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