XTerm Control Sequences

http://invisible-island.net/xterm/
Admin
XTerm Control Sequences is a comprehensive reference guide documenting the escape sequences and...
Tokens:10,595
Snippets:155
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### XTerm Keymap Configuration

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Configure key mappings for Alt and Meta keys using xmodmap. This example assigns Meta to mod3 and distinguishes it from Alt.

```shell
! 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
```

--------------------------------

### VT52 Keypad Sequences

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Shows the keypad sequences for VT52 emulation, noting they differ from other emulations by their prefix.

```text
                  Key            Numeric    Application

```

--------------------------------

### XTerm Home/End Key Sequences (Application Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Escape sequences for Home and End keys in XTerm's application mode.

```text
SS3 H
```

```text
SS3 F
```

--------------------------------

### XTerm Home/End Key Sequences (Normal Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Escape sequences for Home and End keys in XTerm's normal mode.

```text
CSI H
```

```text
CSI F
```

--------------------------------

### XTerm Numeric Keypad Sequences (Application Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Escape sequences for the numeric keypad keys when operating in application mode.

```text
SS3 SP
```

```text
SS3 I
```

```text
SS3 M
```

```text
SS3 P
```

```text
SS3 Q
```

```text
SS3 R
```

```text
SS3 S
```

```text
SS3 j
```

```text
SS3 k
```

```text
SS3 l
```

```text
CSI 3 ~
```

```text
SS3 m
```

```text
SS3 o
```

```text
CSI 2 ~
```

```text
SS3 F
```

```text
CSI B
```

```text
CSI 6 ~
```

```text
CSI D
```

```text
CSI E
```

```text
CSI C
```

```text
SS3 H
```

```text
CSI A
```

```text
CSI 5 ~
```

```text
SS3 X
```

--------------------------------

### XTerm Function Key Sequences (Older Compatibility)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Older XTerm compatibility escape sequences for function keys F1-F3, activated by the oldXtermFKeys resource.

```text
CSI 1 1 ~
```

```text
CSI 1 2 ~
```

```text
CSI 1 3 ~
```

--------------------------------

### XTerm Mouse Tracking Constants

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Manifest constants for enabling various mouse tracking modes in xterm. These are used with DECSET CSI ? Pm h or DECRST CSI ? Pm l control sequences.

```c
#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

     #define SET_ALTERNATE_SCROLL        1007
```

--------------------------------

### Highlight Tracking Mode

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Enables highlight tracking mode, notifying a program of button presses and receiving mouse tracking information to highlight a region. Requires a cooperating program to avoid hanging xterm. Enabled with parameter 1001 to DECSET.

```xterm
CSI Ps ; Ps ; Ps ; Ps ; Ps T
```

--------------------------------

### VT220 Editing Keypad Sequences

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Shows the control sequences for the VT220's 6-key editing keypad, which are unaffected by DECCKM or DECKPNM/DECKPAM.

```text
                   Key        Normal     Application
                   ---------+----------+-------------
                   Insert   | CSI 2 ~  | CSI 2 ~
                   Delete   | CSI 3 ~  | CSI 3 ~
                   Home     | CSI 1 ~  | CSI 1 ~
                   End      | CSI 4 ~  | CSI 4 ~
                   PageUp   | CSI 5 ~  | CSI 5 ~
                   PageDown | CSI 6 ~  | CSI 6 ~
                   ---------+----------+-------------
```

--------------------------------

### X10 Compatibility Mouse Tracking

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Enables X10 compatibility mode for mouse tracking. Sends an escape sequence only on button press, encoding location and button. Enabled with parameter 9 to DECSET.

```xterm
CSI M CbCxCy
```

--------------------------------

### VT52 Cursor Key Sequences

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Provides the escape sequences for VT52 cursor keys, which are the same in both normal and application modes.

```text
                   Key            Normal/Application
                   -------------+--------------------
                   Cursor Up    | ESC A
                   Cursor Down  | ESC B
                   Cursor Right | ESC C
                   Cursor Left  | ESC D
                   ------------+--------------------
```

--------------------------------

### XTerm Cursor Key Sequences (Application Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

These are the escape sequences transmitted by XTerm for cursor keys when in application mode.

```text
SS3 A
```

```text
SS3 B
```

```text
SS3 C
```

```text
SS3 D
```

--------------------------------

### XTerm Function Key Sequences (Standard)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Standard escape sequences for function keys F1-F12 in XTerm.

```text
SS3 P
```

```text
SS3 Q
```

```text
SS3 R
```

```text
SS3 S
```

```text
CSI 1 5 ~
```

```text
CSI 1 7 ~
```

```text
CSI 1 8 ~
```

```text
CSI 1 9 ~
```

```text
CSI 2 0 ~
```

