blob: cdd184ecdc8ed2a80c1f5ffefce08c483ff17286 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
foot-ctlseqs(5)
# DESCRIPTION
This document describes all the control sequences supported by foot.
- CC0 - 7-bit control sequences
- CC1 - 8-bit control sequences (*not supported*)
- CSI - Control Sequence Introducer
- OSC - Operating System Command
- DCS - Device Control String
# CC0 - 7-bit control sequences
[[ *Sequence*
:[ *Name*
:[ *Description*
| *\\a*
: BEL
: Depends on what *bell* in *foot.ini*(5)
| *\\b*
: BS
: Backspace; move the cursor left one step. Wrap if _bw_ is enabled.
| *\\t*
: HT
: Horizontal tab; move the cursor to the next tab stop.
| *\\n*
: LF
: Line feed; move the cursor down one step, or scroll content up if
at the bottom line.
| *\\v*
: VT
: Vertical tab; identical to _LF_.
| *\\f*
: FF
: Form feed; identical to _LF_.
| *\\r*
: CR
: Carriage ret; move the cursor to the left most column.
| *\\x0E*
: SS0
: Shift out; select the _G1_ character set.
| *\\x0F*
: SS1
: Shift in; select the _G0_ character set.
# CC1 - 8-bit control sequences
Foot does not support any CC1 control sequences.
# CSI
All sequences begin with *\\E[*, denoted _CSI_ in the tables
below. Spaces are used in the sequence strings to make them easier to
read, but are not actually part of the string. I.e. *CSI 1 m* is
really *\\E1m*.
## SGR
All SGR sequences are on the form *CSI <N> m*, where _N_ is a decimal
number - the _parameter_. Multiple parameters can be combined in a
single CSI sequence by separating them with semicolons: *CSI 1;2;3 m*
[[ *Sequence*
:[ *Description*
| 0
: Reset all attributes.
| 1
: Bold
| 2
: Dim
| 3
: Italic
| 4
: Underline
| 5
: Blink
| 7
: Reverse video; swap foreground and background colors
| 8
: Conceal; text is not visible, but is copyable
| 9
: Crossed-out/strike
| 22
: Disable *bold* and *dim*
| 23
: Disable italic
| 24
: Disable underline
| 25
: Disable blink
| 27
: Disable reverse video
| 28
: Disable conceal
| 29
: Disable crossed-out
| 30-37
: Select foreground color (using *regularN* in *foot.ini*(5))
| 38
: See indexed and RGB colors below
| 39
: Use the default foreground color (*foreground* in *foot.ini*(5))
| 40-47
: Select background color (using *regularN* in *foot.ini*(5))
| 48
: See indexed and RGB colors below
| 49
: Use the default background color (*background* in *foot.ini*(5))
| 90-97
: Select foreground color (using *brightN* in *foot.ini*(5))
| 100-107
: Select background color (using *brightN* in *foot.ini*(5))
## Indexed and RGB colors (256-color palette and 24-bit colors)
Foot supports both the new sub-parameter based variants, and the older
parameter based variants for setting foreground and background colors.
Indexed colors:
- *CSI 38:5:<idx> m*
- *CSI 38;5;<idx> m*
RGB colors:
- *CSI 38:2:<cs>:<r>:<g>:<b> m*
- *CSI 38:2:<r>:<g>:<b> m*
- *CSI 38;2;<r>;<g>;<b> m*
The first variant is the "correct" one (and foot also recognizes, but
ignores, the optional _tolerance_ parameters).
The second one is allowed since many programs "forget" the color space
ID, _cs_.
The sub-parameter based variants are preferred, and what foot's
terminfo uses.
## DECSET/DECRST
*TODO*
## Other
*TODO*: all other CSI sequences that does not fall into any of the
above categories.
# OSC
*TODO*
All _OSC_ sequences begin with *\\E]*.
# DCS
*TODO*
All _DCS_ sequences begin with *\\EP*, and are terminated by *\\E\\*
(ST).
|