← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kdebase/utopic

« back to all changes in this revision

Viewing changes to konsole/doc/developer/old-documents/More/rxvt-ref.html

  • Committer: Bazaar Package Importer
  • Author(s): Debian Qt/KDE Maintainers, José Manuel Santamaría Lema, Modestas Vainius
  • Date: 2011-05-26 02:53:50 UTC
  • mfrom: (0.7.7 upstream) (0.4.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 296.
  • Revision ID: james.westby@ubuntu.com-20110526025350-7o10g65yegec2rnq
Tags: 4:4.6.3-1
* New upstream release.

[ José Manuel Santamaría Lema ]
* Bump kde-sc-dev-latest build dependency to 4:4.6.3.
* Bump Standards-Version to 3.9.2; no changes needed.

[ Modestas Vainius ]
* Enable DLRestrictions for libraries in this package. Requires
  libdlrestrictions-dev 0.14 and kdelibs5-dev 4:4.6.3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
konsole/doc/developer/old-documents/More/rxvt-ref.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
 
2
<!--
 
3
don't use Netscape to edit this file, since it has some stange ideas of
 
4
formatting that makes later global/change/replace difficult,
 
5
but it is okay for making the text version of this document
 
6
-->
 
7
<HTML>
 
8
<HEAD>
 
9
<TITLE>
 
10
Rxvt Technical Reference
 
11
</TITLE>
 
12
  <META NAME="Author" CONTENT="mj olesen <olesen@me.queensu.ca>">
 
13
  <META NAME="Description" CONTENT="Documentation of VT, XTerm, and other escape sequences used by rxvt.">
 
14
</HEAD>
 
15
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#0000FF" ALINK="#FF0000">
 
16
<HR>
 
17
<CENTER>
 
18
<H1><A NAME="Top">Rxvt Technical Reference</A></H1>
 
19
Reworked from XTerm documentation and other sources<BR>
 
20
<P>
 
21
<A TARGET="_top" HREF="refer.html">[No]</A>
 
22
<A TARGET="_top" HREF="refer-frame.html">Frames</A>
 
23
<HR>
 
24
</CENTER>
 
25
<UL>
 
26
<LI><A HREF="#Definitions">Definitions</A></LI>
 
27
<LI><A HREF="#Values">Values</A></LI>
 
28
<LI><A HREF="#Sequences">Escape Sequences</A></LI>
 
29
<LI><A HREF="#CSI">CSI (Code Sequence Introducer) Sequences</A></LI>
 
30
<LI><A HREF="#PrivateModes">DEC Private Modes</A></LI>
 
31
<LI><A HREF="#XTerm">XTerm Escape Sequences</A></LI>
 
32
<LI><A HREF="#menuBar">menuBar</A></LI>
 
33
<LI><A HREF="#XPM">XPM</A></LI>
 
34
<LI><A HREF="#Mouse">Mouse Reporting</A></LI>
 
35
<LI><A HREF="#Graphics">Special Graphics Mode</A></LI>
 
36
<LI><A HREF="#KeyCodes">Key Codes</A></LI>
 
37
</UL>
 
38
 
 
39
<HR>
 
40
<H2><A HREF="#toc" NAME="Definitions">Definitions</A></H2>
 
41
<P>
 
42
 
 
43
<DL><DT><B><TT>c</TT></B></DT><DD>The literal character c.</DD></DL>
 
44
<P>
 
45
 
 
46
<DL><DT><B><TT>C</TT></B></DT><DD>A single (required) character.</DD></DL>
 
47
<P>
 
48
 
 
49
<DL>
 
50
<DT><B><TT>Ps</TT></B></DT>
 
51
<DD>A single (usually optional) numeric parameter,
 
52
composed of one or more digits.</DD>
 
53
</DL>
 
54
<P>
 
55
 
 
56
<DL>
 
57
<DT><B><TT>Pm</TT></B></DT>
 
58
<DD>A multiple numeric parameter composed of any number of single numeric
 
59
parameters, separated by ; character(s).</DD>
 
60
</DL>
 
61
<P>
 
62
 
 
63
<DL>
 
64
<DT><B><TT>Pt</TT></B></DT>
 
65
<DD>A text parameter composed of printable characters.</DD>
 
66
</DL>
 
67
<P>
 
68
 
 
69
<HR>
 
70
<H2><A HREF="#toc" NAME="Values">Values</A></H2>
 
71
<P>
 
72
 
 
73
<DL>
 
74
<DT><B><TT>ENQ</TT></B></DT>
 
75
<DD>Enquiry (Ctrl-E) = Send Device Attributes (DA)<BR>
 
76
request attributes from terminal
 
77
== <A HREF="#ESC[Psc"><B><TT>ESC[c</TT></B></A>
 
78
</DD>
 
79
</DL>
 
80
<P>
 
81
 
 
82
<DL><DT><B><TT>BEL</TT></B></DT><DD>Bell (Ctrl-G)</DD></DL>
 
83
<P>
 
84
 
 
85
<DL><DT><B><TT>BS</TT></B></DT><DD>Backspace (Ctrl-H)</DD></DL>
 
86
<P>
 
87
 
 
88
<DL><DT><B><TT>TAB</TT></B></DT><DD>Horizontal Tab (HT) (Ctrl-I)</DD></DL>
 
89
<P>
 
90
 
 
91
<DL><DT><B><TT>LF</TT></B></DT><DD>Line Feed or New Line (NL) (Ctrl-J)</DD></DL>
 
92
<P>
 
93
 
 
94
<DL>
 
95
<DT><B><TT>VT</TT></B></DT>
 
96
<DD>Vertical Tab (Ctrl-K) same as <B><TT>LF</TT></B></DD>
 
97
</DL>
 
98
<P>
 
99
 
 
100
<DL>
 
101
<DT><B><TT>FF</TT></B></DT>
 
102
<DD>Form Feed or New Page (NP) (Ctrl-L) same as <B><TT>LF</TT></B></DD>
 
103
</DL>
 
104
<P>
 
105
 
 
106
<DL><DT><B><TT>CR</TT></B></DT><DD>Carriage Return (Ctrl-M)</DD></DL>
 
107
<P>
 
108
 
 
109
<DL>
 
110
<DT><B><TT>SO</TT></B></DT>
 
111
<DD>Shift Out (Ctrl-N), invokes the G1 character set<BR>
 
112
Switch to Alternate Character Set</DD>
 
113
</DL>
 
114
<P>
 
115
 
 
116
<DL>
 
117
<DT><B><TT>SI</TT></B></DT>
 
118
<DD>Shift In (Ctrl-O), invokes the G0 character set (the default)<BR>
 
119
Switch to Standard Character Set</DD>
 
120
</DL>
 
121
<P>
 
122
 
 
123
<DL><DT><B><TT>SPC</TT></B></DT><DD>Space Character</DD></DL>
 
124
<P>
 
125
 
 
126
<HR>
 
127
<H2><A HREF="#toc" NAME="Sequences">Escape Sequences</A></H2>
 
128
<P>
 
129
 
 
130
<DL>
 
131
<DT><B><TT>ESC # 8</TT></B></DT>
 
132
<DD>DEC Screen Alignment Test (DECALN)</DD>
 
133
</DL>
 
134
<P>
 
135
 
 
136
<DL>
 
137
<DT><B><TT>
 
138
ESC 7<BR>
 
139
ESC 8
 
140
</TT></B></DT>
 
141
<DD>
 
142
Save Cursor (SC)<BR>
 
143
Restore Cursor (RC)
 
144
</DD>
 
145
</DL>
 
146
<P>
 
147
 
 
148
<DL>
 
149
<A NAME="ESC="></A>
 
150
<DT><B><TT>
 
151
ESC =<BR>
 
152
ESC &gt;
 
153
</TT></B></DT>
 
154
<DD>
 
155
Application Keypad (SMKX) ==
 
156
<A HREF="#Priv66"><B><TT>ESC[?66h</TT></B></A><BR>
 
157
Normal Keypad (RMKX) ==
 
158
<A HREF="#Priv66"><B><TT>ESC[?66l</TT></B></A>
 
159
</DD>
 
160
</DL>
 
161
<P>
 
162
 
 
163
<B>Note:</B>
 
164
If the numeric keypad is activated, eg, <B>Num_Lock</B> has been pressed,
 
165
numbers or control functions are generated by the numeric keypad (see
 
166
<A HREF="#KeyCodes">Key Codes</A>)
 
167
<P>
 
168
 
 
169
<DL><DT><B><TT>ESC D</TT></B></DT><DD>Index (IND)</DD></DL>
 
170
<P>
 
171
 
 
172
<DL><DT><B><TT>ESC E</TT></B></DT><DD>Next Line (NEL)</DD></DL>
 
173
<P>
 
174
 
 
175
<DL><DT><B><TT>ESC H</TT></B></DT><DD>Tab Set (HTS)</DD></DL>
 
176
<P>
 
177
 
 
178
<DL><DT><B><TT>ESC M</TT></B></DT><DD>Reverse Index (RI)</DD></DL>
 
179
<P>
 
180
 
 
181
<DL>
 
182
<DT><B><TT>ESC N</TT></B></DT>
 
183
<DD>Single Shift Select of G2 Character Set (SS2): affects next character only
 
184
<B><U>unimplemented</B></U>
 
185
</DD>
 
186
</DL>
 
187
<P>
 
188
 
 
189
<DL>
 
190
<DT><B><TT>ESC O</TT></B></DT>
 
191
<DD>Single Shift Select of G3 Character Set (SS3): affects next character only
 
192
<B><U>unimplemented</U></B>
 
193
</DD>
 
194
</DL>
 
195
<P>
 
196
 
 
197
<DL>
 
198
<DT><B><TT>ESC Z</TT></B></DT>
 
199
<DD>Obsolete form of <A HREF="#ESC[Psc"><B><TT>ESC[c</TT></B></A><BR>
 
200
returns: <B><TT>ESC[?1;2C</TT></B> (<B><U>rxvt compile-time option</U></B>)
 
201
</DD>
 
202
</DL>
 
203
<P>
 
204
 
 
205
<DL>
 
206
<DT><B><TT>ESC c</TT></B></DT>
 
207
<DD>Full Reset (RIS)</DD>
 
208
</DL>
 
209
<P>
 
210
 
 
211
<DL>
 
212
<DT><B><TT>ESC n</TT></B></DT>
 
213
<DD>Invoke the G2 Character Set (LS2)</DD>
 
214
</DL>
 
215
<P>
 
216
 
 
217
<DL>
 
218
<DT><B><TT>ESC o</TT></B></DT>
 
219
<DD>Invoke the G3 Character Set (LS3)</DD>
 
220
</DL>
 
221
<P>
 
222
 
 
223
<DL>
 
224
<DT><B><TT>
 
225
ESC ( C<BR>
 
226
ESC ) C<BR>
 
227
ESC * C<BR>
 
228
ESC + C<BR>
 
229
ESC $ C
 
230
</TT></B></DT>
 
231
<DD>
 
232
Designate G0 Character Set (ISO 2022)<BR>
 
233
Designate G1 Character Set (ISO 2022)<BR>
 
234
Designate G2 Character Set (ISO 2022)<BR>
 
235
Designate G3 Character Set (ISO 2022)<BR>
 
236
Designate Kanji Character Set<BR>
 
237
<EM>where</EM> <B><TT>C</TT></B> is<BR>
 
238
<UL>
 
239
<B><TT>C = 0</TT></B> : DEC Special Character and Line Drawing Set<BR>
 
240
<B><TT>C = A</TT></B> : United Kingdom (UK)<BR>
 
241
<B><TT>C = B</TT></B> : United States (USASCII)<BR>
 
242
<B><TT>C = &lt;</TT></B> : Multinational character set <B><U>unimplemented</U></B><BR>
 
243
<B><TT>C = 5</TT></B> : Finnish character set <B><U>unimplemented</U></B><BR>
 
244
<B><TT>C = C</TT></B> : Finnish character set <B><U>unimplemented</U></B><BR>
 
245
<B><TT>C = K</TT></B> : German character set <B><U>unimplemented</U></B>
 
246
</UL>
 
247
</DD>
 
248
</DL>
 
249
<P>
 
250
 
 
251
<HR>
 
252
<H2><A HREF="#toc" NAME="CSI">CSI (Code Sequence Introducer) Sequences</A></H2>
 
253
<P>
 
254
 
 
255
<DL>
 
256
<DT><B><TT>ESC [ Ps @</TT></B></DT>
 
257
<DD>Insert <B><TT>Ps</TT></B> (Blank) Character(s) [default: 1] (ICH)</DD>
 
258
</DL>
 
259
<P>
 
260
 
 
261
<DL>
 
262
<A NAME="ESC[PsA"></A>
 
263
<DT><B><TT>ESC [ Ps A</TT></B></DT>
 
264
<DD>Cursor Up <B><TT>Ps</TT></B> Times [default: 1] (CUU)</DD>
 
265
</DL>
 
266
<P>
 
267
 
 
268
<DL>
 
269
<DT><B><TT>ESC [ Ps B</TT></B></DT>
 
270
<DD>Cursor Down <B><TT>Ps</TT></B> Times [default: 1] (CUD)
 
271
</DD>
 
272
</DL>
 
273
<P>
 
274
 
 
275
<DL>
 
276
<A NAME="ESC[PsC"></A>
 
277
<DT><B><TT>ESC [ Ps C</TT></B></DT>
 
278
<DD>Cursor Forward <B><TT>Ps</TT></B> Times [default: 1] (CUF)</DD>
 
279
</DL>
 
280
<P>
 
281
 
 
282
<DL>
 
283
<DT><B><TT>ESC [ Ps D</TT></B></DT>
 
284
<DD>Cursor
 
285
Backward <B><TT>Ps</TT></B> Times [default: 1] (CUB)</DD>
 
286
</DL>
 
287
<P>
 
288
 
 
289
<DL>
 
290
<DT><B><TT>ESC [ Ps E</TT></B></DT>
 
291
<DD>Cursor Down <B><TT>Ps</TT></B> Times [default: 1] and to first column</DD>
 
292
</DL>
 
293
<P>
 
294
 
 
295
<DL>
 
296
<DT><B><TT>ESC [ Ps F</TT></B></DT>
 
297
<DD>Cursor Up <B><TT>Ps</TT></B> Times [default: 1] and to first column</DD>
 
298
</DL>
 
299
<P>
 
300
 
 
301
<DL>
 
302
<A NAME="ESC[PsG"></A>
 
303
<DT><B><TT>ESC [ Ps G</TT></B></DT>
 
304
<DD>Cursor to Column <B><TT>Ps</TT></B> (HPA)</DD>
 
305
</DL>
 
306
<P>
 
307
 
 
308
<DL>
 
309
<DT><B><TT>ESC [ Ps;Ps H</TT></B></DT>
 
310
<DD>Cursor Position [row;column] [default: 1;1] (CUP)</DD>
 
311
</DL>
 
312
<P>
 
313
 
 
314
<DL>
 
315
<DT><B><TT>ESC [ Ps I</TT></B></DT>
 
316
<DD>Move forward <B><TT>Ps</TT></B> tab stops [default: 1]</DD>
 
317
</DL>
 
318
<P>
 
319
 
 
320
<DL>
 
321
<DT><B><TT>ESC [ Ps J</TT></B></DT>
 
322
<DD>Erase in Display (ED)<BR>
 
323
<B><TT>Ps = 0</TT></B> : Clear Below (default)<BR>
 
324
<B><TT>Ps = 1</TT></B> : Clear Above<BR>
 
325
<B><TT>Ps = 2</TT></B> : Clear All</DD>
 
326
</DL>
 
327
<P>
 
328
 
 
329
<DL>
 
330
<DT><B><TT>ESC [ Ps K</TT></B></DT>
 
331
<DD>Erase in Line (EL)<BR>
 
332
<B><TT>Ps = 0</TT></B> : Clear to Right (default)<BR>
 
333
<B><TT>Ps = 1</TT></B> : Clear to Left (EL1)<BR>
 
334
<B><TT>Ps = 2</TT></B> : Clear All</DD>
 
335
</DL>
 
336
<P>
 
337
 
 
338
<DL>
 
339
<DT><B><TT>ESC [ Ps L</TT></B></DT>
 
340
<DD>Insert <B><TT>Ps</TT></B> Line(s) [default: 1] (IL)</DD>
 
341
</DL>
 
342
<P>
 
343
 
 
344
<DL>
 
345
<DT><B><TT>ESC [ Ps M</TT></B></DT>
 
346
<DD>Delete <B><TT>Ps</TT></B> Line(s) [default: 1] (DL)</DD>
 
347
</DL>
 
348
<P>
 
349
 
 
350
<DL>
 
351
<DT><B><TT>ESC [ Ps P</TT></B></DT>
 
352
<DD>Delete <B><TT>Ps</TT></B> Character(s)
 
353
[default: 1] (DCH)</DD>
 
354
</DL>
 
355
<P>
 
356
 
 
357
<DL>
 
358
<DT><B><TT>ESC [ Ps;Ps;Ps;Ps;Ps T</TT></B></DT>
 
359
<DD>Initiate <A HREF="#Mouse">hilite mouse tracking</A>.
 
360
<B><U>unimplemented</U></B><BR>
 
361
Parameters are [func;startx;starty;firstrow;lastrow].</DD>
 
362
</DL>
 
363
<P>
 
364
 
 
365
<DL>
 
366
<DT><B><TT>ESC [ Ps W</TT></B></DT>
 
367
<DD>Tabulator functions<BR>
 
368
<B><TT>Ps = 0</TT></B> : Tab Set (HTS)<BR>
 
369
<B><TT>Ps = 2</TT></B> : Tab Clear (TBC), Clear Current Column (default)<BR>
 
370
<B><TT>Ps = 5</TT></B> : Tab Clear (TBC), Clear All</DD>
 
371
</DL>
 
372
<P>
 
373
 
 
374
<DL>
 
375
<DT><B><TT>ESC [ Ps X</TT></B></DT>
 
376
<DD>Erase <B><TT>Ps</TT></B> Character(s) [default: 1] (ECH)</DD>
 
377
</DL>
 
378
<P>
 
379
 
 
380
<DL>
 
381
<DT><B><TT>ESC [ Ps Z</TT></B></DT>
 
382
<DD>Move backward <B><TT>Ps</TT></B> [default: 1] tab stops</DD>
 
383
</DL>
 
384
<P>
 
385
 
 
386
<DL>
 
387
<DT><B><TT>ESC [ Ps '</TT></B></DT>
 
388
<DD>== <A HREF="#ESC[PsG"><B><TT>ESC [ Ps G</TT></B></A></DD>
 
389
</DL>
 
390
<P>
 
391
 
 
392
<DL>
 
393
<DT><B><TT>ESC [ Ps a</TT></B></DT>
 
394
<DD>== <A HREF="#ESC[PsC"><B><TT>ESC [ Ps C</TT></B></A></DD>
 
395
</DL>
 
396
<P>
 
397
 
 
398
<DL>
 
399
<A NAME="ESC[Psc"></A>
 
400
<DT><B><TT>ESC [ Ps c</TT></B></DT>
 
401
<DD>Send Device Attributes (DA)<BR>
 
402
<B><TT>Ps = 0</TT></B> (or omitted) : request attributes from terminal<BR>
 
403
returns: <B><TT>ESC[?1;2c</TT></B> (``I am a VT100 with Advanced Video Option'')</DD>
 
404
</DL>
 
405
<P>
 
406
 
 
407
<DL>
 
408
<DT><B><TT>ESC [ Ps d</TT></B></DT>
 
409
<DD>Cursor to Line <B><TT>Ps</TT></B> (VPA)</DD>
 
410
</DL>
 
411
<P>
 
412
 
 
413
<DL>
 
414
<DT><B><TT>ESC [ Ps e</TT></B></DT>
 
415
<DD>== <A HREF="#ESC[PsA"><B><TT>ESC [ Ps A</TT></B></A></DD>
 
416
</DL>
 
417
<P>
 
418
 
 
419
<DL>
 
420
<DT><B><TT>ESC [ Ps;Ps f</TT></B></DT>
 
421
<DD>Horizontal and Vertical Position [row;column] (HVP)<BR>
 
422
[default: 1;1]</DD>
 
423
</DL>
 
424
<P>
 
425
 
 
426
<DL>
 
427
<DT><B><TT>ESC [ Ps g</TT></B></DT>
 
428
<DD>Tab Clear (TBC)<BR>
 
429
<B><TT>Ps = 0</TT></B> : Clear Current Column (default)<BR>
 
430
<B><TT>Ps = 3</TT></B> : Clear All (TBC)
 
431
</DD>
 
432
</DL>
 
433
<P>
 
434
 
 
435
<DL>
 
436
<DT><B><TT>ESC [ Ps i</TT></B></DT>
 
437
<DD>Printing<BR>
 
438
<B><TT>Ps = 4</TT></B> : disable transparent print mode (MC4)<BR>
 
439
<B><TT>Ps = 5</TT></B> : enable transparent print mode (MC5)
 
440
<B><U>unimplemented</U></B>
 
441
</DD>
 
442
</DL>
 
443
<P>
 
444
 
 
445
<DL>
 
446
<DT><B><TT>
 
447
ESC [ Pm h<BR>
 
448
ESC [ Pm l
 
449
</TT></B>
 
450
<DD>Set Mode (SM)<BR>
 
451
Reset Mode (RM)</DD>
 
452
<DT><B><TT>Ps = 4</TT></B></DT>
 
453
<DD>
 
454
<B><TT>h</TT></B> : Insert Mode (SMIR)<BR>
 
455
<B><TT>l</TT></B> : Replace Mode (RMIR)
 
456
</DD>
 
457
<DT><B><TT>Ps = 20</TT></B> <B><U>unimplemented</U></B></DT>
 
458
<DD>
 
459
<B><TT>h</TT></B> : Automatic Newline (LNM)<BR>
 
460
<B><TT>l</TT></B> : Normal Linefeed (LNM)
 
461
</DD>
 
462
</DL>
 
463
<P>
 
464
 
 
465
<DL>
 
466
<DT><B><TT>ESC [ Pm m</TT></B></DT>
 
467
<DD>Character Attributes (SGR) </BR>
 
468
<B><TT>Ps = 0</TT></B> : Normal (default)<BR>
 
469
<B><TT>Ps = 1 / 22</TT></B> : On / Off  Bold (bright fg)<BR>
 
470
<B><TT>Ps = 4 / 24</TT></B> : On / Off  Underline<BR>
 
471
<B><TT>Ps = 5 / 25</TT></B> : On / Off  Blink (bright bg)<BR>
 
472
<B><TT>Ps = 7 / 27</TT></B> : On / Off  Inverse<BR>
 
473
<B><TT>Ps = 30 / 40</TT></B> : fg / bg  Black<BR>
 
474
<B><TT>Ps = 31 / 41</TT></B> : fg / bg  Red<BR>
 
475
<B><TT>Ps = 32 / 42</TT></B> : fg / bg  Green<BR>
 
476
<B><TT>Ps = 33 / 43</TT></B> : fg / bg  Yellow<BR>
 
477
<B><TT>Ps = 34 / 44</TT></B> : fg / bg  Blue<BR>
 
478
<B><TT>Ps = 35 / 45</TT></B> : fg / bg  Magenta<BR>
 
479
<B><TT>Ps = 36 / 46</TT></B> : fg / bg  Cyan<BR>
 
480
<B><TT>Ps = 37 / 47</TT></B> : fg / bg  White<BR>
 
481
<B><TT>Ps = 39 / 49</TT></B> : fg / bg  Default</DD>
 
482
</DL>
 
483
<P>
 
484
 
 
485
<DL>
 
486
<DT><B><TT>ESC [ Ps n</TT></B></DT>
 
487
<DD>Device Status Report (DSR)<BR>
 
488
<B><TT>Ps = 5</TT></B> : Status Report <B><TT>ESC [ 0 n</TT></B> (``OK'')<BR>
 
489
<B><TT>Ps = 6</TT></B> : Report Cursor Position (CPR) [row;column] as
 
490
                        <B><TT>ESC [ r ; c R</TT></B><BR>
 
491
<B><TT>Ps = 7</TT></B> : Request Display Name<BR>
 
492
<B><TT>Ps = 8</TT></B> : Request Version Number (place in window title)
 
493
</DD>
 
494
</DL>
 
495
<P>
 
496
 
 
497
<DL>
 
498
<DT><B><TT>ESC [ Ps;Ps r</TT></B></DT>
 
499
<DD>Set Scrolling Region [top;bottom]<BR>
 
500
[default: full size of window] (CSR)</DD>
 
501
</DL>
 
502
<P>
 
503
 
 
504
<DL>
 
505
<DT><B><TT>ESC [ Ps x</TT></B></DT>
 
506
<DD>Request Terminal Parameters (DECREQTPARM)
 
507
</DD>
 
508
</DL>
 
509
<P>
 
510
 
 
511
<HR>
 
512
<H2><A HREF="#toc" NAME="PrivateModes">DEC Private Modes</A></H2>
 
513
 
 
514
<DL>
 
515
<DT><B><TT>ESC [ ? Pm h</TT></B></DT>
 
516
<DD>DEC Private Mode Set (DECSET)</DD>
 
517
</DL>
 
518
<P>
 
519
 
 
520
<DL>
 
521
<DT><B><TT>ESC [ ? Pm l</TT></B></DT>
 
522
<DD>DEC Private Mode Reset (DECRST)</DD>
 
523
</DL>
 
524
<P>
 
525
 
 
526
<DL>
 
527
<DT><B><TT>ESC [ ? Pm r</TT></B></DT>
 
528
<DD>Restore previously saved DEC Private Mode Values.</DD>
 
529
</DL>
 
530
<P>
 
531
 
 
532
<DL>
 
533
<DT><B><TT>ESC [ ? Pm s</TT></B></DT>
 
534
<DD>Save DEC Private Mode Values.</DD>
 
535
</DL>
 
536
 
 
537
<P>
 
538
<DL>
 
539
<DT><B><TT>ESC [ ? Pm t</TT></B></DT>
 
540
<DD>Toggle DEC Private Mode Values (rxvt extension).</DD>
 
541
</DL>
 
542
<P>
 
543
 
 
544
<EM>where</EM>
 
545
<P>
 
546
 
 
547
<DL>
 
548
<DD>
 
549
<DT><B><TT>Ps = 1</TT></B> (DECCKM)</DT>
 
550
<DD>
 
551
<B><TT>h</TT></B> : Application Cursor Keys<BR>
 
552
<B><TT>l</TT></B> : Normal Cursor Keys
 
553
</DD>
 
554
<DT><B><TT>Ps = 2</TT></B> <B><U>unimplemented</U></B></DT>
 
555
<DD>
 
556
<B><TT>h</TT></B> : Designate USASCII for character sets G0-G3.
 
557
</DD>
 
558
<DT><B><TT>Ps = 3</TT></B></DT>
 
559
<DD>
 
560
<B><TT>h</TT></B> : 132 Column Mode (DECCOLM)<BR>
 
561
<B><TT>l</TT></B> : 80 Column Mode (DECCOLM)
 
562
</DD>
 
563
<DT><B><TT>Ps = 4</TT></B> <B><U>unimplemented</U></B></DT>
 
564
<DD>
 
565
<B><TT>h</TT></B> : Smooth (Slow) Scroll (DECSCLM)<BR>
 
566
<B><TT>l</TT></B> : Jump (Fast) Scroll (DECSCLM)
 
567
</DD>
 
568
<DT><B><TT>Ps = 5</TT></B></DT>
 
569
<DD>
 
570
<B><TT>h</TT></B> : Reverse Video (DECSCNM)<BR>
 
571
<B><TT>l</TT></B> : Normal Video (DECSCNM)
 
572
</DD>
 
573
<DT><B><TT>Ps = 6</TT></B></DT>
 
574
<DD>
 
575
<B><TT>h</TT></B> : Origin Mode (DECOM)<BR>
 
576
<B><TT>l</TT></B> : Normal Cursor Mode (DECOM)
 
577
</DD>
 
578
<DT><B><TT>Ps = 7</TT></B></DT>
 
579
<DD>
 
580
<B><TT>h</TT></B> : Wraparound Mode (DECAWM)<BR>
 
581
<B><TT>l</TT></B> : No Wraparound Mode (DECAWM)
 
582
</DD>
 
583
<DT><B><TT>Ps = 8</TT></B> <B><U>unimplemented</U></B></DT>
 
584
<DD>
 
585
<B><TT>h</TT></B> : Auto-repeat Keys (DECARM)<BR>
 
586
<B><TT>l</TT></B> : No Auto-repeat Keys (DECARM)
 
587
</DD>
 
588
<DT><B><TT>Ps = 9</TT></B> (X10 XTerm <A HREF="#Mouse">mouse reporting</A>)</DT>
 
589
<DD>
 
590
<B><TT>h</TT></B> : Send Mouse X &amp; Y on button press.<BR>
 
591
<B><TT>l</TT></B> : No mouse reporting.
 
592
</DD>
 
593
<A NAME="Priv10"></A>
 
594
<DT><B><TT>Ps = 10</TT></B> (<B><U>rxvt</U></B>)</DT>
 
595
<DD>
 
596
<B><TT>h</TT></B> : <A HREF="#menuBar">menuBar</A> visisble<BR>
 
597
<B><TT>l</TT></B> : <A HREF="#menuBar">menuBar</A> invisisble
 
598
</DD>
 
599
<DT><B><TT>Ps = 25</TT></B></DT>
 
600
<DD>
 
601
<B><TT>h</TT></B> : Visible cursor {cnorm/cvvis}<BR>
 
602
<B><TT>l</TT></B> : Invisible cursor {civis}
 
603
</DD>
 
604
<DT><B><TT>Ps = 30</TT></B> (<B><U>rxvt</U></B>)</DT>
 
605
<DD>
 
606
<B><TT>h</TT></B> : scrollBar visisble<BR>
 
607
<B><TT>l</TT></B> : scrollBar invisisble
 
608
</DD>
 
609
<DT><B><TT>Ps = 35</TT></B> (<B><U>rxvt</U></B>)</DT>
 
610
<DD>
 
611
<B><TT>h</TT></B> : Allow XTerm Shift+key sequences<BR>
 
612
<B><TT>l</TT></B> : Disallow XTerm Shift+key sequences
 
613
</DD>
 
614
<DT><B><TT>Ps = 38</TT></B> : Enter Tektronix Mode (DECTEK)
 
615
<B><U>unimplemented</U></B></DT>
 
616
<DD>
 
617
</DD>
 
618
<DT><B><TT>Ps = 40</TT></B></DT>
 
619
<DD>
 
620
<B><TT>h</TT></B> : Allow 80/132 Mode<BR>
 
621
<B><TT>l</TT></B> : Disallow 80/132 Mode
 
622
</DD>
 
623
<DT><B><TT>Ps = 44</TT></B> <B><U>unimplemented</U></B></DT>
 
624
<DD>
 
625
<B><TT>h</TT></B> : Turn On Margin Bell<BR>
 
626
<B><TT>l</TT></B> : Turn Off Margin Bell
 
627
</DD>
 
628
<DT><B><TT>Ps = 45</TT></B> <B><U>unimplemented</U></B></DT>
 
629
<DD>
 
630
<B><TT>h</TT></B> : Reverse-wraparound Mode<BR>
 
631
<B><TT>l</TT></B> : No Reverse-wraparound Mode
 
632
</DD>
 
633
<DT><B><TT>Ps = 46</TT></B> <B><U>unimplemented</U></B></DT>
 
634
<DT><B><TT>Ps = 47</TT></B></DT>
 
635
<DD>
 
636
<B><TT>h</TT></B> : Use Alternate Screen Buffer<BR>
 
637
<B><TT>l</TT></B> : Use Normal Screen Buffer
 
638
</DD>
 
639
<A NAME="Priv66"></A>
 
640
<DT><B><TT>Ps = 66</TT></B></DT>
 
641
<DD>
 
642
<B><TT>h</TT></B> : Application Keypad (DECPAM)
 
643
        == <A HREF="#ESC="><B><TT>ESC =</TT></B></A><BR>
 
644
<B><TT>l</TT></B> : Normal Keypad (DECPNM)
 
645
        == <A HREF="#ESC="><B><TT>ESC &gt;</TT></B></A>
 
646
</DD>
 
647
<DT><B><TT>Ps = 67</TT></B></DT>
 
648
<DD>
 
649
<B><TT>h</TT></B> : Backspace key sends <B><TT>BS</TT></B> (DECBKM)<BR>
 
650
<B><TT>l</TT></B> : Backspace key sends <B><TT>DEL</TT></B>
 
651
</DD>
 
652
<DT><B><TT>Ps = 1000</TT></B> (X11 XTerm <A HREF="#Mouse">mouse reporting</A>)</DT>
 
653
<DD>
 
654
<B><TT>h</TT></B> : Send Mouse X &amp; Y on button press and release.<BR>
 
655
<B><TT>l</TT></B> : No mouse reporting.
 
656
</DD>
 
657
<DT><B><TT>Ps = 1001</TT></B> (X11 XTerm <A HREF="#Mouse">mouse Tracking</A>) <B><U>unimplemented</U></B></DT>
 
658
<DD>
 
659
<B><TT>h</TT></B> : Use Hilite Mouse Tracking.<BR>
 
660
<B><TT>l</TT></B> : No mouse reporting.
 
661
</DD>
 
662
</DL>
 
663
<P>
 
664
 
 
665
<HR>
 
666
<H2><A HREF="#toc" NAME="XTerm">XTerm Escape Sequences</A></H2>
 
667
 
 
668
<DL>
 
669
<DT><B><TT>ESC ] Ps;Pt BEL</TT></B></DT>
 
670
<DD>Set XTerm Parameters</DD>
 
671
<DT><B><TT>Ps = 0</TT></B></DT>
 
672
<DD>Change Icon Name and Window Title to <B><TT>Pt</TT></B></DD>
 
673
<DT><B><TT>Ps = 1</TT></B></DT>
 
674
<DD>Change Icon Name to <B><TT>Pt</TT></B></DD>
 
675
<DT><B><TT>Ps = 2</TT></B></DT>
 
676
<DD>Change Window Title to <B><TT>Pt</TT></B></DD>
 
677
<DT><B><TT>Ps = 10</TT></B></DT>
 
678
<DD><A HREF="#menuBar">menuBar</A> command <B><TT>Pt</TT></B>
 
679
(<B><U>rxvt compile-time option</U></B>)</DD>
 
680
<DT><B><TT>Ps = 20</TT></B></DT>
 
681
<DD>Change default background <A HREF="#XPM">pixmap</A> to <B><TT>Pt</TT></B>
 
682
(<B><U>rxvt compile-time option</U></B>)
 
683
</DD>
 
684
 
 
685
<DT><B><TT>Ps = 39</TT></B></DT>
 
686
<DD>Change default foreground color to <B><TT>Pt</TT></B>
 
687
(<B><U>rxvt compile-time option</U></B>)</DD>
 
688
<DT><B><TT>Ps = 46</TT></B></DT>
 
689
<DD>Change Log File to <B><TT>Pt</TT></B>(normally disabled by a compile-time option) <B><U>unimplemented</U></B></DD>
 
690
<DT><B><TT>Ps = 49</TT></B></DT>
 
691
<DD>Change default background color to <B><TT>Pt</TT></B>
 
692
(<B><U>rxvt compile-time option</U></B>)</DD>
 
693
<DT>
 
694
<B><TT>Ps = 50</TT></B></DT>
 
695
<DD>Set Font to <B><TT>Pt</TT></B>, with the following special values of <B><TT>Pt</TT></B> (<B><U>rxvt</U></B>)<BR>
 
696
<B><TT>#+n</TT></B> : change up <B><TT>n</TT></B> font(s)<BR>
 
697
<B><TT>#-n</TT></B> : change down <B><TT>n</TT></B> font(s)<BR>
 
698
<UL>if <B><TT>n</TT></B> is missing or 0, a value of 1 is used</UL>
 
699
<EM>empty</EM> : change to font0<BR>
 
700
<B><TT>#n</TT></B> : change to font<B><TT>n</TT></B></DD>
 
701
</DL>
 
702
<P>
 
703
 
 
704
<HR>
 
705
<H2><A HREF="#toc" NAME="menuBar">menuBar</A></H2>
 
706
<P>
 
707
 
 
708
<STRONG>The exact syntax used is <EM>almost</EM> solidified.</STRONG><BR>
 
709
In the menus, <STRONG>DON'T</STRONG> try to use menuBar commands that
 
710
add or remove a menuBar.
 
711
<P>
 
712
 
 
713
Note that in all of the commands, the <B><EM>/path/</EM></B>
 
714
<EM>cannot</EM> be omitted:
 
715
use <B>./</B> to specify a menu relative to the current menu.
 
716
 
 
717
<H3>Overview of menuBar operation</H3>
 
718
 
 
719
For the menuBar XTerm escape sequence <B><TT>ESC ] 10; Pt BEL</TT></B>, the
 
720
syntax of <B><TT>Pt</TT></B> can be used for a variety of tasks:
 
721
<UL COMPACT>
 
722
<LI><A HREF="#menuBarCommands">Commands</A></LI>
 
723
<LI><A HREF="#menuBarAdd">Adding and accessing menus</A></LI>
 
724
<LI><A HREF="#menuBarRemove">Removing menus</A></LI>
 
725
<LI><A HREF="#menuBarArrows">Quick Arrows</A></LI>
 
726
<LI><A HREF="#menuBarSummary">Command Summary</A></LI>
 
727
</UL>
 
728
 
 
729
At the top level is the current menuBar which is a member of a
 
730
circular linked-list of other such menuBars.
 
731
 
 
732
The menuBar acts as a parent for the various drop-down menus, which in
 
733
turn, may have labels, separator lines, menuItems and subMenus.
 
734
 
 
735
The menuItems are the useful bits: you can use them to mimic keyboard
 
736
input or even to send text or escape sequences back to rxvt.
 
737
 
 
738
The menuBar syntax is intended to provide a simple yet robust method
 
739
of constructing and manipulating menus and navigating through the
 
740
menuBars.
 
741
 
 
742
<P>
 
743
The first step is to use the tag <B>[menu:<EM>name</EM>]</B> which
 
744
creates the menuBar called <EM>name</EM> and allows access.
 
745
You may now
 
746
<A HREF="#menuBarAdd">add</A> or <A HREF="#menuBarRemove">remove</A>
 
747
menus, subMenus, and menuItems. Finally, use the tag
 
748
<B>[done]</B> to set the menuBar access as <B>readonly</B>
 
749
to prevent accidental corruption of the menus.
 
750
To re-access the current menuBar for alterations, use the tag
 
751
<B>[menu]</B>, make the alterations and then use
 
752
<B>[done]</B>
 
753
<P>
 
754
 
 
755
<H3><A HREF="#menuBar" NAME="menuBarCommands">Commands</A></H3>
 
756
 
 
757
<DL >
 
758
<DT><B>[menu:<EM>name</EM>]</B></DT>
 
759
<DD>
 
760
access the named menuBar for creation or alteration.
 
761
If a new menuBar is created, it is called <EM>name</EM> (max of 15 chars)
 
762
and the current menuBar is pushed onto the stack
 
763
</DD>
 
764
 
 
765
<DT><B>[menu]</B></DT>
 
766
<DD>access the current menuBar for alteration</DD>
 
767
 
 
768
<DT><B>[title:<EM>string</EM>]</B></DT>
 
769
<DD>
 
770
set the current menuBar's title to <EM>string</EM>, which may contain
 
771
the following format specifiers:<BR>
 
772
<B>%%</B> : literal <B>%</B> character<BR>
 
773
<B>%n</B> : rxvt name (as per the <B>-name</B> command-line option)<BR>
 
774
<B>%v</B> : rxvt version
 
775
</DD>
 
776
 
 
777
<DT><B>[done]</B></DT>
 
778
<DD>
 
779
set menuBar access as <B>readonly</B>.<BR>
 
780
End-of-file tag for <B>[read:<EM>file</EM>]</B> operations.
 
781
</DD>
 
782
 
 
783
<DT><B>[read:<EM>file</EM>]</B></DT>
 
784
<DD>
 
785
read menu commands directly from <EM>file</EM>
 
786
(extension &quot;.menu&quot; will be appended if required).
 
787
Start reading at a line with <B>[menu]</B> or <B>[menu:<EM>name</EM>]</B>
 
788
and continuing until <B>[done]</B> is encountered.
 
789
<BR>
 
790
Blank and comment lines (starting with <B>#</B>) are ignored.
 
791
Actually, since any invalid menu commands are also ignored, almost
 
792
anything could be construed as a comment line, but this may be
 
793
tightened up in the future ... so don't count on it!.
 
794
</DD>
 
795
 
 
796
<DT><B>[read:<EM>file</EM>;<EM>name</EM>]</B></DT>
 
797
<DD>
 
798
The same as <B>[read:<EM>file</EM>]</B>, but
 
799
start reading at a line with <B>[menu:<EM>name</EM>]</B>
 
800
and continuing until <B>[done:<EM>name</EM>]</B>
 
801
or <B>[done]</B> is encountered.
 
802
</DD>
 
803
 
 
804
<DT><B>[dump]</B></DT>
 
805
<DD>
 
806
dump all menuBars to the file <B>/tmp/rxvt-PID</B> in a format suitable
 
807
for later rereading.
 
808
</DD>
 
809
 
 
810
<DT><B>
 
811
[rm:name]<BR>
 
812
[rm] [rm:]<BR>
 
813
[rm*] [rm:*]
 
814
</B></DT>
 
815
<DD>
 
816
remove the named menuBar<BR>
 
817
remove the current menuBar<BR>
 
818
remove all menuBars
 
819
</DD>
 
820
 
 
821
<DT><B>[swap]</B></DT>
 
822
<DD>swap the top two menuBars</DD>
 
823
 
 
824
<DT><B>[prev]<BR>[next]</B></DT>
 
825
<DD>access the previous or next menuBar</DD>
 
826
 
 
827
<DT><B>[show]<BR>[hide]</B></DT>
 
828
<DD>control display of the menuBar ... just like
 
829
<A HREF="#Priv10"><B>ESC[?10 h/l</B></A>
 
830
</DD>
 
831
 
 
832
<DT><B>
 
833
[pixmap:<EM>name</EM>]<BR>
 
834
[pixmap:<EM>name</EM>;<EM>scaling</EM>]
 
835
</B></DT>
 
836
<DD>set the background pixmap globally ... just like
 
837
<A HREF="#XPM"><B>ESC]20; Pt BEL</B></A>
 
838
<BR>
 
839
<B>A Future implementation <EM>may</EM> make this local to the menubar</B>
 
840
</DD>
 
841
 
 
842
<DT><B>[:<EM>command</EM>:]</B></DT>
 
843
<DD>ignore the menu readonly status and issue a <EM>command</EM> to
 
844
<A HREF="#menuBarAdd">Add/Modify</A> or
 
845
<A HREF="#menuBarRemove">Remove</A> a menu or menuitem or
 
846
change the <A HREF="#menuBarArrows">Quick Arrows</A>;
 
847
a useful shortcut for setting the quick arrows from a menuBar.
 
848
</DD>
 
849
</DL>
 
850
 
 
851
<H3><A HREF="#menuBar" NAME="menuBarAdd">Adding and accessing menus</A></H3>
 
852
 
 
853
The following commands may also be <B>+</B> prefixed.
 
854
<DL>
 
855
<DT><B>/<BR>./<BR>../<BR>../../</B></DT>
 
856
<DD>
 
857
access menuBar top level<BR>
 
858
access current menu level<BR>
 
859
access parent menu (1 level up)<BR>
 
860
access parent menu (multiple levels up)
 
861
</DD>
 
862
 
 
863
<DT><B><EM>/path/</EM>menu</B></DT>
 
864
<DD>add/access menu</DD>
 
865
 
 
866
<DT><B><EM>/path/</EM>menu/*</B></DT>
 
867
<DD>add/access menu and clear it if it exists</DD>
 
868
 
 
869
<DT><B><EM>/path/</EM>{-}</B></DT>
 
870
<DD>add separator</DD>
 
871
 
 
872
<DT><B><EM>/path/</EM>{item}</B></DT>
 
873
<DD>add <B>item</B> as a label</DD>
 
874
 
 
875
<DT><B><EM>/path/</EM>{item} action</B></DT>
 
876
<DD>
 
877
add/alter <EM>menuitem</EM> with an associated <EM>action</EM>
 
878
</DD>
 
879
 
 
880
<DT><B><EM>/path/</EM>{item}{right-text}</B></DT>
 
881
<DD>
 
882
add/alter <EM>menuitem</EM> with <B>right-text</B>
 
883
as the right-justified text and as the associated <EM>action</EM>
 
884
</DD>
 
885
 
 
886
<DT><B><EM>/path/</EM>{item}{rtext} action</B></DT>
 
887
<DD>
 
888
add/alter <EM>menuitem</EM> with an associated <EM>action</EM>
 
889
and with <B>rtext</B> as the right-justified text.
 
890
</DD>
 
891
</DL>
 
892
 
 
893
<DL>
 
894
<DT>Special characters in <EM>action</EM> must be backslash-escaped:</DT>
 
895
<DD><B>\a \b \E \e \n \r \t \octal</B></DD>
 
896
<DT>or in control-character notation:</DT>
 
897
<DD><B>^@, ^A .. ^Z .. ^_, ^?</B></DD>
 
898
</DL>
 
899
 
 
900
To send a string starting with a <B>NUL</B> (<B>^@</B>)
 
901
character to the program, start <EM>action</EM> with a pair of
 
902
<B>NUL</B> characters (<B>^@^@</B>),
 
903
the first of which will be stripped off and the balance directed to
 
904
the program.
 
905
Otherwise if <EM>action</EM> begins with <B>NUL</B>
 
906
followed by non-<B>NUL</B> characters, the leading
 
907
<B>NUL</B> is stripped off and the balance is sent back to rxvt.
 
908
<P>
 
909
As a convenience for the many Emacs-type editors, <EM>action</EM>
 
910
may start with <B>M-</B> (eg, <B>M-$</B> is equivalent to <B>\E$</B>)
 
911
and a <B>CR</B>  will be appended if missed from <B>M-x</B> commands.
 
912
 
 
913
As a convenience for issuing XTerm <B>ESC]</B> sequences from a menubar
 
914
(or quick arrow), a <B>BEL</B> (<B>^G</B>) will be appended if needed.
 
915
 
 
916
<DL>
 
917
<DT>For example,</DT>
 
918
<DD><B>M-xapropos</B></DD>
 
919
<DT>is equivalent to</DT>
 
920
<DD><B>\Exapropos\r</B></DD>
 
921
<DT>and</DT>
 
922
<DD><B>\E]10;mona;100</B>
 
923
<DT>is equivalent to</DT>
 
924
<DD><B>\E]10;mona;100\a</B></DD>
 
925
</DL>
 
926
 
 
927
<P>
 
928
The option <B>{<EM>right-rtext</EM>}</B> will be right-justified.
 
929
In the absence of a specified action, this text will be used as the
 
930
<EM>action</EM> as well.
 
931
<DL>
 
932
<DT>For example,</DT>
 
933
<DD><B>/File/{Open}{^X^F}</B></DD>
 
934
<DT>is equivalent to</DT>
 
935
<DD><B>/File/{Open){^X^F}&nbsp;^X^F</B></DD>
 
936
</DL>
 
937
 
 
938
The left label <EM>is</EM> necessary, since it's used for matching,
 
939
but implicitly hiding the left label (by using same name for both left
 
940
and right labels), or explicitly hiding the left label (by preceding
 
941
it with a dot), makes it possible to have right-justified text only.
 
942
<DL>
 
943
<DT>For example,</DT>
 
944
<DD><B>/File/{Open}{Open}&nbsp;Open-File-Action</B></DD>
 
945
<DT>or hiding it</DT>
 
946
<DD><B>/File/{.anylabel}{Open}&nbsp;Open-File-Action</B></DD>
 
947
</DL>
 
948
 
 
949
<H3><A HREF="#menuBar" NAME="menuBarRemove">Removing menus</A></H3>
 
950
 
 
951
<DL>
 
952
<DT><B>
 
953
-/*<BR>
 
954
-<EM>/path/</EM>menu<BR>
 
955
-<EM>/path/</EM>{item}<BR>
 
956
-<EM>/path/</EM>{-}
 
957
</B></DT>
 
958
<DD>
 
959
remove all menus from the menuBar, the same as <B>[clear]</B><BR>
 
960
remove menu<BR>
 
961
remove item<BR>
 
962
remove separator
 
963
</DD>
 
964
<DT><B>-/path/menu/*</B></DT>
 
965
<DD>remove all items, separators and submenus from menu</DD>
 
966
</DL>
 
967
 
 
968
<H3><A HREF="#menuBar" NAME="menuBarArrows">Quick Arrows</A></H3>
 
969
 
 
970
The menus also provide a hook for <EM>quick arrows</EM> to provide easier
 
971
user access. If nothing has been explicitly set, the default is to
 
972
emulate the curror keys. The syntax permits each arrow to be altered
 
973
individually or all four at once without re-entering their common
 
974
beginning/end text. For example, to explicitly associate cursor
 
975
actions with the arrows, any of the following forms could be used:
 
976
 
 
977
<DL >
 
978
<DT><B>
 
979
&lt;r&gt;<EM>Right</EM><BR>
 
980
&lt;l&gt;<EM>Left</EM><BR>
 
981
&lt;u&gt;<EM>Up</EM><BR>
 
982
&lt;d&gt;<EM>Down</EM>
 
983
</B></DT>
 
984
<DD>Define actions for the respective arrow buttons</DD>
 
985
<DT><B>
 
986
&lt;b&gt;<EM>Begin</EM><BR>
 
987
&lt;e&gt;<EM>End</EM>
 
988
</B></TT></DT>
 
989
<DD>
 
990
Define common beginning/end parts for <EM>quick arrows</EM>
 
991
when used in conjunction with the above
 
992
<B>&lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt;</B>
 
993
constructs
 
994
</DD>
 
995
</DL>
 
996
 
 
997
<DL>
 
998
<DT>For example, define arrows individually,</DT>
 
999
<DD><B>
 
1000
&lt;u&gt;\E[A<BR>
 
1001
&lt;d&gt;\E[B<BR>
 
1002
&lt;r&gt;\E[C<BR>
 
1003
&lt;l&gt;\E[D
 
1004
</B></DD>
 
1005
<DT>or all at once</DT>
 
1006
<DD><B>&lt;u&gt;\E[A&lt;d&gt;\E[B&lt;r&gt;\E[C&lt;l&gt;\E[D</B></DD>
 
1007
<DT>or more compactly (factoring out common parts)</DD>
 
1008
<DD><B>&lt;b&gt;\E[&lt;u&gt;A&lt;d&gt;B&lt;r&gt;C&lt;l&gt;D</B></DD>
 
1009
</DL>
 
1010
 
 
1011
<HR>
 
1012
<H3><A HREF="#menuBar" NAME="menuBarSummary">Command Summary</A></H3>
 
1013
 
 
1014
A short summary of the most <EM>common</EM> commands:
 
1015
<DL >
 
1016
<DT>[menu:name]</DT>
 
1017
<DD>use an existing named menuBar or start a new one</DD>
 
1018
<DT>[menu]</DT>
 
1019
<DD>use the current menuBar</DD>
 
1020
<DT>[title:string]</DT>
 
1021
<DD>set menuBar title<DD>
 
1022
<DT>[done]</DT>
 
1023
<DD>set menu access to readonly and, if reading from a file, signal EOF</DD>
 
1024
<DT>[done:name]</DT>
 
1025
<DD>if reading from a file using [read:file;name] signal EOF</DD>
 
1026
<DT>[rm:name]<BR>[rm] [rm:]<BR>[rm*] [rm:*]</DT>
 
1027
<DD>remove named, current, or all menuBar(s)</DD>
 
1028
<DT>[swap]</DT>
 
1029
<DD>swap top two menuBars</DD>
 
1030
<DT>[prev]<BR>[next]</DT>
 
1031
<DD>access the previous/next menuBar</DD>
 
1032
<DT>[show]<BR>[hide]</DT>
 
1033
<DD>map/unmap menuBar</DD>
 
1034
<DT>[pixmap;file]<BR>[pixmap;file;scaling]</DT>
 
1035
<DD>set a background pixmap</DD>
 
1036
<DT>
 
1037
[read:file]<BR>
 
1038
[read:file;name]</DT>
 
1039
<DD>read in a menu from a file</DD>
 
1040
<DT>[dump]</DT>
 
1041
<DD>dump out all menuBars to /tmp/rxvt-PID</DD>
 
1042
<DT>/<DT><DD>access menuBar top level</DD>
 
1043
<DT>./<BR>../<BR>../../</DT><DD>access current or parent menu level</DD>
 
1044
<DT>/path/menu</DT><DD>add/access menu</DD>
 
1045
<DT>/path/{-}</DT><DD>add separator</DD>
 
1046
<DT>/path/{item}{rtext}&nbsp;action</DT>
 
1047
<DD>add/alter menu item<BR>({rtext} and/or action, may be omitted)</DD>
 
1048
<DT>-/*</DT><DD>remove all menus from the menuBar</DD>
 
1049
<DT>-/path/menu</DT><DD>remove menu items, separators and submenus from menu</DD>
 
1050
<DT>-/path/menu</DT><DD>remove menu</DD>
 
1051
<DT>-/path/{item}</DT><DD>remove item</DD>
 
1052
<DT>-/path/{-}</DT><DD>remove separator</DD>
 
1053
<DT>&lt;b&gt;Begin&lt;r&gt;Right&lt;l&gt;Left&lt;u&gt;Up&lt;d&gt;Down&lt;e&gt;End</DT>
 
1054
<DD>menu quick arrows</DD>
 
1055
</DL>
 
1056
 
 
1057
<HR>
 
1058
<H2><A HREF="#toc" NAME="XPM">XPM</A></H2>
 
1059
<P>
 
1060
For the XPM XTerm escape sequence <B><TT>ESC ] 20; Pt BEL</TT></B>
 
1061
then value of <B><TT>Pt</TT></B>
 
1062
can be the name of the background pixmap followed by a sequence of
 
1063
scaling/positioning commands separated by semi-colons. The
 
1064
scaling/positioning commands are as follows:
 
1065
<DL>
 
1066
<DT>query scale/position</DT>
 
1067
<DD><B>?</B></DD>
 
1068
<DT>change scale and position</DT>
 
1069
<DD><B>WxH+X+Y</B><BR>
 
1070
<B>WxH+X</B> (== <B>WxH+X+X</B>)<BR>
 
1071
<B>WxH</B> (same as <B>WxH+50+50</B>)<BR>
 
1072
<B>W+X+Y</B> (same as <B>WxW+X+Y</B>)<BR>
 
1073
<B>W+X</B> (same as <B>WxW+X+X</B>)<BR>
 
1074
<B>W</B> (same as <B>WxW+50+50</B>)
 
1075
</DD>
 
1076
<DT>change position (absolute)</DT>
 
1077
<DD><B>=+X+Y</B><BR>
 
1078
<B>=+X</B> (same as <B>=+X+Y</B>)
 
1079
</DD>
 
1080
<DT>change position (relative)</DT>
 
1081
<DD><B>+X+Y</B><BR>
 
1082
<B>+X</B> (same as <B>+X+Y</B>)
 
1083
</DD>
 
1084
<DT>rescale (relative)</DT>
 
1085
<DD>
 
1086
<B>Wx0</B> -&gt; <B>W *= (W/100)</B><BR>
 
1087
<B>0xH</B> -&gt; <B>H *= (H/100)</B></DD>
 
1088
</DL>
 
1089
<P>
 
1090
 
 
1091
For example:
 
1092
<DL>
 
1093
<DT><B>\E]20;funky\a</B></DT>
 
1094
<DD>load <B>funky.xpm</B> as a tiled image</DD>
 
1095
<DT><B>\E]20;mona;100\a</B></DT>
 
1096
<DD>load <B>mona.xpm</B> with a scaling of 100%</DD>
 
1097
<DT><B>\E]20;;200;?\a</B></DT>
 
1098
<DD>rescale the current pixmap to 200% and display the image geometry
 
1099
in the title</DD>
 
1100
</DL>
 
1101
<P>
 
1102
 
 
1103
<HR>
 
1104
<H2><A HREF="#toc" NAME="Mouse">Mouse Reporting</A></H2>
 
1105
<P>
 
1106
 
 
1107
<DL>
 
1108
<DT><B><TT>ESC [ M &lt;b&gt; &lt;x&gt; &lt;y&gt;</TT></B></DT>
 
1109
<DD>report mouse position</DD>
 
1110
</DL>
 
1111
<P>
 
1112
 <P>
 
1113
The lower 2 bits of <B><TT>&lt;b&gt;</TT></B> indicate the button:
 
1114
<DL>
 
1115
<DT>Button = <B><TT>&lt;b&gt; &amp; 3 - SPACE</TT></B></DT>
 
1116
<DD>
 
1117
0 = Button1 pressed<BR>
 
1118
1 = Button2 pressed<BR>
 
1119
2 = Button3 pressed<BR>
 
1120
3 = button released (X11 mouse report)</DD>
 
1121
</DL>
 
1122
The upper bits of <B><TT>&lt;b&gt;</TT></B> indicate the modifiers when
 
1123
the button was pressed and are added together (X11 mouse report only):
 
1124
<DL>
 
1125
<DT>State = <B><TT>&lt;b&gt; &amp; 28 - SPACE</TT></B></DT>
 
1126
<DD>
 
1127
4 = Shift<BR>
 
1128
8 = Meta<BR>
 
1129
16 = Control<BR>
 
1130
Col = <B><TT>&lt;x&gt; - SPACE</TT></B><BR>
 
1131
Row = <B><TT>&lt;y&gt; - SPACE</TT></B>
 
1132
</DD>
 
1133
</DL>
 
1134
 
 
1135
<HR>
 
1136
<H2><A HREF="#toc" NAME="Graphics">Special Graphics Mode</A></H2>
 
1137
 
 
1138
Add more documentation here, <EM>if anyone actually cares.</EM> <P>
 
1139
 
 
1140
<DL>
 
1141
<DT><B><TT>ESC G Q</TT></B></DT>
 
1142
<DD>query if graphics are available<BR>
 
1143
returns: <B><TT>ESC G 0</TT></B> no graphics available<BR>
 
1144
returns: <B><TT>ESC G 1</TT></B> graphics available (color only)</DD>
 
1145
</DL>
 
1146
<DL>
 
1147
<DT><B><TT>ESC G W &lt;x&gt;;&lt;y&gt;;&lt;w&gt;;&lt;h&gt;:</TT></B></DT>
 
1148
<DD>create window</DD>
 
1149
</DL>
 
1150
<P>
 
1151
 
 
1152
<DL>
 
1153
<DT><B><TT>ESC G C &lt;id&gt;</TT></B></DT>
 
1154
<DD>clear window</DD>
 
1155
</DL>
 
1156
<P>
 
1157
 
 
1158
<DL>
 
1159
<DT><B><TT>ESC G G &lt;id&gt;:</TT></B></DT>
 
1160
<DD>query window<BR>
 
1161
returns: <B><TT>ESC G &lt;id&gt; &lt;x&gt; &lt;y&gt; &lt;w&gt; &lt;h&gt; &lt;fw&gt; &lt;fh&gt; &lt;nw&gt; &lt;nh&gt;</TT></B>
 
1162
</DD>
 
1163
</DL>
 
1164
<P>
 
1165
 
 
1166
<DL>
 
1167
<DT><B><TT>
 
1168
ESC G L &lt;id&gt;<BR>
 
1169
ESC G P &lt;id&gt;<BR>
 
1170
ESC G F &lt;id&gt;
 
1171
</TT></B></DT>
 
1172
<DD>
 
1173
start point<BR>
 
1174
start line<BR>
 
1175
start fill
 
1176
</DD>
 
1177
</DL>
 
1178
<P>
 
1179
 
 
1180
<DL>
 
1181
<DT><B><TT>;&lt;x&gt;;&lt;y&gt;</TT></B></DT>
 
1182
<DD>extend point/line/fill</DD>
 
1183
</DL>
 
1184
 
 
1185
<P>
 
1186
<DL>
 
1187
<DT><B><TT>ESC G T &lt;id&gt;;&lt;x&gt;;&lt;y&gt;;&lt;mode&gt;;&lt;len&gt;:&lt;text&gt;</TT></B></DT>
 
1188
<DD>place text</DD>
 
1189
</DL>
 
1190
<P>
 
1191
 
 
1192
<HR>
 
1193
<H2><A HREF="#toc" NAME="KeyCodes">Key Codes</A></H2>
 
1194
<P>
 
1195
 
 
1196
Note: <B>Shift</B> + <B>F1</B>-<B>F10</B> generates <B>F11</B>-<B>F20</B>
 
1197
<P>
 
1198
For the keypad, use <B>Shift</B> to temporarily override
 
1199
Application-Keypad setting use <B>Num_Lock</B> to toggle
 
1200
Application-Keypad setting if <B>Num_Lock</B> is off,
 
1201
<A HREF="#ESC=">escape sequences</A> toggle Application-Keypad setting.
 
1202
Also note that values of <B>Home</B>, <B>End</B>, <B>Delete</B>
 
1203
may have been compiled differently on your system.
 
1204
 
 
1205
<TABLE CELLPADDING=5 WIDTH="100%" >
 
1206
<TR>
 
1207
<TD></TD>
 
1208
<TD><B>Normal<B></TD>
 
1209
<TD><B>Shift<B></TD>
 
1210
<TD><B>Control<B></TD>
 
1211
<TD><B>Ctrl+Shift<B></TD>
 
1212
</TR>
 
1213
<TR><TD>Tab      </TD><TD>^I       </TD><TD>ESC [ Z</TD><TD>^I       </TD><TD>ESC [ Z</TD></TR>
 
1214
<TR><TD>BackSpace</TD><TD>^H       </TD><TD>^?         </TD><TD>^?</TD><TD>^?</TD></TR>
 
1215
<TR><TD>Find     </TD><TD>ESC [ 1 ~</TD><TD>ESC [ 1 $  </TD><TD>ESC [ 1 ^</TD><TD>ESC [ 1 @</TD></TR>
 
1216
<TR><TD>Insert   </TD><TD>ESC [ 2 ~</TD><TD><I>paste</I></TD><TD>ESC [ 2 ^</TD><TD>ESC [ 2 @</TD></TR>
 
1217
<TR><TD>Execute  </TD><TD>ESC [ 3 ~</TD><TD>ESC [ 3 $  </TD><TD>ESC [ 3 ^</TD><TD>ESC [ 3 @</TD></TR>
 
1218
<TR><TD>Select   </TD><TD>ESC [ 4 ~</TD><TD>ESC [ 4 $  </TD><TD>ESC [ 4 ^</TD><TD>ESC [ 4 @</TD></TR>
 
1219
<TR><TD>Prior    </TD><TD>ESC [ 5 ~</TD><TD><I>scroll-up</I></TD><TD>ESC [ 5 ^</TD><TD>ESC [ 5 @</TD></TR>
 
1220
<TR><TD>Next     </TD><TD>ESC [ 6 ~</TD><TD><I>scroll-down</I></TD><TD>ESC [ 6 ^</TD><TD>ESC [ 6 @</TD></TR>
 
1221
<TR><TD>Home     </TD><TD>ESC [ 7 ~</TD><TD>ESC [ 7 $  </TD><TD>ESC [ 7 ^</TD><TD>ESC [ 7 @</TD></TR>
 
1222
<TR><TD>End      </TD><TD>ESC [ 8 ~</TD><TD>ESC [ 8 $  </TD><TD>ESC [ 8 ^</TD><TD>ESC [ 8 @</TD></TR>
 
1223
<TR><TD>Delete   </TD><TD>ESC [ 3 ~</TD><TD>ESC [ 3 $  </TD><TD>ESC [ 3 ^</TD><TD>ESC [ 3 @</TD></TR>
 
1224
 
 
1225
<TR><TD>F1 </TD><TD>ESC [ 11 ~</TD><TD>ESC [ 23 ~</TD><TD>ESC [ 11 ^</TD><TD>ESC [ 23 ^</TD></TR>
 
1226
<TR><TD>F2 </TD><TD>ESC [ 12 ~</TD><TD>ESC [ 24 ~</TD><TD>ESC [ 12 ^</TD><TD>ESC [ 24 ^</TD></TR>
 
1227
<TR><TD>F3 </TD><TD>ESC [ 13 ~</TD><TD>ESC [ 25 ~</TD><TD>ESC [ 13 ^</TD><TD>ESC [ 25 ^</TD></TR>
 
1228
<TR><TD>F4 </TD><TD>ESC [ 14 ~</TD><TD>ESC [ 26 ~</TD><TD>ESC [ 14 ^</TD><TD>ESC [ 26 ^</TD></TR>
 
1229
<TR><TD>F5 </TD><TD>ESC [ 15 ~</TD><TD>ESC [ 28 ~</TD><TD>ESC [ 15 ^</TD><TD>ESC [ 28 ^</TD></TR>
 
1230
<TR><TD>F6 </TD><TD>ESC [ 17 ~</TD><TD>ESC [ 29 ~</TD><TD>ESC [ 17 ^</TD><TD>ESC [ 29 ^</TD></TR>
 
1231
<TR><TD>F7 </TD><TD>ESC [ 18 ~</TD><TD>ESC [ 31 ~</TD><TD>ESC [ 18 ^</TD><TD>ESC [ 31 ^</TD></TR>
 
1232
<TR><TD>F8 </TD><TD>ESC [ 19 ~</TD><TD>ESC [ 32 ~</TD><TD>ESC [ 19 ^</TD><TD>ESC [ 32 ^</TD></TR>
 
1233
<TR><TD>F9 </TD><TD>ESC [ 20 ~</TD><TD>ESC [ 33 ~</TD><TD>ESC [ 20 ^</TD><TD>ESC [ 33 ^</TD></TR>
 
1234
<TR><TD>F10</TD><TD>ESC [ 21 ~</TD><TD>ESC [ 34 ~</TD><TD>ESC [ 21 ^</TD><TD>ESC [ 34 ^</TD></TR>
 
1235
<TR><TD>F11</TD><TD>ESC [ 23 ~</TD><TD>ESC [ 23 $</TD><TD>ESC [ 23 ^</TD><TD>ESC [ 23 @</TD></TR>
 
1236
<TR><TD>F12</TD><TD>ESC [ 24 ~</TD><TD>ESC [ 24 $</TD><TD>ESC [ 24 ^</TD><TD>ESC [ 24 @</TD></TR>
 
1237
<TR><TD>F13</TD><TD>ESC [ 25 ~</TD><TD>ESC [ 25 $</TD><TD>ESC [ 25 ^</TD><TD>ESC [ 25 @</TD></TR>
 
1238
<TR><TD>F14</TD><TD>ESC [ 26 ~</TD><TD>ESC [ 26 $</TD><TD>ESC [ 26 ^</TD><TD>ESC [ 26 @</TD></TR>
 
1239
<TR><TD>F15 (Help)</TD><TD>ESC [ 28 ~</TD><TD>ESC [ 28 $</TD><TD>ESC [ 28 ^</TD><TD>ESC [ 28 @</TD></TR>
 
1240
<TR><TD>F16 (Menu)</TD><TD>ESC [ 29 ~</TD><TD>ESC [ 29 $</TD><TD>ESC [ 29 ^</TD><TD>ESC [ 29 @</TD></TR>
 
1241
<TR><TD>F17</TD><TD>ESC [ 31 ~</TD><TD>ESC [ 31 $</TD><TD>ESC [ 31 ^</TD><TD>ESC [ 31 @</TD></TR>
 
1242
<TR><TD>F18</TD><TD>ESC [ 32 ~</TD><TD>ESC [ 32 $</TD><TD>ESC [ 32 ^</TD><TD>ESC [ 32 @</TD></TR>
 
1243
<TR><TD>F19</TD><TD>ESC [ 33 ~</TD><TD>ESC [ 33 $</TD><TD>ESC [ 33 ^</TD><TD>ESC [ 33 @</TD></TR>
 
1244
<TR><TD>F20</TD><TD>ESC [ 34 ~</TD><TD>ESC [ 34 $</TD><TD>ESC [ 34 ^</TD><TD>ESC [ 34 @</TD></TR>
 
1245
<TR>
 
1246
<TD></TD><TD></TD><TD></TD><TD></TD>
 
1247
<TD><B>Application</B></TD>
 
1248
</TR>
 
1249
<TR><TD>Up   </TD><TD>ESC [ A</TD><TD>ESC [ a</TD><TD>ESC O a</TD><TD>ESC O A</TD></TR>
 
1250
<TR><TD>Down </TD><TD>ESC [ B</TD><TD>ESC [ b</TD><TD>ESC O b</TD><TD>ESC O B</TD></TR>
 
1251
<TR><TD>Right</TD><TD>ESC [ C</TD><TD>ESC [ c</TD><TD>ESC O c</TD><TD>ESC O C</TD></TR>
 
1252
<TR><TD>Left </TD><TD>ESC [ D</TD><TD>ESC [ d</TD><TD>ESC O d</TD><TD>ESC O D</TD></TR>
 
1253
<TR><TD>KP_Enter</TD><TD>^M</TD><TD></TD><TD></TD><TD>ESC O M</TD></TR>
 
1254
<TR><TD>KP_F1</TD><TD>ESC O P</TD><TD></TD><TD></TD><TD>ESC O P</TD></TR>
 
1255
<TR><TD>KP_F2</TD><TD>ESC O Q</TD><TD></TD><TD></TD><TD>ESC O Q</TD></TR>
 
1256
<TR><TD>KP_F3</TD><TD>ESC O R</TD><TD></TD><TD></TD><TD>ESC O R</TD></TR>
 
1257
<TR><TD>KP_F4</TD><TD>ESC O S</TD><TD></TD><TD></TD><TD>ESC O S</TD></TR>
 
1258
<TR><TD>XK_KP_Multiply </TD><TD>*</TD><TD></TD><TD></TD><TD>ESC O j</TD></TR>
 
1259
<TR><TD>XK_KP_Add      </TD><TD>+</TD><TD></TD><TD></TD><TD>ESC O k</TD></TR>
 
1260
<TR><TD>XK_KP_Separator</TD><TD>,</TD><TD></TD><TD></TD><TD>ESC O l</TD></TR>
 
1261
<TR><TD>XK_KP_Subtract </TD><TD>-</TD><TD></TD><TD></TD><TD>ESC O m</TD></TR>
 
1262
<TR><TD>XK_KP_Decimal  </TD><TD>.</TD><TD></TD><TD></TD><TD>ESC O n</TD></TR>
 
1263
<TR><TD>XK_KP_Divide   </TD><TD>/</TD><TD></TD><TD></TD><TD>ESC O o</TD></TR>
 
1264
<TR><TD>XK_KP_0        </TD><TD>0</TD><TD></TD><TD></TD><TD>ESC O p</TD></TR>
 
1265
<TR><TD>XK_KP_1        </TD><TD>1</TD><TD></TD><TD></TD><TD>ESC O q</TD></TR>
 
1266
<TR><TD>XK_KP_2        </TD><TD>2</TD><TD></TD><TD></TD><TD>ESC O r</TD></TR>
 
1267
<TR><TD>XK_KP_3        </TD><TD>3</TD><TD></TD><TD></TD><TD>ESC O s</TD></TR>
 
1268
<TR><TD>XK_KP_4        </TD><TD>4</TD><TD></TD><TD></TD><TD>ESC O t</TD></TR>
 
1269
<TR><TD>XK_KP_5        </TD><TD>5</TD><TD></TD><TD></TD><TD>ESC O u</TD></TR>
 
1270
<TR><TD>XK_KP_6        </TD><TD>6</TD><TD></TD><TD></TD><TD>ESC O v</TD></TR>
 
1271
<TR><TD>XK_KP_7        </TD><TD>7</TD><TD></TD><TD></TD><TD>ESC O w</TD></TR>
 
1272
<TR><TD>XK_KP_8        </TD><TD>8</TD><TD></TD><TD></TD><TD>ESC O x</TD></TR>
 
1273
<TR><TD>XK_KP_9        </TD><TD>9</TD><TD></TD><TD></TD><TD>ESC O y</TD></TR>
 
1274
</TABLE>
 
1275
 
 
1276
<P><HR><ADDRESS>
 
1277
Mark Olesen<BR>
 
1278
Fri Feb 14 14:16:00 1997
 
1279
</ADDRESS>
 
1280
</BODY>
 
1281
</HTML>