Xterm Control Sequences

Edward Moy
University of California, Berkeley

Revised by
Stephen Gildea
X Consortium (1994)
Thomas Dickey
XFree86 Project (1996-2006)
invisible-island.net (2006-2012)

Definitions

C1 (8-Bit) Control Characters

The xterm program recognizes both 8-bit and 7-bit control characters. It generates 7-bit controls (by default) or 8-bit if S8C1T is enabled. The following pairs of 7-bit and 8-bit control characters are equivalent:

These control characters are used in the vtXXX emulation.

VT100 Mode

Most of these control sequences are standard VT102 control sequences, but there is support for later DEC VT terminals (i.e., VT220, VT320, VT420, VT510), as well as ISO 6429 and aixterm color controls. The only VT102 feature not supported is auto-repeat, since the only way X provides for this will affect all windows. There are additional control sequences to provide xterm-dependent functions, such as the scrollbar or window size. Where the function is specified by DEC or ISO 6429, the code assigned to it is given in parentheses. The escape codes to designate and invoke character sets are specified by ISO 2022; see that document for a discussion of character sets.

Single-character functions

Controls beginning with ESC
This excludes controls where ESC is part of a 7-bit equivalent to 8-bit C1 controls, ordered by the final character(s).

Final character C for designating 94-character sets. In this list, 0 , A and B apply to VT100 and up, the remainder to VT220 and up:
C = 0 → DEC Special Character and Line Drawing Set.
C = A → United Kingdom (UK).
C = B → United States (USASCII).
C = 4 → Dutch.
C = C or 5 → Finnish.
C = R → French.
C = Q → French Canadian.
C = K → German.
C = Y → Italian.
C = E or 6 → Norwegian/Danish.
C = Z → Spanish.
C = H or 7 → Swedish.
C = = → Swiss.

The same character sets apply as for ESC ( C.

The same character sets apply as for ESC ( C.

The same character sets apply as for ESC ( C.

The same character sets apply as for ESC ( C.

The same character sets apply as for ESC ( C.

These work for 96-character sets only.
C = A → ISO Latin-1 Supplemental.

Application Program-Control functions

Device-Control functions

User-Defined Keys (DECUDK). The first parameter:
P s = 0 → Clear all UDK definitions before starting (default).
P s = 1 → Erase Below (default).
The second parameter:
P s = 0 ← Lock the keys (default).
P s = 1 ← Do not lock.
The third parameter is a ’;’-separated list of strings denoting the key-code separated by a ’/’ from the hex-encoded key value. The key codes correspond to the DEC function-key codes (e.g., F6=17).

Request Status String (DECRQSS). The string following the "q" is one of the following:

“ q

xterm responds with DCS 1 $ r P t ST for valid requests, replacing the P t with the corresponding CSI string, or DCS 0 $ r P t ST for invalid requests.

Set Termcap/Terminfo Data (xterm, experimental). The string following the "p" is a name to use for retrieving data from the terminal database. The data will be used for the "tcap" keyboard configuration’s function- and special-keys, as well as by the Request Termcap/Terminfo String control.

Request Termcap/Terminfo String (xterm, experimental). The string following the "q" is a list of names encoded in hexadecimal (2 digits per character) separated by ; which correspond to termcap or terminfo key names.
Two special features are also recognized, which are not key names: Co for termcap colors (or colors for terminfo colors), and TN for termcap name (or name for terminfo name).
xterm responds with DCS 1 + r P t ST for valid requests, adding to P t an = , and the value of the corresponding string that xterm would send, or DCS 0 + r P t ST for invalid requests. The strings are encoded in hexadecimal (2 digits per character).

Functions using CSI , ordered by the final character(s)

s H

P s = 0 → Erase Below (default).
P s = 1 → Erase Above.
P s = 2 → Erase All.
P s = 3 → Erase Saved Lines (xterm).

P s = 0 → Selective Erase Below (default).
P s = 1 → Selective Erase Above.
P s = 2 → Selective Erase All.

P s = 0 → Erase to Right (default).
P s = 1 → Erase to Left.
P s = 2 → Erase All.

P s = 0 → Selective Erase to Right (default).
P s = 1 → Selective Erase to Left.
P s = 2 → Selective Erase All.

s ; P s ; P s ; P s T

P s T

P s = 0 → Do not set window/icon labels using hexadecimal.
P s = 1 → Do not query window/icon labels using hexadecimal.
P s = 2 → Do not set window/icon labels using UTF-8.
P s = 3 → Do not query window/icon labels using UTF-8. (See discussion of "Title Modes").

P s = 0 or omitted → request attributes from terminal. The response depends on the decTerminalID resource setting.
→ CSI ? 1 ; 2 c (‘‘VT100 with Advanced Video Option’’)
→ CSI ? 1 ; 0 c (‘‘VT101 with No Options’’)
→ CSI ? 6 c (‘‘VT102’’)
→ CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c (‘‘VT220’’)
The VT100-style response parameters do not mean anything by themselves. VT220 parameters do, telling the host what features the terminal supports:
P s = 1 → 132-columns.
P s = 2 → Printer.
P s = 6 → Selective erase.
P s = 8 → User-defined keys.
P s = 9 → National replacement character sets.
P s = 1 5 → Technical characters.
P s = 2 2 → ANSI color, e.g., VT525.
P s = 2 9 → ANSI text locator (i.e., DEC Locator mode).

P s = 0 or omitted → request the terminal’s identification code. The response depends on the decTerminalID resource setting. It should apply only to VT220 and up, but xterm extends this to VT100.
→ CSI > P p ; P v ; P c c
where P p denotes the terminal type
P p = 0 → ‘‘VT100’’.
P p = 1 → ‘‘VT220’’.
and P v is the firmware version (for xterm, this was originally the XFree86 patch number, starting with 95). In a DEC terminal, P c indicates the ROM cartridge registration number and is always zero.

s f

P s = 0 → Clear Current Column (default).
P s = 3 → Clear All.

P s = 2 → Keyboard Action Mode (AM).
P s = 4 → Insert Mode (IRM).
P s = 1 2 → Send/receive (SRM).
P s = 2 0 → Automatic Newline (LNM).

P s = 1 → Application Cursor Keys (DECCKM).
P s = 2 → Designate USASCII for character sets G0-G3 (DECANM), and set VT100 mode.
P s = 3 → 132 Column Mode (DECCOLM).
P s = 4 → Smooth (Slow) Scroll (DECSCLM).
P s = 5 → Reverse Video (DECSCNM).
P s = 6 → Origin Mode (DECOM).
P s = 7 → Wraparound Mode (DECAWM).
P s = 8 → Auto-repeat Keys (DECARM).
P s = 9 → Send Mouse X & Y on button press. See the section Mouse Tracking.
P s = 1 0 → Show toolbar (rxvt).
P s = 1 2 → Start Blinking Cursor (att610).
P s = 1 8 → Print form feed (DECPFF).
P s = 1 9 → Set print extent to full screen (DECPEX).
P s = 2 5 → Show Cursor (DECTCEM).
P s = 3 0 → Show scrollbar (rxvt).
P s = 3 5 → Enable font-shifting functions (rxvt).
P s = 3 8 → Enter Tektronix Mode (DECTEK).
P s = 4 0 → Allow 80 → 132 Mode.
P s = 4 1 → more(1) fix (see curses resource).
P s = 4 2 → Enable Nation Replacement Character sets (DECNRCM).
P s = 4 4 → Turn On Margin Bell.
P s = 4 5 → Reverse-wraparound Mode.
P s = 4 6 → Start Logging. This is normally disabled by a compile-time option.
P s = 4 7 → Use Alternate Screen Buffer. (This may be disabled by the titeInhibit resource).
P s = 6 6 → Application keypad (DECNKM).
P s = 6 7 → Backarrow key sends backspace (DECBKM).
P s = 6 9 → Enable left and right margin mode (DECLRMM), VT420 and up.
P s = 9 5 → Do not clear screen when DECCOLM is set/reset (DECNCSM), VT510 and up.
P s = 1 0 0 0 → Send Mouse X & Y on button press and release. See the section Mouse Tracking.
P s = 1 0 0 1 → Use Hilite Mouse Tracking.
P s = 1 0 0 2 → Use Cell Motion Mouse Tracking.
P s = 1 0 0 3 → Use All Motion Mouse Tracking.
P s = 1 0 0 4 → Send FocusIn/FocusOut events.
P s = 1 0 0 5 → Enable UTF-8 Mouse Mode.
P s = 1 0 0 6 → Enable SGR Mouse Mode.
P s = 1 0 1 0 → Scroll to bottom on tty output (rxvt).
P s = 1 0 1 5 → Enable urxvt Mouse Mode.
P s = 1 0 1 1 → Scroll to bottom on key press (rxvt).
P s = 1 0 3 4 → Interpret "meta" key, sets eighth bit. (enables the eightBitInput resource).
P s = 1 0 3 5 → Enable special modifiers for Alt and NumLock keys. (This enables the numLock resource).
P s = 1 0 3 6 → Send ESC when Meta modifies a key. (This enables the metaSendsEscape resource).
P s = 1 0 3 7 → Send DEL from the editing-keypad Delete key.
P s = 1 0 3 9 → Send ESC when Alt modifies a key. (This enables the altSendsEscape resource).
P s = 1 0 4 0 → Keep selection even if not highlighted. (This enables the keepSelection resource).
P s = 1 0 4 1 → Use the CLIPBOARD selection. (This enables the selectToClipboard resource).
P s = 1 0 4 2 → Enable Urgency window manager hint when Control-G is received. (This enables the bellIsUrgent resource).
P s = 1 0 4 3 → Enable raising of the window when Control-G is received. (enables the popOnBell resource).
P s = 1 0 4 7 → Use Alternate Screen Buffer. (This may be disabled by the titeInhibit resource).
P s = 1 0 4 8 → Save cursor as in DECSC. (This may be disabled by the titeInhibit resource).
P s = 1 0 4 9 → Save cursor as in DECSC and use Alternate Screen Buffer, clearing it first. (This may be disabled by the titeInhibit resource). This combines the effects of the 1 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based applications rather than the 4 7 mode.
P s = 1 0 5 0 → Set terminfo/termcap function-key mode.
P s = 1 0 5 1 → Set Sun function-key mode.
P s = 1 0 5 2 → Set HP function-key mode.
P s = 1 0 5 3 → Set SCO function-key mode.
P s = 1 0 6 0 → Set legacy keyboard emulation (X11R6).
P s = 1 0 6 1 → Set VT220 keyboard emulation.
P s = 2 0 0 4 → Set bracketed paste mode.

P s = 0 → Print screen (default).
P s = 4 → Turn off printer controller mode.
P s = 5 → Turn on printer controller mode.

P s = 1 → Print line containing cursor.
P s = 4 → Turn off autoprint mode.
P s = 5 → Turn on autoprint mode.
P s = 1 0 → Print composed display, ignores DECPEX.
P s = 1 1 → Print all pages.

P s = 2 → Keyboard Action Mode (AM).
P s = 4 → Replace Mode (IRM).
P s = 1 2 → Send/receive (SRM).
P s = 2 0 → Normal Linefeed (LNM).

P s = 1 → Normal Cursor Keys (DECCKM).
P s = 2 → Designate VT52 mode (DECANM).
P s = 3 → 80 Column Mode (DECCOLM).
P s = 4 → Jump (Fast) Scroll (DECSCLM).
P s = 5 → Normal Video (DECSCNM).
P s = 6 → Normal Cursor Mode (DECOM).
P s = 7 → No Wraparound Mode (DECAWM).
P s = 8 → No Auto-repeat Keys (DECARM).
P s = 9 → Don’t send Mouse X & Y on button press.
P s = 1 0 → Hide toolbar (rxvt).
P s = 1 2 → Stop Blinking Cursor (att610).
P s = 1 8 → Don’t print form feed (DECPFF).
P s = 1 9 → Limit print to scrolling region (DECPEX).
P s = 2 5 → Hide Cursor (DECTCEM).
P s = 3 0 → Don’t show scrollbar (rxvt).
P s = 3 5 → Disable font-shifting functions (rxvt).
P s = 4 0 → Disallow 80 → 132 Mode.
P s = 4 1 → No more(1) fix (see curses resource).
P s = 4 2 → Disable Nation Replacement Character sets (DECNRCM).
P s = 4 4 → Turn Off Margin Bell.
P s = 4 5 → No Reverse-wraparound Mode.
P s = 4 6 → Stop Logging. (This is normally disabled by a compile-time option).
P s = 4 7 → Use Normal Screen Buffer.
P s = 6 6 → Numeric keypad (DECNKM).
P s = 6 7 → Backarrow key sends delete (DECBKM).
P s = 6 9 → Disable left and right margin mode (DECLRMM), VT420 and up.
P s = 9 5 → Clear screen when DECCOLM is set/reset (DECNCSM), VT510 and up.
P s = 1 0 0 0 → Don’t send Mouse X & Y on button press and release. See the section Mouse Tracking.
P s = 1 0 0 1 → Don’t use Hilite Mouse Tracking.
P s = 1 0 0 2 → Don’t use Cell Motion Mouse Tracking.
P s = 1 0 0 3 → Don’t use All Motion Mouse Tracking.
P s = 1 0 0 4 → Don’t send FocusIn/FocusOut events.
P s = 1 0 0 5 → Disable UTF-8 Mouse Mode.
P s = 1 0 0 6 → Disable SGR Mouse Mode.
P s = 1 0 1 0 → Don’t scroll to bottom on tty output (rxvt).
P s = 1 0 1 5 → Disable urxvt Mouse Mode.
P s = 1 0 1 1 → Don’t scroll to bottom on key press (rxvt).
P s = 1 0 3 4 → Don’t interpret "meta" key. (This disables the eightBitInput resource).
P s = 1 0 3 5 → Disable special modifiers for Alt and NumLock keys. (This disables the numLock resource).
P s = 1 0 3 6 → Don’t send ESC when Meta modifies a key. (This disables the metaSendsEscape resource).
P s = 1 0 3 7 → Send VT220 Remove from the editing-keypad Delete key.
P s = 1 0 3 9 → Don’t send ESC when Alt modifies a key. (This disables the altSendsEscape resource).
P s = 1 0 4 0 → Do not keep selection when not highlighted. (This disables the keepSelection resource).
P s = 1 0 4 1 → Use the PRIMARY selection. (This disables the selectToClipboard resource).
P s = 1 0 4 2 → Disable Urgency window manager hint when Control-G is received. (This disables the bellIsUrgent resource).
P s = 1 0 4 3 → Disable raising of the window when Control-G is received. (This disables the popOnBell resource).
P s = 1 0 4 7 → Use Normal Screen Buffer, clearing screen first if in the Alternate Screen. (This may be disabled by the titeInhibit resource).
P s = 1 0 4 8 → Restore cursor as in DECRC. (This may be disabled by the titeInhibit resource).
P s = 1 0 4 9 → Use Normal Screen Buffer and restore cursor as in DECRC. (This may be disabled by the titeInhibit resource). This combines the effects of the 1 0 4 7 and 1 0 4 8 modes. Use this with terminfo-based applications rather than the 4 7 mode.
P s = 1 0 5 0 → Reset terminfo/termcap function-key mode.
P s = 1 0 5 1 → Reset Sun function-key mode.
P s = 1 0 5 2 → Reset HP function-key mode.
P s = 1 0 5 3 → Reset SCO function-key mode.
P s = 1 0 6 0 → Reset legacy keyboard emulation (X11R6).
P s = 1 0 6 1 → Reset keyboard emulation to Sun/PC style.
P s = 2 0 0 4 → Reset bracketed paste mode.

P s = 0 → Normal (default).
P s = 1 → Bold.
P s = 4 → Underlined.
P s = 5 → Blink (appears as Bold).
P s = 7 → Inverse.
P s = 8 → Invisible, i.e., hidden (VT300).
P s = 2 2 → Normal (neither bold nor faint).
P s = 2 4 → Not underlined.
P s = 2 5 → Steady (not blinking).
P s = 2 7 → Positive (not inverse).
P s = 2 8 → Visible, i.e., not hidden (VT300).
P s = 3 0 → Set foreground color to Black.
P s = 3 1 → Set foreground color to Red.
P s = 3 2 → Set foreground color to Green.
P s = 3 3 → Set foreground color to Yellow.
P s = 3 4 → Set foreground color to Blue.
P s = 3 5 → Set foreground color to Magenta.
P s = 3 6 → Set foreground color to Cyan.
P s = 3 7 → Set foreground color to White.
P s = 3 9 → Set foreground color to default (original).
P s = 4 0 → Set background color to Black.
P s = 4 1 → Set background color to Red.
P s = 4 2 → Set background color to Green.
P s = 4 3 → Set background color to Yellow.
P s = 4 4 → Set background color to Blue.
P s = 4 5 → Set background color to Magenta.
P s = 4 6 → Set background color to Cyan.
P s = 4 7 → Set background color to White.
P s = 4 9 → Set background color to default (original).

If 16-color support is compiled, the following apply. Assume that xterm’s resources are set so that the ISO color codes are the first 8 of a set of 16. Then the aixterm colors are the bright versions of the ISO colors:
P s = 9 0 → Set foreground color to Black.
P s = 9 1 → Set foreground color to Red.
P s = 9 2 → Set foreground color to Green.
P s = 9 3 → Set foreground color to Yellow.
P s = 9 4 → Set foreground color to Blue.
P s = 9 5 → Set foreground color to Magenta.
P s = 9 6 → Set foreground color to Cyan.
P s = 9 7 → Set foreground color to White.
P s = 1 0 0 → Set background color to Black.
P s = 1 0 1 → Set background color to Red.
P s = 1 0 2 → Set background color to Green.
P s = 1 0 3 → Set background color to Yellow.
P s = 1 0 4 → Set background color to Blue.
P s = 1 0 5 → Set background color to Magenta.
P s = 1 0 6 → Set background color to Cyan.
P s = 1 0 7 → Set background color to White.

If xterm is compiled with the 16-color support disabled, it supports the following, from rxvt:
P s = 1 0 0 → Set foreground and background color to default.

If 88- or 256-color support is compiled, the following apply.
P s = 3 8 ; 5 ; P s → Set foreground color to the second P s .
P s = 4 8 ; 5 ; P s → Set background color to the second P s .

Set or reset resource-values used by xterm to decide whether to construct escape sequences holding information about the modifiers pressed with a given key. The first parameter identifies the resource to set/reset. The second parameter is the value to assign to the resource. If the second parameter is omitted, the resource is reset to its initial value.
P s = 1 → modifyCursorKeys.
P s = 2 → modifyFunctionKeys.
P s = 4 → modifyOtherKeys.
If no parameters are given, all resources are reset to their initial values.

P s = 5 → Status Report. Result (‘‘OK’’) is
CSI 0 n
P s = 6 → Report Cursor Position (CPR) [row;column]. Result is
CSI r ; c R

P s = 1 → modifyCursorKeys.
P s = 2 → modifyFunctionKeys.
P s = 4 → modifyOtherKeys.
If the parameter is omitted, modifyFunctionKeys is disabled. When modifyFunctionKeys is disabled, xterm uses the modifier keys to make an extended sequence of functions rather than adding a parameter to each function key to denote the modifiers.

P s = 6 → Report Cursor Position (DECXCPR) [row;column] as CSI ? r ; c R (assumes the default page, i.e., "1").
P s = 1 5 → Report Printer status as CSI ? 1 0 n (ready). or CSI ? 1 1 n (not ready).
P s = 2 5 → Report UDK status as CSI ? 2 0 n (unlocked) or CSI ? 2 1 n (locked).
P s = 2 6 → Report Keyboard status as
CSI ? 2 7 ; 1 ; 0 ; 0 n (North American).
The last two parameters apply to VT400 & up, and denote keyboard ready and LK01 respectively.
P s = 5 3 → Report Locator status as CSI ? 5 3 n Locator available, if compiled-in, or CSI ? 5 0 n No Locator, if not.
P s = 6 2 → Report macro space (DECMSR) as CSI P n \* {
P s = 6 3 → Report memory checksum (DECCKSR) as DCS P t ! x x x x ST
P t is the request id (from an optional parameter to the request).
The x’s are hexadecimal digits 0-9 and A-F.
P s = 7 5 → Report data integrity as CSI ? 7 0 n (ready, no errors)
P s = 8 5 → Report multi-session configuration as CSI ? 8 3 n (not configured for multiple-session operation).

P s = 0 → never hide the pointer.
P s = 1 → hide if the mouse tracking mode is not enabled.
P s = 2 → always hide the pointer. If no parameter is given, xterm uses the default, which is 1 .

CSI P s ; P m $ y
where P s is the mode number as in RM, and P m is the mode value:
0 - not recognized
1 - set
2 - reset
3 - permanently set
4 - permanently reset

Request DEC private mode (DECRQM). For VT300 and up, reply is
CSI ? P s ; P m $ p
where P s is the mode number as in DECSET, P m is the mode value as in the ANSI DECRQM.

Set conformance level (DECSCL). Valid values for the first parameter:
P s = 6 1 → VT100.
P s = 6 2 → VT200.
P s = 6 3 → VT300.
Valid values for the second parameter:
P s = 0 → 8-bit controls.
P s = 1 → 7-bit controls (always set for VT100).
P s = 2 → 8-bit controls.

P s = 0 → Clear all LEDS (default).
P s = 1 → Light Num Lock.
P s = 2 → Light Caps Lock.
P s = 3 → Light Scroll Lock.
P s = 2 1 → Extinguish Num Lock.
P s = 2 2 → Extinguish Caps Lock.
P s = 2 3 → Extinguish Scroll Lock.

Set cursor style (DECSCUSR, VT520).
P s = 0 → blinking block.
P s = 1 → blinking block (default).
P s = 2 → steady block.
P s = 3 → blinking underline.
P s = 4 → steady underline.

P s = 0 → DECSED and DECSEL can erase (default).
P s = 1 → DECSED and DECSEL cannot erase.
P s = 2 → DECSED and DECSEL can erase.

Set Scrolling Region [top;bottom] (default = full size of window) (DECSTBM).

; P b ; P r ; P s $ r

P t ; P l ; P b ; P r denotes the rectangle.
P s denotes the SGR attributes to change: 0, 1, 4, 5, 7.

Set left and right margins (DECSLRM), available only when DECLRMM is enabled (VT420 and up).

s ; P s t

P s = 1 → De-iconify window.
P s = 2 → Iconify window.
P s = 3 ; x ; y → Move window to [x, y].
P s = 4 ; height ; width → Resize the xterm window to given height and width in pixels. Omitted parameters reuse the current height or width. Zero parameters use the display’s height or width.
P s = 5 → Raise the xterm window to the front of the stacking order.
P s = 6 → Lower the xterm window to the bottom of the stacking order.
P s = 7 → Refresh the xterm window.
P s = 8 ; height ; width → Resize the text area to given height and width in characters. Omitted parameters reuse the current height or width. Zero parameters use the display’s height or width.
P s = 9 ; 0 → Restore maximized window.
P s = 9 ; 1 → Maximize window (i.e., resize to screen size).
P s = 1 0 ; 0 → Undo full-screen mode.
P s = 1 0 ; 1 → Change to full-screen.
P s = 1 1 → Report xterm window state. If the xterm window is open (non-iconified), it returns CSI 1 t . If the xterm window is iconified, it returns CSI 2 t .
P s = 1 3 → Report xterm window position. Result is CSI 3 ; x ; y t
P s = 1 4 → Report xterm window in pixels. Result is CSI 4 ; height ; width t
P s = 1 8 → Report the size of the text area in characters. Result is CSI 8 ; height ; width t
P s = 1 9 → Report the size of the screen in characters. Result is CSI 9 ; height ; width t
P s = 2 0 → Report xterm window’s icon label. Result is OSC L label ST
P s = 2 1 → Report xterm window’s title. Result is OSC l label ST
P s = 2 2 ; 0 → Save xterm icon and window title on stack.
P s = 2 2 ; 1 → Save xterm icon title on stack.
P s = 2 2 ; 2 → Save xterm window title on stack.
P s = 2 3 ; 0 → Restore xterm icon and window title from stack.
P s = 2 3 ; 1 → Restore xterm icon title from stack.
P s = 2 3 ; 2 → Restore xterm window title from stack.
P s >= 2 4 → Resize to P s lines (DECSLPP).

Reverse Attributes in Rectangular Area (DECRARA), VT400 and up.
P t ; P l ; P b ; P r denotes the rectangle.
P s denotes the attributes to reverse, i.e., 1, 4, 5, 7.

Set one or more features of the title modes. Each parameter enables a single feature.
P s = 0 → Set window/icon labels using hexadecimal.
P s = 1 → Query window/icon labels using hexadecimal.
P s = 2 → Set window/icon labels using UTF-8.
P s = 3 → Query window/icon labels using UTF-8. (See discussion of "Title Modes")

Set warning-bell volume (DECSWBV, VT520).
P s = 0 or 1 → off.
P s = 2 , 3 or 4 → low.
P s = 5 , 6 , 7 , or 8 → high.

u

P s = 1 → off.
P s = 2 , 3 or 4 → low.
P s = 0 , 5 , 6 , 7 , or 8 → high.

Copy Rectangular Area (DECCRA, VT400 and up).
P t ; P l ; P b ; P r denotes the rectangle.
P p denotes the source page.
P t ; P l denotes the target location.
P p denotes the target page.

Enable Filter Rectangle (DECEFR), VT420 and up.
Parameters are [top;left;bottom;right].
Defines the coordinates of a filter rectangle and activates it. Anytime the locator is detected outside of the filter rectangle, an outside rectangle event is generated and the rectangle is disabled. Filter rectangles are always treated as "one-shot" events. Any parameters that are omitted default to the current locator position. If all parameters are omitted, any locator motion will be reported. DECELR always cancels any prevous rectangle definition.

if P s is a "0" (default) or "1", and xterm is emulating VT100, the control sequence elicits a response of the same form whose parameters describe the terminal:
P s → the given P s incremented by 2.
P n = 1 ← no parity.
P n = 1 ← eight bits.
P n = 1 ← 2 8 transmit 38.4k baud.
P n = 1 ← 2 8 receive 38.4k baud.
P n = 1 ← clock multiplier.
P n = 0 ← STP flags.

P s = 0 → from start to end position, wrapped.
P s = 1 → from start to end position, wrapped.
P s = 2 → rectangle (exact).

Request Checksum of Rectangular Area (DECRQCRA), VT420 and up. Response is
DCS P t ! x x x x ST
P i is the request id.
P g is the page number.
P t ; P l ; P b ; P r denotes the rectangle.
The x’s are hexadecimal digits 0-9 and A-F.

Fill Rectangular Area (DECFRA), VT420 and up.
P c is the character to use.
P t ; P l ; P b ; P r denotes the rectangle.

Enable Locator Reporting (DECELR).
Valid values for the first parameter:
P s = 0 → Locator disabled (default).
P s = 1 → Locator enabled.
P s = 2 → Locator enabled for one report, then disabled.
The second parameter specifies the coordinate unit for locator reports.
Valid values for the second parameter:
P u = 0 ← or omitted → default to character cells.
P u = 1 ← device physical pixels.
P u = 2 ← character cells.

Erase Rectangular Area (DECERA), VT400 and up.
P t ; P l ; P b ; P r denotes the rectangle.

Valid values for the first (and any additional parameters) are:
P s = 0 → only respond to explicit host requests (DECRQLP).
(This is default). It also cancels any filter
rectangle.
P s = 1 → report button down transitions.
P s = 2 → do not report button down transitions.
P s = 3 → report button up transitions.
P s = 4 → do not report button up transitions.

Selective Erase Rectangular Area (DECSERA), VT400 and up.
P t ; P l ; P b ; P r denotes the rectangle.

Valid values for the parameter are:
P s = 0 , 1 or omitted → transmit a single DECLRP locator report.

If Locator Reporting has been enabled by a DECELR, xterm will respond with a DECLRP Locator Report. This report is also generated on button up and down events if they have been enabled with a DECSLE, or when the locator is detected outside of a filter rectangle, if filter rectangles have been enabled with a DECEFR.

→ CSI P e ; P b ; P r ; P c ; P p & w

Parameters are [event;button;row;column;page].
Valid values for the event:
P e = 0 → locator unavailable - no other parameters sent.
P e = 1 → request - xterm received a DECRQLP.
P e = 2 → left button down.
P e = 3 → left button up.
P e = 4 → middle button down.
P e = 5 → middle button up.
P e = 6 → right button down.
P e = 7 → right button up.
P e = 8 → M4 button down.
P e = 9 → M4 button up.
P e = 1 0 → locator outside filter rectangle.
‘‘button’’ parameter is a bitmask indicating which buttons are pressed:
P b = 0 ← no buttons down.
P b & 1 ← right button down.
P b & 2 ← middle button down.
P b & 4 ← left button down.
P b & 8 ← M4 button down.
‘‘row’’ and ‘‘column’’ parameters are the coordinates of the locator position in the xterm window, encoded as ASCII decimal.
The ‘‘page’’ parameter is not used by xterm, and will be omitted.

Insert P s Column(s) (default = 1) (DECIC), VT420 and up.

Delete P s Column(s) (default = 1) (DECDC), VT420 and up.

Operating System Controls

Set Text Parameters. For colors and font, if P t is a "?", the control sequence elicits a response which consists of the control sequence which would set the corresponding value. The dtterm control sequences allow you to determine the icon name and window title.
P s = 0 → Change Icon Name and Window Title to P t .
P s = 1 → Change Icon Name to P t .
P s = 2 → Change Window Title to P t .
P s = 3 → Set X property on top-level window. P t should be in the form "prop=value", or just "prop" to delete the property
P s = 4 ; c ; spec → Change Color Number c to the color specified by spec. This can be a name or RGB specification as per XParseColor. Any number of c name pairs may be given. The color numbers correspond to the ANSI colors 0-7, their bright versions 8-15, and if supported, the remainder of the 88-color or 256-color table.

If a "?" is given rather than a name or RGB specification, xterm replies with a control sequence of the same form which can be used to set the corresponding color. Because more than one pair of color number and specification can be given in one control sequence, xterm can make more than one reply.

P s = 5 ; c ; spec → Change Special Color Number c to the color specified by spec. This can be a name or RGB specification as per XParseColor. Any number of c name pairs may be given. The special colors can also be set by adding the maximum number of colors to these codes in an OSC 4 control:

P c = 0 ← resource colorBD (BOLD).
P c = 1 ← resource colorUL (UNDERLINE).
P c = 2 ← resource colorBL (BLINK).
P c = 3 ← resource colorRV (REVERSE).

The 10 colors (below) which may be set or queried using 1 0 through 1 9 are denoted dynamic colors, since the corresponding control sequences were the first means for setting xterm’s colors dynamically, i.e., after it was started. They are not the same as the ANSI colors. These controls may be disabled using the allowColorOps resource. At least one parameter is expected for P t . Each successive parameter changes the next color in the list. The value of P s tells the starting point in the list. The colors are specified by name or RGB specification as per XParseColor.

If a "?" is given rather than a name or RGB specification, xterm replies with a control sequence of the same form which can be used to set the corresponding dynamic color. Because more than one pair of color number and specification can be given in one control sequence, xterm can make more than one reply.

P s = 1 0 → Change VT100 text foreground color to P t .
P s = 1 1 → Change VT100 text background color to P t .
P s = 1 2 → Change text cursor color to P t .
P s = 1 3 → Change mouse foreground color to P t .
P s = 1 4 → Change mouse background color to P t .
P s = 1 5 → Change Tektronix foreground color to P t .
P s = 1 6 → Change Tektronix background color to P t .
P s = 1 7 → Change highlight background color to P t .
P s = 1 8 → Change Tektronix cursor color to P t .
P s = 1 9 → Change highlight foreground color to P t .

P s = 4 6 → Change Log File to P t . (This is normally disabled by a compile-time option).

P s = 5 0 → Set Font to P t . These controls may be disabled using the allowFontOps resource. If P t begins with a "#", index in the font menu, relative (if the next character is a plus or minus sign) or absolute. A number is expected but not required after the sign (the default is the current entry for relative, zero for absolute indexing).
The same rule (plus or minus sign, optional number) is used when querying the font. The remainder of P t is ignored.
A font can be specified after a "#" index expression, by adding a space and then the font specifier.
If the "TrueType Fonts" menu entry is set (the renderFont resource), then this control sets/queries the faceName resource.

P s = 5 1 (reserved for Emacs shell).

P s = 5 2 → Manipulate Selection Data. These controls may be disabled using the allowWindowOps resource. The parameter P t is parsed as

The first, P c , may contain zero or more characters from the set c p s 0 1 2 3 4 5 6 7 . It is used to construct a list of selection parameters for clipboard, primary, select, or cut buffers 0 through 7 respectively, in the order given. If the parameter is empty, xterm uses s 0 , to specify the configurable primary/clipboard selection and cut buffer 0.
The second parameter, P d , gives the selection data. Normally this is a string encoded in base64. The data becomes the new selection, which is then available for pasting by other applications.
If the second parameter is a ? , xterm replies to the host with the selection data encoded using the same protocol.
If the second parameter is neither a base64 string nor ? , then the selection is cleared.

P s = 1 0 4 ; c → Reset Color Number c. It is reset to the color specified by the corresponding X resource. Any number of c parameters may be given. These parameters correspond to the ANSI colors 0-7, their bright versions 8-15, and if supported, the remainder of the 88-color or 256-color table. If no parameters are given, the entire table will be reset.

P s = 1 0 5 ; c → Reset Special Color Number c. It is reset to the color specified by the corresponding X resource. Any number of c parameters may be given. These parameters correspond to the special colors which can be set using an OSC 5 control (or by adding the maximum number of colors using an OSC 4 control).

The dynamic colors can also be reset to their default (resource) values:
P s = 1 1 0 → Reset VT100 text foreground color.
P s = 1 1 1 → Reset VT100 text background color.
P s = 1 1 2 → Reset text cursor color.
P s = 1 1 3 → Reset mouse foreground color.
P s = 1 1 4 → Reset mouse background color.
P s = 1 1 5 → Reset Tektronix foreground color.
P s = 1 1 6 → Reset Tektronix background color.
P s = 1 1 7 → Reset highlight color.
P s = 1 1 8 → Reset Tektronix cursor color.

Privacy Message

Alt and Meta Keys

Many keyboards have keys labeled "Alt". Few have keys labeled "Meta". However, xterm’s default translations use the Meta modifier. Common keyboard configurations assign the Meta modifier to an "Alt" key. By using xmodmap one may have the modifier assigned to a different key, and have "real" alt and meta keys. Here is an example:

! put meta on mod3 to distinguish it from alt
keycode 64 = Alt_L
clear mod1
add mod1 = Alt_L
keycode 115 = Meta_L
clear mod3
add mod3 = Meta_L

The metaSendsEscape resource (and altSendsEscape if altIsNotMeta is set) can be used to control the way the Meta modifier applies to ordinary keys unless the modifyOtherKeys resource is set:

- prefix a key with the ESC character.
- shift the key from codes 0-127 to 128-255 by adding 128.

The table shows the result for a given character "x" with modifiers according to the default translations with the resources set on or off. This assumes altIsNotMeta is set:

PC-Style Function Keys

If xterm does minimal translation of the function keys, it usually does this with a PC-style keyboard, so PC-style function keys result. Sun keyboards are similar to PC keyboards. Both have cursor and scrolling operations printed on the keypad, which duplicate the smaller cursor and scrolling keypads.

X does not predefine NumLock (used for VT220 keyboards) or Alt (used as an extension for the Sun/PC keyboards) as modifiers. These keys are recognized as modifiers when enabled by the numLock resource, or by the "DECSET 1 0 3 5 " control sequence.

The cursor keys transmit the following escape sequences depending on the mode specified via the DECCKM escape sequence.

The home- and end-keys (unlike PageUp and other keys also on the 6-key editing keypad) are considered "cursor keys" by xterm. Their mode is also controlled by the DECCKM escape sequence:

The application keypad transmits the following escape sequences depending on the mode specified via the DECPNM and DECPAM escape sequences. Use the NumLock key to override the application mode.

Not all keys are present on the Sun/PC keypad (e.g., PF1, Tab), but are supported by the program.

They also provide 12 function keys, as well as a few other special-purpose keys:

Older versions of xterm implement different escape sequences for F1 through F4. These can be activated by setting the oldXtermFKeys resource. However, since they do not correspond to any hardware terminal, they have been deprecated. (The DEC VT220 reserves F1 through F5 for local functions such as Setup).

In normal mode, i.e., a Sun/PC keyboard when the sunKeyboard resource is false, xterm recognizes function key modifiers which are parameters appended before the final character of the control sequence.

For example, shift-F5 would be sent as CSI 1 5 ; 2 ~

If the alwaysUseMods resource is set, the Meta modifier also is recognized, making parameters 9 through 16.

VT220-Style Function Keys

However, xterm is most useful as a DEC VT102 or VT220 emulator. Set the sunKeyboard resource to true to force a Sun/PC keyboard to act like a VT220 keyboard.

The VT102/VT220 application keypad transmits unique escape sequences in application mode, which are distinct from the cursor and scrolling keypad:

The VT220 provides a 6-key editing keypad, which is analogous to that on the PC keyboard. It is not affected by DECCKM or DECPNM/DECPAM:

The VT220 provides 8 additional function keys. With a Sun/PC keyboard, access these keys by Control/F1 for F13, etc.

VT52-Style Function Keys

A VT52 does not have function keys, but it does have a numeric keypad and cursor keys. They differ from the other emulations by the prefix. Also, the cursor keys do not change:

The keypad is similar:

Sun-Style Function Keys

The xterm program provides support for Sun keyboards more directly, by a menu toggle that causes it to send Sun-style function key codes rather than VT220. Note, however, that the sun and VT100 emulations are not really compatible. For example, their wrap-margin behavior differs.

Only function keys are altered; keypad and cursor keys are the same. The emulation responds identically. See the xterm-sun terminfo entry for details.

HP-Style Function Keys

Similarly, xterm can be compiled to support HP keyboards. See the xterm-hp terminfo entry for details.

The Alternate Screen Buffer

Xterm maintains two screen buffers. The normal screen buffer allows you to scroll back to view saved lines of output up to the maximum set by the saveLines resource. The alternate screen buffer is exactly as large as the display, contains no additional saved lines. When the alternate screen buffer is active, you cannot scroll back to view saved lines. Xterm provides control sequences and menu entries for switching between the two.

Most full-screen applications use terminfo or termcap to obtain strings used to start/stop full-screen mode, i.e., smcup and rmcup for terminfo, or the corresponding ti and te for termcap. The titeInhibit resource removes the ti and te strings from the TERMCAP string which is set in the environment for some platforms. That is not done when xterm is built with terminfo libraries because terminfo does not provide the whole text of the termcap data in one piece. It would not work for terminfo anyway, since terminfo data is not passed in environment variables; setting an environment variable in this manner would have no effect on the application’s ability to switch between normal and alternate screen buffers. Instead, the newer private mode controls (such as 1 0 4 9 ) for switching between normal and alternate screen buffers simply disable the switching. They add other features such as clearing the display for the same reason: to make the details of switching independent of the application that requests the switch.

Bracketed Paste Mode

When bracketed paste mode is set, pasted text is bracketed with control sequences so that the program can differentiate pasted text from typed-in text. When bracketed paste mode is set, the program will receive:
ESC [ 200 ~,
followed by the pasted text, followed by
ESC [ 201 ~.

Title Modes

The window- and icon-labels can be set or queried using control sequences. As a VT220-emulator, xterm "should" limit the character encoding for the corresponding strings to ISO-8859-1. Indeed, it used to be the case (and was documented) that window titles had to be ISO-8859-1. This is no longer the case. However, there are many applications which still assume that titles are set using ISO-8859-1. So that is the default behavior.

If xterm is running with UTF-8 encoding, it is possible to use window- and icon-labels encoded using UTF-8. That is because the underlying X libraries (and many, but not all) window managers support this feature.

The utf8Title X resource setting tells xterm to disable a reconversion of the title string back to ISO-8859-1, allowing the title strings to be interpreted as UTF-8. The same feature can be enabled using the title mode control sequence described in this summary.

Separate from the ability to set the titles, xterm provides the ability to query the titles, returning them either in ISO-8859-1 or UTF-8. This choice is available only while xterm is using UTF-8 encoding.

Finally, the characters sent to, or returned by a title control are less constrained than the rest of the control sequences. To make them more manageable (and constrained), for use in shell scripts, xterm has an optional feature which decodes the string from hexadecimal (for setting titles) or for encoding the title into hexadecimal when querying the value.

Mouse Tracking

The VT widget can be set to send the mouse position and other information on button presses. These modes are typically used by editors and other full-screen applications that want to make use of the mouse.

There are two sets of mutually exclusive modes:

The mouse protocols include DEC Locator mode, enabled by the DECELR CSI P s ; P s ’ z control sequence, and is not described here (control sequences are summarized above). The remaining five modes of the mouse protocols are each enabled (or disabled) by a different parameter in the "DECSET CSI ? P m h " or "DECRST CSI ? P m l " control sequence.

Manifest constants for the parameter values are defined in xcharmouse.h as follows:

#define SET_X10_MOUSE 9
#define SET_VT200_MOUSE 1000
#define SET_VT200_HIGHLIGHT_MOUSE 1001
#define SET_BTN_EVENT_MOUSE 1002
#define SET_ANY_EVENT_MOUSE 1003

#define SET_FOCUS_EVENT_MOUSE 1004

#define SET_EXT_MODE_MOUSE 1005
#define SET_SGR_EXT_MODE_MOUSE 1006
#define SET_URXVT_EXT_MODE_MOUSE 1015

The motion reporting modes are strictly xterm extensions, and are not part of any standard, though they are analogous to the DEC VT200 DECELR locator reports.

Normally, parameters (such as pointer position and button number) for all mouse tracking escape sequences generated by xterm encode numeric parameters in a single character as value+32. For example, ! specifies the value 1. The upper left character position on the terminal is denoted as 1,1. This scheme dates back to X10, though the normal mouse-tracking (from X11) is more elaborate.

X10 compatibility mode sends an escape sequence only on button press, encoding the location and the mouse button pressed. It is enabled by specifying parameter 9 to DECSET. On button press, xterm sends CSI M C b C x C y (6 characters).

Normal tracking mode sends an escape sequence on both button press and release. Modifier key (shift, ctrl, meta) information is also sent. It is enabled by specifying parameter 1000 to DECSET. On button press or release, xterm sends CSI M C b C x C y .

Wheel mice may return buttons 4 and 5. Those buttons are represented by the same event codes as buttons 1 and 2 respectively, except that 64 is added to the event code. Release events for the wheel buttons are not reported.

Mouse highlight tracking notifies a program of a button press, receives a range of lines from the program, highlights the region covered by the mouse within that range until button release, and then sends the program the release coordinates. It is enabled by specifying parameter 1001 to DECSET. Highlighting is performed only for button 1, though other button events can be received.

Warning: use of this mode requires a cooperating program or it will hang xterm.

On button press, the same information as for normal tracking is generated; xterm then waits for the program to send mouse tracking information. All X events are ignored until the proper escape sequence is received from the pty: CSI P s ; P s ; P s ; P s ; P s T . The parameters are func, startx, starty, firstrow, and lastrow. func is non-zero to initiate highlight tracking and zero to abort. startx and starty give the starting x and y location for the highlighted region. The ending location tracks the mouse, but will never be above row firstrow and will always be above row lastrow. (The top of the screen is row 1.) When the button is released, xterm reports the ending position one of two ways:

CSI t C x C y .

CSI T C x C y C x C y C x C y .
The parameters are startx, starty, endx, endy, mousex, and mousey.

Button-event tracking is essentially the same as normal tracking, but xterm also reports button-motion events. Motion events are reported only if the mouse pointer has moved to a different character cell. It is enabled by specifying parameter 1002 to DECSET. On button press or release, xterm sends the same codes used by normal tracking mode.

Any-event mode is the same as button-event mode, except that all motion events are reported, even if no mouse button is down. It is enabled by specifying 1003 to DECSET.

FocusIn/FocusOut can be combined with any of the mouse events since it uses a different protocol. When set, it causes xterm to send CSI I when the terminal gains focus, and CSI O when it loses focus.

The original X10 mouse protocol limits the C x and C y ordinates to 223 (=255 - 32). Xterm supports more than one scheme for extending this range, by changing the protocol encoding:

This enables UTF-8 encoding for C x and C y under all tracking modes, expanding the maximum encodable position from 223 to 2015. For positions less than 95, the resulting output is identical under both modes. Under extended mouse mode, positions greater than 95 generate "extra" bytes which will confuse applications which do not treat their input as a UTF-8 stream. Likewise, C b will be UTF-8 encoded, to reduce confusion with wheel mouse events.
Under normal mouse mode, positions outside (160,94) result in byte pairs which can be interpreted as a single UTF-8 character; applications which do treat their input as UTF-8 will almost certainly be confused unless extended mouse mode is active.
This scheme has the drawback that the encoded coordinates will not pass through luit unchanged, e.g., for locales using non-UTF-8 encoding.

The encoded button value in this case does not add 32 since that was useful only in the X10 scheme for ensuring that the byte containing the button value is a printable code. The modifiers are encoded in the same way. A different final character is used for button release to resolve the X10 ambiguity regarding which button was released.
The highlight tracking responses are also modified to an SGR-like format, using the same SGR-style scheme and button-encodings.

The normal mouse response is altered to use CSI followed by semicolon-separated encoded button value, the C x and C y ordinates and final character M .
This uses the same button encoding as X10, but printing it as a decimal integer rather than as a single byte.
However, CSI M can be mistaken for DL (delete lines), while the highlight tracking CSI T can be mistaken for SD (scroll down), and the Window manipulation controls. For these reasons, the 1015 control is not recommended; it is not an improvement over 1005.

Tektronix 4014 Mode

Most of these sequences are standard Tektronix 4014 control sequences. Graph mode supports the 12-bit addressing of the Tektronix 4014. The major features missing are the write-through and defocused modes. This document does not describe the commands used in the various Tektronix plotting modes but does describe the commands to switch modes.

ETB (end transmission block) is the same as Ctrl-W.

t BEL

P s = 0 → Change Icon Name and Window Title to P t .
P s = 1 → Change Icon Name to P t .
P s = 2 → Change Window Title to P t .
P s = 4 6 → Change Log File to P t . (This is normally disabled by a compile-time option).

VT52 Mode

Parameters for cursor movement are at the end of the ESC Y escape sequence. Each ordinate is encoded in a single character as value+32. For example, ! is 1. The screen coordinate system is 0-based.

s

→ ESC / Z (‘‘I am a VT52.’’).