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