cterm.txt 45.1 KB
Newer Older
1
2
3
$Id$

CTerm terminal characteristics:
4
5
------------------------------

6
7
8
9
10
11
12
End of line behaviour (wrapping):
The cursor is moved to the first character of the next line
as soon as a character is written to the last column of the
current line, not on the next character.  A tab will wrap
to the next line only if the current cursor position is the
last character on the line.

13
14
15
16
17
18
19
20
21
22
23
I'm often asked why I don't use VT semantics for wrapping.
The primary reason is that the person asking almost certainly
doesn't know what the VT semantics are, they just want
SyncTERM to behave the same as some other terminal they like.

Not only have the VT semantics never been properly
implemented in any terminal, they even varied between
different actual hardware VT terminals.  Luckily, everything
is on the internet now, so you can see the details and results
here: https://github.com/mattiase/wraptest

24
25
Control characters:

26
0x00 - NUL:
27
28
29
30
31
	In doorway mode, indicates that the next character is
	a literal character.  The IBM CP437 character will
	be displayed.  This allows ESC and other control
	characters to be placed on the screen.

32
33
0x07 - BEL:
	Beep
34

35
0x08 - BS:
36
37
38
39
	Non-destructive backspace.  Moves cursor position to
	the previous column unless the current column is the
	first, in which case no operation is performed.

40
41
0x09 - HT:
	Moves to the next horizontal tab stop.  Does not overwrite
42
43
44
45
46
	any characters in between.  If there are no tab stops left
	in the line, moves to the first position of the next line.
	If the starting position is on the last line, will perform
	a scroll, filling the new line at bottom with the current
	attribute.
47

48
49
50
51
52
53
54
55
0x0A - LF:
	Move cursor position to same column of the next row.
	If current row is the last row, scrolls the screen up
	and fills the new row with the current attribute.

0x0D - CR:
	Move cursor position to column 1 of the current line

56
57
58
59
Control Codes:
--------------

Control codes are in the following format:
deuce's avatar
deuce committed
60
ESC {'0' (ZERO) to '~'}
61
62
	Legal combinations which are not handled are silently dropped.

63
64
65
66
67
ESC E	Next Line (NEL)
	Moves to the line home position of the next line.
	(Same as CR LF)

ESC H	Set Tab (HTS)
deuce's avatar
deuce committed
68
	Sets a tab stop at the current column
69

deuce's avatar
deuce committed
70
71
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

72
ESC M	Reverse Line Feed (RI)
deuce's avatar
deuce committed
73
74
75
	Move up one line

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
76

77
ESC P	Device Control String (DCS)
deuce's avatar
deuce committed
78
79
80
	Begins a string consisting of the characters 0x08 - 0x0d and
	0x20-0x7e, terminated by a String Terminator (ST)
	Supported OSC values:
