1 =head1 RXVT TECHNICAL REFERENCE
9 The literal character c.
13 A single (required) character.
17 A single (usually optional) numeric parameter, composed of one or more
22 A multiple numeric parameter composed of any number of single numeric
23 parameters, separated by C<;> character(s).
27 A text parameter composed of printable characters.
37 Enquiry (Ctrl-E) = Send Device Attributes (DA)
38 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
50 Horizontal Tab (HT) (Ctrl-I)
54 Line Feed or New Line (NL) (Ctrl-J)
58 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
62 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
66 Carriage Return (Ctrl-M)
70 Shift Out (Ctrl-N), invokes the G1 character set.
71 Switch to Alternate Character Set
75 Shift In (Ctrl-O), invokes the G0 character set (the default).
76 Switch to Standard Character Set
84 =head1 Escape Sequences
88 =item B<< C<ESC # 8> >>
90 DEC Screen Alignment Test (DECALN)
100 =item B<< C<ESC => >>
102 Application Keypad (SMKX). See also next sequence.
104 =item B<<< C<< ESC >> >>>
108 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
109 pressed, numbers or control functions are generated by the numeric keypad
112 =item B<< C<ESC D> >>
116 =item B<< C<ESC E> >>
120 =item B<< C<ESC H> >>
124 =item B<< C<ESC M> >>
128 =item B<< C<ESC N> >>
130 Single Shift Select of G2 Character Set (SS2): affects next character
131 only I<unimplemented>
133 =item B<< C<ESC O> >>
135 Single Shift Select of G3 Character Set (SS3): affects next character
136 only I<unimplemented>
138 =item B<< C<ESC Z> >>
140 Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>
142 =item B<< C<ESC c> >>
146 =item B<< C<ESC n> >>
148 Invoke the G2 Character Set (LS2)
150 =item B<< C<ESC o> >>
152 Invoke the G3 Character Set (LS3)
154 =item B<< C<ESC>(C<C> >>
156 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
158 =item B<< C<ESC>)C<C> >>
160 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
162 =item B<< C<ESC * C> >>
164 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
166 =item B<< C<ESC + C> >>
168 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
170 =item B<< C<ESC $ C> >>
172 Designate Kanji Character Set
174 Where B<< C<C> >> is one of:
178 C = C<0> DEC Special Character and Line Drawing Set
179 C = C<A> United Kingdom (UK)
180 C = C<B> United States (USASCII)
181 C = C<< < >> Multinational character set I<unimplemented>
182 C = C<5> Finnish character set I<unimplemented>
183 C = C<C> Finnish character set I<unimplemented>
184 C = C<K> German character set I<unimplemented>
192 =head1 CSI (Code Sequence Introducer) Sequences
196 =item B<< C<ESC [ Ps @> >>
198 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
200 =item B<< C<ESC [ Ps A> >>
202 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
204 =item B<< C<ESC [ Ps B> >>
206 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
208 =item B<< C<ESC [ Ps C> >>
210 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
212 =item B<< C<ESC [ Ps D> >>
214 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
216 =item B<< C<ESC [ Ps E> >>
218 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
220 =item B<< C<ESC [ Ps F> >>
222 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
224 =item B<< C<ESC [ Ps G> >>
226 Cursor to Column B<< C<Ps> >> (HPA)
228 =item B<< C<ESC [ Ps;Ps H> >>
230 Cursor Position [row;column] [default: 1;1] (CUP)
232 =item B<< C<ESC [ Ps I> >>
234 Move forward B<< C<Ps> >> tab stops [default: 1]
236 =item B<< C<ESC [ Ps J> >>
238 Erase in Display (ED)
242 B<< C<Ps = 0> >> Clear Below (default)
243 B<< C<Ps = 1> >> Clear Above
244 B<< C<Ps = 2> >> Clear All
248 =item B<< C<ESC [ Ps K> >>
254 B<< C<Ps = 0> >> Clear to Right (default)
255 B<< C<Ps = 1> >> Clear to Left
256 B<< C<Ps = 2> >> Clear All
260 =item B<< C<ESC [ Ps L> >>
262 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
264 =item B<< C<ESC [ Ps M> >>
266 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
268 =item B<< C<ESC [ Ps P> >>
270 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
272 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
274 Initiate . I<unimplemented> Parameters are
275 [func;startx;starty;firstrow;lastrow].
277 =item B<< C<ESC [ Ps W> >>
283 B<< C<Ps = 0> >> Tab Set (HTS)
284 B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default)
285 B<< C<Ps = 5> >> Tab Clear (TBC), Clear All
289 =item B<< C<ESC [ Ps X> >>
291 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
293 =item B<< C<ESC [ Ps Z> >>
295 Move backward B<< C<Ps> >> [default: 1] tab stops
297 =item B<< C<ESC [ Ps '> >>
299 See B<< C<ESC [ Ps G> >>
301 =item B<< C<ESC [ Ps a> >>
303 See B<< C<ESC [ Ps C> >>
305 =item B<< C<ESC [ Ps c> >>
307 Send Device Attributes (DA)
308 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309 returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video
312 =item B<< C<ESC [ Ps d> >>
314 Cursor to Line B<< C<Ps> >> (VPA)
316 =item B<< C<ESC [ Ps e> >>
318 See B<< C<ESC [ Ps A> >>
320 =item B<< C<ESC [ Ps;Ps f> >>
322 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
324 =item B<< C<ESC [ Ps g> >>
330 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC)
335 =item B<< C<ESC [ Ps i> >>
341 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented>
346 =item B<< C<ESC [ Pm h> >>
348 Set Mode (SM). See next sequence for description of C<Pm>.
350 =item B<< C<ESC [ Pm l> >>
356 =item B<< C<Ps = 4> >>
360 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR)
365 =item B<< C<Ps = 20> >> I<unimplemented>
369 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM)
376 =item B<< C<ESC [ Pm m> >>
378 Character Attributes (SGR)
382 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg)
384 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse
387 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan
394 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default
399 =item B<< C<ESC [ Ps n> >>
401 Device Status Report (DSR)
405 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
406 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
407 B<< C<Ps = 7> >> Request Display Name
408 B<< C<Ps = 8> >> Request Version Number (place in window title)
412 =item B<< C<ESC [ Ps;Ps r> >>
414 Set Scrolling Region [top;bottom]
415 [default: full size of window] (CSR)
417 =item B<< C<ESC [ s> >>
421 =item B<< C<ESC [ Ps x> >>
423 Request Terminal Parameters (DECREQTPARM)
425 =item B<< C<ESC [ u> >>
433 =head1 DEC Private Modes
437 =item B<< C<ESC [ ? Pm h> >>
439 DEC Private Mode Set (DECSET)
441 =item B<< C<ESC [ ? Pm l> >>
443 DEC Private Mode Reset (DECRST)
445 =item B<< C<ESC [ ? Pm r> >>
447 Restore previously saved DEC Private Mode Values.
449 =item B<< C<ESC [ ? Pm s> >>
451 Save DEC Private Mode Values.
453 =item B<< C<ESC [ ? Pm t> >>
455 Toggle DEC Private Mode Values (rxvt extension). I<where>
459 =item B<< C<Ps = 1> >> (DECCKM)
463 B<< C<h> >> Application Cursor Keys
464 B<< C<l> >> Normal Cursor Keys
468 =item B<< C<Ps = 2> >> (ANSI/VT52 mode)
472 B<< C<h> >> Enter VT52 mode
473 B<< C<l> >> Enter VT52 mode
477 =item B<< C<Ps = 3> >>
481 B<< C<h> >> 132 Column Mode (DECCOLM)
482 B<< C<l> >> 80 Column Mode (DECCOLM)
486 =item B<< C<Ps = 4> >>
490 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
491 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
495 =item B<< C<Ps = 5> >>
499 B<< C<h> >> Reverse Video (DECSCNM)
500 B<< C<l> >> Normal Video (DECSCNM)
504 =item B<< C<Ps = 6> >>
508 B<< C<h> >> Origin Mode (DECOM)
509 B<< C<l> >> Normal Cursor Mode (DECOM)
513 =item B<< C<Ps = 7> >>
517 B<< C<h> >> Wraparound Mode (DECAWM)
518 B<< C<l> >> No Wraparound Mode (DECAWM)
522 =item B<< C<Ps = 8> >> I<unimplemented>
526 B<< C<h> >> Auto-repeat Keys (DECARM)
527 B<< C<l> >> No Auto-repeat Keys (DECARM)
531 =item B<< C<Ps = 9> >> X10 XTerm
535 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting.
542 =item B<< C<Ps = 10> >> (B<rxvt>)
547 B<< C<l> >> invisible
551 =item B<< C<Ps = 25> >>
555 B<< C<h> >> Visible cursor {cnorm/cvvis}
556 B<< C<l> >> Invisible cursor {civis}
560 =item B<< C<Ps = 30> >>
564 B<< C<h> >> scrollBar visisble
565 B<< C<l> >> scrollBar invisisble
569 =item B<< C<Ps = 35> >> (B<rxvt>)
573 B<< C<h> >> Allow XTerm Shift+key sequences
574 B<< C<l> >> Disallow XTerm Shift+key sequences
578 =item B<< C<Ps = 38> >> I<unimplemented>
580 Enter Tektronix Mode (DECTEK)
582 =item B<< C<Ps = 40> >>
586 B<< C<h> >> Allow 80/132 Mode
587 B<< C<l> >> Disallow 80/132 Mode
591 =item B<< C<Ps = 44> >> I<unimplemented>
595 B<< C<h> >> Turn On Margin Bell
596 B<< C<l> >> Turn Off Margin Bell
600 =item B<< C<Ps = 45> >> I<unimplemented>
604 B<< C<h> >> Reverse-wraparound Mode
605 B<< C<l> >> No Reverse-wraparound Mode
609 =item B<< C<Ps = 46> >> I<unimplemented>
611 =item B<< C<Ps = 47> >>
615 B<< C<h> >> Use Alternate Screen Buffer
616 B<< C<l> >> Use Normal Screen Buffer
622 =item B<< C<Ps = 66> >>
626 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
627 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
631 =item B<< C<Ps = 67> >>
635 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
636 B<< C<l> >> Backspace key sends B<< C<DEL> >>
640 =item B<< C<Ps = 1000> >> (X11 XTerm)
644 B<< C<h> >> Send Mouse X & Y on button press and release.
645 B<< C<l> >> No mouse reporting.
649 =item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
653 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting.
658 =item B<< C<Ps = 1010> >>
662 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output
667 =item B<< C<Ps = 1011> >>
671 B<< C<h> >> Scroll to bottom when a key is pressed
672 B<< C<l> >> Don't scroll to bottom when a key is pressed
676 =item B<< C<Ps = 1047> >>
680 B<< C<h> >> Use Alternate Screen Buffer
681 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
685 =item B<< C<Ps = 1048> >>
689 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position
700 =head1 XTerm Operating System Commands
704 =item B<< C<ESC ] Ps;Pt ST> >>
706 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
707 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
708 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
712 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
713 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
714 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
715 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
716 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<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
717 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
718 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
719 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
720 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
721 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
722 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
723 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
724 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
725 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
728 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
729 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
730 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension)
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension)
742 B<< The exact syntax used is I<almost> solidified. >>
743 In the menus, B<DON'T> try to use menuBar commands that add or remove a
746 Note that in all of the commands, the B<< I</path/> >> I<cannot> be
747 omitted: use B<./> to specify a menu relative to the current menu.
749 =head2 Overview of menuBar operation
751 For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
752 of C<Pt> can be used for a variety of tasks:
754 At the top level is the current menuBar which is a member of a circular
755 linked-list of other such menuBars.
757 The menuBar acts as a parent for the various drop-down menus, which in
758 turn, may have labels, separator lines, menuItems and subMenus.
760 The menuItems are the useful bits: you can use them to mimic keyboard
761 input or even to send text or escape sequences back to rxvt.
763 The menuBar syntax is intended to provide a simple yet robust method of
764 constructing and manipulating menus and navigating through the
767 The first step is to use the tag B<< [menu:I<name>] >> which creates
768 the menuBar called I<name> and allows access. You may now or menus,
769 subMenus, and menuItems. Finally, use the tag B<[done]> to set the
770 menuBar access as B<readonly> to prevent accidental corruption of the
771 menus. To re-access the current menuBar for alterations, use the tag
772 B<[menu]>, make the alterations and then use B<[done]>
780 =item B<< [menu:+I<name>] >>
782 access the named menuBar for creation or alteration. If a new menuBar
783 is created, it is called I<name> (max of 15 chars) and the current
784 menuBar is pushed onto the stack
788 access the current menuBar for alteration
790 =item B<< [title:+I<string>] >>
792 set the current menuBar's title to I<string>, which may contain the
793 following format specifiers:
794 B<%%> : literal B<%> character
795 B<%n> : rxvt name (as per the B<-name> command-line option)
800 set menuBar access as B<readonly>.
801 End-of-file tag for B<< [read:+I<file>] >> operations.
803 =item B<< [read:+I<file>] >>
805 read menu commands directly from I<file> (extension ".menu" will be
806 appended if required.) Start reading at a line with B<[menu]> or B<<
807 [menu:+I<name> >> and continuing until B<[done]> is encountered.
809 Blank and comment lines (starting with B<#>) are ignored. Actually,
810 since any invalid menu commands are also ignored, almost anything could
811 be construed as a comment line, but this may be tightened up in the
812 future ... so don't count on it!.
814 =item B<< [read:+I<file>;+I<name>] >>
816 The same as B<< [read:+I<file>] >>, but start reading at a line with
817 B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
818 B<[done]> is encountered.
822 dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
827 remove the named menuBar
831 remove the current menuBar
833 =item B<[rm*] [rm:*]>
839 swap the top two menuBars
843 access the previous menuBar
847 access the next menuBar
851 Enable display of the menuBar
855 Disable display of the menuBar
857 =item B<< [pixmap:+I<name>] >>
859 =item B<< [pixmap:+I<name>;I<scaling>] >>
861 (set the background pixmap globally
863 B<< A Future implementation I<may> make this local to the menubar >>)
865 =item B<< [:+I<command>:] >>
867 ignore the menu readonly status and issue a I<command> to or a menu or
868 menuitem or change the ; a useful shortcut for setting the quick arrows
875 =head2 Adding and accessing menus
877 The following commands may also be B<+> prefixed.
883 access menuBar top level
887 access current menu level
891 access parent menu (1 level up)
895 access parent menu (multiple levels up)
897 =item B<< I</path/>menu >>
901 =item B<< I</path/>menu/* >>
903 add/access menu and clear it if it exists
905 =item B<< I</path/>{-} >>
909 =item B<< I</path/>{item} >>
911 add B<item> as a label
913 =item B<< I</path/>{item} action >>
915 add/alter I<menuitem> with an associated I<action>
917 =item B<< I</path/>{item}{right-text} >>
919 add/alter I<menuitem> with B<right-text> as the right-justified text
920 and as the associated I<action>
922 =item B<< I</path/>{item}{rtext} action >>
924 add/alter I<menuitem> with an associated I<action> and with B<rtext> as
925 the right-justified text.
931 =item Special characters in I<action> must be backslash-escaped:
933 B<\a \b \E \e \n \r \t \octal>
935 =item or in control-character notation:
937 B<^@, ^A .. ^Z .. ^_, ^?>
941 To send a string starting with a B<NUL> (B<^@>) character to the
942 program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
943 the first of which will be stripped off and the balance directed to the
944 program. Otherwise if I<action> begins with B<NUL> followed by
945 non-+B<NUL> characters, the leading B<NUL> is stripped off and the
946 balance is sent back to rxvt.
948 As a convenience for the many Emacs-type editors, I<action> may start
949 with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950 appended if missed from B<M-x> commands.
952 As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
953 quick arrow), a B<BEL> (B<^G>) will be appended if needed.
959 B<M-xapropos> is equivalent to B<\Exapropos\r>
963 B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
967 The option B<< {I<right-rtext>} >> will be right-justified. In the
968 absence of a specified action, this text will be used as the I<action>
975 B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
979 The left label I<is> necessary, since it's used for matching, but
980 implicitly hiding the left label (by using same name for both left and
981 right labels), or explicitly hiding the left label (by preceeding it
982 with a dot), makes it possible to have right-justified text only.
988 B</File/{Open}{Open} Open-File-Action>
992 B</File/{.anylabel}{Open} Open-File-Action>
998 =head2 Removing menus
1004 remove all menus from the menuBar, the same as B<[clear]>
1006 =item B<< -+I</path>menu+ >>
1010 =item B<< -+I</path>{item}+ >>
1014 =item B<< -+I</path>{-} >>
1018 =item B<-/path/menu/*>
1020 remove all items, separators and submenus from menu
1028 The menus also provide a hook for I<quick arrows> to provide easier
1029 user access. If nothing has been explicitly set, the default is to
1030 emulate the curror keys. The syntax permits each arrow to be altered
1031 individually or all four at once without re-entering their common
1032 beginning/end text. For example, to explicitly associate cursor actions
1033 with the arrows, any of the following forms could be used:
1037 =item B<< <r>+I<Right> >>
1039 =item B<< <l>+I<Left> >>
1041 =item B<< <u>+I<Up> >>
1043 =item B<< <d>+I<Down> >>
1045 Define actions for the respective arrow buttons
1047 =item B<< <b>+I<Begin> >>
1049 =item B<< <e>+I<End> >>
1051 Define common beginning/end parts for I<quick arrows> which used in
1052 conjunction with the above <r> <l> <u> <d> constructs
1058 =item For example, define arrows individually,
1068 =item or all at once
1070 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1072 =item or more compactly (factoring out common parts)
1074 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1080 =head2 Command Summary
1082 A short summary of the most I<common> commands:
1088 use an existing named menuBar or start a new one
1092 use the current menuBar
1094 =item [title:string]
1100 set menu access to readonly and, if reading from a file, signal EOF
1104 if reading from a file using [read:file;name] signal EOF
1108 remove named menuBar(s)
1112 remove current menuBar
1116 remove all menuBar(s)
1120 swap top two menuBars
1124 access the previous menuBar
1128 access the next menuBar
1140 =item [pixmap;file;scaling]
1142 set a background pixmap
1146 =item [read:file;name]
1148 read in a menu from a file
1152 dump out all menuBars to /tmp/rxvt-PID
1156 access menuBar top level
1164 access current or parent menu level
1174 =item /path/{item}{rtext} action
1180 remove all menus from the menuBar
1184 remove menu items, separators and submenus from menu
1198 =item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1207 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1208 of B<< C<Pt> >> can be the name of the background pixmap followed by a
1209 sequence of scaling/positioning commands separated by semi-colons. The
1210 scaling/positioning commands are as follows:
1214 =item query scale/position
1218 =item change scale and position
1222 B<WxH+X> (== B<WxH+X+X>)
1224 B<WxH> (same as B<WxH+50+50>)
1226 B<W+X+Y> (same as B<WxW+X+Y>)
1228 B<W+X> (same as B<WxW+X+X>)
1230 B<W> (same as B<WxW+50+50>)
1232 =item change position (absolute)
1236 B<=+X> (same as B<=+X+Y>)
1238 =item change position (relative)
1242 B<+X> (same as B<+X+Y>)
1244 =item rescale (relative)
1246 B<Wx0> -> B<W *= (W/100)>
1248 B<0xH> -> B<H *= (H/100)>
1256 =item B<\E]20;funky\a>
1258 load B<funky.xpm> as a tiled image
1260 =item B<\E]20;mona;100\a>
1262 load B<mona.xpm> with a scaling of 100%
1264 =item B<\E]20;;200;?\a>
1266 rescale the current pixmap to 200% and display the image geometry in
1272 =head1 Mouse Reporting
1276 =item B<< C<< ESC [ M <b> <x> <y> >> >>
1278 report mouse position
1282 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
1286 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
1293 3 button released (X11 mouse report)
1299 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1300 button was pressed and are added together (X11 mouse report only):
1304 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
1311 32 Double Click I<(Rxvt extension)>
1315 Col = B<< C<< <x> - SPACE >> >>
1317 Row = B<< C<< <y> - SPACE >> >>
1324 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1326 For the keypad, use B<Shift> to temporarily override Application-Keypad
1327 setting use B<Num_Lock> to toggle Application-Keypad setting if
1328 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
1329 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
1334 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1335 Tab ^I ESC [ Z ^I ESC [ Z
1336 BackSpace ^H ^? ^? ^?
1337 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1338 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1339 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1340 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1341 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
1342 Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @
1343 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1344 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1345 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1346 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1347 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1348 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1349 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1350 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1351 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1352 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1353 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1354 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
1355 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
1356 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
1357 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
1358 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
1359 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
1360 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
1361 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
1362 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
1363 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
1364 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
1365 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
1367 Up ESC [ A ESC [ a ESC O a ESC O A
1368 Down ESC [ B ESC [ b ESC O b ESC O B
1369 Right ESC [ C ESC [ c ESC O c ESC O C
1370 Left ESC [ D ESC [ d ESC O d ESC O D
1372 KP_F1 ESC O P ESC O P
1373 KP_F2 ESC O Q ESC O Q
1374 KP_F3 ESC O R ESC O R
1375 KP_F4 ESC O S ESC O S
1376 XK_KP_Multiply * ESC O j
1378 XK_KP_Separator , ESC O l
1379 XK_KP_Subtract - ESC O m
1380 XK_KP_Decimal . ESC O n
1381 XK_KP_Divide / ESC O o
1397 Marc Lehmann <rxvt@schmorp.de>, converted this document to pod and
1398 reworked it from the original Rxvt documentation, which was done by Geoff
1399 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other