ANSI escape code
ANSI escape sequences are a standard for in-band signaling to control cursor location, [|color], font styling, and other options on video text terminals and terminal emulators. Certain sequences of bytes, most starting with an ASCII escape character and a bracket character, are embedded into text. The terminal interprets these sequences as commands, rather than text to display verbatim.
ANSI sequences were introduced in the 1970s to replace vendor-specific sequences and became widespread in the computer equipment market by the early 1980s. Although hardware text terminals have become increasingly rare in the 21st century, the relevance of the ANSI standard persists because a great majority of terminal emulators and command consoles interpret at least a portion of the ANSI standard.
History
Almost all manufacturers of video terminals added vendor-specific escape sequences to perform operations such as placing the cursor at arbitrary positions on the screen. One example is the VT52 terminal, which allowed the cursor to be placed at an x,y location on the screen by sending the character, a character, and then two characters representing numerical values equal to the x,y location plus 32. The Hazeltine 1500 had a similar feature, invoked using, and then the X and Y positions separated with a comma. While the two terminals had identical functionality in this regard, different control sequences had to be used to invoke them.As these sequences were different for different terminals, elaborate libraries such as termcap and utilities such as tput had to be created so programs could use the same API to work with any terminal. In addition, many of these terminals required sending numbers as the binary values of the characters; for some programming languages, and for systems that did not use ASCII internally, it was often difficult to turn a number into the correct character.
The ANSI standard attempted to address these problems by making a command set that all terminals would use and requiring all numeric information to be transmitted as ASCII numbers. The first standard in the series was ECMA-48, adopted in 1976. It was a continuation of a series of character coding standards, the first one being ECMA-6 from 1965, a 7-bit standard from which ISO 646 originates. The name "ANSI escape sequence" dates from 1979 when ANSI adopted ANSI X3.64. The ANSI X3L2 committee collaborated with the ECMA committee TC 1 to produce nearly identical standards. These two standards were merged into an international standard, ISO 6429. In 1994, ANSI withdrew its standard in favor of the international standard.
The first popular video terminal to support these sequences was the Digital VT100, introduced in 1978. This model was very successful in the market, which sparked a variety of VT100 clones, among the earliest and most popular of which was the much more affordable Zenith Z-19 in 1979. Others included the Qume QVT-108, Televideo TVI-970, Wyse WY-99GT as well as optional "VT100" or "VT103" or "ANSI" modes with varying degrees of compatibility on many other brands. The popularity of these gradually led to more and more software assuming the escape sequences worked, leading to almost all new terminals and emulator programs supporting them.
In 1981, ANSI X3.64 was adopted for use in the US government by FIPS publication 86. Later, the US government stopped duplicating industry standards, so FIPS pub. 86 was withdrawn.
ECMA-48 has been updated several times and is currently at its 5th edition, from 1991. It is also adopted by ISO and IEC as standard ISO/IEC 6429. A version is adopted as a Japanese Industrial Standard, as JIS X 0211.
Related standards include ITU T.61, the Teletex standard, and the ISO/IEC 8613, the Open Document Architecture standard. The two systems share many escape codes with the ANSI system, with extensions that are not necessarily meaningful to computer terminals. Both systems quickly fell into disuse, but ECMA-48 does mark the extensions used in them as reserved.
Platform support
In the early 1980s, large amounts of software directly used these sequences to update screen displays. This included everything on VMS, most software designed to be portable on CP/M home computers, and even lots of Unix software as it was easier to use than the termcap libraries, such as the shell script examples below in this article.Terminal emulators for communicating with remote machines almost always implement ANSI escape codes. This includes anything written to communicate with bulletin-board systems on home and personal computers. On Unix terminal emulators such as xterm also can communicate with software running on the same machine, and thus software running in X11 under a terminal emulator could assume the ability to write these sequences.
As computers got more powerful even built-in displays started supporting them, allowing software to be portable between CP/M systems. There were attempts to extend the escape sequences to support printers and as an early PDF-like document storage format, the Open Document Architecture.
DOS and Windows
The IBM PC, introduced in 1981, did not support these or any other escape sequences for updating the screen. Only a few control characters were interpreted by the underlying BIOS. Any display effects had to be done with BIOS calls, which were notoriously slow, or by directly manipulating the IBM PC hardware. This made any interesting software non-portable and led to the need to duplicate details of the display hardware in PC Clones.DOS version 2.0 included an optional device driver named. Poor performance, and the fact that it was not installed by default, meant software rarely took advantage of it.
The Windows Console did not support ANSI escape sequences, nor did Microsoft provide any method to enable them. Some replacements such as JP Software's TCC, Michael J. Mefford's ANSI.COM, Jason Hood's and Maximus5's ConEmu enabled ANSI escape sequences. Software such as the Python colorama package or Cygwin modified text in-process as it was sent to the console, extracting the ANSI Escape sequences and emulating them with Windows calls.
In 2016, Microsoft released the Windows 10 version 1511 update which unexpectedly implemented support for ANSI escape sequences, over three decades after the debut of Windows. This was done alongside Windows Subsystem for Linux, apparently to allow Unix-like terminal-based software to use the Windows Console. Windows PowerShell 5.1 enabled this by default, and PowerShell 6 made it possible to embed the necessary ESC character into a string with.
Windows Terminal, introduced in 2019, supports the sequences by default. Since Windows 11 22H2 and Windows Terminal 1.15, Windows Terminal replaces Windows Console as the default.
C0 control codes
Almost all users assume some functions of some single-byte characters. Initially defined as part of ASCII, the default C0 control code set is now defined in ISO 6429, making it part of the same standard as the C1 set invoked by the ANSI escape sequences. This is used to shorten the amount of data transmitted, or to perform some functions that are unavailable from escape sequences:| ^ | C0 | Abbr | C escape sequence | Name | Effect |
| 0x07 | \a | Bell | Makes an audible noise. | ||
| 0x08 | \b | Backspace | Moves the cursor left. | ||
| 0x09 | \t | Tab | Moves the cursor right to next tab stop. | ||
| 0x0A | \n | Line Feed | Moves to next line, scrolls the display up if at bottom of the screen. Usually does not move horizontally, though programs should not rely on this. | ||
| 0x0C | \f | Form Feed | Move a printer to top of next page. Usually does not move horizontally, though programs should not rely on this. Effect on video terminals varies. | ||
| 0x0D | \r | Moves the cursor to column zero. | |||
| 0x1B | \x1B, \033 | Escape | Starts all the escape sequences |
Escape sequences vary in length. The general format for an ANSI-compliant escape sequence is defined by ANSI X3.41. The escape sequences consist only of bytes in the range , and can be parsed without looking ahead. The behavior when a control character, a byte with the high bit set, or a byte that is not part of any valid sequence is encountered before the end is undefined.
Fe Escape sequences
If the [#ESC|] is followed by a byte in the range 0x40 to 0x5F, the escape sequence is of type. Its interpretation is delegated to the applicable C1 control code standard. Accordingly, all escape sequences corresponding to C1 control codes from ANSI X3.64 / ECMA-48 follow this format.The standard says that, in 8-bit environments, the control functions corresponding to type escape sequences can be represented as single bytes in the 0x80–0x9F range. This is possible in character encodings conforming to the provisions for an 8-bit code made in ISO 2022, such as the ISO 8859 series. However, in character encodings used on modern devices such as UTF-8 or CP-1252, those codes are often used for other purposes, so only the 2-byte sequence is typically used. In the case of UTF-8, representing a C1 control code via the C1 Controls and Latin-1 Supplement block results in a different two-byte code, but no space is saved this way.
| Code | C1 | Abbr | Name | Effect |
| Single Shift Two | Select a single character from one of the alternative character sets. SS2 selects the G2 character set, and SS3 selects the G3 character set. In a 7-bit environment, this is followed by one or more GL bytes specifying a character from that set. In an 8-bit environment, these may instead be GR bytes. | |||
| Single Shift Three | Select a single character from one of the alternative character sets. SS2 selects the G2 character set, and SS3 selects the G3 character set. In a 7-bit environment, this is followed by one or more GL bytes specifying a character from that set. In an 8-bit environment, these may instead be GR bytes. | |||
| Device Control String | Terminated by ST. Xterm's uses of this sequence include defining User-Defined Keys, and requesting or setting Termcap/Terminfo data. | |||
| Control Sequence Introducer | Starts most of the useful sequences, terminated by a byte in the range 0x40 through 0x7E. | |||
| String Terminator | Terminates strings in other controls. | |||
| Operating System Command | Starts a control string for the operating system to use, terminated by ST. | |||
| Start of String | Takes an argument of a string of text, terminated by ST. The uses for these string control sequences are defined by the application or privacy discipline. These functions are rarely implemented and the arguments are ignored by xterm. Some Kermit clients allow the server to automatically execute Kermit commands on the client by embedding them in APC sequences; this is a potential security risk if the server is untrusted. | |||
| Privacy Message | Takes an argument of a string of text, terminated by ST. The uses for these string control sequences are defined by the application or privacy discipline. These functions are rarely implemented and the arguments are ignored by xterm. Some Kermit clients allow the server to automatically execute Kermit commands on the client by embedding them in APC sequences; this is a potential security risk if the server is untrusted. | |||
| Takes an argument of a string of text, terminated by ST. The uses for these string control sequences are defined by the application or privacy discipline. These functions are rarely implemented and the arguments are ignored by xterm. Some Kermit clients allow the server to automatically execute Kermit commands on the client by embedding them in APC sequences; this is a potential security risk if the server is untrusted. |
Control Sequence Introducer commands
For Control Sequence Introducer, or CSI, commands, the is followed by any number of "parameter bytes" in the range 0x30–0x3F, then by any number of "intermediate bytes" in the range 0x20–0x2F, then finally by a single "final byte" in the range 0x40–0x7E.All common sequences just use the parameters as a series of semicolon-separated numbers such as. Missing numbers are treated as . Some sequences treat as in order to make missing parameters useful.
A subset of arrangements was declared "private" so that terminal manufacturers could insert their own sequences without conflicting with the standard. Sequences containing the parameter bytes
<=>? or the final bytes 0x70–0x7E are private.The behavior of the terminal is undefined in the case where a CSI sequence contains any character outside of the range 0x20–0x7E. These illegal characters are either C0 control characters, DEL, or bytes with the high bit set. Possible responses are to ignore the byte, to process it immediately, and furthermore whether to continue with the CSI sequence, to abort it immediately, or to ignore the rest of it.
| Code | Abbr | Name | Effect |
| CSI A | Cursor Up | Moves the cursor cells in the given direction. If the cursor is already at the edge of the screen, this has no effect. | |
| CSI B | Cursor Down | Moves the cursor cells in the given direction. If the cursor is already at the edge of the screen, this has no effect. | |
| CSI C | Cursor Forward | Moves the cursor cells in the given direction. If the cursor is already at the edge of the screen, this has no effect. | |
| CSI D | Cursor Back | Moves the cursor cells in the given direction. If the cursor is already at the edge of the screen, this has no effect. | |
| CSI E | Cursor Next Line | Moves cursor to beginning of the line lines down. | |
| CSI F | Cursor Previous Line | Moves cursor to beginning of the line lines up. | |
| CSI G | Moves the cursor to column . | ||
| CSI ; H | Cursor Position | Moves the cursor to row, column. The values are 1-based, and default to if omitted. A sequence such as is a synonym for as well as is the same as and | |
| CSI J | Erase in Display | Clears part of the screen. If is , clear from cursor to end of screen. If is, clear from cursor to beginning of the screen. If is, clear entire screen. If is, clear entire screen and delete all lines saved in the scrollback buffer. | |
| CSI K | Erase in Line | Erases part of the line. If is , clear from cursor to the end of the line. If is, clear from cursor to beginning of the line. If is, clear entire line. Cursor position does not change. | |
| CSI S | Scroll Up | Scroll whole page up by lines. New lines are added at the bottom. | |
| CSI T | Scroll Down | Scroll whole page down by lines. New lines are added at the top. | |
| CSI ; f | Same as CUP, but counts as a format effector function rather than an editor function. This can lead to different handling in certain terminal modes. | ||
| CSI m | Select Graphic Rendition | Sets colors and style of the characters following this code | |
| CSI 5i | AUX Port On | Enable aux serial port usually for local serial printer | |
| CSI 4i | AUX Port Off | Disable aux serial port usually for local serial printer | |
| CSI 6n | Device Status Report | Reports the cursor position by transmitting, where is the row and is the column. |
| Code | Abbr | Name | Effect |
| CSI s | Save Current Cursor Position | Saves the cursor position/state in SCO console mode. In vertical split screen mode, instead used to set or reset left and right margins. | |
| CSI u | Restores the cursor position/state in SCO console mode. | ||
| CSI ? 25 h | Shows the cursor, from the VT220. | ||
| CSI ? 25 l | Hides the cursor. | ||
| CSI ? 1004 h | Enable reporting focus. Reports whenever terminal emulator enters or exits focus as and, respectively. | ||
| CSI ? 1004 l | Disable reporting focus. | ||
| CSI ? 1049 h | Enable alternative screen buffer, from xterm | ||
| CSI ? 1049 l | Disable alternative screen buffer, from xterm | ||
| CSI ? 2004 h | Turn on bracketed paste mode. In bracketed paste mode, text pasted into the terminal will be surrounded by and ; programs running in the terminal should not treat characters bracketed by those sequences as commands. From xterm | ||
| CSI ? 2004 l | Turn off bracketed paste mode. |
[|Select Graphic Rendition] parameters
The control sequenceCSI m, named Select Graphic Rendition, sets display attributes. Several attributes can be set in the same sequence, separated by semicolons. Each display attribute remains in effect until a following occurrence of SGR resets it. If no codes are given, is treated as .| n | Name | Note |
| Reset or normal | All attributes become turned off | |
| Bold or increased intensity | As with faint, the color change is a PC invention. | |
| Faint, decreased intensity, or dim | May be implemented as a light font weight like bold. | |
| Italic | Not widely supported. Sometimes treated as inverse or blink. | |
| Underline | Style extensions exist for Kitty, VTE, mintty, iTerm2 and Konsole. | |
| Slow blink | Sets blinking to less than 150 times per minute | |
| Rapid blink | MS-DOS ANSI.SYS, 150+ per minute; not widely supported | |
| Reverse video or invert | Swap foreground and background colors. | |
| Conceal or hide | Not widely supported. | |
| Crossed-out, or strike | Characters legible but marked as if for deletion. Not supported in Terminal.app. | |
| Primary font | ||
| Alternative font | Select alternative font | |
| Fraktur | Rarely supported | |
| Doubly underlined; or: not bold | Double-underline per ECMA-48, but instead disables bold intensity on several terminals, including in the Linux kernel's console before version 4.17. | |
| Normal intensity | Neither bold nor faint; color changes where intensity is implemented as such. | |
| Neither italic, nor blackletter | ||
| Not underlined | Neither singly nor doubly underlined | |
| Not blinking | Turn blinking off | |
| Proportional spacing | ITU T.61 and T.416, not known to be used on terminals | |
| Not reversed | ||
| Reveal | Not concealed | |
| Not crossed out | ||
| Set foreground color | ||
| Set foreground color | Next arguments are or | |
| Default foreground color | Implementation defined | |
| Set background color | ||
| Set background color | Next arguments are or | |
| Default background color | Implementation defined | |
| Disable proportional spacing | T.61 and T.416 | |
| Framed | Implemented as "emoji variation selector" in mintty. | |
| Encircled | Implemented as "emoji variation selector" in mintty. | |
| Overlined | Not supported in Terminal.app | |
| Neither framed nor encircled | ||
| Not overlined | ||
| Set underline color | Not in standard; implemented in Kitty, VTE, mintty, and iTerm2. Next arguments are or . | |
| Default underline color | Not in standard; implemented in Kitty, VTE, mintty, and iTerm2. | |
| Ideogram underline or right side line | Rarely supported | |
| Ideogram double underline, or double line on the right side | Rarely supported | |
| Ideogram overline or left side line | Rarely supported | |
| Ideogram double overline, or double line on the left side | Rarely supported | |
| Ideogram stress marking | Rarely supported | |
| No ideogram attributes | Reset the effects of all of – | |
| Superscript | Implemented only in mintty | |
| Subscript | Implemented only in mintty | |
| Neither superscript nor subscript | Implemented only in mintty | |
| Set bright foreground color | Not in standard; originally implemented by aixterm | |
| Set bright background color | Not in standard; originally implemented by aixterm |
Colors
3-bit and 4-bit
The original specification only had 8 colors, and just gave them names. The SGR parameters 30–37 selected the foreground color, while 40–47 selected the background. Quite a few terminals implemented "bold" as a brighter color rather than a different font, thus providing 8 additional foreground colors. Usually you could not get these as background colors, though sometimes inverse video would allow that. Examples: to get black letters on white background use, to get red use, to get bright red use. To reset colors to their defaults, use , or reset all attributes with. Later terminals added the ability to directly specify the "bright" colors with 90–97 and 100–107.The chart below shows a few examples of how classical standards and modern terminal emulators translate the 4-bit color codes into 24-bit color codes.
8-bit
As 256-color lookup tables became common on graphic cards, escape sequences were added to select from a pre-defined set of 256 colors:ESC38;5;m Select foreground color where n is a number from the table below
ESC[48;5;m Select background color
0- 7: standard colors
8- 15: high intensity colors
16-231: 6 × 6 × 6 cube : 16 + 36 × r + 6 × g + b
232-255: grayscale from dark to light in 24 steps
The colors displayed by these values vary across terminal/emulator implementations as the recognized ECMA-48 and ITU's T.416 specifications do not define a specific color palette for this lookup table. While it is common to use the above formula for the color palette, in particular the algorithm and [choice of colors for the 16-231 cube values differs between implementations. The color palette and algorithm used by XTerm is specified below as a sample.
The ITU's T.416 Information technology - Open Document Architecture and interchange format: Character content architectures uses ":" as separator characters instead:
ESCTo calculate the RGB values of the colors in the table above, the following [Python (programming language)">Python script can be used:
- print a list of the 256-color red/green/blue values used by xterm.
- reference:
- https://github.com/ThomasDickey/ncurses-snapshots/blob/master/test/xterm-16color.dat
- https://github.com/ThomasDickey/xterm-snapshots/blob/master/XTerm-col.ad
- https://github.com/ThomasDickey/xterm-snapshots/blob/master/256colres.pl
for code in range:
if code > 8:
level = 255
elif code 7:
level = 229
else:
level = 205
r = 127 if code 8 else level if != 0 else 92 if code 12 else 0
g = 127 if code 8 else level if != 0 else 92 if code 12 else 0
b = 127 if code 8 else 238 if code 4 else level if != 0 else 0
for red in range:
for green in range:
for blue in range:
code = 16 + + + blue
r = red * 40 + 55 if red != 0 else 0
g = green * 40 + 55 if green != 0 else 0
b = blue * 40 + 55 if blue != 0 else 0
for gray in range:
level = gray * 10 + 8
code = 232 + gray
There has also been a similar but incompatible 88-color encoding using the same escape sequence, seen in and. It uses a 4×4×4 color cube.
24-bit
As "true color" graphic cards with 16 to 24 bits of color became common, applications began to support 24-bit colors. Terminal emulators supporting setting 24-bit foreground and background colors with escape sequences include Xterm, KDE's [Konsole">48:5:m Select background colorTo calculate the RGB values of the colors in the table above, the following [Python (programming language)">Python script can be used:
- print a list of the 256-color red/green/blue values used by xterm.
- reference:
- https://github.com/ThomasDickey/ncurses-snapshots/blob/master/test/xterm-16color.dat
- https://github.com/ThomasDickey/xterm-snapshots/blob/master/XTerm-col.ad
- https://github.com/ThomasDickey/xterm-snapshots/blob/master/256colres.pl
for code in range:
if code > 8:
level = 255
elif code 7:
level = 229
else:
level = 205
r = 127 if code 8 else level if != 0 else 92 if code 12 else 0
g = 127 if code 8 else level if != 0 else 92 if code 12 else 0
b = 127 if code 8 else 238 if code 4 else level if != 0 else 0
for red in range:
for green in range:
for blue in range:
code = 16 + + + blue
r = red * 40 + 55 if red != 0 else 0
g = green * 40 + 55 if green != 0 else 0
b = blue * 40 + 55 if blue != 0 else 0
for gray in range:
level = gray * 10 + 8
code = 232 + gray
There has also been a similar but incompatible 88-color encoding using the same escape sequence, seen in and. It uses a 4×4×4 color cube.
24-bit
As "true color" graphic cards with 16 to 24 bits of color became common, applications began to support 24-bit colors. Terminal emulators supporting setting 24-bit foreground and background colors with escape sequences include Xterm, KDE's [Konsole, and iTerm, as well as all libvte based terminals, including GNOME Terminal.ESCThis syntax, initially implemented in XTerm, is based on a reading of the [ISO/IEC JTC 1">ISO/IEC 8613-6 specification, specifically that SGR 38 / SGR 48 followed by the parameter "2" can specify a "direct color" in RGB space.. As the first widely-used implementation, this specification of RGB values using semicolon separators is widely supported by terminal emulators that include 24-bit color support.
As with the 8-bit color codes, there is a very similar specification of 24-bit color in the [ITU">48;2;;;m Select RGB background color
This syntax, initially implemented in XTerm, is based on a reading of the [ISO/IEC JTC 1">ISO/IEC 8613-6 specification, specifically that SGR 38 / SGR 48 followed by the parameter "2" can specify a "direct color" in RGB space.. As the first widely-used implementation, this specification of RGB values using semicolon separators is widely supported by terminal emulators that include 24-bit color support.
As with the 8-bit color codes, there is a very similar specification of 24-bit color in the [ITU's T.416 Open Document Architecture and interchange format: Character content architectures, which was adopted as ISO/IEC 8613-6 but ended up as a commercial failure. The ODA version is more elaborate and thus incompatible with the above semicolon-separated version:
- Colons are used as separators, rather than semicolons.
- The parameters after the '2' are optional and can be left empty.
- There is a leading "colorspace ID". The definition of the colorspace ID is not included in that specification, so it may be blank to represent the unspecified default. For CMYK color specifications, mintty interprets the colorspace ID parameter as specifying the maximum value which the channel values are given out of.
- In addition to the '2' value after 48 to specify a Red-Green-Blue format, there are alternatives of '0' for implementation-defined and '1' for transparent - neither of which have any further parameters; '3' specifies colors using a Cyan-Magenta-Yellow scheme, and '4' for a Cyan-Magenta-Yellow-Black one, the latter using the position marked as "unused" for the Black component.
ESC[48:2:::::::m Select RGB background color
where indicates the Color-Space associated with the given tolerance: for CIELUV or for CIELAB.
The semicolon-based RGB specification is the most widely supported, but both it and the RGB variant of [ITU T.416 are supported by many terminal emulators.
Unix environment variables relating to color support
Rather than using the color support in termcap and terminfo introduced in SVr3.2, the S-Lang library used a separate environment variable to indicate whether a terminal emulator could use colors at all, and later added values to indicate if it supported 24-bit color. This system, although poorly documented, became widespread enough for Fedora and RHEL to consider using it as a simpler and more universal detection mechanism compared to querying the now-updated libraries.Some terminal emulators set to report the color scheme of the terminal. This behavior originated in S-Lang and is used by vim. Gnome-terminal refuses to add this behavior, as the syntax for the value is not agreed upon, the value cannot be changed upon a runtime change of the palette, and more "proper" xterm OSC 4/10/11 sequences already exist.
[|Operating System Command] sequences
Most Operating System Command sequences were defined by Xterm, but many are also supported by other terminal emulators. For historical reasons, Xterm can end the command with [Bell character|] as well as the standard . For example, Xterm allows the icon name and window title to be set by.A non-xterm extension is the hyperlink, from 2017, used by VTE, iTerm2, and mintty, among others.
The Linux console uses to change the palette, which, if hard-coded into an application, may hang other terminals. However, appending will be ignored by Linux and form a proper, ignorable sequence for other terminals.
Fs Escape sequences
If the is followed by a byte in the range, the escape sequence is of type. This type is used for control functions individually registered with the ISO-IR registry. A table of these is listed under ISO/IEC 2022.Fp Escape sequences
If the is followed by a byte in the range, the escape sequence is of type, which is set apart for up to sixteen private-use control functions.| Abbr | Name | Effect | |
| DEC Save Cursor | Saves the cursor position, encoding shift state and formatting attributes. | ||
| Restores the cursor position, encoding shift state and formatting attributes from the previous DECSC if any, otherwise resets these all to their defaults. |
nF Escape sequences
If the is followed by a byte in the range, the escape sequence is of type. Said byte is followed by any number of additional bytes in this range, and then a byte in the range. These escape sequences are further subcategorised by the low two bits of the first byte, e.g. "type " for sequences where the first byte is ; and by whether the final byte is in the range indicating private use or not.Most of the sequences are for changing the current character set, and are listed in ISO/IEC 2022. Some others:
| Abbr | Name | Effect | |
| Makes the function keys send ESC + letter instead of 8-bit C1 codes. | |||
| Makes the function keys send 8-bit C1 codes. |
If the first byte is '#' the public sequences are reserved for additional ISO-IR registered individual control functions. No such sequences are presently registered. Type sequences are available for private-use control functions.
| Abbr | Name | Effect | |
| DEC Double-Height Letters, Top Half | Makes the current line use characters twice as tall. This code is for the top half. | ||
| Makes the current line use characters twice as tall. This code is for the bottom half. | |||
| DEC Single-Width Line | Makes the current line use single-width characters, per the default behaviour. | ||
| Makes the current line use double-width characters, discarding any characters in the second half of the line. |
Examples
— This clears the screen and, on some devices, locates the cursor to the y,x position 1,1.— This makes text green. The green may be a dark, dull green, so you may wish to enable Bold with the sequence which would make it bright green, or combined as. Some implementations use the Bold state to make the character Bright.
— This reassigns the key F10 to send to the keyboard buffer the string "DIR" and ENTER, which in the DOS command line would display the contents of the current directory. This was sometimes used for ANSI bombs. This is a private-use code, using a non-standard extension to include a string-valued parameter. Following the letter of the standard would consider the sequence to end at the letter D.
— This saves the cursor position. Using the sequence will restore it to the position. Say the current cursor position is 7 and 10. The sequence will save those two numbers. Now you can move to a different cursor position, such as 20 and 3, using the sequence or. Now if you use the sequence CSI u the cursor position will return to 7 and 10. Some terminals require the DEC sequences / instead which is more widely supported.
In shell scripting
ANSI escape codes are often used in UNIX and UNIX-like terminals to provide syntax highlighting. For example, on compatible terminals, the following list command color-codes file and directory names by type.ls --color
Users can employ escape codes in their scripts by including them as part of standard output or standard error. For example, the following GNU sed command embellishes the output of the make command by displaying lines containing words starting with "WARN" in reverse video and words starting with "ERR" in bright yellow on a dark red background. The representations of the codes are highlighted.
make 2>&1 | sed -e 's/.*\bWARN.*/\x1b/i' -e 's/.*\bERR.*/\x1b[93;41m&\x1b[0m/i'
The following [Bash (Unix shell)">Bash function flashes the terminal until the user presses a key.
It can be used to alert a programmer when a lengthy command terminates, such as with.
The following command will reset the console, similar to the command on modern Linux systems; however it should work even on older Linux systems and on other [UNIX">0m/i' -e 's/.*\bERR.*/\x1b[93;41m&\x1b[0m/i'
The following [Bash (Unix shell)">Bash function flashes the terminal until the user presses a key.
It can be used to alert a programmer when a lengthy command terminates, such as with.
The following command will reset the console, similar to the command on modern Linux systems; however it should work even on older Linux systems and on other [UNIX variants.
In C
This following program creates a table of numbers from 0 to 109, each of which is displayed in the format specified by the Select Graphic Rendition escape sequence using that number as the graphic rendition code.- include
Terminal input sequences
Pressing special keys on the keyboard, as well as outputting many xterm CSI, DCS, or OSC sequences, often produces a CSI, DCS, or OSC sequence, sent from the terminal to the computer as though the user typed it.When typing input on a terminal keypresses outside the normal main alphanumeric keyboard area can be sent to the host as ANSI sequences. For keys that have an equivalent output function, such as the cursor keys, these often mirror the output sequences. However, for most keypresses there isn't an equivalent output sequence to use.
There are several encoding schemes, and unfortunately most terminals mix sequences from different schemes, so host software has to be able to deal with input sequences using any scheme.
To complicate the matter, the VT terminals themselves have two schemes of input, normal mode and application mode that can be switched by the application.
-> char -> esc -> Alt-esc -> Alt-keypress or keycode sequence '^_, which would form C1 codes.