```text
CSI 2 1 ~
```

```text
CSI 2 3 ~
```

```text
CSI 2 4 ~
```

--------------------------------

### XTerm Numeric Keypad Sequences (Numeric Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Escape sequences for the numeric keypad keys when operating in numeric mode.

```text
SP
```

```text
TAB
```

```text
CR
```

```text
SS3 P
```

```text
SS3 Q
```

```text
SS3 R
```

```text
SS3 S
```

```text
"*"
```

```text
"+ " 
```

```text
","
```

```text
"-"
```

```text
". "
```

```text
"/ "
```

```text
"0"
```

```text
"1"
```

```text
"2"
```

```text
"3"
```

```text
"4"
```

```text
"5"
```

```text
"6"
```

```text
"7"
```

```text
"8"
```

```text
"9"
```

```text
"="
```

--------------------------------

### XTerm Function Key Modifiers

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Explains how xterm encodes function key modifiers as parameters before the final character of a control sequence. Modifiers like Shift, Alt, Control, and Meta are mapped to specific numeric parameters.

```text
F4       | CSI 1 4 ~
               --------+-----------------

In normal mode, i.e., a Sun/PC keyboard when the sunKeyboard resource is
false (and none of the other keyboard resources such as oldXtermFKeys
resource is set), xterm encodes function key modifiers as parameters
appended before the final character of the control sequence.  As a spe-
cial case, the SS3  sent before F1 through F4 is altered to CSI  when
sending a function key modifier as a parameter.

                     Code     Modifiers
                   ---------+---------------------------
                      2     | Shift
                      3     | Alt
                      4     | Shift + Alt
                      5     | Control
                      6     | Shift + Control
                      7     | Alt + Control
                      8     | Shift + Alt + Control
                      9     | Meta
                      10    | Meta + Shift
                      11    | Meta + Alt
                      12    | Meta + Alt + Shift
                      13    | Meta + Ctrl
                      14    | Meta + Ctrl + Shift
                      15    | Meta + Ctrl + Alt
                      16    | Meta + Ctrl + Alt + Shift
                   ---------+---------------------------

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

If the alwaysUseMods resource is set, the Meta modifier also is recog-
nized, making parameters 9 through 16.
```

--------------------------------

### VT102/VT220 Application Keypad Sequences

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Details the unique escape sequences transmitted by the VT102/VT220 application keypad in application mode. These sequences are distinct from cursor and scrolling keypads.

```text
                  Key            Numeric    Application
                  -------------+----------+-------------
                  Space        | SP       | SS3 SP
                  Tab          | TAB      | SS3 I
                  Enter        | CR       | SS3 M
                  PF1          | SS3 P    | SS3 P
                  PF2          | SS3 Q    | SS3 Q
                  PF3          | SS3 R    | SS3 R
                  PF4          | SS3 S    | SS3 S
                  * (multiply) | *        | SS3 j
                  + (add)      | +        | SS3 k
                  , (comma)    | ,        | SS3 l
                  - (minus)    | -        | SS3 m
                  . (period)   | .        | SS3 n
                  / (divide)   | /        | SS3 o
                  0            | 0        | SS3 p
                  1            | 1        | SS3 q
                  2            | 2        | SS3 r
                  3            | 3        | SS3 s
                  4            | 4        | SS3 t
                  5            | 5        | SS3 u
                  6            | 6        | SS3 v
                  7            | 7        | SS3 w
                  8            | 8        | SS3 x
                  9            | 9        | SS3 y
                  = (equal)    | =        | SS3 X
                  ------------+----------+-------------
```

--------------------------------

### XTerm Cursor Key Sequences (Normal Mode)

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

These are the standard escape sequences transmitted by XTerm for cursor keys when not in application mode.

```text
CSI A
```

```text
CSI B
```

```text
CSI C
```

```text
CSI D
```

--------------------------------

### VT220 Additional Function Keys

Source: https://gist.githubusercontent.com/justinmk/a5102f9a0c1810437885a04a07ef0a91/raw/b66b17a605590afbd725c092b0cdc58e15d461a2/XTerm-Control-Sequences.txt

Lists the escape sequences for the 8 additional function keys on the VT220, accessible via Control/F1 for F13 on a Sun/PC keyboard.

```text
                       Key        Escape Sequence
                       ---------+-----------------
                       F13      | CSI 2 5 ~
                       F14      | CSI 2 6 ~
                       F15      | CSI 2 8 ~
                       F16      | CSI 2 9 ~
                       F17      | CSI 3 1 ~
                       F18      | CSI 3 2 ~
                       F19      | CSI 3 3 ~
                       F20      | CSI 3 4 ~
                       ---------+-----------------
```
Tokens:
Raw