3 RXVT REFERENCE - FAQ, command sequences and other background information
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
14 printf '\33]2;%s\007' "new window title"
18 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19 all escape sequences, and other background information.
21 The newest version of this document is also available on the World Wide Web at
22 L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 =head1 FREQUENTLY ASKED QUESTIONS
27 =head2 Meta, Features & Commandline Issues
29 =head3 My question isn't answered here, can I ask a human?
31 Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32 channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33 interested in learning about new and exciting problems (but not FAQs :).
35 =head3 Does it support tabs, can I have a tabbed rxvt-unicode?
37 Beginning with version 7.3, there is a perl extension that implements a
38 simple tabbed terminal. It is installed by default, so any of these should
41 @@RXVT_NAME@@ -pe tabbed
43 URxvt.perl-ext-common: default,tabbed
45 It will also work fine with tabbing functionality of many window managers
46 or similar tabbing programs, and its embedding-features allow it to be
47 embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
48 the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
49 (murxvt) terminal as an example embedding application.
51 =head3 How do I know which rxvt-unicode version I'm using?
53 The version number is displayed with the usage (-h). Also the escape
54 sequence C<ESC [ 8 n> sets the window title to the version number. When
55 using the @@RXVT_NAME@@c client, the version displayed is that of the
58 =head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
60 Rxvt-unicode tries to obey the rule of not charging you for something you
61 don't use. One thing you should try is to configure out all settings that
62 you don't need, for example, Xft support is a resource hog by design,
63 when used. Compiling it out ensures that no Xft font will be loaded
64 accidentally when rxvt-unicode tries to find a font for your characters.
66 Also, many people (me included) like large windows and even larger
67 scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
68 6 bytes per screen cell. For a 160x?? window this amounts to almost a
69 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70 use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71 rxvt-unicode then uses 8 bytes per screen cell.
73 =head3 How can I start @@RXVT_NAME@@d in a race-free way?
75 Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
76 display, create the listening socket and then fork.
78 =head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
80 rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
81 check and see if that is set. Note that several programs, JED, slrn,
82 Midnight Commander automatically check this variable to decide whether or
85 =head3 How do I set the correct, full IP address for the DISPLAY variable?
87 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88 insecure mode then it is possible to use the following shell script
89 snippets to correctly set the display. If your version of rxvt-unicode
90 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
91 the COLORTERM variable can be used to distinguish rxvt-unicode from a
94 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
97 # Bourne/Korn/POSIX family of shells:
98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
99 if [ ${TERM:-foo} = xterm ]; then
100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell
110 =head3 How do I compile the manual pages on my own?
112 You need to have a recent version of perl installed as F</usr/bin/perl>,
113 one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
114 the doc subdirectory and enter C<make alldoc>.
116 =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
118 I often get asked about this, and I think, no, they didn't cause extra
119 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
120 that the urxvt binary is larger (due to some encoding tables always being
121 compiled in), but it actually uses less memory (RSS) after startup. Even
122 with C<--disable-everything>, this comparison is a bit unfair, as many
123 features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
124 already in use in this mode.
126 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything
130 When you C<--enable-everything> (which _is_ unfair, as this involves xft
131 and full locale/XIM support which are quite bloaty inside libX11 and my
132 libc), the two diverge, but not unreasnobaly so.
134 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything
138 The very large size of the text section is explained by the east-asian
139 encoding tables, which, if unused, take up disk space but nothing else
140 and can be compiled out unless you rely on X11 core fonts that use those
141 encodings. The BSS size comes from the 64k emergency buffer that my c++
142 compiler allocates (but of course doesn't use unless you are out of
143 memory). Also, using an xft font instead of a core font immediately adds a
144 few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
147 Of course, due to every character using two or four bytes instead of one,
148 a large scrollback buffer will ultimately make rxvt-unicode use more
151 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
152 still fares rather well. And compared to some monsters like gnome-terminal
153 (21152k + extra 4204k in separate processes) or konsole (22200k + extra
154 43180k in daemons that stay around after exit, plus half a minute of
155 startup time, including the hundreds of warnings it spits out), it fares
158 =head3 Why C++, isn't that unportable/bloated/uncool?
160 Is this a question? :) It comes up very often. The simple answer is: I had
161 to write it, and C++ allowed me to write and maintain it in a fraction
162 of the time and effort (which is a scarce resource for me). Put even
163 shorter: It simply wouldn't exist without C++.
165 My personal stance on this is that C++ is less portable than C, but in
166 the case of rxvt-unicode this hardly matters, as its portability limits
167 are defined by things like X11, pseudo terminals, locale support and unix
168 domain sockets, which are all less portable than C++ itself.
170 Regarding the bloat, see the above question: It's easy to write programs
171 in C that use gobs of memory, an certainly possible to write programs in
172 C++ that don't. C++ also often comes with large libraries, but this is
173 not necessarily the case with GCC. Here is what rxvt links against on my
174 system with a minimal config:
176 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
177 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
178 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
179 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
181 And here is rxvt-unicode:
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
189 No large bloated libraries (of course, none were linked in statically),
190 except maybe libX11 :)
193 =head2 Rendering, Font & Look and Feel Issues
195 =head3 I can't get transparency working, what am I doing wrong?
197 First of all, transparency isn't officially supported in rxvt-unicode, so
198 you are mostly on your own. Do not bug the author about it (but you may
199 bug everybody else). Also, if you can't get it working consider it a rite
200 of passage: ... and you failed.
202 Here are four ways to get transparency. B<Do> read the manpage and option
203 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
205 1. Use inheritPixmap:
207 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40
210 That works. If you think it doesn't, you lack transparency and tinting
211 support, or you are unable to read.
213 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
214 to use effects other than tinting and shading: Just shade/tint/whatever
215 your picture with gimp or any other tool:
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
220 That works. If you think it doesn't, you lack XPM and Perl support, or you
223 3. Use an ARGB visual:
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
227 This requires XFT support, and the support of your X-server. If that
228 doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229 there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230 bugfixes and workarounds for Xft and Xlib to make it work, but that
231 doesn't mean that your WM has the required kludges in place.
233 4. Use xcompmgr and let it do the job:
235 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
238 Then click on a window you want to make transparent. Replace C<0xc0000000>
239 by other values to change the degree of opacity. If it doesn't work and
240 your server crashes, you got to keep the pieces.
242 =head3 Why do some chinese characters look so different than others?
244 This is because there is a difference between script and language --
245 rxvt-unicode does not know which language the text that is output is,
246 as it only knows the unicode character codes. If rxvt-unicode first
247 sees a japanese/chinese character, it might choose a japanese font for
248 display. Subsequent japanese characters will use that font. Now, many
249 chinese characters aren't represented in japanese fonts, so when the first
250 non-japanese character comes up, rxvt-unicode will look for a chinese font
251 -- unfortunately at this point, it will still use the japanese font for
252 chinese characters that are also in the japanese font.
254 The workaround is easy: just tag a chinese font at the end of your font
255 list (see the previous question). The key is to view the font list as
256 a preference list: If you expect more japanese, list a japanese font
257 first. If you expect more chinese, put a chinese font first.
259 In the future it might be possible to switch language preferences at
260 runtime (the internal data structure has no problem with using different
261 fonts for the same character at the same time, but no interface for this
262 has been designed yet).
264 Until then, you might get away with switching fonts at runtime (see L<Can
265 I switch the fonts at runtime?> later in this document).
267 =head3 Why does rxvt-unicode sometimes leave pixel droppings?
269 Most fonts were not designed for terminal use, which means that character
270 size varies a lot. A font that is otherwise fine for terminal use might
271 contain some characters that are simply too wide. Rxvt-unicode will avoid
272 these characters. For characters that are just "a bit" too wide a special
273 "careful" rendering mode is used that redraws adjacent characters.
275 All of this requires that fonts do not lie about character sizes,
276 however: Xft fonts often draw glyphs larger than their acclaimed bounding
277 box, and rxvt-unicode has no way of detecting this (the correct way is to
278 ask for the character bounding box, which unfortunately is wrong in these
281 It's not clear (to me at least), wether this is a bug in Xft, freetype,
282 or the respective font. If you encounter this problem you might try using
283 the C<-lsp> option to give the font more height. If that doesn't work, you
284 might be forced to use a different font.
286 All of this is not a problem when using X11 core fonts, as their bounding
289 =head3 How can I keep rxvt-unicode from using reverse video so much?
291 First of all, make sure you are running with the right terminal settings
292 (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
293 make sure you have specified colours for italic and bold, as otherwise
294 rxvt-unicode might use reverse video to simulate the effect:
299 =head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
301 For some unexplainable reason, some rare programs assume a very weird
302 colour palette when confronted with a terminal with more than the standard
303 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
304 these programs not to assume non-ISO colours without very good reasons.
306 In the meantime, you can either edit your C<rxvt-unicode> terminfo
307 definition to only claim 8 colour support or use C<TERM=rxvt>, which will
308 fix colours but keep you from using other rxvt-unicode features.
310 =head3 Can I switch the fonts at runtime?
312 Yes, using an escape sequence. Try something like this, which has the same
313 effect as using the C<-fn> switch, and takes effect immediately:
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
317 This is useful if you e.g. work primarily with japanese (and prefer a
318 japanese font), but you have to switch to chinese temporarily, where
319 japanese fonts would only be in your way.
321 You can think of this as a kind of manual ISO-2022 switching.
323 =head3 Why do italic characters look as if clipped?
325 Many fonts have difficulties with italic characters and hinting. For
326 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327 Mono> completely fails in it's italic face. A workaround might be to
328 enable freetype autohinting, i.e. like this:
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
333 =head3 Can I speed up Xft rendering somehow?
335 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
336 it is simply slow. If you still want Xft fonts you might try to disable
337 antialiasing (by appending C<:antialias=false>), which saves lots of
338 memory and also speeds up rendering considerably.
340 =head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
342 Rxvt-unicode will use whatever you specify as a font. If it needs to
343 fall back to it's default font search list it will prefer X11 core
344 fonts, because they are small and fast, and then use Xft fonts. It has
345 antialiasing disabled for most of them, because the author thinks they
348 If you want antialiasing, you have to specify the fonts manually.
350 =head3 What's with this bold/blink stuff?
352 If no bold colour is set via C<colorBD:>, bold will invert text using the
353 standard foreground colour.
355 For the standard background colour, blinking will actually make the
356 text blink when compiled with C<--enable-blinking>. with standard
357 colours. Without C<--enable-blinking>, the blink attribute will be
360 On ANSI colours, bold/blink attributes are used to set high-intensity
361 foreground/background colors.
363 color0-7 are the low-intensity colors.
365 color8-15 are the corresponding high-intensity colors.
367 =head3 I don't like the screen colors. How do I change them?
369 You can change the screen colors at run-time using F<~/.Xdefaults>
370 resources (or as long-options).
372 Here are values that are supposed to resemble a VGA screen,
373 including the murky brown that passes for low-intensity yellow:
375 URxvt.color0: #000000
376 URxvt.color1: #A80000
377 URxvt.color2: #00A800
378 URxvt.color3: #A8A800
379 URxvt.color4: #0000A8
380 URxvt.color5: #A800A8
381 URxvt.color6: #00A8A8
382 URxvt.color7: #A8A8A8
384 URxvt.color8: #000054
385 URxvt.color9: #FF0054
386 URxvt.color10: #00FF54
387 URxvt.color11: #FFFF54
388 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF
393 And here is a more complete set of non-standard colors described (not by
394 me) as "pretty girly".
396 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1
400 URxvt.color0: #000000
401 URxvt.color8: #8b8f93
402 URxvt.color1: #dc74d1
403 URxvt.color9: #dc74d1
404 URxvt.color2: #0eb8c7
405 URxvt.color10: #0eb8c7
406 URxvt.color3: #dfe37e
407 URxvt.color11: #dfe37e
408 URxvt.color5: #9e88f0
409 URxvt.color13: #9e88f0
410 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd
415 =head3 Why do some characters look so much different than others?
419 =head3 How does rxvt-unicode choose fonts?
421 Most fonts do not contain the full range of Unicode, which is
422 fine. Chances are that the font you (or the admin/package maintainer of
423 your system/os) have specified does not cover all the characters you want
426 B<rxvt-unicode> makes a best-effort try at finding a replacement
427 font. Often the result is fine, but sometimes the chosen font looks
428 bad/ugly/wrong. Some fonts have totally strange characters that don't
429 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430 intelligence to detect that a specific glyph is wrong: it has to believe
431 the font that the characters it claims to contain indeed look correct.
433 In that case, select a font of your taste and add it to the font list,
436 @@RXVT_NAME@@ -fn basefont,font2,font3...
438 When rxvt-unicode sees a character, it will first look at the base
439 font. If the base font does not contain the character, it will go to the
440 next font, and so on. Specifying your own fonts will also speed up this
441 search and use less resources within rxvt-unicode and the X-server.
443 The only limitation is that none of the fonts may be larger than the base
444 font, as the base font defines the terminal character cell size, which
445 must be the same due to the way terminals work.
448 =head2 Keyboard, Mouse & User Interaction
450 =head3 The new selection selects pieces that are too big, how can I select single words?
452 If you want to select e.g. alphanumeric words, you can use the following
455 URxvt.selection.pattern-0: ([[:word:]]+)
457 If you click more than twice, the selection will be extended
460 To get a selection that is very similar to the old code, try this pattern:
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
464 Please also note that the I<LeftClick Shift-LeftClik> combination also
465 selects words like the old code.
467 =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
469 You can disable the perl extension completely by setting the
470 B<perl-ext-common> resource to the empty string, which also keeps
471 rxvt-unicode from initialising perl, saving memory.
473 If you only want to disable specific features, you first have to
474 identify which perl extension is responsible. For this, read the section
475 B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
476 example, to disable the B<selection-popup> and B<option-popup>, specify
477 this B<perl-ext-common> resource:
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
481 This will keep the default extensions, but disable the two popup
482 extensions. Some extensions can also be configured, for example,
483 scrollback search mode is triggered by B<M-s>. You can move it to any
484 other combination either by setting the B<searchable-scrollback> resource:
486 URxvt.searchable-scrollback: CM-s
488 =head3 The cursor moves when selecting text in the current input line, how do I switch this off?
492 =head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
494 These are caused by the C<readline> perl extension. Under normal
495 circumstances, it will move your cursor around when you click into the
496 line that contains it. It tries hard not to do this at the wrong moment,
497 but when running a program that doesn't parse cursor movements or in some
498 cases during rlogin sessions, it fails to detect this properly.
500 You can permamently switch this feature off by disabling the C<readline>
503 URxvt.perl-ext-common: default,-readline
505 =head3 My numerical keypad acts weird and generates differing output?
507 Some Debian GNUL/Linux users seem to have this problem, although no
508 specific details were reported so far. It is possible that this is caused
509 by the wrong C<TERM> setting, although the details of wether and how
510 this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511 keymap. See the answer to the previous question, and please report if that
514 =head3 My Compose (Multi_key) key is no longer working.
516 The most common causes for this are that either your locale is not set
517 correctly, or you specified a B<preeditStyle> that is not supported by
518 your input method. For example, if you specified B<OverTheSpot> and
519 your input method (e.g. the default input method handling Compose keys)
520 does not support this (for instance because it is not visual), then
521 rxvt-unicode will continue without an input method.
523 In this case either do not specify a B<preeditStyle> or specify more than
524 one pre-edit style, such as B<OverTheSpot,Root,None>.
526 =head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
528 Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529 international keyboards) or simply use ISO 14755 support to your
530 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
531 codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
534 =head3 Mouse cut/paste suddenly no longer works.
536 Make sure that mouse reporting is actually turned off since killing
537 some editors prematurely may leave the mouse in mouse report mode. I've
538 heard that tcsh may use mouse reporting unless it otherwise specified. A
539 quick check is to see if cut/paste works when the Alt or Shift keys are
542 =head3 What's with the strange Backspace/Delete key behaviour?
544 Assuming that the physical Backspace key corresponds to the
545 BackSpace keysym (not likely for Linux ... see the following
546 question) there are two standard values that can be used for
547 Backspace: C<^H> and C<^?>.
549 Historically, either value is correct, but rxvt-unicode adopts the debian
550 policy of using C<^?> when unsure, because it's the one only only correct
553 Rxvt-unicode tries to inherit the current stty settings and uses the value
554 of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555 started from a terminal (say, from a menu or by remote shell), then the
556 system value of `erase', which corresponds to CERASE in <termios.h>, will
557 be used (which may not be the same as your stty setting).
559 For starting a new rxvt-unicode:
569 Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
571 For an existing rxvt-unicode:
581 This helps satisfy some of the Backspace discrepancies that occur, but
582 if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583 properly reflects that.
585 The Delete key is a another casualty of the ill-defined Backspace problem.
586 To avoid confusion between the Backspace and Delete keys, the Delete
587 key has been assigned an escape sequence to match the vt100 for Execute
588 (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
590 Some other Backspace problems:
592 some editors use termcap/terminfo,
593 some editors (vim I'm told) expect Backspace = ^H,
594 GNU Emacs (and Emacs-like editors) use ^H for help.
596 Perhaps someday this will all be resolved in a consistent manner.
598 =head3 I don't like the key-bindings. How do I change them?
600 There are some compile-time selections available via configure. Unless
601 you have run "configure" with the C<--disable-resources> option you can
602 use the `keysym' resource to alter the keystrings associated with keysyms.
604 Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up>
620 URxvt.keysym.M-Down: \033<M-Down>
621 URxvt.keysym.M-Left: \033<M-Left>
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
627 See some more examples in the documentation for the B<keysym> resource.
629 =head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
638 Rather than have rxvt-unicode try to accommodate all the various possible
639 keyboard mappings, it is better to use `xmodmap' to remap the keys as
640 required for your particular machine.
644 =head2 Terminal Configuration
646 =head3 Why doesn't rxvt-unicode read my resources?
648 Well, why, indeed? It does, in a way very similar to other X
649 applications. Most importantly, this means that if you or your OS loads
650 resources into the X display (the right way to do it), rxvt-unicode will
651 ignore any resource files in your home directory. It will only read
652 F<$HOME/.Xdefaults> when no resources are attached to the display.
654 If you have or use an F<$HOME/.Xresources> file, chances are that
655 resources are loaded into your X-server. In this case, you have to
656 re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
658 Also consider the form resources have to use:
660 URxvt.resource: value
662 If you want to use another form (there are lots of different ways of
663 specifying resources), make sure you understand wether and why it
664 works. If unsure, use the form above.
666 =head3 When I log-in to another system it tells me about missing terminfo data?
668 The terminal description used by rxvt-unicode is not as widely available
669 as that for xterm, or even rxvt (for which the same problem often arises).
671 The correct solution for this problem is to install the terminfo, this can
672 be done like this (with ncurses' infocmp):
674 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
677 ... or by installing rxvt-unicode normally on the remote system,
679 If you cannot or do not want to do this, then you can simply set
680 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681 problems arising, which includes wrong keymapping, less and different
682 colours and some refresh errors in fullscreen applications. It's a nice
683 quick-and-dirty workaround for rare cases, though.
685 If you always want to do this (and are fine with the consequences) you
686 can either recompile rxvt-unicode with the desired TERM value or use a
691 If you don't plan to use B<rxvt> (quite common...) you could also replace
692 the rxvt terminfo file with the rxvt-unicode one.
694 =head3 C<tic> outputs some error when compiling the terminfo entry.
696 Most likely it's the empty definition for C<enacs=>. Just replace it by
697 C<enacs=\E[0@> and try again.
699 =head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
703 =head3 I need a termcap file entry.
705 One reason you might want this is that some distributions or operating
706 systems still compile some programs using the long-obsoleted termcap
707 library (Fedora Core's bash is one example) and rely on a termcap entry
710 You could use rxvt's termcap entry with resonable results in many cases.
711 You can also create a termcap entry by using terminfo's infocmp program
714 infocmp -C rxvt-unicode
716 Or you could use this termcap entry, generated by the command above:
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
739 =head3 Why does C<ls> no longer have coloured output?
741 The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742 decide wether a terminal has colour, but uses it's own configuration
743 file. Needless to say, C<rxvt-unicode> is not in it's default file (among
744 with most other terminals supporting colour). Either add:
748 to C</etc/DIR_COLORS> or simply add:
750 alias ls='ls --color=auto'
752 to your C<.profile> or C<.bashrc>.
754 =head3 Why doesn't vim/emacs etc. use the 88 colour mode?
758 =head3 Why doesn't vim/emacs etc. make use of italic?
762 =head3 Why are the secondary screen-related options not working properly?
764 Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
765 distributions (most notably Debian GNU/Linux) break rxvt-unicode
766 by setting C<TERM> to C<rxvt>, which doesn't have these extra
767 features. Unfortunately, some of these (most notably, again, Debian
768 GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
769 file, so you will need to install it on your own (See the question B<When
770 I log-in to another system it tells me about missing terminfo data?> on
774 =head2 Encoding / Locale / Input Method Issues
776 =head3 Rxvt-unicode does not seem to understand the selected encoding?
780 =head3 Unicode does not seem to work?
782 If you encounter strange problems like typing an accented character but
783 getting two unrelated other characters or similar, or if program output is
784 subtly garbled, then you should check your locale settings.
786 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787 programs. Often rxvt-unicode is started in the C<C> locale, while the
788 login script running within the rxvt-unicode window changes the locale to
789 something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
791 The best thing is to fix your startup environment, as you will likely run
792 into other problems. If nothing works you can try this in your .profile.
794 printf '\e]701;%s\007' "$LC_CTYPE"
796 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797 supported on your systems. Some systems have a C<locale> command which
798 displays this (also, C<perl -e0> can be used to check locale settings, as
799 it will complain loudly if it cannot set the locale). If it displays something
802 locale: Cannot set LC_CTYPE to default locale: ...
804 Then the locale you specified is not supported on your system.
806 If nothing works and you are sure that everything is set correctly then
807 you will need to remember a little known fact: Some programs just don't
810 =head3 How does rxvt-unicode determine the encoding to use?
814 =head3 Is there an option to switch encodings?
816 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
817 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
818 UTF-8 or any other encodings with respect to terminal I/O.
820 The reasons is that there exists a perfectly fine mechanism for selecting
821 the encoding, doing I/O and (most important) communicating this to all
822 applications so everybody agrees on character properties such as width
823 and code number. This mechanism is the I<locale>. Applications not using
824 that info will have problems (for example, C<xterm> gets the width of
825 characters wrong as it uses it's own, locale-independent table under all
828 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829 programs doing the same (that is, most) will automatically agree in the
830 interpretation of characters.
832 Unfortunately, there is no system-independent way to select locales, nor
833 is there a standard on how locale specifiers will look like.
835 On most systems, the content of the C<LC_CTYPE> environment variable
836 contains an arbitrary string which corresponds to an already-installed
837 locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
838 C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
839 (i.e. C<de> or C<german>) are also common.
841 Rxvt-unicode ignores all other locale categories, and except for
842 the encoding, ignores country or language-specific settings,
843 i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
846 If you want to use a specific encoding you have to make sure you start
847 rxvt-unicode with the correct C<LC_CTYPE> category.
849 =head3 Can I switch locales at runtime?
851 Yes, using an escape sequence. Try something like this, which sets
852 rxvt-unicode's idea of C<LC_CTYPE>.
854 printf '\e]701;%s\007' ja_JP.SJIS
856 See also the previous answer.
858 Sometimes this capability is rather handy when you want to work in
859 one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860 (e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861 first switches to a locale supported by xjdic and back later:
863 printf '\e]701;%s\007' ja_JP.SJIS
865 printf '\e]701;%s\007' de_DE.UTF-8
867 You can also use xterm's C<luit> program, which usually works fine, except
868 for some locales where character width differs between program- and
869 rxvt-unicode-locales.
871 =head3 My input method wants <some encoding> but I want UTF-8, what can I do?
873 You can specify separate locales for the input method and the rest of the
874 terminal, using the resource C<imlocale>:
876 URxvt.imlocale: ja_JP.EUC-JP
878 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879 use your input method. Please note, however, that you will not be able to
880 input characters outside C<EUC-JP> in a normal way then, as your input
883 =head3 Rxvt-unicode crashes when the X Input Method changes or exits.
885 Unfortunately, this is unavoidable, as the XIM protocol is racy by
886 design. Applications can avoid some crashes at the expense of memory
887 leaks, and Input Methods can avoid some crashes by careful ordering at
888 exit time. B<kinput2> (and derived input methods) generally succeeds,
889 while B<SCIM> (or similar input methods) fails. In the end, however,
890 crashes cannot be completely avoided even if both sides cooperate.
892 So the only workaround is not to kill your Input Method Servers.
895 =head2 Operating Systems / Package Maintaining
897 =head3 I am using Debian GNU/Linux and have a problem...
899 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900 patches that considerably change the behaviour of rxvt-unicode (but
901 unfortunately this notice has been removed). Before reporting a bug to
902 the original rxvt-unicode author please download and install the genuine
903 version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904 the problem. If you cannot, chances are that the problems are specific to
905 Debian GNU/Linux, in which case it should be reported via the Debian Bug
906 Tracking System (use C<reportbug> to report the bug).
908 For other problems that also affect the Debian package, you can and
909 probably should use the Debian BTS, too, because, after all, it's also a
910 bug in the Debian version and it serves as a reminder for other users that
911 might encounter the same issue.
913 =head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
915 You should build one binary with the default options. F<configure>
916 now enables most useful options, and the trend goes to making them
917 runtime-switchable, too, so there is usually no drawback to enbaling them,
918 except higher disk and possibly memory usage. The perl interpreter should
919 be enabled, as important functionality (menus, selection, likely more in
920 the future) depends on it.
922 You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
923 system-wide (except maybe with C<defaults>). This will result in useful
924 behaviour. If your distribution aims at low memory, add an empty
925 C<perl-ext-common> resource to the app-defaults file. This will keep the
926 perl interpreter disabled until the user enables it.
928 If you can/want build more binaries, I recommend building a minimal
929 one with C<--disable-everything> (very useful) and a maximal one with
930 C<--enable-everything> (less useful, it will be very big due to a lot of
931 encodings built-in that increase download times and are rarely used).
933 =head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
935 It should be, starting with release 7.1. You are encouraged to properly
936 install urxvt with privileges necessary for your OS now.
938 When rxvt-unicode detects that it runs setuid or setgid, it will fork
939 into a helper process for privileged operations (pty handling on some
940 systems, utmp/wtmp/lastlog handling on others) and drop privileges
941 immediately. This is much safer than most other terminals that keep
942 privileges while running (but is more relevant to urxvt, as it contains
943 things as perl interpreters, which might be "helpful" to attackers).
945 This forking is done as the very first within main(), which is very early
946 and reduces possible bugs to initialisation code run before main(), or
947 things like the dynamic loader of your system, which should result in very
950 =head3 On Solaris 9, many line-drawing characters are too wide.
952 Seems to be a known bug, read
953 L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954 following ugly workaround to get non-double-wide-characters working:
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
958 =head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
960 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961 in your compile environment, or an implementation that implements it,
962 wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963 B<wchar_t> is represented as unicode.
965 As you might have guessed, FreeBSD does neither define this symobl nor
966 does it support it. Instead, it uses it's own internal representation of
967 B<wchar_t>. This is, of course, completely fine with respect to standards.
969 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970 C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
972 C<__STDC_ISO_10646__> is the only sane way to support multi-language
973 apps in an OS, as using a locale-dependent (and non-standardized)
974 representation of B<wchar_t> makes it impossible to convert between
975 B<wchar_t> (as used by X11 and your applications) and any other encoding
976 without implementing OS-specific-wrappers for each and every locale. There
977 simply are no APIs to convert B<wchar_t> into anything except the current
980 Some applications (such as the formidable B<mlterm>) work around this
981 by carrying their own replacement functions for character set handling
982 with them, and either implementing OS-dependent hacks or doing multiple
983 conversions (which is slow and unreliable in case the OS implements
984 encodings slightly different than the terminal emulator).
986 The rxvt-unicode author insists that the right way to fix this is in the
987 system libraries once and for all, instead of forcing every app to carry
988 complete replacements for them :)
990 =head3 I use Solaris 9 and it doesn't compile/work/etc.
992 Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993 problems with C<wcwidth> and a compile problem.
995 =head3 How can I use rxvt-unicode under cygwin?
997 rxvt-unicode should compile and run out of the box on cygwin, using
998 the X11 libraries that come with cygwin. libW11 emulation is no
999 longer supported (and makes no sense, either, as it only supported a
1000 single font). I recommend starting the X-server in C<-multiwindow> or
1001 C<-rootless> mode instead, which will result in similar look&feel as the
1002 old libW11 emulation.
1004 At the time of this writing, cygwin didn't seem to support any multi-byte
1005 encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1008 =head1 RXVT TECHNICAL REFERENCE
1012 The rest of this document describes various technical aspects of
1013 B<rxvt-unicode>. First the description of supported command sequences,
1014 followed by pixmap support and last by a description of all features
1015 selectable at C<configure> time.
1023 The literal character c.
1027 A single (required) character.
1031 A single (usually optional) numeric parameter, composed of one or more
1036 A multiple numeric parameter composed of any number of single numeric
1037 parameters, separated by C<;> character(s).
1041 A text parameter composed of printable characters.
1051 Enquiry (Ctrl-E) = Send Device Attributes (DA)
1052 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
1064 Horizontal Tab (HT) (Ctrl-I)
1068 Line Feed or New Line (NL) (Ctrl-J)
1072 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
1076 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
1080 Carriage Return (Ctrl-M)
1084 Shift Out (Ctrl-N), invokes the G1 character set.
1085 Switch to Alternate Character Set
1089 Shift In (Ctrl-O), invokes the G0 character set (the default).
1090 Switch to Standard Character Set
1098 =head1 Escape Sequences
1102 =item B<< C<ESC # 8> >>
1104 DEC Screen Alignment Test (DECALN)
1106 =item B<< C<ESC 7> >>
1110 =item B<< C<ESC 8> >>
1114 =item B<< C<ESC => >>
1116 Application Keypad (SMKX). See also next sequence.
1118 =item B<<< C<< ESC >> >>>
1120 Normal Keypad (RMKX)
1122 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1123 pressed, numbers or control functions are generated by the numeric keypad
1126 =item B<< C<ESC D> >>
1130 =item B<< C<ESC E> >>
1134 =item B<< C<ESC H> >>
1138 =item B<< C<ESC M> >>
1142 =item B<< C<ESC N> >>
1144 Single Shift Select of G2 Character Set (SS2): affects next character
1145 only I<unimplemented>
1147 =item B<< C<ESC O> >>
1149 Single Shift Select of G3 Character Set (SS3): affects next character
1150 only I<unimplemented>
1152 =item B<< C<ESC Z> >>
1154 Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
1156 =item B<< C<ESC c> >>
1160 =item B<< C<ESC n> >>
1162 Invoke the G2 Character Set (LS2)
1164 =item B<< C<ESC o> >>
1166 Invoke the G3 Character Set (LS3)
1168 =item B<< C<ESC ( C> >>
1170 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
1172 =item B<< C<ESC ) C> >>
1174 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
1176 =item B<< C<ESC * C> >>
1178 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
1180 =item B<< C<ESC + C> >>
1182 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
1184 =item B<< C<ESC $ C> >>
1186 Designate Kanji Character Set
1188 Where B<< C<C> >> is one of:
1192 C = C<0> DEC Special Character and Line Drawing Set
1193 C = C<A> United Kingdom (UK)
1194 C = C<B> United States (USASCII)
1195 C = C<< < >> Multinational character set I<unimplemented>
1196 C = C<5> Finnish character set I<unimplemented>
1197 C = C<C> Finnish character set I<unimplemented>
1198 C = C<K> German character set I<unimplemented>
1206 =head1 CSI (Command Sequence Introducer) Sequences
1210 =item B<< C<ESC [ Ps @> >>
1212 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
1214 =item B<< C<ESC [ Ps A> >>
1216 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
1218 =item B<< C<ESC [ Ps B> >>
1220 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
1222 =item B<< C<ESC [ Ps C> >>
1224 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
1226 =item B<< C<ESC [ Ps D> >>
1228 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
1230 =item B<< C<ESC [ Ps E> >>
1232 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
1234 =item B<< C<ESC [ Ps F> >>
1236 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
1238 =item B<< C<ESC [ Ps G> >>
1240 Cursor to Column B<< C<Ps> >> (HPA)
1242 =item B<< C<ESC [ Ps;Ps H> >>
1244 Cursor Position [row;column] [default: 1;1] (CUP)
1246 =item B<< C<ESC [ Ps I> >>
1248 Move forward B<< C<Ps> >> tab stops [default: 1]
1250 =item B<< C<ESC [ Ps J> >>
1252 Erase in Display (ED)
1256 B<< C<Ps = 0> >> Clear Below (default)
1257 B<< C<Ps = 1> >> Clear Above
1258 B<< C<Ps = 2> >> Clear All
1262 =item B<< C<ESC [ Ps K> >>
1268 B<< C<Ps = 0> >> Clear to Right (default)
1269 B<< C<Ps = 1> >> Clear to Left
1270 B<< C<Ps = 2> >> Clear All
1274 =item B<< C<ESC [ Ps L> >>
1276 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
1278 =item B<< C<ESC [ Ps M> >>
1280 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
1282 =item B<< C<ESC [ Ps P> >>
1284 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
1286 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
1288 Initiate . I<unimplemented> Parameters are
1289 [func;startx;starty;firstrow;lastrow].
1291 =item B<< C<ESC [ Ps W> >>
1297 B<< C<Ps = 0> >> Tab Set (HTS)
1298 B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default)
1299 B<< C<Ps = 5> >> Tab Clear (TBC), Clear All
1303 =item B<< C<ESC [ Ps X> >>
1305 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
1307 =item B<< C<ESC [ Ps Z> >>
1309 Move backward B<< C<Ps> >> [default: 1] tab stops
1311 =item B<< C<ESC [ Ps '> >>
1313 See B<< C<ESC [ Ps G> >>
1315 =item B<< C<ESC [ Ps a> >>
1317 See B<< C<ESC [ Ps C> >>
1319 =item B<< C<ESC [ Ps c> >>
1321 Send Device Attributes (DA)
1322 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
1323 returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
1326 =item B<< C<ESC [ Ps d> >>
1328 Cursor to Line B<< C<Ps> >> (VPA)
1330 =item B<< C<ESC [ Ps e> >>
1332 See B<< C<ESC [ Ps A> >>
1334 =item B<< C<ESC [ Ps;Ps f> >>
1336 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1338 =item B<< C<ESC [ Ps g> >>
1344 B<< C<Ps = 0> >> Clear Current Column (default)
1345 B<< C<Ps = 3> >> Clear All (TBC)
1349 =item B<< C<ESC [ Pm h> >>
1351 Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1353 =item B<< C<ESC [ Ps i> >>
1355 Printing. See also the C<print-pipe> resource.
1359 B<< C<Ps = 0> >> print screen (MC0)
1360 B<< C<Ps = 4> >> disable transparent print mode (MC4)
1361 B<< C<Ps = 5> >> enable transparent print mode (MC5)
1365 =item B<< C<ESC [ Pm l> >>
1371 =item B<< C<Ps = 4> >>
1375 B<< C<h> >> Insert Mode (SMIR)
1376 B<< C<l> >> Replace Mode (RMIR)
1380 =item B<< C<Ps = 20> >> (partially implemented)
1384 B<< C<h> >> Automatic Newline (LNM)
1385 B<< C<l> >> Normal Linefeed (LNM)
1391 =item B<< C<ESC [ Pm m> >>
1393 Character Attributes (SGR)
1397 B<< C<Ps = 0> >> Normal (default)
1398 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1399 B<< C<Ps = 3 / 23> >> On / Off Italic
1400 B<< C<Ps = 4 / 24> >> On / Off Underline
1401 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1402 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1403 B<< C<Ps = 7 / 27> >> On / Off Inverse
1404 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
1405 B<< C<Ps = 30 / 40> >> fg/bg Black
1406 B<< C<Ps = 31 / 41> >> fg/bg Red
1407 B<< C<Ps = 32 / 42> >> fg/bg Green
1408 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1409 B<< C<Ps = 34 / 44> >> fg/bg Blue
1410 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1411 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1412 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
1413 B<< C<Ps = 37 / 47> >> fg/bg White
1414 B<< C<Ps = 39 / 49> >> fg/bg Default
1415 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1416 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1417 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1418 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1419 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1420 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1421 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1422 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1423 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
1427 =item B<< C<ESC [ Ps n> >>
1429 Device Status Report (DSR)
1433 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1434 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1435 B<< C<Ps = 7> >> Request Display Name
1436 B<< C<Ps = 8> >> Request Version Number (place in window title)
1440 =item B<< C<ESC [ Ps;Ps r> >>
1442 Set Scrolling Region [top;bottom]
1443 [default: full size of window] (CSR)
1445 =item B<< C<ESC [ s> >>
1449 =item B<< C<ESC [ Ps;Pt t> >>
1455 B<< C<Ps = 1> >> Deiconify (map) window
1456 B<< C<Ps = 2> >> Iconify window
1457 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1458 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1459 B<< C<Ps = 5> >> Raise window
1460 B<< C<Ps = 6> >> Lower window
1461 B<< C<Ps = 7> >> Refresh screen once
1462 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1463 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1464 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1465 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1466 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1467 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1468 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1469 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1470 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1474 =item B<< C<ESC [ u> >>
1478 =item B<< C<ESC [ Ps x> >>
1480 Request Terminal Parameters (DECREQTPARM)
1486 =head1 DEC Private Modes
1490 =item B<< C<ESC [ ? Pm h> >>
1492 DEC Private Mode Set (DECSET)
1494 =item B<< C<ESC [ ? Pm l> >>
1496 DEC Private Mode Reset (DECRST)
1498 =item B<< C<ESC [ ? Pm r> >>
1500 Restore previously saved DEC Private Mode Values.
1502 =item B<< C<ESC [ ? Pm s> >>
1504 Save DEC Private Mode Values.
1506 =item B<< C<ESC [ ? Pm t> >>
1508 Toggle DEC Private Mode Values (rxvt extension). I<where>
1512 =item B<< C<Ps = 1> >> (DECCKM)
1516 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys
1521 =item B<< C<Ps = 2> >> (ANSI/VT52 mode)
1525 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode
1530 =item B<< C<Ps = 3> >>
1534 B<< C<h> >> 132 Column Mode (DECCOLM)
1535 B<< C<l> >> 80 Column Mode (DECCOLM)
1539 =item B<< C<Ps = 4> >>
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1548 =item B<< C<Ps = 5> >>
1552 B<< C<h> >> Reverse Video (DECSCNM)
1553 B<< C<l> >> Normal Video (DECSCNM)
1557 =item B<< C<Ps = 6> >>
1561 B<< C<h> >> Origin Mode (DECOM)
1562 B<< C<l> >> Normal Cursor Mode (DECOM)
1566 =item B<< C<Ps = 7> >>
1570 B<< C<h> >> Wraparound Mode (DECAWM)
1571 B<< C<l> >> No Wraparound Mode (DECAWM)
1575 =item B<< C<Ps = 8> >> I<unimplemented>
1579 B<< C<h> >> Auto-repeat Keys (DECARM)
1580 B<< C<l> >> No Auto-repeat Keys (DECARM)
1584 =item B<< C<Ps = 9> >> X10 XTerm
1588 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting.
1593 =item B<< C<Ps = 25> >>
1597 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis}
1602 =item B<< C<Ps = 30> >>
1606 B<< C<h> >> scrollBar visisble
1607 B<< C<l> >> scrollBar invisisble
1611 =item B<< C<Ps = 35> >> (B<rxvt>)
1615 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences
1620 =item B<< C<Ps = 38> >> I<unimplemented>
1622 Enter Tektronix Mode (DECTEK)
1624 =item B<< C<Ps = 40> >>
1628 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode
1633 =item B<< C<Ps = 44> >> I<unimplemented>
1637 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell
1642 =item B<< C<Ps = 45> >> I<unimplemented>
1646 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode
1651 =item B<< C<Ps = 46> >> I<unimplemented>
1653 =item B<< C<Ps = 47> >>
1657 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer
1664 =item B<< C<Ps = 66> >>
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1673 =item B<< C<Ps = 67> >>
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1682 =item B<< C<Ps = 1000> >> (X11 XTerm)
1686 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting.
1691 =item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
1695 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting.
1700 =item B<< C<Ps = 1010> >> (B<rxvt>)
1704 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output
1709 =item B<< C<Ps = 1011> >> (B<rxvt>)
1713 B<< C<h> >> Scroll to bottom when a key is pressed
1714 B<< C<l> >> Don't scroll to bottom when a key is pressed
1718 =item B<< C<Ps = 1021> >> (B<rxvt>)
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1727 =item B<< C<Ps = 1047> >>
1731 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1736 =item B<< C<Ps = 1048> >>
1740 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position
1745 =item B<< C<Ps = 1049> >>
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer
1760 =head1 XTerm Operating System Commands
1764 =item B<< C<ESC ] Ps;Pt ST> >>
1766 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
1767 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1768 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1772 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1773 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1774 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1775 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.
1776 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
1777 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1778 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1786 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1787 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1788 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> >>
1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1790 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1791 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1801 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1802 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1812 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1813 of B<< C<Pt> >> can be the name of the background pixmap followed by a
1814 sequence of scaling/positioning commands separated by semi-colons. The
1815 scaling/positioning commands are as follows:
1819 =item query scale/position
1823 =item change scale and position
1827 B<WxH+X> (== B<WxH+X+X>)
1829 B<WxH> (same as B<WxH+50+50>)
1831 B<W+X+Y> (same as B<WxW+X+Y>)
1833 B<W+X> (same as B<WxW+X+X>)
1835 B<W> (same as B<WxW+50+50>)
1837 =item change position (absolute)
1841 B<=+X> (same as B<=+X+Y>)
1843 =item change position (relative)
1847 B<+X> (same as B<+X+Y>)
1849 =item rescale (relative)
1851 B<Wx0> -> B<W *= (W/100)>
1853 B<0xH> -> B<H *= (H/100)>
1861 =item B<\E]20;funky\a>
1863 load B<funky.xpm> as a tiled image
1865 =item B<\E]20;mona;100\a>
1867 load B<mona.xpm> with a scaling of 100%
1869 =item B<\E]20;;200;?\a>
1871 rescale the current pixmap to 200% and display the image geometry in
1877 =head1 Mouse Reporting
1881 =item B<< C<< ESC [ M <b> <x> <y> >> >>
1883 report mouse position
1887 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
1891 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
1898 3 button released (X11 mouse report)
1904 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1905 button was pressed and are added together (X11 mouse report only):
1909 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
1916 32 Double Click I<(Rxvt extension)>
1920 Col = B<< C<< <x> - SPACE >> >>
1922 Row = B<< C<< <y> - SPACE >> >>
1929 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1931 For the keypad, use B<Shift> to temporarily override Application-Keypad
1932 setting use B<Num_Lock> to toggle Application-Keypad setting if
1933 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
1934 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
1939 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1940 Tab ^I ESC [ Z ^I ESC [ Z
1941 BackSpace ^H ^? ^? ^?
1942 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1943 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1944 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1945 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1946 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
1947 Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @
1948 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1949 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1950 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1951 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1952 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1953 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1954 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1955 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1956 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1957 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1958 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1959 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
1960 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
1961 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
1962 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
1963 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
1964 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
1965 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
1966 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
1967 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
1968 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
1969 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
1970 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
1972 Up ESC [ A ESC [ a ESC O a ESC O A
1973 Down ESC [ B ESC [ b ESC O b ESC O B
1974 Right ESC [ C ESC [ c ESC O c ESC O C
1975 Left ESC [ D ESC [ d ESC O d ESC O D
1977 KP_F1 ESC O P ESC O P
1978 KP_F2 ESC O Q ESC O Q
1979 KP_F3 ESC O R ESC O R
1980 KP_F4 ESC O S ESC O S
1981 XK_KP_Multiply * ESC O j
1983 XK_KP_Separator , ESC O l
1984 XK_KP_Subtract - ESC O m
1985 XK_KP_Decimal . ESC O n
1986 XK_KP_Divide / ESC O o
2000 =head1 CONFIGURE OPTIONS
2002 General hint: if you get compile errors, then likely your configuration
2003 hasn't been tested well. Either try with C<--enable-everything> or use
2004 the F<./reconf> script as a base for experiments. F<./reconf> is used by
2005 myself, so it should generally be a working config. Of course, you should
2006 always report when a combination doesn't work, so it can be fixed. Marc
2007 Lehmann <rxvt@schmorp.de>.
2013 =item --enable-everything
2015 Add (or remove) support for all non-multichoice options listed in "./configure
2018 You can specify this and then disable options you do not like by
2019 I<following> this with the appropriate C<--disable-...> arguments,
2020 or you can start with a minimal configuration by specifying
2021 C<--disable-everything> and than adding just the C<--enable-...> arguments
2024 =item --enable-xft (default: enabled)
2026 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2027 slower and require lots of memory, but as long as you don't use them, you
2030 =item --enable-font-styles (default: on)
2032 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2033 styles. The fonts can be set manually or automatically.
2035 =item --with-codesets=NAME,... (default: all)
2037 Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2038 are always compiled in, which includes most 8-bit character sets). These
2039 codeset tables are used for driving X11 core fonts, they are not required
2040 for Xft fonts, although having them compiled in lets rxvt-unicode choose
2041 replacement fonts more intelligently. Compiling them in will make your
2042 binary bigger (all of together cost about 700kB), but it doesn't increase
2043 memory usage unless you use a font requiring one of these encodings.
2047 all all available codeset groups
2048 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs
2050 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings
2056 =item --enable-xim (default: on)
2058 Add support for XIM (X Input Method) protocol. This allows using
2059 alternative input methods (e.g. kinput2) and will also correctly
2060 set up the input for people using dead keys or compose keys.
2062 =item --enable-unicode3 (default: off)
2064 Recommended to stay off unless you really need non-BMP characters.
2066 Enable direct support for displaying unicode codepoints above
2067 65535 (the basic multilingual page). This increases storage
2068 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069 support these extra characters, but Xft does.
2071 Please note that rxvt-unicode can store unicode code points >65535
2072 even without this flag, but the number of such characters is
2073 limited to a view thousand (shared with combining characters,
2074 see next switch), and right now rxvt-unicode cannot display them
2075 (input/output and cut&paste still work, though).
2077 =item --enable-combining (default: on)
2079 Enable automatic composition of combining characters into
2080 composite characters. This is required for proper viewing of text
2081 where accents are encoded as seperate unicode characters. This is
2082 done by using precomposited characters when available or creating
2083 new pseudo-characters when no precomposed form exists.
2085 Without --enable-unicode3, the number of additional precomposed
2086 characters is somewhat limited (the 6400 private use characters will be
2087 (ab-)used). With --enable-unicode3, no practical limit exists.
2089 This option will also enable storage (but not display) of characters
2090 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2092 The combining table also contains entries for arabic presentation forms,
2093 but these are not currently used. Bug me if you want these to be used (and
2094 tell me how these are to be used...).
2096 =item --enable-fallback(=CLASS) (default: Rxvt)
2098 When reading resource settings, also read settings for class CLASS. To
2099 disable resource fallback use --disable-fallback.
2101 =item --with-res-name=NAME (default: urxvt)
2103 Use the given name as default application name when
2104 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106 =item --with-res-class=CLASS /default: URxvt)
2108 Use the given class as default application class
2109 when reading resources. Specify --with-res-class=Rxvt to replace
2112 =item --enable-utmp (default: on)
2114 Write user and tty to utmp file (used by programs like F<w>) at
2115 start of rxvt execution and delete information when rxvt exits.
2117 =item --enable-wtmp (default: on)
2119 Write user and tty to wtmp file (used by programs like F<last>) at
2120 start of rxvt execution and write logout when rxvt exits. This
2121 option requires --enable-utmp to also be specified.
2123 =item --enable-lastlog (default: on)
2125 Write user and tty to lastlog file (used by programs like
2126 F<lastlogin>) at start of rxvt execution. This option requires
2127 --enable-utmp to also be specified.
2129 =item --enable-xpm-background (default: on)
2131 Add support for XPM background pixmaps.
2133 =item --enable-transparency (default: on)
2135 Add support for inheriting parent backgrounds thus giving a fake
2136 transparency to the term.
2138 =item --enable-fading (default: on)
2140 Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2142 =item --enable-tinting (default: on)
2144 Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2146 =item --enable-rxvt-scroll (default: on)
2148 Add support for the original rxvt scrollbar.
2150 =item --enable-next-scroll (default: on)
2152 Add support for a NeXT-like scrollbar.
2154 =item --enable-xterm-scroll (default: on)
2156 Add support for an Xterm-like scrollbar.
2158 =item --enable-plain-scroll (default: on)
2160 Add support for a very unobtrusive, plain-looking scrollbar that
2161 is the favourite of the rxvt-unicode author, having used it for
2164 =item --enable-ttygid (default: off)
2166 Change tty device setting to group "tty" - only use this if
2167 your system uses this type of security.
2169 =item --disable-backspace-key
2171 Removes any handling of the backspace key by us - let the X server do it.
2173 =item --disable-delete-key
2175 Removes any handling of the delete key by us - let the X server
2178 =item --disable-resources
2180 Removes any support for resource checking.
2182 =item --disable-swapscreen
2184 Remove support for secondary/swap screen.
2186 =item --enable-frills (default: on)
2188 Add support for many small features that are not essential but nice to
2189 have. Normally you want this, but for very small binaries you may want to
2192 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193 in combination with other switches) is:
2196 EWMH-hints (pid, utf8 names) and protocols (ping)
2197 seperate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth)
2200 settable extra linespacing /-lsp)
2201 iso-14755-2 and -3, and visual feedback
2202 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure)
2204 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc)
2206 XEmbed support (-embed)
2208 hold on exit (-hold)
2209 skip builtin block graphics (-sbg)
2211 It also enabled some non-essential features otherwise disabled, such as:
2213 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection
2216 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences
2219 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences
2221 rectangular selections
2222 trailing space removal for selections
2223 verbose X error handling
2225 =item --enable-iso14755 (default: on)
2227 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2228 F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2229 C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2232 =item --enable-keepscrolling (default: on)
2234 Add support for continual scrolling of the display when you hold
2235 the mouse button down on a scrollbar arrow.
2237 =item --enable-mousewheel (default: on)
2239 Add support for scrolling via mouse wheel or buttons 4 & 5.
2241 =item --enable-slipwheeling (default: on)
2243 Add support for continual scrolling (using the mouse wheel as an
2244 accelerator) while the control key is held down. This option
2245 requires --enable-mousewheel to also be specified.
2247 =item --disable-new-selection
2249 Remove support for mouse selection style like that of xterm.
2251 =item --enable-dmalloc (default: off)
2253 Use Gray Watson's malloc - which is good for debugging See
2254 http://www.letters.com/dmalloc/ for details If you use either this or the
2255 next option, you may need to edit src/Makefile after compiling to point
2256 DINCLUDE and DLIB to the right places.
2258 You can only use either this option and the following (should
2261 =item --enable-dlmalloc (default: off)
2263 Use Doug Lea's malloc - which is good for a production version
2264 See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2266 =item --enable-smart-resize (default: on)
2268 Add smart growth/shrink behaviour when changing font size via hot
2269 keys. This should keep the window corner which is closest to a corner of
2270 the screen in a fixed position.
2272 =item --enable-pointer-blank (default: on)
2274 Add support to have the pointer disappear when typing or inactive.
2276 =item --enable-perl (default: on)
2278 Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279 manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2280 in F<src/perl-ext/> for the extensions that are installed by default. The
2281 perl interpreter that is used can be specified via the C<PERL> environment
2282 variable when running configure.
2284 =item --with-name=NAME (default: urxvt)
2286 Set the basename for the installed binaries, resulting
2287 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2290 =item --with-term=NAME (default: rxvt-unicode)
2292 Change the environmental variable for the terminal to NAME.
2294 =item --with-terminfo=PATH
2296 Change the environmental variable for the path to the terminfo tree to
2301 Use the X Window System (pretty much default, eh?).
2303 =item --with-xpm-includes=DIR
2305 Look for the XPM includes in DIR.
2307 =item --with-xpm-library=DIR
2309 Look for the XPM library in DIR.
2313 Not needed - define via --enable-xpm-background.
2319 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2320 reworked it from the original Rxvt documentation, which was done by Geoff
2321 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other