File: rxvtRef.txt

package info (click to toggle)
rxvt 1%3A2.7.10-6
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,068 kB
  • ctags: 4,415
  • sloc: ansic: 23,997; sh: 6,606; makefile: 649; perl: 33
file content (916 lines) | stat: -rw-r--r-- 27,465 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916

TITLE INFORMATION: Rxvt Technical Reference 
AUTHOR INFORMATION: Geoff Wing (gcw@pobox.com) 
DATE INFORMATION: 18 April 1998 

    o Definitions
    o Values
    o Escape Sequences
    o CSI (Code Sequence Introducer) Sequences
    o DEC Private Modes
    o XTerm Operating System Commands
    o menuBar
    o XPM
    o Mouse Reporting
    o Special Graphics Mode
    o Key Codes

Reworked from XTerm documentation and other sources

Definitions

    o c
        The literal character c.

    o C
        A single (required) character.

    o Ps
        A single (usually optional) numeric parameter, composed of one or
	more digits.

    o Pm
        A multiple numeric parameter composed of any number of single numeric
	parameters, separated by ; character(s).

    o Pt
        A text parameter composed of printable characters.

Top

Values

    o ENQ
        Enquiry (Ctrl-E) = Send Device Attributes (DA) 
        request attributes from terminal == ESC[Psc

    o BEL
        Bell (Ctrl-G)

    o BS
        Backspace (Ctrl-H)

    o TAB
        Horizontal Tab (HT) (Ctrl-I)

    o LF
        Line Feed or New Line (NL) (Ctrl-J)

    o VT
        Vertical Tab (Ctrl-K) same as LF

    o FF
        Form Feed or New Page (NP) (Ctrl-L) same as LF

    o CR
        Carriage Return (Ctrl-M)

    o SO
        Shift Out (Ctrl-N), invokes the G1 character set. 
        Switch to Alternate Character Set

    o SI
        Shift In (Ctrl-O), invokes the G0 character set (the default) 
        Switch to Standard Character Set

    o SPC
        Space Character

Top

Escape Sequences

    o ESC # 8
        DEC Screen Alignment Test (DECALN)

    o ESC 7
      ESC 8
        Save Cursor (SC)
        Restore Cursor

    o ESC =
      ESC >
        Application Keypad (SMKX) == ESC[?66h
        Normal Keypad (RMKX) == ESC[?66l
    Note: If the numeric keypad is activated, eg, Num_Lock has been
    pressed, numbers or control functions are generated by the numeric keypad
    (see Key Codes)

    o ESC D
        Index (IND)

    o ESC E
        Next Line (NEL)

    o ESC H
        Tab Set (HTS)

    o ESC M
        Reverse Index (RI)

    o ESC N
        Single Shift Select of G2 Character Set (SS2): affects next character
	only unimplemented

    o ESC O
        Single Shift Select of G3 Character Set (SS3): affects next character
	only unimplemented

    o ESC Z
        Obsolete form of ESC[c 
        returns: ESC[?1;2C rxvt compile-time option

    o ESC c
        Full reset (RIS)

    o ESC n
        Invoke the G2 Character Set (LS2)

    o ESC o
        Invoke the G3 Character Set (LS3)

    o ESC ( C
      ESC ) C
      ESC * C
      ESC + C
      ESC $ C
        Designate G0 Character Set (ISO 2022)
        Designate G1 Character Set (ISO 2022)
        Designate G2 Character Set (ISO 2022)
        Designate G3 Character Set (ISO 2022)
        Designate Kanji Character Set 
        where C is 
         C = 0  DEC Special Character and Line Drawing Set 
         C = A  United Kingdom (UK) 
         C = B  United States (USASCII) 
         C = <  Multinational character set unimplemented 
         C = 5  Finnish character set unimplemented 
         C = C  Finnish character set unimplemented 
         C = K  German character set unimplemented 

Top

CSI (Code Sequence Introducer) Sequences

    o ESC [ Ps @
        Insert Ps (Blank) Character(s) [default: 1] (ICH)

    o ESC [ Ps A
        Cursor Up Ps Times [default: 1] (CUU)

    o ESC [ Ps B
        Cursor Down Ps Times [default: 1] (CUD)
    o ESC [ Ps C
        Cursor Forward Ps Times [default: 1] (CUF)

    o ESC [ Ps D
        Cursor Backward Ps Times [default: 1] (CUB)

    o ESC [ Ps E
        Cursor Down Ps Times [default: 1] and to first column

    o ESC [ Ps F
        Cursor Up Ps Times [default: 1] and to first column

    o ESC [ Ps G
        Cursor to Column Ps (HPA)

    o ESC [ Ps;Ps H
        Cursor Position [row;column] [default: 1;1] (CUP)

    o ESC [ Ps I
        Move forward Ps tab stops [default: 1]

    o ESC [ Ps J
        Erase in Display (ED) 
         Ps = 0  Clear Below (default) 
         Ps = 1  Clear Above 
         Ps = 2  Clear All 

    o ESC [ Ps K
        Erase in Line (EL) 
         Ps = 0  Clear to Right (default) 
         Ps = 1  Clear to Left 
         Ps = 2  Clear All 

    o ESC [ Ps L
        Insert Ps Line(s) [default: 1] (IL)

    o ESC [ Ps M
        Delete Ps Line(s) [default: 1] (DL)

    o ESC [ Ps P
        Delete Ps Character(s) [default: 1] (DCH)

    o ESC [ Ps;Ps;Ps;Ps;Ps T
        Initiate hilite mouse tracking.  unimplemented
	Parameters are [func;startx;starty;firstrow;lastrow].

    o ESC [ Ps W
        Tabulator functions 
         Ps = 0  Tab Set (HTS) 
         Ps = 2  Tab Clear (TBC), Clear Current Column (default) 
         Ps = 5  Tab Clear (TBC), Clear All 

    o ESC [ Ps X
        Erase Ps Character(s) [default: 1] (ECH)

    o ESC [ Ps Z
        Move backward Ps [default: 1] tab stops

    o ESC [ Ps '
        == ESC [ Ps G

    o ESC [ Ps a
        == ESC [ Ps C

    o ESC [ Ps c
        Send Device Attributes (DA)
        Ps = 0 (or omitted) : request attributes from terminal 
        returns: ESC[?1;2c (``I am a VT100 with Advanced Video
	Option'')

    o ESC [ Ps d
        Cursor to Line Ps (VPA)

    o ESC [ Ps e
        == ESC [ Ps A

    o ESC [ Ps;Ps f
        Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]

    o ESC [ Ps g
        Tab Clear (TBC) 
         Ps = 0  Clear Current Column (default) 
         Ps = 3  Clear All (TBC) 

    o ESC [ Ps i
        Printing 
         Ps = 4  disable transparent print mode (MC4) 
         Ps = 5  enable transparent print mode (MC5) unimplemented 

    o ESC [ Pm h
      ESC [ Pm l
        Set Mode (SM) 
        Reset Mode (RM)
	    o Ps = 4
                 h  Insert Mode (SMIR) 
                 l  Replace Mode (RMIR) 

	    o Ps = 20 unimplemented
                 h  Automatic Newline (LNM) 
                 h  Normal Linefeed (LNM) 

    o ESC [ Pm m
        Character Attributes (SGR) 
         Ps = 0  Normal (default) 
         Ps = 1 / 22  On / Off Bold (bright fg) 
         Ps = 4 / 24  On / Off Underline 
         Ps = 5 / 25  On / Off Blink (bright bg) 
         Ps = 7 / 27  On / Off Inverse 
         Ps = 30 / 40  fg/bg Black 
         Ps = 31 / 41  fg/bg Red 
         Ps = 32 / 42  fg/bg Green 
         Ps = 33 / 43  fg/bg Yellow 
         Ps = 34 / 44  fg/bg Blue 
         Ps = 35 / 45  fg/bg Magenta 
         Ps = 36 / 46  fg/bg Cyan 
         Ps = 37 / 47  fg/bg White 
         Ps = 39 / 49  fg/bg Default 

    o ESC [ Ps n
        Device Status Report (DSR) 
         Ps = 5  Status Report ESC [ 0 n (``OK'') 
         Ps = 6  Report Cursor Position (CPR) [row;column] as ESC [ r ; c R 
         Ps = 7  Request Display Name 
         Ps = 8  Request Version Number (place in window title) 

    o ESC [ Ps;Ps r
        Set Scrolling Region [top;bottom] 
        [default: full size of window] (CSR)

    o ESC [ s
        Save Cursor (SC)

    o ESC [ Ps x
        Request Terminal Parameters (DECREQTPARM)

    o ESC [ u
        Restore Cursor

Top

DEC Private Modes

    o ESC [ ? Pm h
        DEC Private Mode Set (DECSET)

    o ESC [ ? Pm l
        DEC Private Mode Reset (DECRST)

    o ESC [ ? Pm r
        Restore previously saved DEC Private Mode Values.

    o ESC [ ? Pm s
        Save DEC Private Mode Values.

    o ESC [ ? Pm t
        Toggle DEC Private Mode Values (rxvt extension).
    where 

        o Ps = 1 (DECCKM)
             h  Application Cursor Keys 
             l  Normal Cursor Keys 

        o Ps = 2 (ANSI/VT52 mode)
             h  Enter VT52 mode 
             l  Enter VT52 mode 

        o Ps = 3
             h  132 Column Mode (DECCOLM) 
             l  80 Column Mode (DECCOLM) 

        o Ps = 4
             h  Smooth (Slow) Scroll (DECSCLM) 
             l  Jump (Fast) Scroll (DECSCLM) 

        o Ps = 5
             h  Reverse Video (DECSCNM) 
             l  Normal Video (DECSCNM) 

        o Ps = 6
             h  Origin Mode (DECOM) 
             l  Normal Cursor Mode (DECOM) 

        o Ps = 7
             h  Wraparound Mode (DECAWM) 
             l  No Wraparound Mode (DECAWM) 

        o Ps = 8 unimplemented
             h  Auto-repeat Keys (DECARM) 
             l  No Auto-repeat Keys (DECARM) 

        o Ps = 9 X10 XTerm mouse reporting
             h  Send Mouse X & Y on button press. 
             l  No mouse reporting. 

        o Ps = 10 (rxvt)
             h  menuBar visible 
             l  menuBar invisible 

        o Ps = 25
             h  Visible cursor {cnorm/cvvis} 
             l  Invisible cursor {civis} 

        o Ps = 30
             h  scrollBar visisble 
             l  scrollBar invisisble 

        o Ps = 35 (rxvt)
             h  Allow XTerm Shift+key sequences 
             l  Disallow XTerm Shift+key sequences 

        o Ps = 38 unimplemented
            Enter Tektronix Mode (DECTEK)
        o Ps = 40
             h  Allow 80/132 Mode 
             l  Disallow 80/132 Mode 

        o Ps = 44 unimplemented
             h  Turn On Margin Bell 
             l  Turn Off Margin Bell 

        o Ps = 45 unimplemented
             h  Reverse-wraparound Mode 
             l  No Reverse-wraparound Mode 

        o Ps = 46 unimplemented

        o Ps = 47
             h  Use Alternate Screen Buffer 
             l  Use Normal Screen Buffer 

        o Ps = 66
             h  Application Keypad (DECPAM) == ESC = 
             l  Normal Keypad (DECPNM) == ESC > 

        o Ps = 67
             h  Backspace key sends BS (DECBKM) 
             l  Backspace key sends DEL 

        o Ps = 1000 (X11 XTerm mouse reporting)
             h  Send Mouse X & Y on button press and release. 
             l  No mouse reporting. 

        o Ps = 1001 (X11 XTerm mouse tracking) unimplemented
             h  Use Hilite Mouse Tracking. 
             l  No mouse reporting. 

        o Ps = 1010
             h  Don't scroll to bottom on TTY output 
             l  Scroll to bottom on TTY output 

        o Ps = 1011
             h  Scroll to bottom when a key is pressed 
             l  Don't scroll to bottom when a key is pressed 

        o Ps = 1047
             h  Use Alternate Screen Buffer 
             l  Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 

        o Ps = 1048
             h  Save cursor position 
             l  Restore cursor position 

Top

XTerm Operating System Commands

    o ESC ] Ps;Pt ST
        Set XTerm Parameters 
        8-bit ST: 0x9c, 
        7-bit ST sequence: ESC \ (0x1b, 0x5c), 
        backwards compatible terminator BEL (0x07) is also accepted. 
         Ps = 0  Change Icon Name and Window Title to Pt 
         Ps = 1  Change Icon Name to Pt 
         Ps = 2  Change Window Title to Pt 
         Ps = 4  Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour.  Each pair causes the numbered colour to be changed to name.  
        Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 
         Ps = 10 (NB: may change in future)  menuBar command Pt rxvt compile-time option 
         Ps = 12  Change colour of text cursor foreground to Pt 
         Ps = 13  Change colour of mouse foreground to Pt 
         Ps = 17  Change colour of highlight characters to Pt 
         Ps = 18  Change colour of bold characters to Pt 
         Ps = 19  Change colour of underlined characters to Pt 
         Ps = 20  Change default background pixmap to Pt 
         Ps = 39  Change default foreground colour to Pt rxvt compile-time option 
         Ps = 46  Change Log File to Pt unimplemented 
         Ps = 49  Change default background colour to Pt rxvt compile-time option 
         Ps = 50  Set Font to Pt, with the following special values of Pt (rxvt) 
        #+n change up n font(s) 
        #-n change down n font(s) 
        if n is missing of 0, a value of 1 is used 
        empty change to font0 
        n change to font n 
         Ps = 55  Log all scrollback buffer and all of screen to Pt 

Top

menuBar

The exact syntax used is almost solidified. 
In the menus, DON'T try to use menuBar commands that add or remove a
menuBar.

Note that in all of the commands, the /path/ cannot be omitted:
use ./ to specify a menu relative to the current menu.

Overview of menuBar operation

For the menuBar XTerm escape sequence ESC ] 10 ; Pt ST, the
syntax of Pt can be used for a variety of tasks:

    o Commands
    o Adding and accessing menus
    o Removing menus
    o Quick Arrows
    o Command Summary

At the top level is the current menuBar which is a member of a circular
linked-list of other such menuBars.

The menuBar acts as a parent for the various drop-down menus, which in turn,
may have labels, separator lines, menuItems and subMenus.

The menuItems are the useful bits: you can use them to mimic keyboard input
or even to send text or escape sequences back to rxvt.

The menuBar syntax is intended to provide a simple yet robust method of
constructing and manipulating menus and navigating through the menuBars.

The first step is to use the tag [menu:name] which creates the
menuBar called name and allows access.
You may now add or remove menus,
subMenus, and menuItems. Finally, use the tag [done] to set the menuBar
access as readonly to prevent accidental corruption of the menus.
To re-access the current menuBar for alterations, use the tag [menu],
make the alterations and then use [done]

Commands

    o [menu:name]
        access the named menuBar for creation or alteration. If a new menuBar
	is created, it is called name (max of 15 chars) and the current
	menuBar is pushed onto the stack

    o [menu]
        access the current menuBar for alteration

    o [title:string]
        set the current menuBar's title to string, which may contain the
	following format specifiers: 
        %% : literal % character 
        %n : rxvt name (as per the -name command-line option) 
        %v : rxvt version

    o [done]
        set menuBar access as readonly. 
        End-of-file tag for [read:file] operations.

    o [read:file]
        read menu commands directly from file (extension ".menu" will be
	appended if required.) Start reading at a line with [menu] or
	[menu:name and continuing until [done] is encountered.

	Blank and comment lines (starting with #) are ignored.
	Actually, since any invalid menu commands are also ignored, almost
	anything could be construed as a comment line, but this may be
	tightened up in the future ... so don't count on it!.

    o [read:file;name]
        The same as [read:file], but start reading at a line with
	[menu:name] and continuing until [done:name] or
	[done] is encountered.

    o [dump]
        dump all menuBars to the file /tmp/rxvt-PID in a format suitable
	for later rereading.

    o [rm:name]
      [rm] [rm:]
      [rm*] [rm:*]
        remove the named menuBar 
        remove the current menuBar 
        remove all menuBars

    o [swap]
        swap the top two menuBars

    o [prev]
      [next]
        access the previous or next menuBar

    o [show]
      [hide]
        control display of the menuBar ... just like
	ESC[?10 h/l

    o [pixmap:name]
      [pixmap:name;scaling]
        set the background pixmap globally ... just like
	ESC ] 20 ; Pt ST

	A Future implementation may make this local to the menubar

    o [:command:]
        ignore the menu readonly status and issue a command to
	Add/Modify or Remove a menu or
	menuitem or change the Quick Arrows; a useful
	shortcut for setting the quick arrows from a menuBar.

Adding and accessing menus

The following commands may also be + prefixed.

    o /
      ./
      ../
      ../../
        access menuBar top level 
        access current menu level 
        access parent menu (1 level up) 
        access parent menu (multiple levels up)
    o /path/menu
        add/access menu
    o /path/menu/*
        add/access menu and clear it if it exists
    o /path/{-}
        add separator
    o /path/{item}
        add item as a label
    o /path/{item} action
        add/alter menuitem with an associated action
    o /path/{item}{right-text}
        add/alter menuitem with right-text as the right-justified
	text and as the associated action
    o /path/{item}{rtext} action
        add/alter menuitem with an associated action and with
	rtext as the right-justified text.

    o Special characters in action must be backslash-escaped:
        \a \b \E \e \n \r \t \octal
    o or in control-character notation:
        ^@, ^A .. ^Z .. ^_, ^?

To send a string starting with a NUL (^@) character to the program,
start action with a pair of NUL characters (^@^@), the first of
which will be stripped off and the balance directed to the program.
Otherwise if action begins with NUL followed by non-NUL
characters, the leading NUL is stripped off and the balance is sent back
to rxvt.

As a convenience for the many Emacs-type editors, action may start
with M- (eg, M-$ is equivalent to \E$) and a CR will be
appended if missed from M-x commands.

As a convenience for issuing XTerm ESC] sequences from a menubar
(or quick arrow), a BEL (^G) will be appended if needed.

    o For example,
        M-xapropos is equivalent to \Exapropos\r
    o and
        \E]10;mona;100 is equivalent to \E]10;mona;100\a

The option {right-rtext} will be right-justified.  In the absence of
a specified action, this text will be used as the action as well.

    o For example,
        /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F

The left label is necessary, since it's used for matching,
but implicitly hiding the left label (by using same name for both left
and right labels), or explicitly hiding the left label (by preceeding
it with a dot), makes it possible to have right-justified text only.

    o For example,
        /File/{Open}{Open} Open-File-Action
    o or hiding it
        /File/{.anylabel}{Open} Open-File-Action

Removing menus

    o -/*
      -/pathmenu
      -/path{item}
      -/path{-}
        remove all menus from the menuBar, the same as [clear]
        remove menu 
        remove item 
        remove separator
    o -/path/menu/*
        remove all items, separators and submenus from menu

Quick Arrows

The menus also provide a hook for quick arrows to provide easier user
access. If nothing has been explicitly set, the default is to emulate the
curror keys. The syntax permits each arrow to be altered individually or
all four at once without re-entering their common beginning/end text. For
example, to explicitly associate cursor actions with the arrows, any of
the following forms could be used:

    o <r>Right
      <l>Left
      <u>Up
      <d>Down
        Define actions for the respective arrow buttons
    o <b>Begin
      <e>End
        Define common beginning/end parts for quick arrows which used
	in conjunction with the above <r> <l> <u> <d> constructs

    o For example, define arrows individually,
        <u>\E[A 
        <d>\E[B 
        <r>\E[C 
        <l>\E[D
    o or all at once
        <u>\E[A<d>\E[B<r>\E[C<l>\E[D
    o or more compactly (factoring out common parts)
        <b>\E[<u>A<d>B<r>C<l>D

Command Summary

A short summary of the most common commands:

    o [menu:name]
        use an existing named menuBar or start a new one
    o [menu]
        use the current menuBar
    o [title:string]
        set menuBar title
    o [done]
        set menu access to readonly and, if reading from a file, signal EOF
    o [done:name]
        if reading from a file using [read:file;name] signal EOF
    o [rm:name]
      [rm] [rm:]
      [rm*] [rm:*]
        remove named, current, or all menuBar(s)
    o [swap]
        swap top two menuBars
    o [prev]
      [next]
        access the previous/next menuBar
    o [show]
      [hide]
        map/unmap menuBar
    o [pixmap;file]
      [pixmap;file;scaling]
        set a background pixmap
    o [read:file]
      [read:file;name]
        read in a menu from a file
    o [dump]
        dump out all menuBars to /tmp/rxvt-PID
    o /
        access menuBar top level
    o ./
      ../
      ../../
        access current or parent menu level
    o /path/menu
        add/access menu
    o /path/{-}
        add separator
    o /path/{item}{rtext} action
        add/alter menu item
        ({rtext} and/or action, may be omitted)
    o -/*
        remove all menus from the menuBar
    o -/path/menu
        remove menu items, separators and submenus from menu
    o -/path/menu
        remove menu
    o -/path/{item}
        remove item
    o -/path/{-}
        remove separator
    o <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
        menu quick arrows

Top

XPM

For the XPM XTerm escape sequence ESC ] 20 ; Pt ST then value of
Pt can be the name of the background pixmap followed by a sequence of
scaling/positioning commands separated by semi-colons. The scaling/positioning
commands are as follows:

    o query scale/position
        ?

    o change scale and position
        WxH+X+Y
        WxH+X (== WxH+X+X)
        WxH (same as WxH+50+50)
        W+X+Y (same as WxW+X+Y)
        W+X (same as WxW+X+X)
        W (same as WxW+50+50)

    o change position (absolute)
        =+X+Y
        =+X (same as =+X+Y)

    o change position (relative)
        +X+Y
        +X (same as +X+Y)

    o rescale (relative)
        Wx0 -> W *= (W/100)
        0xH -> H *= (H/100)

For example:

    o \E]20;funky\a
        load funky.xpm as a tiled image

    o \E]20;mona;100\a
        load mona.xpm with a scaling of 100%

    o \E]20;;200;?\a
        rescale the current pixmap to 200% and display the image geometry in the title

Top

Mouse Reporting

    o ESC [ M <b> <x> <y>
        report mouse position

The lower 2 bits of <b> indicate the button:

    o Button = (<b> - SPACE) & 3
        0 = Button1 pressed 
        1 = Button2 pressed 
        2 = Button3 pressed 
        3 = button released (X11 mouse report)

The upper bits of <b> indicate the modifiers when the button was
pressed and are added together (X11 mouse report only):

    o State = (<b> - SPACE) & 60
        4 = Shift 
        8 = Meta 
        16 = Control 
        32 = Double Click (Rxvt extension) 
        Col = <x> - SPACE 
        Row = <y> - SPACE

Top

Special Graphics Mode

Add more documentation here, if anyone actually cares.

    o ESC G Q
        query if graphics are available 
        returns: ESC G 0 no graphics available 
        returns: ESC G 1 graphics available (colour only)

    o ESC G W <;x>;<y>;<w>;<h>:
        create window

    o ESC G C <id>
        clear window

    o ESC G G <it>:
        query window 
        returns: ESC G <id> <x> <y> <w> <h> <fw> <fh> <nw> <nh>

    o ESC G L <id>
      ESC G P <id>
      ESC G F <id>
        start point 
        start line 
        start fill

    o ;<x>;<y>
        extend point/line/fill

    o ESC G T <id>;<x>;<y>;<mode>;<len>:<text>
        place text

Top

Key Codes

Note: Shift + F1-F10 generates F11-F20

For the keypad, use Shift to temporarily override Application-Keypad
setting use Num_Lock to toggle Application-Keypad setting if Num_Lock
is off, escape sequences toggle Application-Keypad setting.
Also note that values of Home, End, Delete may have been compiled
differently on your system.

                  Normal       Shift        Control      Ctrl+Shift 
 Tab              ^I           ESC [ Z      ^I           ESC [ Z 
 BackSpace        ^H           ^?           ^?           ^? 
 Find             ESC [ 1 ~    ESC [ 1 $    ESC [ 1 ^    ESC [ 1 @ 
 Insert           ESC [ 2 ~    paste        ESC [ 2 ^    ESC [ 2 @ 
 Execute          ESC [ 3 ~    ESC [ 3 $    ESC [ 3 ^    ESC [ 3 @ 
 Select           ESC [ 4 ~    ESC [ 4 $    ESC [ 4 ^    ESC [ 4 @ 
 Prior            ESC [ 5 ~    scroll-up    ESC [ 5 ^    ESC [ 5 @ 
 Next             ESC [ 6 ~    scroll-down  ESC [ 6 ^    ESC [ 6 @ 
 Home             ESC [ 7 ~    ESC [ 7 $    ESC [ 7 ^    ESC [ 7 @ 
 End              ESC [ 8 ~    ESC [ 8 $    ESC [ 8 ^    ESC [ 8 @ 
 Delete           ESC [ 3 ~    ESC [ 3 $    ESC [ 3 ^    ESC [ 3 @ 
 F1               ESC [ 11 ~   ESC [ 23 ~   ESC [ 11 ^   ESC [ 23 ^ 
 F2               ESC [ 12 ~   ESC [ 24 ~   ESC [ 12 ^   ESC [ 24 ^ 
 F3               ESC [ 13 ~   ESC [ 25 ~   ESC [ 13 ^   ESC [ 25 ^ 
 F4               ESC [ 14 ~   ESC [ 26 ~   ESC [ 14 ^   ESC [ 26 ^ 
 F5               ESC [ 15 ~   ESC [ 28 ~   ESC [ 15 ^   ESC [ 28 ^ 
 F6               ESC [ 17 ~   ESC [ 29 ~   ESC [ 17 ^   ESC [ 29 ^ 
 F7               ESC [ 18 ~   ESC [ 31 ~   ESC [ 18 ^   ESC [ 31 ^ 
 F8               ESC [ 19 ~   ESC [ 32 ~   ESC [ 19 ^   ESC [ 32 ^ 
 F9               ESC [ 20 ~   ESC [ 33 ~   ESC [ 20 ^   ESC [ 33 ^ 
 F10              ESC [ 21 ~   ESC [ 34 ~   ESC [ 21 ^   ESC [ 34 ^ 
 F11              ESC [ 23 ~   ESC [ 23 $   ESC [ 23 ^   ESC [ 23 @ 
 F12              ESC [ 24 ~   ESC [ 24 $   ESC [ 24 ^   ESC [ 24 @ 
 F13              ESC [ 25 ~   ESC [ 25 $   ESC [ 25 ^   ESC [ 25 @ 
 F14              ESC [ 26 ~   ESC [ 26 $   ESC [ 26 ^   ESC [ 26 @ 
 F15 (Help)       ESC [ 28 ~   ESC [ 28 $   ESC [ 28 ^   ESC [ 28 @ 
 F16 (Menu)       ESC [ 29 ~   ESC [ 29 $   ESC [ 29 ^   ESC [ 29 @ 
 F17              ESC [ 31 ~   ESC [ 31 $   ESC [ 31 ^   ESC [ 31 @ 
 F18              ESC [ 32 ~   ESC [ 32 $   ESC [ 32 ^   ESC [ 32 @ 
 F19              ESC [ 33 ~   ESC [ 33 $   ESC [ 33 ^   ESC [ 33 @ 
 F20              ESC [ 34 ~   ESC [ 34 $   ESC [ 34 ^   ESC [ 34 @ 
                                                         Application 
 Up               ESC [ A      ESC [ a      ESC O a      ESC O A 
 Down             ESC [ B      ESC [ b      ESC O b      ESC O B 
 Right            ESC [ C      ESC [ c      ESC O c      ESC O C 
 Left             ESC [ D      ESC [ d      ESC O d      ESC O D 
 KP_Enter         ^M                                     ESC O M 
 KP_F1            ESC O P                                ESC O P 
 KP_F2            ESC O Q                                ESC O Q 
 KP_F3            ESC O R                                ESC O R 
 KP_F4            ESC O S                                ESC O S 
 XK_KP_Multiply   *                                      ESC O j 
 XK_KP_Add        +                                      ESC O k 
 XK_KP_Separator  ,                                      ESC O l 
 XK_KP_Subtract   -                                      ESC O m 
 XK_KP_Decimal    .                                      ESC O n 
 XK_KP_Divide     /                                      ESC O o 
 XK_KP_0          0                                      ESC O p 
 XK_KP_1          1                                      ESC O q 
 XK_KP_2          2                                      ESC O r 
 XK_KP_3          3                                      ESC O s 
 XK_KP_4          4                                      ESC O t 
 XK_KP_5          5                                      ESC O u 
 XK_KP_6          6                                      ESC O v 
 XK_KP_7          7                                      ESC O w 
 XK_KP_8          8                                      ESC O x 
 XK_KP_9          9                                      ESC O y 

Top