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://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
24 The main manual page for @@RXVT_NAME@@ itself is available at
25 L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
27 =head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
30 =head2 Meta, Features & Commandline Issues
32 =head3 My question isn't answered here, can I ask a human?
34 Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35 channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36 interested in learning about new and exciting problems (but not FAQs :).
38 =head3 I use Gentoo, and I have a problem...
40 There are three big problems with Gentoo Linux: first of all, most if not
41 all Gentoo systems are completely broken (missing or mismatched header
42 files, broken compiler etc. are just the tip of the iceberg); secondly,
43 the Gentoo maintainer thinks it is a good idea to add broken patches to
44 the code; and lastly, it should be called Gentoo GNU/Linux.
46 For these reasons, it is impossible to support rxvt-unicode on
47 Gentoo. Problems appearing on Gentoo systems will usually simply be
48 ignored unless they can be reproduced on non-Gentoo systems.
50 =head3 Does it support tabs, can I have a tabbed rxvt-unicode?
52 Beginning with version 7.3, there is a perl extension that implements a
53 simple tabbed terminal. It is installed by default, so any of these should
56 @@URXVT_NAME@@ -pe tabbed
58 URxvt.perl-ext-common: default,tabbed
60 It will also work fine with tabbing functionality of many window managers
61 or similar tabbing programs, and its embedding-features allow it to be
62 embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
63 the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
64 (murxvt) terminal as an example embedding application.
66 =head3 How do I know which rxvt-unicode version I'm using?
68 The version number is displayed with the usage (-h). Also the escape
69 sequence C<ESC [ 8 n> sets the window title to the version number. When
70 using the @@URXVT_NAME@@c client, the version displayed is that of the
73 =head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
75 Rxvt-unicode tries to obey the rule of not charging you for something you
76 don't use. One thing you should try is to configure out all settings that
77 you don't need, for example, Xft support is a resource hog by design,
78 when used. Compiling it out ensures that no Xft font will be loaded
79 accidentally when rxvt-unicode tries to find a font for your characters.
81 Also, many people (me included) like large windows and even larger
82 scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
83 6 bytes per screen cell. For a 160x?? window this amounts to almost a
84 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
85 use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
86 rxvt-unicode then uses 8 bytes per screen cell.
88 =head3 How can I start @@URXVT_NAME@@d in a race-free way?
90 Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
91 display, create the listening socket and then fork.
93 =head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
95 If you want to start @@URXVT_NAME@@d automatically whenever you run
96 @@URXVT_NAME@@c and the daemon isn't running yet, use this script:
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
105 This tries to create a new terminal, and if fails with exit status 2,
106 meaning it couldn't connect to the daemon, it will start the daemon and
107 re-run the command. Subsequent invocations of the script will re-use the
110 =head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
112 The original rxvt and rxvt-unicode always export the variable "COLORTERM",
113 so you can check and see if that is set. Note that several programs, JED,
114 slrn, Midnight Commander automatically check this variable to decide
115 whether or not to use color.
117 =head3 How do I set the correct, full IP address for the DISPLAY variable?
119 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
120 insecure mode then it is possible to use the following shell script
121 snippets to correctly set the display. If your version of rxvt-unicode
122 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
123 the COLORTERM variable can be used to distinguish rxvt-unicode from a
126 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
129 # Bourne/Korn/POSIX family of shells:
130 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
131 if [ ${TERM:-foo} = xterm ]; then
132 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
136 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
137 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
138 read DISPLAY # set it in our local shell
142 =head3 How do I compile the manual pages on my own?
144 You need to have a recent version of perl installed as F</usr/bin/perl>,
145 one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
146 F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
148 =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
150 I often get asked about this, and I think, no, they didn't cause extra
151 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
152 that the urxvt binary is larger (due to some encoding tables always being
153 compiled in), but it actually uses less memory (RSS) after startup. Even
154 with C<--disable-everything>, this comparison is a bit unfair, as many
155 features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
156 already in use in this mode.
158 text data bss drs rss filename
159 98398 1664 24 15695 1824 rxvt --disable-everything
160 188985 9048 66616 18222 1788 urxvt --disable-everything
162 When you C<--enable-everything> (which I<is> unfair, as this involves xft
163 and full locale/XIM support which are quite bloaty inside libX11 and my
164 libc), the two diverge, but not unreasonably so.
166 text data bss drs rss filename
167 163431 2152 24 20123 2060 rxvt --enable-everything
168 1035683 49680 66648 29096 3680 urxvt --enable-everything
170 The very large size of the text section is explained by the east-asian
171 encoding tables, which, if unused, take up disk space but nothing else
172 and can be compiled out unless you rely on X11 core fonts that use those
173 encodings. The BSS size comes from the 64k emergency buffer that my c++
174 compiler allocates (but of course doesn't use unless you are out of
175 memory). Also, using an xft font instead of a core font immediately adds a
176 few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
179 Of course, due to every character using two or four bytes instead of one,
180 a large scrollback buffer will ultimately make rxvt-unicode use more
183 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
184 still fares rather well. And compared to some monsters like gnome-terminal
185 (21152k + extra 4204k in separate processes) or konsole (22200k + extra
186 43180k in daemons that stay around after exit, plus half a minute of
187 startup time, including the hundreds of warnings it spits out), it fares
190 =head3 Why C++, isn't that unportable/bloated/uncool?
192 Is this a question? :) It comes up very often. The simple answer is: I had
193 to write it, and C++ allowed me to write and maintain it in a fraction
194 of the time and effort (which is a scarce resource for me). Put even
195 shorter: It simply wouldn't exist without C++.
197 My personal stance on this is that C++ is less portable than C, but in
198 the case of rxvt-unicode this hardly matters, as its portability limits
199 are defined by things like X11, pseudo terminals, locale support and unix
200 domain sockets, which are all less portable than C++ itself.
202 Regarding the bloat, see the above question: It's easy to write programs
203 in C that use gobs of memory, an certainly possible to write programs in
204 C++ that don't. C++ also often comes with large libraries, but this is
205 not necessarily the case with GCC. Here is what rxvt links against on my
206 system with a minimal config:
208 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
209 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
210 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
211 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
213 And here is rxvt-unicode:
215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
221 No large bloated libraries (of course, none were linked in statically),
222 except maybe libX11 :)
225 =head2 Rendering, Font & Look and Feel Issues
227 =head3 I can't get transparency working, what am I doing wrong?
229 First of all, please address all transparency related issues to Sasha Vasko at
230 sasha@aftercode.net and do not bug the author about it. Also, if you can't
231 get it working consider it a rite of passage: ... and you failed.
233 Here are four ways to get transparency. B<Do> read the manpage and option
234 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
236 1. Use transparent mode:
238 Esetroot wallpaper.jpg
239 @@URXVT_NAME@@ -tr -tint red -sh 40
241 That works. If you think it doesn't, you lack transparency and tinting
242 support, or you are unable to read.
244 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
245 to use effects other than tinting and shading: Just shade/tint/whatever
246 your picture with gimp or any other tool:
248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
251 That works. If you think it doesn't, you lack AfterImage support, or you
254 3. Use an ARGB visual:
256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
258 This requires XFT support, and the support of your X-server. If that
259 doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
260 there yet, no matter what they claim. Rxvt-Unicode contains the necessary
261 bugfixes and workarounds for Xft and Xlib to make it work, but that
262 doesn't mean that your WM has the required kludges in place.
264 4. Use xcompmgr and let it do the job:
266 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
267 -set _NET_WM_WINDOW_OPACITY 0xc0000000
269 Then click on a window you want to make transparent. Replace C<0xc0000000>
270 by other values to change the degree of opacity. If it doesn't work and
271 your server crashes, you got to keep the pieces.
273 =head3 Why does rxvt-unicode sometimes leave pixel droppings?
275 Most fonts were not designed for terminal use, which means that character
276 size varies a lot. A font that is otherwise fine for terminal use might
277 contain some characters that are simply too wide. Rxvt-unicode will avoid
278 these characters. For characters that are just "a bit" too wide a special
279 "careful" rendering mode is used that redraws adjacent characters.
281 All of this requires that fonts do not lie about character sizes,
282 however: Xft fonts often draw glyphs larger than their acclaimed bounding
283 box, and rxvt-unicode has no way of detecting this (the correct way is to
284 ask for the character bounding box, which unfortunately is wrong in these
287 It's not clear (to me at least), whether this is a bug in Xft, freetype,
288 or the respective font. If you encounter this problem you might try using
289 the C<-lsp> option to give the font more height. If that doesn't work, you
290 might be forced to use a different font.
292 All of this is not a problem when using X11 core fonts, as their bounding
295 =head3 How can I keep rxvt-unicode from using reverse video so much?
297 First of all, make sure you are running with the right terminal settings
298 (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
299 make sure you have specified colours for italic and bold, as otherwise
300 rxvt-unicode might use reverse video to simulate the effect:
305 =head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
307 For some unexplainable reason, some rare programs assume a very weird
308 colour palette when confronted with a terminal with more than the standard
309 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
310 these programs not to assume non-ISO colours without very good reasons.
312 In the meantime, you can either edit your C<rxvt-unicode> terminfo
313 definition to only claim 8 colour support or use C<TERM=rxvt>, which will
314 fix colours but keep you from using other rxvt-unicode features.
316 =head3 Can I switch the fonts at runtime?
318 Yes, using an escape sequence. Try something like this, which has the same
319 effect as using the C<-fn> switch, and takes effect immediately:
321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
323 This is useful if you e.g. work primarily with japanese (and prefer a
324 japanese font), but you have to switch to chinese temporarily, where
325 japanese fonts would only be in your way.
327 You can think of this as a kind of manual ISO-2022 switching.
329 =head3 Why do italic characters look as if clipped?
331 Many fonts have difficulties with italic characters and hinting. For
332 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
333 Mono> completely fails in its italic face. A workaround might be to
334 enable freetype autohinting, i.e. like this:
336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
339 =head3 Can I speed up Xft rendering somehow?
341 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
342 it is simply slow. If you still want Xft fonts you might try to disable
343 antialiasing (by appending C<:antialias=false>), which saves lots of
344 memory and also speeds up rendering considerably.
346 =head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
348 Rxvt-unicode will use whatever you specify as a font. If it needs to
349 fall back to its default font search list it will prefer X11 core
350 fonts, because they are small and fast, and then use Xft fonts. It has
351 antialiasing disabled for most of them, because the author thinks they
354 If you want antialiasing, you have to specify the fonts manually.
356 =head3 What's with this bold/blink stuff?
358 If no bold colour is set via C<colorBD:>, bold will invert text using the
359 standard foreground colour.
361 For the standard background colour, blinking will actually make
362 the text blink when compiled with C<--enable-text-blink>. Without
363 C<--enable-text-blink>, the blink attribute will be ignored.
365 On ANSI colours, bold/blink attributes are used to set high-intensity
366 foreground/background colors.
368 color0-7 are the low-intensity colors.
370 color8-15 are the corresponding high-intensity colors.
372 =head3 I don't like the screen colors. How do I change them?
374 You can change the screen colors at run-time using F<~/.Xdefaults>
375 resources (or as long-options).
377 Here are values that are supposed to resemble a VGA screen,
378 including the murky brown that passes for low-intensity yellow:
380 URxvt.color0: #000000
381 URxvt.color1: #A80000
382 URxvt.color2: #00A800
383 URxvt.color3: #A8A800
384 URxvt.color4: #0000A8
385 URxvt.color5: #A800A8
386 URxvt.color6: #00A8A8
387 URxvt.color7: #A8A8A8
389 URxvt.color8: #000054
390 URxvt.color9: #FF0054
391 URxvt.color10: #00FF54
392 URxvt.color11: #FFFF54
393 URxvt.color12: #0000FF
394 URxvt.color13: #FF00FF
395 URxvt.color14: #00FFFF
396 URxvt.color15: #FFFFFF
398 And here is a more complete set of non-standard colors.
400 URxvt.cursorColor: #dc74d1
401 URxvt.pointerColor: #dc74d1
402 URxvt.background: #0e0e0e
403 URxvt.foreground: #4ad5e1
404 URxvt.color0: #000000
405 URxvt.color8: #8b8f93
406 URxvt.color1: #dc74d1
407 URxvt.color9: #dc74d1
408 URxvt.color2: #0eb8c7
409 URxvt.color10: #0eb8c7
410 URxvt.color3: #dfe37e
411 URxvt.color11: #dfe37e
412 URxvt.color5: #9e88f0
413 URxvt.color13: #9e88f0
414 URxvt.color6: #73f7ff
415 URxvt.color14: #73f7ff
416 URxvt.color7: #e1dddd
417 URxvt.color15: #e1dddd
419 They have been described (not by me) as "pretty girly".
421 =head3 Why do some characters look so much different than others?
425 =head3 How does rxvt-unicode choose fonts?
427 Most fonts do not contain the full range of Unicode, which is
428 fine. Chances are that the font you (or the admin/package maintainer of
429 your system/os) have specified does not cover all the characters you want
432 B<rxvt-unicode> makes a best-effort try at finding a replacement
433 font. Often the result is fine, but sometimes the chosen font looks
434 bad/ugly/wrong. Some fonts have totally strange characters that don't
435 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
436 intelligence to detect that a specific glyph is wrong: it has to believe
437 the font that the characters it claims to contain indeed look correct.
439 In that case, select a font of your taste and add it to the font list,
442 @@URXVT_NAME@@ -fn basefont,font2,font3...
444 When rxvt-unicode sees a character, it will first look at the base
445 font. If the base font does not contain the character, it will go to the
446 next font, and so on. Specifying your own fonts will also speed up this
447 search and use less resources within rxvt-unicode and the X-server.
449 The only limitation is that none of the fonts may be larger than the base
450 font, as the base font defines the terminal character cell size, which
451 must be the same due to the way terminals work.
453 =head3 Why do some chinese characters look so different than others?
455 This is because there is a difference between script and language --
456 rxvt-unicode does not know which language the text that is output is,
457 as it only knows the unicode character codes. If rxvt-unicode first
458 sees a japanese/chinese character, it might choose a japanese font for
459 display. Subsequent japanese characters will use that font. Now, many
460 chinese characters aren't represented in japanese fonts, so when the first
461 non-japanese character comes up, rxvt-unicode will look for a chinese font
462 -- unfortunately at this point, it will still use the japanese font for
463 chinese characters that are also in the japanese font.
465 The workaround is easy: just tag a chinese font at the end of your font
466 list (see the previous question). The key is to view the font list as
467 a preference list: If you expect more japanese, list a japanese font
468 first. If you expect more chinese, put a chinese font first.
470 In the future it might be possible to switch language preferences at
471 runtime (the internal data structure has no problem with using different
472 fonts for the same character at the same time, but no interface for this
473 has been designed yet).
475 Until then, you might get away with switching fonts at runtime (see L<Can
476 I switch the fonts at runtime?> later in this document).
478 =head3 How can I make mplayer display video correctly?
480 We are working on it, in the meantime, as a workaround, use something like:
482 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
485 =head2 Keyboard, Mouse & User Interaction
487 =head3 The new selection selects pieces that are too big, how can I select single words?
489 If you want to select e.g. alphanumeric words, you can use the following
492 URxvt.selection.pattern-0: ([[:word:]]+)
494 If you click more than twice, the selection will be extended
497 To get a selection that is very similar to the old code, try this pattern:
499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
501 Please also note that the I<LeftClick Shift-LeftClick> combination also
502 selects words like the old code.
504 =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
506 You can disable the perl extension completely by setting the
507 B<perl-ext-common> resource to the empty string, which also keeps
508 rxvt-unicode from initialising perl, saving memory.
510 If you only want to disable specific features, you first have to
511 identify which perl extension is responsible. For this, read the section
512 B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
513 example, to disable the B<selection-popup> and B<option-popup>, specify
514 this B<perl-ext-common> resource:
516 URxvt.perl-ext-common: default,-selection-popup,-option-popup
518 This will keep the default extensions, but disable the two popup
519 extensions. Some extensions can also be configured, for example,
520 scrollback search mode is triggered by B<M-s>. You can move it to any
521 other combination either by setting the B<searchable-scrollback> resource:
523 URxvt.searchable-scrollback: CM-s
525 =head3 The cursor moves when selecting text in the current input line, how do I switch this off?
529 =head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
531 These are caused by the C<readline> perl extension. Under normal
532 circumstances, it will move your cursor around when you click into the
533 line that contains it. It tries hard not to do this at the wrong moment,
534 but when running a program that doesn't parse cursor movements or in some
535 cases during rlogin sessions, it fails to detect this properly.
537 You can permanently switch this feature off by disabling the C<readline>
540 URxvt.perl-ext-common: default,-readline
542 =head3 My numerical keypad acts weird and generates differing output?
544 Some Debian GNUL/Linux users seem to have this problem, although no
545 specific details were reported so far. It is possible that this is caused
546 by the wrong C<TERM> setting, although the details of whether and how
547 this can happen are unknown, as C<TERM=rxvt> should offer a compatible
548 keymap. See the answer to the previous question, and please report if that
551 =head3 My Compose (Multi_key) key is no longer working.
553 The most common causes for this are that either your locale is not set
554 correctly, or you specified a B<preeditStyle> that is not supported by
555 your input method. For example, if you specified B<OverTheSpot> and
556 your input method (e.g. the default input method handling Compose keys)
557 does not support this (for instance because it is not visual), then
558 rxvt-unicode will continue without an input method.
560 In this case either do not specify a B<preeditStyle> or specify more than
561 one pre-edit style, such as B<OverTheSpot,Root,None>.
563 =head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
565 Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
566 international keyboards) or simply use ISO 14755 support to your
567 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
568 codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
571 =head3 Mouse cut/paste suddenly no longer works.
573 Make sure that mouse reporting is actually turned off since killing
574 some editors prematurely may leave the mouse in mouse report mode. I've
575 heard that tcsh may use mouse reporting unless it otherwise specified. A
576 quick check is to see if cut/paste works when the Alt or Shift keys are
579 =head3 What's with the strange Backspace/Delete key behaviour?
581 Assuming that the physical Backspace key corresponds to the
582 Backspace keysym (not likely for Linux ... see the following
583 question) there are two standard values that can be used for
584 Backspace: C<^H> and C<^?>.
586 Historically, either value is correct, but rxvt-unicode adopts the debian
587 policy of using C<^?> when unsure, because it's the one and only correct
590 Rxvt-unicode tries to inherit the current stty settings and uses the value
591 of `erase' to guess the value for backspace. If rxvt-unicode wasn't
592 started from a terminal (say, from a menu or by remote shell), then the
593 system value of `erase', which corresponds to CERASE in <termios.h>, will
594 be used (which may not be the same as your stty setting).
596 For starting a new rxvt-unicode:
606 Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
608 For an existing rxvt-unicode:
618 This helps satisfy some of the Backspace discrepancies that occur, but
619 if you use Backspace = C<^H>, make sure that the termcap/terminfo value
620 properly reflects that.
622 The Delete key is a another casualty of the ill-defined Backspace problem.
623 To avoid confusion between the Backspace and Delete keys, the Delete
624 key has been assigned an escape sequence to match the vt100 for Execute
625 (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
627 Some other Backspace problems:
629 some editors use termcap/terminfo,
630 some editors (vim I'm told) expect Backspace = ^H,
631 GNU Emacs (and Emacs-like editors) use ^H for help.
633 Perhaps someday this will all be resolved in a consistent manner.
635 =head3 I don't like the key-bindings. How do I change them?
637 There are some compile-time selections available via configure. Unless
638 you have run "configure" with the C<--disable-resources> option you can
639 use the `keysym' resource to alter the keystrings associated with keysyms.
641 Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
643 URxvt.keysym.Home: \033[1~
644 URxvt.keysym.End: \033[4~
645 URxvt.keysym.C-apostrophe: \033<C-'>
646 URxvt.keysym.C-slash: \033<C-/>
647 URxvt.keysym.C-semicolon: \033<C-;>
648 URxvt.keysym.C-grave: \033<C-`>
649 URxvt.keysym.C-comma: \033<C-,>
650 URxvt.keysym.C-period: \033<C-.>
651 URxvt.keysym.C-0x60: \033<C-`>
652 URxvt.keysym.C-Tab: \033<C-Tab>
653 URxvt.keysym.C-Return: \033<C-Return>
654 URxvt.keysym.S-Return: \033<S-Return>
655 URxvt.keysym.S-space: \033<S-Space>
656 URxvt.keysym.M-Up: \033<M-Up>
657 URxvt.keysym.M-Down: \033<M-Down>
658 URxvt.keysym.M-Left: \033<M-Left>
659 URxvt.keysym.M-Right: \033<M-Right>
660 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
661 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
662 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
664 See some more examples in the documentation for the B<keysym> resource.
666 =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
675 Rather than have rxvt-unicode try to accommodate all the various possible
676 keyboard mappings, it is better to use `xmodmap' to remap the keys as
677 required for your particular machine.
680 =head2 Terminal Configuration
682 =head3 Can I see a typical configuration?
684 The default configuration tries to be xterm-like, which I don't like that
685 much, but it's least surprise to regular users.
687 As a rxvt or rxvt-unicode user, you are practically supposed to invest
688 time into customising your terminal. To get you started, here is the
689 author's .Xdefaults entries, with comments on what they do. It's certainly
690 not I<typical>, but what's typical...
692 URxvt.cutchars: "()*,<>[]{}|'
693 URxvt.print-pipe: cat >/tmp/xxx
695 These are just for testing stuff.
697 URxvt.imLocale: ja_JP.UTF-8
698 URxvt.preeditType: OnTheSpot,None
700 This tells rxvt-unicode to use a special locale when communicating with
701 the X Input Method, and also tells it to only use the OnTheSpot pre-edit
702 type, which requires the C<xim-onthespot> perl extension but rewards me
703 with correct-looking fonts.
705 URxvt.perl-lib: /root/lib/urxvt
706 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
707 URxvt.selection.pattern-0: ( at .*? line \\d+)
708 URxvt.selection.pattern-1: ^(/[^:]+):\
709 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
710 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
712 This is my perl configuration. The first two set the perl library
713 directory and also tells urxvt to use a large number of extensions. I
714 develop for myself mostly, so I actually use most of the extensions I
717 The selection stuff mainly makes the selection perl-error-message aware
718 and tells it to convert perl error messages into vi-commands to load the
719 relevant file and go tot he error line number.
721 URxvt.scrollstyle: plain
722 URxvt.secondaryScroll: true
724 As the documentation says: plain is the preferred scrollbar for the
725 author. The C<secondaryScroll> configures urxvt to scroll in full-screen
726 apps, like screen, so lines scrolled out of screen end up in urxvt's
729 URxvt.background: #000000
730 URxvt.foreground: gray90
732 URxvt.colorBD: #ffffff
733 URxvt.cursorColor: #e0e080
734 URxvt.throughColor: #8080f0
735 URxvt.highlightColor: #f0f0f0
737 Some colours. Not sure which ones are being used or even non-defaults, but
738 these are in my .Xdefaults. Most notably, they set foreground/background
739 to light gray/black, and also make sure that the colour 7 matches the
740 default foreground colour.
742 URxvt.underlineColor: yellow
744 Another colour, makes underline lines look different. Sometimes hurts, but
745 is mostly a nice effect.
747 URxvt.geometry: 154x36
748 URxvt.loginShell: false
750 URxvt.utmpInhibit: true
752 Uh, well, should be mostly self-explanatory. By specifying some defaults
753 manually, I can quickly switch them for testing.
755 URxvt.saveLines: 8192
757 A large scrollback buffer is essential. Really.
761 The only case I use it is for my IRC window, which I like to keep
762 iconified till people msg me (which beeps).
764 URxvt.visualBell: true
766 The audible bell is often annoying, especially when in a crowd.
770 Please don't hack my mutt! Ooops...
772 URxvt.pastableTabs: false
774 I once thought this is a great idea.
776 urxvt.font: 9x15bold,\
777 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
778 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
779 [codeset=JISX0208]xft:Kochi Gothic, \
780 xft:Bitstream Vera Sans Mono:autohint=true, \
781 xft:Code2000:antialias=false
782 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
783 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
784 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
786 I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
787 overwhelmed. A special note: the C<9x15bold> mentioned above is actually
788 the version from XFree-3.3, as XFree-4 replaced it by a totally different
789 font (different glyphs for C<;> and many other harmless characters),
790 while the second font is actually the C<9x15bold> from XFree4/XOrg. The
791 bold version has less chars than the medium version, so I use it for rare
792 characters, too. When editing sources with vim, I use italic for comments
793 and other stuff, which looks quite good with Bitstream Vera anti-aliased.
795 Terminus is a quite bad font (many very wrong glyphs), but for most of my
796 purposes, it works, and gives a different look, as my normal (Non-bold)
797 font is already bold, and I want to see a difference between bold and
800 Please note that I used the C<urxvt> instance name and not the C<URxvt>
801 class name. Thats because I use different configs for different purposes,
802 for example, my IRC window is started with C<-name IRC>, and uses these
806 IRC*geometry: 87x12+535+542
810 IRC*boldFont: suxuseuro
812 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
813 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
815 C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
816 sizes. C<suxuseuro> allows me to keep an eye (and actually read)
817 stuff while keeping a very small window. If somebody pastes something
818 complicated (e.g. japanese), I temporarily switch to a larger font.
820 The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
821 C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
822 file for different hosts, for example, on ym main desktop, I use:
824 URxvt.keysym.C-M-q: command:\033[3;5;5t
825 URxvt.keysym.C-M-y: command:\033[3;5;606t
826 URxvt.keysym.C-M-e: command:\033[3;1605;5t
827 URxvt.keysym.C-M-c: command:\033[3;1605;606t
828 URxvt.keysym.C-M-p: perl:test
830 The first for keysym definitions allow me to quickly bring some windows
831 in the layout I like most. Ion users might start laughing but will stop
832 immediately when I tell them that I use my own Fvwm2 module for much the
833 same effect as Ion provides, and I only very rarely use the above key
836 =head3 Why doesn't rxvt-unicode read my resources?
838 Well, why, indeed? It does, in a way very similar to other X
839 applications. Most importantly, this means that if you or your OS loads
840 resources into the X display (the right way to do it), rxvt-unicode will
841 ignore any resource files in your home directory. It will only read
842 F<$HOME/.Xdefaults> when no resources are attached to the display.
844 If you have or use an F<$HOME/.Xresources> file, chances are that
845 resources are loaded into your X-server. In this case, you have to
846 re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
848 Also consider the form resources have to use:
850 URxvt.resource: value
852 If you want to use another form (there are lots of different ways of
853 specifying resources), make sure you understand whether and why it
854 works. If unsure, use the form above.
856 =head3 When I log-in to another system it tells me about missing terminfo data?
858 The terminal description used by rxvt-unicode is not as widely available
859 as that for xterm, or even rxvt (for which the same problem often arises).
861 The correct solution for this problem is to install the terminfo, this can
862 be done by simply installing rxvt-unicode on the remote system as well
863 (in case you have a nice package manager ready), or you can install the
864 terminfo database manually like this (with ncurses infocmp. works as
867 REMOTE=remotesystem.domain
868 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
870 One some systems you might need to set C<$TERMINFO> to the full path of
871 F<$HOME/.terminfo> for this to work.
873 If you cannot or do not want to do this, then you can simply set
874 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
875 problems arising, which includes wrong keymapping, less and different
876 colours and some refresh errors in fullscreen applications. It's a nice
877 quick-and-dirty workaround for rare cases, though.
879 If you always want to do this (and are fine with the consequences) you
880 can either recompile rxvt-unicode with the desired TERM value or use a
885 If you don't plan to use B<rxvt> (quite common...) you could also replace
886 the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
888 =head3 nano fails with "Error opening terminal: rxvt-unicode"
890 This exceptionally confusing and useless error message is printed by nano
891 when it can't find the terminfo database. Nothing is wrong with your
892 terminal, read the previous answer for a solution.
894 =head3 C<tic> outputs some error when compiling the terminfo entry.
896 Most likely it's the empty definition for C<enacs=>. Just replace it by
897 C<enacs=\E[0@> and try again.
899 =head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
903 =head3 I need a termcap file entry.
905 One reason you might want this is that some distributions or operating
906 systems still compile some programs using the long-obsoleted termcap
907 library (Fedora Core's bash is one example) and rely on a termcap entry
910 You could use rxvt's termcap entry with reasonable results in many cases.
911 You can also create a termcap entry by using terminfo's infocmp program
914 infocmp -C rxvt-unicode
916 Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
917 generated by the command above.
919 =head3 Why does C<ls> no longer have coloured output?
921 The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
922 decide whether a terminal has colour, but uses its own configuration
923 file. Needless to say, C<rxvt-unicode> is not in its default file (among
924 with most other terminals supporting colour). Either add:
928 to C</etc/DIR_COLORS> or simply add:
930 alias ls='ls --color=auto'
932 to your C<.profile> or C<.bashrc>.
934 =head3 Why doesn't vim/emacs etc. use the 88 colour mode?
938 =head3 Why doesn't vim/emacs etc. make use of italic?
942 =head3 Why are the secondary screen-related options not working properly?
944 Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
945 distributions (most notably Debian GNU/Linux) break rxvt-unicode
946 by setting C<TERM> to C<rxvt>, which doesn't have these extra
947 features. Unfortunately, some of these (most notably, again, Debian
948 GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
949 file, so you will need to install it on your own (See the question B<When
950 I log-in to another system it tells me about missing terminfo data?> on
954 =head2 Encoding / Locale / Input Method Issues
956 =head3 Rxvt-unicode does not seem to understand the selected encoding?
960 =head3 Unicode does not seem to work?
962 If you encounter strange problems like typing an accented character but
963 getting two unrelated other characters or similar, or if program output is
964 subtly garbled, then you should check your locale settings.
966 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
967 programs running in it. Often rxvt-unicode is started in the C<C> locale,
968 while the login script running within the rxvt-unicode window changes the
969 locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970 not going to work, and is the most common cause for problems.
972 The best thing is to fix your startup environment, as you will likely run
973 into other problems. If nothing works you can try this in your .profile.
975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
977 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
978 supported on your systems. Some systems have a C<locale> command which
979 displays this (also, C<perl -e0> can be used to check locale settings, as
980 it will complain loudly if it cannot set the locale). If it displays something
983 locale: Cannot set LC_CTYPE to default locale: ...
985 Then the locale you specified is not supported on your system.
987 If nothing works and you are sure that everything is set correctly then
988 you will need to remember a little known fact: Some programs just don't
991 =head3 How does rxvt-unicode determine the encoding to use?
995 =head3 Is there an option to switch encodings?
997 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
998 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
999 UTF-8 or any other encodings with respect to terminal I/O.
1001 The reasons is that there exists a perfectly fine mechanism for selecting
1002 the encoding, doing I/O and (most important) communicating this to all
1003 applications so everybody agrees on character properties such as width
1004 and code number. This mechanism is the I<locale>. Applications not using
1005 that info will have problems (for example, C<xterm> gets the width of
1006 characters wrong as it uses its own, locale-independent table under all
1009 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1010 programs doing the same (that is, most) will automatically agree in the
1011 interpretation of characters.
1013 Unfortunately, there is no system-independent way to select locales, nor
1014 is there a standard on how locale specifiers will look like.
1016 On most systems, the content of the C<LC_CTYPE> environment variable
1017 contains an arbitrary string which corresponds to an already-installed
1018 locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1019 C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1020 (i.e. C<de> or C<german>) are also common.
1022 Rxvt-unicode ignores all other locale categories, and except for
1023 the encoding, ignores country or language-specific settings,
1024 i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1027 If you want to use a specific encoding you have to make sure you start
1028 rxvt-unicode with the correct C<LC_CTYPE> category.
1030 =head3 Can I switch locales at runtime?
1032 Yes, using an escape sequence. Try something like this, which sets
1033 rxvt-unicode's idea of C<LC_CTYPE>.
1035 printf '\33]701;%s\007' ja_JP.SJIS
1037 See also the previous answer.
1039 Sometimes this capability is rather handy when you want to work in
1040 one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1041 (e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1042 first switches to a locale supported by xjdic and back later:
1044 printf '\33]701;%s\007' ja_JP.SJIS
1046 printf '\33]701;%s\007' de_DE.UTF-8
1048 You can also use xterm's C<luit> program, which usually works fine, except
1049 for some locales where character width differs between program- and
1050 rxvt-unicode-locales.
1052 =head3 I have problems getting my input method working.
1054 Try a search engine, as this is slightly different for every input method server.
1056 Here is a checklist:
1060 =item - Make sure your locale I<and> the imLocale are supported on your OS.
1062 Try C<locale -a> or check the documentation for your OS.
1064 =item - Make sure your locale or imLocale matches a locale supported by your XIM.
1066 For example, B<kinput2> does not support UTF-8 locales, you should use
1067 C<ja_JP.EUC-JP> or equivalent.
1069 =item - Make sure your XIM server is actually running.
1071 =item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1073 When you want to use e.g. B<kinput2>, it must be set to
1074 C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075 method servers are running with this command:
1077 xprop -root XIM_SERVERS
1083 =head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1085 You can specify separate locales for the input method and the rest of the
1086 terminal, using the resource C<imlocale>:
1088 URxvt.imlocale: ja_JP.EUC-JP
1090 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1091 use your input method. Please note, however, that, depending on your Xlib
1092 version, you may not be able to input characters outside C<EUC-JP> in a
1093 normal way then, as your input method limits you.
1095 =head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1097 Unfortunately, this is unavoidable, as the XIM protocol is racy by
1098 design. Applications can avoid some crashes at the expense of memory
1099 leaks, and Input Methods can avoid some crashes by careful ordering at
1100 exit time. B<kinput2> (and derived input methods) generally succeeds,
1101 while B<SCIM> (or similar input methods) fails. In the end, however,
1102 crashes cannot be completely avoided even if both sides cooperate.
1104 So the only workaround is not to kill your Input Method Servers.
1107 =head2 Operating Systems / Package Maintaining
1109 =head3 I am using Debian GNU/Linux and have a problem...
1111 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1112 patches that considerably change the behaviour of rxvt-unicode (but
1113 unfortunately this notice has been removed). Before reporting a bug to
1114 the original rxvt-unicode author please download and install the genuine
1115 version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1116 the problem. If you cannot, chances are that the problems are specific to
1117 Debian GNU/Linux, in which case it should be reported via the Debian Bug
1118 Tracking System (use C<reportbug> to report the bug).
1120 For other problems that also affect the Debian package, you can and
1121 probably should use the Debian BTS, too, because, after all, it's also a
1122 bug in the Debian version and it serves as a reminder for other users that
1123 might encounter the same issue.
1125 =head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1127 You should build one binary with the default options. F<configure>
1128 now enables most useful options, and the trend goes to making them
1129 runtime-switchable, too, so there is usually no drawback to enabling them,
1130 except higher disk and possibly memory usage. The perl interpreter should
1131 be enabled, as important functionality (menus, selection, likely more in
1132 the future) depends on it.
1134 You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1135 system-wide (except maybe with C<defaults>). This will result in useful
1136 behaviour. If your distribution aims at low memory, add an empty
1137 C<perl-ext-common> resource to the app-defaults file. This will keep the
1138 perl interpreter disabled until the user enables it.
1140 If you can/want build more binaries, I recommend building a minimal
1141 one with C<--disable-everything> (very useful) and a maximal one with
1142 C<--enable-everything> (less useful, it will be very big due to a lot of
1143 encodings built-in that increase download times and are rarely used).
1145 =head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1147 It should be, starting with release 7.1. You are encouraged to properly
1148 install urxvt with privileges necessary for your OS now.
1150 When rxvt-unicode detects that it runs setuid or setgid, it will fork
1151 into a helper process for privileged operations (pty handling on some
1152 systems, utmp/wtmp/lastlog handling on others) and drop privileges
1153 immediately. This is much safer than most other terminals that keep
1154 privileges while running (but is more relevant to urxvt, as it contains
1155 things as perl interpreters, which might be "helpful" to attackers).
1157 This forking is done as the very first within main(), which is very early
1158 and reduces possible bugs to initialisation code run before main(), or
1159 things like the dynamic loader of your system, which should result in very
1162 =head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1164 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1165 in your compile environment, or an implementation that implements it,
1166 whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1167 B<wchar_t> is represented as unicode.
1169 As you might have guessed, FreeBSD does neither define this symbol nor
1170 does it support it. Instead, it uses its own internal representation of
1171 B<wchar_t>. This is, of course, completely fine with respect to standards.
1173 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1174 C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1176 C<__STDC_ISO_10646__> is the only sane way to support multi-language
1177 apps in an OS, as using a locale-dependent (and non-standardized)
1178 representation of B<wchar_t> makes it impossible to convert between
1179 B<wchar_t> (as used by X11 and your applications) and any other encoding
1180 without implementing OS-specific-wrappers for each and every locale. There
1181 simply are no APIs to convert B<wchar_t> into anything except the current
1184 Some applications (such as the formidable B<mlterm>) work around this
1185 by carrying their own replacement functions for character set handling
1186 with them, and either implementing OS-dependent hacks or doing multiple
1187 conversions (which is slow and unreliable in case the OS implements
1188 encodings slightly different than the terminal emulator).
1190 The rxvt-unicode author insists that the right way to fix this is in the
1191 system libraries once and for all, instead of forcing every app to carry
1192 complete replacements for them :)
1194 =head3 How can I use rxvt-unicode under cygwin?
1196 rxvt-unicode should compile and run out of the box on cygwin, using
1197 the X11 libraries that come with cygwin. libW11 emulation is no
1198 longer supported (and makes no sense, either, as it only supported a
1199 single font). I recommend starting the X-server in C<-multiwindow> or
1200 C<-rootless> mode instead, which will result in similar look&feel as the
1201 old libW11 emulation.
1203 At the time of this writing, cygwin didn't seem to support any multi-byte
1204 encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1207 =head3 Character widths are not correct.
1209 urxvt uses the system wcwidth function to know the information about
1210 the width of characters, so on systems with incorrect locale data you
1211 will likely get bad results. Two notorious examples are Solaris 9,
1212 where single-width characters like U+2514 are reported as double-width,
1213 and Darwin 8, where combining chars are reported having width 1.
1215 The solution is to upgrade your system or switch to a better one. A
1216 possibly working workaround is to use a wcwidth implementation like
1218 http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1220 =head3 I want 256 colors
1222 Are you sure you need 256 colors? 88 colors should be enough for most
1223 purposes. If you really need more, there is an unsupported patch for
1224 it in the doc directory, but please do not ask for it to be applied.
1226 =head1 RXVT-UNICODE TECHNICAL REFERENCE
1228 The rest of this document describes various technical aspects of
1229 B<rxvt-unicode>. First the description of supported command sequences,
1230 followed by pixmap support and last by a description of all features
1231 selectable at C<configure> time.
1239 The literal character c.
1243 A single (required) character.
1247 A single (usually optional) numeric parameter, composed of one or more
1252 A multiple numeric parameter composed of any number of single numeric
1253 parameters, separated by C<;> character(s).
1257 A text parameter composed of printable characters.
1267 Enquiry (Ctrl-E) = Send Device Attributes (DA)
1268 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
1280 Horizontal Tab (HT) (Ctrl-I)
1284 Line Feed or New Line (NL) (Ctrl-J)
1288 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
1292 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
1296 Carriage Return (Ctrl-M)
1300 Shift Out (Ctrl-N), invokes the G1 character set.
1301 Switch to Alternate Character Set
1305 Shift In (Ctrl-O), invokes the G0 character set (the default).
1306 Switch to Standard Character Set
1314 =head2 Escape Sequences
1318 =item B<< C<ESC # 8> >>
1320 DEC Screen Alignment Test (DECALN)
1322 =item B<< C<ESC 7> >>
1326 =item B<< C<ESC 8> >>
1330 =item B<< C<ESC => >>
1332 Application Keypad (SMKX). See also next sequence.
1334 =item B<<< C<< ESC >> >>>
1336 Normal Keypad (RMKX)
1338 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1339 pressed, numbers or control functions are generated by the numeric keypad
1342 =item B<< C<ESC D> >>
1346 =item B<< C<ESC E> >>
1350 =item B<< C<ESC H> >>
1354 =item B<< C<ESC M> >>
1358 =item B<< C<ESC N> >>
1360 Single Shift Select of G2 Character Set (SS2): affects next character
1361 only I<unimplemented>
1363 =item B<< C<ESC O> >>
1365 Single Shift Select of G3 Character Set (SS3): affects next character
1366 only I<unimplemented>
1368 =item B<< C<ESC Z> >>
1370 Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
1372 =item B<< C<ESC c> >>
1376 =item B<< C<ESC n> >>
1378 Invoke the G2 Character Set (LS2)
1380 =item B<< C<ESC o> >>
1382 Invoke the G3 Character Set (LS3)
1384 =item B<< C<ESC ( C> >>
1386 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
1388 =item B<< C<ESC ) C> >>
1390 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
1392 =item B<< C<ESC * C> >>
1394 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
1396 =item B<< C<ESC + C> >>
1398 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
1400 =item B<< C<ESC $ C> >>
1402 Designate Kanji Character Set
1404 Where B<< C<C> >> is one of:
1408 C = C<0> DEC Special Character and Line Drawing Set
1409 C = C<A> United Kingdom (UK)
1410 C = C<B> United States (USASCII)
1411 C = C<< < >> Multinational character set I<unimplemented>
1412 C = C<5> Finnish character set I<unimplemented>
1413 C = C<C> Finnish character set I<unimplemented>
1414 C = C<K> German character set I<unimplemented>
1422 =head2 CSI (Command Sequence Introducer) Sequences
1426 =item B<< C<ESC [ Ps @> >>
1428 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
1430 =item B<< C<ESC [ Ps A> >>
1432 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
1434 =item B<< C<ESC [ Ps B> >>
1436 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
1438 =item B<< C<ESC [ Ps C> >>
1440 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
1442 =item B<< C<ESC [ Ps D> >>
1444 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
1446 =item B<< C<ESC [ Ps E> >>
1448 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
1450 =item B<< C<ESC [ Ps F> >>
1452 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
1454 =item B<< C<ESC [ Ps G> >>
1456 Cursor to Column B<< C<Ps> >> (HPA)
1458 =item B<< C<ESC [ Ps;Ps H> >>
1460 Cursor Position [row;column] [default: 1;1] (CUP)
1462 =item B<< C<ESC [ Ps I> >>
1464 Move forward B<< C<Ps> >> tab stops [default: 1]
1466 =item B<< C<ESC [ Ps J> >>
1468 Erase in Display (ED)
1472 B<< C<Ps = 0> >> Clear Below (default)
1473 B<< C<Ps = 1> >> Clear Above
1474 B<< C<Ps = 2> >> Clear All
1478 =item B<< C<ESC [ Ps K> >>
1484 B<< C<Ps = 0> >> Clear to Right (default)
1485 B<< C<Ps = 1> >> Clear to Left
1486 B<< C<Ps = 2> >> Clear All
1487 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1488 (@@RXVT_NAME@@ extension)
1492 =item B<< C<ESC [ Ps L> >>
1494 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
1496 =item B<< C<ESC [ Ps M> >>
1498 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
1500 =item B<< C<ESC [ Ps P> >>
1502 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
1504 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
1506 Initiate . I<unimplemented> Parameters are
1507 [func;startx;starty;firstrow;lastrow].
1509 =item B<< C<ESC [ Ps W> >>
1515 B<< C<Ps = 0> >> Tab Set (HTS)
1516 B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default)
1517 B<< C<Ps = 5> >> Tab Clear (TBC), Clear All
1521 =item B<< C<ESC [ Ps X> >>
1523 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
1525 =item B<< C<ESC [ Ps Z> >>
1527 Move backward B<< C<Ps> >> [default: 1] tab stops
1529 =item B<< C<ESC [ Ps '> >>
1531 See B<< C<ESC [ Ps G> >>
1533 =item B<< C<ESC [ Ps a> >>
1535 See B<< C<ESC [ Ps C> >>
1537 =item B<< C<ESC [ Ps c> >>
1539 Send Device Attributes (DA)
1540 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
1541 returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
1544 =item B<< C<ESC [ Ps d> >>
1546 Cursor to Line B<< C<Ps> >> (VPA)
1548 =item B<< C<ESC [ Ps e> >>
1550 See B<< C<ESC [ Ps A> >>
1552 =item B<< C<ESC [ Ps;Ps f> >>
1554 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1556 =item B<< C<ESC [ Ps g> >>
1562 B<< C<Ps = 0> >> Clear Current Column (default)
1563 B<< C<Ps = 3> >> Clear All (TBC)
1567 =item B<< C<ESC [ Pm h> >>
1569 Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1571 =item B<< C<ESC [ Ps i> >>
1573 Printing. See also the C<print-pipe> resource.
1577 B<< C<Ps = 0> >> print screen (MC0)
1578 B<< C<Ps = 4> >> disable transparent print mode (MC4)
1579 B<< C<Ps = 5> >> enable transparent print mode (MC5)
1583 =item B<< C<ESC [ Pm l> >>
1589 =item B<< C<Ps = 4> >>
1593 B<< C<h> >> Insert Mode (SMIR)
1594 B<< C<l> >> Replace Mode (RMIR)
1598 =item B<< C<Ps = 20> >> (partially implemented)
1602 B<< C<h> >> Automatic Newline (LNM)
1603 B<< C<l> >> Normal Linefeed (LNM)
1609 =item B<< C<ESC [ Pm m> >>
1611 Character Attributes (SGR)
1615 B<< C<Ps = 0> >> Normal (default)
1616 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1617 B<< C<Ps = 3 / 23> >> On / Off Italic
1618 B<< C<Ps = 4 / 24> >> On / Off Underline
1619 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1620 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1621 B<< C<Ps = 7 / 27> >> On / Off Inverse
1622 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
1623 B<< C<Ps = 30 / 40> >> fg/bg Black
1624 B<< C<Ps = 31 / 41> >> fg/bg Red
1625 B<< C<Ps = 32 / 42> >> fg/bg Green
1626 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1627 B<< C<Ps = 34 / 44> >> fg/bg Blue
1628 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1629 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1630 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
1631 B<< C<Ps = 37 / 47> >> fg/bg White
1632 B<< C<Ps = 39 / 49> >> fg/bg Default
1633 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1634 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1635 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1636 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1637 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1638 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1639 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1640 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1641 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
1645 =item B<< C<ESC [ Ps n> >>
1647 Device Status Report (DSR)
1651 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'')
1652 B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1653 B<< C<Ps = 7> >> Request Display Name
1654 B<< C<Ps = 8> >> Request Version Number (place in window title)
1658 =item B<< C<ESC [ Ps;Ps r> >>
1660 Set Scrolling Region [top;bottom]
1661 [default: full size of window] (CSR)
1663 =item B<< C<ESC [ s> >>
1667 =item B<< C<ESC [ Ps;Pt t> >>
1673 B<< C<Ps = 1> >> Deiconify (map) window
1674 B<< C<Ps = 2> >> Iconify window
1675 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1676 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1677 B<< C<Ps = 5> >> Raise window
1678 B<< C<Ps = 6> >> Lower window
1679 B<< C<Ps = 7> >> Refresh screen once
1680 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1681 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1682 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1683 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1684 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1685 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1686 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1687 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1688 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1692 =item B<< C<ESC [ u> >>
1696 =item B<< C<ESC [ Ps x> >>
1698 Request Terminal Parameters (DECREQTPARM)
1704 =head2 DEC Private Modes
1708 =item B<< C<ESC [ ? Pm h> >>
1710 DEC Private Mode Set (DECSET)
1712 =item B<< C<ESC [ ? Pm l> >>
1714 DEC Private Mode Reset (DECRST)
1716 =item B<< C<ESC [ ? Pm r> >>
1718 Restore previously saved DEC Private Mode Values.
1720 =item B<< C<ESC [ ? Pm s> >>
1722 Save DEC Private Mode Values.
1724 =item B<< C<ESC [ ? Pm t> >>
1726 Toggle DEC Private Mode Values (rxvt extension). I<where>
1730 =item B<< C<Pm = 1> >> (DECCKM)
1734 B<< C<h> >> Application Cursor Keys
1735 B<< C<l> >> Normal Cursor Keys
1739 =item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1743 B<< C<h> >> Enter VT52 mode
1744 B<< C<l> >> Enter VT52 mode
1748 =item B<< C<Pm = 3> >>
1752 B<< C<h> >> 132 Column Mode (DECCOLM)
1753 B<< C<l> >> 80 Column Mode (DECCOLM)
1757 =item B<< C<Pm = 4> >>
1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1766 =item B<< C<Pm = 5> >>
1770 B<< C<h> >> Reverse Video (DECSCNM)
1771 B<< C<l> >> Normal Video (DECSCNM)
1775 =item B<< C<Pm = 6> >>
1779 B<< C<h> >> Origin Mode (DECOM)
1780 B<< C<l> >> Normal Cursor Mode (DECOM)
1784 =item B<< C<Pm = 7> >>
1788 B<< C<h> >> Wraparound Mode (DECAWM)
1789 B<< C<l> >> No Wraparound Mode (DECAWM)
1793 =item B<< C<Pm = 8> >> I<unimplemented>
1797 B<< C<h> >> Auto-repeat Keys (DECARM)
1798 B<< C<l> >> No Auto-repeat Keys (DECARM)
1802 =item B<< C<Pm = 9> >> X10 XTerm
1806 B<< C<h> >> Send Mouse X & Y on button press.
1807 B<< C<l> >> No mouse reporting.
1811 =item B<< C<Pm = 25> >>
1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1816 B<< C<l> >> Invisible cursor {civis}
1820 =item B<< C<Pm = 30> >>
1824 B<< C<h> >> scrollBar visible
1825 B<< C<l> >> scrollBar invisible
1829 =item B<< C<Pm = 35> >> (B<rxvt>)
1833 B<< C<h> >> Allow XTerm Shift+key sequences
1834 B<< C<l> >> Disallow XTerm Shift+key sequences
1838 =item B<< C<Pm = 38> >> I<unimplemented>
1840 Enter Tektronix Mode (DECTEK)
1842 =item B<< C<Pm = 40> >>
1846 B<< C<h> >> Allow 80/132 Mode
1847 B<< C<l> >> Disallow 80/132 Mode
1851 =item B<< C<Pm = 44> >> I<unimplemented>
1855 B<< C<h> >> Turn On Margin Bell
1856 B<< C<l> >> Turn Off Margin Bell
1860 =item B<< C<Pm = 45> >> I<unimplemented>
1864 B<< C<h> >> Reverse-wraparound Mode
1865 B<< C<l> >> No Reverse-wraparound Mode
1869 =item B<< C<Pm = 46> >> I<unimplemented>
1871 =item B<< C<Pm = 47> >>
1875 B<< C<h> >> Use Alternate Screen Buffer
1876 B<< C<l> >> Use Normal Screen Buffer
1882 =item B<< C<Pm = 66> >>
1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1891 =item B<< C<Pm = 67> >>
1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1900 =item B<< C<Pm = 1000> >> (X11 XTerm)
1904 B<< C<h> >> Send Mouse X & Y on button press and release.
1905 B<< C<l> >> No mouse reporting.
1909 =item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1913 B<< C<h> >> Use Hilite Mouse Tracking.
1914 B<< C<l> >> No mouse reporting.
1918 =item B<< C<Pm = 1002> >> (X11 XTerm)
1922 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1923 B<< C<l> >> No mouse reporting.
1927 =item B<< C<Pm = 1003> >> (X11 XTerm)
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1932 B<< C<l> >> No mouse reporting.
1936 =item B<< C<Pm = 1010> >> (B<rxvt>)
1940 B<< C<h> >> Don't scroll to bottom on TTY output
1941 B<< C<l> >> Scroll to bottom on TTY output
1945 =item B<< C<Pm = 1011> >> (B<rxvt>)
1949 B<< C<h> >> Scroll to bottom when a key is pressed
1950 B<< C<l> >> Don't scroll to bottom when a key is pressed
1954 =item B<< C<Pm = 1021> >> (B<rxvt>)
1958 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1959 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1963 =item B<< C<Pm = 1047> >>
1967 B<< C<h> >> Use Alternate Screen Buffer
1968 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1972 =item B<< C<Pm = 1048> >>
1976 B<< C<h> >> Save cursor position
1977 B<< C<l> >> Restore cursor position
1981 =item B<< C<Pm = 1049> >>
1985 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1986 B<< C<l> >> Use Normal Screen Buffer
1990 =item B<< C<Pm = 2004> >>
1994 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1995 B<< C<l> >> Disable bracketed paste mode
2005 =head2 XTerm Operating System Commands
2009 =item B<< C<ESC ] Ps;Pt ST> >>
2011 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
2012 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
2013 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
2017 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
2019 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
2020 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.
2021 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
2022 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
2023 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
2024 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
2025 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
2026 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
2027 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
2028 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
2029 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
2031 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
2032 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
2033 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> >>
2034 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
2035 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).
2036 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>.
2037 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
2038 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2039 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2040 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2041 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2042 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2043 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2044 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2045 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2046 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2047 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2048 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
2054 =head1 BACKGROUND IMAGE
2056 For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2057 of B<< C<Pt> >> can be the name of the background image file followed by a
2058 sequence of scaling/positioning commands separated by semi-colons. The
2059 scaling/positioning commands are as follows:
2063 =item query scale/position
2067 =item change scale and position
2071 B<WxH+X> (== B<WxH+X+X>)
2073 B<WxH> (same as B<WxH+50+50>)
2075 B<W+X+Y> (same as B<WxW+X+Y>)
2077 B<W+X> (same as B<WxW+X+X>)
2079 B<W> (same as B<WxW+50+50>)
2081 =item change position (absolute)
2085 B<=+X> (same as B<=+X+Y>)
2087 =item change position (relative)
2091 B<+X> (same as B<+X+Y>)
2093 =item rescale (relative)
2095 B<Wx0> -> B<W *= (W/100)>
2097 B<0xH> -> B<H *= (H/100)>
2105 =item B<\E]20;funky.jpg\a>
2107 load B<funky.jpg> as a tiled image
2109 =item B<\E]20;mona.jpg;100\a>
2111 load B<mona.jpg> with a scaling of 100%
2113 =item B<\E]20;;200;?\a>
2115 rescale the current pixmap to 200% and display the image geometry in
2122 =head1 Mouse Reporting
2126 =item B<< C<< ESC [ M <b> <x> <y> >> >>
2128 report mouse position
2132 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
2136 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
2143 3 button released (X11 mouse report)
2149 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
2150 button was pressed and are added together (X11 mouse report only):
2154 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
2161 32 Double Click I<(rxvt extension)>
2165 Col = B<< C<< <x> - SPACE >> >>
2167 Row = B<< C<< <y> - SPACE >> >>
2175 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2177 For the keypad, use B<Shift> to temporarily override Application-Keypad
2178 setting use B<Num_Lock> to toggle Application-Keypad setting if
2179 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
2180 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
2185 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
2186 Tab ^I ESC [ Z ^I ESC [ Z
2187 BackSpace ^H ^? ^? ^?
2188 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2189 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
2190 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2191 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2192 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
2193 Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @
2194 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
2195 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
2196 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2197 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
2198 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
2199 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
2200 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
2201 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
2202 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
2203 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
2204 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
2205 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
2206 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
2207 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
2208 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
2209 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
2210 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
2211 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
2212 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
2213 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
2214 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
2215 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
2216 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
2218 Up ESC [ A ESC [ a ESC O a ESC O A
2219 Down ESC [ B ESC [ b ESC O b ESC O B
2220 Right ESC [ C ESC [ c ESC O c ESC O C
2221 Left ESC [ D ESC [ d ESC O d ESC O D
2223 KP_F1 ESC O P ESC O P
2224 KP_F2 ESC O Q ESC O Q
2225 KP_F3 ESC O R ESC O R
2226 KP_F4 ESC O S ESC O S
2227 XK_KP_Multiply * ESC O j
2229 XK_KP_Separator , ESC O l
2230 XK_KP_Subtract - ESC O m
2231 XK_KP_Decimal . ESC O n
2232 XK_KP_Divide / ESC O o
2246 =head1 CONFIGURE OPTIONS
2248 General hint: if you get compile errors, then likely your configuration
2249 hasn't been tested well. Either try with C<--enable-everything> or use
2250 the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2251 switches). Of course, you should always report when a combination doesn't
2252 work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2258 =item --enable-everything
2260 Add (or remove) support for all non-multichoice options listed in "./configure
2263 You can specify this and then disable options you do not like by
2264 I<following> this with the appropriate C<--disable-...> arguments,
2265 or you can start with a minimal configuration by specifying
2266 C<--disable-everything> and than adding just the C<--enable-...> arguments
2269 =item --enable-xft (default: enabled)
2271 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2272 slower and require lots of memory, but as long as you don't use them, you
2275 =item --enable-font-styles (default: on)
2277 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2278 styles. The fonts can be set manually or automatically.
2280 =item --with-codesets=NAME,... (default: all)
2282 Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2283 are always compiled in, which includes most 8-bit character sets). These
2284 codeset tables are used for driving X11 core fonts, they are not required
2285 for Xft fonts, although having them compiled in lets rxvt-unicode choose
2286 replacement fonts more intelligently. Compiling them in will make your
2287 binary bigger (all of together cost about 700kB), but it doesn't increase
2288 memory usage unless you use a font requiring one of these encodings.
2292 all all available codeset groups
2293 zh common chinese encodings
2294 zh_ext rarely used but very big chinese encodings
2295 jp common japanese encodings
2296 jp_ext rarely used but big japanese encodings
2301 =item --enable-xim (default: on)
2303 Add support for XIM (X Input Method) protocol. This allows using
2304 alternative input methods (e.g. kinput2) and will also correctly
2305 set up the input for people using dead keys or compose keys.
2307 =item --enable-unicode3 (default: off)
2309 Recommended to stay off unless you really need non-BMP characters.
2311 Enable direct support for displaying unicode codepoints above
2312 65535 (the basic multilingual page). This increases storage
2313 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2314 support these extra characters, but Xft does.
2316 Please note that rxvt-unicode can store unicode code points >65535
2317 even without this flag, but the number of such characters is
2318 limited to a few thousand (shared with combining characters,
2319 see next switch), and right now rxvt-unicode cannot display them
2320 (input/output and cut&paste still work, though).
2322 =item --enable-combining (default: on)
2324 Enable automatic composition of combining characters into
2325 composite characters. This is required for proper viewing of text
2326 where accents are encoded as seperate unicode characters. This is
2327 done by using precomposited characters when available or creating
2328 new pseudo-characters when no precomposed form exists.
2330 Without --enable-unicode3, the number of additional precomposed
2331 characters is somewhat limited (the 6400 private use characters will be
2332 (ab-)used). With --enable-unicode3, no practical limit exists.
2334 This option will also enable storage (but not display) of characters
2335 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2337 The combining table also contains entries for arabic presentation forms,
2338 but these are not currently used. Bug me if you want these to be used (and
2339 tell me how these are to be used...).
2341 =item --enable-fallback(=CLASS) (default: Rxvt)
2343 When reading resource settings, also read settings for class CLASS. To
2344 disable resource fallback use --disable-fallback.
2346 =item --with-res-name=NAME (default: urxvt)
2348 Use the given name as default application name when
2349 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2351 =item --with-res-class=CLASS (default: URxvt)
2353 Use the given class as default application class
2354 when reading resources. Specify --with-res-class=Rxvt to replace
2357 =item --enable-utmp (default: on)
2359 Write user and tty to utmp file (used by programs like F<w>) at
2360 start of rxvt execution and delete information when rxvt exits.
2362 =item --enable-wtmp (default: on)
2364 Write user and tty to wtmp file (used by programs like F<last>) at
2365 start of rxvt execution and write logout when rxvt exits. This
2366 option requires --enable-utmp to also be specified.
2368 =item --enable-lastlog (default: on)
2370 Write user and tty to lastlog file (used by programs like
2371 F<lastlogin>) at start of rxvt execution. This option requires
2372 --enable-utmp to also be specified.
2374 =item --enable-afterimage (default: on)
2376 Add support for libAfterImage to be used for transparency and background
2377 images. It adds support for many file formats including JPG, PNG,
2378 SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2379 (L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2381 This option also adds such eye candy as blending an image over the root
2382 background, as well as dynamic scaling and bluring of background images.
2384 Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2385 increase by a few megabytes even if no extra features are used (mostly due
2386 to third-party libraries used by libAI). Memory footprint may somewhat be
2387 lowered if libAfterImage is configured without support for SVG.
2389 =item --enable-transparency (default: on)
2391 Add support for backgrounds, creating illusion of transparency in the term.
2393 =item --enable-fading (default: on)
2395 Add support for fading the text when focus is lost.
2397 =item --enable-rxvt-scroll (default: on)
2399 Add support for the original rxvt scrollbar.
2401 =item --enable-next-scroll (default: on)
2403 Add support for a NeXT-like scrollbar.
2405 =item --enable-xterm-scroll (default: on)
2407 Add support for an Xterm-like scrollbar.
2409 =item --disable-backspace-key
2411 Removes any handling of the backspace key by us - let the X server do it.
2413 =item --disable-delete-key
2415 Removes any handling of the delete key by us - let the X server
2418 =item --disable-resources
2420 Removes any support for resource checking.
2422 =item --disable-swapscreen
2424 Remove support for secondary/swap screen.
2426 =item --enable-frills (default: on)
2428 Add support for many small features that are not essential but nice to
2429 have. Normally you want this, but for very small binaries you may want to
2432 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2433 in combination with other switches) is:
2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2438 seperate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth)
2441 settable extra linespacing /-lsp)
2442 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure)
2445 keysym remapping support
2446 cursor blinking and underline cursor (-cb, -uc)
2447 XEmbed support (-embed)
2449 hold on exit (-hold)
2450 compile in built-in block graphics
2451 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc)
2454 It also enables some non-essential features otherwise disabled, such as:
2456 some round-trip time optimisations
2457 nearest color allocation on pseudocolor screens
2458 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences
2462 locale switching escape sequence
2463 window op and some xterm/OSC escape sequences
2464 rectangular selections
2465 trailing space removal for selections
2466 verbose X error handling
2468 =item --enable-iso14755 (default: on)
2470 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2471 Basic support (section 5.1) is enabled by C<--enable-frills>, while
2472 support for 5.2, 5.3 and 5.4 is enabled with this switch.
2474 =item --enable-keepscrolling (default: on)
2476 Add support for continual scrolling of the display when you hold
2477 the mouse button down on a scrollbar arrow.
2479 =item --enable-selectionscrolling (default: on)
2481 Add support for scrolling when the selection moves to the top or
2482 bottom of the screen.
2484 =item --enable-mousewheel (default: on)
2486 Add support for scrolling via mouse wheel or buttons 4 & 5.
2488 =item --enable-slipwheeling (default: on)
2490 Add support for continual scrolling (using the mouse wheel as an
2491 accelerator) while the control key is held down. This option
2492 requires --enable-mousewheel to also be specified.
2494 =item --enable-smart-resize (default: off)
2496 Add smart growth/shrink behaviour when resizing.
2497 This should keep the window corner which is closest to a corner of
2498 the screen in a fixed position.
2500 =item --enable-text-blink (default: on)
2502 Add support for blinking text.
2504 =item --enable-pointer-blank (default: on)
2506 Add support to have the pointer disappear when typing or inactive.
2508 =item --enable-perl (default: on)
2510 Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2511 manpage for more info on this feature, or the files in F<src/perl/>
2512 for the extensions that are installed by default.
2513 The perl interpreter that is used can be specified via the C<PERL>
2514 environment variable when running configure. Even when compiled in,
2515 perl will I<not> be initialised when all extensions have been disabled
2516 C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517 resource standpoint.
2519 =item --with-afterimage-config=DIR
2521 Look for the libAfterImage config script in DIR.
2523 =item --with-name=NAME (default: urxvt)
2525 Set the basename for the installed binaries, resulting
2526 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2529 =item --with-term=NAME (default: rxvt-unicode)
2531 Change the environmental variable for the terminal to NAME.
2533 =item --with-terminfo=PATH
2535 Change the environmental variable for the path to the terminfo tree to
2540 Use the X Window System (pretty much default, eh?).
2546 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2547 reworked it from the original Rxvt documentation, which was done by Geoff
2548 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other