Context Navigation

ctlseqs.ms

Revision 8, 64.2 KB (checked in by emasson, 3 years ago)
initial import for the community edition

Line
1	.\"#! troff -ms $1 -- Nroff --
2	.\" "Xterm Control Sequences" document
3	.\" $XTermId: ctlseqs.ms,v 1.188 2008/04/20 22:24:36 tom Exp $
4	.\"
5	.\"
6	.\" Copyright 1996-2007,2008 by Thomas E. Dickey
7	.\"
8	.\" All Rights Reserved
9	.\"
10	.\" Permission is hereby granted, free of charge, to any person obtaining a
11	.\" copy of this software and associated documentation files (the
12	.\" "Software"), to deal in the Software without restriction, including
13	.\" without limitation the rights to use, copy, modify, merge, publish,
14	.\" distribute, sublicense, and/or sell copies of the Software, and to
15	.\" permit persons to whom the Software is furnished to do so, subject to
16	.\" the following conditions:
17	.\"
18	.\" The above copyright notice and this permission notice shall be included
19	.\" in all copies or substantial portions of the Software.
20	.\"
21	.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22	.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23	.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24	.\" IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
25	.\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
26	.\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
27	.\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28	.\"
29	.\" Except as contained in this notice, the name(s) of the above copyright
30	.\" holders shall not be used in advertising or otherwise to promote the
31	.\" sale, use or other dealings in this Software without prior written
32	.\" authorization.
33	.\"
34	.\"
35	.\" Copyright 1991, 1994 X Consortium
36	.\"
37	.\" Permission is hereby granted, free of charge, to any person obtaining
38	.\" a copy of this software and associated documentation files (the
39	.\" "Software"), to deal in the Software without restriction, including
40	.\" without limitation the rights to use, copy, modify, merge, publish,
41	.\" distribute, sublicense, and/or sell copies of the Software, and to
42	.\" permit persons to whom the Software is furnished to do so, subject to
43	.\" the following conditions:
44	.\"
45	.\" The above copyright notice and this permission notice shall be
46	.\" included in all copies or substantial portions of the Software.
47	.\"
48	.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
49	.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
50	.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
51	.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
52	.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
53	.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
54	.\" OTHER DEALINGS IN THE SOFTWARE.
55	.\"
56	.\" Except as contained in this notice, the name of the X Consortium shall
57	.\" not be used in advertising or otherwise to promote the sale, use or
58	.\" other dealings in this Software without prior written authorization
59	.\" from the X Consortium.
60	.\"
61	.\" X Window System is a trademark of X Consortium, Inc.
62	.\"
63	.\" Originally written by Edward Moy, University of California,
64	.\" Berkeley, edmoy@violet.berkeley.edu, for the X.V10R4 xterm.
65	.\" The X Consortium staff has since updated it for X11.
66	.\" Updated by Thomas E. Dickey for XFree86 3.2 - XFree86 4.3
67	.\"
68	.\" Run this file through troff and use the -ms macro package.
69	.\"
70	.if n .pl 9999v \" no page breaks in nroff
71	.ND
72	.de St
73	.sp
74	.nr PD 0
75	.nr PI 1.0i
76	.nr VS 16
77	..
78	.de Ed
79	.nr PD .3v
80	.nr VS 12
81	..
82	.ds CH \" as nothing
83	.ds LH Xterm Control Sequences
84	.nr s 6*\n(PS/10
85	.ds L \s\nsBEL\s0
86	.ds E \s\nsESC\s0
87	.ds T \s\nsTAB\s0
88	.ds X \s\nsETX\s0
89	.ds N \s\nsENQ\s0
90	.ds e \s\nsETB\s0
91	.ds C \s\nsCAN\s0
92	.ds S \s\nsSUB\s0
93	.\" space between chars
94	.ie t .ds s \\|
95	.el .ds s " \"
96	.nr [W \w'\*L'u
97	.nr w \w'\*E'u
98	.if \nw>\n([W .nr [W \nw
99	.nr w \w'\*T'u
100	.if \nw>\n([W .nr [W \nw
101	.nr w \w'\*X'u
102	.if \nw>\n([W .nr [W \nw
103	.nr w \w'\*N'u
104	.if \nw>\n([W .nr [W \nw
105	.nr w \w'\*e'u
106	.if \nw>\n([W .nr [W \nw
107	.nr w \w'\*C'u
108	.if \nw>\n([W .nr [W \nw
109	.nr w \w'\*S'u
110	.if \nw>\n([W .nr [W \nw
111	.nr [W +\w'\\|\\|'u
112	.de []
113	.nr w \w'\\$2'
114	.nr H \\n([Wu-\\nwu
115	.nr h \\nHu/2u
116	.\" do fancy box in troff
117	.ie t .ds \\$1 \(br\v'-1p'\(br\v'1p'\h'\\nhu'\\$2\h'\\nHu-\\nhu'\(br\l'-\\n([Wu\(ul'\v'-1p'\(br\l'-\\n([Wu\(rn'\v'1p'\*s
118	.el .ds \\$1 \\$2\*s
119	..
120	.[] Et \v'-1p'\*X\v'1p'
121	.[] En \v'-1p'\*N\v'1p'
122	.[] Be \v'-1p'\*L\v'1p'
123	.[] AP \v'-1p'\s\nsAPC\s0\v'1p'
124	.[] Bs \v'-1p'\s\nsBS\s0\v'1p'
125	.[] Cs \v'-1p'\s\nsCSI\s0\v'1p'
126	.[] S2 \v'-1p'\s\nsSS2\s0\v'1p'
127	.[] S3 \v'-1p'\s\nsSS3\s0\v'1p'
128	.[] SS \v'-1p'\s\nsSOS\s0\v'1p'
129	.[] Eg \v'-1p'\s\nsEPA\s0\v'1p'
130	.[] Sg \v'-1p'\s\nsSPA\s0\v'1p'
131	.[] Dc \v'-1p'\s\nsDCS\s0\v'1p'
132	.[] Ht \v'-1p'\s\nsHTS\s0\v'1p'
133	.[] ID \v'-1p'\s\nsIND\s0\v'1p'
134	.[] Nl \v'-1p'\s\nsNEL\s0\v'1p'
135	.[] Os \v'-1p'\s\nsOSC\s0\v'1p'
136	.[] RI \v'-1p'\s\nsRI\s0\v'1p'
137	.[] PM \v'-1p'\s\nsPM\s0\v'1p'
138	.[] ST \v'-1p'\s\nsST\s0\v'1p'
139	.[] Ta \v'-1p'\*T\v'1p'
140	.[] Lf \v'-1p'\s\nsLF\s0\v'1p'
141	.[] Vt \v'-1p'\s\nsVT\s0\v'1p'
142	.[] Ff \v'-1p'\s\nsFF\s0\v'1p'
143	.[] Cr \v'-1p'\s\nsCR\s0\v'1p'
144	.[] So \v'-1p'\s\nsSO\s0\v'1p'
145	.[] Sp \v'-1p'\s\nsSP\s0\v'1p'
146	.[] Si \v'-1p'\s\nsSI\s0\v'1p'
147	.[] Eb \v'-1p'\*e\v'1p'
148	.[] Ca \v'-1p'\*C\v'1p'
149	.[] Su \v'-1p'\*S\v'1p'
150	.[] Es \v'-1p'\*E\v'1p'
151	.[] Fs \v'-1p'\s\nsFS\s0\v'1p'
152	.[] Gs \v'-1p'\s\nsGS\s0\v'1p'
153	.[] Rs \v'-1p'\s\nsRS\s0\v'1p'
154	.[] Us \v'-1p'\s\nsUS\s0\v'1p'
155	.[] XX \v'-1p'\s\nsXX\s0\v'1p'
156	.[] $ $
157	.[] # #
158	.[] % %
159	.[] (( (
160	.[] ) )
161	.[] * *
162	.[] + +
163	.[] , ,
164	.[] - -
165	.[] . .
166	.[] 0 0
167	.[] 1 1
168	.[] 2 2
169	.[] 3 3
170	.[] 4 4
171	.[] 5 5
172	.[] 6 6
173	.[] 7 7
174	.[] 8 8
175	.[] 9 9
176	.[] : :
177	.[] ; ;
178	.[] = =
179	.[] / /
180	.[] < <
181	.[] > >
182	.[] ? ?
183	.[] @ @
184	.[] A A
185	.[] cB B
186	.[] C C
187	.[] D D
188	.[] E E
189	.[] F F
190	.[] G G
191	.[] H H
192	.[] I I
193	.[] J J
194	.[] K K
195	.[] L L
196	.[] M M
197	.[] N N
198	.[] O O
199	.[] P P
200	.[] Q Q
201	.[] R R
202	.[] S S
203	.[] T T
204	.[] V V
205	.[] W W
206	.[] XX X
207	.[] Y Y
208	.[] Z Z
209	.[] [[ [
210	.[] ]] ]
211	.[] bS \\e
212	.[] { {
213	.[] ] ]
214	.[] & &
215	.[] ^ ^
216	.[] _ _
217	.[] qu \&'
218	.[] ` \`
219	.[] a a
220	.[] b b
221	.[] c c
222	.[] d d
223	.[] f f
224	.[] g g
225	.[] h h
226	.[] i i
227	.[] j j
228	.[] k k
229	.[] l l
230	.[] m m
231	.[] n n
232	.[] o o
233	.[] p p
234	.[] q q
235	.[] r r
236	.[] cs s
237	.[] t t
238	.[] u u
239	.[] v v
240	.[] w w
241	.[] x x
242	.[] y y
243	.[] z z
244	.[] \| \|
245	.[] } }
246	.[] ! !
247	.[] c" \(lq
248	.[] c~ ~
249	.[] Sc \fIc\fP
250	.ds Cc \fIC\fP
251	.ds Cb \fIC\v'.3m'\h'-.2m'\s-2b\s0\v'-.3m'\fP
252	.ds Cx \fIC\v'.3m'\h'-.2m'\s-2x\s0\v'-.3m'\fP
253	.ds Cy \fIC\v'.3m'\h'-.2m'\s-2y\s0\v'-.3m'\fP
254	.ds Pb \fIP\v'.3m'\h'-.2m'\s-2b\s0\v'-.3m'\fP
255	.ds Pc \fIP\v'.3m'\h'-.2m'\s-2c\s0\v'-.3m'\fP
256	.ds Pd \fIP\v'.3m'\h'-.2m'\s-2d\s0\v'-.3m'\fP
257	.ds Pe \fIP\v'.3m'\h'-.2m'\s-2e\s0\v'-.3m'\fP
258	.ds Pl \fIP\v'.3m'\h'-.2m'\s-2l\s0\v'-.3m'\fP
259	.ds Pm \fIP\v'.3m'\h'-.2m'\s-2m\s0\v'-.3m'\fP
260	.ds Pp \fIP\v'.3m'\h'-.2m'\s-2p\s0\v'-.3m'\fP
261	.ds Pr \fIP\v'.3m'\h'-.2m'\s-2r\s0\v'-.3m'\fP
262	.ds Ps \fIP\v'.3m'\h'-.2m'\s-2s\s0\v'-.3m'\fP
263	.ds Pt \fIP\v'.3m'\h'-.2m'\s-2t\s0\v'-.3m'\fP
264	.ds Pu \fIP\v'.3m'\h'-.2m'\s-2u\s0\v'-.3m'\fP
265	.ds Pv \fIP\v'.3m'\h'-.2m'\s-2v\s0\v'-.3m'\fP
266	.ds Ix \fIx\fP
267	.ds Iy \fIy\fP
268	.ds Iw \fIw\fP
269	.ds Ih \fIh\fP
270	.ds Ir \fIr\fP
271	.ds Ic \fIc\fP
272	.ie t .nr LL 6.5i
273	.el .nr LL 72m
274	.if n .na
275	.TL
276	Xterm Control Sequences
277	.AU
278	Edward Moy
279	.AI
280	University of California, Berkeley
281	.sp
282	Revised by
283	.AU
284	Stephen Gildea
285	.AI
286	X Consortium (1994)
287	.AU
288	Thomas Dickey
289	.AI
290	XFree86 Project (1996-2006)
291	invisible-island.net (2006-2008)
292	.AU
293	.
294	.am BT \" add page numbers after first page
295	.ds CF %
296	..
297	.SH
298	Definitions
299	.IP \*(Sc
300	The literal character \fIc\fP.
301	.IP \*(Cc
302	A single (required) character.
303	.IP \*(Ps
304	A single (usually optional) numeric parameter, composed of one of more digits.
305	.IP \*(Pm
306	A multiple numeric parameter composed of any number of single numeric
307	parameters, separated by \*; character(s).
308	Individual values for the parameters are listed with \*(Ps .
309	.IP \*(Pt
310	A text parameter composed of printable characters.
311	.
312	.SH
313	C1 (8-Bit) Control Characters
314	.ds RH C1 (8-Bit) Control Characters
315	.LP
316	The \fIxterm\fP program recognizes both 8-bit and 7-bit control characters.
317	It generates 7-bit controls (by default) or 8-bit if S8C1T is enabled.
318	The following pairs of 7-bit and 8-bit control characters are equivalent:
319	.St
320	.IP \\(Es\\D
321	Index (\*(ID is 0x84)
322	.IP \\(Es\\E
323	Next Line (\*(Nl is 0x85)
324	.IP \\(Es\\H
325	Tab Set (\*(Ht is 0x88)
326	.IP \\(Es\\M
327	Reverse Index (\*(RI is 0x8d)
328	.IP \\(Es\\N
329	Single Shift Select of G2 Character Set (\*(S2 is 0x8e): affects next character only
330	.IP \\(Es\\O
331	Single Shift Select of G3 Character Set (\*(S3 is 0x8f): affects next character only
332	.IP \\(Es\\P
333	Device Control String (\*(Dc is 0x90)
334	.IP \\(Es\\V
335	Start of Guarded Area (\*(Sg is 0x96)
336	.IP \\(Es\\W
337	End of Guarded Area (\*(Eg is 0x97)
338	.IP \\(Es\\(XX
339	Start of String (\*(SS is 0x98)
340	.IP \\(Es\\Z
341	Return Terminal ID (DECID is 0x9a). Obsolete form of \(Cs\c (DA).
342	.IP \\(Es\\([[
343	Control Sequence Introducer (\*(Cs is 0x9b)
344	.IP \\(Es\\(bS
345	String Terminator (\*(ST is 0x9c)
346	.IP \\(Es\\(]]
347	Operating System Command (\*(Os is 0x9d)
348	.IP \\(Es\\^
349	Privacy Message (\*(PM is 0x9e)
350	.IP \\(Es\\_
351	Application Program Command (\*(AP is 0x9f)
352	.Ed
353	.sp
354	.LP
355	These control characters are used in the vtXXX emulation.
356	.
357	.SH
358	VT100 Mode
359	.ds RH VT100 Mode
360	.LP
361	Most of these control sequences are standard VT102 control sequences,
362	but there is support for later DEC VT terminals (i.e., VT220, VT320, VT420),
363	as well as ISO 6429 and \fIaixterm\fP color controls.
364	The only VT102 features not supported is auto-repeat,
365	since the only way X provides for this will affect all windows.
366	There are additional control sequences to provide
367	\fIxterm-\fPdependent functions, such as the scrollbar or window size.
368	Where the function is specified by DEC or ISO 6429, the code assigned
369	to it is given in parentheses. The escape codes to designate and invoke
370	character sets are specified by ISO 2022; see that document for a
371	discussion of character sets.
372	.
373	.St
374	.\"
375	.LP
376	.B
377	Single-character functions
378	.\"
379	.IP \\*(Be
380	Bell (Ctrl-G)
381	.
382	.IP \\*(Bs
383	Backspace (Ctrl-H)
384	.
385	.IP \\*(Cr
386	Carriage Return (Ctrl-M)
387	.
388	.IP \\*(En
389	Return Terminal Status (Ctrl-E).
390	Default response is an empty string, but may be overridden
391	by a resource \fBanswerbackString\fP.
392	.
393	.IP \\*(Ff
394	Form Feed or New Page (NP) (Ctrl-L) same as LF
395	.
396	.IP \\*(Lf
397	Line Feed or New Line (NL) (Ctrl-J)
398	.
399	.IP \\*(So
400	Shift Out (Ctrl-N) \(-> Switch to Alternate Character Set: invokes the
401	G1 character set.
402	.
403	.IP \\*(Sp
404	Space.
405	.
406	.IP \\*(Ta
407	Horizontal Tab (HT) (Ctrl-I)
408	.
409	.IP \\*(Vt
410	Vertical Tab (Ctrl-K) same as LF
411	.
412	.IP \\*(Si
413	Shift In (Ctrl-O) \(-> Switch to Standard Character Set: invokes the
414	G0 character set (the default).
415	.Ed
416	.\"
417	.\"
418	.\"
419	.St
420	.LP
421	.B
422	Controls beginning with ESC (other than those where ESC is part of a 7-bit equivalent to 8-bit C1 controls), ordered by the final character(s).
423	.\"
424	.IP \\(Es\\(Sp\\*F
425	7-bit controls (S7C1T).
426	.
427	.IP \\(Es\\(Sp\\*G
428	8-bit controls (S8C1T).
429	.
430	.IP \\(Es\\(Sp\\*L
431	Set ANSI conformance level 1 (dpANS X3.134.1).
432	.
433	.IP \\(Es\\(Sp\\*M
434	Set ANSI conformance level 2 (dpANS X3.134.1).
435	.
436	.IP \\(Es\\(Sp\\*N
437	Set ANSI conformance level 3 (dpANS X3.134.1).
438	.
439	.IP \\(Es\\#\\*3
440	DEC double-height line, top half (DECDHL)
441	.
442	.IP \\(Es\\#\\*4
443	DEC double-height line, bottom half (DECDHL)
444	.
445	.IP \\(Es\\#\\*5
446	DEC single-width line (DECSWL)
447	.
448	.IP \\(Es\\#\\*6
449	DEC double-width line (DECDWL)
450	.
451	.IP \\(Es\\#\\*8
452	DEC Screen Alignment Test (DECALN)
453	.
454	.IP \\(Es\\%\\*@
455	Select default character set, ISO 8859-1 (ISO 2022)
456	.
457	.IP \\(Es\\%\\*G
458	Select UTF-8 character set (ISO 2022)
459	.
460	.IP \\(Es\\(((\\*(Cc
461	Designate G0 Character Set (ISO 2022)
462	.IP \\(Es\\)\\*(Cc
463	Designate G1 Character Set (ISO 2022)
464	.
465	.IP \\(Es\\\\(Cc
466	Designate G2 Character Set (ISO 2022)
467	.
468	.IP \\(Es\\+\\*(Cc
469	Designate G3 Character Set (ISO 2022)
470	.br
471	Final character \*(Cc for designating character sets
472	(\0, \A and \*(cB apply to VT100 and up, the remainder to VT220 and up):
473	\(Cc = \0 \(-> DEC Special Character and Line Drawing Set
474	\(Cc = \A \(-> United Kingdom (UK)
475	\(Cc = \(cB \(-> United States (USASCII)
476	\(Cc = \4 \(-> Dutch
477	\(Cc = \C or \*5 \(-> Finnish
478	\(Cc = \R \(-> French
479	\(Cc = \Q \(-> French Canadian
480	\(Cc = \K \(-> German
481	\(Cc = \Y \(-> Italian
482	\(Cc = \E or \*6 \(-> Norwegian/Danish
483	\(Cc = \Z \(-> Spanish
484	\(Cc = \H or \*7 \(-> Swedish
485	\(Cc = \= \(-> Swiss
486	.
487	.IP \\(Es\\7
488	Save Cursor (DECSC)
489	.
490	.IP \\(Es\\8
491	Restore Cursor (DECRC)
492	.
493	.IP \\(Es\\=
494	Application Keypad (DECPAM)
495	.
496	.IP \\(Es\\>
497	Normal Keypad (DECPNM)
498	.
499	.IP \\(Es\\F
500	Cursor to lower left corner of screen (if
501	enabled by the \fBhpLowerleftBugCompat\fP resource).
502	.
503	.IP \\(Es\\c
504	Full Reset (RIS)
505	.
506	.IP \\(Es\\l
507	Memory Lock (per HP terminals). Locks memory above the cursor.
508	.
509	.IP \\(Es\\m
510	Memory Unlock (per HP terminals)
511	.
512	.IP \\(Es\\n
513	Invoke the G2 Character Set as GL (LS2).
514	.
515	.IP \\(Es\\o
516	Invoke the G3 Character Set as GL (LS3).
517	.
518	.IP \\(Es\\\|
519	Invoke the G3 Character Set as GR (LS3R).
520	.
521	.IP \\(Es\\}
522	Invoke the G2 Character Set as GR (LS2R).
523	.
524	.IP \\(Es\\(c~
525	Invoke the G1 Character Set as GR (LS1R).
526	.Ed
527	.
528	.St
529	.LP
530	.B
531	Application Program-Control functions
532	.IP \\(AP\\(Pt\\s\\(ST
533	\fIxterm\fP implements no \(AP functions; \(Pt is ignored.
534	\*(Pt need not be printable characters.
535	.Ed
536	.
537	.St
538	.LP
539	.B
540	Device-Control functions
541	.IP \\(Dc\\(Ps\\;\\(Ps\\\|\\(Pt\\s\\(ST
542	User-Defined Keys (DECUDK).
543	The first parameter:
544	\(Ps = \0 \(-> Clear all UDK definitions before starting (default)
545	\(Ps = \1 \(-> Erase Below (default)
546	.br
547	The second parameter:
548	\(Ps = \0 \(-> Lock the keys (default)
549	\(Ps = \1 \(-> Do not lock.
550	.br
551	The third parameter is a ';'-separated list of strings denoting
552	the key-code separated by a '/' from the hex-encoded key value.
553	The key codes correspond to the DEC function-key codes (e.g., F6=17).
554	.
555	.IP \\(Dc\\$\\q\\(Pt\\s\\(ST
556	Request Status String (DECRQSS).
557	The string following the "q" is one of the following:
558	\(c"\q \(-> DECSCA
559	\(c"\p \(-> DECSCL
560	\*r \(-> DECSTBM
561	\*m \(-> SGR
562	.br
563	\fIxterm\fP responds with
564	\(Dc\1\$\r\(Pt\s\*(ST
565	for valid requests, replacing the \(Pt with the corresponding \(Cs
566	string,
567	or
568	\(Dc\0\$\r\(Pt\s\*(ST
569	for invalid requests.
570	.
571	.IP \\(Dc\\+\\q\\(Pt\\s\\(ST
572	Request Termcap/Terminfo String (xterm, experimental).
573	The string following the "q" is a list of names
574	encoded in hexadecimal (2 digits per character)
575	separated by \*;
576	which correspond to termcap or terminfo key names.
577	.br
578	\fIxterm\fP responds with
579	\(Dc\1\+\r\(Pt\s\*(ST
580	for valid requests, adding to \(Pt an \=,
581	and the value of the corresponding string that xterm would send,
582	or
583	\(Dc\0\+\r\(Pt\s\*(ST
584	for invalid requests.
585	The strings are encoded in hexadecimal (2 digits per character).
586	.Ed
587	.\"
588	.St
589	.LP
590	.B
591	Functions using \*(Cs, ordered by the final character(s)
592	.IP \\(Cs\\(Ps\\s\\@
593	Insert \*(Ps (Blank) Character(s) (default = 1) (ICH)
594	.
595	.IP \\(Cs\\(Ps\\s\\A
596	Cursor Up \*(Ps Times (default = 1) (CUU)
597	.
598	.IP \\(Cs\\(Ps\\s\\(cB
599	Cursor Down \*(Ps Times (default = 1) (CUD)
600	.
601	.IP \\(Cs\\(Ps\\s\\C
602	Cursor Forward \*(Ps Times (default = 1) (CUF)
603	.
604	.IP \\(Cs\\(Ps\\s\\D
605	Cursor Backward \*(Ps Times (default = 1) (CUB)
606	.
607	.IP \\(Cs\\(Ps\\s\\E
608	Cursor Next Line \*(Ps Times (default = 1) (CNL)
609	.
610	.IP \\(Cs\\(Ps\\s\\F
611	Cursor Preceding Line \*(Ps Times (default = 1) (CPL)
612	.
613	.IP \\(Cs\\(Ps\\s\\G
614	Cursor Character Absolute [column] (default = [row,1]) (CHA)
615	.
616	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\*H
617	Cursor Position [row;column] (default = [1,1]) (CUP)
618	.
619	.IP \\(Cs\\(Ps\\s\\I
620	Cursor Forward Tabulation \*(Ps tab stops (default = 1) (CHT)
621	.
622	.IP \\(Cs\\(Ps\\s\\J
623	Erase in Display (ED)
624	\(Ps = \0 \(-> Erase Below (default)
625	\(Ps = \1 \(-> Erase Above
626	\(Ps = \2 \(-> Erase All
627	\(Ps = \3 \(-> Erase Saved Lines (xterm)
628	.
629	.IP \\(Cs\\?\\(Ps\\s\\*J
630	Erase in Display (DECSED)
631	\(Ps = \0 \(-> Selective Erase Below (default)
632	\(Ps = \1 \(-> Selective Erase Above
633	\(Ps = \2 \(-> Selective Erase All
634	.
635	.IP \\(Cs\\(Ps\\s\\K
636	Erase in Line (EL)
637	\(Ps = \0 \(-> Erase to Right (default)
638	\(Ps = \1 \(-> Erase to Left
639	\(Ps = \2 \(-> Erase All
640	.
641	.IP \\(Cs\\?\\(Ps\\s\\*K
642	Erase in Line (DECSEL)
643	\(Ps = \0 \(-> Selective Erase to Right (default)
644	\(Ps = \1 \(-> Selective Erase to Left
645	\(Ps = \2 \(-> Selective Erase All
646	.
647	.IP \\(Cs\\(Ps\\s\\L
648	Insert \*(Ps Line(s) (default = 1) (IL)
649	.
650	.IP \\(Cs\\(Ps\\s\\M
651	Delete \*(Ps Line(s) (default = 1) (DL)
652	.
653	.IP \\(Cs\\(Ps\\s\\P
654	Delete \*(Ps Character(s) (default = 1) (DCH)
655	.
656	.IP \\(Cs\\(Ps\\s\\S
657	Scroll up \*(Ps lines (default = 1) (SU)
658	.
659	.IP \\(Cs\\(Ps\\s\\T
660	Scroll down \*(Ps lines (default = 1) (SD)
661	.
662	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\;\\(Ps\\s\\;\\(Ps\\s\\;\\(Ps\\s\\T
663	Initiate highlight mouse tracking.
664	Parameters are [func;startx;starty;firstrow;lastrow].
665	See the section \fBMouse Tracking\fP.
666	.
667	.IP \\(Cs\\(Ps\\s\\(XX
668	Erase \*(Ps Character(s) (default = 1) (ECH)
669	.
670	.IP \\(Cs\\(Ps\\s\\Z
671	Cursor Backward Tabulation \*(Ps tab stops (default = 1) (CBT)
672	.
673	.IP \\(Cs\\(Pm\\s\\`
674	Character Position Absolute [column] (default = [row,1]) (HPA)
675	.
676	.IP \\(Cs\\(Ps\\s\\b
677	Repeat the preceding graphic character \*(Ps times (REP)
678	.
679	.IP \\(Cs\\(Ps\\s\\c
680	Send Device Attributes (Primary DA)
681	\(Ps = \0 or omitted \(-> request attributes from terminal.
682	The response depends on the \fBdecTerminalID\fP resource setting.
683	\(-> \(Cs\?\1\;\2\c (``VT100 with Advanced Video Option'')
684	\(-> \(Cs\?\1\;\0\c (``VT101 with No Options'')
685	\(-> \(Cs\?\6\c (``VT102'')
686	\(-> \(Cs\?\6\0\;\1\;\2\;\6\;\8\;\9\;\1\5\;\*c (``VT220'')
687	.br
688	The VT100-style response parameters do not mean anything by themselves.
689	VT220 parameters do, telling the host what features the terminal supports:
690	\(-> \*1 132-columns
691	\(-> \*2 Printer
692	\(-> \*6 Selective erase
693	\(-> \*8 User-defined keys
694	\(-> \*9 National replacement character sets
695	\(-> \1\5 Technical characters
696	\(-> \2\2 ANSI color, e.g., VT525
697	\(-> \2\9 ANSI text locator (i.e., DEC Locator mode)
698	.
699	.IP \\(Cs\\>\\(Ps\\s\\*c
700	Send Device Attributes (Secondary DA)
701	\(Ps = \0 or omitted \(-> request the terminal's identification code.
702	The response depends on the \fBdecTerminalID\fP resource setting.
703	It should apply only to VT220 and up, but \fIxterm\fP extends this to VT100.
704	\(-> \(Cs\s\>\(Pp\s\;\(Pv\s\;\(Pc\s\c
705	.br
706	where \*(Pp denotes the terminal type
707	\(-> \*0 (``VT100'')
708	\(-> \*1 (``VT220'')
709	.br
710	and \*(Pv is the firmware version (for \fIxterm\fP, this was originally
711	the XFree86 patch number, starting with 95).
712	In a DEC terminal, \*(Pc indicates the ROM cartridge
713	registration number and is always zero.
714	.
715	.IP \\(Cs\\(Pm\\s\\d
716	Line Position Absolute [row] (default = [1,column]) (VPA)
717	.
718	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\*f
719	Horizontal and Vertical Position [row;column] (default = [1,1]) (HVP)
720	.
721	.IP \\(Cs\\(Ps\\s\\g
722	Tab Clear (TBC)
723	\(Ps = \0 \(-> Clear Current Column (default)
724	\(Ps = \3 \(-> Clear All
725	.
726	.IP \\(Cs\\(Pm\\s\\h
727	Set Mode (SM)
728	\(Ps = \2 \(-> Keyboard Action Mode (AM)
729	\(Ps = \4 \(-> Insert Mode (IRM)
730	\(Ps = \1\*2 \(-> Send/receive (SRM)
731	\(Ps = \2\*0 \(-> Automatic Newline (LNM)
732	.
733	.IP \\(Cs\\?\\(Pm\\s\\*h
734	DEC Private Mode Set (DECSET)
735	\(Ps = \1 \(-> Application Cursor Keys (DECCKM)
736	\(Ps = \2 \(-> Designate USASCII for character sets G0-G3 (DECANM),
737	and set VT100 mode.
738	\(Ps = \3 \(-> 132 Column Mode (DECCOLM)
739	\(Ps = \4 \(-> Smooth (Slow) Scroll (DECSCLM)
740	\(Ps = \5 \(-> Reverse Video (DECSCNM)
741	\(Ps = \6 \(-> Origin Mode (DECOM)
742	\(Ps = \7 \(-> Wraparound Mode (DECAWM)
743	\(Ps = \8 \(-> Auto-repeat Keys (DECARM)
744	\(Ps = \9 \(-> Send Mouse X & Y on button press.
745	See the section \fBMouse Tracking\fP.
746	\(Ps = \1\*0 \(-> Show toolbar (rxvt)
747	\(Ps = \1\*2 \(-> Start Blinking Cursor (att610)
748	\(Ps = \1\*8 \(-> Print form feed (DECPFF)
749	\(Ps = \1\*9 \(-> Set print extent to full screen (DECPEX)
750	\(Ps = \2\*5 \(-> Show Cursor (DECTCEM)
751	\(Ps = \3\*0 \(-> Show scrollbar (rxvt).
752	\(Ps = \3\*5 \(-> Enable font-shifting functions (rxvt).
753	\(Ps = \3\*8 \(-> Enter Tektronix Mode (DECTEK)
754	\(Ps = \4\*0 \(-> Allow 80 \z\(<-\(-> 132 Mode
755	\(Ps = \4\*1 \(-> \fImore\fP(1) fix (see \fBcurses\fP resource)
756	\(Ps = \4\*2 \(-> Enable Nation Replacement Character sets (DECNRCM)
757	\(Ps = \4\*4 \(-> Turn On Margin Bell
758	\(Ps = \4\*5 \(-> Reverse-wraparound Mode
759	\(Ps = \4\*6 \(-> Start Logging
760	(normally disabled by a compile-time option)
761	\(Ps = \4\*7 \(-> Use Alternate Screen Buffer (unless
762	disabled by the \fBtiteInhibit\fP resource)
763	\(Ps = \6\*6 \(-> Application keypad (DECNKM)
764	\(Ps = \6\*7 \(-> Backarrow key sends backspace (DECBKM)
765	\(Ps = \1\0\0\*0 \(-> Send Mouse X & Y on button press and release.
766	See the section \fBMouse Tracking\fP.
767	\(Ps = \1\0\0\*1 \(-> Use Hilite Mouse Tracking.
768	\(Ps = \1\0\0\*2 \(-> Use Cell Motion Mouse Tracking.
769	\(Ps = \1\0\0\*3 \(-> Use All Motion Mouse Tracking.
770	\(Ps = \1\0\0\*4 \(-> Send FocusIn/FocusOut events.
771	\(Ps = \1\0\1\*0 \(-> Scroll to bottom on tty output (rxvt).
772	\(Ps = \1\0\1\*1 \(-> Scroll to bottom on key press (rxvt).
773	\(Ps = \1\0\3\*4 \(-> Interpret "meta" key, sets eighth bit.
774	(enables the \fBeightBitInput\fP resource).
775	\(Ps = \1\0\3\*5 \(-> Enable special modifiers for Alt and NumLock keys
776	(enables the \fBnumLock\fP resource).
777	\(Ps = \1\0\3\*6 \(-> Send ESC when Meta modifies a key
778	(enables the \fBmetaSendsEscape\fP resource).
779	\(Ps = \1\0\3\*7 \(-> Send DEL from the editing-keypad Delete key
780	\(Ps = \1\0\3\*9 \(-> Send ESC when Alt modifies a key
781	(enables the \fBaltSendsEscape\fP resource).
782	\(Ps = \1\0\4\*0 \(-> Keep selection even if not highlighted
783	(enables the \fBkeepSelection\fP resource).
784	\(Ps = \1\0\4\*1 \(-> Use the CLIPBOARD selection
785	(enables the \fBselectToClipboard\fP resource).
786	\(Ps = \1\0\4\*2 \(-> Enable Urgency window manager hint when Control-G is received
787	(enables the \fBbellIsUrgent\fP resource).
788	\(Ps = \1\0\4\*3 \(-> Enable raising of the window when Control-G is received
789	(enables the \fBpopOnBell\fP resource).
790	\(Ps = \1\0\4\*7 \(-> Use Alternate Screen Buffer (unless
791	disabled by the \fBtiteInhibit\fP resource)
792	\(Ps = \1\0\4\*8 \(-> Save cursor as in DECSC (unless
793	disabled by the \fBtiteInhibit\fP resource)
794	\(Ps = \1\0\4\*9 \(-> Save cursor as in DECSC
795	and use Alternate Screen Buffer, clearing it first (unless
796	disabled by the \fBtiteInhibit\fP resource).
797	This combines the effects of the \1\0\4\7 and \1\0\4\8 modes.
798	Use this with terminfo-based applications rather than the \4\7 mode.
799	\(Ps = \1\0\5\*0 \(-> Set terminfo/termcap function-key mode.
800	\(Ps = \1\0\5\*1 \(-> Set Sun function-key mode.
801	\(Ps = \1\0\5\*2 \(-> Set HP function-key mode.
802	\(Ps = \1\0\5\*3 \(-> Set SCO function-key mode.
803	\(Ps = \1\0\6\*0 \(-> Set legacy keyboard emulation (X11R6).
804	\(Ps = \1\0\6\*1 \(-> Set VT220 keyboard emulation.
805	\(Ps = \2\0\0\*4 \(-> Set bracketed paste mode.
806	.
807	.IP \\(Cs\\(Pm\\s\\i
808	Media Copy (MC)
809	\(Ps = \0 \(-> Print screen (default)
810	\(Ps = \4 \(-> Turn off printer controller mode
811	\(Ps = \5 \(-> Turn on printer controller mode
812	.
813	.IP \\(Cs\\?\\(Pm\\s\\*i
814	Media Copy (MC, DEC-specific)
815	\(Ps = \1 \(-> Print line containing cursor
816	\(Ps = \4 \(-> Turn off autoprint mode
817	\(Ps = \5 \(-> Turn on autoprint mode
818	\(Ps = \1 \*0 \(-> Print composed display, ignores DECPEX
819	\(Ps = \1 \*1 \(-> Print all pages
820	.
821	.IP \\(Cs\\(Pm\\s\\l
822	Reset Mode (RM)
823	\(Ps = \2 \(-> Keyboard Action Mode (AM)
824	\(Ps = \4 \(-> Replace Mode (IRM)
825	\(Ps = \1\*2 \(-> Send/receive (SRM)
826	\(Ps = \2\*0 \(-> Normal Linefeed (LNM)
827	.
828	.IP \\(Cs\\?\\(Pm\\s\\*l
829	DEC Private Mode Reset (DECRST)
830	\(Ps = \1 \(-> Normal Cursor Keys (DECCKM)
831	\(Ps = \2 \(-> Designate VT52 mode (DECANM).
832	\(Ps = \3 \(-> 80 Column Mode (DECCOLM)
833	\(Ps = \4 \(-> Jump (Fast) Scroll (DECSCLM)
834	\(Ps = \5 \(-> Normal Video (DECSCNM)
835	\(Ps = \6 \(-> Normal Cursor Mode (DECOM)
836	\(Ps = \7 \(-> No Wraparound Mode (DECAWM)
837	\(Ps = \8 \(-> No Auto-repeat Keys (DECARM)
838	\(Ps = \9 \(-> Don't send Mouse X & Y on button press
839	\(Ps = \1\*0 \(-> Hide toolbar (rxvt)
840	\(Ps = \1\*2 \(-> Stop Blinking Cursor (att610)
841	\(Ps = \1\*8 \(-> Don't print form feed (DECPFF)
842	\(Ps = \1\*9 \(-> Limit print to scrolling region (DECPEX)
843	\(Ps = \2\*5 \(-> Hide Cursor (DECTCEM)
844	\(Ps = \3\*0 \(-> Don't show scrollbar (rxvt).
845	\(Ps = \3\*5 \(-> Disable font-shifting functions (rxvt).
846	\(Ps = \4\*0 \(-> Disallow 80 \z\(<-\(-> 132 Mode
847	\(Ps = \4\*1 \(-> No \fImore\fP(1) fix (see \fBcurses\fP resource)
848	\(Ps = \4\*2 \(-> Disable Nation Replacement Character sets (DECNRCM)
849	\(Ps = \4\*4 \(-> Turn Off Margin Bell
850	\(Ps = \4\*5 \(-> No Reverse-wraparound Mode
851	\(Ps = \4\*6 \(-> Stop Logging
852	(normally disabled by a compile-time option)
853	\(Ps = \4\*7 \(-> Use Normal Screen Buffer
854	\(Ps = \6\*6 \(-> Numeric keypad (DECNKM)
855	\(Ps = \6\*7 \(-> Backarrow key sends delete (DECBKM)
856	\(Ps = \1\0\0\*0 \(-> Don't send Mouse X & Y on button press and
857	release.
858	See the section \fBMouse Tracking\fP.
859	\(Ps = \1\0\0\*1 \(-> Don't use Hilite Mouse Tracking.
860	\(Ps = \1\0\0\*2 \(-> Don't use Cell Motion Mouse Tracking.
861	\(Ps = \1\0\0\*3 \(-> Don't use All Motion Mouse Tracking.
862	\(Ps = \1\0\0\*4 \(-> Don't send FocusIn/FocusOut events.
863	\(Ps = \1\0\1\*0 \(-> Don't scroll to bottom on tty output (rxvt).
864	\(Ps = \1\0\1\*1 \(-> Don't scroll to bottom on key press (rxvt).
865	\(Ps = \1\0\3\*4 \(-> Don't interpret "meta" key
866	(disables the \fBeightBitInput\fP resource).
867	\(Ps = \1\0\3\*5 \(-> Disable special modifiers for Alt and NumLock keys
868	(disables the \fBnumLock\fP resource).
869	\(Ps = \1\0\3\*6 \(-> Don't send ESC when Meta modifies a key
870	(disables the \fBmetaSendsEscape\fP resource).
871	\(Ps = \1\0\3\*7 \(-> Send VT220 Remove from the editing-keypad Delete key
872	\(Ps = \1\0\3\*9 \(-> Don't send ESC when Alt modifies a key
873	(disables the \fBaltSendsEscape\fP resource).
874	\(Ps = \1\0\4\*0 \(-> Do not keep selection when not highlighted
875	(disables the \fBkeepSelection\fP resource).
876	\(Ps = \1\0\4\*1 \(-> Use the PRIMARY selection.
877	(disables the \fBselectToClipboard\fP resource).
878	\(Ps = \1\0\4\*2 \(-> Disable Urgency window manager hint when Control-G is received
879	(disables the \fBbellIsUrgent\fP resource).
880	\(Ps = \1\0\4\*3 \(-> Disable raising of the window when Control-G is received
881	(disables the \fBpopOnBell\fP resource).
882	\(Ps = \1\0\4\*7 \(-> Use Normal Screen Buffer, clearing screen
883	first if in the Alternate Screen (unless
884	disabled by the \fBtiteInhibit\fP resource)
885	\(Ps = \1\0\4\*8 \(-> Restore cursor as in DECRC (unless
886	disabled by the \fBtiteInhibit\fP resource)
887	\(Ps = \1\0\4\*9 \(-> Use Normal Screen Buffer and restore cursor
888	as in DECRC (unless
889	disabled by the \fBtiteInhibit\fP resource).
890	This combines the effects of the \1\0\4\7 and \1\0\4\8 modes.
891	Use this with terminfo-based applications rather than the \4\7 mode.
892	\(Ps = \1\0\5\*0 \(-> Reset terminfo/termcap function-key mode.
893	\(Ps = \1\0\5\*1 \(-> Reset Sun function-key mode.
894	\(Ps = \1\0\5\*2 \(-> Reset HP function-key mode.
895	\(Ps = \1\0\5\*3 \(-> Reset SCO function-key mode.
896	\(Ps = \1\0\6\*0 \(-> Reset legacy keyboard emulation (X11R6).
897	\(Ps = \1\0\6\*1 \(-> Reset keyboard emulation to Sun/PC style.
898	\(Ps = \2\0\0\*4 \(-> Reset bracketed paste mode.
899	.
900	.IP \\(Cs\\(Pm\\s\\m
901	Character Attributes (SGR)
902	\(Ps = \0 \(-> Normal (default)
903	\(Ps = \1 \(-> Bold
904	\(Ps = \4 \(-> Underlined
905	\(Ps = \5 \(-> Blink (appears as Bold)
906	\(Ps = \7 \(-> Inverse
907	\(Ps = \8 \(-> Invisible, i.e., hidden (VT300)
908	\(Ps = \2\*2 \(-> Normal (neither bold nor faint)
909	\(Ps = \2\*4 \(-> Not underlined
910	\(Ps = \2\*5 \(-> Steady (not blinking)
911	\(Ps = \2\*7 \(-> Positive (not inverse)
912	\(Ps = \2\*8 \(-> Visible, i.e., not hidden (VT300)
913	\(Ps = \3\*0 \(-> Set foreground color to Black
914	\(Ps = \3\*1 \(-> Set foreground color to Red
915	\(Ps = \3\*2 \(-> Set foreground color to Green
916	\(Ps = \3\*3 \(-> Set foreground color to Yellow
917	\(Ps = \3\*4 \(-> Set foreground color to Blue
918	\(Ps = \3\*5 \(-> Set foreground color to Magenta
919	\(Ps = \3\*6 \(-> Set foreground color to Cyan
920	\(Ps = \3\*7 \(-> Set foreground color to White
921	\(Ps = \3\*9 \(-> Set foreground color to default (original)
922	\(Ps = \4\*0 \(-> Set background color to Black
923	\(Ps = \4\*1 \(-> Set background color to Red
924	\(Ps = \4\*2 \(-> Set background color to Green
925	\(Ps = \4\*3 \(-> Set background color to Yellow
926	\(Ps = \4\*4 \(-> Set background color to Blue
927	\(Ps = \4\*5 \(-> Set background color to Magenta
928	\(Ps = \4\*6 \(-> Set background color to Cyan
929	\(Ps = \4\*7 \(-> Set background color to White
930	\(Ps = \4\*9 \(-> Set background color to default (original).
931	.sp
932	If 16-color support is compiled, the following apply.
933	Assume that \fIxterm\fP's resources
934	are set so that the ISO color codes are the first 8 of a set of 16.
935	Then the \fIaixterm\fP colors are the bright versions of the ISO colors:
936	\(Ps = \9\*0 \(-> Set foreground color to Black
937	\(Ps = \9\*1 \(-> Set foreground color to Red
938	\(Ps = \9\*2 \(-> Set foreground color to Green
939	\(Ps = \9\*3 \(-> Set foreground color to Yellow
940	\(Ps = \9\*4 \(-> Set foreground color to Blue
941	\(Ps = \9\*5 \(-> Set foreground color to Magenta
942	\(Ps = \9\*6 \(-> Set foreground color to Cyan
943	\(Ps = \9\*7 \(-> Set foreground color to White
944	\(Ps = \1\0\0 \(-> Set background color to Black
945	\(Ps = \1\0\1 \(-> Set background color to Red
946	\(Ps = \1\0\2 \(-> Set background color to Green
947	\(Ps = \1\0\3 \(-> Set background color to Yellow
948	\(Ps = \1\0\4 \(-> Set background color to Blue
949	\(Ps = \1\0\5 \(-> Set background color to Magenta
950	\(Ps = \1\0\6 \(-> Set background color to Cyan
951	\(Ps = \1\0\7 \(-> Set background color to White
952	.sp
953	If \fIxterm\fP is compiled with the 16-color support disabled, it supports
954	the following, from \fIrxvt\fP:
955	\(Ps = \1\0\0 \(-> Set foreground and background color to default
956	.sp
957	If 88- or 256-color support is compiled, the following apply.
958	\(Ps = \3\8 ; \5 ; \(Ps \(-> Set foreground color to the second \(Ps
959	\(Ps = \4\8 ; \5 ; \(Ps \(-> Set background color to the second \(Ps
960	.sp
961	.
962	.IP \\(Cs\\>\\(Ps\\;\\(Ps\\s\\*m
963	Set or reset resource-values used by \fIxterm\fP to decide whether to
964	construct escape sequences holding information about the modifiers
965	pressed with a given key.
966	The first parameter identifies the resource to set/reset.
967	The second parameter is the value to assign to the resource.
968	If the second parameter is omitted, the resource is reset to its initial value.
969	\(-> \*1 modifyCursorKeys
970	\(-> \*2 modifyFunctionKeys
971	\(-> \*4 modifyOtherKeys
972	.br
973	If no parameters are given, all resources are reset to their initial values.
974	.
975	.IP \\(Cs\\(Ps\\s\\n
976	Device Status Report (DSR)
977	\(Ps = \5 \(-> Status Report \(Cs\0\*n (``OK'')
978	\(Ps = \6 \(-> Report Cursor Position (CPR) [row;column] as
979	.br
980	\(Cs\(Ir\s\;\(Ic\s\*R
981	.
982	.IP \\(Cs\\>\\(Ps\\s\\*n
983	Disable modifiers which may be enabled via the
984	\(Cs\>\(Ps\;\(Ps\s\*m
985	sequence.
986	This corresponds to a resource value of "-1", which cannot be set with
987	the other sequence.
988	The parameter identifies the resource to be disabled:
989	\(-> \*1 modifyCursorKeys
990	\(-> \*2 modifyFunctionKeys
991	\(-> \*4 modifyOtherKeys
992	If the parameter is omitted, \fBmodifyFunctionKeys\fP is disabled.
993	When \fBmodifyFunctionKeys\fP is disabled, \fIxterm\fP uses the
994	modifier keys to make an extended sequence of functions rather
995	than adding a parameter to each function key to denote the modifiers.
996	.
997	.IP \\(Cs\\?\\(Ps\\s\\*n
998	Device Status Report (DSR, DEC-specific)
999	\(Ps = \6 \(-> Report Cursor Position (CPR) [row;column] as
1000	\(Cs\?\(Ir\s\;\(Ic\s\R
1001	(assumes page is zero).
1002	\(Ps = \1\*5 \(-> Report Printer status as
1003	\(Cs\?\1\0\s\n (ready)
1004	or
1005	\(Cs\?\1\1\s\n (not ready)
1006	\(Ps = \2\*5 \(-> Report UDK status as
1007	\(Cs\?\2\0\s\n (unlocked)
1008	or
1009	\(Cs\?\2\1\s\n (locked)
1010	\(Ps = \2\*6 \(-> Report Keyboard status as
1011	.br
1012	\(Cs\?\2\7\s\;\s\1\s\;\s\0\s\;\s\0\s\n (North American)
1013	.br
1014	The last two parameters apply to VT400 & up, and denote keyboard ready and LK01 respectively.
1015	\(Ps = \5\*3 \(-> Report Locator status as
1016	.br
1017	\(Cs\?\5\3\s\n Locator available, if compiled-in, or
1018	.br
1019	\(Cs\?\5\0\s\n No Locator, if not.
1020	.
1021	.IP \\(Cs\\>\\(Ps\\s\\*p
1022	Set resource value \fIpointerMode\fP,
1023	used by \fIxterm\fP to decide whether to
1024	hide the pointer cursor as the user types.
1025	Valid values for the parameter:
1026	\(Ps = \0 \(-> never hide the pointer
1027	\(Ps = \1 \(-> hide if the mouse tracking mode is not enabled
1028	\(Ps = \2 \(-> always hide the pointer
1029	If no parameter is given, \fIxterm\fP uses the default,
1030	which is \*1.
1031	.
1032	.IP \\(Cs\\!\\*p
1033	Soft terminal reset (DECSTR)
1034	.
1035	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\(c"\\p
1036	Set conformance level (DECSCL)
1037	Valid values for the first parameter:
1038	\(Ps = \6\*1 \(-> VT100
1039	\(Ps = \6\*2 \(-> VT200
1040	\(Ps = \6\*3 \(-> VT300
1041	.br
1042	Valid values for the second parameter:
1043	\(Ps = \0 \(-> 8-bit controls
1044	\(Ps = \1 \(-> 7-bit controls (always set for VT100)
1045	\(Ps = \2 \(-> 8-bit controls
1046	.
1047	.IP \\(Cs\\(Ps\\s\\(c"\\*q
1048	Select character protection attribute (DECSCA).
1049	Valid values for the parameter:
1050	\(Ps = \0 \(-> DECSED and DECSEL can erase (default)
1051	\(Ps = \1 \(-> DECSED and DECSEL cannot erase
1052	\(Ps = \2 \(-> DECSED and DECSEL can erase
1053	.
1054	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\*r
1055	Set Scrolling Region [top;bottom] (default = full size of window) (DECSTBM)
1056	.
1057	.IP \\(Cs\\?\\(Pm\\s\\*r
1058	Restore DEC Private Mode Values. The value of \*(Ps previously saved is
1059	restored. \*(Ps values are the same as for DECSET.
1060	.
1061	.IP \\(Cs\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\;\\(Ps\\$\\r
1062	Change Attributes in Rectangular Area (DECCARA).
1063	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1064	\*(Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7
1065	.
1066	.IP \\(Cs\\(cs
1067	Save cursor (ANSI.SYS)
1068	.
1069	.IP \\(Cs\\?\\(Pm\\s\\*(cs
1070	Save DEC Private Mode Values. \*(Ps values are the same as for DECSET.
1071	.
1072	.IP \\(Cs\\(Ps\\s\\;\\(Ps\\s\\;\\(Ps\\s\\t
1073	Window manipulation (from \fIdtterm\fP, as well as extensions).
1074	These controls may be disabled using the \fIallowWindowOps\fP resource.
1075	Valid values for the first (and any additional parameters) are:
1076	\(Ps = \1 \(-> De-iconify window.
1077	\(Ps = \2 \(-> Iconify window.
1078	\(Ps = \3 ; \fIx ; y\fP \(-> Move window to [x, y].
1079	\(Ps = \4 ; \fIheight ; width\fP \(-> Resize the \fIxterm\fP window to height and width in pixels.
1080	\(Ps = \5 \(-> Raise the \fIxterm\fP window to the front of the stacking order.
1081	\(Ps = \6 \(-> Lower the \fIxterm\fP window to the bottom of the stacking order.
1082	\(Ps = \7 \(-> Refresh the \fIxterm\fP window.
1083	\(Ps = \8 ; \fIheight ; width\fP \(-> Resize the text area to [height;width] in characters.
1084	\(Ps = \9 ; \*0 \(-> Restore maximized window.
1085	\(Ps = \9 ; \*1 \(-> Maximize window (i.e., resize to screen size).
1086	\(Ps = \1\*1 \(-> Report \fIxterm\fP window state.
1087	If the \fIxterm\fP window is open (non-iconified), it returns \(Cs\1\*t.
1088	If the \fIxterm\fP window is iconified, it returns \(Cs\2\*t.
1089	\(Ps = \1\*3 \(-> Report \fIxterm\fP window position as
1090	\(Cs\3\;\(Ix\;\(Iy\*t
1091	\(Ps = \1\*4 \(-> Report \fIxterm\fP window in pixels as
1092	\(Cs\s\4\s\;\s\fIheight\fP\s\;\s\fIwidth\fP\s\*t
1093	\(Ps = \1\*8 \(-> Report the size of the text area in characters as
1094	\(Cs\s\8\s\;\s\fIheight\fP\s\;\s\fIwidth\fP\s\*t
1095	\(Ps = \1\*9 \(-> Report the size of the screen in characters as
1096	\(Cs\s\9\s\;\s\fIheight\fP\s\;\s\fIwidth\fP\s\*t
1097	\(Ps = \2\*0 \(-> Report \fIxterm\fP window's icon label as
1098	\(Os\s\L\s\fIlabel\fP\s\(ST
1099	\(Ps = \2\*1 \(-> Report \fIxterm\fP window's title as
1100	\(Os\s\l\s\fItitle\fP\s\(ST
1101	\(Ps >= \2\4 \(-> Resize to \(Ps lines (DECSLPP)
1102	.
1103	.IP \\(Cs\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\;\\(Ps\\$\\t
1104	Reverse Attributes in Rectangular Area (DECRARA).
1105	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1106	\*(Ps denotes the attributes to reverse. 1, 4, 5, 7
1107	.
1108	.IP \\(Cs\\u
1109	Save cursor (ANSI.SYS)
1110	.
1111	.IP \\(Cs\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\;\\(Pp\\;\\(Pt\\;\\(Pl\\;\\(Pp\\$\\v
1112	Copy Rectangular Area (DECCRA)
1113	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1114	\*(Pp denotes the source page.
1115	\(Pt\;\*(Pl denotes the target location.
1116	\*(Pp denotes the target page.
1117	.
1118	.IP \\(Cs\\(Pt\\s\\;\\(Pl\\s\\;\\(Pb\\s\\;\\(Pr\\s\\(qu\\w
1119	Enable Filter Rectangle (DECEFR)
1120	.br
1121	Parameters are [top;left;bottom;right].
1122	.br
1123	Defines the coordinates of a filter rectangle and activates it.
1124	Anytime the locator is detected outside of the filter rectangle,
1125	an outside rectangle event is generated and the rectangle is disabled.
1126	Filter rectangles are always treated as "one-shot" events.
1127	Any parameters that are omitted default to the current locator position.
1128	If all parameters are omitted, any locator motion will be reported.
1129	DECELR always cancels any prevous rectangle definition.
1130	.
1131	.IP \\(Cs\\(Ps\\s\\x
1132	Request Terminal Parameters (DECREQTPARM)
1133	.br
1134	if \*(Ps is a "0" (default) or "1", and \fBxterm\fR is emulating VT100,
1135	the control sequence elicits a response of the same form
1136	whose parameters describe the terminal:
1137	\(Ps \(-> the given \(Ps incremented by 2.
1138	\*1 \(-> no parity
1139	\*1 \(-> eight bits
1140	\1 \2 \*8 \(-> transmit 38.4k baud
1141	\1 \2 \*8 \(-> receive 38.4k baud
1142	\*1 \(-> clock multiplier
1143	\*0 \(-> STP flags
1144	.
1145	.IP \\(Cs\\(Ps\\s\\x
1146	Select Attribute Change Extent (DECSACE).
1147	\(Ps = \0 \(-> from start to end position, wrapped
1148	\(Ps = \1 \(-> from start to end position, wrapped
1149	\(Ps = \2 \(-> rectangle (exact).
1150	.
1151	.IP \\(Cs\\(Pc\\;\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\$\\x
1152	Fill Rectangular Area (DECFRA).
1153	\*(Pc is the character to use.
1154	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1155	.
1156	.IP \\(Cs\\(Ps\\s\\;\\(Pu\\s\\(qu\\z
1157	Enable Locator Reporting (DECELR)
1158	.br
1159	Valid values for the first parameter:
1160	\(Ps = \0 \(-> Locator disabled (default)
1161	\(Ps = \1 \(-> Locator enabled
1162	\(Ps = \2 \(-> Locator enabled for one report, then disabled
1163	.br
1164	The second parameter specifies the coordinate unit for locator reports.
1165	.br
1166	Valid values for the second parameter:
1167	\(Pu = \0 or omitted \(-> default to character cells
1168	\(Pu = \1 \(-> device physical pixels
1169	\(Pu = \2 \(-> character cells
1170	.
1171	.IP \\(Cs\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\$\\z
1172	Erase Rectangular Area (DECERA).
1173	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1174	.
1175	.IP \\(Cs\\(Pm\\s\\(qu\\*{
1176	Select Locator Events (DECSLE)
1177	.br
1178	Valid values for the first (and any additional parameters) are:
1179	\(Ps = \0 \(-> only respond to explicit host requests (DECRQLP)
1180	(default) also cancels any filter rectangle
1181	\(Ps = \1 \(-> report button down transitions
1182	\(Ps = \2 \(-> do not report button down transitions
1183	\(Ps = \3 \(-> report button up transitions
1184	\(Ps = \4 \(-> do not report button up transitions
1185	.
1186	.IP \\(Cs\\(Pt\\;\\(Pl\\;\\(Pb\\;\\(Pr\\$\\{
1187	Selective Erase Rectangular Area (DECSERA).
1188	\(Pt\;\(Pl\;\(Pb\;\*(Pr denotes the rectangle.
1189	.
1190	.IP \\(Cs\\(Ps\\s\\(qu\\*\|
1191	Request Locator Position (DECRQLP)
1192	.br
1193	Valid values for the parameter are:
1194	\(Ps = \0, 1 or omitted \(-> transmit a single DECLRP locator report
1195	.sp
1196	If Locator Reporting has been enabled by a DECELR, xterm will respond
1197	with a DECLRP Locator Report. This report is also generated on button
1198	up and down events if they have been enabled with a DECSLE, or when
1199	the locator is detected outside of a filter rectangle, if filter rectangles
1200	have been enabled with a DECEFR.
1201	.sp
1202	\(-> \(Cs\(Pe\s\;\(Pb\s\;\(Pr\s\;\(Pc\s\;\(Pp\s\&\s\w
1203	.sp
1204	Parameters are [event;button;row;column;page].
1205	.br
1206	Valid values for the event:
1207	\(Pe = \0 \(-> locator unavailable - no other parameters sent
1208	\(Pe = \1 \(-> request - xterm received a DECRQLP
1209	\(Pe = \2 \(-> left button down
1210	\(Pe = \3 \(-> left button up
1211	\(Pe = \4 \(-> middle button down
1212	\(Pe = \5 \(-> middle button up
1213	\(Pe = \6 \(-> right button down
1214	\(Pe = \7 \(-> right button up
1215	\(Pe = \8 \(-> M4 button down
1216	\(Pe = \9 \(-> M4 button up
1217	\(Pe = \1\*0 \(-> locator outside filter rectangle
1218	.br
1219	``button'' parameter is a bitmask indicating which buttons are pressed:
1220	\(Pb = \0 \(-> no buttons down
1221	\(Pb & \1 \(-> right button down
1222	\(Pb & \2 \(-> middle button down
1223	\(Pb & \4 \(-> left button down
1224	\(Pb & \8 \(-> M4 button down
1225	.br
1226	``row'' and ``column'' parameters are the coordinates of the locator
1227	position in the xterm window, encoded as ASCII decimal.
1228	.br
1229	The ``page'' parameter is not used by xterm, and will be omitted.
1230	.
1231	.Ed
1232	.
1233	.St
1234	.LP
1235	.B
1236	Operating System Controls
1237	.
1238	.IP \\(Os\\(Ps\\s\\;\\(Pt\\s\\*(ST
1239	.IP \\(Os\\(Ps\\s\\;\\(Pt\\s\\*(Be
1240	Set Text Parameters.
1241	For colors and font,
1242	if \*(Pt is a "?", the control sequence elicits a response which consists
1243	of the control sequence which would set the corresponding value.
1244	The \fIdtterm\fP control sequences allow you to determine the icon name
1245	and window title.
1246	\(Ps = \0 \(-> Change Icon Name and Window Title to \*(Pt
1247	\(Ps = \1 \(-> Change Icon Name to \*(Pt
1248	\(Ps = \2 \(-> Change Window Title to \*(Pt
1249	\(Ps = \3 \(-> Set X property on top-level window. \*(Pt should be in the form
1250	"\fIprop=value\fP", or just "\fIprop\fP" to delete the property
1251	\(Ps = \4 ; \fIc ; spec\fP \(-> Change Color Number \fIc\fP to
1252	the color specified by \fIspec\fP,
1253	i.e., a name or RGB specification as per \fIXParseColor\fP.
1254	Any number of \fIc name\fP pairs may be given.
1255	The color numbers correspond to the ANSI colors 0-7,
1256	their bright versions 8-15,
1257	and if supported, the remainder of the 88-color or 256-color table.
1258	.sp
1259	If a "?" is given rather than a name or RGB specification,
1260	xterm replies with a control sequence of the same form which can be used
1261	to set the corresponding color.
1262	Because more than one pair of color number and specification can
1263	be given in one control sequence, \fBxterm\fR can make more than one reply.
1264	.sp
1265	The 8 colors which may be set using \1\0 through \1\7 are
1266	denoted \fIdynamic colors\fR, since the corresponding control sequences
1267	were the first means for setting \fBxterm\fR's colors dynamically,
1268	i.e., after it was started.
1269	They are not the same as the ANSI colors.
1270	One or more parameters is expected for \*(Pt.
1271	Each successive parameter changes the next color in the list.
1272	The value of \*(Ps tells the starting point in the list.
1273	The colors are specified by name or RGB specification as per \fIXParseColor\fP.
1274	.sp
1275	If a "?" is given rather than a name or RGB specification,
1276	xterm replies with a control sequence of the same form which can be used
1277	to set the corresponding dynamic color.
1278	Because more than one pair of color number and specification can
1279	be given in one control sequence, \fBxterm\fR can make more than one reply.
1280	.sp
1281	\(Ps = \1\0 \(-> Change VT100 text foreground color to \(Pt
1282	\(Ps = \1\1 \(-> Change VT100 text background color to \(Pt
1283	\(Ps = \1\2 \(-> Change text cursor color to \(Pt
1284	\(Ps = \1\3 \(-> Change mouse foreground color to \(Pt
1285	\(Ps = \1\4 \(-> Change mouse background color to \(Pt
1286	\(Ps = \1\5 \(-> Change Tektronix foreground color to \(Pt
1287	\(Ps = \1\6 \(-> Change Tektronix background color to \(Pt
1288	\(Ps = \1\7 \(-> Change highlight color to \(Pt
1289	\(Ps = \1\8 \(-> Change Tektronix cursor color to \(Pt
1290	.sp
1291	\(Ps = \4\6 \(-> Change Log File to \(Pt (normally disabled by a
1292	compile-time option)
1293	.sp
1294	\(Ps = \5\0 \(-> Set Font to \(Pt
1295	If \*(Pt begins with a "#", index in the font menu, relative (if the
1296	next character is a plus or minus sign) or absolute. A number is
1297	expected but not required after the sign (the default is the current
1298	entry for relative, zero for absolute indexing).
1299	.sp
1300	\(Ps = \5\*1 (reserved for Emacs shell)
1301	.sp
1302	\(Ps = \5\*2 \(-> Manipulate Selection Data.
1303	These controls may be disabled using the \fIallowWindowOps\fP resource.
1304	The parameter \*(Pt is parsed as
1305	.br
1306	\(Pc\;\*(Pd
1307	.br
1308	The first, \*(Pc, may contain any character from the
1309	set \c \p \(cs \0 \1 \2 \3 \4 \5 \6 \*7.
1310	It is used to construct a list of selection parameters for
1311	clipboard,
1312	primary,
1313	select,
1314	or cut buffers 0 through 8 respectively,
1315	in the order given.
1316	If the parameter is empty, \fIxterm\fP uses \(cs\0,
1317	to specify the configurable primary/clipboard selection and cut buffer 0.
1318	.br
1319	The second parameter, \*(Pd, gives the selection data.
1320	Normally this is a string encoded in base64.
1321	The data becomes the new selection,
1322	which is then available for pasting by other applications.
1323	.br
1324	If the second parameter is a \*?,
1325	\fIxterm\fP replies to the host with the selection
1326	data encoded using the same protocol.
1327	.Ed
1328	.
1329	.St
1330	.LP
1331	.B
1332	Privacy Message
1333	.IP \\(PM\\(Pt\\s\\(ST
1334	\fIxterm\fP implements no \(PM functions; \(Pt is ignored.
1335	\*(Pt need not be printable characters.
1336	.Ed
1337	.
1338	.SH
1339	Alt and Meta Keys
1340	.LP
1341	Many keyboards have keys labeled "Alt".
1342	Few have keys labeled "Meta".
1343	However, \fIxterm\fP's default translations use the \fIMeta\fP modifier.
1344	Common keyboard configurations assign the \fIMeta\fP modifier to an "Alt" key.
1345	By using \fIxmodmap\fP one may have the modifier assigned to a different key,
1346	and have "real" alt and meta keys.
1347	Here is an example:
1348	.DS B
1349	! put meta on mod3 to distinguish it from alt
1350	keycode 64 = Alt_L
1351	clear mod1
1352	add mod1 = Alt_L
1353	keycode 115 = Meta_L
1354	clear mod3
1355	add mod3 = Meta_L
1356	.DE
1357	.LP
1358	The \fBmetaSendsEscape\fP resource
1359	(and \fBaltSendsEscape\fP if \fBaltIsNotMeta\fP is set)
1360	can be used to control the way the \fIMeta\fP modifier applies to ordinary
1361	keys unless the \fBmodifyOtherKeys\fP resource is set:
1362	.IP
1363	-
1364	prefix a key with the \*(Es character.
1365	.IP
1366	-
1367	shift the key from codes 0-127 to 128-255 by adding 128.
1368	.LP
1369	The table shows the result for a given character "x" with modifiers
1370	according to the default translations with the resources set on or off.
1371	This assumes \fBaltIsNotMeta\fP is set:
1372	.TS
1373	center;
1374	lf3 lf3 lf3 lf3
1375	lf3w(2c) lf3w(2c) lf3w(2c) lf3w(2c) .
1376	_
1377	key altSendsEscape metaSendsEscape result
1378	_
1379	x off off x
1380	Meta-x off off shift
1381	Alt-x off off shift
1382	Alt+Meta-x off off shift
1383	x ON off x
1384	Meta-x ON off shift
1385	Alt-x ON off \*(Es x
1386	Alt+Meta-x ON off \*(Es shift
1387	x off ON x
1388	Meta-x off ON \*(Es x
1389	Alt-x off ON shift
1390	Alt+Meta-x off ON \*(Es shift
1391	x ON ON x
1392	Meta-x ON ON \*(Es x
1393	Alt-x ON ON \*(Es x
1394	Alt+Meta-x ON ON \*(Es x
1395	_
1396	.TE
1397	.SH
1398	PC-Style Function Keys
1399	.ds RH Function Keys
1400	.LP
1401	If \fIxterm\fP does minimal translation of the function keys, it usually does this
1402	with a PC-style keyboard, so PC-style function keys result.
1403	Sun keyboards are similar to PC keyboards.
1404	Both have cursor and scrolling operations printed on the keypad,
1405	which duplicate the smaller cursor and scrolling keypads.
1406	.LP
1407	X does not predefine NumLock (used for VT220 keyboards) or Alt (used as
1408	an extension for the Sun/PC keyboards) as modifiers.
1409	These keys are recognized as modifiers when enabled
1410	by the \fBnumLock\fP resource,
1411	or by the DECSET \1\0\3\5 control sequence.
1412	.LP
1413	The cursor keys transmit the following escape sequences depending on the
1414	mode specified via the \fBDECCKM\fP escape sequence.
1415	.TS
1416	center;
1417	cf3 cf3 cf3
1418	lf3w(2c) lf3w(2c) lf3w(2c) .
1419	Key Normal Application
1420	_
1421	Cursor Up \(Cs\A \(S3\A
1422	Cursor Down \(Cs\(cB \(S3\(cB
1423	Cursor Right \(Cs\C \(S3\C
1424	Cursor Left \(Cs\D \(S3\D
1425	_
1426	.TE
1427	The home- and end-keys
1428	(unlike PageUp and other keys also on the 6-key editing keypad)
1429	are considered "cursor keys" by \fIxterm\fP.
1430	Their mode is also controlled by the \fBDECCKM\fP escape sequence:
1431	.TS
1432	center;
1433	cf3 cf3 cf3
1434	lf3w(2c) lf3w(2c) lf3w(2c) .
1435	Key Normal Application
1436	_
1437	Home \(Cs\H \(S3\H
1438	End \(Cs\F \(S3\F
1439	_
1440	.TE
1441	.LP
1442	The application keypad transmits the following escape sequences depending on the
1443	mode specified via the \fBDECPNM\fP and \fBDECPAM\fP escape sequences.
1444	Use the NumLock key to override the application mode.
1445	.LP
1446	Not all keys are present on the Sun/PC keypad (e.g., PF1, Tab), but are supported by
1447	the program.
1448	.TS
1449	center;
1450	cf3 cf3 cf3 cf3 cf3
1451	lf3w(2c) lf3w(2c) lf3w(2c) lf3w(2c) lf3w(2c) .
1452	Key Numeric Application Terminfo Termcap
1453	_
1454	Space \(Sp \(S3\*(Sp - -
1455	Tab \(Ta \(S3\*I - -
1456	Enter \(Cr \(S3\*M kent @8
1457	PF1 \(S3\P \(S3\P kf1 k1
1458	PF2 \(S3\Q \(S3\Q kf2 k2
1459	PF3 \(S3\R \(S3\R kf3 k3
1460	PF4 \(S3\S \(S3\S kf4 k4
1461	* \f1(multiply)\fP \** \(S3\j - -
1462	+ \f1(add)\fP \+ \(S3\*k - -
1463	, \f1(comma)\fP \, \(S3\*l - -
1464	- \f1(minus)\fP \- \(S3\*m - -
1465	\&. \f1(Delete)\fP \. \(Cs\3\(c~ - -
1466	/ \f1(divide)\fP \/ \(S3\*o - -
1467	0 \f1(Insert)\fP \0 \(Cs\2\(c~ - -
1468	1 \f1(End)\fP \1 \(S3\*F kc1 K4
1469	2 \f1(DownArrow)\fP \2 \(Cs\*(cB - -
1470	3 \f1(PageDown)\fP \3 \(Cs\6\(c~ kc3 K5
1471	4 \f1(LeftArrow)\fP \4 \(Cs\*D - -
1472	5 \f1(Begin)\fP \5 \(Cs\*E kb2 K2
1473	6 \f1(RightArrow)\fP \6 \(Cs\*C - -
1474	7 \f1(Home)\fP \7 \(S3\*H ka1 K1
1475	8 \f1(UpArrow)\fP \8 \(Cs\*A - -
1476	9 \f1(PageUp)\fP \9 \(Cs\5\(c~ ka3 K3
1477	= (equal) \= \(S3\*(XX - -
1478	_
1479	.TE
1480	They also provide 12 function keys, as well as a few other special-purpose keys.
1481	.TS
1482	center;
1483	cf3 cf3
1484	lf3w(2c) lf3w(2c) .
1485	Key Escape Sequence
1486	_
1487	F1 \(S3\P
1488	F2 \(S3\Q
1489	F3 \(S3\R
1490	F4 \(S3\S
1491	F5 \(Cs\1\5\(c~
1492	F6 \(Cs\1\7\(c~
1493	F7 \(Cs\1\8\(c~
1494	F8 \(Cs\1\9\(c~
1495	F9 \(Cs\2\0\(c~
1496	F10 \(Cs\2\1\(c~
1497	F11 \(Cs\2\3\(c~
1498	F12 \(Cs\2\4\(c~
1499	_
1500	.TE
1501	.LP
1502	Older versions of \fIxterm\fP implement different escape sequences for F1 through F4.
1503	These can be activated by setting the \fBoldXtermFKeys\fP resource.
1504	However, since they do not correspond to any hardware terminal, they have been deprecated.
1505	(The DEC VT220 reserves F1 through F5 for local functions such as \fBSetup\fP).
1506	.TS
1507	center;
1508	cf3 cf3
1509	lf3w(2c) lf3w(2c) .
1510	Key Escape Sequence
1511	_
1512	F1 \(Cs\1\1\(c~
1513	F2 \(Cs\1\2\(c~
1514	F3 \(Cs\1\3\(c~
1515	F4 \(Cs\1\4\(c~
1516	_
1517	.TE
1518	In normal mode, i.e., a Sun/PC keyboard
1519	when the \fBsunKeyboard\fP resource is false,
1520	\fIxterm\fP recognizes function key modifiers
1521	which are parameters appended before the final character
1522	of the control sequence.
1523	.TS
1524	center;
1525	cf3 lf3
1526	cf3w(2c) lf3w(2c) .
1527	Code Modifiers
1528	_
1529	2 Shift
1530	3 Alt
1531	4 Shift + Alt
1532	5 Control
1533	6 Shift + Control
1534	7 Alt + Control
1535	8 Shift + Alt + Control
1536	_
1537	.TE
1538	For example, shift-F5 would be sent as
1539	\(Cs\1\5\;\2\(c~
1540	.LP
1541	If the \fBalwaysUseMods\fP resource is set, the Meta modifier also is
1542	recognized, making parameters 9 through 16.
1543	.SH
1544	VT220-Style Function Keys
1545	.LP
1546	However, \fIxterm\fP is most useful as a DEC VT102 or VT220 emulator.
1547	Set the \fBsunKeyboard\fP resource to true to force a Sun/PC keyboard
1548	to act like a VT220 keyboard.
1549
1550	The VT102/VT220 application keypad transmits unique escape sequences in
1551	application mode, which are distinct from the cursor and scrolling keypad:
1552	.TS
1553	center;
1554	cf3 cf3 cf3
1555	lf3w(2c) lf3w(2c) lf3w(2c) .
1556	Key Numeric Application
1557	_
1558	Space \(Sp \(S3\*(Sp
1559	Tab \(Ta \(S3\*I
1560	Enter \(Cr \(S3\*M
1561	PF1 \(S3\P \(S3\P
1562	PF2 \(S3\Q \(S3\Q
1563	PF3 \(S3\R \(S3\R
1564	PF4 \(S3\S \(S3\S
1565	* \f1(multiply)\fP \** \(S3\j
1566	+ \f1(add)\fP \+ \(S3\*k
1567	, \f1(comma)\fP \, \(S3\*l
1568	- \f1(minus)\fP \- \(S3\*m
1569	\&. \f1(period)\fP \. \(S3\*n
1570	/ \f1(divide)\fP \/ \(S3\*o
1571	0 \0 \(S3\*p
1572	1 \1 \(S3\*q
1573	2 \2 \(S3\*r
1574	3 \3 \(S3\*(cs
1575	4 \4 \(S3\*t
1576	5 \5 \(S3\*u
1577	6 \6 \(S3\*v
1578	7 \7 \(S3\*w
1579	8 \8 \(S3\*x
1580	9 \9 \(S3\*y
1581	= (equal) \= \(S3\*(XX
1582	_
1583	.TE
1584	The VT220 provides a 6-key editing keypad,
1585	which is analogous to that on the PC keyboard.
1586	It is not affected by \fBDECCKM\fP or \fBDECPNM\fP/\fBDECPAM\fP:
1587	.TS
1588	center;
1589	cf3 cf3 cf3
1590	lf3w(2c) lf3w(2c) lf3w(2c) .
1591	Key Normal Application
1592	_
1593	\f1Insert\fP \(Cs\2\(c~ \(Cs\2\(c~
1594	\f1Delete\fP \(Cs\3\(c~ \(Cs\3\(c~
1595	\f1Home\fP \(Cs\1\(c~ \(Cs\1\(c~
1596	\f1End\fP \(Cs\4\(c~ \(Cs\4\(c~
1597	\f1PageUp\fP \(Cs\5\(c~ \(Cs\5\(c~
1598	\f1PageDown\fP \(Cs\6\(c~ \(Cs\6\(c~
1599	_
1600	.TE
1601	.LP
1602	The VT220 provides 8 additional function keys.
1603	With a Sun/PC keyboard, access these keys by Control/F1 for F13, etc.
1604	.TS
1605	center;
1606	cf3 cf3
1607	lf3w(2c) lf3w(2c) .
1608	Key Escape Sequence
1609	_
1610	F13 \(Cs\2\5\(c~
1611	F14 \(Cs\2\6\(c~
1612	F15 \(Cs\2\8\(c~
1613	F16 \(Cs\2\9\(c~
1614	F17 \(Cs\3\1\(c~
1615	F18 \(Cs\3\2\(c~
1616	F19 \(Cs\3\3\(c~
1617	F20 \(Cs\3\4\(c~
1618	_
1619	.TE
1620	.SH
1621	VT52-Style Function Keys
1622	.LP
1623	A VT52 does not have function keys, but it does have a numeric keypad and cursor keys.
1624	They differ from the other emulations by the prefix.
1625	Also, the cursor keys do not change:
1626	.TS
1627	center;
1628	cf3 cf3
1629	lf3w(2c) lf3w(2c) .
1630	Key Normal/Application
1631	_
1632	Cursor Up \(Es\A
1633	Cursor Down \(Es\(cB
1634	Cursor Right \(Es\C
1635	Cursor Left \(Es\D
1636	_
1637	.TE
1638	The keypad is similar:
1639	.TS
1640	center;
1641	cf3 cf3 cf3
1642	lf3w(2c) lf3w(2c) lf3w(2c) .
1643	Key Numeric Application
1644	_
1645	Space \(Sp \(Es\?\(Sp
1646	Tab \(Ta \(Es\?\I
1647	Enter \(Cr \(Es\?\M
1648	PF1 \(Es\P \(Es\P
1649	PF2 \(Es\Q \(Es\Q
1650	PF3 \(Es\R \(Es\R
1651	PF4 \(Es\S \(Es\S
1652	* \f1(multiply)\fP \** \(Es\?\*j
1653	+ \f1(add)\fP \+ \(Es\?\k
1654	, \f1(comma)\fP \, \(Es\?\l
1655	- \f1(minus)\fP \- \(Es\?\m
1656	\&. \f1(period)\fP \. \(Es\?\n
1657	/ \f1(divide)\fP \/ \(Es\?\o
1658	0 \0 \(Es\?\p
1659	1 \1 \(Es\?\q
1660	2 \2 \(Es\?\r
1661	3 \3 \(Es\?\(cs
1662	4 \4 \(Es\?\t
1663	5 \5 \(Es\?\u
1664	6 \6 \(Es\?\v
1665	7 \7 \(Es\?\w
1666	8 \8 \(Es\?\x
1667	9 \9 \(Es\?\y
1668	= (equal) \= \(Es\?\(XX
1669	_
1670	.TE
1671	.SH
1672	Sun-Style Function Keys
1673	.LP
1674	The \fIxterm\fP program provides support for Sun keyboards more directly, by
1675	a menu toggle that causes it to send Sun-style function key codes rather than VT220.
1676	Note, however, that the \fIsun\fP and \fIVT100\fP emulations are not really
1677	compatible. For example, their wrap-margin behavior differs.
1678	.LP
1679	Only function keys are altered; keypad and cursor keys are the same.
1680	The emulation responds identically.
1681	See the xterm-sun terminfo entry for details.
1682	.SH
1683	HP-Style Function Keys
1684	.LP
1685	Similarly, \fIxterm\fP can be compiled to support HP keyboards.
1686	See the xterm-hp terminfo entry for details.
1687	.SH
1688	The Alternate Screen Buffer
1689	.LP
1690	\fBXterm\fP maintains two screen buffers.
1691	The normal screen buffer allows you to scroll back to view saved lines
1692	of output up to the maximum set by the \fBsaveLines\fP resource.
1693	The alternate screen buffer is exactly as large as the display,
1694	contains no additional saved lines.
1695	When the alternate screen buffer is active,
1696	you cannot scroll back to view saved lines.
1697	\fBXterm\fP provides control sequences and menu entries
1698	for switching between the two.
1699
1700	Most full-screen applications use terminfo or termcap to obtain
1701	strings used to start/stop full-screen mode,
1702	i.e., \fIsmcup\fP and \fIrmcup\fP for terminfo,
1703	or the corresponding \fIti\fP and \fIte\fP for termcap.
1704	The \fBtiteInhibit\fP resource removes the \fIti\fP and \fIte\fP strings
1705	from the TERMCAP string which is set in the environment for some platforms.
1706	That is not done when \fBxterm\fP is built with terminfo libraries because
1707	terminfo does not provide the whole text of the termcap data in one piece.
1708	It would not work for terminfo anyway, since terminfo data is not passed
1709	in environment variables;
1710	setting an environment variable in this manner would have no effect on
1711	the application's ability to switch between normal and alternate screen
1712	buffers.
1713	Instead, the newer private mode controls
1714	(such as \1\0\4\9)
1715	for switching between normal
1716	and alternate screen buffers simply disable the switching.
1717	They add other features such as clearing the display for the same reason:
1718	to make the details of switching independent of the application that
1719	requests the switch.
1720	.SH
1721	Bracketed Paste Mode
1722	.ds RH Bracketed Paste Mode
1723	.LP
1724	When bracketed paste mode is set,
1725	pasted text is bracketed with control sequences
1726	so that the program can differentiate pasted text from typed-in text.
1727	When bracketed paste mode is set,
1728	the program will receive: ESC [ 200 ~,
1729	followed by the pasted text, followed by ESC [ 201 ~.
1730	.SH
1731	Mouse Tracking
1732	.ds RH Mouse Tracking
1733	.LP
1734	The VT widget can be set to send the mouse position and other
1735	information on button presses. These modes are typically used by
1736	editors and other full-screen applications that want to make use of
1737	the mouse.
1738
1739	There are six mutually exclusive modes.
1740	One is DEC Locator mode, enabled by the
1741	DECELR \(Cs\(Ps\s\;\(Ps\s\s\(qu\s\z
1742	control sequence, and is not described here
1743	(control sequences are summarized above).
1744	The remaining five
1745	modes are each enabled (or disabled) by a different parameter in
1746	DECSET \(Cs\?\(Pm\s\*h
1747	or
1748	DECRST \(Cs\?\(Pm\s\*l
1749	control sequence.
1750
1751	Manifest constants for the parameter values
1752	are defined in \fBxcharmouse.h\fP as follows:
1753	.
1754	.DS B
1755	#define SET_X10_MOUSE 9
1756	#define SET_VT200_MOUSE 1000
1757	#define SET_VT200_HIGHLIGHT_MOUSE 1001
1758	#define SET_BTN_EVENT_MOUSE 1002
1759	#define SET_ANY_EVENT_MOUSE 1003
1760
1761	#define SET_FOCUS_EVENT_MOUSE 1004
1762	.DE
1763	.LP
1764	The motion reporting modes are strictly \fIxterm\fP extensions, and are not
1765	part of any standard, though they are analogous to the DEC VT200 DECELR
1766	locator reports.
1767
1768	Parameters (such as pointer position and button number) for all mouse
1769	tracking escape sequences generated by \fIxterm\fP
1770	encode numeric parameters in a single character as
1771	\fIvalue\fP+32.
1772	For example, \*! specifies the value 1.
1773	The upper left character position on the terminal is denoted as 1,1.
1774
1775	X10 compatibility mode sends an escape sequence only on button press,
1776	encoding the location and the mouse button pressed.
1777	It is enabled by specifying parameter 9 to DECSET.
1778	On button press, \fIxterm\fP sends
1779	\(Cs\M\(Cb\(Cx\*(Cy (6 characters).
1780	\*(Cb is button\-1.
1781	\(Cx and \(Cy are the x and y coordinates of the mouse when the
1782	button was pressed.
1783
1784	Normal tracking mode sends an escape sequence on both button press and
1785	release. Modifier key (shift, ctrl, meta) information is also sent.
1786	It is enabled by specifying parameter 1000 to DECSET.
1787	On button press or release, \fIxterm\fP sends
1788	\(Cs\M\(Cb\(Cx\*(Cy.
1789	The low two bits of \*(Cb encode button information:
1790	0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release.
1791	The next three bits encode the modifiers which were down when the button was
1792	pressed and are added together: 4=Shift, 8=Meta, 16=Control.
1793	Note however that the shift and control bits are normally unavailable
1794	because \fIxterm\fP uses the control modifier with mouse for popup menus,
1795	and the shift modifier is used in the default translations for button events.
1796	The \fIMeta\fP modifier recognized by \fIxterm\fP is the \fImod1\fP mask,
1797	and is not necessarily the "Meta" key (see \fIxmodmap\fP).
1798	\(Cx and \(Cy are the x and y coordinates of the mouse event, encoded as
1799	in X10 mode.
1800
1801	Wheel mice may return buttons 4 and 5.
1802	Those buttons are represented by the same event codes
1803	as buttons 1 and 2 respectively,
1804	except that 64 is added to the event code.
1805	Release events for the wheel buttons are not reported.
1806
1807	Mouse highlight tracking notifies a program of a button press, receives a
1808	range of lines from the program, highlights the region covered by
1809	the mouse within that range until button release, and then sends the
1810	program the release coordinates.
1811	It is enabled by specifying parameter 1001 to DECSET.
1812	Highlighting is performed only for button 1, though other button events
1813	can be received.
1814	\fBWarning:\fP use of this mode requires a cooperating program or it will
1815	hang \fIxterm.\fP
1816	On button press, the same information as for normal tracking is
1817	generated; \fIxterm\fP then waits for the program to send mouse
1818	tracking information.
1819	\fIAll X events are ignored until the proper escape sequence is
1820	received from the pty:\fP
1821	\(Cs\(Ps\s\;\(Ps\s\;\(Ps\s\;\(Ps\s\;\(Ps\s\T.
1822	The parameters are \fIfunc, startx, starty, firstrow,\fP and \fIlastrow.\fP
1823	\fIfunc\fP is non-zero to initiate highlight tracking and zero to abort.
1824	\fIstartx\fP and \fIstarty\fP give the starting x and y location for
1825	the highlighted region. The ending location tracks the mouse, but
1826	will never be above row \fIfirstrow\fP and will always be above row
1827	\fIlastrow.\fP (The top of the screen is row 1.)
1828	When the button is released, \fIxterm\fP reports the ending position
1829	one of two ways: if the start and end coordinates are valid text
1830	locations: \(Cs\t\(Cx\(Cy. If either coordinate is past
1831	the end of the line:
1832	\(Cs\T\(Cx\(Cy\(Cx\(Cy\(Cx\(Cy.
1833	The parameters are \fIstartx, starty, endx, endy, mousex,\fP and \fImousey.\fP
1834	\fIstartx, starty, endx, \fPand\fI endy\fP give the starting and
1835	ending character positions of the region. \fImousex\fP and \fImousey\fP
1836	give the location of the mouse at button up, which may not be over a
1837	character.
1838
1839	Button-event tracking is essentially the same as normal tracking, but
1840	\fIxterm\fP also reports button-motion events. Motion events
1841	are reported only if the mouse pointer has moved to a different character
1842	cell. It is enabled by specifying parameter 1002 to DECSET.
1843	On button press or release, \fIxterm\fP sends the same codes used by normal
1844	tracking mode. On button-motion events, \fIxterm\fP adds 32 to the event code
1845	(the third character, \*(Cb).
1846	The other bits of the event code specify button and modifier keys as in normal mode.
1847	For example, motion into cell x,y with button 1
1848	down is reported as \(Cs\M\@\(Cx\*(Cy.
1849	( \*@ = 32 + 0 (button 1) + 32 (motion indicator) ).
1850	Similarly, motion with button 3
1851	down is reported as \(Cs\M\(cB\(Cx\*(Cy.
1852	( \*(cB = 32 + 2 (button 3) + 32 (motion indicator) ).
1853
1854	Any-event mode is the same as button-event mode, except that all motion
1855	events are reported, even if no mouse button is down.
1856	It is enabled by specifying 1003 to DECSET.
1857
1858	FocusIn/FocusOut can be combined with any of the mouse events since
1859	it uses a different protocol.
1860	When set, it causes \fIxterm\fP to send
1861	\(Cs\I when the terminal gains focus, and
1862	\(Cs\O when it loses focus.
1863	.
1864	.br
1865	.ds RH Tektronix 4014 Mode
1866	.SH
1867	Tektronix 4014 Mode
1868	.LP
1869	Most of these sequences are standard Tektronix 4014 control sequences.
1870	Graph mode supports the 12-bit addressing of the Tektronix 4014.
1871	The major features missing are
1872	the write-through and defocused modes.
1873	This document does not describe the commands used in the various
1874	Tektronix plotting modes but does describe the commands to switch modes.
1875	.St
1876	.IP \\*(Be
1877	Bell (Ctrl-G)
1878	.IP \\*(Bs
1879	Backspace (Ctrl-H)
1880	.IP \\*(Ta
1881	Horizontal Tab (Ctrl-I)
1882	.IP \\*(Lf
1883	Line Feed or New Line (Ctrl-J)
1884	.IP \\*(Vt
1885	Cursor up (Ctrl-K)
1886	.IP \\*(Ff
1887	Form Feed or New Page (Ctrl-L)
1888	.IP \\*(Cr
1889	Carriage Return (Ctrl-M)
1890	.IP \\(Es\\(Et
1891	Switch to VT100 Mode (ESC Ctrl-C)
1892	.IP \\(Es\\(En
1893	Return Terminal Status (ESC Ctrl-E)
1894	.IP \\(Es\\(Ff
1895	PAGE (Clear Screen) (ESC Ctrl-L)
1896	.IP \\(Es\\(So
1897	Begin 4015 APL mode (ignored by \fIxterm\fP) (ESC Ctrl-N)
1898	.IP \\(Es\\(Si
1899	End 4015 APL mode (ignored by \fIxterm\fP) (ESC Ctrl-O)
1900	.IP \\(Es\\(Eb
1901	COPY (Save Tektronix Codes to file COPYyyyy-mm-dd.hh:mm:ss) (ESC Ctrl-W)
1902	.IP \\(Es\\(Ca
1903	Bypass Condition (ESC Ctrl-X)
1904	.IP \\(Es\\(Su
1905	GIN mode (ESC Ctrl-Z)
1906	.IP \\(Es\\(Fs
1907	Special Point Plot Mode (ESC Ctrl-\e)
1908	.IP \\(Es\\8
1909	Select Large Character Set
1910	.IP \\(Es\\9
1911	Select #2 Character Set
1912	.IP \\(Es\\:
1913	Select #3 Character Set
1914	.IP \\(Es\\;
1915	Select Small Character Set
1916	.IP \\(Os\\(Ps\\s\\;\\(Pt\\s\\*(Be
1917	Set Text Parameters of VT window
1918	\(Ps = \0 \(-> Change Icon Name and Window Title to \*(Pt
1919	\(Ps = \1 \(-> Change Icon Name to \*(Pt
1920	\(Ps = \2 \(-> Change Window Title to \*(Pt
1921	\(Ps = \4\6 \(-> Change Log File to \(Pt (normally disabled by a
1922	compile-time option)
1923	.IP \\(Es\\`
1924	Normal Z Axis and Normal (solid) Vectors
1925	.IP \\(Es\\a
1926	Normal Z Axis and Dotted Line Vectors
1927	.IP \\(Es\\b
1928	Normal Z Axis and Dot-Dashed Vectors
1929	.IP \\(Es\\c
1930	Normal Z Axis and Short-Dashed Vectors
1931	.IP \\(Es\\d
1932	Normal Z Axis and Long-Dashed Vectors
1933	.IP \\(Es\\h
1934	Defocused Z Axis and Normal (solid) Vectors
1935	.IP \\(Es\\i
1936	Defocused Z Axis and Dotted Line Vectors
1937	.IP \\(Es\\j
1938	Defocused Z Axis and Dot-Dashed Vectors
1939	.IP \\(Es\\k
1940	Defocused Z Axis and Short-Dashed Vectors
1941	.IP \\(Es\\l
1942	Defocused Z Axis and Long-Dashed Vectors
1943	.IP \\(Es\\p
1944	Write-Thru Mode and Normal (solid) Vectors
1945	.IP \\(Es\\q
1946	Write-Thru Mode and Dotted Line Vectors
1947	.IP \\(Es\\r
1948	Write-Thru Mode and Dot-Dashed Vectors
1949	.IP \\(Es\\(cs
1950	Write-Thru Mode and Short-Dashed Vectors
1951	.IP \\(Es\\t
1952	Write-Thru Mode and Long-Dashed Vectors
1953	.IP \\*(Fs
1954	Point Plot Mode (Ctrl-\e)
1955	.IP \\*(Gs
1956	Graph Mode (Ctrl-])
1957	.IP \\*(Rs
1958	Incremental Plot Mode (Ctrl-^)
1959	.IP \\*(Us
1960	Alpha Mode (Ctrl-_)
1961	.Ed
1962	.
1963	.
1964	.br
1965	.ds RH VT52 Mode
1966	.SH
1967	VT52 Mode
1968	.LP
1969	Parameters for cursor movement are at the end of the \(Es\Y escape sequence.
1970	Each ordinate is encoded in a single character as \fIvalue\fP+32.
1971	For example, \*! is 1.
1972	The screen coordinate system is 0-based.
1973	.St
1974	.IP \\(Es\\A
1975	Cursor up.
1976	.IP \\(Es\\(cB
1977	Cursor down.
1978	.IP \\(Es\\C
1979	Cursor right.
1980	.IP \\(Es\\D
1981	Cursor left.
1982	.IP \\(Es\\F
1983	Enter graphics mode.
1984	.IP \\(Es\\G
1985	Exit graphics mode.
1986	.IP \\(Es\\H
1987	Move the cursor to the home position.
1988	.IP \\(Es\\I
1989	Reverse line feed.
1990	.IP \\(Es\\J
1991	Erase from the cursor to the end of the screen.
1992	.IP \\(Es\\K
1993	Erase from the cursor to the end of the line.
1994	.IP \\(Es\\Y\\(Ps\\s\\*(Ps
1995	Move the cursor to given row and column.
1996	.IP \\(Es\\Z
1997	Identify
1998	\(-> \(Es\s\/\s\*Z (``I am a VT52.'')
1999	.IP \\(Es\\=
2000	Enter alternate keypad mode.
2001	.IP \\(Es\\>
2002	Exit alternate keypad mode.
2003	.IP \\(Es\\<
2004	Exit VT52 mode (Enter VT100 mode).
2005	.Ed
2006	.
2007	.if n .pl \n(nlu+1v

Note: See TracBrowser for help on using the browser.

Context Navigation

root/foundation-apps/mxterm-maxx/ctlseqs.ms

Download in other formats: