3 RXVT REFERENCE - FAQ, command sequences and other background information
5 =head1 FREQUENTLY ASKED QUESTIONS
9 =item How do I know which rxvt-unicode version I'm using?
11 The version number is displayed with the usage (-h). Also the escape
12 sequence C<ESC[8n> sets the window title to the version number.
14 =item When I log-in to another system it tells me about missing terminfo data?
16 The terminal description used by rxvt-unicode is not as widely available
17 as that for xterm, or even rxvt (for which the same problem often arises).
19 The correct solution for this problem is to install the terminfo, this can
20 be done like this (with ncurses' infocmp):
22 REMOTE=remotesystem.domain
23 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
25 ... or by installing rxvt-unicode normally on the remote system,
27 If you cannot or do not want to do this, then you can simply set
28 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29 problems arising, which includes wrong keymapping, less and different
30 colours and some refresh errors in fullscreen applications. It's a nice
31 quick-and-dirty workaround for rare cases, though.
33 If you always want to do this you can either recompile rxvt-unicode with
34 the desired TERM value or use a resource to set it:
38 If you don't plan to use B<rxvt> (quite common...) you could also replace
39 the rxvt terminfo file with the rxvt-unicode one.
41 =item I need a termcap file entry.
43 You could use rxvt's termcap entry with resonable results in many cases.
44 You can also create a termcap entry by using terminfo's infocmp program
47 infocmp -C rxvt-unicode
49 OR you could this termcap entry:
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
71 =item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
73 Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
74 behave similar to the original rxvt:
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
79 =item Rxvt-unicode does not seem to understand the selected encoding?
81 =item Unicode does not seem to work?
83 If you encounter strange problems like typing an accented character but
84 getting two unrelated other characters or similar, or if program output is
85 subtly garbled, then you should check your locale settings.
87 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88 programs. Often rxvt-unicode is started in the C<C> locale, while the
89 login script running within the rxvt-unicode window changes the locale to
90 sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
92 The best thing is to fix your startup environment, as you will likely run
93 into other problems. If nothing works you can try this in your .profile.
95 printf '\e]701;%s\007' "$LC_CTYPE"
97 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98 supported on your systems. Some systems have a C<locale> command which
99 displays this. If it displays sth. like:
101 locale: Cannot set LC_CTYPE to default locale: ...
103 Then the locale you specified is not supported on your system.
105 If nothing works and you are sure that everything is set correctly then
106 you will need to remember a little known fact: Some programs just don't
109 =item Why do some characters look so much different than others?
111 =item How does rxvt-unicode choose fonts?
113 Most fonts do not contain the full range of Unicode, which is
114 fine. Chances are that the font you (or the admin/package maintainer of
115 your system/os) have specified does not cover all the characters you want
118 B<rxvt-unicode> makes a best-effort try at finding a replacement
119 font. Often the result is fine, but sometimes the chosen font looks
120 bad. Many fonts have totally strange characters that don't resemble the
121 correct glyph at all, and rxvt-unicode lacks the artificial intelligence
122 to detect that a specific glyph is wrong: it has to believe the font that
123 the characters it contains indeed look correct.
125 In that case, select a font of your taste and add it to the font list,
128 @@RXVT_NAME@@ -fn basefont,font2,font3...
130 When rxvt-unicode sees a character, it will first look at the base
131 font. If the base font does not contain the character, it will go to the
132 next font, and so on. Specifying your own fonts will also speed up this
133 search and use less resources within rxvt-unicode and the X-server.
135 The only limitation is that all the fonts must not be larger than the base
136 font, as the base font defines the principal cell size, which must be the
137 same due to the way terminals work.
139 =item Why do some chinese characters look so different than others?
141 This is because there is a difference between script and language --
142 rxvt-unicode does not know which language the text that is output
143 is, as it only knows the unicode character codes. If rxvt-unicode
144 first sees a japanese character, it might choose a japanese font for
145 it. Subsequent japanese characters will take that font. Now, many chinese
146 characters aren't represented in japanese fonts, so when the first
147 non-japanese character comes up, rxvt-unicode will look for a chinese font
148 -- unfortunately at this point, it will still use the japanese font for
149 japanese characters that are also chinese.
151 The workaround is easy: just tag a chinese font at the end of your font
152 list (see the previous question). The key is to view the font list as
153 a preference list: If you expect more japanese, list a japanese font
154 first. If you expect more chinese, put a chinese font first.
156 In the future it might be possible to switch preferences at runtime (the
157 internal data structure has no problem with using different fonts for
158 the same character at the same time, but no interface for this has been
161 =item Why does rxvt-unicode sometimes leave pixel droppings?
163 Most fonts were not designed for terminal use, which means that character
164 size varies a lot. A font that is otherwise fine for terminal use might
165 contain some characters that are simply too wide. Rxvt-unicode will avoid
166 these characters. For characters that are just "a bit" too wide a special
167 "careful" rendering mode is used that redraws adjacent characters.
169 All of this requires that fonts do not lie about character sizes,
170 however: Xft fonts often draw glyphs larger than their acclaimed bounding
171 box, and rxvt-unicode has no way of detecting this (the correct way is to
172 ask for the character bounding box, which unfortunately is wrong in these
175 It's not clear (to me at least), wether this is a bug in Xft, freetype, or
176 the respective font. If you encounter this problem there is no way to work
177 around this except by using a different font.
179 All of this is not a problem when using X11 core fonts, as their bounding
182 =item My Compose (Multi_key) key is no longer working.
184 The most common causes for this are that either your locale is not set
185 correctly, or you specified a B<preeditStyle> that is not supported by
186 your input method. For example, if you specified B<OverTheSpot> and
187 your input method (e.g. the default input method handling Compose keys)
188 does not support this (for instance because it is not visual), then
189 rxvt-unicode will continue without an input method.
191 In this case either do not specify a B<preeditStyle> or specify more than
192 one pre-edit style, such as B<OverTheSpot,Root,None>.
194 =item How can I keep rxvt-unicode from using reverse video so much?
196 First of all, make sure you are running with the right terminfo
197 (C<urxvt>), which will get rid of most of these effects. Then make sure
198 you have specified colours for italic and bold, as otherwise rxvt-unicode
199 might use reverse video to simulate the effect:
204 =item Some programs assume totally weird colours (red instead of blue), how can I fix that?
206 For some unexplainable reason, some programs (i.e. irssi) assume a very
207 weird colour palette when confronted with a terminal with more than the
208 standard 8 colours (rxvt-unicode supports 88). The right fix is, of
209 course, to fix these programs not to assume non-ISO colours without very
212 In the meantime, you can either edit your C<urxvt> terminfo definition to
213 only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
214 but keep you from using other rxvt-unicode features.
216 =item I am on FreeBSD and rxvt-unicode does not seem to work at all.
218 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219 in your compile environment, or an implementation that implements it,
220 wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221 B<wchar_t> is represented as unicode.
223 As you might have guessed, FreeBSD does neither define this symobl nor
224 does it support it. Instead, it uses it's own internal representation of
225 B<wchar_t>. This is, of course, completely legal.
227 However, C<__STDC_ISO_10646__> is the only sane way to support
228 multi-language apps in an OS, as using a locale-dependent (and
229 non-standardized) representation of B<wchar_t> makes it impossible to
230 convert between B<wchar_t> (as used by X11 and your applications) and any
231 other encoding without implementing OS-specific-wrappers for each and
232 every locale. There simply are no APIs to convert B<wchar_t> into anything
233 except the current locale encoding.
235 Some applications (such as the formidable B<mlterm>) work around this
236 by carrying their own replacement functions for character set handling
237 with them, and either implementing OS-dependent hacks or doing multiple
238 conversions (which is slow and unreliable in case the OS implements
239 encodings slightly different than the terminal emulator).
241 The rxvt-unicode author insists that the right way to fix this is in the
242 system libraries once and for all, instead of forcing every app to carry
243 complete replacements.
245 =item How does rxvt-unicode determine the encoding to use?
247 =item Is there an option to switch encodings?
249 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
250 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
251 UTF-8 or any other encodings with respect to terminal I/O.
253 The reasons is that there exists a perfectly fine mechanism for selecting
254 the encoding, doing I/O and (most important) communicating this to all
255 applications so everybody agrees on character properties such as width and
256 code number. This mechanism is the I<locale>.
258 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259 programs doing the same (that is, most) will automatically agree in the
260 interpretation of characters.
262 Unfortunately, there is no system-independent way to select locales, nor
263 is there a standard on how locale specifiers will look like.
265 On most systems, the content of the C<LC_CTYPE> environment variable
266 contains an arbitrary string which corresponds to an already-installed
267 locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
268 C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269 (i.e. C<de> or C<german>) are also common.
271 Rxvt-unicode ignores all other locale categories, and except for
272 the encoding, ignores country or language-specific settings,
273 i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
275 If you want to use a specific encoding you have to make sure you start
276 rxvt-unicode with the correct C<LC_CTYPE> category.
278 =item Can I switch locales at runtime?
280 Yes, using an escape sequence. Try sth. like this, which sets
281 rxvt-unicode's idea of C<LC_CTYPE>.
283 printf '\e]701;%s\007' ja_JP.SJIS
285 See also the previous question.
287 Sometimes this capability is rather handy when you want to work in one
288 locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
289 example, I use this script to start C<xjdic>, which first switches to a
290 locale supported by xjdic and back later:
292 printf '\e]701;%s\007' ja_JP.SJIS
294 printf '\e]701;%s\007' de_DE.UTF-8
296 =item Can I switch the fonts at runtime?
298 Yes, using an escape sequence. Try sth. like this, which has the same
299 effect as using the C<-fn> switch, and takes effect immediately:
301 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
303 This is useful if you e.g. work primarily with japanese (and prefer a
304 japanese font), but you have to switch to chinese temporarily, where
305 japanese fonts would only be in your way.
307 You can think of this as a kind of manual ISO-2022 switching.
309 =item Why do italic characters look as if clipped?
311 Many fonts have difficulties with italic characters and hinting. For
312 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313 Mono> completely fails in it's italic face. A workaround is to enable
314 freetype autohinting, i.e. like this:
316 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
319 =item My input method wants <some encoding> but I want UTF-8, what can I do?
321 You can specify separate locales for the input method and the rest of the
322 terminal, using the resource C<imlocale>:
324 URxvt*imlocale: ja_JP.EUC-JP
326 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
327 use your input method. Please note, however, that you will not be able to
328 input characters outside C<EUC-JP> in a normal way then, as your input
331 =item Rxvt-unicode uses gobs of memory, how can I reduce that?
333 Rxvt-unicode tries to obey the rule of not charging you for sth. you
334 don't use. One thing you should try is to configure out all settings that
335 you don't need, for example, Xft support is a resource hog by design,
336 when used. Compiling it out ensures that no Xft font will be loaded
337 accidentally when rxvt-unicode tries to find a font for your characters.
339 Also, many people (me included) like large windows and even larger
340 scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
341 6 bytes per screen cell. For a 160x?? window this amounts to almost a
342 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
343 use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
344 rxvt-unicode then uses 8 bytes per screen cell.
346 =item Can I speed up Xft rendering somehow?
348 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
349 it is simply slow. If you still want Xft fonts you might try to disable
350 antialiasing (by appending C<:antialiasing=false>), which saves lots of
351 memory and also speeds up rendering considerably.
353 =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
355 Rxvt-unicode will use whatever you specify as a font. If it needs to
356 fall back to it's default font search list it will prefer X11 core
357 fonts, because they are small and fast, and then use Xft fonts. It has
358 antialiasing disabled for most of them, because the author thinks they
361 If you want antialiasing, you have to specify the fonts manually.
363 =item Mouse cut/paste suddenly no longer works.
365 Make sure that mouse reporting is actually turned off since killing
366 some editors prematurely may leave the mouse in mouse report mode. I've
367 heard that tcsh may use mouse reporting unless it otherwise specified. A
368 quick check is to see if cut/paste works when the Alt or Shift keys are
369 depressed. See @@RXVT_NAME@@(7)
371 =item What's with this bold/blink stuff?
373 If no bold colour is set via C<colorBD:>, bold will invert text using the
374 standard foreground colour.
376 For the standard background colour, blinking will actually make the
377 text blink when compiled with C<--enable-blinking>. with standard
378 colours. Without C<--enable-blinking>, the blink attribute will be
381 On ANSI colours, bold/blink attributes are used to set high-intensity
382 foreground/background colors.
384 color0-7 are the low-intensity colors.
386 color8-15 are the corresponding high-intensity colors.
388 =item I don't like the screen colors. How do I change them?
390 You can change the screen colors at run-time using F<~/.Xdefaults>
391 resources (or as long-options).
393 Here are values that are supposed to resemble a VGA screen,
394 including the murky brown that passes for low-intensity yellow:
396 URxvt*color0: #000000
397 URxvt*color1: #A80000
398 URxvt*color2: #00A800
399 URxvt*color3: #A8A800
400 URxvt*color4: #0000A8
401 URxvt*color5: #A800A8
402 URxvt*color6: #00A8A8
403 URxvt*color7: #A8A8A8
405 URxvt*color8: #000054
406 URxvt*color9: #FF0054
407 URxvt*color10: #00FF54
408 URxvt*color11: #FFFF54
409 URxvt*color12: #0000FF
410 URxvt*color13: #FF00FF
411 URxvt*color14: #00FFFF
412 URxvt*color15: #FFFFFF
414 And here is a more complete set of non-standard colors described as
417 URxvt.cursorColor: #dc74d1
418 URxvt.pointerColor: #dc74d1
419 URxvt.background: #0e0e0e
420 URxvt.foreground: #4ad5e1
421 URxvt.color0: #000000
422 URxvt.color8: #8b8f93
423 URxvt.color1: #dc74d1
424 URxvt.color9: #dc74d1
425 URxvt.color2: #0eb8c7
426 URxvt.color10: #0eb8c7
427 URxvt.color3: #dfe37e
428 URxvt.color11: #dfe37e
429 URxvt.color5: #9e88f0
430 URxvt.color13: #9e88f0
431 URxvt.color6: #73f7ff
432 URxvt.color14: #73f7ff
433 URxvt.color7: #e1dddd
434 URxvt.color15: #e1dddd
436 =item What's with the strange Backspace/Delete key behaviour?
438 Assuming that the physical Backspace key corresponds to the
439 BackSpace keysym (not likely for Linux ... see the following
440 question) there are two standard values that can be used for
441 Backspace: C<^H> and C<^?>.
443 Historically, either value is correct, but rxvt-unicode adopts the debian
444 policy of using C<^?> when unsure, because it's the one only only correct
447 Rxvt-unicode tries to inherit the current stty settings and uses the value
448 of `erase' to guess the value for backspace. If rxvt-unicode wasn't
449 started from a terminal (say, from a menu or by remote shell), then the
450 system value of `erase', which corresponds to CERASE in <termios.h>, will
451 be used (which may not be the same as your stty setting).
453 For starting a new rxvt-unicode:
463 Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
465 For an existing rxvt-unicode:
475 This helps satisfy some of the Backspace discrepancies that occur, but
476 if you use Backspace = C<^H>, make sure that the termcap/terminfo value
477 properly reflects that.
479 The Delete key is a another casualty of the ill-defined Backspace problem.
480 To avoid confusion between the Backspace and Delete keys, the Delete
481 key has been assigned an escape sequence to match the vt100 for Execute
482 (ESC[3~) and is in the supplied termcap/terminfo.
484 Some other Backspace problems:
486 some editors use termcap/terminfo,
487 some editors (vim I'm told) expect Backspace = ^H,
488 GNU Emacs (and Emacs-like editors) use ^H for help.
490 Perhaps someday this will all be resolved in a consistent manner.
492 =item I don't like the key-bindings. How do I change them?
494 There are some compile-time selections available via configure. Unless
495 you have run "configure" with the C<--disable-resources> option you can
496 use the `keysym' resource to alter the keystrings associated with keysym
497 0xFF00 - 0xFFFF (function, cursor keys, etc).
499 Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
501 !# ----- special uses ------:
502 ! tn3270 login, remap function and arrow keys.
503 tn3270*font: *clean-bold-*-*--15-*
505 ! keysym - used by rxvt only
507 tn3270*keysym.0xFFFF: \004
510 tn3270*keysym.0xFF50: \001
512 tn3270*keysym.0xFF51: \002
514 tn3270*keysym.0xFF52: \020
516 tn3270*keysym.0xFF53: \006
518 tn3270*keysym.0xFF54: \016
520 tn3270*keysym.0xFF57: \005
523 tn3270*keysym.0xFFBE: \e1
524 tn3270*keysym.0xFFBF: \e2
525 tn3270*keysym.0xFFC0: \e3
526 tn3270*keysym.0xFFC1: \e4
527 tn3270*keysym.0xFFC2: \e5
528 tn3270*keysym.0xFFC3: \e6
529 tn3270*keysym.0xFFC4: \e7
530 tn3270*keysym.0xFFC5: \e8
531 tn3270*keysym.0xFFC6: \e9
532 tn3270*keysym.0xFFC7: \e0
533 tn3270*keysym.0xFFC8: \e-
534 tn3270*keysym.0xFFC9: \e=
536 ! map Prior/Next to F7/F8
537 tn3270*keysym.0xFF55: \e7
538 tn3270*keysym.0xFF56: \e8
540 =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
541 How do I make use of them? For example, the Sun Keyboard type 4
542 has the following mappings that rxvt-unicode doesn't recognize.
551 Rather than have rxvt-unicode try to accommodate all the various possible keyboard
552 mappings, it is better to use `xmodmap' to remap the keys as required for
553 your particular machine.
555 =item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
556 I need this to decide about setting colors etc.
558 rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
559 check and see if that is set. Note that several programs, JED, slrn,
560 Midnight Commander automatically check this variable to decide whether or
563 =item How do I set the correct, full IP address for the DISPLAY variable?
565 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
566 insecure mode then it is possible to use the following shell script
567 snippets to correctly set the display. If your version of rxvt-unicode
568 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
569 the COLORTERM variable can be used to distinguish rxvt-unicode from a
572 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
575 # Bourne/Korn/POSIX family of shells:
576 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
577 if [ ${TERM:-foo} = xterm ]; then
578 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
582 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
583 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
584 read DISPLAY # set it in our local shell
588 =item How do I compile the manual pages for myself?
590 You need to have a recent version of perl installed as F</usr/bin/perl>,
591 one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
592 the doc subdirectory and enter C<make alldoc>.
594 =item My question isn't answered here, can I ask a human?
596 Before sending me mail, you could go to IRC: C<irc.freenode.net>,
597 channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
598 interested in learning about new and exciting problems (but not FAQs :).
605 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
607 # change the locale and tell rxvt-unicode about it
608 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
611 printf '\33]2;%s\007' "new window title"
615 The rest of this document describes various technical aspects of
616 B<rxvt-unicode>. First the description of supported command sequences,
617 followed by menu and pixmap support and last by a description of all
618 features selectable at C<configure> time.
620 =head1 RXVT TECHNICAL REFERENCE
628 The literal character c.
632 A single (required) character.
636 A single (usually optional) numeric parameter, composed of one or more
641 A multiple numeric parameter composed of any number of single numeric
642 parameters, separated by C<;> character(s).
646 A text parameter composed of printable characters.
656 Enquiry (Ctrl-E) = Send Device Attributes (DA)
657 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
669 Horizontal Tab (HT) (Ctrl-I)
673 Line Feed or New Line (NL) (Ctrl-J)
677 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
681 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
685 Carriage Return (Ctrl-M)
689 Shift Out (Ctrl-N), invokes the G1 character set.
690 Switch to Alternate Character Set
694 Shift In (Ctrl-O), invokes the G0 character set (the default).
695 Switch to Standard Character Set
703 =head1 Escape Sequences
707 =item B<< C<ESC # 8> >>
709 DEC Screen Alignment Test (DECALN)
711 =item B<< C<ESC 7> >>
715 =item B<< C<ESC 8> >>
719 =item B<< C<ESC => >>
721 Application Keypad (SMKX). See also next sequence.
723 =item B<<< C<< ESC >> >>>
727 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
728 pressed, numbers or control functions are generated by the numeric keypad
731 =item B<< C<ESC D> >>
735 =item B<< C<ESC E> >>
739 =item B<< C<ESC H> >>
743 =item B<< C<ESC M> >>
747 =item B<< C<ESC N> >>
749 Single Shift Select of G2 Character Set (SS2): affects next character
750 only I<unimplemented>
752 =item B<< C<ESC O> >>
754 Single Shift Select of G3 Character Set (SS3): affects next character
755 only I<unimplemented>
757 =item B<< C<ESC Z> >>
759 Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>
761 =item B<< C<ESC c> >>
765 =item B<< C<ESC n> >>
767 Invoke the G2 Character Set (LS2)
769 =item B<< C<ESC o> >>
771 Invoke the G3 Character Set (LS3)
773 =item B<< C<ESC> ( C> >>
775 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
777 =item B<< C<ESC> ) C> >>
779 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
781 =item B<< C<ESC * C> >>
783 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
785 =item B<< C<ESC + C> >>
787 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
789 =item B<< C<ESC $ C> >>
791 Designate Kanji Character Set
793 Where B<< C<C> >> is one of:
797 C = C<0> DEC Special Character and Line Drawing Set
798 C = C<A> United Kingdom (UK)
799 C = C<B> United States (USASCII)
800 C = C<< < >> Multinational character set I<unimplemented>
801 C = C<5> Finnish character set I<unimplemented>
802 C = C<C> Finnish character set I<unimplemented>
803 C = C<K> German character set I<unimplemented>
811 =head1 CSI (Command Sequence Introducer) Sequences
815 =item B<< C<ESC [ Ps @> >>
817 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
819 =item B<< C<ESC [ Ps A> >>
821 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
823 =item B<< C<ESC [ Ps B> >>
825 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
827 =item B<< C<ESC [ Ps C> >>
829 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
831 =item B<< C<ESC [ Ps D> >>
833 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
835 =item B<< C<ESC [ Ps E> >>
837 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
839 =item B<< C<ESC [ Ps F> >>
841 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
843 =item B<< C<ESC [ Ps G> >>
845 Cursor to Column B<< C<Ps> >> (HPA)
847 =item B<< C<ESC [ Ps;Ps H> >>
849 Cursor Position [row;column] [default: 1;1] (CUP)
851 =item B<< C<ESC [ Ps I> >>
853 Move forward B<< C<Ps> >> tab stops [default: 1]
855 =item B<< C<ESC [ Ps J> >>
857 Erase in Display (ED)
861 B<< C<Ps = 0> >> Clear Below (default)
862 B<< C<Ps = 1> >> Clear Above
863 B<< C<Ps = 2> >> Clear All
867 =item B<< C<ESC [ Ps K> >>
873 B<< C<Ps = 0> >> Clear to Right (default)
874 B<< C<Ps = 1> >> Clear to Left
875 B<< C<Ps = 2> >> Clear All
879 =item B<< C<ESC [ Ps L> >>
881 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
883 =item B<< C<ESC [ Ps M> >>
885 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
887 =item B<< C<ESC [ Ps P> >>
889 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
891 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
893 Initiate . I<unimplemented> Parameters are
894 [func;startx;starty;firstrow;lastrow].
896 =item B<< C<ESC [ Ps W> >>
902 B<< C<Ps = 0> >> Tab Set (HTS)
903 B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default)
904 B<< C<Ps = 5> >> Tab Clear (TBC), Clear All
908 =item B<< C<ESC [ Ps X> >>
910 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
912 =item B<< C<ESC [ Ps Z> >>
914 Move backward B<< C<Ps> >> [default: 1] tab stops
916 =item B<< C<ESC [ Ps '> >>
918 See B<< C<ESC [ Ps G> >>
920 =item B<< C<ESC [ Ps a> >>
922 See B<< C<ESC [ Ps C> >>
924 =item B<< C<ESC [ Ps c> >>
926 Send Device Attributes (DA)
927 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
928 returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video
931 =item B<< C<ESC [ Ps d> >>
933 Cursor to Line B<< C<Ps> >> (VPA)
935 =item B<< C<ESC [ Ps e> >>
937 See B<< C<ESC [ Ps A> >>
939 =item B<< C<ESC [ Ps;Ps f> >>
941 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
943 =item B<< C<ESC [ Ps g> >>
949 B<< C<Ps = 0> >> Clear Current Column (default)
950 B<< C<Ps = 3> >> Clear All (TBC)
954 =item B<< C<ESC [ Pm h> >>
956 Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
958 =item B<< C<ESC [ Ps i> >>
960 Printing. See also the C<print-pipe> resource.
964 B<< C<Ps = 0> >> print screen (MC0)
965 B<< C<Ps = 4> >> disable transparent print mode (MC4)
966 B<< C<Ps = 5> >> enable transparent print mode (MC5)
970 =item B<< C<ESC [ Pm l> >>
976 =item B<< C<Ps = 4> >>
980 B<< C<h> >> Insert Mode (SMIR)
981 B<< C<l> >> Replace Mode (RMIR)
985 =item B<< C<Ps = 20> >> (partially implemented)
989 B<< C<h> >> Automatic Newline (LNM)
990 B<< C<l> >> Normal Linefeed (LNM)
996 =item B<< C<ESC [ Pm m> >>
998 Character Attributes (SGR)
1002 B<< C<Ps = 0> >> Normal (default)
1003 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1004 B<< C<Ps = 3 / 23> >> On / Off Italic
1005 B<< C<Ps = 4 / 24> >> On / Off Underline
1006 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1007 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1008 B<< C<Ps = 7 / 27> >> On / Off Inverse
1009 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
1010 B<< C<Ps = 30 / 40> >> fg/bg Black
1011 B<< C<Ps = 31 / 41> >> fg/bg Red
1012 B<< C<Ps = 32 / 42> >> fg/bg Green
1013 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1014 B<< C<Ps = 34 / 44> >> fg/bg Blue
1015 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1016 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1017 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
1018 B<< C<Ps = 37 / 47> >> fg/bg White
1019 B<< C<Ps = 39 / 49> >> fg/bg Default
1020 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1021 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1022 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1023 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1024 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1025 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1026 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1027 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1028 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
1032 =item B<< C<ESC [ Ps n> >>
1034 Device Status Report (DSR)
1038 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1039 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1040 B<< C<Ps = 7> >> Request Display Name
1041 B<< C<Ps = 8> >> Request Version Number (place in window title)
1045 =item B<< C<ESC [ Ps;Ps r> >>
1047 Set Scrolling Region [top;bottom]
1048 [default: full size of window] (CSR)
1050 =item B<< C<ESC [ s> >>
1054 =item B<< C<ESC [ Ps x> >>
1056 Request Terminal Parameters (DECREQTPARM)
1058 =item B<< C<ESC [ u> >>
1066 =head1 DEC Private Modes
1070 =item B<< C<ESC [ ? Pm h> >>
1072 DEC Private Mode Set (DECSET)
1074 =item B<< C<ESC [ ? Pm l> >>
1076 DEC Private Mode Reset (DECRST)
1078 =item B<< C<ESC [ ? Pm r> >>
1080 Restore previously saved DEC Private Mode Values.
1082 =item B<< C<ESC [ ? Pm s> >>
1084 Save DEC Private Mode Values.
1086 =item B<< C<ESC [ ? Pm t> >>
1088 Toggle DEC Private Mode Values (rxvt extension). I<where>
1092 =item B<< C<Ps = 1> >> (DECCKM)
1096 B<< C<h> >> Application Cursor Keys
1097 B<< C<l> >> Normal Cursor Keys
1101 =item B<< C<Ps = 2> >> (ANSI/VT52 mode)
1105 B<< C<h> >> Enter VT52 mode
1106 B<< C<l> >> Enter VT52 mode
1110 =item B<< C<Ps = 3> >>
1114 B<< C<h> >> 132 Column Mode (DECCOLM)
1115 B<< C<l> >> 80 Column Mode (DECCOLM)
1119 =item B<< C<Ps = 4> >>
1123 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1124 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1128 =item B<< C<Ps = 5> >>
1132 B<< C<h> >> Reverse Video (DECSCNM)
1133 B<< C<l> >> Normal Video (DECSCNM)
1137 =item B<< C<Ps = 6> >>
1141 B<< C<h> >> Origin Mode (DECOM)
1142 B<< C<l> >> Normal Cursor Mode (DECOM)
1146 =item B<< C<Ps = 7> >>
1150 B<< C<h> >> Wraparound Mode (DECAWM)
1151 B<< C<l> >> No Wraparound Mode (DECAWM)
1155 =item B<< C<Ps = 8> >> I<unimplemented>
1159 B<< C<h> >> Auto-repeat Keys (DECARM)
1160 B<< C<l> >> No Auto-repeat Keys (DECARM)
1164 =item B<< C<Ps = 9> >> X10 XTerm
1168 B<< C<h> >> Send Mouse X & Y on button press.
1169 B<< C<l> >> No mouse reporting.
1173 =item B<< C<Ps = 10> >> (B<rxvt>)
1177 B<< C<h> >> menuBar visible
1178 B<< C<l> >> menuBar invisible
1182 =item B<< C<Ps = 25> >>
1186 B<< C<h> >> Visible cursor {cnorm/cvvis}
1187 B<< C<l> >> Invisible cursor {civis}
1191 =item B<< C<Ps = 30> >>
1195 B<< C<h> >> scrollBar visisble
1196 B<< C<l> >> scrollBar invisisble
1200 =item B<< C<Ps = 35> >> (B<rxvt>)
1204 B<< C<h> >> Allow XTerm Shift+key sequences
1205 B<< C<l> >> Disallow XTerm Shift+key sequences
1209 =item B<< C<Ps = 38> >> I<unimplemented>
1211 Enter Tektronix Mode (DECTEK)
1213 =item B<< C<Ps = 40> >>
1217 B<< C<h> >> Allow 80/132 Mode
1218 B<< C<l> >> Disallow 80/132 Mode
1222 =item B<< C<Ps = 44> >> I<unimplemented>
1226 B<< C<h> >> Turn On Margin Bell
1227 B<< C<l> >> Turn Off Margin Bell
1231 =item B<< C<Ps = 45> >> I<unimplemented>
1235 B<< C<h> >> Reverse-wraparound Mode
1236 B<< C<l> >> No Reverse-wraparound Mode
1240 =item B<< C<Ps = 46> >> I<unimplemented>
1242 =item B<< C<Ps = 47> >>
1246 B<< C<h> >> Use Alternate Screen Buffer
1247 B<< C<l> >> Use Normal Screen Buffer
1253 =item B<< C<Ps = 66> >>
1257 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1258 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1262 =item B<< C<Ps = 67> >>
1266 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1267 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1271 =item B<< C<Ps = 1000> >> (X11 XTerm)
1275 B<< C<h> >> Send Mouse X & Y on button press and release.
1276 B<< C<l> >> No mouse reporting.
1280 =item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
1284 B<< C<h> >> Use Hilite Mouse Tracking.
1285 B<< C<l> >> No mouse reporting.
1289 =item B<< C<Ps = 1010> >> (B<rxvt>)
1293 B<< C<h> >> Don't scroll to bottom on TTY output
1294 B<< C<l> >> Scroll to bottom on TTY output
1298 =item B<< C<Ps = 1011> >> (B<rxvt>)
1302 B<< C<h> >> Scroll to bottom when a key is pressed
1303 B<< C<l> >> Don't scroll to bottom when a key is pressed
1307 =item B<< C<Ps = 1047> >>
1311 B<< C<h> >> Use Alternate Screen Buffer
1312 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1316 =item B<< C<Ps = 1048> >>
1320 B<< C<h> >> Save cursor position
1321 B<< C<l> >> Restore cursor position
1325 =item B<< C<Ps = 1049> >>
1329 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1330 B<< C<l> >> Use Normal Screen Buffer
1340 =head1 XTerm Operating System Commands
1344 =item B<< C<ESC ] Ps;Pt ST> >>
1346 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
1347 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1348 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1352 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1353 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1354 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1355 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.
1356 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
1357 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1358 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1359 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1360 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1361 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1362 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1363 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1364 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1365 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1366 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1367 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
1368 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> >>
1369 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1370 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)
1371 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1372 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1373 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>
1374 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1375 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1376 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1377 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1387 B<< The exact syntax used is I<almost> solidified. >>
1388 In the menus, B<DON'T> try to use menuBar commands that add or remove a
1391 Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1392 omitted: use B<./> to specify a menu relative to the current menu.
1394 =head2 Overview of menuBar operation
1396 For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1397 of C<Pt> can be used for a variety of tasks:
1399 At the top level is the current menuBar which is a member of a circular
1400 linked-list of other such menuBars.
1402 The menuBar acts as a parent for the various drop-down menus, which in
1403 turn, may have labels, separator lines, menuItems and subMenus.
1405 The menuItems are the useful bits: you can use them to mimic keyboard
1406 input or even to send text or escape sequences back to rxvt.
1408 The menuBar syntax is intended to provide a simple yet robust method of
1409 constructing and manipulating menus and navigating through the
1412 The first step is to use the tag B<< [menu:I<name>] >> which creates
1413 the menuBar called I<name> and allows access. You may now or menus,
1414 subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1415 menuBar access as B<readonly> to prevent accidental corruption of the
1416 menus. To re-access the current menuBar for alterations, use the tag
1417 B<[menu]>, make the alterations and then use B<[done]>
1425 =item B<< [menu:+I<name>] >>
1427 access the named menuBar for creation or alteration. If a new menuBar
1428 is created, it is called I<name> (max of 15 chars) and the current
1429 menuBar is pushed onto the stack
1433 access the current menuBar for alteration
1435 =item B<< [title:+I<string>] >>
1437 set the current menuBar's title to I<string>, which may contain the
1438 following format specifiers:
1439 B<%%> : literal B<%> character
1440 B<%n> : rxvt name (as per the B<-name> command-line option)
1441 B<%v> : rxvt version
1445 set menuBar access as B<readonly>.
1446 End-of-file tag for B<< [read:+I<file>] >> operations.
1448 =item B<< [read:+I<file>] >>
1450 read menu commands directly from I<file> (extension ".menu" will be
1451 appended if required.) Start reading at a line with B<[menu]> or B<<
1452 [menu:+I<name> >> and continuing until B<[done]> is encountered.
1454 Blank and comment lines (starting with B<#>) are ignored. Actually,
1455 since any invalid menu commands are also ignored, almost anything could
1456 be construed as a comment line, but this may be tightened up in the
1457 future ... so don't count on it!.
1459 =item B<< [read:+I<file>;+I<name>] >>
1461 The same as B<< [read:+I<file>] >>, but start reading at a line with
1462 B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1463 B<[done]> is encountered.
1467 dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1472 remove the named menuBar
1476 remove the current menuBar
1478 =item B<[rm*] [rm:*]>
1484 swap the top two menuBars
1488 access the previous menuBar
1492 access the next menuBar
1496 Enable display of the menuBar
1500 Disable display of the menuBar
1502 =item B<< [pixmap:+I<name>] >>
1504 =item B<< [pixmap:+I<name>;I<scaling>] >>
1506 (set the background pixmap globally
1508 B<< A Future implementation I<may> make this local to the menubar >>)
1510 =item B<< [:+I<command>:] >>
1512 ignore the menu readonly status and issue a I<command> to or a menu or
1513 menuitem or change the ; a useful shortcut for setting the quick arrows
1520 =head2 Adding and accessing menus
1522 The following commands may also be B<+> prefixed.
1528 access menuBar top level
1532 access current menu level
1536 access parent menu (1 level up)
1540 access parent menu (multiple levels up)
1542 =item B<< I</path/>menu >>
1546 =item B<< I</path/>menu/* >>
1548 add/access menu and clear it if it exists
1550 =item B<< I</path/>{-} >>
1554 =item B<< I</path/>{item} >>
1556 add B<item> as a label
1558 =item B<< I</path/>{item} action >>
1560 add/alter I<menuitem> with an associated I<action>
1562 =item B<< I</path/>{item}{right-text} >>
1564 add/alter I<menuitem> with B<right-text> as the right-justified text
1565 and as the associated I<action>
1567 =item B<< I</path/>{item}{rtext} action >>
1569 add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1570 the right-justified text.
1576 =item Special characters in I<action> must be backslash-escaped:
1578 B<\a \b \E \e \n \r \t \octal>
1580 =item or in control-character notation:
1582 B<^@, ^A .. ^Z .. ^_, ^?>
1586 To send a string starting with a B<NUL> (B<^@>) character to the
1587 program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1588 the first of which will be stripped off and the balance directed to the
1589 program. Otherwise if I<action> begins with B<NUL> followed by
1590 non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1591 balance is sent back to rxvt.
1593 As a convenience for the many Emacs-type editors, I<action> may start
1594 with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1595 appended if missed from B<M-x> commands.
1597 As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1598 quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1604 B<M-xapropos> is equivalent to B<\Exapropos\r>
1608 B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1612 The option B<< {I<right-rtext>} >> will be right-justified. In the
1613 absence of a specified action, this text will be used as the I<action>
1620 B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1624 The left label I<is> necessary, since it's used for matching, but
1625 implicitly hiding the left label (by using same name for both left and
1626 right labels), or explicitly hiding the left label (by preceeding it
1627 with a dot), makes it possible to have right-justified text only.
1633 B</File/{Open}{Open} Open-File-Action>
1637 B</File/{.anylabel}{Open} Open-File-Action>
1643 =head2 Removing menus
1649 remove all menus from the menuBar, the same as B<[clear]>
1651 =item B<< -+I</path>menu+ >>
1655 =item B<< -+I</path>{item}+ >>
1659 =item B<< -+I</path>{-} >>
1663 =item B<-/path/menu/*>
1665 remove all items, separators and submenus from menu
1673 The menus also provide a hook for I<quick arrows> to provide easier
1674 user access. If nothing has been explicitly set, the default is to
1675 emulate the curror keys. The syntax permits each arrow to be altered
1676 individually or all four at once without re-entering their common
1677 beginning/end text. For example, to explicitly associate cursor actions
1678 with the arrows, any of the following forms could be used:
1682 =item B<< <r>+I<Right> >>
1684 =item B<< <l>+I<Left> >>
1686 =item B<< <u>+I<Up> >>
1688 =item B<< <d>+I<Down> >>
1690 Define actions for the respective arrow buttons
1692 =item B<< <b>+I<Begin> >>
1694 =item B<< <e>+I<End> >>
1696 Define common beginning/end parts for I<quick arrows> which used in
1697 conjunction with the above <r> <l> <u> <d> constructs
1703 =item For example, define arrows individually,
1713 =item or all at once
1715 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1717 =item or more compactly (factoring out common parts)
1719 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1725 =head2 Command Summary
1727 A short summary of the most I<common> commands:
1733 use an existing named menuBar or start a new one
1737 use the current menuBar
1739 =item [title:string]
1745 set menu access to readonly and, if reading from a file, signal EOF
1749 if reading from a file using [read:file;name] signal EOF
1753 remove named menuBar(s)
1757 remove current menuBar
1761 remove all menuBar(s)
1765 swap top two menuBars
1769 access the previous menuBar
1773 access the next menuBar
1785 =item [pixmap;file;scaling]
1787 set a background pixmap
1791 =item [read:file;name]
1793 read in a menu from a file
1797 dump out all menuBars to /tmp/rxvt-PID
1801 access menuBar top level
1809 access current or parent menu level
1819 =item /path/{item}{rtext} action
1825 remove all menus from the menuBar
1829 remove menu items, separators and submenus from menu
1843 =item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1852 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1853 of B<< C<Pt> >> can be the name of the background pixmap followed by a
1854 sequence of scaling/positioning commands separated by semi-colons. The
1855 scaling/positioning commands are as follows:
1859 =item query scale/position
1863 =item change scale and position
1867 B<WxH+X> (== B<WxH+X+X>)
1869 B<WxH> (same as B<WxH+50+50>)
1871 B<W+X+Y> (same as B<WxW+X+Y>)
1873 B<W+X> (same as B<WxW+X+X>)
1875 B<W> (same as B<WxW+50+50>)
1877 =item change position (absolute)
1881 B<=+X> (same as B<=+X+Y>)
1883 =item change position (relative)
1887 B<+X> (same as B<+X+Y>)
1889 =item rescale (relative)
1891 B<Wx0> -> B<W *= (W/100)>
1893 B<0xH> -> B<H *= (H/100)>
1901 =item B<\E]20;funky\a>
1903 load B<funky.xpm> as a tiled image
1905 =item B<\E]20;mona;100\a>
1907 load B<mona.xpm> with a scaling of 100%
1909 =item B<\E]20;;200;?\a>
1911 rescale the current pixmap to 200% and display the image geometry in
1917 =head1 Mouse Reporting
1921 =item B<< C<< ESC [ M <b> <x> <y> >> >>
1923 report mouse position
1927 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
1931 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
1938 3 button released (X11 mouse report)
1944 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1945 button was pressed and are added together (X11 mouse report only):
1949 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
1956 32 Double Click I<(Rxvt extension)>
1960 Col = B<< C<< <x> - SPACE >> >>
1962 Row = B<< C<< <y> - SPACE >> >>
1969 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1971 For the keypad, use B<Shift> to temporarily override Application-Keypad
1972 setting use B<Num_Lock> to toggle Application-Keypad setting if
1973 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
1974 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
1979 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1980 Tab ^I ESC [ Z ^I ESC [ Z
1981 BackSpace ^H ^? ^? ^?
1982 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1983 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1984 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1985 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1986 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
1987 Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @
1988 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1989 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1990 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1991 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1992 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1993 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1994 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1995 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1996 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1997 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1998 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1999 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
2000 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
2001 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
2002 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
2003 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
2004 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
2005 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
2006 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
2007 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
2008 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
2009 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
2010 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
2012 Up ESC [ A ESC [ a ESC O a ESC O A
2013 Down ESC [ B ESC [ b ESC O b ESC O B
2014 Right ESC [ C ESC [ c ESC O c ESC O C
2015 Left ESC [ D ESC [ d ESC O d ESC O D
2017 KP_F1 ESC O P ESC O P
2018 KP_F2 ESC O Q ESC O Q
2019 KP_F3 ESC O R ESC O R
2020 KP_F4 ESC O S ESC O S
2021 XK_KP_Multiply * ESC O j
2023 XK_KP_Separator , ESC O l
2024 XK_KP_Subtract - ESC O m
2025 XK_KP_Decimal . ESC O n
2026 XK_KP_Divide / ESC O o
2040 =head1 CONFIGURE OPTIONS
2042 General hint: if you get compile errors, then likely your configuration
2043 hasn't been tested well. Either try with --enable-everything or use the
2044 ./reconf script as a base for experiments. ./reconf is used by myself,
2045 so it should generally be a working config. Of course, you should always
2046 report when a combination doesn't work, so it can be fixed. Marc Lehmann
2051 =item --enable-everything
2053 Add support for all non-multichoice options listed in "./configure
2054 --help". Note that unlike other enable options this is order dependant.
2055 You can specify this and then disable options which this enables by
2056 I<following> this with the appropriate commands.
2060 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2061 slower and require lots of memory, but as long as you don't use them, you
2064 =item --enable-font-styles
2066 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2067 styles. The fonts can be set manually or automatically.
2069 =item --with-codesets=NAME,...
2071 Compile in support for additional codeset (encoding) groups (eu, vn are
2072 always compiled in, which includes most 8-bit character sets). These
2073 codeset tables are currently only used for driving X11 core fonts, they
2074 are not required for Xft fonts. Compiling them in will make your binary
2075 bigger (together about 700kB), but it doesn't increase memory usage unless
2076 you use an X11 font requiring one of these encodings.
2080 all all available codeset groups
2081 zh common chinese encodings
2082 zh_ext rarely used but very big chinese encodigs
2083 jp common japanese encodings
2084 jp_ext rarely used but big japanese encodings
2091 Add support for XIM (X Input Method) protocol. This allows using
2092 alternative input methods (e.g. kinput2) and will also correctly
2093 set up the input for people using dead keys or compose keys.
2095 =item --enable-unicode3
2097 Enable direct support for displaying unicode codepoints above
2098 65535 (the basic multilingual page). This increases storage
2099 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2100 support these extra characters, but Xft does.
2102 Please note that rxvt-unicode can store unicode code points >65535
2103 even without this flag, but the number of such characters is
2104 limited to a view thousand (shared with combining characters,
2105 see next switch), and right now rxvt-unicode cannot display them
2106 (input/output and cut&paste still work, though).
2108 =item --enable-combining
2110 Enable automatic composition of combining characters into
2111 composite characters. This is required for proper viewing of text
2112 where accents are encoded as seperate unicode characters. This is
2113 done by using precomposited characters when available or creating
2114 new pseudo-characters when no precomposed form exists.
2116 Without --enable-unicode3, the number of additional precomposed
2117 characters is rather limited (2048, if this is full, rxvt will use the
2118 private use area, extending the number of combinations to 8448). With
2119 --enable-unicode3, no practical limit exists. This will also enable
2120 storage of characters >65535.
2122 The combining table also contains entries for arabic presentation forms,
2123 but these are not currently used. Bug me if you want these to be used.
2125 =item --enable-fallback(=CLASS)
2127 When reading resource settings, also read settings for class CLASS
2128 (default: Rxvt). To disable resource fallback use --disable-fallback.
2130 =item --with-res-name=NAME
2132 Use the given name (default: urxvt) as default application name when
2133 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2135 =item --with-res-class=CLASS
2137 Use the given class (default: URxvt) as default application class
2138 when reading resources. Specify --with-res-class=Rxvt to replace
2143 Write user and tty to utmp file (used by programs like F<w>) at
2144 start of rxvt execution and delete information when rxvt exits.
2148 Write user and tty to wtmp file (used by programs like F<last>) at
2149 start of rxvt execution and write logout when rxvt exits. This
2150 option requires --enable-utmp to also be specified.
2152 =item --enable-lastlog
2154 Write user and tty to lastlog file (used by programs like
2155 F<lastlogin>) at start of rxvt execution. This option requires
2156 --enable-utmp to also be specified.
2158 =item --enable-xpm-background
2160 Add support for XPM background pixmaps.
2162 =item --enable-transparency
2164 Add support for inheriting parent backgrounds thus giving a fake
2165 transparency to the term.
2167 =item --enable-fading
2169 Add support for fading the text when focus is lost.
2171 =item --enable-tinting
2173 Add support for tinting of transparent backgrounds.
2175 =item --enable-menubar
2177 Add support for our menu bar system (this interacts badly with
2178 dynamic locale switching currently).
2180 =item --enable-rxvt-scroll
2182 Add support for the original rxvt scrollbar.
2184 =item --enable-next-scroll
2186 Add support for a NeXT-like scrollbar.
2188 =item --enable-xterm-scroll
2190 Add support for an Xterm-like scrollbar.
2192 =item --enable-plain-scroll
2194 Add support for a very unobtrusive, plain-looking scrollbar that
2195 is the favourite of the rxvt-unicode author, having used it for
2198 =item --enable-half-shadow
2200 Make shadows on the scrollbar only half the normal width & height.
2201 only applicable to rxvt scrollbars.
2203 =item --enable-ttygid
2205 Change tty device setting to group "tty" - only use this if
2206 your system uses this type of security.
2208 =item --disable-backspace-key
2210 Disable any handling of the backspace key by us - let the X server
2213 =item --disable-delete-key
2215 Disable any handling of the delete key by us - let the X server
2218 =item --disable-resources
2220 Remove all resources checking.
2222 =item --enable-xgetdefault
2224 Make resources checking via XGetDefault() instead of our small
2225 version which only checks ~/.Xdefaults, or if that doesn't exist
2228 =item --enable-strings
2230 Add support for our possibly faster memset() function and other
2231 various routines, overriding your system's versions which may
2232 have been hand-crafted in assembly or may require extra libraries
2233 to link in. (this breaks ANSI-C rules and has problems on many
2236 =item --disable-swapscreen
2238 Remove support for swap screen.
2240 =item --enable-frills
2242 Add support for many small features that are not essential but nice to
2243 have. Normally you want this, but for very small binaries you may want to
2246 =item --enable-iso14755
2248 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2249 F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2250 C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2253 =item --enable-linespace
2255 Add support to provide user specified line spacing between text rows.
2257 =item --enable-keepscrolling
2259 Add support for continual scrolling of the display when you hold
2260 the mouse button down on a scrollbar arrow.
2262 =item --enable-mousewheel
2264 Add support for scrolling via mouse wheel or buttons 4 & 5.
2266 =item --enable-slipwheeling
2268 Add support for continual scrolling (using the mouse wheel as an
2269 accelerator) while the control key is held down. This option
2270 requires --enable-mousewheel to also be specified.
2272 =item --disable-new-selection
2274 Remove support for mouse selection style like that of xterm.
2276 =item --enable-dmalloc
2278 Use Gray Watson's malloc - which is good for debugging See
2279 http://www.letters.com/dmalloc/ for details If you use either this or the
2280 next option, you may need to edit src/Makefile after compiling to point
2281 DINCLUDE and DLIB to the right places.
2283 You can only use either this option and the following (should
2286 =item --enable-dlmalloc
2288 Use Doug Lea's malloc - which is good for a production version
2289 See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2291 =item --enable-smart-resize
2293 Add smart growth/shrink behaviour when changing font size via from hot
2294 keys. This should keep in a fixed position the rxvt corner which is
2295 closest to a corner of the screen.
2297 =item --enable-cursor-blink
2299 Add support for a blinking cursor.
2301 =item --enable-pointer-blank
2303 Add support to have the pointer disappear when typing or inactive.
2305 =item --with-name=NAME
2307 Set the basename for the installed binaries (default: urxvt, resulting in
2308 urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
2310 =item --with-term=NAME
2312 Change the environmental variable for the terminal to NAME (default
2315 =item --with-terminfo=PATH
2317 Change the environmental variable for the path to the terminfo tree to
2322 Use the X Window System (pretty much default, eh?).
2324 =item --with-xpm-includes=DIR
2326 Look for the XPM includes in DIR.
2328 =item --with-xpm-library=DIR
2330 Look for the XPM library in DIR.
2334 Not needed - define via --enable-xpm-background.
2340 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2341 reworked it from the original Rxvt documentation, which was done by Geoff
2342 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other