cterm.txt 31.8 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
Control characters:

15
16
17
18
19
20
NUL:
	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.

21
22
23
24
CR:
	Move cursor position to column 1 of the current line

LF:
25
	Move cursor position to same column of the next row.
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
	If current row is the last row, scrolls the screen up
	and fills the new row with the current attribute.

BS:
	Non-destructive backspace.  Moves cursor position to
	the previous column unless the current column is the
	first, in which case no operation is performed.

0x07:
	Beep

TAB:
	Moves to the next tab stop.  Does not overwrite any
	characters in between.  If the starting position is
	last column, advances to next line.  If starting
	position is the last column of the last line, performs
	a scroll, filling the new line at bottom with the
	current attribute and moves to the first character in
	the new line.

Control Codes:
--------------

Control codes are in the following format:
ESC {SPACE to '/'}{'0' (ZERO) to '~'}
	There may be multiple characters from the {SPACE to '/'} set
	before the terminating '0' to '~'

	Legal combinations which are not handled are silently dropped.

56
ESC D	(Disabled in current code)
57
58
59
60
	Scrolls window up one line filling the bottom line with the
	current attribute.
	SOURCE: BANSI.TXT

61
ESC M	(Disabled in current code)
62
63
64
65
	Scrolls window down one line filling the top line with the
	current attribute
	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
66
ESC _	Application Program String
deuce's avatar
deuce committed
67
68
69
70
	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
71
ESC P	Device Control String
deuce's avatar
deuce committed
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
	Begins a string consisting of the characters 0x08 - 0x0d and
	0x20-0x7e, terminated by a String Terminator (ST)
	Supported OSC values:
		[ 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.

deuce's avatar
deuce committed
139
140
141
142
ESC ^	Privacy Message
	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
143

144
145
146
147
148
149
150
151
152
153
154
155
156
157
ESC ]	Operating System Command
	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
158

159
160
161
162
163
164
165
		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

deuce's avatar
deuce committed
166
167
168
ESC X	Start Of String
	As the above strings, but may contain any characters except
	a Start Of String sequence or a String Terminator sequence.
169
	The string is currently ignored.
deuce's avatar
deuce committed
170
171
172

ESC \	String Terminator

173
174
175
Control Sequences:
------------------

