2 RXVT REFERENCE - FAQ, command sequences and other background information
6 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
8 # change the locale and tell rxvt-unicode about it
9 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12 printf '\33]2;%s\007' "new window title"
15 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
16 all escape sequences, and other background information.
18 The newest version of this document is also available on the World Wide
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
22 FREQUENTLY ASKED QUESTIONS
23 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape
25 sequence "ESC [ 8 n" sets the window title to the version number.
27 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode contains large patches
29 that considerably change the behaviour of rxvt-unicode. Before
30 reporting a bug to the original rxvt-unicode author please download
31 and install the genuine version
32 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
33 problem. If you cannot, chances are that the problems are specific
34 to Debian GNU/Linux, in which case it should be reported via the
35 Debian Bug Tracking System (use "reportbug" to report the bug).
37 For other problems that also affect the Debian package, you can and
38 probably should use the Debian BTS, too, because, after all, it's
39 also a bug in the Debian version and it serves as a reminder for
40 other users that might encounter the same issue.
42 When I log-in to another system it tells me about missing terminfo data?
43 The terminal description used by rxvt-unicode is not as widely
44 available as that for xterm, or even rxvt (for which the same
45 problem often arises).
47 The correct solution for this problem is to install the terminfo,
48 this can be done like this (with ncurses' infocmp):
50 REMOTE=remotesystem.domain
51 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
53 ... or by installing rxvt-unicode normally on the remote system,
55 If you cannot or do not want to do this, then you can simply set
56 "TERM=rxvt" or even "TERM=xterm", and live with the small number of
57 problems arising, which includes wrong keymapping, less and
58 different colours and some refresh errors in fullscreen
59 applications. It's a nice quick-and-dirty workaround for rare cases,
62 If you always want to do this (and are fine with the consequences)
63 you can either recompile rxvt-unicode with the desired TERM value or
64 use a resource to set it:
68 If you don't plan to use rxvt (quite common...) you could also
69 replace the rxvt terminfo file with the rxvt-unicode one.
71 "bash"'s readline does not work correctly under rxvt.
72 I need a termcap file entry.
73 One reason you might want this is that some distributions or
74 operating systems still compile some programs using the
75 long-obsoleted termcap (Fedora Core's bash is one example) and rely
76 on a termcap entry for "rxvt-unicode".
78 You could use rxvt's termcap entry with resonable results in many
79 cases. You can also create a termcap entry by using terminfo's
80 infocmp program like this:
82 infocmp -C rxvt-unicode
84 Or you could use this termcap entry, generated by the command above:
86 rxvt-unicode|rxvt-unicode terminal (X Window System):\
87 :am:bw:eo:km:mi:ms:xn:xo:\
89 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
90 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
91 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
92 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
93 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
94 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
95 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
96 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
97 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
98 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
99 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
100 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
101 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
102 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
103 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
106 Why does "ls" no longer have coloured output?
107 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
108 decide wether a terminal has colour, but uses it's own configuration
109 file. Needless to say, "rxvt-unicode" is not in it's default file
110 (among with most other terminals supporting colour). Either add:
114 to "/etc/DIR_COLORS" or simply add:
116 alias ls='ls --color=auto'
118 to your ".profile" or ".bashrc".
120 Why doesn't vim/emacs etc. use the 88 colour mode?
121 Why doesn't vim/emacs etc. make use of italic?
122 Why are the secondary screen-related options not working properly?
123 Make sure you are using "TERM=rxvt-unicode". Some pre-packaged
124 distributions (most notably Debian GNU/Linux) break rxvt-unicode by
125 setting "TERM" to "rxvt", which doesn't have these extra features.
126 Unfortunately, some of these (most notably, again, Debian GNU/Linux)
127 furthermore fail to even install the "rxvt-unicode" terminfo file,
128 so you will need to install it on your own (See the question When I
129 log-in to another system it tells me about missing terminfo data? on
132 My numerical keypad acts weird and generates differing output?
133 Some Debian GNUL/Linux users seem to have this problem, although no
134 specific details were reported so far. It is possible that this is
135 caused by the wrong "TERM" setting, although the details of wether
136 and how this can happen are unknown, as "TERM=rxvt" should offer a
137 compatible keymap. See the answer to the previous question, and
138 please report if that helped.
140 Rxvt-unicode does not seem to understand the selected encoding?
141 Unicode does not seem to work?
142 If you encounter strange problems like typing an accented character
143 but getting two unrelated other characters or similar, or if program
144 output is subtly garbled, then you should check your locale
147 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
148 programs. Often rxvt-unicode is started in the "C" locale, while the
149 login script running within the rxvt-unicode window changes the
150 locale to something else, e.g. "en_GB.UTF-8". Needless to say, this
151 is not going to work.
153 The best thing is to fix your startup environment, as you will
154 likely run into other problems. If nothing works you can try this in
157 printf '\e]701;%s\007' "$LC_CTYPE"
159 If this doesn't work, then maybe you use a "LC_CTYPE" specification
160 not supported on your systems. Some systems have a "locale" command
161 which displays this (also, "perl -e0" can be used to check locale
162 settings, as it will complain loudly if it cannot set the locale).
163 If it displays something like:
165 locale: Cannot set LC_CTYPE to default locale: ...
167 Then the locale you specified is not supported on your system.
169 If nothing works and you are sure that everything is set correctly
170 then you will need to remember a little known fact: Some programs
171 just don't support locales :(
173 Why do some characters look so much different than others?
174 How does rxvt-unicode choose fonts?
175 Most fonts do not contain the full range of Unicode, which is fine.
176 Chances are that the font you (or the admin/package maintainer of
177 your system/os) have specified does not cover all the characters you
180 rxvt-unicode makes a best-effort try at finding a replacement font.
181 Often the result is fine, but sometimes the chosen font looks
182 bad/ugly/wrong. Some fonts have totally strange characters that
183 don't resemble the correct glyph at all, and rxvt-unicode lacks the
184 artificial intelligence to detect that a specific glyph is wrong: it
185 has to believe the font that the characters it claims to contain
188 In that case, select a font of your taste and add it to the font
191 rxvt -fn basefont,font2,font3...
193 When rxvt-unicode sees a character, it will first look at the base
194 font. If the base font does not contain the character, it will go to
195 the next font, and so on. Specifying your own fonts will also speed
196 up this search and use less resources within rxvt-unicode and the
199 The only limitation is that none of the fonts may be larger than the
200 base font, as the base font defines the terminal character cell
201 size, which must be the same due to the way terminals work.
203 Why do some chinese characters look so different than others?
204 This is because there is a difference between script and language --
205 rxvt-unicode does not know which language the text that is output
206 is, as it only knows the unicode character codes. If rxvt-unicode
207 first sees a japanese/chinese character, it might choose a japanese
208 font for display. Subsequent japanese characters will use that font.
209 Now, many chinese characters aren't represented in japanese fonts,
210 so when the first non-japanese character comes up, rxvt-unicode will
211 look for a chinese font -- unfortunately at this point, it will
212 still use the japanese font for chinese characters that are also in
215 The workaround is easy: just tag a chinese font at the end of your
216 font list (see the previous question). The key is to view the font
217 list as a preference list: If you expect more japanese, list a
218 japanese font first. If you expect more chinese, put a chinese font
221 In the future it might be possible to switch language preferences at
222 runtime (the internal data structure has no problem with using
223 different fonts for the same character at the same time, but no
224 interface for this has been designed yet).
226 Until then, you might get away with switching fonts at runtime (see
227 "Can I switch the fonts at runtime?" later in this document).
229 Why does rxvt-unicode sometimes leave pixel droppings?
230 Most fonts were not designed for terminal use, which means that
231 character size varies a lot. A font that is otherwise fine for
232 terminal use might contain some characters that are simply too wide.
233 Rxvt-unicode will avoid these characters. For characters that are
234 just "a bit" too wide a special "careful" rendering mode is used
235 that redraws adjacent characters.
237 All of this requires that fonts do not lie about character sizes,
238 however: Xft fonts often draw glyphs larger than their acclaimed
239 bounding box, and rxvt-unicode has no way of detecting this (the
240 correct way is to ask for the character bounding box, which
241 unfortunately is wrong in these cases).
243 It's not clear (to me at least), wether this is a bug in Xft,
244 freetype, or the respective font. If you encounter this problem you
245 might try using the "-lsp" option to give the font more height. If
246 that doesn't work, you might be forced to use a different font.
248 All of this is not a problem when using X11 core fonts, as their
249 bounding box data is correct.
251 My Compose (Multi_key) key is no longer working.
252 The most common causes for this are that either your locale is not
253 set correctly, or you specified a preeditStyle that is not supported
254 by your input method. For example, if you specified OverTheSpot and
255 your input method (e.g. the default input method handling Compose
256 keys) does not support this (for instance because it is not visual),
257 then rxvt-unicode will continue without an input method.
259 In this case either do not specify a preeditStyle or specify more
260 than one pre-edit style, such as OverTheSpot,Root,None.
262 I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO
264 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
265 international keyboards) or simply use ISO 14755 support to your
266 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
267 other codes, too, such as "Ctrl-Shift-1-d" to type the default
268 telnet escape character and so on.
270 How can I keep rxvt-unicode from using reverse video so much?
271 First of all, make sure you are running with the right terminal
272 settings ("TERM=rxvt-unicode"), which will get rid of most of these
273 effects. Then make sure you have specified colours for italic and
274 bold, as otherwise rxvt-unicode might use reverse video to simulate
280 Some programs assume totally weird colours (red instead of blue), how
282 For some unexplainable reason, some rare programs assume a very
283 weird colour palette when confronted with a terminal with more than
284 the standard 8 colours (rxvt-unicode supports 88). The right fix is,
285 of course, to fix these programs not to assume non-ISO colours
286 without very good reasons.
288 In the meantime, you can either edit your "rxvt-unicode" terminfo
289 definition to only claim 8 colour support or use "TERM=rxvt", which
290 will fix colours but keep you from using other rxvt-unicode
293 I am on FreeBSD and rxvt-unicode does not seem to work at all.
294 Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined
295 in your compile environment, or an implementation that implements
296 it, wether it defines the symbol or not. "__STDC_ISO_10646__"
297 requires that wchar_t is represented as unicode.
299 As you might have guessed, FreeBSD does neither define this symobl
300 nor does it support it. Instead, it uses it's own internal
301 representation of wchar_t. This is, of course, completely fine with
302 respect to standards.
304 However, "__STDC_ISO_10646__" is the only sane way to support
305 multi-language apps in an OS, as using a locale-dependent (and
306 non-standardized) representation of wchar_t makes it impossible to
307 convert between wchar_t (as used by X11 and your applications) and
308 any other encoding without implementing OS-specific-wrappers for
309 each and every locale. There simply are no APIs to convert wchar_t
310 into anything except the current locale encoding.
312 Some applications (such as the formidable mlterm) work around this
313 by carrying their own replacement functions for character set
314 handling with them, and either implementing OS-dependent hacks or
315 doing multiple conversions (which is slow and unreliable in case the
316 OS implements encodings slightly different than the terminal
319 The rxvt-unicode author insists that the right way to fix this is in
320 the system libraries once and for all, instead of forcing every app
321 to carry complete replacements for them :)
323 How does rxvt-unicode determine the encoding to use?
324 Is there an option to switch encodings?
325 Unlike some other terminals, rxvt-unicode has no encoding switch,
326 and no specific "utf-8" mode, such as xterm. In fact, it doesn't
327 even know about UTF-8 or any other encodings with respect to
330 The reasons is that there exists a perfectly fine mechanism for
331 selecting the encoding, doing I/O and (most important) communicating
332 this to all applications so everybody agrees on character properties
333 such as width and code number. This mechanism is the *locale*.
334 Applications not using that info will have problems (for example,
335 "xterm" gets the width of characters wrong as it uses it's own,
336 locale-independent table under all locales).
338 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding.
339 All programs doing the same (that is, most) will automatically agree
340 in the interpretation of characters.
342 Unfortunately, there is no system-independent way to select locales,
343 nor is there a standard on how locale specifiers will look like.
345 On most systems, the content of the "LC_CTYPE" environment variable
346 contains an arbitrary string which corresponds to an
347 already-installed locale. Common names for locales are
348 "en_US.UTF-8", "de_DE.ISO-8859-15", "ja_JP.EUC-JP", i.e.
349 "language_country.encoding", but other forms (i.e. "de" or "german")
352 Rxvt-unicode ignores all other locale categories, and except for the
353 encoding, ignores country or language-specific settings, i.e.
354 "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to
357 If you want to use a specific encoding you have to make sure you
358 start rxvt-unicode with the correct "LC_CTYPE" category.
360 Can I switch locales at runtime?
361 Yes, using an escape sequence. Try something like this, which sets
362 rxvt-unicode's idea of "LC_CTYPE".
364 printf '\e]701;%s\007' ja_JP.SJIS
366 See also the previous answer.
368 Sometimes this capability is rather handy when you want to work in
369 one locale (e.g. "de_DE.UTF-8") but some programs don't support it
370 (e.g. UTF-8). For example, I use this script to start "xjdic", which
371 first switches to a locale supported by xjdic and back later:
373 printf '\e]701;%s\007' ja_JP.SJIS
375 printf '\e]701;%s\007' de_DE.UTF-8
377 You can also use xterm's "luit" program, which usually works fine,
378 except for some locales where character width differs between
379 program- and rxvt-unicode-locales.
381 Can I switch the fonts at runtime?
382 Yes, using an escape sequence. Try something like this, which has
383 the same effect as using the "-fn" switch, and takes effect
386 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
388 This is useful if you e.g. work primarily with japanese (and prefer
389 a japanese font), but you have to switch to chinese temporarily,
390 where japanese fonts would only be in your way.
392 You can think of this as a kind of manual ISO-2022 switching.
394 Why do italic characters look as if clipped?
395 Many fonts have difficulties with italic characters and hinting. For
396 example, the otherwise very nicely hinted font "xft:Bitstream Vera
397 Sans Mono" completely fails in it's italic face. A workaround might
398 be to enable freetype autohinting, i.e. like this:
400 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
401 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
403 My input method wants <some encoding> but I want UTF-8, what can I do?
404 You can specify separate locales for the input method and the rest
405 of the terminal, using the resource "imlocale":
407 URxvt*imlocale: ja_JP.EUC-JP
409 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and
410 still use your input method. Please note, however, that you will not
411 be able to input characters outside "EUC-JP" in a normal way then,
412 as your input method limits you.
414 Rxvt-unicode uses gobs of memory, how can I reduce that?
415 Rxvt-unicode tries to obey the rule of not charging you for
416 something you don't use. One thing you should try is to configure
417 out all settings that you don't need, for example, Xft support is a
418 resource hog by design, when used. Compiling it out ensures that no
419 Xft font will be loaded accidentally when rxvt-unicode tries to find
420 a font for your characters.
422 Also, many people (me included) like large windows and even larger
423 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will
424 use 6 bytes per screen cell. For a 160x?? window this amounts to
425 almost a kilobyte per line. A scrollback buffer of 10000 lines will
426 then (if full) use 10 Megabytes of memory. With "--enable-unicode3"
427 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
429 Can I speed up Xft rendering somehow?
430 Yes, the most obvious way to speed it up is to avoid Xft entirely,
431 as it is simply slow. If you still want Xft fonts you might try to
432 disable antialiasing (by appending ":antialiasing=false"), which
433 saves lots of memory and also speeds up rendering considerably.
435 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
436 Rxvt-unicode will use whatever you specify as a font. If it needs to
437 fall back to it's default font search list it will prefer X11 core
438 fonts, because they are small and fast, and then use Xft fonts. It
439 has antialiasing disabled for most of them, because the author
440 thinks they look best that way.
442 If you want antialiasing, you have to specify the fonts manually.
444 Mouse cut/paste suddenly no longer works.
445 Make sure that mouse reporting is actually turned off since killing
446 some editors prematurely may leave the mouse in mouse report mode.
447 I've heard that tcsh may use mouse reporting unless it otherwise
448 specified. A quick check is to see if cut/paste works when the Alt
449 or Shift keys are depressed. See rxvt(7)
451 What's with this bold/blink stuff?
452 If no bold colour is set via "colorBD:", bold will invert text using
453 the standard foreground colour.
455 For the standard background colour, blinking will actually make the
456 text blink when compiled with "--enable-blinking". with standard
457 colours. Without "--enable-blinking", the blink attribute will be
460 On ANSI colours, bold/blink attributes are used to set
461 high-intensity foreground/background colors.
463 color0-7 are the low-intensity colors.
465 color8-15 are the corresponding high-intensity colors.
467 I don't like the screen colors. How do I change them?
468 You can change the screen colors at run-time using ~/.Xdefaults
469 resources (or as long-options).
471 Here are values that are supposed to resemble a VGA screen,
472 including the murky brown that passes for low-intensity yellow:
474 URxvt.color0: #000000
475 URxvt.color1: #A80000
476 URxvt.color2: #00A800
477 URxvt.color3: #A8A800
478 URxvt.color4: #0000A8
479 URxvt.color5: #A800A8
480 URxvt.color6: #00A8A8
481 URxvt.color7: #A8A8A8
483 URxvt.color8: #000054
484 URxvt.color9: #FF0054
485 URxvt.color10: #00FF54
486 URxvt.color11: #FFFF54
487 URxvt.color12: #0000FF
488 URxvt.color13: #FF00FF
489 URxvt.color14: #00FFFF
490 URxvt.color15: #FFFFFF
492 And here is a more complete set of non-standard colors described
493 (not by me) as "pretty girly".
495 URxvt.cursorColor: #dc74d1
496 URxvt.pointerColor: #dc74d1
497 URxvt.background: #0e0e0e
498 URxvt.foreground: #4ad5e1
499 URxvt.color0: #000000
500 URxvt.color8: #8b8f93
501 URxvt.color1: #dc74d1
502 URxvt.color9: #dc74d1
503 URxvt.color2: #0eb8c7
504 URxvt.color10: #0eb8c7
505 URxvt.color3: #dfe37e
506 URxvt.color11: #dfe37e
507 URxvt.color5: #9e88f0
508 URxvt.color13: #9e88f0
509 URxvt.color6: #73f7ff
510 URxvt.color14: #73f7ff
511 URxvt.color7: #e1dddd
512 URxvt.color15: #e1dddd
514 How can I start rxvtd in a race-free way?
515 Despite it's name, rxvtd is not a real daemon, but more like a
516 server that answers rxvtc's requests, so it doesn't background
519 To ensure rxvtd is listening on it's socket, you can use the
520 following method to wait for the startup message before continuing:
524 What's with the strange Backspace/Delete key behaviour?
525 Assuming that the physical Backspace key corresponds to the
526 BackSpace keysym (not likely for Linux ... see the following
527 question) there are two standard values that can be used for
528 Backspace: "^H" and "^?".
530 Historically, either value is correct, but rxvt-unicode adopts the
531 debian policy of using "^?" when unsure, because it's the one only
532 only correct choice :).
534 Rxvt-unicode tries to inherit the current stty settings and uses the
535 value of `erase' to guess the value for backspace. If rxvt-unicode
536 wasn't started from a terminal (say, from a menu or by remote
537 shell), then the system value of `erase', which corresponds to
538 CERASE in <termios.h>, will be used (which may not be the same as
541 For starting a new rxvt-unicode:
551 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7).
553 For an existing rxvt-unicode:
563 This helps satisfy some of the Backspace discrepancies that occur,
564 but if you use Backspace = "^H", make sure that the termcap/terminfo
565 value properly reflects that.
567 The Delete key is a another casualty of the ill-defined Backspace
568 problem. To avoid confusion between the Backspace and Delete keys,
569 the Delete key has been assigned an escape sequence to match the
570 vt100 for Execute ("ESC [ 3 ~") and is in the supplied
573 Some other Backspace problems:
575 some editors use termcap/terminfo, some editors (vim I'm told)
576 expect Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for
579 Perhaps someday this will all be resolved in a consistent manner.
581 I don't like the key-bindings. How do I change them?
582 There are some compile-time selections available via configure.
583 Unless you have run "configure" with the "--disable-resources"
584 option you can use the `keysym' resource to alter the keystrings
585 associated with keysyms.
587 Here's an example for a URxvt session started using "rxvt -name
590 URxvt.keysym.Home: \033[1~
591 URxvt.keysym.End: \033[4~
592 URxvt.keysym.C-apostrophe: \033<C-'>
593 URxvt.keysym.C-slash: \033<C-/>
594 URxvt.keysym.C-semicolon: \033<C-;>
595 URxvt.keysym.C-grave: \033<C-`>
596 URxvt.keysym.C-comma: \033<C-,>
597 URxvt.keysym.C-period: \033<C-.>
598 URxvt.keysym.C-0x60: \033<C-`>
599 URxvt.keysym.C-Tab: \033<C-Tab>
600 URxvt.keysym.C-Return: \033<C-Return>
601 URxvt.keysym.S-Return: \033<S-Return>
602 URxvt.keysym.S-space: \033<S-Space>
603 URxvt.keysym.M-Up: \033<M-Up>
604 URxvt.keysym.M-Down: \033<M-Down>
605 URxvt.keysym.M-Left: \033<M-Left>
606 URxvt.keysym.M-Right: \033<M-Right>
607 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
608 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
609 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
611 See some more examples in the documentation for the keysym resource.
613 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How
614 do I make use of them? For example, the Sun Keyboard type 4 has the
615 following mappings that rxvt-unicode doesn't recognize.
623 Rather than have rxvt-unicode try to accommodate all the various
624 possible keyboard mappings, it is better to use `xmodmap' to remap
625 the keys as required for your particular machine.
627 How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
628 I need this to decide about setting colors etc.
629 rxvt and rxvt-unicode always export the variable "COLORTERM", so you
630 can check and see if that is set. Note that several programs, JED,
631 slrn, Midnight Commander automatically check this variable to decide
632 whether or not to use color.
634 How do I set the correct, full IP address for the DISPLAY variable?
635 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
636 insecure mode then it is possible to use the following shell script
637 snippets to correctly set the display. If your version of
638 rxvt-unicode wasn't also compiled with ESCZ_ANSWER (as assumed in
639 these snippets) then the COLORTERM variable can be used to
640 distinguish rxvt-unicode from a regular xterm.
642 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell
645 # Bourne/Korn/POSIX family of shells:
646 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
647 if [ ${TERM:-foo} = xterm ]; then
648 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
652 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
653 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
654 read DISPLAY # set it in our local shell
658 How do I compile the manual pages for myself?
659 You need to have a recent version of perl installed as
660 /usr/bin/perl, one that comes with pod2man, pod2text and pod2html.
661 Then go to the doc subdirectory and enter "make alldoc".
663 My question isn't answered here, can I ask a human?
664 Before sending me mail, you could go to IRC: "irc.freenode.net",
665 channel "#rxvt-unicode" has some rxvt-unicode enthusiasts that might
666 be interested in learning about new and exciting problems (but not
669 RXVT TECHNICAL REFERENCE
671 The rest of this document describes various technical aspects of
672 rxvt-unicode. First the description of supported command sequences,
673 followed by menu and pixmap support and last by a description of all
674 features selectable at "configure" time.
677 "c" The literal character c.
679 "C" A single (required) character.
682 A single (usually optional) numeric parameter, composed of one or
686 A multiple numeric parameter composed of any number of single
687 numeric parameters, separated by ";" character(s).
690 A text parameter composed of printable characters.
694 Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes
695 from terminal. See "ESC [ Ps c".
704 Horizontal Tab (HT) (Ctrl-I)
707 Line Feed or New Line (NL) (Ctrl-J)
710 Vertical Tab (Ctrl-K) same as "LF"
713 Form Feed or New Page (NP) (Ctrl-L) same as "LF"
716 Carriage Return (Ctrl-M)
719 Shift Out (Ctrl-N), invokes the G1 character set. Switch to
720 Alternate Character Set
723 Shift In (Ctrl-O), invokes the G0 character set (the default).
724 Switch to Standard Character Set
731 DEC Screen Alignment Test (DECALN)
740 Application Keypad (SMKX). See also next sequence.
745 Note: If the numeric keypad is activated, eg, Num_Lock has been
746 pressed, numbers or control functions are generated by the numeric
747 keypad (see Key Codes).
762 Single Shift Select of G2 Character Set (SS2): affects next
763 character only *unimplemented*
766 Single Shift Select of G3 Character Set (SS3): affects next
767 character only *unimplemented*
770 Obsolete form of returns: "ESC [ ? 1 ; 2 C" *rxvt-unicode
777 Invoke the G2 Character Set (LS2)
780 Invoke the G3 Character Set (LS3)
783 Designate G0 Character Set (ISO 2022), see below for values of "C".
786 Designate G1 Character Set (ISO 2022), see below for values of "C".
789 Designate G2 Character Set (ISO 2022), see below for values of "C".
792 Designate G3 Character Set (ISO 2022), see below for values of "C".
795 Designate Kanji Character Set
799 C = 0 DEC Special Character and Line Drawing Set
800 C = A United Kingdom (UK)
801 C = B United States (USASCII)
802 C = < Multinational character set unimplemented
803 C = 5 Finnish character set unimplemented
804 C = C Finnish character set unimplemented
805 C = K German character set unimplemented
809 CSI (Command Sequence Introducer) Sequences
811 Insert "Ps" (Blank) Character(s) [default: 1] (ICH)
814 Cursor Up "Ps" Times [default: 1] (CUU)
817 Cursor Down "Ps" Times [default: 1] (CUD)
820 Cursor Forward "Ps" Times [default: 1] (CUF)
823 Cursor Backward "Ps" Times [default: 1] (CUB)
826 Cursor Down "Ps" Times [default: 1] and to first column
829 Cursor Up "Ps" Times [default: 1] and to first column
832 Cursor to Column "Ps" (HPA)
835 Cursor Position [row;column] [default: 1;1] (CUP)
838 Move forward "Ps" tab stops [default: 1]
841 Erase in Display (ED)
843 Ps = 0 Clear Below (default)
850 Ps = 0 Clear to Right (default)
855 Insert "Ps" Line(s) [default: 1] (IL)
858 Delete "Ps" Line(s) [default: 1] (DL)
861 Delete "Ps" Character(s) [default: 1] (DCH)
863 "ESC [ Ps;Ps;Ps;Ps;Ps T"
864 Initiate . *unimplemented* Parameters are
865 [func;startx;starty;firstrow;lastrow].
871 Ps = 2 Tab Clear (TBC), Clear Current Column (default)
872 Ps = 5 Tab Clear (TBC), Clear All
875 Erase "Ps" Character(s) [default: 1] (ECH)
878 Move backward "Ps" [default: 1] tab stops
887 Send Device Attributes (DA) "Ps = 0" (or omitted): request
888 attributes from terminal returns: "ESC [ ? 1 ; 2 c" (``I am a VT100
889 with Advanced Video Option'')
892 Cursor to Line "Ps" (VPA)
898 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
903 Ps = 0 Clear Current Column (default)
904 Ps = 3 Clear All (TBC)
907 Set Mode (SM). See "ESC [ Pm l" sequence for description of "Pm".
910 Printing. See also the "print-pipe" resource.
912 Ps = 0 print screen (MC0)
913 Ps = 4 disable transparent print mode (MC4)
914 Ps = 5 enable transparent print mode (MC5)
921 l Replace Mode (RMIR)
923 "Ps = 20" (partially implemented)
924 h Automatic Newline (LNM)
925 l Normal Linefeed (LNM)
928 Character Attributes (SGR)
930 Ps = 0 Normal (default)
931 Ps = 1 / 21 On / Off Bold (bright fg)
932 Ps = 3 / 23 On / Off Italic
933 Ps = 4 / 24 On / Off Underline
934 Ps = 5 / 25 On / Off Slow Blink (bright bg)
935 Ps = 6 / 26 On / Off Rapid Blink (bright bg)
936 Ps = 7 / 27 On / Off Inverse
937 Ps = 8 / 27 On / Off Invisible (NYI)
938 Ps = 30 / 40 fg/bg Black
939 Ps = 31 / 41 fg/bg Red
940 Ps = 32 / 42 fg/bg Green
941 Ps = 33 / 43 fg/bg Yellow
942 Ps = 34 / 44 fg/bg Blue
943 Ps = 35 / 45 fg/bg Magenta
944 Ps = 36 / 46 fg/bg Cyan
945 Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6)
946 Ps = 37 / 47 fg/bg White
947 Ps = 39 / 49 fg/bg Default
948 Ps = 90 / 100 fg/bg Bright Black
949 Ps = 91 / 101 fg/bg Bright Red
950 Ps = 92 / 102 fg/bg Bright Green
951 Ps = 93 / 103 fg/bg Bright Yellow
952 Ps = 94 / 104 fg/bg Bright Blue
953 Ps = 95 / 105 fg/bg Bright Magenta
954 Ps = 96 / 106 fg/bg Bright Cyan
955 Ps = 97 / 107 fg/bg Bright White
956 Ps = 99 / 109 fg/bg Bright Default
959 Device Status Report (DSR)
961 Ps = 5 Status Report ESC [ 0 n (``OK'')
962 Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
963 Ps = 7 Request Display Name
964 Ps = 8 Request Version Number (place in window title)
967 Set Scrolling Region [top;bottom] [default: full size of window]
976 Ps = 1 Deiconify (map) window
977 Ps = 2 Iconify window
978 Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
979 Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
982 Ps = 7 Refresh screen once
983 Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
984 Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
985 Ps = 13 Report window position (responds with Ps = 3)
986 Ps = 14 Report window pixel size (responds with Ps = 4)
987 Ps = 18 Report window text size (responds with Ps = 7)
988 Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
989 Ps = 20 Reports icon label (ESC ] L NAME \234)
990 Ps = 21 Reports window title (ESC ] l NAME \234)
991 Ps = 24.. Set window height to Ps rows
997 Request Terminal Parameters (DECREQTPARM)
1003 DEC Private Mode Set (DECSET)
1006 DEC Private Mode Reset (DECRST)
1009 Restore previously saved DEC Private Mode Values.
1012 Save DEC Private Mode Values.
1015 Toggle DEC Private Mode Values (rxvt extension). *where*
1018 h Application Cursor Keys
1019 l Normal Cursor Keys
1021 "Ps = 2" (ANSI/VT52 mode)
1026 h 132 Column Mode (DECCOLM)
1027 l 80 Column Mode (DECCOLM)
1030 h Smooth (Slow) Scroll (DECSCLM)
1031 l Jump (Fast) Scroll (DECSCLM)
1034 h Reverse Video (DECSCNM)
1035 l Normal Video (DECSCNM)
1038 h Origin Mode (DECOM)
1039 l Normal Cursor Mode (DECOM)
1042 h Wraparound Mode (DECAWM)
1043 l No Wraparound Mode (DECAWM)
1045 "Ps = 8" *unimplemented*
1046 h Auto-repeat Keys (DECARM)
1047 l No Auto-repeat Keys (DECARM)
1050 h Send Mouse X & Y on button press.
1051 l No mouse reporting.
1058 h Visible cursor {cnorm/cvvis}
1059 l Invisible cursor {civis}
1062 h scrollBar visisble
1063 l scrollBar invisisble
1066 h Allow XTerm Shift+key sequences
1067 l Disallow XTerm Shift+key sequences
1069 "Ps = 38" *unimplemented*
1070 Enter Tektronix Mode (DECTEK)
1074 l Disallow 80/132 Mode
1076 "Ps = 44" *unimplemented*
1077 h Turn On Margin Bell
1078 l Turn Off Margin Bell
1080 "Ps = 45" *unimplemented*
1081 h Reverse-wraparound Mode
1082 l No Reverse-wraparound Mode
1084 "Ps = 46" *unimplemented*
1086 h Use Alternate Screen Buffer
1087 l Use Normal Screen Buffer
1092 h Application Keypad (DECPAM) == ESC =
1093 l Normal Keypad (DECPNM) == ESC >
1096 h Backspace key sends BS (DECBKM)
1097 l Backspace key sends DEL
1099 "Ps = 1000" (X11 XTerm)
1100 h Send Mouse X & Y on button press and release.
1101 l No mouse reporting.
1103 "Ps = 1001" (X11 XTerm) *unimplemented*
1104 h Use Hilite Mouse Tracking.
1105 l No mouse reporting.
1108 h Don't scroll to bottom on TTY output
1109 l Scroll to bottom on TTY output
1112 h Scroll to bottom when a key is pressed
1113 l Don't scroll to bottom when a key is pressed
1116 h Use Alternate Screen Buffer
1117 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1120 h Save cursor position
1121 l Restore cursor position
1124 h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1125 l Use Normal Screen Buffer
1129 XTerm Operating System Commands
1131 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \
1132 (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also
1133 accepted. any octet can be escaped by prefixing it with SYN (0x16,
1136 Ps = 0 Change Icon Name and Window Title to Pt
1137 Ps = 1 Change Icon Name to Pt
1138 Ps = 2 Change Window Title to Pt
1139 Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.
1140 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
1141 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1142 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1143 Ps = 12 Change colour of text cursor foreground to Pt
1144 Ps = 13 Change colour of mouse foreground to Pt
1145 Ps = 17 Change colour of highlight characters to Pt
1146 Ps = 18 Change colour of bold characters to Pt
1147 Ps = 19 Change colour of underlined characters to Pt
1148 Ps = 20 Change default background to Pt
1149 Ps = 39 Change default foreground colour to Pt rxvt compile-time option
1150 Ps = 46 Change Log File to Pt unimplemented
1151 Ps = 49 Change default background colour to Pt rxvt compile-time option
1152 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1153 Ps = 55 Log all scrollback buffer and all of screen to Pt
1154 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension)
1155 Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension)
1156 Ps = 704 Change colour of italic characters to Pt
1157 Ps = 705 Change background pixmap tint colour to Pt
1158 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1159 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50.
1160 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50.
1161 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50.
1166 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1167 use menuBar commands that add or remove a menuBar.
1169 Note that in all of the commands, the */path/* *cannot* be omitted: use
1170 ./ to specify a menu relative to the current menu.
1172 Overview of menuBar operation
1173 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1174 "Pt" can be used for a variety of tasks:
1176 At the top level is the current menuBar which is a member of a circular
1177 linked-list of other such menuBars.
1179 The menuBar acts as a parent for the various drop-down menus, which in
1180 turn, may have labels, separator lines, menuItems and subMenus.
1182 The menuItems are the useful bits: you can use them to mimic keyboard
1183 input or even to send text or escape sequences back to rxvt.
1185 The menuBar syntax is intended to provide a simple yet robust method of
1186 constructing and manipulating menus and navigating through the menuBars.
1188 The first step is to use the tag [menu:*name*] which creates the menuBar
1189 called *name* and allows access. You may now or menus, subMenus, and
1190 menuItems. Finally, use the tag [done] to set the menuBar access as
1191 readonly to prevent accidental corruption of the menus. To re-access the
1192 current menuBar for alterations, use the tag [menu], make the
1193 alterations and then use [done]
1199 access the named menuBar for creation or alteration. If a new
1200 menuBar is created, it is called *name* (max of 15 chars) and the
1201 current menuBar is pushed onto the stack
1204 access the current menuBar for alteration
1207 set the current menuBar's title to *string*, which may contain the
1208 following format specifiers: %% : literal % character %n : rxvt name
1209 (as per the -name command-line option) %v : rxvt version
1212 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1216 read menu commands directly from *file* (extension ".menu" will be
1217 appended if required.) Start reading at a line with [menu] or
1218 [menu:+*name* and continuing until [done] is encountered.
1220 Blank and comment lines (starting with #) are ignored. Actually,
1221 since any invalid menu commands are also ignored, almost anything
1222 could be construed as a comment line, but this may be tightened up
1223 in the future ... so don't count on it!.
1225 [read:+*file*;+*name*]
1226 The same as [read:+*file*], but start reading at a line with
1227 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1231 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1235 remove the named menuBar
1238 remove the current menuBar
1244 swap the top two menuBars
1247 access the previous menuBar
1250 access the next menuBar
1253 Enable display of the menuBar
1256 Disable display of the menuBar
1259 [pixmap:+*name*;*scaling*]
1260 (set the background pixmap globally
1262 A Future implementation *may* make this local to the menubar)
1265 ignore the menu readonly status and issue a *command* to or a menu
1266 or menuitem or change the ; a useful shortcut for setting the quick
1267 arrows from a menuBar.
1271 Adding and accessing menus
1272 The following commands may also be + prefixed.
1274 /+ access menuBar top level
1276 ./+ access current menu level
1279 access parent menu (1 level up)
1282 access parent menu (multiple levels up)
1288 add/access menu and clear it if it exists
1296 */path/*{item} action
1297 add/alter *menuitem* with an associated *action*
1299 */path/*{item}{right-text}
1300 add/alter *menuitem* with right-text as the right-justified text and
1301 as the associated *action*
1303 */path/*{item}{rtext} action
1304 add/alter *menuitem* with an associated *action* and with rtext as
1305 the right-justified text.
1307 Special characters in *action* must be backslash-escaped:
1308 \a \b \E \e \n \r \t \octal
1310 or in control-character notation:
1311 ^@, ^A .. ^Z .. ^_, ^?
1313 To send a string starting with a NUL (^@) character to the program,
1314 start *action* with a pair of NUL characters (^@^@), the first of which
1315 will be stripped off and the balance directed to the program. Otherwise
1316 if *action* begins with NUL followed by non-+NUL characters, the leading
1317 NUL is stripped off and the balance is sent back to rxvt.
1319 As a convenience for the many Emacs-type editors, *action* may start
1320 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1321 missed from M-x commands.
1323 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1324 quick arrow), a BEL (^G) will be appended if needed.
1327 M-xapropos is equivalent to \Exapropos\r
1329 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1331 The option {*right-rtext*} will be right-justified. In the absence of a
1332 specified action, this text will be used as the *action* as well.
1335 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1337 The left label *is* necessary, since it's used for matching, but
1338 implicitly hiding the left label (by using same name for both left and
1339 right labels), or explicitly hiding the left label (by preceeding it
1340 with a dot), makes it possible to have right-justified text only.
1343 /File/{Open}{Open} Open-File-Action
1346 /File/{.anylabel}{Open} Open-File-Action
1352 remove all menus from the menuBar, the same as [clear]
1364 remove all items, separators and submenus from menu
1369 The menus also provide a hook for *quick arrows* to provide easier user
1370 access. If nothing has been explicitly set, the default is to emulate
1371 the curror keys. The syntax permits each arrow to be altered
1372 individually or all four at once without re-entering their common
1373 beginning/end text. For example, to explicitly associate cursor actions
1374 with the arrows, any of the following forms could be used:
1380 Define actions for the respective arrow buttons
1384 Define common beginning/end parts for *quick arrows* which used in
1385 conjunction with the above <r> <l> <u> <d> constructs
1387 For example, define arrows individually,
1397 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1399 or more compactly (factoring out common parts)
1400 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1405 A short summary of the most *common* commands:
1408 use an existing named menuBar or start a new one
1411 use the current menuBar
1417 set menu access to readonly and, if reading from a file, signal EOF
1420 if reading from a file using [read:file;name] signal EOF
1423 remove named menuBar(s)
1426 remove current menuBar
1429 remove all menuBar(s)
1432 swap top two menuBars
1435 access the previous menuBar
1438 access the next menuBar
1447 [pixmap;file;scaling]
1448 set a background pixmap
1452 read in a menu from a file
1455 dump out all menuBars to /tmp/rxvt-PID
1457 / access menuBar top level
1462 access current or parent menu level
1470 /path/{item}{rtext} action
1473 -/* remove all menus from the menuBar
1476 remove menu items, separators and submenus from menu
1487 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1491 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1492 can be the name of the background pixmap followed by a sequence of
1493 scaling/positioning commands separated by semi-colons. The
1494 scaling/positioning commands are as follows:
1496 query scale/position
1499 change scale and position
1504 WxH (same as WxH+50+50)
1506 W+X+Y (same as WxW+X+Y)
1508 W+X (same as WxW+X+X)
1510 W (same as WxW+50+50)
1512 change position (absolute)
1517 change position (relative)
1530 load funky.xpm as a tiled image
1533 load mona.xpm with a scaling of 100%
1536 rescale the current pixmap to 200% and display the image geometry in
1540 "ESC [ M <b> <x> <y>"
1541 report mouse position
1543 The lower 2 bits of "<b>" indicate the button:
1545 Button = "(<b> - SPACE) & 3"
1549 3 button released (X11 mouse report)
1551 The upper bits of "<b>" indicate the modifiers when the button was
1552 pressed and are added together (X11 mouse report only):
1554 State = "(<b> - SPACE) & 60"
1558 32 Double Click (Rxvt extension)
1565 Note: Shift + F1-F10 generates F11-F20
1567 For the keypad, use Shift to temporarily override Application-Keypad
1568 setting use Num_Lock to toggle Application-Keypad setting if Num_Lock is
1569 off, toggle Application-Keypad setting. Also note that values of Home,
1570 End, Delete may have been compiled differently on your system.
1572 Normal Shift Control Ctrl+Shift
1573 Tab ^I ESC [ Z ^I ESC [ Z
1574 BackSpace ^H ^? ^? ^?
1575 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1576 Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
1577 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1578 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1579 Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
1580 Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
1581 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1582 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1583 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1584 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1585 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1586 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1587 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1588 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1589 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1590 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1591 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1592 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
1593 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
1594 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
1595 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
1596 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
1597 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
1598 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
1599 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
1600 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
1601 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
1602 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
1603 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
1605 Up ESC [ A ESC [ a ESC O a ESC O A
1606 Down ESC [ B ESC [ b ESC O b ESC O B
1607 Right ESC [ C ESC [ c ESC O c ESC O C
1608 Left ESC [ D ESC [ d ESC O d ESC O D
1610 KP_F1 ESC O P ESC O P
1611 KP_F2 ESC O Q ESC O Q
1612 KP_F3 ESC O R ESC O R
1613 KP_F4 ESC O S ESC O S
1614 XK_KP_Multiply * ESC O j
1616 XK_KP_Separator , ESC O l
1617 XK_KP_Subtract - ESC O m
1618 XK_KP_Decimal . ESC O n
1619 XK_KP_Divide / ESC O o
1632 General hint: if you get compile errors, then likely your configuration
1633 hasn't been tested well. Either try with --enable-everything or use the
1634 ./reconf script as a base for experiments. ./reconf is used by myself,
1635 so it should generally be a working config. Of course, you should always
1636 report when a combination doesn't work, so it can be fixed. Marc Lehmann
1640 Add support for all non-multichoice options listed in "./configure
1641 --help". Note that unlike other enable options this is order
1642 dependant. You can specify this and then disable options which this
1643 enables by *following* this with the appropriate commands.
1646 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1647 are slower and require lots of memory, but as long as you don't use
1648 them, you don't pay for them.
1650 --enable-font-styles
1651 Add support for bold, *italic* and *bold italic* font styles. The
1652 fonts can be set manually or automatically.
1654 --with-codesets=NAME,...
1655 Compile in support for additional codeset (encoding) groups (eu, vn
1656 are always compiled in, which includes most 8-bit character sets).
1657 These codeset tables are currently only used for driving X11 core
1658 fonts, they are not required for Xft fonts. Compiling them in will
1659 make your binary bigger (together about 700kB), but it doesn't
1660 increase memory usage unless you use an X11 font requiring one of
1663 all all available codeset groups
1664 zh common chinese encodings
1665 zh_ext rarely used but very big chinese encodigs
1666 jp common japanese encodings
1667 jp_ext rarely used but big japanese encodings
1671 Add support for XIM (X Input Method) protocol. This allows using
1672 alternative input methods (e.g. kinput2) and will also correctly set
1673 up the input for people using dead keys or compose keys.
1676 Enable direct support for displaying unicode codepoints above 65535
1677 (the basic multilingual page). This increases storage requirements
1678 per character from 2 to 4 bytes. X11 fonts do not yet support these
1679 extra characters, but Xft does.
1681 Please note that rxvt-unicode can store unicode code points >65535
1682 even without this flag, but the number of such characters is limited
1683 to a view thousand (shared with combining characters, see next
1684 switch), and right now rxvt-unicode cannot display them
1685 (input/output and cut&paste still work, though).
1688 Enable automatic composition of combining characters into composite
1689 characters. This is required for proper viewing of text where
1690 accents are encoded as seperate unicode characters. This is done by
1691 using precomposited characters when available or creating new
1692 pseudo-characters when no precomposed form exists.
1694 Without --enable-unicode3, the number of additional precomposed
1695 characters is rather limited (2048, if this is full, rxvt will use
1696 the private use area, extending the number of combinations to 8448).
1697 With --enable-unicode3, no practical limit exists. This will also
1698 enable storage of characters >65535.
1700 The combining table also contains entries for arabic presentation
1701 forms, but these are not currently used. Bug me if you want these to
1704 --enable-fallback(=CLASS)
1705 When reading resource settings, also read settings for class CLASS
1706 (default: Rxvt). To disable resource fallback use
1709 --with-res-name=NAME
1710 Use the given name (default: urxvt) as default application name when
1711 reading resources. Specify --with-res-name=rxvt to replace rxvt.
1713 --with-res-class=CLASS
1714 Use the given class (default: URxvt) as default application class
1715 when reading resources. Specify --with-res-class=Rxvt to replace
1719 Write user and tty to utmp file (used by programs like w) at start
1720 of rxvt execution and delete information when rxvt exits.
1723 Write user and tty to wtmp file (used by programs like last) at
1724 start of rxvt execution and write logout when rxvt exits. This
1725 option requires --enable-utmp to also be specified.
1728 Write user and tty to lastlog file (used by programs like lastlogin)
1729 at start of rxvt execution. This option requires --enable-utmp to
1732 --enable-xpm-background
1733 Add support for XPM background pixmaps.
1735 --enable-transparency
1736 Add support for inheriting parent backgrounds thus giving a fake
1737 transparency to the term.
1740 Add support for fading the text when focus is lost.
1743 Add support for tinting of transparent backgrounds.
1746 Add support for our menu bar system (this interacts badly with
1747 dynamic locale switching currently).
1749 --enable-rxvt-scroll
1750 Add support for the original rxvt scrollbar.
1752 --enable-next-scroll
1753 Add support for a NeXT-like scrollbar.
1755 --enable-xterm-scroll
1756 Add support for an Xterm-like scrollbar.
1758 --enable-plain-scroll
1759 Add support for a very unobtrusive, plain-looking scrollbar that is
1760 the favourite of the rxvt-unicode author, having used it for many
1763 --enable-half-shadow
1764 Make shadows on the scrollbar only half the normal width & height.
1765 only applicable to rxvt scrollbars.
1768 Change tty device setting to group "tty" - only use this if your
1769 system uses this type of security.
1771 --disable-backspace-key
1772 Disable any handling of the backspace key by us - let the X server
1775 --disable-delete-key
1776 Disable any handling of the delete key by us - let the X server do
1780 Remove all resources checking.
1782 --enable-xgetdefault
1783 Make resources checking via XGetDefault() instead of our small
1784 version which only checks ~/.Xdefaults, or if that doesn't exist
1787 Please note that nowadays, things like XIM will automatically pull
1788 in and use the full X resource manager, so the overhead of using it
1789 might be very small, if nonexistant.
1792 Add support for our possibly faster memset() function and other
1793 various routines, overriding your system's versions which may have
1794 been hand-crafted in assembly or may require extra libraries to link
1795 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1798 --disable-swapscreen
1799 Remove support for swap screen.
1802 Add support for many small features that are not essential but nice
1803 to have. Normally you want this, but for very small binaries you may
1804 want to disable this.
1806 A non-exhaustive list of features enabled by "--enable-frills"
1807 (possibly in combination with other switches) is:
1810 seperate underline colour
1811 settable border widths and borderless switch
1812 settable extra linespacing
1813 extra window properties (e.g. UTF-8 window names and PID)
1814 iso-14755-2 and -3, and visual feedback
1815 backindex and forwardindex escape sequence
1816 window op and locale change escape sequences
1818 settable insecure mode
1819 keysym remapping support
1822 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1823 Basic support (section 5.1) is enabled by "--enable-frills", while
1824 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1826 --enable-keepscrolling
1827 Add support for continual scrolling of the display when you hold the
1828 mouse button down on a scrollbar arrow.
1831 Add support for scrolling via mouse wheel or buttons 4 & 5.
1833 --enable-slipwheeling
1834 Add support for continual scrolling (using the mouse wheel as an
1835 accelerator) while the control key is held down. This option
1836 requires --enable-mousewheel to also be specified.
1838 --disable-new-selection
1839 Remove support for mouse selection style like that of xterm.
1842 Use Gray Watson's malloc - which is good for debugging See
1843 http://www.letters.com/dmalloc/ for details If you use either this
1844 or the next option, you may need to edit src/Makefile after
1845 compiling to point DINCLUDE and DLIB to the right places.
1847 You can only use either this option and the following (should you
1851 Use Doug Lea's malloc - which is good for a production version See
1852 <http://g.oswego.edu/dl/html/malloc.html> for details.
1854 --enable-smart-resize
1855 Add smart growth/shrink behaviour when changing font size via from
1856 hot keys. This should keep in a fixed position the rxvt corner which
1857 is closest to a corner of the screen.
1859 --enable-cursor-blink
1860 Add support for a blinking cursor.
1862 --enable-pointer-blank
1863 Add support to have the pointer disappear when typing or inactive.
1866 Set the basename for the installed binaries (default: "urxvt",
1867 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to
1868 replace with "rxvt".
1871 Change the environmental variable for the terminal to NAME (default
1874 --with-terminfo=PATH
1875 Change the environmental variable for the path to the terminfo tree
1879 Use the X Window System (pretty much default, eh?).
1881 --with-xpm-includes=DIR
1882 Look for the XPM includes in DIR.
1884 --with-xpm-library=DIR
1885 Look for the XPM library in DIR.
1888 Not needed - define via --enable-xpm-background.
1891 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1892 reworked it from the original Rxvt documentation, which was done by
1893 Geoff Wing <gcw@pobox.com>, who in turn used the XTerm documentation and