ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.txt
Revision: 1.69
Committed: Thu Feb 2 18:04:45 2006 UTC (18 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-7_6
Changes since 1.68: +1 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 NAME
2     RXVT REFERENCE - FAQ, command sequences and other background information
3    
4 root 1.11 SYNOPSIS
5     # set a new font set
6     printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
7    
8     # change the locale and tell rxvt-unicode about it
9     export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
10    
11     # set window title
12     printf '\33]2;%s\007' "new window title"
13    
14     DESCRIPTION
15     This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
16     all escape sequences, and other background information.
17    
18     The newest version of this document is also available on the World Wide
19     Web at
20     <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21    
22 root 1.61 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
23 root 1.59 Meta, Features & Commandline Issues
24     My question isn't answered here, can I ask a human?
25     Before sending me mail, you could go to IRC: "irc.freenode.net", channel
26     "#rxvt-unicode" has some rxvt-unicode enthusiasts that might be
27     interested in learning about new and exciting problems (but not FAQs :).
28 root 1.41
29 root 1.59 Does it support tabs, can I have a tabbed rxvt-unicode?
30     Beginning with version 7.3, there is a perl extension that implements a
31     simple tabbed terminal. It is installed by default, so any of these
32     should give you tabs:
33 root 1.41
34 root 1.60 urxvt -pe tabbed
35 root 1.41
36 root 1.59 URxvt.perl-ext-common: default,tabbed
37 root 1.41
38 root 1.59 It will also work fine with tabbing functionality of many window
39     managers or similar tabbing programs, and its embedding-features allow
40     it to be embedded into other programs, as witnessed by doc/rxvt-tabbed
41     or the upcoming "Gtk2::URxvt" perl module, which features a tabbed urxvt
42     (murxvt) terminal as an example embedding application.
43 root 1.41
44 root 1.59 How do I know which rxvt-unicode version I'm using?
45     The version number is displayed with the usage (-h). Also the escape
46     sequence "ESC [ 8 n" sets the window title to the version number. When
47 root 1.60 using the urxvtc client, the version displayed is that of the daemon.
48 root 1.42
49 root 1.59 Rxvt-unicode uses gobs of memory, how can I reduce that?
50     Rxvt-unicode tries to obey the rule of not charging you for something
51     you don't use. One thing you should try is to configure out all settings
52     that you don't need, for example, Xft support is a resource hog by
53     design, when used. Compiling it out ensures that no Xft font will be
54     loaded accidentally when rxvt-unicode tries to find a font for your
55     characters.
56 root 1.56
57 root 1.59 Also, many people (me included) like large windows and even larger
58     scrollback buffers: Without "--enable-unicode3", rxvt-unicode will use 6
59     bytes per screen cell. For a 160x?? window this amounts to almost a
60     kilobyte per line. A scrollback buffer of 10000 lines will then (if
61     full) use 10 Megabytes of memory. With "--enable-unicode3" it gets
62     worse, as rxvt-unicode then uses 8 bytes per screen cell.
63 root 1.56
64 root 1.60 How can I start urxvtd in a race-free way?
65     Try "urxvtd -f -o", which tells urxvtd to open the display, create the
66 root 1.59 listening socket and then fork.
67 root 1.56
68 root 1.67 How can I start urxvtd automatically when I run URXVT_NAME@@c?
69     If you want to start urxvtd automatically whenever you run urxvtc and
70     the daemon isn't running yet, use this script:
71    
72     #!/bin/sh
73     urxvtc "$@"
74     if [ $? -eq 2 ]; then
75     urxvtd -q -o -f
76     urxvtc "$@"
77     fi
78    
79     This tries to create a new terminal, and if fails with exit status 2,
80     meaning it couldn't connect to the daemon, it will start the daemon and
81     re-run the command. Subsequent invocations of the script will re-use the
82     existing daemon.
83    
84 root 1.59 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
85 root 1.62 The original rxvt and rxvt-unicode always export the variable
86     "COLORTERM", so you can check and see if that is set. Note that several
87     programs, JED, slrn, Midnight Commander automatically check this
88     variable to decide whether or not to use color.
89 root 1.56
90 root 1.59 How do I set the correct, full IP address for the DISPLAY variable?
91     If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
92     insecure mode then it is possible to use the following shell script
93     snippets to correctly set the display. If your version of rxvt-unicode
94     wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets)
95     then the COLORTERM variable can be used to distinguish rxvt-unicode from
96     a regular xterm.
97 root 1.56
98 root 1.59 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
99     snippets:
100 root 1.57
101 root 1.59 # Bourne/Korn/POSIX family of shells:
102     [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
103     if [ ${TERM:-foo} = xterm ]; then
104     stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
105     echo -n '^[Z'
106     read term_id
107     stty icanon echo
108     if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
109     echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
110     read DISPLAY # set it in our local shell
111     fi
112     fi
113 root 1.56
114 root 1.59 How do I compile the manual pages on my own?
115     You need to have a recent version of perl installed as /usr/bin/perl,
116     one that comes with pod2man, pod2text and pod2html. Then go to the doc
117     subdirectory and enter "make alldoc".
118 root 1.56
119 root 1.59 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
120 root 1.56 I often get asked about this, and I think, no, they didn't cause extra
121     bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
122     that the urxvt binary is larger (due to some encoding tables always
123     being compiled in), but it actually uses less memory (RSS) after
124     startup. Even with "--disable-everything", this comparison is a bit
125     unfair, as many features unique to urxvt (locale, encoding conversion,
126     iso14755 etc.) are already in use in this mode.
127    
128     text data bss drs rss filename
129     98398 1664 24 15695 1824 rxvt --disable-everything
130     188985 9048 66616 18222 1788 urxvt --disable-everything
131    
132 root 1.63 When you "--enable-everything" (which *is* unfair, as this involves xft
133 root 1.56 and full locale/XIM support which are quite bloaty inside libX11 and my
134     libc), the two diverge, but not unreasnobaly so.
135    
136     text data bss drs rss filename
137     163431 2152 24 20123 2060 rxvt --enable-everything
138     1035683 49680 66648 29096 3680 urxvt --enable-everything
139    
140     The very large size of the text section is explained by the east-asian
141     encoding tables, which, if unused, take up disk space but nothing else
142     and can be compiled out unless you rely on X11 core fonts that use those
143     encodings. The BSS size comes from the 64k emergency buffer that my c++
144     compiler allocates (but of course doesn't use unless you are out of
145     memory). Also, using an xft font instead of a core font immediately adds
146     a few megabytes of RSS. Xft indeed is responsible for a lot of RSS even
147     when not used.
148    
149     Of course, due to every character using two or four bytes instead of
150     one, a large scrollback buffer will ultimately make rxvt-unicode use
151     more memory.
152    
153     Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
154     still fares rather well. And compared to some monsters like
155     gnome-terminal (21152k + extra 4204k in separate processes) or konsole
156     (22200k + extra 43180k in daemons that stay around after exit, plus half
157     a minute of startup time, including the hundreds of warnings it spits
158     out), it fares extremely well *g*.
159    
160 root 1.59 Why C++, isn't that unportable/bloated/uncool?
161 root 1.56 Is this a question? :) It comes up very often. The simple answer is: I
162     had to write it, and C++ allowed me to write and maintain it in a
163     fraction of the time and effort (which is a scarce resource for me). Put
164     even shorter: It simply wouldn't exist without C++.
165    
166     My personal stance on this is that C++ is less portable than C, but in
167     the case of rxvt-unicode this hardly matters, as its portability limits
168     are defined by things like X11, pseudo terminals, locale support and
169     unix domain sockets, which are all less portable than C++ itself.
170    
171     Regarding the bloat, see the above question: It's easy to write programs
172     in C that use gobs of memory, an certainly possible to write programs in
173     C++ that don't. C++ also often comes with large libraries, but this is
174     not necessarily the case with GCC. Here is what rxvt links against on my
175     system with a minimal config:
176    
177     libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
178     libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
179     libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
180     /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
181    
182     And here is rxvt-unicode:
183    
184     libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
185     libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
186     libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
187     libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
188     /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
189    
190     No large bloated libraries (of course, none were linked in statically),
191     except maybe libX11 :)
192    
193 root 1.59 Rendering, Font & Look and Feel Issues
194     I can't get transparency working, what am I doing wrong?
195     First of all, transparency isn't officially supported in rxvt-unicode,
196     so you are mostly on your own. Do not bug the author about it (but you
197     may bug everybody else). Also, if you can't get it working consider it a
198     rite of passage: ... and you failed.
199 root 1.56
200 root 1.59 Here are four ways to get transparency. Do read the manpage and option
201     descriptions for the programs mentioned and rxvt-unicode. Really, do it!
202 root 1.56
203 root 1.59 1. Use inheritPixmap:
204 root 1.56
205 root 1.59 Esetroot wallpaper.jpg
206 root 1.60 urxvt -ip -tint red -sh 40
207 root 1.56
208 root 1.59 That works. If you think it doesn't, you lack transparency and tinting
209     support, or you are unable to read.
210 root 1.56
211 root 1.59 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
212     to use effects other than tinting and shading: Just shade/tint/whatever
213     your picture with gimp or any other tool:
214 root 1.56
215 root 1.59 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
216 root 1.60 urxvt -pixmap background.xpm -pe automove-background
217 root 1.56
218 root 1.59 That works. If you think it doesn't, you lack XPM and Perl support, or
219     you are unable to read.
220 root 1.56
221 root 1.59 3. Use an ARGB visual:
222 root 1.56
223 root 1.60 urxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
224 root 1.56
225 root 1.59 This requires XFT support, and the support of your X-server. If that
226     doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
227     there yet, no matter what they claim. Rxvt-Unicode contains the
228     neccessary bugfixes and workarounds for Xft and Xlib to make it work,
229     but that doesn't mean that your WM has the required kludges in place.
230 root 1.56
231 root 1.59 4. Use xcompmgr and let it do the job:
232 root 1.56
233 root 1.59 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
234     -set _NET_WM_WINDOW_OPACITY 0xc0000000
235 root 1.56
236 root 1.59 Then click on a window you want to make transparent. Replace 0xc0000000
237     by other values to change the degree of opacity. If it doesn't work and
238     your server crashes, you got to keep the pieces.
239 root 1.56
240 root 1.59 Why does rxvt-unicode sometimes leave pixel droppings?
241     Most fonts were not designed for terminal use, which means that
242     character size varies a lot. A font that is otherwise fine for terminal
243     use might contain some characters that are simply too wide. Rxvt-unicode
244     will avoid these characters. For characters that are just "a bit" too
245     wide a special "careful" rendering mode is used that redraws adjacent
246     characters.
247 root 1.56
248 root 1.59 All of this requires that fonts do not lie about character sizes,
249     however: Xft fonts often draw glyphs larger than their acclaimed
250     bounding box, and rxvt-unicode has no way of detecting this (the correct
251     way is to ask for the character bounding box, which unfortunately is
252     wrong in these cases).
253 root 1.56
254 root 1.59 It's not clear (to me at least), wether this is a bug in Xft, freetype,
255     or the respective font. If you encounter this problem you might try
256     using the "-lsp" option to give the font more height. If that doesn't
257     work, you might be forced to use a different font.
258 root 1.56
259 root 1.59 All of this is not a problem when using X11 core fonts, as their
260     bounding box data is correct.
261 root 1.56
262 root 1.59 How can I keep rxvt-unicode from using reverse video so much?
263     First of all, make sure you are running with the right terminal settings
264     ("TERM=rxvt-unicode"), which will get rid of most of these effects. Then
265     make sure you have specified colours for italic and bold, as otherwise
266     rxvt-unicode might use reverse video to simulate the effect:
267 root 1.57
268 root 1.59 URxvt.colorBD: white
269     URxvt.colorIT: green
270 root 1.56
271 root 1.59 Some programs assume totally weird colours (red instead of blue), how can I fix that?
272     For some unexplainable reason, some rare programs assume a very weird
273     colour palette when confronted with a terminal with more than the
274     standard 8 colours (rxvt-unicode supports 88). The right fix is, of
275     course, to fix these programs not to assume non-ISO colours without very
276     good reasons.
277 root 1.56
278 root 1.59 In the meantime, you can either edit your "rxvt-unicode" terminfo
279     definition to only claim 8 colour support or use "TERM=rxvt", which will
280     fix colours but keep you from using other rxvt-unicode features.
281 root 1.56
282 root 1.59 Can I switch the fonts at runtime?
283     Yes, using an escape sequence. Try something like this, which has the
284     same effect as using the "-fn" switch, and takes effect immediately:
285 root 1.56
286 root 1.59 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
287 root 1.56
288 root 1.59 This is useful if you e.g. work primarily with japanese (and prefer a
289     japanese font), but you have to switch to chinese temporarily, where
290     japanese fonts would only be in your way.
291 root 1.56
292 root 1.59 You can think of this as a kind of manual ISO-2022 switching.
293 root 1.56
294 root 1.59 Why do italic characters look as if clipped?
295     Many fonts have difficulties with italic characters and hinting. For
296     example, the otherwise very nicely hinted font "xft:Bitstream Vera Sans
297     Mono" completely fails in it's italic face. A workaround might be to
298     enable freetype autohinting, i.e. like this:
299 root 1.56
300 root 1.59 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
301     URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
302 root 1.56
303 root 1.59 Can I speed up Xft rendering somehow?
304     Yes, the most obvious way to speed it up is to avoid Xft entirely, as it
305     is simply slow. If you still want Xft fonts you might try to disable
306     antialiasing (by appending ":antialias=false"), which saves lots of
307     memory and also speeds up rendering considerably.
308 root 1.56
309 root 1.59 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
310     Rxvt-unicode will use whatever you specify as a font. If it needs to
311     fall back to it's default font search list it will prefer X11 core
312     fonts, because they are small and fast, and then use Xft fonts. It has
313     antialiasing disabled for most of them, because the author thinks they
314     look best that way.
315 root 1.57
316 root 1.59 If you want antialiasing, you have to specify the fonts manually.
317 root 1.57
318 root 1.59 What's with this bold/blink stuff?
319     If no bold colour is set via "colorBD:", bold will invert text using the
320     standard foreground colour.
321 root 1.56
322 root 1.59 For the standard background colour, blinking will actually make the text
323     blink when compiled with "--enable-blinking". with standard colours.
324     Without "--enable-blinking", the blink attribute will be ignored.
325 root 1.56
326 root 1.59 On ANSI colours, bold/blink attributes are used to set high-intensity
327     foreground/background colors.
328 root 1.57
329 root 1.59 color0-7 are the low-intensity colors.
330 root 1.56
331 root 1.59 color8-15 are the corresponding high-intensity colors.
332 root 1.56
333 root 1.59 I don't like the screen colors. How do I change them?
334     You can change the screen colors at run-time using ~/.Xdefaults
335     resources (or as long-options).
336 root 1.56
337 root 1.59 Here are values that are supposed to resemble a VGA screen, including
338     the murky brown that passes for low-intensity yellow:
339 root 1.56
340 root 1.59 URxvt.color0: #000000
341     URxvt.color1: #A80000
342     URxvt.color2: #00A800
343     URxvt.color3: #A8A800
344     URxvt.color4: #0000A8
345     URxvt.color5: #A800A8
346     URxvt.color6: #00A8A8
347     URxvt.color7: #A8A8A8
348 root 1.56
349 root 1.59 URxvt.color8: #000054
350     URxvt.color9: #FF0054
351     URxvt.color10: #00FF54
352     URxvt.color11: #FFFF54
353     URxvt.color12: #0000FF
354     URxvt.color13: #FF00FF
355     URxvt.color14: #00FFFF
356     URxvt.color15: #FFFFFF
357 root 1.56
358 root 1.63 And here is a more complete set of non-standard colors.
359 root 1.56
360 root 1.59 URxvt.cursorColor: #dc74d1
361     URxvt.pointerColor: #dc74d1
362     URxvt.background: #0e0e0e
363     URxvt.foreground: #4ad5e1
364     URxvt.color0: #000000
365     URxvt.color8: #8b8f93
366     URxvt.color1: #dc74d1
367     URxvt.color9: #dc74d1
368     URxvt.color2: #0eb8c7
369     URxvt.color10: #0eb8c7
370     URxvt.color3: #dfe37e
371     URxvt.color11: #dfe37e
372     URxvt.color5: #9e88f0
373     URxvt.color13: #9e88f0
374     URxvt.color6: #73f7ff
375     URxvt.color14: #73f7ff
376     URxvt.color7: #e1dddd
377     URxvt.color15: #e1dddd
378 root 1.56
379 root 1.65 They have been described (not by me) as "pretty girly".
380    
381     Why do some characters look so much different than others?
382     See next entry.
383 root 1.63
384 root 1.59 How does rxvt-unicode choose fonts?
385 root 1.56 Most fonts do not contain the full range of Unicode, which is fine.
386     Chances are that the font you (or the admin/package maintainer of your
387     system/os) have specified does not cover all the characters you want to
388     display.
389    
390     rxvt-unicode makes a best-effort try at finding a replacement font.
391     Often the result is fine, but sometimes the chosen font looks
392     bad/ugly/wrong. Some fonts have totally strange characters that don't
393     resemble the correct glyph at all, and rxvt-unicode lacks the artificial
394     intelligence to detect that a specific glyph is wrong: it has to believe
395     the font that the characters it claims to contain indeed look correct.
396    
397     In that case, select a font of your taste and add it to the font list,
398     e.g.:
399    
400 root 1.60 urxvt -fn basefont,font2,font3...
401 root 1.66
402 root 1.56 When rxvt-unicode sees a character, it will first look at the base font.
403     If the base font does not contain the character, it will go to the next
404     font, and so on. Specifying your own fonts will also speed up this
405     search and use less resources within rxvt-unicode and the X-server.
406    
407     The only limitation is that none of the fonts may be larger than the
408     base font, as the base font defines the terminal character cell size,
409     which must be the same due to the way terminals work.
410    
411 root 1.66 Why do some chinese characters look so different than others?
412     This is because there is a difference between script and language --
413     rxvt-unicode does not know which language the text that is output is, as
414     it only knows the unicode character codes. If rxvt-unicode first sees a
415     japanese/chinese character, it might choose a japanese font for display.
416     Subsequent japanese characters will use that font. Now, many chinese
417     characters aren't represented in japanese fonts, so when the first
418     non-japanese character comes up, rxvt-unicode will look for a chinese
419     font -- unfortunately at this point, it will still use the japanese font
420     for chinese characters that are also in the japanese font.
421    
422     The workaround is easy: just tag a chinese font at the end of your font
423     list (see the previous question). The key is to view the font list as a
424     preference list: If you expect more japanese, list a japanese font
425     first. If you expect more chinese, put a chinese font first.
426    
427     In the future it might be possible to switch language preferences at
428     runtime (the internal data structure has no problem with using different
429     fonts for the same character at the same time, but no interface for this
430     has been designed yet).
431    
432     Until then, you might get away with switching fonts at runtime (see "Can
433     I switch the fonts at runtime?" later in this document).
434    
435 root 1.59 Keyboard, Mouse & User Interaction
436     The new selection selects pieces that are too big, how can I select single words?
437     If you want to select e.g. alphanumeric words, you can use the following
438     setting:
439    
440     URxvt.selection.pattern-0: ([[:word:]]+)
441 root 1.56
442 root 1.59 If you click more than twice, the selection will be extended more and
443     more.
444 root 1.56
445 root 1.59 To get a selection that is very similar to the old code, try this
446     pattern:
447 root 1.56
448 root 1.59 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
449 root 1.56
450 root 1.59 Please also note that the *LeftClick Shift-LeftClik* combination also
451     selects words like the old code.
452 root 1.56
453 root 1.59 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
454     You can disable the perl extension completely by setting the
455     perl-ext-common resource to the empty string, which also keeps
456     rxvt-unicode from initialising perl, saving memory.
457 root 1.56
458 root 1.59 If you only want to disable specific features, you first have to
459     identify which perl extension is responsible. For this, read the section
460 root 1.60 PREPACKAGED EXTENSIONS in the urxvtperl(3) manpage. For example, to
461 root 1.59 disable the selection-popup and option-popup, specify this
462     perl-ext-common resource:
463 root 1.56
464 root 1.59 URxvt.perl-ext-common: default,-selection-popup,-option-popup
465 root 1.56
466 root 1.59 This will keep the default extensions, but disable the two popup
467     extensions. Some extensions can also be configured, for example,
468     scrollback search mode is triggered by M-s. You can move it to any other
469     combination either by setting the searchable-scrollback resource:
470    
471     URxvt.searchable-scrollback: CM-s
472    
473     The cursor moves when selecting text in the current input line, how do I switch this off?
474     See next entry.
475    
476     During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
477     These are caused by the "readline" perl extension. Under normal
478     circumstances, it will move your cursor around when you click into the
479     line that contains it. It tries hard not to do this at the wrong moment,
480     but when running a program that doesn't parse cursor movements or in
481     some cases during rlogin sessions, it fails to detect this properly.
482    
483     You can permamently switch this feature off by disabling the "readline"
484     extension:
485    
486     URxvt.perl-ext-common: default,-readline
487 root 1.56
488 root 1.59 My numerical keypad acts weird and generates differing output?
489     Some Debian GNUL/Linux users seem to have this problem, although no
490     specific details were reported so far. It is possible that this is
491     caused by the wrong "TERM" setting, although the details of wether and
492     how this can happen are unknown, as "TERM=rxvt" should offer a
493     compatible keymap. See the answer to the previous question, and please
494     report if that helped.
495 root 1.56
496 root 1.59 My Compose (Multi_key) key is no longer working.
497 root 1.56 The most common causes for this are that either your locale is not set
498     correctly, or you specified a preeditStyle that is not supported by your
499     input method. For example, if you specified OverTheSpot and your input
500     method (e.g. the default input method handling Compose keys) does not
501     support this (for instance because it is not visual), then rxvt-unicode
502     will continue without an input method.
503    
504     In this case either do not specify a preeditStyle or specify more than
505     one pre-edit style, such as OverTheSpot,Root,None.
506    
507 root 1.59 I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO 14755
508 root 1.56 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
509     international keyboards) or simply use ISO 14755 support to your
510     advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
511     other codes, too, such as "Ctrl-Shift-1-d" to type the default telnet
512     escape character and so on.
513    
514 root 1.59 Mouse cut/paste suddenly no longer works.
515     Make sure that mouse reporting is actually turned off since killing some
516     editors prematurely may leave the mouse in mouse report mode. I've heard
517     that tcsh may use mouse reporting unless it otherwise specified. A quick
518     check is to see if cut/paste works when the Alt or Shift keys are
519     depressed.
520    
521     What's with the strange Backspace/Delete key behaviour?
522     Assuming that the physical Backspace key corresponds to the BackSpace
523     keysym (not likely for Linux ... see the following question) there are
524     two standard values that can be used for Backspace: "^H" and "^?".
525 root 1.56
526 root 1.59 Historically, either value is correct, but rxvt-unicode adopts the
527     debian policy of using "^?" when unsure, because it's the one only only
528     correct choice :).
529 root 1.56
530 root 1.59 Rxvt-unicode tries to inherit the current stty settings and uses the
531     value of `erase' to guess the value for backspace. If rxvt-unicode
532     wasn't started from a terminal (say, from a menu or by remote shell),
533     then the system value of `erase', which corresponds to CERASE in
534     <termios.h>, will be used (which may not be the same as your stty
535     setting).
536 root 1.56
537 root 1.59 For starting a new rxvt-unicode:
538 root 1.56
539 root 1.59 # use Backspace = ^H
540     $ stty erase ^H
541 root 1.60 $ urxvt
542 root 1.56
543 root 1.59 # use Backspace = ^?
544     $ stty erase ^?
545 root 1.60 $ urxvt
546 root 1.56
547 root 1.59 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
548 root 1.56
549 root 1.59 For an existing rxvt-unicode:
550 root 1.56
551 root 1.59 # use Backspace = ^H
552     $ stty erase ^H
553     $ echo -n "^[[36h"
554 root 1.56
555 root 1.59 # use Backspace = ^?
556     $ stty erase ^?
557     $ echo -n "^[[36l"
558 root 1.56
559 root 1.59 This helps satisfy some of the Backspace discrepancies that occur, but
560     if you use Backspace = "^H", make sure that the termcap/terminfo value
561     properly reflects that.
562 root 1.56
563 root 1.59 The Delete key is a another casualty of the ill-defined Backspace
564     problem. To avoid confusion between the Backspace and Delete keys, the
565     Delete key has been assigned an escape sequence to match the vt100 for
566     Execute ("ESC [ 3 ~") and is in the supplied termcap/terminfo.
567 root 1.56
568 root 1.59 Some other Backspace problems:
569 root 1.56
570 root 1.59 some editors use termcap/terminfo, some editors (vim I'm told) expect
571     Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for help.
572 root 1.57
573 root 1.59 Perhaps someday this will all be resolved in a consistent manner.
574 root 1.56
575 root 1.59 I don't like the key-bindings. How do I change them?
576     There are some compile-time selections available via configure. Unless
577     you have run "configure" with the "--disable-resources" option you can
578     use the `keysym' resource to alter the keystrings associated with
579     keysyms.
580 root 1.56
581 root 1.60 Here's an example for a URxvt session started using "urxvt -name URxvt"
582 root 1.56
583 root 1.59 URxvt.keysym.Home: \033[1~
584     URxvt.keysym.End: \033[4~
585     URxvt.keysym.C-apostrophe: \033<C-'>
586     URxvt.keysym.C-slash: \033<C-/>
587     URxvt.keysym.C-semicolon: \033<C-;>
588     URxvt.keysym.C-grave: \033<C-`>
589     URxvt.keysym.C-comma: \033<C-,>
590     URxvt.keysym.C-period: \033<C-.>
591     URxvt.keysym.C-0x60: \033<C-`>
592     URxvt.keysym.C-Tab: \033<C-Tab>
593     URxvt.keysym.C-Return: \033<C-Return>
594     URxvt.keysym.S-Return: \033<S-Return>
595     URxvt.keysym.S-space: \033<S-Space>
596     URxvt.keysym.M-Up: \033<M-Up>
597     URxvt.keysym.M-Down: \033<M-Down>
598     URxvt.keysym.M-Left: \033<M-Left>
599     URxvt.keysym.M-Right: \033<M-Right>
600     URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
601     URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
602     URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
603 root 1.56
604 root 1.59 See some more examples in the documentation for the keysym resource.
605 root 1.56
606 root 1.59 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
607     KP_Insert == Insert
608     F22 == Print
609     F27 == Home
610     F29 == Prior
611     F33 == End
612     F35 == Next
613 root 1.56
614 root 1.59 Rather than have rxvt-unicode try to accommodate all the various
615     possible keyboard mappings, it is better to use `xmodmap' to remap the
616     keys as required for your particular machine.
617 root 1.56
618 root 1.59 Terminal Configuration
619     Why doesn't rxvt-unicode read my resources?
620     Well, why, indeed? It does, in a way very similar to other X
621     applications. Most importantly, this means that if you or your OS loads
622     resources into the X display (the right way to do it), rxvt-unicode will
623     ignore any resource files in your home directory. It will only read
624     $HOME/.Xdefaults when no resources are attached to the display.
625 root 1.56
626 root 1.59 If you have or use an $HOME/.Xresources file, chances are that resources
627     are loaded into your X-server. In this case, you have to re-login after
628     every change (or run xrdb -merge $HOME/.Xresources).
629 root 1.56
630 root 1.59 Also consider the form resources have to use:
631 root 1.56
632 root 1.59 URxvt.resource: value
633 root 1.56
634 root 1.59 If you want to use another form (there are lots of different ways of
635     specifying resources), make sure you understand wether and why it works.
636     If unsure, use the form above.
637 root 1.56
638 root 1.59 When I log-in to another system it tells me about missing terminfo data?
639     The terminal description used by rxvt-unicode is not as widely available
640     as that for xterm, or even rxvt (for which the same problem often
641     arises).
642 root 1.56
643 root 1.59 The correct solution for this problem is to install the terminfo, this
644     can be done like this (with ncurses' infocmp):
645 root 1.56
646 root 1.59 REMOTE=remotesystem.domain
647     infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
648 root 1.56
649 root 1.59 ... or by installing rxvt-unicode normally on the remote system,
650 root 1.56
651 root 1.59 If you cannot or do not want to do this, then you can simply set
652     "TERM=rxvt" or even "TERM=xterm", and live with the small number of
653     problems arising, which includes wrong keymapping, less and different
654     colours and some refresh errors in fullscreen applications. It's a nice
655     quick-and-dirty workaround for rare cases, though.
656 root 1.56
657 root 1.59 If you always want to do this (and are fine with the consequences) you
658     can either recompile rxvt-unicode with the desired TERM value or use a
659     resource to set it:
660 root 1.56
661 root 1.59 URxvt.termName: rxvt
662 root 1.56
663 root 1.59 If you don't plan to use rxvt (quite common...) you could also replace
664 root 1.62 the rxvt terminfo file with the rxvt-unicode one and use "TERM=rxvt".
665 root 1.56
666 root 1.59 "tic" outputs some error when compiling the terminfo entry.
667     Most likely it's the empty definition for "enacs=". Just replace it by
668     "enacs=\E[0@" and try again.
669 root 1.56
670 root 1.60 "bash"'s readline does not work correctly under urxvt.
671 root 1.59 See next entry.
672 root 1.56
673 root 1.59 I need a termcap file entry.
674     One reason you might want this is that some distributions or operating
675     systems still compile some programs using the long-obsoleted termcap
676     library (Fedora Core's bash is one example) and rely on a termcap entry
677     for "rxvt-unicode".
678    
679     You could use rxvt's termcap entry with resonable results in many cases.
680     You can also create a termcap entry by using terminfo's infocmp program
681     like this:
682    
683     infocmp -C rxvt-unicode
684    
685     Or you could use this termcap entry, generated by the command above:
686    
687     rxvt-unicode|rxvt-unicode terminal (X Window System):\
688     :am:bw:eo:km:mi:ms:xn:xo:\
689     :co#80:it#8:li#24:lm#0:\
690     :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
691     :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
692     :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
693     :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
694     :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
695     :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
696     :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
697     :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
698     :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
699     :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
700     :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
701     :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
702     :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
703     :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
704     :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
705     :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
706     :vs=\E[?25h:
707    
708     Why does "ls" no longer have coloured output?
709     The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
710     decide wether a terminal has colour, but uses it's own configuration
711     file. Needless to say, "rxvt-unicode" is not in it's default file (among
712     with most other terminals supporting colour). Either add:
713    
714     TERM rxvt-unicode
715    
716     to "/etc/DIR_COLORS" or simply add:
717    
718     alias ls='ls --color=auto'
719    
720     to your ".profile" or ".bashrc".
721    
722     Why doesn't vim/emacs etc. use the 88 colour mode?
723     See next entry.
724    
725     Why doesn't vim/emacs etc. make use of italic?
726     See next entry.
727    
728     Why are the secondary screen-related options not working properly?
729     Make sure you are using "TERM=rxvt-unicode". Some pre-packaged
730     distributions (most notably Debian GNU/Linux) break rxvt-unicode by
731     setting "TERM" to "rxvt", which doesn't have these extra features.
732     Unfortunately, some of these (most notably, again, Debian GNU/Linux)
733     furthermore fail to even install the "rxvt-unicode" terminfo file, so
734     you will need to install it on your own (See the question When I log-in
735     to another system it tells me about missing terminfo data? on how to do
736     this).
737    
738     Encoding / Locale / Input Method Issues
739     Rxvt-unicode does not seem to understand the selected encoding?
740     See next entry.
741 root 1.56
742 root 1.59 Unicode does not seem to work?
743     If you encounter strange problems like typing an accented character but
744     getting two unrelated other characters or similar, or if program output
745     is subtly garbled, then you should check your locale settings.
746 root 1.56
747 root 1.59 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
748     programs. Often rxvt-unicode is started in the "C" locale, while the
749     login script running within the rxvt-unicode window changes the locale
750     to something else, e.g. "en_GB.UTF-8". Needless to say, this is not
751     going to work.
752 root 1.56
753 root 1.59 The best thing is to fix your startup environment, as you will likely
754     run into other problems. If nothing works you can try this in your
755     .profile.
756 root 1.56
757 root 1.59 printf '\e]701;%s\007' "$LC_CTYPE"
758 root 1.56
759 root 1.59 If this doesn't work, then maybe you use a "LC_CTYPE" specification not
760     supported on your systems. Some systems have a "locale" command which
761     displays this (also, "perl -e0" can be used to check locale settings, as
762     it will complain loudly if it cannot set the locale). If it displays
763     something like:
764 root 1.56
765 root 1.59 locale: Cannot set LC_CTYPE to default locale: ...
766 root 1.56
767 root 1.59 Then the locale you specified is not supported on your system.
768 root 1.56
769 root 1.59 If nothing works and you are sure that everything is set correctly then
770     you will need to remember a little known fact: Some programs just don't
771     support locales :(
772 root 1.56
773 root 1.59 How does rxvt-unicode determine the encoding to use?
774     See next entry.
775 root 1.56
776 root 1.59 Is there an option to switch encodings?
777     Unlike some other terminals, rxvt-unicode has no encoding switch, and no
778     specific "utf-8" mode, such as xterm. In fact, it doesn't even know
779     about UTF-8 or any other encodings with respect to terminal I/O.
780 root 1.56
781 root 1.59 The reasons is that there exists a perfectly fine mechanism for
782     selecting the encoding, doing I/O and (most important) communicating
783     this to all applications so everybody agrees on character properties
784     such as width and code number. This mechanism is the *locale*.
785     Applications not using that info will have problems (for example,
786     "xterm" gets the width of characters wrong as it uses it's own,
787     locale-independent table under all locales).
788 root 1.56
789 root 1.59 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. All
790     programs doing the same (that is, most) will automatically agree in the
791     interpretation of characters.
792 root 1.56
793 root 1.59 Unfortunately, there is no system-independent way to select locales, nor
794     is there a standard on how locale specifiers will look like.
795 root 1.56
796 root 1.59 On most systems, the content of the "LC_CTYPE" environment variable
797     contains an arbitrary string which corresponds to an already-installed
798     locale. Common names for locales are "en_US.UTF-8", "de_DE.ISO-8859-15",
799     "ja_JP.EUC-JP", i.e. "language_country.encoding", but other forms (i.e.
800     "de" or "german") are also common.
801 root 1.56
802 root 1.59 Rxvt-unicode ignores all other locale categories, and except for the
803     encoding, ignores country or language-specific settings, i.e.
804     "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to rxvt-unicode.
805 root 1.56
806 root 1.59 If you want to use a specific encoding you have to make sure you start
807     rxvt-unicode with the correct "LC_CTYPE" category.
808 root 1.56
809 root 1.59 Can I switch locales at runtime?
810     Yes, using an escape sequence. Try something like this, which sets
811     rxvt-unicode's idea of "LC_CTYPE".
812 root 1.56
813 root 1.59 printf '\e]701;%s\007' ja_JP.SJIS
814 root 1.56
815 root 1.59 See also the previous answer.
816 root 1.56
817 root 1.59 Sometimes this capability is rather handy when you want to work in one
818     locale (e.g. "de_DE.UTF-8") but some programs don't support it (e.g.
819     UTF-8). For example, I use this script to start "xjdic", which first
820     switches to a locale supported by xjdic and back later:
821 root 1.56
822 root 1.59 printf '\e]701;%s\007' ja_JP.SJIS
823     xjdic -js
824     printf '\e]701;%s\007' de_DE.UTF-8
825 root 1.56
826 root 1.59 You can also use xterm's "luit" program, which usually works fine,
827     except for some locales where character width differs between program-
828     and rxvt-unicode-locales.
829 root 1.56
830 root 1.68 I have problems getting my input method working.
831     Try a search engine, as this is slightly different for every input
832     method server.
833    
834     Here is a checklist:
835    
836     - Make sure your locale *and* the imLocale are supported on your OS.
837     Try "locale -a" or check the documentation for your OS.
838    
839     - Make sure your locale or imLocale matches a locale supported by your
840     XIM.
841     For example, kinput2 does not support UTF-8 locales, you should use
842     "ja_JP.EUC-JP" or equivalent.
843    
844     - Make sure your XIM server is actually running.
845     - Make sure the "XMODIFIERS" environment variable is set correctly when
846     *starting* rxvt-unicode.
847     When you want to use e.g. kinput2, it must be set to "@im=kinput2".
848     For scim, use "@im=SCIM". Youc an see what input method servers are
849     running with this command:
850    
851     xprop -root XIM_SERVERS
852    
853     *
854    
855 root 1.59 My input method wants <some encoding> but I want UTF-8, what can I do?
856     You can specify separate locales for the input method and the rest of
857     the terminal, using the resource "imlocale":
858 root 1.56
859 root 1.59 URxvt.imlocale: ja_JP.EUC-JP
860 root 1.56
861 root 1.59 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and still
862 root 1.68 use your input method. Please note, however, that, depending on your
863     Xlib version, you may not be able to input characters outside "EUC-JP"
864     in a normal way then, as your input method limits you.
865 root 1.56
866 root 1.59 Rxvt-unicode crashes when the X Input Method changes or exits.
867     Unfortunately, this is unavoidable, as the XIM protocol is racy by
868     design. Applications can avoid some crashes at the expense of memory
869     leaks, and Input Methods can avoid some crashes by careful ordering at
870     exit time. kinput2 (and derived input methods) generally succeeds, while
871     SCIM (or similar input methods) fails. In the end, however, crashes
872     cannot be completely avoided even if both sides cooperate.
873 root 1.56
874 root 1.59 So the only workaround is not to kill your Input Method Servers.
875 root 1.56
876 root 1.59 Operating Systems / Package Maintaining
877     I am using Debian GNU/Linux and have a problem...
878     The Debian GNU/Linux package of rxvt-unicode in sarge contains large
879     patches that considerably change the behaviour of rxvt-unicode (but
880     unfortunately this notice has been removed). Before reporting a bug to
881     the original rxvt-unicode author please download and install the genuine
882     version (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
883     the problem. If you cannot, chances are that the problems are specific
884     to Debian GNU/Linux, in which case it should be reported via the Debian
885     Bug Tracking System (use "reportbug" to report the bug).
886 root 1.56
887 root 1.59 For other problems that also affect the Debian package, you can and
888     probably should use the Debian BTS, too, because, after all, it's also a
889     bug in the Debian version and it serves as a reminder for other users
890     that might encounter the same issue.
891 root 1.56
892 root 1.59 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
893     You should build one binary with the default options. configure now
894     enables most useful options, and the trend goes to making them
895     runtime-switchable, too, so there is usually no drawback to enbaling
896     them, except higher disk and possibly memory usage. The perl interpreter
897     should be enabled, as important functionality (menus, selection, likely
898     more in the future) depends on it.
899 root 1.56
900 root 1.59 You should not overwrite the "perl-ext-common" snd "perl-ext" resources
901     system-wide (except maybe with "defaults"). This will result in useful
902     behaviour. If your distribution aims at low memory, add an empty
903     "perl-ext-common" resource to the app-defaults file. This will keep the
904     perl interpreter disabled until the user enables it.
905 root 1.56
906 root 1.59 If you can/want build more binaries, I recommend building a minimal one
907     with "--disable-everything" (very useful) and a maximal one with
908     "--enable-everything" (less useful, it will be very big due to a lot of
909     encodings built-in that increase download times and are rarely used).
910 root 1.56
911 root 1.59 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
912     It should be, starting with release 7.1. You are encouraged to properly
913     install urxvt with privileges necessary for your OS now.
914 root 1.56
915 root 1.59 When rxvt-unicode detects that it runs setuid or setgid, it will fork
916     into a helper process for privileged operations (pty handling on some
917     systems, utmp/wtmp/lastlog handling on others) and drop privileges
918     immediately. This is much safer than most other terminals that keep
919     privileges while running (but is more relevant to urxvt, as it contains
920     things as perl interpreters, which might be "helpful" to attackers).
921 root 1.56
922 root 1.59 This forking is done as the very first within main(), which is very
923     early and reduces possible bugs to initialisation code run before
924     main(), or things like the dynamic loader of your system, which should
925     result in very little risk.
926 root 1.56
927 root 1.59 On Solaris 9, many line-drawing characters are too wide.
928     Seems to be a known bug, read
929     <http://nixdoc.net/files/forum/about34198.html>. Some people use the
930     following ugly workaround to get non-double-wide-characters working:
931 root 1.56
932 root 1.59 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
933 root 1.56
934 root 1.59 I am on FreeBSD and rxvt-unicode does not seem to work at all.
935     Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined in
936     your compile environment, or an implementation that implements it,
937     wether it defines the symbol or not. "__STDC_ISO_10646__" requires that
938     wchar_t is represented as unicode.
939 root 1.56
940 root 1.59 As you might have guessed, FreeBSD does neither define this symobl nor
941     does it support it. Instead, it uses it's own internal representation of
942     wchar_t. This is, of course, completely fine with respect to standards.
943 root 1.56
944 root 1.59 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1" and
945     "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
946 root 1.56
947 root 1.59 "__STDC_ISO_10646__" is the only sane way to support multi-language apps
948     in an OS, as using a locale-dependent (and non-standardized)
949     representation of wchar_t makes it impossible to convert between wchar_t
950     (as used by X11 and your applications) and any other encoding without
951     implementing OS-specific-wrappers for each and every locale. There
952     simply are no APIs to convert wchar_t into anything except the current
953     locale encoding.
954 root 1.56
955 root 1.59 Some applications (such as the formidable mlterm) work around this by
956     carrying their own replacement functions for character set handling with
957     them, and either implementing OS-dependent hacks or doing multiple
958     conversions (which is slow and unreliable in case the OS implements
959     encodings slightly different than the terminal emulator).
960 root 1.56
961 root 1.59 The rxvt-unicode author insists that the right way to fix this is in the
962     system libraries once and for all, instead of forcing every app to carry
963     complete replacements for them :)
964 root 1.56
965 root 1.59 I use Solaris 9 and it doesn't compile/work/etc.
966     Try the diff in doc/solaris9.patch as a base. It fixes the worst
967     problems with "wcwidth" and a compile problem.
968 root 1.56
969 root 1.59 How can I use rxvt-unicode under cygwin?
970     rxvt-unicode should compile and run out of the box on cygwin, using the
971     X11 libraries that come with cygwin. libW11 emulation is no longer
972     supported (and makes no sense, either, as it only supported a single
973     font). I recommend starting the X-server in "-multiwindow" or
974     "-rootless" mode instead, which will result in similar look&feel as the
975     old libW11 emulation.
976 root 1.56
977 root 1.59 At the time of this writing, cygwin didn't seem to support any
978     multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
979     likely limited to 8-bit encodings.
980 root 1.1
981 root 1.62 RXVT-UNICODE TECHNICAL REFERENCE
982 root 1.1 The rest of this document describes various technical aspects of
983     rxvt-unicode. First the description of supported command sequences,
984 root 1.46 followed by pixmap support and last by a description of all features
985     selectable at "configure" time.
986 root 1.1
987 root 1.66 Definitions
988 root 1.1 "c" The literal character c.
989    
990     "C" A single (required) character.
991    
992     "Ps"
993     A single (usually optional) numeric parameter, composed of one or
994     more digits.
995    
996     "Pm"
997     A multiple numeric parameter composed of any number of single
998     numeric parameters, separated by ";" character(s).
999    
1000     "Pt"
1001     A text parameter composed of printable characters.
1002    
1003 root 1.66 Values
1004 root 1.1 "ENQ"
1005     Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes
1006     from terminal. See "ESC [ Ps c".
1007    
1008     "BEL"
1009     Bell (Ctrl-G)
1010    
1011     "BS"
1012     Backspace (Ctrl-H)
1013    
1014     "TAB"
1015     Horizontal Tab (HT) (Ctrl-I)
1016    
1017     "LF"
1018     Line Feed or New Line (NL) (Ctrl-J)
1019    
1020     "VT"
1021     Vertical Tab (Ctrl-K) same as "LF"
1022    
1023     "FF"
1024     Form Feed or New Page (NP) (Ctrl-L) same as "LF"
1025    
1026     "CR"
1027     Carriage Return (Ctrl-M)
1028    
1029     "SO"
1030     Shift Out (Ctrl-N), invokes the G1 character set. Switch to
1031     Alternate Character Set
1032    
1033     "SI"
1034     Shift In (Ctrl-O), invokes the G0 character set (the default).
1035     Switch to Standard Character Set
1036    
1037     "SPC"
1038     Space Character
1039    
1040 root 1.66 Escape Sequences
1041 root 1.1 "ESC # 8"
1042     DEC Screen Alignment Test (DECALN)
1043    
1044     "ESC 7"
1045     Save Cursor (SC)
1046    
1047     "ESC 8"
1048     Restore Cursor
1049    
1050     "ESC ="
1051     Application Keypad (SMKX). See also next sequence.
1052    
1053     "ESC"
1054     Normal Keypad (RMKX)
1055    
1056     Note: If the numeric keypad is activated, eg, Num_Lock has been
1057     pressed, numbers or control functions are generated by the numeric
1058     keypad (see Key Codes).
1059    
1060     "ESC D"
1061     Index (IND)
1062    
1063     "ESC E"
1064     Next Line (NEL)
1065    
1066     "ESC H"
1067     Tab Set (HTS)
1068    
1069     "ESC M"
1070     Reverse Index (RI)
1071    
1072     "ESC N"
1073     Single Shift Select of G2 Character Set (SS2): affects next
1074     character only *unimplemented*
1075    
1076     "ESC O"
1077     Single Shift Select of G3 Character Set (SS3): affects next
1078     character only *unimplemented*
1079    
1080     "ESC Z"
1081 root 1.11 Obsolete form of returns: "ESC [ ? 1 ; 2 C" *rxvt-unicode
1082     compile-time option*
1083 root 1.1
1084     "ESC c"
1085     Full reset (RIS)
1086    
1087     "ESC n"
1088     Invoke the G2 Character Set (LS2)
1089    
1090     "ESC o"
1091     Invoke the G3 Character Set (LS3)
1092    
1093 root 1.11 "ESC ( C"
1094 root 1.1 Designate G0 Character Set (ISO 2022), see below for values of "C".
1095    
1096 root 1.11 "ESC ) C"
1097 root 1.1 Designate G1 Character Set (ISO 2022), see below for values of "C".
1098    
1099     "ESC * C"
1100     Designate G2 Character Set (ISO 2022), see below for values of "C".
1101    
1102     "ESC + C"
1103     Designate G3 Character Set (ISO 2022), see below for values of "C".
1104    
1105     "ESC $ C"
1106     Designate Kanji Character Set
1107    
1108     Where "C" is one of:
1109    
1110     C = 0 DEC Special Character and Line Drawing Set
1111     C = A United Kingdom (UK)
1112     C = B United States (USASCII)
1113     C = < Multinational character set unimplemented
1114     C = 5 Finnish character set unimplemented
1115     C = C Finnish character set unimplemented
1116     C = K German character set unimplemented
1117    
1118    
1119    
1120 root 1.66 CSI (Command Sequence Introducer) Sequences
1121 root 1.1 "ESC [ Ps @"
1122     Insert "Ps" (Blank) Character(s) [default: 1] (ICH)
1123    
1124     "ESC [ Ps A"
1125     Cursor Up "Ps" Times [default: 1] (CUU)
1126    
1127     "ESC [ Ps B"
1128     Cursor Down "Ps" Times [default: 1] (CUD)
1129    
1130     "ESC [ Ps C"
1131     Cursor Forward "Ps" Times [default: 1] (CUF)
1132    
1133     "ESC [ Ps D"
1134     Cursor Backward "Ps" Times [default: 1] (CUB)
1135    
1136     "ESC [ Ps E"
1137     Cursor Down "Ps" Times [default: 1] and to first column
1138    
1139     "ESC [ Ps F"
1140     Cursor Up "Ps" Times [default: 1] and to first column
1141    
1142     "ESC [ Ps G"
1143     Cursor to Column "Ps" (HPA)
1144    
1145     "ESC [ Ps;Ps H"
1146     Cursor Position [row;column] [default: 1;1] (CUP)
1147    
1148     "ESC [ Ps I"
1149     Move forward "Ps" tab stops [default: 1]
1150    
1151     "ESC [ Ps J"
1152     Erase in Display (ED)
1153    
1154     Ps = 0 Clear Below (default)
1155     Ps = 1 Clear Above
1156     Ps = 2 Clear All
1157    
1158     "ESC [ Ps K"
1159     Erase in Line (EL)
1160    
1161     Ps = 0 Clear to Right (default)
1162     Ps = 1 Clear to Left
1163     Ps = 2 Clear All
1164    
1165     "ESC [ Ps L"
1166     Insert "Ps" Line(s) [default: 1] (IL)
1167    
1168     "ESC [ Ps M"
1169     Delete "Ps" Line(s) [default: 1] (DL)
1170    
1171     "ESC [ Ps P"
1172     Delete "Ps" Character(s) [default: 1] (DCH)
1173    
1174     "ESC [ Ps;Ps;Ps;Ps;Ps T"
1175     Initiate . *unimplemented* Parameters are
1176     [func;startx;starty;firstrow;lastrow].
1177    
1178     "ESC [ Ps W"
1179     Tabulator functions
1180    
1181     Ps = 0 Tab Set (HTS)
1182     Ps = 2 Tab Clear (TBC), Clear Current Column (default)
1183     Ps = 5 Tab Clear (TBC), Clear All
1184    
1185     "ESC [ Ps X"
1186     Erase "Ps" Character(s) [default: 1] (ECH)
1187    
1188     "ESC [ Ps Z"
1189     Move backward "Ps" [default: 1] tab stops
1190    
1191     "ESC [ Ps '"
1192     See "ESC [ Ps G"
1193    
1194     "ESC [ Ps a"
1195     See "ESC [ Ps C"
1196    
1197     "ESC [ Ps c"
1198     Send Device Attributes (DA) "Ps = 0" (or omitted): request
1199 root 1.11 attributes from terminal returns: "ESC [ ? 1 ; 2 c" (``I am a VT100
1200     with Advanced Video Option'')
1201 root 1.1
1202     "ESC [ Ps d"
1203     Cursor to Line "Ps" (VPA)
1204    
1205     "ESC [ Ps e"
1206     See "ESC [ Ps A"
1207    
1208     "ESC [ Ps;Ps f"
1209     Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1210    
1211     "ESC [ Ps g"
1212     Tab Clear (TBC)
1213    
1214     Ps = 0 Clear Current Column (default)
1215     Ps = 3 Clear All (TBC)
1216    
1217     "ESC [ Pm h"
1218     Set Mode (SM). See "ESC [ Pm l" sequence for description of "Pm".
1219    
1220     "ESC [ Ps i"
1221     Printing. See also the "print-pipe" resource.
1222    
1223     Ps = 0 print screen (MC0)
1224     Ps = 4 disable transparent print mode (MC4)
1225     Ps = 5 enable transparent print mode (MC5)
1226    
1227     "ESC [ Pm l"
1228     Reset Mode (RM)
1229    
1230     "Ps = 4"
1231     h Insert Mode (SMIR)
1232     l Replace Mode (RMIR)
1233    
1234     "Ps = 20" (partially implemented)
1235     h Automatic Newline (LNM)
1236     l Normal Linefeed (LNM)
1237    
1238     "ESC [ Pm m"
1239     Character Attributes (SGR)
1240    
1241     Ps = 0 Normal (default)
1242     Ps = 1 / 21 On / Off Bold (bright fg)
1243     Ps = 3 / 23 On / Off Italic
1244     Ps = 4 / 24 On / Off Underline
1245     Ps = 5 / 25 On / Off Slow Blink (bright bg)
1246     Ps = 6 / 26 On / Off Rapid Blink (bright bg)
1247     Ps = 7 / 27 On / Off Inverse
1248     Ps = 8 / 27 On / Off Invisible (NYI)
1249     Ps = 30 / 40 fg/bg Black
1250     Ps = 31 / 41 fg/bg Red
1251     Ps = 32 / 42 fg/bg Green
1252     Ps = 33 / 43 fg/bg Yellow
1253     Ps = 34 / 44 fg/bg Blue
1254     Ps = 35 / 45 fg/bg Magenta
1255     Ps = 36 / 46 fg/bg Cyan
1256     Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6)
1257     Ps = 37 / 47 fg/bg White
1258     Ps = 39 / 49 fg/bg Default
1259     Ps = 90 / 100 fg/bg Bright Black
1260     Ps = 91 / 101 fg/bg Bright Red
1261     Ps = 92 / 102 fg/bg Bright Green
1262     Ps = 93 / 103 fg/bg Bright Yellow
1263     Ps = 94 / 104 fg/bg Bright Blue
1264     Ps = 95 / 105 fg/bg Bright Magenta
1265     Ps = 96 / 106 fg/bg Bright Cyan
1266     Ps = 97 / 107 fg/bg Bright White
1267     Ps = 99 / 109 fg/bg Bright Default
1268    
1269     "ESC [ Ps n"
1270     Device Status Report (DSR)
1271    
1272     Ps = 5 Status Report ESC [ 0 n (``OK'')
1273     Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
1274     Ps = 7 Request Display Name
1275     Ps = 8 Request Version Number (place in window title)
1276    
1277     "ESC [ Ps;Ps r"
1278     Set Scrolling Region [top;bottom] [default: full size of window]
1279     (CSR)
1280    
1281     "ESC [ s"
1282     Save Cursor (SC)
1283    
1284 root 1.4 "ESC [ Ps;Pt t"
1285     Window Operations
1286    
1287     Ps = 1 Deiconify (map) window
1288     Ps = 2 Iconify window
1289     Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
1290 root 1.11 Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
1291 root 1.4 Ps = 5 Raise window
1292     Ps = 6 Lower window
1293     Ps = 7 Refresh screen once
1294 root 1.11 Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
1295     Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
1296 root 1.4 Ps = 13 Report window position (responds with Ps = 3)
1297     Ps = 14 Report window pixel size (responds with Ps = 4)
1298     Ps = 18 Report window text size (responds with Ps = 7)
1299     Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
1300     Ps = 20 Reports icon label (ESC ] L NAME \234)
1301     Ps = 21 Reports window title (ESC ] l NAME \234)
1302     Ps = 24.. Set window height to Ps rows
1303 root 1.1
1304     "ESC [ u"
1305     Restore Cursor
1306    
1307 root 1.4 "ESC [ Ps x"
1308     Request Terminal Parameters (DECREQTPARM)
1309    
1310 root 1.1
1311    
1312 root 1.66 DEC Private Modes
1313 root 1.1 "ESC [ ? Pm h"
1314     DEC Private Mode Set (DECSET)
1315    
1316     "ESC [ ? Pm l"
1317     DEC Private Mode Reset (DECRST)
1318    
1319     "ESC [ ? Pm r"
1320     Restore previously saved DEC Private Mode Values.
1321    
1322     "ESC [ ? Pm s"
1323     Save DEC Private Mode Values.
1324    
1325     "ESC [ ? Pm t"
1326     Toggle DEC Private Mode Values (rxvt extension). *where*
1327    
1328     "Ps = 1" (DECCKM)
1329     h Application Cursor Keys
1330     l Normal Cursor Keys
1331    
1332     "Ps = 2" (ANSI/VT52 mode)
1333     h Enter VT52 mode
1334     l Enter VT52 mode
1335    
1336     "Ps = 3"
1337     h 132 Column Mode (DECCOLM)
1338     l 80 Column Mode (DECCOLM)
1339    
1340     "Ps = 4"
1341     h Smooth (Slow) Scroll (DECSCLM)
1342     l Jump (Fast) Scroll (DECSCLM)
1343    
1344     "Ps = 5"
1345     h Reverse Video (DECSCNM)
1346     l Normal Video (DECSCNM)
1347    
1348     "Ps = 6"
1349     h Origin Mode (DECOM)
1350     l Normal Cursor Mode (DECOM)
1351    
1352     "Ps = 7"
1353     h Wraparound Mode (DECAWM)
1354     l No Wraparound Mode (DECAWM)
1355    
1356     "Ps = 8" *unimplemented*
1357     h Auto-repeat Keys (DECARM)
1358     l No Auto-repeat Keys (DECARM)
1359    
1360     "Ps = 9" X10 XTerm
1361     h Send Mouse X & Y on button press.
1362     l No mouse reporting.
1363    
1364     "Ps = 25"
1365     h Visible cursor {cnorm/cvvis}
1366     l Invisible cursor {civis}
1367    
1368     "Ps = 30"
1369     h scrollBar visisble
1370     l scrollBar invisisble
1371    
1372     "Ps = 35" (rxvt)
1373     h Allow XTerm Shift+key sequences
1374     l Disallow XTerm Shift+key sequences
1375    
1376     "Ps = 38" *unimplemented*
1377     Enter Tektronix Mode (DECTEK)
1378    
1379     "Ps = 40"
1380     h Allow 80/132 Mode
1381     l Disallow 80/132 Mode
1382    
1383     "Ps = 44" *unimplemented*
1384     h Turn On Margin Bell
1385     l Turn Off Margin Bell
1386    
1387     "Ps = 45" *unimplemented*
1388     h Reverse-wraparound Mode
1389     l No Reverse-wraparound Mode
1390    
1391     "Ps = 46" *unimplemented*
1392     "Ps = 47"
1393     h Use Alternate Screen Buffer
1394     l Use Normal Screen Buffer
1395    
1396    
1397    
1398     "Ps = 66"
1399     h Application Keypad (DECPAM) == ESC =
1400     l Normal Keypad (DECPNM) == ESC >
1401    
1402     "Ps = 67"
1403     h Backspace key sends BS (DECBKM)
1404     l Backspace key sends DEL
1405    
1406     "Ps = 1000" (X11 XTerm)
1407     h Send Mouse X & Y on button press and release.
1408     l No mouse reporting.
1409    
1410     "Ps = 1001" (X11 XTerm) *unimplemented*
1411     h Use Hilite Mouse Tracking.
1412     l No mouse reporting.
1413    
1414     "Ps = 1010" (rxvt)
1415     h Don't scroll to bottom on TTY output
1416     l Scroll to bottom on TTY output
1417    
1418     "Ps = 1011" (rxvt)
1419     h Scroll to bottom when a key is pressed
1420     l Don't scroll to bottom when a key is pressed
1421    
1422 root 1.29 "Ps = 1021" (rxvt)
1423     h Bold/italic implies high intensity (see option -is)
1424     l Font styles have no effect on intensity (Compile styles)
1425    
1426 root 1.1 "Ps = 1047"
1427     h Use Alternate Screen Buffer
1428     l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1429    
1430     "Ps = 1048"
1431     h Save cursor position
1432     l Restore cursor position
1433    
1434     "Ps = 1049"
1435     h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1436     l Use Normal Screen Buffer
1437    
1438    
1439    
1440 root 1.66 XTerm Operating System Commands
1441 root 1.1 "ESC ] Ps;Pt ST"
1442     Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \
1443     (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also
1444     accepted. any octet can be escaped by prefixing it with SYN (0x16,
1445     ^V).
1446    
1447     Ps = 0 Change Icon Name and Window Title to Pt
1448     Ps = 1 Change Icon Name to Pt
1449     Ps = 2 Change Window Title to Pt
1450     Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.
1451     Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1452     Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1453     Ps = 11 Change colour of text background to Pt (NB: may change in future)
1454     Ps = 12 Change colour of text cursor foreground to Pt
1455     Ps = 13 Change colour of mouse foreground to Pt
1456     Ps = 17 Change colour of highlight characters to Pt
1457 root 1.37 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1458     Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1459 root 1.48 Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1460 root 1.18 Ps = 39 Change default foreground colour to Pt.
1461 root 1.1 Ps = 46 Change Log File to Pt unimplemented
1462 root 1.18 Ps = 49 Change default background colour to Pt.
1463 root 1.1 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1464     Ps = 55 Log all scrollback buffer and all of screen to Pt
1465 root 1.18 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1466 root 1.51 Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1467 root 1.1 Ps = 704 Change colour of italic characters to Pt
1468 root 1.18 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1469 root 1.37 Ps = 706 Change colour of bold characters to Pt
1470     Ps = 707 Change colour of underlined characters to Pt
1471 root 1.1 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1472 root 1.18 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1473     Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1474     Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1475     Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1476     Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1477 root 1.31 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1478 root 1.1
1479     XPM
1480     For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1481     can be the name of the background pixmap followed by a sequence of
1482     scaling/positioning commands separated by semi-colons. The
1483     scaling/positioning commands are as follows:
1484    
1485     query scale/position
1486     ?
1487    
1488     change scale and position
1489     WxH+X+Y
1490    
1491     WxH+X (== WxH+X+X)
1492    
1493     WxH (same as WxH+50+50)
1494    
1495     W+X+Y (same as WxW+X+Y)
1496    
1497     W+X (same as WxW+X+X)
1498    
1499     W (same as WxW+50+50)
1500    
1501     change position (absolute)
1502     =+X+Y
1503    
1504     =+X (same as =+X+Y)
1505    
1506     change position (relative)
1507     +X+Y
1508    
1509     +X (same as +X+Y)
1510    
1511     rescale (relative)
1512     Wx0 -> W *= (W/100)
1513    
1514     0xH -> H *= (H/100)
1515    
1516     For example:
1517    
1518     \E]20;funky\a
1519     load funky.xpm as a tiled image
1520    
1521     \E]20;mona;100\a
1522     load mona.xpm with a scaling of 100%
1523    
1524     \E]20;;200;?\a
1525     rescale the current pixmap to 200% and display the image geometry in
1526     the title
1527    
1528     Mouse Reporting
1529     "ESC [ M <b> <x> <y>"
1530     report mouse position
1531    
1532     The lower 2 bits of "<b>" indicate the button:
1533    
1534     Button = "(<b> - SPACE) & 3"
1535     0 Button1 pressed
1536     1 Button2 pressed
1537     2 Button3 pressed
1538     3 button released (X11 mouse report)
1539    
1540     The upper bits of "<b>" indicate the modifiers when the button was
1541     pressed and are added together (X11 mouse report only):
1542    
1543     State = "(<b> - SPACE) & 60"
1544     4 Shift
1545     8 Meta
1546     16 Control
1547 root 1.62 32 Double Click (rxvt extension)
1548 root 1.1
1549     Col = "<x> - SPACE"
1550    
1551     Row = "<y> - SPACE"
1552    
1553     Key Codes
1554     Note: Shift + F1-F10 generates F11-F20
1555    
1556     For the keypad, use Shift to temporarily override Application-Keypad
1557     setting use Num_Lock to toggle Application-Keypad setting if Num_Lock is
1558     off, toggle Application-Keypad setting. Also note that values of Home,
1559     End, Delete may have been compiled differently on your system.
1560    
1561     Normal Shift Control Ctrl+Shift
1562     Tab ^I ESC [ Z ^I ESC [ Z
1563     BackSpace ^H ^? ^? ^?
1564     Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1565     Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
1566     Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1567     Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1568     Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
1569     Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
1570     Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1571     End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1572     Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1573     F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1574     F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1575     F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1576     F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1577     F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1578     F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1579     F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1580     F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1581     F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
1582     F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
1583     F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
1584     F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
1585     F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
1586     F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
1587     F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
1588     F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
1589     F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
1590     F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
1591     F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
1592     F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
1593     Application
1594     Up ESC [ A ESC [ a ESC O a ESC O A
1595     Down ESC [ B ESC [ b ESC O b ESC O B
1596     Right ESC [ C ESC [ c ESC O c ESC O C
1597     Left ESC [ D ESC [ d ESC O d ESC O D
1598     KP_Enter ^M ESC O M
1599     KP_F1 ESC O P ESC O P
1600     KP_F2 ESC O Q ESC O Q
1601     KP_F3 ESC O R ESC O R
1602     KP_F4 ESC O S ESC O S
1603     XK_KP_Multiply * ESC O j
1604     XK_KP_Add + ESC O k
1605     XK_KP_Separator , ESC O l
1606     XK_KP_Subtract - ESC O m
1607     XK_KP_Decimal . ESC O n
1608     XK_KP_Divide / ESC O o
1609     XK_KP_0 0 ESC O p
1610     XK_KP_1 1 ESC O q
1611     XK_KP_2 2 ESC O r
1612     XK_KP_3 3 ESC O s
1613     XK_KP_4 4 ESC O t
1614     XK_KP_5 5 ESC O u
1615     XK_KP_6 6 ESC O v
1616     XK_KP_7 7 ESC O w
1617     XK_KP_8 8 ESC O x
1618     XK_KP_9 9 ESC O y
1619    
1620     CONFIGURE OPTIONS
1621     General hint: if you get compile errors, then likely your configuration
1622 root 1.24 hasn't been tested well. Either try with "--enable-everything" or use
1623     the ./reconf script as a base for experiments. ./reconf is used by
1624     myself, so it should generally be a working config. Of course, you
1625     should always report when a combination doesn't work, so it can be
1626     fixed. Marc Lehmann <rxvt@schmorp.de>.
1627    
1628     All
1629 root 1.1
1630     --enable-everything
1631 root 1.24 Add (or remove) support for all non-multichoice options listed in
1632     "./configure --help".
1633    
1634     You can specify this and then disable options you do not like by
1635     *following* this with the appropriate "--disable-..." arguments, or
1636     you can start with a minimal configuration by specifying
1637     "--disable-everything" and than adding just the "--enable-..."
1638     arguments you want.
1639 root 1.1
1640 root 1.24 --enable-xft (default: enabled)
1641 root 1.1 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1642     are slower and require lots of memory, but as long as you don't use
1643     them, you don't pay for them.
1644    
1645 root 1.24 --enable-font-styles (default: on)
1646 root 1.1 Add support for bold, *italic* and *bold italic* font styles. The
1647     fonts can be set manually or automatically.
1648    
1649 root 1.24 --with-codesets=NAME,... (default: all)
1650 root 1.19 Compile in support for additional codeset (encoding) groups ("eu",
1651     "vn" are always compiled in, which includes most 8-bit character
1652     sets). These codeset tables are used for driving X11 core fonts,
1653     they are not required for Xft fonts, although having them compiled
1654     in lets rxvt-unicode choose replacement fonts more intelligently.
1655     Compiling them in will make your binary bigger (all of together cost
1656     about 700kB), but it doesn't increase memory usage unless you use a
1657     font requiring one of these encodings.
1658 root 1.1
1659     all all available codeset groups
1660     zh common chinese encodings
1661     zh_ext rarely used but very big chinese encodigs
1662     jp common japanese encodings
1663     jp_ext rarely used but big japanese encodings
1664     kr korean encodings
1665    
1666 root 1.24 --enable-xim (default: on)
1667 root 1.1 Add support for XIM (X Input Method) protocol. This allows using
1668     alternative input methods (e.g. kinput2) and will also correctly set
1669     up the input for people using dead keys or compose keys.
1670    
1671 root 1.24 --enable-unicode3 (default: off)
1672 root 1.49 Recommended to stay off unless you really need non-BMP characters.
1673    
1674 root 1.1 Enable direct support for displaying unicode codepoints above 65535
1675     (the basic multilingual page). This increases storage requirements
1676     per character from 2 to 4 bytes. X11 fonts do not yet support these
1677     extra characters, but Xft does.
1678    
1679     Please note that rxvt-unicode can store unicode code points >65535
1680     even without this flag, but the number of such characters is limited
1681     to a view thousand (shared with combining characters, see next
1682     switch), and right now rxvt-unicode cannot display them
1683     (input/output and cut&paste still work, though).
1684    
1685 root 1.24 --enable-combining (default: on)
1686 root 1.1 Enable automatic composition of combining characters into composite
1687     characters. This is required for proper viewing of text where
1688     accents are encoded as seperate unicode characters. This is done by
1689     using precomposited characters when available or creating new
1690     pseudo-characters when no precomposed form exists.
1691    
1692     Without --enable-unicode3, the number of additional precomposed
1693 root 1.49 characters is somewhat limited (the 6400 private use characters will
1694     be (ab-)used). With --enable-unicode3, no practical limit exists.
1695 root 1.13
1696     This option will also enable storage (but not display) of characters
1697     beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1698 root 1.1
1699     The combining table also contains entries for arabic presentation
1700     forms, but these are not currently used. Bug me if you want these to
1701 root 1.13 be used (and tell me how these are to be used...).
1702 root 1.1
1703 root 1.24 --enable-fallback(=CLASS) (default: Rxvt)
1704     When reading resource settings, also read settings for class CLASS.
1705     To disable resource fallback use --disable-fallback.
1706    
1707     --with-res-name=NAME (default: urxvt)
1708     Use the given name as default application name when reading
1709     resources. Specify --with-res-name=rxvt to replace rxvt.
1710    
1711     --with-res-class=CLASS /default: URxvt)
1712     Use the given class as default application class when reading
1713     resources. Specify --with-res-class=Rxvt to replace rxvt.
1714 root 1.1
1715 root 1.24 --enable-utmp (default: on)
1716 root 1.1 Write user and tty to utmp file (used by programs like w) at start
1717     of rxvt execution and delete information when rxvt exits.
1718    
1719 root 1.24 --enable-wtmp (default: on)
1720 root 1.1 Write user and tty to wtmp file (used by programs like last) at
1721     start of rxvt execution and write logout when rxvt exits. This
1722     option requires --enable-utmp to also be specified.
1723    
1724 root 1.24 --enable-lastlog (default: on)
1725 root 1.1 Write user and tty to lastlog file (used by programs like lastlogin)
1726     at start of rxvt execution. This option requires --enable-utmp to
1727     also be specified.
1728    
1729 root 1.34 --enable-xpm-background (default: on)
1730 root 1.1 Add support for XPM background pixmaps.
1731    
1732 root 1.34 --enable-transparency (default: on)
1733 root 1.1 Add support for inheriting parent backgrounds thus giving a fake
1734     transparency to the term.
1735    
1736 root 1.24 --enable-fading (default: on)
1737     Add support for fading the text when focus is lost (requires
1738     "--enable-transparency").
1739    
1740     --enable-tinting (default: on)
1741     Add support for tinting of transparent backgrounds (requires
1742     "--enable-transparency").
1743 root 1.1
1744 root 1.24 --enable-rxvt-scroll (default: on)
1745 root 1.1 Add support for the original rxvt scrollbar.
1746    
1747 root 1.24 --enable-next-scroll (default: on)
1748 root 1.1 Add support for a NeXT-like scrollbar.
1749    
1750 root 1.24 --enable-xterm-scroll (default: on)
1751 root 1.1 Add support for an Xterm-like scrollbar.
1752    
1753 root 1.24 --enable-plain-scroll (default: on)
1754 root 1.1 Add support for a very unobtrusive, plain-looking scrollbar that is
1755     the favourite of the rxvt-unicode author, having used it for many
1756     years.
1757    
1758 root 1.24 --enable-ttygid (default: off)
1759 root 1.1 Change tty device setting to group "tty" - only use this if your
1760     system uses this type of security.
1761    
1762     --disable-backspace-key
1763 root 1.24 Removes any handling of the backspace key by us - let the X server
1764 root 1.1 do it.
1765    
1766     --disable-delete-key
1767 root 1.24 Removes any handling of the delete key by us - let the X server do
1768 root 1.1 it.
1769    
1770     --disable-resources
1771 root 1.24 Removes any support for resource checking.
1772 root 1.1
1773     --disable-swapscreen
1774 root 1.24 Remove support for secondary/swap screen.
1775 root 1.1
1776 root 1.24 --enable-frills (default: on)
1777 root 1.1 Add support for many small features that are not essential but nice
1778     to have. Normally you want this, but for very small binaries you may
1779     want to disable this.
1780    
1781 root 1.2 A non-exhaustive list of features enabled by "--enable-frills"
1782     (possibly in combination with other switches) is:
1783    
1784     MWM-hints
1785 root 1.17 EWMH-hints (pid, utf8 names) and protocols (ping)
1786 root 1.32 seperate underline colour (-underlineColor)
1787     settable border widths and borderless switch (-w, -b, -bl)
1788 root 1.52 visual depth selection (-depth)
1789 root 1.32 settable extra linespacing /-lsp)
1790 root 1.2 iso-14755-2 and -3, and visual feedback
1791 root 1.32 tripleclickwords (-tcw)
1792     settable insecure mode (-insecure)
1793 root 1.11 keysym remapping support
1794 root 1.32 cursor blinking and underline cursor (-cb, -uc)
1795     XEmbed support (-embed)
1796     user-pty (-pty-fd)
1797     hold on exit (-hold)
1798     skip builtin block graphics (-sbg)
1799 root 1.52
1800     It also enabled some non-essential features otherwise disabled, such
1801     as:
1802    
1803     some round-trip time optimisations
1804     nearest color allocation on pseudocolor screens
1805     UTF8_STRING supporr for selection
1806 root 1.32 sgr modes 90..97 and 100..107
1807 root 1.52 backindex and forwardindex escape sequences
1808     view change/zero scorllback esacpe sequences
1809     locale switching escape sequence
1810     window op and some xterm/OSC escape sequences
1811     rectangular selections
1812     trailing space removal for selections
1813     verbose X error handling
1814 root 1.2
1815 root 1.24 --enable-iso14755 (default: on)
1816 root 1.44 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1817 root 1.1 Basic support (section 5.1) is enabled by "--enable-frills", while
1818     support for 5.2, 5.3 and 5.4 is enabled with this switch.
1819    
1820 root 1.24 --enable-keepscrolling (default: on)
1821 root 1.1 Add support for continual scrolling of the display when you hold the
1822     mouse button down on a scrollbar arrow.
1823    
1824 root 1.24 --enable-mousewheel (default: on)
1825 root 1.1 Add support for scrolling via mouse wheel or buttons 4 & 5.
1826    
1827 root 1.24 --enable-slipwheeling (default: on)
1828 root 1.1 Add support for continual scrolling (using the mouse wheel as an
1829     accelerator) while the control key is held down. This option
1830     requires --enable-mousewheel to also be specified.
1831    
1832     --disable-new-selection
1833     Remove support for mouse selection style like that of xterm.
1834    
1835 root 1.24 --enable-dmalloc (default: off)
1836 root 1.1 Use Gray Watson's malloc - which is good for debugging See
1837 root 1.69 <http://www.letters.com/dmalloc/> for details If you use either this
1838 root 1.1 or the next option, you may need to edit src/Makefile after
1839     compiling to point DINCLUDE and DLIB to the right places.
1840    
1841     You can only use either this option and the following (should you
1842     use either) .
1843    
1844 root 1.24 --enable-dlmalloc (default: off)
1845 root 1.1 Use Doug Lea's malloc - which is good for a production version See
1846     <http://g.oswego.edu/dl/html/malloc.html> for details.
1847    
1848 root 1.24 --enable-smart-resize (default: on)
1849 root 1.25 Add smart growth/shrink behaviour when changing font size via hot
1850 root 1.26 keys. This should keep the window corner which is closest to a
1851     corner of the screen in a fixed position.
1852 root 1.1
1853 root 1.24 --enable-pointer-blank (default: on)
1854 root 1.1 Add support to have the pointer disappear when typing or inactive.
1855    
1856 root 1.49 --enable-perl (default: on)
1857 root 1.44 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
1858 root 1.30 (doc/rxvtperl.txt) for more info on this feature, or the files in
1859 root 1.33 src/perl-ext/ for the extensions that are installed by default. The
1860     perl interpreter that is used can be specified via the "PERL"
1861     environment variable when running configure.
1862 root 1.30
1863 root 1.24 --with-name=NAME (default: urxvt)
1864     Set the basename for the installed binaries, resulting in "urxvt",
1865     "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1866    
1867     --with-term=NAME (default: rxvt-unicode)
1868     Change the environmental variable for the terminal to NAME.
1869 root 1.1
1870     --with-terminfo=PATH
1871     Change the environmental variable for the path to the terminfo tree
1872     to PATH.
1873    
1874     --with-x
1875     Use the X Window System (pretty much default, eh?).
1876    
1877     --with-xpm-includes=DIR
1878     Look for the XPM includes in DIR.
1879    
1880     --with-xpm-library=DIR
1881     Look for the XPM library in DIR.
1882    
1883     --with-xpm
1884     Not needed - define via --enable-xpm-background.
1885    
1886     AUTHORS
1887     Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1888     reworked it from the original Rxvt documentation, which was done by
1889     Geoff Wing <gcw@pobox.com>, who in turn used the XTerm documentation and
1890     other sources.
1891