81
82
83
84
85
86
87
88
89
		"CTerm:Font:p1:<b64>"
		Indicates the string is a loadable font. (CTerm 1.213)

		p1 is a font slot number, which must be higher than the last
		default defined font (See CSI sp D for list of predefined
		fonts). <b64> is the base64 encoded font data.  Font size is
		deduced from the size of the data.  This replaces the now
		deprecated CSI = Ps1 ; Ps2 {

90

deuce's avatar
deuce committed
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
		[ p1 [ ; p2 ] ] q
		Defaults:  p1 = 0  p2 = 0
		Indicates the string is a sixel sequence.

		p1 selects the vertical height of a single pixel.  This
		may be overridden by the raster attributes command, and
		is deprecated.  Supported values
		
			Value      Vertical Size
			-----      -------------
			0,1,5,6    2 pixels
			2          5 pixels
			3,4        3 pixels
			7,8,9      1 pixel

		p2 indicates if unset sixels should be set to the current
		background colour.  If p2 is 1, positions specified as 0
		remain at their current colour.

		Any additional parameters are ignored.

		The rest of the string is made up of sixel data characters and
		sixel control functions.  Sixel data characters are in the
		rage of '?' (0x3f) to '~' (0x7e).  Each sixel data character
		represents six vertical pixels.  The data is extracted by
		subtracting 0x3f from the ASCII value of the character.
		The least significant bit is the topmost pixel.

                Sixel Control Functions
                ! Pn X
			Graphics Repeat Introducer
			The character X is repeated Pn times.
		" p1 ; p2 [ ; p3 [ ; p4 ] ]
			Raster Attributes
			p1 indicates the vertical size in pixels of each
			sixel.  p2 indicates the horizontal size in pixels.
			p3 and p4 define the height and width (in sixels)
			respectively of a block to fill with the background
			colour.  This block may not extend past the current
			bottom of the screen.  If any pixel data characters
			proceed this command, it is ignored.
		# p1
			Colour Select
			Selects the current foreground colour from the
			sixel palette.
		# p1 ; p2 ; p3 ; p4 ; p5
			Palette map
			Defines sixel palette entry p1 and sets it as the
			current foreground colour.  p2 specifies the colour
			space to define the colour in, the only supported
			value is 2.  p3, p4, and p5 specify the red, green,
			and blue content as a percentage (0-100).
		$
			Graphics Carriage Return
			Returns the active position to the left border of
			the same sixel row.  Generally, one pass per colour
			is used.  In passes after the first one, sixels
			with a value of zero are not overwritten with the
			background colour.
		-
			Graphics New Line
			Moves the active position to the left border of the
			next sixel row.

155

deuce's avatar
deuce committed
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
		$ q pt
		Request Status String (DECRQSS)

		pt is the intermediate and/or final characters of a control
		function to query the status of.  The terminal will send a
		response in the format

		DCS p1 $ r pt ST

		p1 is 1 if the terminal supports querying the control
		function and 0 if it does not.

		pt is the characters in the control function except the CSI
		characters.

deuce's avatar
deuce committed
171
172
173
		Currently supported values of p1:

		m	Request SGR parameters
174
		r	Request top and bottom margins
175
		s	Request left and right margins
176
177
178
		t	Request height in lines
		$|	Request width in columns
		*|	Request height in lines
deuce's avatar
deuce committed
179

180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

		p1 [ ; p2 [ ; p3 ] ! z
		Define Macro (DECDMAC)
		Defaults: p2 = 0  p3 = 0
		
		Sets a macro to be replayed using CSI Pn * z

		p1 is the macro number to set, and make be between 0 and
		63 inclusive.

		If p2 is zero, the macro numbered p1 will be deleted. If
		p2 is one, all macros are deleted.
		
		If p3 is zero, the macro is defined using ASCII characters
		(0x20 - 0x7e and 0xa0 - 0xff only) if p3 is one, the macro
		is defined using hex pairs.
		
		When the macro is defined using hex pairs, a repeat
		sequence may be included in the format of ! Pn ; D..D ;
		Pn specifies the number of repeats (default of one instance)
		D..D is the sequence of pairs to send Pn times.  The 
		terminating ; may be left out if the sequence to be
		repeated ends at the end of the string.

204
205
206
ESC X	Start Of String (SOS)
	As the above strings, but may contain any characters except
	a Start Of String sequence or a String Terminator sequence.
deuce's avatar
deuce committed
207
	The string is currently ignored.
deuce's avatar
deuce committed
208

209
210
211
ESC \	String Terminator (ST)

ESC ]	Operating System Command (OSC)
212
213
214
215
216
217
218
219
220
221
222
223
224
	Begins a string consisting of the characters 0x08 - 0x0d and
	0x20-0x7e, terminated by a String Terminator (ST)
	Supported OSC values:
		4;(pX;pY)...
		Specifies one or more palette redefinitions.
		pX is the palette index, and pY is the colour definition
		Color format:
			rgb:R/G/B
			Where R, G, and B are a sequence of one to four
			hex digits representing the value of the
			red, green, and blue channels respectively.

		SOURCE: xterm
deuce's avatar
deuce committed
225

226
227
228
229
230
231
232
		104 [ ; Ps ... ]
		Resets palette entry to default.  If the entire string
		is "104", resets all colours.  Otherwise, only each index
		separated by a semicolon is reset.

		SOURCE: xterm

233
234
235
ESC ^	Privacy Message (PM)
	Begins a string consisting of the characters 0x08 - 0x0d and
	0x20-0x7e, terminated by a String Terminator (ST)
236
	The string is currently ignored.
deuce's avatar
deuce committed
237

238
239
240
241
ESC _	Application Program String (APS)
	Begins a string consisting of the characters 0x08 - 0x0d and
	0x20-0x7e, terminated by a String Terminator (ST)
	The string is currently ignored.
deuce's avatar
deuce committed
242

243
ESC c	Reset to Initial State (RIS)
deuce's avatar
deuce committed
244
245
246
	Resets all the terminal settings, clears the screen, and homes
	the cursor.

247
248
249
Control Sequences:
------------------

250
251
252
Control sequences start with the Control Sequence Introducer which is
ESC [  CSI will be used to express this from now on.

253
Control sequences are in the following format:
254
CSI {'0' (ZERO) to '?'}{SPACE to '/'}{'@' to '~'}
255
256
257
258
	There may be multiple characters from the {'0' (ZERO) to '?'}
	and {SPACE to '/'} before the terminating {'@' to '~'} character.

	Legal combinations not handled are silently dropped.
259
	Illegal combinations are displayed.
260
261
262
263

Sequence Parameters:
	Parameters are expressed by the {'0' (ZERO) to '?'} character set.
	Sequences which use parameters use decimal parameters separated by
deuce's avatar
deuce committed
264
	a ';'.  The use of a ':' from the set is reserved.
265
266
267
	If the parameter string begins with '<', '=', '>', or '?' then
	this is a non-standard extension to the ANSI spec.

deuce's avatar
deuce committed
268
269
270
271
272
273
	Pn          Indicates a single numeric parameter
	Pn1 ; Pn2   Two numeric parameters
	Pn...       Any number of numeric parameters
	Ps          Single selective parameter
	Ps1 ; Ps1   Two selective parameters
	Ps...       Any numer of selective parameters
274

deuce's avatar
deuce committed
275
	If a default is defined, the parameter is optional
276

277
CSI Pn @ (ICH)
deuce's avatar
deuce committed
278
	Insert Character(s)
deuce's avatar
deuce committed
279
280
	Defaults: Pn = 1
	Moves text from the current position to the right edge Pn characters
281
	to the right, with rightmost characters going off-screen and the
deuce's avatar
deuce committed
282
283
284
285
	resulting hole being filled with the current attribute.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

286
287
CSI Pn SP @ (SL)
	Scroll Left
288
289
290
291
292
293
294
	Defaults: Pn = 1
	Shifts the contents of the screen left Pn columns(s) with
	leftmost columns going off-screen and the resulting hole being
	filled with the current attribute.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

295
CSI Pn A (CUU)
deuce's avatar
deuce committed
296
	Cursor Up
deuce's avatar
deuce committed
297
298
	Defaults: Pn = 1
	Moves the cursor position up Pn lines from the current position.
deuce's avatar
deuce committed
299
300
301
302
303
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

304
305
CSI Pn SP A (SR)
	Scroll Right
306
307
308
309
310
311
312
	Defaults: Pn = 1
	Shifts the contents of the screen right Pn columns(s) with
	rightmost columns going off-screen and the resulting hole being
	filled with the current attribute.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

313
CSI Pn B (CUD)
deuce's avatar
deuce committed
314
	Cursor Down
deuce's avatar
deuce committed
315
316
	Defaults: Pn = 1
	Moves the cursor position down Pn lines from the current position.
deuce's avatar
deuce committed
317
318
319
320
321
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

322
CSI Pn C (CUF)
deuce's avatar
deuce committed
323
	Cursor Right
deuce's avatar
deuce committed
324
325
	Defaults: Pn = 1
	Moves the cursor position right Pn columns from the current position.
deuce's avatar
deuce committed
326
327
328
329
330
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

331
CSI Pn D (CUB)
deuce's avatar
deuce committed
332
	Cursor Left
deuce's avatar
deuce committed
333
334
	Defaults: Pn = 1
	Moves the cursor position left Pn columns from the current position.
deuce's avatar
deuce committed
335
336
337
338
339
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

340
CSI Ps1 ; Ps2 sp D (FNT)
341
	Font Selection
deuce's avatar
deuce committed
342
	Defaults: Ps1 = 0  Ps2 = 0
343
	"sp" indicates a single space character.
deuce's avatar
deuce committed
344
345
	Sets font Ps1 to be the one indicated by Ps2.  Currently four fonts are
	supported.  Ps2 must be between 0 and 255.  Not all output types support
346
	font selection.  Only X11 and SDL currently do.
deuce's avatar
deuce committed
347
	Supported Ps1 values:
348
		0  - Default font
deuce's avatar
deuce committed
349
		1  - Font selected by the high intensity bit when CSI ? 31 h
350
		     is enabled
deuce's avatar
deuce committed
351
		2  - Font selected by the blink intensity bit when CSI ? 34 h
352
353
		     is enabled
		3  - Font selected by both the high intensity and blink bits
deuce's avatar
deuce committed
354
		     when both CSI ? 31 h and CSI ? 34 h are enabled
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
	Currently included fonts are:
		0  - Codepage 437 English
		1  - Codepage 1251 Cyrillic, (swiss)
		2  - Russian koi8-r
		3  - ISO-8859-2 Central European
		4  - ISO-8859-4 Baltic wide (VGA 9bit mapped)
		5  - Codepage 866 (c) Russian
		6  - ISO-8859-9 Turkish
		7  - haik8 codepage (use only with armscii8 screenmap)
		8  - ISO-8859-8 Hebrew
		9  - Ukrainian font koi8-u
		10 - ISO-8859-15 West European, (thin)
		11 - ISO-8859-4 Baltic (VGA 9bit mapped)
		12 - Russian koi8-r (b)
		13 - ISO-8859-4 Baltic wide
		14 - ISO-8859-5 Cyrillic
		15 - ARMSCII-8 Character set
		16 - ISO-8859-15 West European
		17 - Codepage 850 Multilingual Latin I, (thin)
		18 - Codepage 850 Multilingual Latin I
		19 - Codepage 885 Norwegian, (thin)
		20 - Codepage 1251 Cyrillic
		21 - ISO-8859-7 Greek
		22 - Russian koi8-r (c)
		23 - ISO-8859-4 Baltic
		24 - ISO-8859-1 West European
		25 - Codepage 866 Russian
		26 - Codepage 437 English, (thin)
		27 - Codepage 866 (b) Russian
		28 - Codepage 885 Norwegian
		29 - Ukrainian font cp866u
		30 - ISO-8859-1 West European, (thin)
		31 - Codepage 1131 Belarusian, (swiss)
388
389
390
391
392
		32 - Commodore 64 (UPPER)
		33 - Commodore 64 (Lower)
		34 - Commodore 128 (UPPER)
		35 - Commodore 128 (Lower)
		36 - Atari
deuce's avatar
deuce committed
393
394
		37 - P0T NOoDLE (Amiga)
		38 - mO'sOul (Amiga)
395
		39 - MicroKnight Plus (Amiga)
deuce's avatar
deuce committed
396
		40 - Topaz Plus (Amiga)
397
		41 - MicroKnight (Amiga)
deuce's avatar
deuce committed
398
399
		42 - Topaz (Amiga)

400
401
402
	Not all fonts are supported in all modes.  If a font is not supported
	in the current mode, no action is taken, but there should be a
	non-zero 'Font Selection result' value in the Font State Report.
403

deuce's avatar
deuce committed
404
405
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

406
CSI Pn E (CNL)
deuce's avatar
deuce committed
407
	Cursor Next Line
deuce's avatar
deuce committed
408
409
	Defaults: Pn = 1
	Moves the cursor to the first column of the line Pn down from the
410
411
412
	current position. Moving past the bottom of the screen scrolls the
	screen up the remaining number of lines filling newly added lines
	with the current attribute.
deuce's avatar
deuce committed
413
414
415

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

416
CSI Pn F (CPL)
417
	Cursor Preceding Line
deuce's avatar
deuce committed
418
	Defaults: Pn = 1
419
	Moves the cursor to the first column of the row Pn up from the
420
421
	current position.  Attempting to move past the screen boundaries
	stops the cursor at the screen boundary.
422
423
424

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

425
CSI Pn G (CHA)
deuce's avatar
deuce committed
426
	Cursor Character Absolute
deuce's avatar
deuce committed
427
428
	Defaults: Pn = 1
	Movies the cursor to column Pn of the current row.
429

deuce's avatar
deuce committed
430
431
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

432
CSI Pn1 ; Pn2 H (CUP)
433
	Cursor Position
deuce's avatar
deuce committed
434
435
	Defaults: Pn1 = 1  Pn2 = 1
	Moves the cursor to the Pn2th column of the Pn1th line.
deuce's avatar
deuce committed
436
437
438

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
439
440
441
442
443
444
445
446
CSI Pn I (CHT)
	Cursor Forward Tabulation
	Defaults: Pn = 1
	Move the cursor to the Pn-th next tab stop.
	Basically the same as sending TAB Pn times.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

447
CSI Ps J (ED)
deuce's avatar
deuce committed
448
	Erase in Page
deuce's avatar
deuce committed
449
450
	Defaults: Ps = 0
	Erases from the current screen according to the value of Ps
deuce's avatar
deuce committed
451
452
453
454
455
456
457
	0 - Erase from the current position to the end of the screen.
	1 - Erase from the current position to the start of the screen.
	2 - Erase entire screen.  As a violation of ECMA-048, also moves
	    the cursor to position 1/1 as a number of BBS programs assume
	    this behaviour.
	Erased characters are set to the current attribute.

deuce's avatar
deuce committed
458
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
deuce's avatar
deuce committed
459
460
	SOURCE BANSI.TXT

461
CSI Ps K (EL)
deuce's avatar
deuce committed
462
	Erase in Line
deuce's avatar
deuce committed
463
464
	Defaults: Ps = 0
	Erases from the current line according to the value pf Ps
deuce's avatar
deuce committed
465
466
467
468
469
470
471
	0 - Erase from the current position to the end of the line.
	1 - Erase from the current position to the start of the line.
	2 - Erase entire line.
	Erased characters are set to the current attribute.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

472
CSI Pn L (IL)
deuce's avatar
deuce committed
473
	Insert Line(s)
deuce's avatar
deuce committed
474
475
	Defaults: Pn = 1
	Inserts Pn lines at the current line position.  The current line and
476
477
	those after it are scrolled down and the new empty lines are filled
	with the current attribute.
deuce's avatar
deuce committed
478
479
480

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

481
CSI Pn M (DL)
deuce's avatar
deuce committed
482
	Delete Line(s) / "ANSI" Music
deuce's avatar
deuce committed
483
484
	Defaults: Pn = 1
	Deletes the current line and the Pn - 1 lines after it scrolling the
deuce's avatar
deuce committed
485
486
487
488
	first non-deleted line up to the current line and filling the newly
	empty lines at the end of the screen with the current attribute.
	If "ANSI" Music is fully enabled (CSI = 2 M), performs "ANSI" music
	instead.
deuce's avatar
deuce committed
489
490
491
492
493
	See "ANSI" MUSIC section for more details.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
494
495
CSI = Ps M (CTSAM)
	CTerm Set ANSI Music
deuce's avatar
deuce committed
496
497
498
499
500
501
502
503
504
505
	NON-STANDARD EXTENSION.
	Defaults:  Ps = 0
	Sets the current state of ANSI music parsing.
	0 - Only CSI | will introduce an ANSI music string.
	1 - Both CSI | and CSI N will introduce an ANSI music string.
	2 - CSI |, CSI N, and CSI M will all introduce an ANSI music string.
	    In this mode, Delete Line will not be available.

	SOURCE: CTerm only.

506
507
CSI N (BCAM)
	BananaCom ANSI Music
deuce's avatar
deuce committed
508
	"ANSI" Music / Not implemented.
deuce's avatar
deuce committed
509
	If "ANSI" Music is set to BananaCom (CSI = 1 M) or fully enabled
510
	(CSI = 2 M) performs "ANSI" music.  See "ANSI" MUSIC section for more
deuce's avatar
deuce committed
511
	details.
deuce's avatar
deuce committed
512
513
514

	SOURCE: BANSI.TXT

515
CSI Pn P (DCH)
deuce's avatar
deuce committed
516
	Delete Character
deuce's avatar
deuce committed
517
	Defaults: Pn = 1
518
519
520
521
	Deletes the character at the current position by shifting all
	characters from the current column + p1 left to the current column.
	Opened blanks at the end of the line are filled with the current
	attribute.
deuce's avatar
deuce committed
522
523
524

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

525
CSI Pn S (SU)
deuce's avatar
deuce committed
526
	Scroll Up
deuce's avatar
deuce committed
527
528
	Defaults: Pn = 1
	Scrolls all text on the screen up Pn lines.  New lines emptied at the
deuce's avatar
deuce committed
529
	bottom are filled with the current attribute.
deuce's avatar
deuce committed
530
531
532

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
533
534
CSI ? Ps1 ; Ps2 S (XTSRGA)
	XTerm Set or Request Graphics Attribute
535
536
537
538
539
540
	If Ps1 is 2, and Ps2 is 1, replies with the graphics screen information
	in the following format: CSI ? 2 ; 0 ; Px ; Py S
	Where Px is the width of the screen in pixels and Py is the height.

	SOURCE: XTerm

deuce's avatar
deuce committed
541
CSI Pn T (SD)
deuce's avatar
deuce committed
542
	Scroll Down
deuce's avatar
deuce committed
543
544
	Defaults: Pn = 1
	Scrolls all text on the screen down Pn lines.  New lines emptied at the
deuce's avatar
deuce committed
545
	top are filled with the current attribute.
deuce's avatar
deuce committed
546
547

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
548

549
550
551
CSI U
	NON-STANDARD (Disabled in current code)
	Clear screen with default attribute.
deuce's avatar
deuce committed
552
553
	This code is *supposed* to go to the "next page" according to the
	ANSI/ECMA specs with CSI V going to "previous page"
554
555
556

	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
557
CSI Pn X (ECH)
558
	Erase Character
deuce's avatar
deuce committed
559
	Defaults: Pn = 1
560
561
	Erase p1 characters starting at the current character.  Will not erase
	past the end of line.
562
563
564
565
	Erased characters are set to the current attribute.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
566
CSI Pn Y (CVT)
deuce's avatar
deuce committed
567
568
569
570
571
572
573
	Cursor Line Tabulation
	Defaults: Pn = 1
	Move the cursor to the Pn-th next tab stop.
	Basically the same as sending TAB Pn times.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
574
CSI Pn Z (CBT)
575
	Cursor Backward Tabulation
deuce's avatar
deuce committed
576
	Defaults: Pn = 1
577
	Move the cursor to the p1th preceding tab stop.  Will not go past the
deuce's avatar
deuce committed
578
	start of the line.
579
580
581

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
582
CSI Pn ` (HPA)
deuce's avatar
deuce committed
583
584
585
586
587
588
589
	Character Position Absolute
	Defaults: Pn = 1
	Move the cursor to the specified position on the current row.
	Will not go past the end of the line.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
590
CSI Pn a (HPR)
deuce's avatar
deuce committed
591
592
593
594
595
596
597
598
	Cursor Position Forward
	Defaults: Pn = 1
	Moves the cursor position forward Pn columns from the current position.
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
599
CSI Pn b (REP)
deuce's avatar
deuce committed
600
601
602
603
604
605
606
	Repeat
	Defaults: Pn = 1
	Repeats the previous graphic character Pn times.  Will not repeat
	escape sequences.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
607
CSI Ps c (DA)
608
	Device Attributes
deuce's avatar
deuce committed
609
610
	Defaults: Ps = 0
	If Ps is 0, CTerm will reply with the sequence:
611
        CSI = 67;84;101;114;109;pN c
deuce's avatar
deuce committed
612
	64;84;101;114;109 is the ASCII values of the "CTerm" string.  pN is the
613
614
615
616
617
	CVS revision ID of CTerm with dots converted to semi-colons
	(e.g. "1;156").  Use the CVS revision to detect if a specific feature
	is available.  If you are adding features to a forked version of cterm,
	please do so by	adding an extra parameter to the end, not by
	incrementing any existing one!
618

deuce's avatar
deuce committed
619
620
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
621
CSI < Ps c (CTDA)
deuce's avatar
deuce committed
622
623
624
625
626
627
628
	CTerm Device Attributes

	Defaults: Ps = 0
	If Pn is 0, CTerm will reply with the sequence:
        CSI < 0 ; Ps... c

	Possible values for Ps:
629
	1 - Loadable fonts are availabe via Device Control Strings
deuce's avatar
deuce committed
630
631
632
633
634
635
	2 - Palette entries may be modified via an Operating System Command
	    string
	3 - Pixel operations are supported (currently, sixel graphics)
	4 - The current font may be selected via CSI Ps1 ; Ps2 sp D
	5 - More than the standard 16 colours may by configured via
	    Operating System Command strings
636
637
	6 - Extended palette is available
	7 - Mouse is available
deuce's avatar
deuce committed
638

deuce's avatar
deuce committed
639
CSI Ps d (VPA)
deuce's avatar
deuce committed
640
641
642
643
644
645
	Line Position Absolute
	Defaults: Ps = 1
	Moves to row specified by Ps.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
646
647
648
649
650
651
652
CSI Pn SP d (TSR)
	Tab Stop Remove
	Defaults: None
	Removes a tab stop at postion Pn.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

653
654
CSI Pn e (VPR)
	Line Position Forward
deuce's avatar
deuce committed
655
656
657
658
659
	Defaults: Ps = 1
	Moves forward Ps rows.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

660
661
CSI Pn1 ; Pn2 (HVP)
	Character and Line Position
deuce's avatar
deuce committed
662
663
664
665
666
	Defaults: Pn1 = 1  Pn2 = 1
	Moves the cursor to the Pn2th column of the Pn1th line.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

667
668
CSI Ps g (TBC)
	Tabulation Clear
deuce's avatar
deuce committed
669
	Defaults: Pn = 0
670
	Deletes tab stops according to the values of P1:
deuce's avatar
deuce committed
671
672
673
674
675
676
	0 - Deletes tab stop at current position.
	3 - Deletes all tab stops.
	5 - Deletes all tab stops.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
677
CSI = 255 h (BCSET)
deuce's avatar
deuce committed
678
679
680
681
682
	NON-STANDARD EXTENSION
	Enable DoorWay Mode

	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
683
CSI ? Ps... h (DECSET)
deuce's avatar
deuce committed
684
685
686
687
688
689
690
691
692
693
694
695
696
	NON-STANDARD EXTENSION
	Set Mode
	Sets one or more mode.  The following modes are supported:

	6 -  Enable origin mode.
	     In this mode, position parameters are relative to the top left of
	     the scrolling region, not the screen.  Defaults to reset.
	     SOURCE: Digital VT102 User Guide
	7 -  Enable auto wrap
	     This is the normal mode in which a write to the last column of a
	     row will move the cursor to the start of the next line triggering
	     a scroll if required to create a new line.  Defaults to set.
	     SOURCE: Digital VT102 User Guide
deuce's avatar
deuce committed
697
698
699
700
701
	9 -  X10 compatible mouse reporting
	     Mouse button presses will send a CSI M <button> <x> <y>
	     Where <button> is ' ' + button number (0-based)
	     <x> and <y> are '!' + position (0-based)
	     SOURCE: xterm
deuce's avatar
deuce committed
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
	25 - Display the cursor.  Defaults to set.
	     SOURCE: "Installing and Using the VT320 Video Terminal"
	31 - Enable bright alt character set
	     With this mode set, the bright (1) graphic rendition selects
	     characters from an alternate character set.  Defaults to reset.
	32 - Bright Intensity Disable
	     This makes the bright intensity bit not control the intensity.
	     Mostly for use with CSI ? 31 h to permit fonts in the same
	     colours.  Defaults to reset.
	33 - Blink to Bright Intensity Background
	     With this mode set, the blink (5,6) graphic renditions cause the
	     background colour to be high intensity rather than causing blink.
	     Defaults to reset.
	34 - Enable blink alt character set
	     With this mode set, the blink (5, 6) graphic renditions selects
	     characters from an alternate character set.  Defaults to reset
	35 - Blink Disabled
	     This makes the blink (5, 6) graphic renditions not cause the
	     character to blink.  Mostly for use with CSI ? 34 h to permit
	     fonts to be used without blinking.  Defaults to reset.
722
723
724
	69 - DEC Left Right Margin Mode enabled
	     Enables CSI s to set the left/right margins, and disables CSI s
	     from saving the current cursor position.
deuce's avatar
deuce committed
725
726
727
728
729
730
731
732
733
	80 - Sixel Scrolling Enabled
	     When this is set, the sixel active position begins in the
	     upper-left corner of the currently active text position.
	     When the sixel active position reaches the bottom of the
	     page, the page is scrolled up.  At the end of the sixel
	     string, a sixel newline is appended, and the current cursor
	     position is the one in which the bottom sixel is in.
	     Defaults to set.
	     SOURCE: VT330/VT340 Programmer Reference Manual
deuce's avatar
deuce committed
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
	1000 -  Normal tracking mode mouse reporting
	     Mouse button presses will send a CSI M <button> <x> <y>
	     Where <button> is ' ' + button number (0-based)
	     Mouse button releases will use a button number of 4
	     <x> and <y> are '!' + position (0-based)
	     SOURCE: xterm
	1001 -  Highlight tracking mode mouse reporting
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1002 -  Button-event tracking mode mouse reporting
	     Mouse button presses and movement when a button is pressed
	     will send a CSI M <button> <x> <y>
	     Where <button> is ' ' + button number (0-based)
	     32 is added to the button number for movement events.
	     Mouse button releases will use a button number of 4
	     <x> and <y> are '!' + position (0-based)
	     SOURCE: xterm
	1003 -  Any-event tracking mode mouse reporting
	     Mouse button presses and movement
	     will send a CSI M <button> <x> <y>
	     Where <button> is ' ' + button number (0-based)
	     32 is added to the button number for movement events.
	     Mouse button releases will use a button number of 4
	     <x> and <y> are '!' + position (0-based)
	     If no button is pressed, it acts as though button 0 is.
	     SOURCE: xterm
	1004 -  Focus-event tracking mode mouse reporting
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1005 -  UTF-8 encoded extended coordinates
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1006 -  SGR encoded extended coordinates
	     Instead of the CSI M method, the format of mouse reporting
	     is change to CSI < Pb ; Px ; Py M for presses and
	     CSI < Pb ; Px ; Py m for releases.
	     Instead of CSI M
	     Px and Py are one-based.
	     Pb remains the same (32 added for movement)
	     Button 3 is not used for release (separate code)
	     SOURCE: xterm
	1007 -  Alternate scroll mode
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1015 -  URXVT encoded extended coordinates
	     (Not supported by SyncTERM)
	     SOURCE: xterm
deuce's avatar
deuce committed
781

deuce's avatar
deuce committed
782
CSI Pn j (HPB)
deuce's avatar
deuce committed
783
784
785
786
787
788
789
790
	Character Position Backward
	Defaults: Pn = 1
	Moves the cursor position left Pn columns from the current position.
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
791
CSI Pn k (VPB)
deuce's avatar
deuce committed
792
793
794
795
796
797
798
799
	Line Position Backward
	Defaults: Pn = 1
	Moves the cursor position up Pn lines from the current position.
	Attempting to move past the screen boundaries stops the cursor
	at the screen boundary.

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf

deuce's avatar
deuce committed
800
CSI = 255 l (BCRST)
deuce's avatar
deuce committed
801
802
803
804
805
	NON-STANDARD EXTENSION
	Disable DoorWay Mode

	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
806
CSI ? Ps... l (DECRST)
deuce's avatar
deuce committed
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
	NON-STANDARD EXTENSION
	Reset Mode
	Resets one or more mode.  The following modes are supported:

	6 -  Origin Mode
	     With this mode reset, position parameters are relative to the
	     top left of the screen, not the scrolling region.  Defaults
	     to reset.
	     SOURCE: Digital VT102 User Guide
	7 -  Disable auto wrap
	     Resetting this mode causes a write to the last column of a to
	     leave the cursor where it was before the write occurred,
	     overwriting anything which was previously written to the same
	     position.
	     SOURCE: Digital VT102 User Guide
deuce's avatar
deuce committed
822
	9 -  Disable X10 compatible mouse reporting
deuce's avatar
deuce committed
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
	25 - Hide the cursor.  Defaults to set.
	     SOURCE: "Installing and Using the VT320 Video Terminal"
	31 - Disable bright alt character set
	     With this mode reset, the bright (1) graphic rendition does not
	     select an alternative font.  Defaults to reset.
	32 - Bright Intensity Enable
	     When reset, bright intensity graphics rendition behaves normally.
	     Defaults to reset.
	33 - Disable Blink to Bright Intensity Background
	     With this mode set, the blink (5,6) graphic renditions do not
	     affect the background colour.  Defaults to reset.
	34 - Disable blink alt character set
	     With this mode reset, the blink (5, 6) graphic renditions do not
	     select characters from an alternate character set.  Defaults to
	     reset.
	35 - Blink Enable
	     With this mode reset, the blink (5,6) graphic renditions behave
	     normally (cause the characters to blink).  Defaults to reset.
841
842
843
844
	69 - DEC Left Right Margin Mode disabled
	     Disables CSI s from setting the left/right margins, and changes
	     it back to saving the current cursor position.  The current
	     left/right margins are maintained.
deuce's avatar
deuce committed
845
846
847
848
849
850
851
852
	80 - Sixel Scrolling Disabled
	     When this is reset, the sixel active position begins in the
	     upper-left corner of the page.  Any commands that attempt to
	     advance the sixel position past the bottom of the page are
	     ignored.  At the end of the sixel string, the current cursor
	     position is unchanged from where it was when the sixel string
	     started.  Defaults to set.
	     SOURCE: VT330/VT340 Programmer Reference Manual
deuce's avatar
deuce committed
853
854
855
856
857
	1000 -  Disable Normal tracking mode mouse reporting
	     SOURCE: xterm
	1001 -  Disable Highlight tracking mode mouse reporting
	     (Not supported by SyncTERM)
	     SOURCE: xterm
858
	1002 -  Disable Button-event tracking mode mouse reporting
deuce's avatar
deuce committed
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
	     SOURCE: xterm
	1003 -  Disable Any-event tracking mode mouse reporting
	     SOURCE: xterm
	1004 -  Disable Focus-event tracking mode mouse reporting
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1005 -  Disable UTF-8 encoded extended coordinates
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1006 -  Disable SGR encoded extended coordinates
	     SOURCE: xterm
	1007 -  Disable Alternate scroll mode
	     (Not supported by SyncTERM)
	     SOURCE: xterm
	1015 -  Disable URXVT encoded extended coordinates
	     (Not supported by SyncTERM)
	     SOURCE: xterm
deuce's avatar
deuce committed
876

deuce's avatar
deuce committed
877
CSI Ps... m (SGR)
878
	Select Graphic Rendition
deuce's avatar
deuce committed
879
	Defaults: Ps1 = 0
deuce's avatar
deuce committed
880
	Sets or clears one or more text attributes.  Unlimited parameters are
deuce's avatar
deuce committed
881
	supported and are applied in received order.  The following are
882
	supported:
883
884
885
886
887
888
	                                        Blink Bold FG BG TF TB (Modified)
	0 -  Default attribute, white on black     X    X  X  X  X  X
	1 -  Bright Intensity                           X        X
	2 -  Dim intensity                              X        X
	5 -  Blink (By definition, slow blink)     X                X
	6 -  Blink (By definition, fast blink)     X                X
889
	     NOTE: Both blinks are the same speed.
890
891
	7 -  Negative Image - Reverses FG and BG           X  X  X  X
	8 -  Concealed characters, sets the                X     X  X
892
	     foreground colour to the background
893
	     colour.
894
895
896
	22 - Normal intensity                           X        X
	25 - Steady (Not blinking)                 X                X
	27 - Positive Image - Reverses FG and BG           X  X  X  X
897
	     NOTE: This should be a separate
898
899
	           attribute than 7 but this
	           implementation makes them equal
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
	30 - Black foreground                              X     X
	31 - Red foreground                                X     X
	32 - Green foreground                              X     X
	33 - Yellow foreground                             X     X
	34 - Blue foreground                               X     X
	35 - Magenta foreground                            X     X
	36 - Cyan foreground                               X     X
	37 - White foreground                              X     X
	38 - Extended Foreground (see notes)                     X
	39 - Default foreground (same as white)	           X     X
	40 - Black background                                 X     X
	41 - Red background                                   X     X
	42 - Green background                                 X     X
	43 - Yellow background                                X     X
	44 - Blue background                                  X     X
	45 - Magenta background                               X     X
	46 - Cyan background                                  X     X
	47 - White background                                 X     X
	48 - Extended Background (see notes)                        X
	49 - Default background (same as black)               X     X
920
921
922

	All others are ignored.

923
924
925
926
927
928
929
	Blink indicates the blink bit.
	Bold indicates the bold bit.
	FG indicates the foreground colour.
	BG indicates the background colour.
	TF indicates that the Tru Colour foreground is changed.
	TB indicates that the Tru Colour background is changed.

930
931
932
933
934
	NOTE: For 38 and 48, two additional formats are supported, a palette
	selection and a direct colour selection.

	For palette selection, an additional two parameters are required
	after that value.  They are considered part of the 38/48, not separate
deuce's avatar
deuce committed
935
936
937
938
939
940
941
942
943
	values.  The first additional parameter must be a 5.  The second
	additional parameter specified the palette index to use.  To set the
	foreground to orange, and the background to a fairly dark grey, you
	would send:
	CSI 38 ; 5 ; 214 ; 48 ; 5 ; 238 m

	The default palette is the XTerm 256-colour palette.  See here:
	https://jonasjacek.github.io/colors/

944
	For direct colour selection, an additional four parameters are required
945
	after that value.  They are considered part of the 38/48, not separate
946
947
948
949
950
951
	values.  The first additional parameter must be a 2.  The second,
	third, and fourth specify the R/G/B values respectively. CTerm handles
	this with an internal temporary palette, so scrollback may not have the
	correct colours.  The internal palette is large enough for all cells in
	a 132x60 screen to have unique foreground and background colours
	though, so the current screen should always be as expected.
952

953
	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
deuce's avatar
deuce committed
954
	SOURCE: XTerm
955

deuce's avatar
deuce committed
956
CSI Ps n (DSR)
957
	Device Status Report
deuce's avatar
deuce committed
958
	Defaults: Ps = 0
deuce's avatar
deuce committed
959
	A request for a status report.  CTerm handles the following three
deuce's avatar
deuce committed
960
961
	requests:
	5	- Request a DSR
962
963
		  CTerm will always reply with CSI 0 n indicating 
		  "ready, no malfunction detected"
deuce's avatar
deuce committed
964
965
966
	6	- Request active cursor position
		  CTerm will reply with CSI y ; x R where y is the current line
		  and x is
967
		  the current row.
deuce's avatar
deuce committed
968
	255	- NON-STANDARD EXTENSION (BCDSR)
deuce's avatar
deuce committed
969
		  Replies as though a CSI 6 n was received with the cursor in
970
971
		  the bottom right corner.  i.e.: Returns the terminal size as
		  a position report.
972
973

	SOURCE: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
deuce's avatar
deuce committed
974
		(parameters 5 and 6 only)
975
976
	SOURCE: BANSI.TXT (parameter 255)

deuce's avatar
deuce committed
977
CSI = Ps n (CTSMRR)
deuce's avatar
deuce committed
978
979
980
981
982
	NON-STANDARD EXTENSION
	State/Mode Request/Report
	Defaults: Ps = 1

	When Ps is 1, CTerm will respond with a Font State Report of the form
983
	CSI = 1 ;pF ;pR ;pS0 ;pS1 ;pS2 ;pS3 n
deuce's avatar
deuce committed
984
985
986
	pF is the first available loadable-font slot number
	pR is the result of the previous "Font Selection" request:
		0 = successful font selection
987
		1 = failed font selection
deuce's avatar
deuce committed
988
989
990
991
992
993
994
995
996
997
998
999
1000
		99 = no font selection request has been received
	pS0 - pS3 contain the font slots numbers of previously successful
	"Font Selection" requests into the 4 available alternate-font
	style/attribute values:
		pS0 - normal attribute font slot
		PS1 - high intensity foreground attribute font slot
		PS2 - blink attribute font slot
		PS3 - high intensity blink attribute font slot

	When Ps is 2, CTerm will respond with a Mode Report of the form
	CSI = 2[;pN [;pN] [...]] n
	Where pN represent zero or more mode values set previously
	(e.g. via CSI ? pN h).	Mode values cleared (disabled via CSI ? pN l)
For faster browsing, not all history is shown. View entire blame