176
177
178
Control sequences start with the Control Sequence Introducer which is
ESC [  CSI will be used to express this from now on.

179
Control sequences are in the following format:
180
CSI {'0' (ZERO) to '?'}{SPACE to '/'}{'@' to '~'}
181
182
183
184
	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.
185
	Illegal combinations are displayed.
186
187
188
189

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
190
	a ';'.  The use of a ':' from the set is reserved.
191
192
193
	If the parameter string begins with '<', '=', '>', or '?' then
	this is a non-standard extension to the ANSI spec.

194
195
196
197
198
199
200
201
202
	Parameters will be shown as pX where X will be a decimal position
	number.  Surrounded by [] indicates the parameter is optional.

CSI = [p1] M
	NON-STANDARD EXTENSION.
	Defaults:  p1 = 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.
203
	2 - CSI |, CSI N, and CSI M will all introduce an ANSI music string.
204
205
206
207
	    In this mode, Delete Line will not be available.

	SOURCE: CTerm only.

208
209
210
211
212
213
214
215
216
CSI = [ p1 [ ; p2 ] ] {
	NON-STANDARD EXTENSION.
	Defaults:  p1 = 255  p2 = 0
	Indicates that a font block is following.
	p1 indicates the font slot to place the loaded font into.  This must
	be higher than the last default defined font (See CSI sp D for list
	of predefined fonts)  p2 indicates font size according to the
	following table:
		0 - 8x16 font, 4096 bytes.
217
		1 - 8x14 font, 3584 bytes.
218
219
220
221
		2 - 8x8 font, 2048 bytes.

	SOURCE: CTerm only.

222
CSI = [ p1 [ ; ... ] ] n
223
	NON-STANDARD EXTENSION
224
	State/Mode Request/Report
225
	Defaults: p1 = 1
226

227
	When p1 is 1, CTerm will respond with a Font State Report of the form
228
229
230
231
232
233
        CSI = 1 ;pF ;pR ;pS0 ;pS1 ;pS2 ;pS3 n
	pF is the first available loadable-font slot number
	pR is the result of the previous "Font Selection" request:
		0 = successful font selection
		1 = font selection requests are not supported by client
		2 = required subsystem for font use has not been initialized
234
235
		3 = selected font is not available or is incompatible with
		    current video mode
236
		4 = invalid font slot number specified in request
237
238
		5 = required video mode for selected font is incompatible
		    with current video mode
239
		6 = memory allocation failure
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
		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 p1 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)
	will not be included in the set of values returned in the Mode
	Report.  If no modes are currently set, an empty parameter will be
	included as the first and only pN.
256

257
	SOURCE: CTerm only.
258

259
CSI = 255 h
260
261
262
263
264
	NON-STANDARD EXTENSION
	Enable DoorWay Mode

	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
265
CSI ? [ p1 [ ; pX ... ] ] h
266
	NON-STANDARD EXTENSION
deuce's avatar
deuce committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
	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
	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.
	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
308

309
CSI = 255 l
310
311
312
313
314
	NON-STANDARD EXTENSION
	Disable DoorWay Mode

	SOURCE: BANSI.TXT

deuce's avatar
deuce committed
315
CSI ? [ p1 [ ; pX ... ] ] l
316
	NON-STANDARD EXTENSION
deuce's avatar
deuce committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
	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
	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.
	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
357

358
CSI ? 31 l
359
360
361
	NON-STANDARD EXTENSION
	Disable alt character set

362
	Reverses CSI ? 31 h
363

364
CSI ? 32 l
365
	NON-STANDARD EXTENSION
366
	Bright Intensity Enable
367

368
369
	Causes "bright" foreground characters to be bright.
	Reverses CSI ? 32 h
370

371
CSI ? 33 l
372
373
374
	NON-STANDARD EXTENSION
	Blink Normal

375
	Reverses CSI ? 33 h
376

377
378
379
380
381
382
383
384
385
386
387
388
CSI ? 34 l
	NON-STANDARD EXTENSION
	Disable alt character set

	Reverses CSI ? 34 h

CSI ? 35 l
	NON-STANDARD EXTENSION
	Blink Enabled

	Reverses CSI ? 35 h

389
CSI [ p1 [ ; p2 ] ] * r
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
	NON-STANDARD EXTENSION.
	Set the output emulation speed.
	If p1 or p2 are omitted, causes output speed emulation to stop
	p1 may be empty.
	Sequence is ignored if p1 is not empty, 0, or 1.
	The value of p2 sets the output speed emulation as follows:

	Value		Speed
	-----		-----
	empty, 0	Unlimited
	1		300
	2		600
	3		1200
	4		2400
	5		4800
	6		9600
	7		19200
	8		38400
	9		57600
	10		76800
	11		115200

	SOURCE: VT4xx Specification from http://www.vt100.net/
413

414
415
CSI [ p1 [ ; p2 ] ] r
	NON-STANDARD EXTENSION.
416
417
418
419
420
421
	Set Top and Bottom Margins
	Defaults: p1 = 1
		p2 = last line on screen
	Selects top and bottom margins, defining the scrolling region. P1 is
	the line number of the first line in the scrolling region. P2 is the
	line number of the bottom line.
422

deuce's avatar
deuce committed
423
424
425
426
CSI [ p1 ] @
	Insert Character(s)
	Defaults: p1 = 1
	Moves text from the current position to the right edge p1 characters
427
	to the right, with rightmost characters going off-screen and the
deuce's avatar
deuce committed
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
	resulting hole being filled with the current attribute.

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

CSI [ p1 ] A
	Cursor Up
	Defaults: p1 = 1
	Moves the cursor position up p1 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

CSI [ p1 ] B
	Cursor Down
	Defaults: p1 = 1
	Moves the cursor position down p1 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

CSI [ p1 ] C
	Cursor Right
	Defaults: p1 = 1
	Moves the cursor position right p1 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

CSI [ p1 ] D
	Cursor Left
	Defaults: p1 = 1
	Moves the cursor position left p1 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

468
469
470
CSI [ p1 [ ; p2 ] ] sp D
	Font Selection
	Defaults: p1 = 0  p2 = 0
471
	"sp" indicates a single space character.
472
	Sets font p1 to be the one indicated by p2.  Currently four fonts are
473
474
475
476
	supported.  p2 must be between 0 and 255.  Not all output types support
	font selection.  Only X11 and SDL currently do.
	Supported p1 values:
		0  - Default font
477
478
479
480
481
482
		1  - Font selected by the high intensity bit when CSI [ ? 31 h
		     is enabled
		2  - Font selected by the blink intensity bit when CSI [ ? 34 h
		     is enabled
		3  - Font selected by both the high intensity and blink bits
		     when both CSI [ ? 31 h and CSI [ ? 34 h are enabled
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
	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)
516
517
518
519
520
		32 - Commodore 64 (UPPER)
		33 - Commodore 64 (Lower)
		34 - Commodore 128 (UPPER)
		35 - Commodore 128 (Lower)
		36 - Atari
deuce's avatar
deuce committed
521
522
		37 - P0T NOoDLE (Amiga) 
		38 - mO'sOul (Amiga)    
523
524
525
526
		39 - MicroKnight Plus (Amiga)
		40 - Topaz Plus (Amiga)      
		41 - MicroKnight (Amiga)
		42 - Topaz (Amiga)      
527
528
529
	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.
530

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

deuce's avatar
deuce committed
533
534
535
CSI [ p1 ] E
	Cursor Next Line
	Defaults: p1 = 1
536
537
538
539
	Moves the cursor to the first column of the line p1 down from the
	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
540
541
542

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

543
544
545
CSI [ p1 ] F
	Cursor Preceding Line
	Defaults: p1 = 1
546
547
548
	Moves the cursor to the first column if the row p1 up from the
	current position.  Attempting to move past the screen boundaries
	stops the cursor at the screen boundary.
549
550
551

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

deuce's avatar
deuce committed
552
553
554
555
CSI [ p1 ] G
	Cursor Character Absolute
	Defaults: p1 = 1
	Movies the cursor to column p1 of the current row.
556

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

deuce's avatar
deuce committed
559
560
CSI [ p1 [ ; p2 ] ] H
CSI [ p1 [ ; p2 ] ] f
561
	Cursor Position
deuce's avatar
deuce committed
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
	Defaults: p1 = 1  p2 = 1
	Moves the cursor to the p2th column of the p1th line.

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

CSI [ p1 ] J
	Erase in Page
	Defaults: p1 = 0
	Erases from the current screen according to the value of p1
	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.

	SOURCE BANSI.TXT

CSI [ p1 ] K
	Erase in Line
	Defaults: p1 = 0
	Erases from the current line according to the value pf p1
	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

CSI [ p1 ] L
	Insert Line(s)
	Defaults: p1 = 1
	Inserts p1 lines at the current line position.  The current line and
595
596
	those after it are scrolled down and the new empty lines are filled
	with the current attribute.
deuce's avatar
deuce committed
597
598
599
600
601
602

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

CSI [ p1 ] M
	Delete Line(s) / "ANSI" Music
	Defaults: p1 = 1
deuce's avatar
deuce committed
603
604
605
606
607
	Deletes the current line and the p1 - 1 lines after it scrolling the
	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
608
609
610
611
612
613
614
	See "ANSI" MUSIC section for more details.

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

CSI N
	"ANSI" Music / Not implemented.
deuce's avatar
deuce committed
615
	If "ANSI" Music is set to BananaCom (CSI = 1 M) or fully enabled
616
	(CSI = 2 M) performs "ANSI" music.  See "ANSI" MUSIC section for more
deuce's avatar
deuce committed
617
	details.
deuce's avatar
deuce committed
618
619
620
621
622
623

	SOURCE: BANSI.TXT

CSI [ p1 ] P
	Delete Character
	Defaults: p1 = 1
624
625
626
627
	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
628
629
630
631
632
633

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

CSI [ p1 ] S
	Scroll Up
	Defaults: p1 = 1
deuce's avatar
deuce committed
634
635
	Scrolls all text on the screen up p1 lines.  New lines emptied at the
	bottom are filled with the current attribute.
deuce's avatar
deuce committed
636
637
638
639
640
641

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

CSI [ p1 ] T
	Scroll Down
	Defaults: p1 = 1
deuce's avatar
deuce committed
642
643
	Scrolls all text on the screen down p1 lines.  New lines emptied at the
	top are filled with the current attribute.
deuce's avatar
deuce committed
644
645

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

647
648
649
CSI U
	NON-STANDARD (Disabled in current code)
	Clear screen with default attribute.
deuce's avatar
deuce committed
650
651
	This code is *supposed* to go to the "next page" according to the
	ANSI/ECMA specs with CSI V going to "previous page"
652
653
654

	SOURCE: BANSI.TXT

655
656
657
CSI [ p1 ] X
	Erase Character
	Defaults: p1 = 1
658
659
	Erase p1 characters starting at the current character.  Will not erase
	past the end of line.
660
661
662
663
	Erased characters are set to the current attribute.

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

664
665
CSI [ p1 ] Z
	Cursor Backward Tabulation
666
	Defaults: p1 = 1
667
	Move the cursor to the p1th preceding tab stop.  Will not go past the
deuce's avatar
deuce committed
668
	start of the line.
669
670
671

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

672
673
674
675
CSI [ p1 ] c
	Device Attributes
	Defaults: p1 = 0
	If p1 is 0, CTerm will reply with the sequence:
676
        CSI = 67;84;101;114;109;pN c
deuce's avatar
deuce committed
677
	64;84;101;114;109 is the ASCII values of the "CTerm" string.  pN is the
678
679
680
681
682
	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!
683

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

686
687
688
CSI [ p1 [ ; pX ... ] ] m
	Select Graphic Rendition
	Defaults: p1 = 0
deuce's avatar
deuce committed
689
	Sets or clears one or more text attributes.  Unlimited parameters are
deuce's avatar
deuce committed
690
	supported and are applied in received order.  The following are
691
	supported:
deuce's avatar
deuce committed
692
	                                        Blink Bold FG BG (Modified)
693
	0 -  Default attribute, white on black     X    X  X  X
deuce's avatar
deuce committed
694
	1 -  Bright Intensity                           X
695
	2 -  Dim intensity                              X
696
697
698
699
700
	5 -  Blink (By definition, slow blink)     X
	6 -  Blink (By definition, fast blink)     X
	     NOTE: Both blinks are the same speed.
	7 -  Negative Image - Reverses FG and BG           X  X
	8 -  Concealed characters, sets the                X
701
	     foreground colour to the background
702
	     colour.
deuce's avatar
deuce committed
703
704
	22 - Normal intensity                           X
	25 - Steady (Not blinking)                 X
705
706
	27 - Positive Image - Reverses FG and BG           X  X
	     NOTE: This should be a separate
707
708
	           attribute than 7 but this
	           implementation makes them equal
deuce's avatar
deuce committed
709
710
711
712
713
714
715
716
	30 - Black foreground                              X
	31 - Red foreground                                X
	32 - Green foreground                              X
	33 - Yellow foreground                             X
	34 - Blue foreground                               X
	35 - Magenta foreground                            X
	36 - Cyan foreground                               X
	37 - White foreground                              X
717
	39 - Default foreground (same as white)	           X
deuce's avatar
deuce committed
718
719
720
721
722
723
724
725
726
	40 - Black background                                 X
	41 - Red background                                   X
	42 - Green background                                 X
	43 - Yellow background                                X
	44 - Blue background                                  X
	45 - Magenta background                               X
	46 - Cyan background                                  X
	47 - White background                                 X
	49 - Default background (same as black)               X
727
728
729
730
731
732
733
734

	All others are ignored.

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

CSI [ p1 ] n
	Device Status Report
	Defaults: p1 = 0
deuce's avatar
deuce committed
735
	A request for a status report.  CTerm handles the following three
deuce's avatar
deuce committed
736
737
	requests:
	5	- Request a DSR
738
739
		  CTerm will always reply with CSI 0 n indicating 
		  "ready, no malfunction detected"
deuce's avatar
deuce committed
740
741
742
	6	- Request active cursor position
		  CTerm will reply with CSI y ; x R where y is the current line
		  and x is
743
		  the current row.
deuce's avatar
deuce committed
744
	255	- NON-STANDARD EXTENSION
745
		  Replies as though a CSI [ 6 n was received with the cursor in
746
747
		  the bottom right corner.  i.e.: Returns the terminal size as
		  a position report.
748
749

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

753
754
CSI ? [ p1 [ pX ... ] ] s
	NON-STANDARD EXTENSION
755
	Save Mode Setting
deuce's avatar
deuce committed
756
	Saves the current mode states as specified by CSI ? l and CSI ? h.  If
757
	p1 is omitted, saves all such states.  If pX is included, saves only
deuce's avatar
deuce committed
758
759
	the specified states (arguments to CSI ? l/h).

760
	SOURCE: SyncTERM only
761

762
763
764
765
CSI s
	NON-STANDARD EXTENSION
	Save Current Position
	Saves the current cursor position for later restoring with CSI u
766
767
	although this is non-standard, it's so widely used in the BBS world
	that any terminal program MUST implement it.
deuce's avatar
deuce committed
768

769
	SOURCE: ANSI.SYS
770

771
772
CSI ? [ p1 [ pX ... ] ]  u
	NON-STANDARD EXTENSION
773
	Restore Mode Setting
deuce's avatar
deuce committed
774
	Saves the current mode states as specified by CSI ? l and CSI ? h.  If
775
	p1 is omitted, saves all such states.  If pX is included, restores
deuce's avatar
deuce committed
776
777
	all the specified states (arguments to CSI ? l/h)

778
	SOURCE: SyncTERM only
779

780
CSI u
deuce's avatar
deuce committed
781
	NON-STANDARD EXTENSION
782
	Restore Cursor Position
783
784
	Move the cursor to the last position saved by CSI s.  If no position
	has been saved, the cursor is not moved.
785

786
	SOURCE: ANSI.SYS
787
788
789

"ANSI" Music
============
deuce's avatar
deuce committed
790
This is the place where the BBS world completely fell on it's face in ANSI
791
usage.  A programmer with either TeleMate or QModem (the first two programs to
deuce's avatar
deuce committed
792
support "ANSI" music as far as I can tell) decided they needed a method of
793
playing music on a BBS connection.  They decided to add an "unused" ANSI code
deuce's avatar
deuce committed
794
795
796
and go their merry way.  Since their product didn't implement CSI M (Delete
line) they assumed it was unused and blissfully broke the spec.  They defined
"ANSI" music as:
797
CSI M <music string> 0x0e
deuce's avatar
deuce committed
798

799
They used a subset of IBM BASICs PLAY statement functionality for ANSI music
800
strings which often start with "MF" or "MB", so the M after the CSI was often
deuce's avatar
deuce committed
801
considered as part of the music string.  You would see things such as:
802
CSI MFABCD 0x0e and the F would not be played as a note.  This just added
deuce's avatar
deuce committed
803
804
further confusion to the mess.

805
806
807
808
809
810
811
Later on, BananaCom realized the conflict between delete line and music, so
they added *another* broken code CSI N (Properly, erase in field... not
implemented in many BBS clients) which was to provide an "unbroken" method of
playing music strings.  They also used CSI Y to disambiguate delete line, CSI Y
is supposed to be a vertical tab (also not implemented in very many clients).
BananaCom also introduced many more non-standard and standard-breaking control
sequences which are not supported by CTerm.
deuce's avatar
deuce committed
812
813
814
815
816
817

CTerm has further introduced a standard compliant ANSI music introducer CSI |

By default, CTerm allows both CSI N and CSI | to introduce a music string.
Allowed introducers are set by CSI = p1 M as defined above.

818
The details of ANSI music then are as follows:
deuce's avatar
deuce committed
819
820
821
822
823
824
The following characters are allowed in music strings:
"aAbBcCdDeEfFgGlLmMnNoOpPsStT0123456789.-+#<> "
If any character not in this list is present, the music string is ignored as
is the introducing code.

If the introducing code is CSI M the first char is examined, and if it is
deuce's avatar
deuce committed
825
826
827
a one of "BbFfLlSs" or if it is "N" or "n" and is not followed by a decimal
digit, then the music string is treated as though an M is located in front
of the first character.
deuce's avatar
deuce committed
828
829

The music string is then parsed with the following sequences supported:
830
Mx sets misc. music parameters where x is one of the following:
deuce's avatar
deuce committed
831
832
833
	F - Plays music in the foreground, waiting for music to complete
	    playing before more characters are processed.
	B - Play music in the background, allowing normal processing to
834
	    continue.
835
	N - "Normal" not legato, not staccato
deuce's avatar
deuce committed
836
	L - Play notes legato
837
	S - Play notes staccato
deuce's avatar
deuce committed
838
T### Sets the tempo of the music where ### is one or more decimal digits.
deuce's avatar
deuce committed
839
840
841
842
843
844
845
846
847
848
	If the decimal number is greater than 255, it is forced to 255.
	If it is less than 32, it is forced to 32.  The number signifies
	quarter notes per minute.
	The default tempo is 120.
O### Sets the octave of the music where ### is one or more decimal digits.
	If the decimal number is greater than 6, it is forced to 6.
	The default octave is 4.
N### Plays a single note by number.  Valid values are 0 - 71.  Invalid
	values are played as silence.  Note zero is C in octave 0.
	See following section for valid note modifiers.
849
A, B, C, D, E, F, G, or P Plays the named note or pause from the current
deuce's avatar
deuce committed
850
	octave.  An "Octave" is the rising sequence of the following notes:
deuce's avatar
deuce committed
851
852
	C, C#, D, D#, E, F, F#, G, G#, A, A#, B
	This is contrary to normal music terminology.
deuce's avatar
deuce committed
853
	The special note "P" is a pause.
deuce's avatar
deuce committed
854
855
856
857
858
	Notes may be followed by one or more modifier characters which
	are applied in order.  If one overrides a previous one, the last
	is used.  The valid modifiers are:
	+ - Sharp.  The next highest semitone is played.
		Each sharp character will move up one semitone, so "C++"
859
		is equivalent to "D".
deuce's avatar
deuce committed
860
861
	# - Sharp.  The next highest semitone is played.
		Each sharp character will move up one semitone, so "C##"
862
		is equivalent to "D".
deuce's avatar
deuce committed
863
864
	- - Flat.  The next lowest semitone is played.
		Each flat character will move down one semitone, so "D--"
865
		is equivalent to "C".
deuce's avatar
deuce committed
866
	. - Duration is 1.5 times what it would otherwise be.  Dots are not
867
868
		cumulative, so "C.." is equivalent to "C."
	### - Notelength as a reciprocal of the fraction of a whole note to
deuce's avatar
deuce committed
869
870
		play the note for.  For example, 4 would indicate a 1/4 note.
		The default note length is 4.
871
L### Set the notelength parameter for all following notes which do not have
872
873
874
	one specified (ie: override the quarter-note default)  Legal note
	lengths are 1-64 indicating the reciprocal of the fraction (ie: 4
	indicates a 1/4 note).
875
<	Move the next lowest octave.
deuce's avatar
deuce committed
876
877
878
879
880
881
	Octave cannot go above six or below zero.
>	Move to the next highest octave.
	Octave cannot go above six or below zero.

The lowest playable character is C in octave zero.  The frequencies for the
six C notes for the seven octaves in rising order are:
882
65.406, 130.810, 261.620, 523.250, 1046.500, 2093.000, 4186.000
deuce's avatar
deuce committed
883
884
885

Purists will note that the lower three octaves are not exactly one half of
the next higher octave in frequency.  This is due to lost resolution of
886
low frequencies.  The notes *sound* correct to me.  If anyone can give me
deuce's avatar
deuce committed
887
888
an excellent reason to change them (and more correct integer values for all
notes) I am willing to do that assuming the notes still sound "right".
889

890
!!!PLEASE NOTE!!! If you are playing some ANSI Music then ask the user if they
891
heard it, ALWAYS follow it with an 0x0f 0x0e is the shift lock character which
892
893
894
*will* cause people with anything but an ANSI-BBS terminal (ie: *nix users
using the bundled telnet app) to have their screen messed up.  0x0f "undoes"
the 0x0e.