ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.28 by root, Mon Nov 29 13:45:10 2004 UTC vs.
Revision 1.76 by root, Wed Jan 11 19:55:34 2006 UTC

1=head1 NAME 1=head1 NAME
2 2
3RXVT REFERENCE - FAQ, command sequences and other background information 3RXVT REFERENCE - FAQ, command sequences and other background information
4 4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
5=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
6 26
7=over 4 27=over 4
8 28
29=item Isn't rxvt supposed to be small? Don't all those features bloat?
30
31I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even
35with C<--disable-everything>, this comparison is a bit unfair, as many
36features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
37already in use in this mode.
38
39 text data bss drs rss filename
40 98398 1664 24 15695 1824 rxvt --disable-everything
41 188985 9048 66616 18222 1788 urxvt --disable-everything
42
43When you C<--enable-everything> (which _is_ unfair, as this involves xft
44and full locale/XIM support which are quite bloaty inside libX11 and my
45libc), the two diverge, but not unreasnobaly so.
46
47 text data bss drs rss filename
48 163431 2152 24 20123 2060 rxvt --enable-everything
49 1035683 49680 66648 29096 3680 urxvt --enable-everything
50
51The very large size of the text section is explained by the east-asian
52encoding tables, which, if unused, take up disk space but nothing else
53and can be compiled out unless you rely on X11 core fonts that use those
54encodings. The BSS size comes from the 64k emergency buffer that my c++
55compiler allocates (but of course doesn't use unless you are out of
56memory). Also, using an xft font instead of a core font immediately adds a
57few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
58not used.
59
60Of course, due to every character using two or four bytes instead of one,
61a large scrollback buffer will ultimately make rxvt-unicode use more
62memory.
63
64Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65still fares rather well. And compared to some monsters like gnome-terminal
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*.
70
71=item Why C++, isn't that unportable/bloated/uncool?
72
73Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++.
77
78My personal stance on this is that C++ is less portable than C, but in
79the case of rxvt-unicode this hardly matters, as its portability limits
80are defined by things like X11, pseudo terminals, locale support and unix
81domain sockets, which are all less portable than C++ itself.
82
83Regarding the bloat, see the above question: It's easy to write programs
84in C that use gobs of memory, an certainly possible to write programs in
85C++ that don't. C++ also often comes with large libraries, but this is
86not necessarily the case with GCC. Here is what rxvt links against on my
87system with a minimal config:
88
89 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
90 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
91 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
92 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
93
94And here is rxvt-unicode:
95
96 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
97 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
98 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
99 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101
102No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :)
104
105=item Does it support tabs, can I have a tabbed rxvt-unicode?
106
107rxvt-unicode does not directly support tabs. It will work fine with
108tabbing functionality of many window managers or similar tabbing programs,
109and its embedding-features allow it to be embedded into other programs,
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113
9=item How do I know which rxvt-unicode version I'm using? 114=item How do I know which rxvt-unicode version I'm using?
10 115
11The version number is displayed with the usage (-h). Also the escape 116The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 117sequence C<ESC [ 8 n> sets the window title to the version number. When
118using the @@RXVT_NAME@@c client, the version displayed is that of the
119daemon.
120
121=item I am using Debian GNU/Linux and have a problem...
122
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large
124patches that considerably change the behaviour of rxvt-unicode. Before
125reporting a bug to the original rxvt-unicode author please download and
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
127and try to reproduce the problem. If you cannot, chances are that the
128problems are specific to Debian GNU/Linux, in which case it should be
129reported via the Debian Bug Tracking System (use C<reportbug> to report
130the bug).
131
132For other problems that also affect the Debian package, you can and
133probably should use the Debian BTS, too, because, after all, it's also a
134bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue.
136
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
138
139You should build one binary with the default options. F<configure>
140now enables most useful options, and the trend goes to making them
141runtime-switchable, too, so there is usually no drawback to enbaling them,
142except higher disk and possibly memory usage. The perl interpreter should
143be enabled, as important functionality (menus, selection, likely more in
144the future) depends on it.
145
146You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
147system-wide (except maybe with C<defaults>). This will result in useful
148behaviour. If your distribution aims at low memory, add an empty
149C<perl-ext-common> resource to the app-defaults file. This will keep the
150perl interpreter disabled until the user enables it.
151
152If you can/want build more binaries, I recommend building a minimal
153one with C<--disable-everything> (very useful) and a maximal one with
154C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used).
156
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158
159Likely not. While I honestly try to make it secure, and am probably not
160bad at it, I think it is simply unreasonable to expect all of freetype
161+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice. Besides, with the embedded perl
164interpreter the possibility for security problems easily multiplies.
165
166Elevated privileges are only required for utmp and pty operations on some
167systems (for example, GNU/Linux doesn't need any extra privileges for
168ptys, but some need it for utmp support). It is planned to mvoe this into
169a forked handler process, but this is not yet done.
170
171So, while setuid/setgid operation is supported and not a problem on your
172typical single-user-no-other-logins unix desktop, always remember that
173its an awful lot of code, most of which isn't checked for security issues
174regularly.
13 175
14=item When I log-in to another system it tells me about missing terminfo data? 176=item When I log-in to another system it tells me about missing terminfo data?
15 177
16The terminal description used by rxvt-unicode is not as widely available 178The terminal description used by rxvt-unicode is not as widely available
17as that for xterm, or even rxvt (for which the same problem often arises). 179as that for xterm, or even rxvt (for which the same problem often arises).
… …
28C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 190C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different 191problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice 192colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though. 193quick-and-dirty workaround for rare cases, though.
32 194
33If you always want to do this you can either recompile rxvt-unicode with 195If you always want to do this (and are fine with the consequences) you
34the desired TERM value or use a resource to set it: 196can either recompile rxvt-unicode with the desired TERM value or use a
197resource to set it:
35 198
36 URxvt.termName: rxvt 199 URxvt.termName: rxvt
37 200
38If you don't plan to use B<rxvt> (quite common...) you could also replace 201If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one. 202the rxvt terminfo file with the rxvt-unicode one.
40 203
204=item C<tic> outputs some error when compiling the terminfo entry.
205
206Most likely it's the empty definition for C<enacs=>. Just replace it by
207C<enacs=\E[0@> and try again.
208
209=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
210
41=item I need a termcap file entry. 211=item I need a termcap file entry.
212
213One reason you might want this is that some distributions or operating
214systems still compile some programs using the long-obsoleted termcap
215library (Fedora Core's bash is one example) and rely on a termcap entry
216for C<rxvt-unicode>.
42 217
43You could use rxvt's termcap entry with resonable results in many cases. 218You could use rxvt's termcap entry with resonable results in many cases.
44You can also create a termcap entry by using terminfo's infocmp program 219You can also create a termcap entry by using terminfo's infocmp program
45like this: 220like this:
46 221
47 infocmp -C rxvt-unicode 222 infocmp -C rxvt-unicode
48 223
49OR you could this termcap entry: 224Or you could use this termcap entry, generated by the command above:
50 225
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 226 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\ 227 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\ 228 :co#80:it#8:li#24:lm#0:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 229 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 230 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 231 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 232 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 233 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 234 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
235 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 236 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\ 237 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ 238 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ 239 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ 240 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ 241 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ 242 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ 243 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 244 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h: 245 :vs=\E[?25h:
70 246
71=item How can I configure rxvt-unicode so that it looks similar to the original rxvt? 247=item Why does C<ls> no longer have coloured output?
72 248
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode 249The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
74behave similar to the original rxvt: 250decide wether a terminal has colour, but uses it's own configuration
251file. Needless to say, C<rxvt-unicode> is not in it's default file (among
252with most other terminals supporting colour). Either add:
75 253
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 254 TERM rxvt-unicode
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1 255
256to C</etc/DIR_COLORS> or simply add:
257
258 alias ls='ls --color=auto'
259
260to your C<.profile> or C<.bashrc>.
261
262=item Why doesn't vim/emacs etc. use the 88 colour mode?
263
264=item Why doesn't vim/emacs etc. make use of italic?
265
266=item Why are the secondary screen-related options not working properly?
267
268Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
269distributions (most notably Debian GNU/Linux) break rxvt-unicode
270by setting C<TERM> to C<rxvt>, which doesn't have these extra
271features. Unfortunately, some of these (most notably, again, Debian
272GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
273file, so you will need to install it on your own (See the question B<When
274I log-in to another system it tells me about missing terminfo data?> on
275how to do this).
276
277=item My numerical keypad acts weird and generates differing output?
278
279Some Debian GNUL/Linux users seem to have this problem, although no
280specific details were reported so far. It is possible that this is caused
281by the wrong C<TERM> setting, although the details of wether and how
282this can happen are unknown, as C<TERM=rxvt> should offer a compatible
283keymap. See the answer to the previous question, and please report if that
284helped.
78 285
79=item Rxvt-unicode does not seem to understand the selected encoding? 286=item Rxvt-unicode does not seem to understand the selected encoding?
80 287
81=item Unicode does not seem to work? 288=item Unicode does not seem to work?
82 289
… …
85subtly garbled, then you should check your locale settings. 292subtly garbled, then you should check your locale settings.
86 293
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 294Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88programs. Often rxvt-unicode is started in the C<C> locale, while the 295programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to 296login script running within the rxvt-unicode window changes the locale to
90sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. 297something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91 298
92The best thing is to fix your startup environment, as you will likely run 299The best thing is to fix your startup environment, as you will likely run
93into other problems. If nothing works you can try this in your .profile. 300into other problems. If nothing works you can try this in your .profile.
94 301
95 printf '\e]701;%s\007' "$LC_CTYPE" 302 printf '\e]701;%s\007' "$LC_CTYPE"
96 303
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 304If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98supported on your systems. Some systems have a C<locale> command which 305supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like: 306displays this (also, C<perl -e0> can be used to check locale settings, as
307it will complain loudly if it cannot set the locale). If it displays something
308like:
100 309
101 locale: Cannot set LC_CTYPE to default locale: ... 310 locale: Cannot set LC_CTYPE to default locale: ...
102 311
103Then the locale you specified is not supported on your system. 312Then the locale you specified is not supported on your system.
104 313
… …
115your system/os) have specified does not cover all the characters you want 324your system/os) have specified does not cover all the characters you want
116to display. 325to display.
117 326
118B<rxvt-unicode> makes a best-effort try at finding a replacement 327B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks 328font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the 329bad/ugly/wrong. Some fonts have totally strange characters that don't
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence 330resemble the correct glyph at all, and rxvt-unicode lacks the artificial
122to detect that a specific glyph is wrong: it has to believe the font that 331intelligence to detect that a specific glyph is wrong: it has to believe
123the characters it contains indeed look correct. 332the font that the characters it claims to contain indeed look correct.
124 333
125In that case, select a font of your taste and add it to the font list, 334In that case, select a font of your taste and add it to the font list,
126e.g.: 335e.g.:
127 336
128 @@RXVT_NAME@@ -fn basefont,font2,font3... 337 @@RXVT_NAME@@ -fn basefont,font2,font3...
… …
130When rxvt-unicode sees a character, it will first look at the base 339When rxvt-unicode sees a character, it will first look at the base
131font. If the base font does not contain the character, it will go to the 340font. If the base font does not contain the character, it will go to the
132next font, and so on. Specifying your own fonts will also speed up this 341next font, and so on. Specifying your own fonts will also speed up this
133search and use less resources within rxvt-unicode and the X-server. 342search and use less resources within rxvt-unicode and the X-server.
134 343
135The only limitation is that all the fonts must not be larger than the base 344The only limitation is that none of the fonts may be larger than the base
136font, as the base font defines the principal cell size, which must be the 345font, as the base font defines the terminal character cell size, which
137same due to the way terminals work. 346must be the same due to the way terminals work.
138 347
139=item Why do some chinese characters look so different than others? 348=item Why do some chinese characters look so different than others?
140 349
141This is because there is a difference between script and language -- 350This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output 351rxvt-unicode does not know which language the text that is output is,
143is, as it only knows the unicode character codes. If rxvt-unicode 352as it only knows the unicode character codes. If rxvt-unicode first
144first sees a japanese character, it might choose a japanese font for 353sees a japanese/chinese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese 354display. Subsequent japanese characters will use that font. Now, many
146characters aren't represented in japanese fonts, so when the first 355chinese characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font 356non-japanese character comes up, rxvt-unicode will look for a chinese font
148-- unfortunately at this point, it will still use the japanese font for 357-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese. 358chinese characters that are also in the japanese font.
150 359
151The workaround is easy: just tag a chinese font at the end of your font 360The workaround is easy: just tag a chinese font at the end of your font
152list (see the previous question). The key is to view the font list as 361list (see the previous question). The key is to view the font list as
153a preference list: If you expect more japanese, list a japanese font 362a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first. 363first. If you expect more chinese, put a chinese font first.
155 364
156In the future it might be possible to switch preferences at runtime (the 365In the future it might be possible to switch language preferences at
157internal data structure has no problem with using different fonts for 366runtime (the internal data structure has no problem with using different
158the same character at the same time, but no interface for this has been 367fonts for the same character at the same time, but no interface for this
159designed yet). 368has been designed yet).
369
370Until then, you might get away with switching fonts at runtime (see L<Can
371I switch the fonts at runtime?> later in this document).
160 372
161=item Why does rxvt-unicode sometimes leave pixel droppings? 373=item Why does rxvt-unicode sometimes leave pixel droppings?
162 374
163Most fonts were not designed for terminal use, which means that character 375Most fonts were not designed for terminal use, which means that character
164size varies a lot. A font that is otherwise fine for terminal use might 376size varies a lot. A font that is otherwise fine for terminal use might
… …
170however: Xft fonts often draw glyphs larger than their acclaimed bounding 382however: Xft fonts often draw glyphs larger than their acclaimed bounding
171box, and rxvt-unicode has no way of detecting this (the correct way is to 383box, and rxvt-unicode has no way of detecting this (the correct way is to
172ask for the character bounding box, which unfortunately is wrong in these 384ask for the character bounding box, which unfortunately is wrong in these
173cases). 385cases).
174 386
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or 387It's not clear (to me at least), wether this is a bug in Xft, freetype,
176the respective font. If you encounter this problem there is no way to work 388or the respective font. If you encounter this problem you might try using
177around this except by using a different font. 389the C<-lsp> option to give the font more height. If that doesn't work, you
390might be forced to use a different font.
178 391
179All of this is not a problem when using X11 core fonts, as their bounding 392All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct. 393box data is correct.
394
395=item On Solaris 9, many line-drawing characters are too wide.
396
397Seems to be a known bug, read
398L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
399following ugly workaround to get non-double-wide-characters working:
400
401 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
181 402
182=item My Compose (Multi_key) key is no longer working. 403=item My Compose (Multi_key) key is no longer working.
183 404
184The most common causes for this are that either your locale is not set 405The most common causes for this are that either your locale is not set
185correctly, or you specified a B<preeditStyle> that is not supported by 406correctly, or you specified a B<preeditStyle> that is not supported by
… …
189rxvt-unicode will continue without an input method. 410rxvt-unicode will continue without an input method.
190 411
191In this case either do not specify a B<preeditStyle> or specify more than 412In this case either do not specify a B<preeditStyle> or specify more than
192one pre-edit style, such as B<OverTheSpot,Root,None>. 413one pre-edit style, such as B<OverTheSpot,Root,None>.
193 414
415=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
416
417Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
418international keyboards) or simply use ISO 14755 support to your
419advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
420codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
421character and so on.
422
194=item How can I keep rxvt-unicode from using reverse video so much? 423=item How can I keep rxvt-unicode from using reverse video so much?
195 424
196First of all, make sure you are running with the right terminfo 425First of all, make sure you are running with the right terminal settings
197(C<urxvt>), which will get rid of most of these effects. Then make sure 426(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
198you have specified colours for italic and bold, as otherwise rxvt-unicode 427make sure you have specified colours for italic and bold, as otherwise
199might use reverse video to simulate the effect: 428rxvt-unicode might use reverse video to simulate the effect:
200 429
201 URxvt*colorBD: white 430 URxvt.colorBD: white
202 URxvt*colorIT: green 431 URxvt.colorIT: green
203 432
204=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 433=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
205 434
206For some unexplainable reason, some programs (i.e. irssi) assume a very 435For some unexplainable reason, some rare programs assume a very weird
207weird colour palette when confronted with a terminal with more than the 436colour palette when confronted with a terminal with more than the standard
208standard 8 colours (rxvt-unicode supports 88). The right fix is, of 4378 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
209course, to fix these programs not to assume non-ISO colours without very 438these programs not to assume non-ISO colours without very good reasons.
210good reasons.
211 439
212In the meantime, you can either edit your C<urxvt> terminfo definition to 440In the meantime, you can either edit your C<rxvt-unicode> terminfo
213only claim 8 colour support or use C<TERM=rxvt>, which will fix colours 441definition to only claim 8 colour support or use C<TERM=rxvt>, which will
214but keep you from using other rxvt-unicode features. 442fix colours but keep you from using other rxvt-unicode features.
215 443
216=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 444=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
217 445
218Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 446Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219in your compile environment, or an implementation that implements it, 447in your compile environment, or an implementation that implements it,
220wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 448wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221B<wchar_t> is represented as unicode. 449B<wchar_t> is represented as unicode.
222 450
223As you might have guessed, FreeBSD does neither define this symobl nor 451As you might have guessed, FreeBSD does neither define this symobl nor
224does it support it. Instead, it uses it's own internal representation of 452does it support it. Instead, it uses it's own internal representation of
225B<wchar_t>. This is, of course, completely legal. 453B<wchar_t>. This is, of course, completely fine with respect to standards.
226 454
455However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
456C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
457
227However, C<__STDC_ISO_10646__> is the only sane way to support 458C<__STDC_ISO_10646__> is the only sane way to support multi-language
228multi-language apps in an OS, as using a locale-dependent (and 459apps in an OS, as using a locale-dependent (and non-standardized)
229non-standardized) representation of B<wchar_t> makes it impossible to 460representation of B<wchar_t> makes it impossible to convert between
230convert between B<wchar_t> (as used by X11 and your applications) and any 461B<wchar_t> (as used by X11 and your applications) and any other encoding
231other encoding without implementing OS-specific-wrappers for each and 462without implementing OS-specific-wrappers for each and every locale. There
232every locale. There simply are no APIs to convert B<wchar_t> into anything 463simply are no APIs to convert B<wchar_t> into anything except the current
233except the current locale encoding. 464locale encoding.
234 465
235Some applications (such as the formidable B<mlterm>) work around this 466Some applications (such as the formidable B<mlterm>) work around this
236by carrying their own replacement functions for character set handling 467by carrying their own replacement functions for character set handling
237with them, and either implementing OS-dependent hacks or doing multiple 468with them, and either implementing OS-dependent hacks or doing multiple
238conversions (which is slow and unreliable in case the OS implements 469conversions (which is slow and unreliable in case the OS implements
239encodings slightly different than the terminal emulator). 470encodings slightly different than the terminal emulator).
240 471
241The rxvt-unicode author insists that the right way to fix this is in the 472The rxvt-unicode author insists that the right way to fix this is in the
242system libraries once and for all, instead of forcing every app to carry 473system libraries once and for all, instead of forcing every app to carry
243complete replacements. 474complete replacements for them :)
475
476=item I use Solaris 9 and it doesn't compile/work/etc.
477
478Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
479problems with C<wcwidth> and a compile problem.
480
481=item How can I use rxvt-unicode under cygwin?
482
483rxvt-unicode should compile and run out of the box on cygwin, using
484the X11 libraries that come with cygwin. libW11 emulation is no
485longer supported (and makes no sense, either, as it only supported a
486single font). I recommend starting the X-server in C<-multiwindow> or
487C<-rootless> mode instead, which will result in similar look&feel as the
488old libW11 emulation.
489
490At the time of this writing, cygwin didn't seem to support any multi-byte
491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings.
244 493
245=item How does rxvt-unicode determine the encoding to use? 494=item How does rxvt-unicode determine the encoding to use?
246 495
247=item Is there an option to switch encodings? 496=item Is there an option to switch encodings?
248 497
… …
250specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 499specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
251UTF-8 or any other encodings with respect to terminal I/O. 500UTF-8 or any other encodings with respect to terminal I/O.
252 501
253The reasons is that there exists a perfectly fine mechanism for selecting 502The reasons is that there exists a perfectly fine mechanism for selecting
254the encoding, doing I/O and (most important) communicating this to all 503the encoding, doing I/O and (most important) communicating this to all
255applications so everybody agrees on character properties such as width and 504applications so everybody agrees on character properties such as width
256code number. This mechanism is the I<locale>. 505and code number. This mechanism is the I<locale>. Applications not using
506that info will have problems (for example, C<xterm> gets the width of
507characters wrong as it uses it's own, locale-independent table under all
508locales).
257 509
258Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 510Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259programs doing the same (that is, most) will automatically agree in the 511programs doing the same (that is, most) will automatically agree in the
260interpretation of characters. 512interpretation of characters.
261 513
… …
268C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms 520C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269(i.e. C<de> or C<german>) are also common. 521(i.e. C<de> or C<german>) are also common.
270 522
271Rxvt-unicode ignores all other locale categories, and except for 523Rxvt-unicode ignores all other locale categories, and except for
272the encoding, ignores country or language-specific settings, 524the encoding, ignores country or language-specific settings,
273i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode. 525i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
526rxvt-unicode.
274 527
275If you want to use a specific encoding you have to make sure you start 528If you want to use a specific encoding you have to make sure you start
276rxvt-unicode with the correct C<LC_CTYPE> category. 529rxvt-unicode with the correct C<LC_CTYPE> category.
277 530
278=item Can I switch locales at runtime? 531=item Can I switch locales at runtime?
279 532
280Yes, using an escape sequence. Try sth. like this, which sets 533Yes, using an escape sequence. Try something like this, which sets
281rxvt-unicode's idea of C<LC_CTYPE>. 534rxvt-unicode's idea of C<LC_CTYPE>.
282 535
283 printf '\e]701;%s\007' ja_JP.SJIS 536 printf '\e]701;%s\007' ja_JP.SJIS
284 537
285See also the previous question. 538See also the previous answer.
286 539
287Sometimes this capability is rather handy when you want to work in one 540Sometimes this capability is rather handy when you want to work in
288locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For 541one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
289example, I use this script to start C<xjdic>, which first switches to a 542(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
290locale supported by xjdic and back later: 543first switches to a locale supported by xjdic and back later:
291 544
292 printf '\e]701;%s\007' ja_JP.SJIS 545 printf '\e]701;%s\007' ja_JP.SJIS
293 xjdic -js 546 xjdic -js
294 printf '\e]701;%s\007' de_DE.UTF-8 547 printf '\e]701;%s\007' de_DE.UTF-8
295 548
549You can also use xterm's C<luit> program, which usually works fine, except
550for some locales where character width differs between program- and
551rxvt-unicode-locales.
552
296=item Can I switch the fonts at runtime? 553=item Can I switch the fonts at runtime?
297 554
298Yes, using an escape sequence. Try sth. like this, which has the same 555Yes, using an escape sequence. Try something like this, which has the same
299effect as using the C<-fn> switch, and takes effect immediately: 556effect as using the C<-fn> switch, and takes effect immediately:
300 557
301 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 558 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
302 559
303This is useful if you e.g. work primarily with japanese (and prefer a 560This is useful if you e.g. work primarily with japanese (and prefer a
… …
308 565
309=item Why do italic characters look as if clipped? 566=item Why do italic characters look as if clipped?
310 567
311Many fonts have difficulties with italic characters and hinting. For 568Many fonts have difficulties with italic characters and hinting. For
312example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 569example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313Mono> completely fails in it's italic face. A workaround is to enable 570Mono> completely fails in it's italic face. A workaround might be to
314freetype autohinting, i.e. like this: 571enable freetype autohinting, i.e. like this:
315 572
316 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 573 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 574 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
318 575
319=item My input method wants <some encoding> but I want UTF-8, what can I do? 576=item My input method wants <some encoding> but I want UTF-8, what can I do?
320 577
321You can specify separate locales for the input method and the rest of the 578You can specify separate locales for the input method and the rest of the
322terminal, using the resource C<imlocale>: 579terminal, using the resource C<imlocale>:
… …
326Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
327use your input method. Please note, however, that you will not be able to 584use your input method. Please note, however, that you will not be able to
328input characters outside C<EUC-JP> in a normal way then, as your input 585input characters outside C<EUC-JP> in a normal way then, as your input
329method limits you. 586method limits you.
330 587
588=item Rxvt-unicode crashes when the X Input Method changes or exits.
589
590Unfortunately, this is unavoidable, as the XIM protocol is racy by
591design. Applications can avoid some crashes at the expense of memory
592leaks, and Input Methods can avoid some crashes by careful ordering at
593exit time. B<kinput2> (and derived input methods) generally succeeds,
594while B<SCIM> (or similar input methods) fails. In the end, however,
595crashes cannot be completely avoided even if both sides cooperate.
596
597So the only workaround is not to kill your Input Method Servers.
598
331=item Rxvt-unicode uses gobs of memory, how can I reduce that? 599=item Rxvt-unicode uses gobs of memory, how can I reduce that?
332 600
333Rxvt-unicode tries to obey the rule of not charging you for sth. you 601Rxvt-unicode tries to obey the rule of not charging you for something you
334don't use. One thing you should try is to configure out all settings that 602don't use. One thing you should try is to configure out all settings that
335you don't need, for example, Xft support is a resource hog by design, 603you don't need, for example, Xft support is a resource hog by design,
336when used. Compiling it out ensures that no Xft font will be loaded 604when used. Compiling it out ensures that no Xft font will be loaded
337accidentally when rxvt-unicode tries to find a font for your characters. 605accidentally when rxvt-unicode tries to find a font for your characters.
338 606
… …
345 613
346=item Can I speed up Xft rendering somehow? 614=item Can I speed up Xft rendering somehow?
347 615
348Yes, the most obvious way to speed it up is to avoid Xft entirely, as 616Yes, the most obvious way to speed it up is to avoid Xft entirely, as
349it is simply slow. If you still want Xft fonts you might try to disable 617it is simply slow. If you still want Xft fonts you might try to disable
350antialiasing (by appending C<:antialiasing=false>), which saves lots of 618antialiasing (by appending C<:antialias=false>), which saves lots of
351memory and also speeds up rendering considerably. 619memory and also speeds up rendering considerably.
352 620
353=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 621=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
354 622
355Rxvt-unicode will use whatever you specify as a font. If it needs to 623Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
391resources (or as long-options). 659resources (or as long-options).
392 660
393Here are values that are supposed to resemble a VGA screen, 661Here are values that are supposed to resemble a VGA screen,
394including the murky brown that passes for low-intensity yellow: 662including the murky brown that passes for low-intensity yellow:
395 663
396 URxvt*color0: #000000 664 URxvt.color0: #000000
397 URxvt*color1: #A80000 665 URxvt.color1: #A80000
398 URxvt*color2: #00A800 666 URxvt.color2: #00A800
399 URxvt*color3: #A8A800 667 URxvt.color3: #A8A800
400 URxvt*color4: #0000A8 668 URxvt.color4: #0000A8
401 URxvt*color5: #A800A8 669 URxvt.color5: #A800A8
402 URxvt*color6: #00A8A8 670 URxvt.color6: #00A8A8
403 URxvt*color7: #A8A8A8 671 URxvt.color7: #A8A8A8
404 672
405 URxvt*color8: #000054 673 URxvt.color8: #000054
406 URxvt*color9: #FF0054 674 URxvt.color9: #FF0054
407 URxvt*color10: #00FF54 675 URxvt.color10: #00FF54
408 URxvt*color11: #FFFF54 676 URxvt.color11: #FFFF54
409 URxvt*color12: #0000FF 677 URxvt.color12: #0000FF
410 URxvt*color13: #FF00FF 678 URxvt.color13: #FF00FF
411 URxvt*color14: #00FFFF 679 URxvt.color14: #00FFFF
412 URxvt*color15: #FFFFFF 680 URxvt.color15: #FFFFFF
413 681
414And here is a more complete set of non-standard colors described as 682And here is a more complete set of non-standard colors described (not by
415"pretty girly": 683me) as "pretty girly".
416 684
417 URxvt.cursorColor: #dc74d1 685 URxvt.cursorColor: #dc74d1
418 URxvt.pointerColor: #dc74d1 686 URxvt.pointerColor: #dc74d1
419 URxvt.background: #0e0e0e 687 URxvt.background: #0e0e0e
420 URxvt.foreground: #4ad5e1 688 URxvt.foreground: #4ad5e1
… …
431 URxvt.color6: #73f7ff 699 URxvt.color6: #73f7ff
432 URxvt.color14: #73f7ff 700 URxvt.color14: #73f7ff
433 URxvt.color7: #e1dddd 701 URxvt.color7: #e1dddd
434 URxvt.color15: #e1dddd 702 URxvt.color15: #e1dddd
435 703
704=item How can I start @@RXVT_NAME@@d in a race-free way?
705
706Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
707display, create the listening socket and then fork.
708
436=item What's with the strange Backspace/Delete key behaviour? 709=item What's with the strange Backspace/Delete key behaviour?
437 710
438Assuming that the physical Backspace key corresponds to the 711Assuming that the physical Backspace key corresponds to the
439BackSpace keysym (not likely for Linux ... see the following 712BackSpace keysym (not likely for Linux ... see the following
440question) there are two standard values that can be used for 713question) there are two standard values that can be used for
… …
458 731
459 # use Backspace = ^? 732 # use Backspace = ^?
460 $ stty erase ^? 733 $ stty erase ^?
461 $ @@RXVT_NAME@@ 734 $ @@RXVT_NAME@@
462 735
463Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
464 737
465For an existing rxvt-unicode: 738For an existing rxvt-unicode:
466 739
467 # use Backspace = ^H 740 # use Backspace = ^H
468 $ stty erase ^H 741 $ stty erase ^H
… …
477properly reflects that. 750properly reflects that.
478 751
479The Delete key is a another casualty of the ill-defined Backspace problem. 752The Delete key is a another casualty of the ill-defined Backspace problem.
480To avoid confusion between the Backspace and Delete keys, the Delete 753To avoid confusion between the Backspace and Delete keys, the Delete
481key has been assigned an escape sequence to match the vt100 for Execute 754key has been assigned an escape sequence to match the vt100 for Execute
482(ESC[3~) and is in the supplied termcap/terminfo. 755(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
483 756
484Some other Backspace problems: 757Some other Backspace problems:
485 758
486some editors use termcap/terminfo, 759some editors use termcap/terminfo,
487some editors (vim I'm told) expect Backspace = ^H, 760some editors (vim I'm told) expect Backspace = ^H,
… …
491 764
492=item I don't like the key-bindings. How do I change them? 765=item I don't like the key-bindings. How do I change them?
493 766
494There are some compile-time selections available via configure. Unless 767There are some compile-time selections available via configure. Unless
495you have run "configure" with the C<--disable-resources> option you can 768you have run "configure" with the C<--disable-resources> option you can
496use the `keysym' resource to alter the keystrings associated with keysym 769use the `keysym' resource to alter the keystrings associated with keysyms.
4970xFF00 - 0xFFFF (function, cursor keys, etc).
498 770
499Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' 771Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
500 772
501 !# ----- special uses ------: 773 URxvt.keysym.Home: \033[1~
502 ! tn3270 login, remap function and arrow keys. 774 URxvt.keysym.End: \033[4~
503 tn3270*font: *clean-bold-*-*--15-* 775 URxvt.keysym.C-apostrophe: \033<C-'>
776 URxvt.keysym.C-slash: \033<C-/>
777 URxvt.keysym.C-semicolon: \033<C-;>
778 URxvt.keysym.C-grave: \033<C-`>
779 URxvt.keysym.C-comma: \033<C-,>
780 URxvt.keysym.C-period: \033<C-.>
781 URxvt.keysym.C-0x60: \033<C-`>
782 URxvt.keysym.C-Tab: \033<C-Tab>
783 URxvt.keysym.C-Return: \033<C-Return>
784 URxvt.keysym.S-Return: \033<S-Return>
785 URxvt.keysym.S-space: \033<S-Space>
786 URxvt.keysym.M-Up: \033<M-Up>
787 URxvt.keysym.M-Down: \033<M-Down>
788 URxvt.keysym.M-Left: \033<M-Left>
789 URxvt.keysym.M-Right: \033<M-Right>
790 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
791 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
792 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
504 793
505 ! keysym - used by rxvt only 794See some more examples in the documentation for the B<keysym> resource.
506 ! Delete - ^D
507 tn3270*keysym.0xFFFF: \004
508
509 ! Home - ^A
510 tn3270*keysym.0xFF50: \001
511 ! Left - ^B
512 tn3270*keysym.0xFF51: \002
513 ! Up - ^P
514 tn3270*keysym.0xFF52: \020
515 ! Right - ^F
516 tn3270*keysym.0xFF53: \006
517 ! Down - ^N
518 tn3270*keysym.0xFF54: \016
519 ! End - ^E
520 tn3270*keysym.0xFF57: \005
521
522 ! F1 - F12
523 tn3270*keysym.0xFFBE: \e1
524 tn3270*keysym.0xFFBF: \e2
525 tn3270*keysym.0xFFC0: \e3
526 tn3270*keysym.0xFFC1: \e4
527 tn3270*keysym.0xFFC2: \e5
528 tn3270*keysym.0xFFC3: \e6
529 tn3270*keysym.0xFFC4: \e7
530 tn3270*keysym.0xFFC5: \e8
531 tn3270*keysym.0xFFC6: \e9
532 tn3270*keysym.0xFFC7: \e0
533 tn3270*keysym.0xFFC8: \e-
534 tn3270*keysym.0xFFC9: \e=
535
536 ! map Prior/Next to F7/F8
537 tn3270*keysym.0xFF55: \e7
538 tn3270*keysym.0xFF56: \e8
539 795
540=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 796=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
541How do I make use of them? For example, the Sun Keyboard type 4 797How do I make use of them? For example, the Sun Keyboard type 4
542has the following mappings that rxvt-unicode doesn't recognize. 798has the following mappings that rxvt-unicode doesn't recognize.
543 799
… …
546 F27 == Home 802 F27 == Home
547 F29 == Prior 803 F29 == Prior
548 F33 == End 804 F33 == End
549 F35 == Next 805 F35 == Next
550 806
551Rather than have rxvt-unicode try to accommodate all the various possible keyboard 807Rather than have rxvt-unicode try to accommodate all the various possible
552mappings, it is better to use `xmodmap' to remap the keys as required for 808keyboard mappings, it is better to use `xmodmap' to remap the keys as
553your particular machine. 809required for your particular machine.
554 810
555=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? 811=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
556I need this to decide about setting colors etc. 812I need this to decide about setting colors etc.
557 813
558rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 814rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
559check and see if that is set. Note that several programs, JED, slrn, 815check and see if that is set. Note that several programs, JED, slrn,
560Midnight Commander automatically check this variable to decide whether or 816Midnight Commander automatically check this variable to decide whether or
… …
597channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 853channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
598interested in learning about new and exciting problems (but not FAQs :). 854interested in learning about new and exciting problems (but not FAQs :).
599 855
600=back 856=back
601 857
602=head1 SYNOPSIS 858=head1 RXVT TECHNICAL REFERENCE
603
604 # set a new font set
605 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
606
607 # change the locale and tell rxvt-unicode about it
608 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
609
610 # set window title
611 printf '\33]2;%s\007' "new window title"
612 859
613=head1 DESCRIPTION 860=head1 DESCRIPTION
614 861
615The rest of this document describes various technical aspects of 862The rest of this document describes various technical aspects of
616B<rxvt-unicode>. First the description of supported command sequences, 863B<rxvt-unicode>. First the description of supported command sequences,
617followed by menu and pixmap support and last by a description of all 864followed by menu and pixmap support and last by a description of all
618features selectable at C<configure> time. 865features selectable at C<configure> time.
619 866
620=head1 RXVT TECHNICAL REFERENCE
621
622=head1 Definitions 867=head1 Definitions
623 868
624=over 4 869=over 4
625 870
626=item B<< C<c> >> 871=item B<< C<c> >>
… …
754Single Shift Select of G3 Character Set (SS3): affects next character 999Single Shift Select of G3 Character Set (SS3): affects next character
755only I<unimplemented> 1000only I<unimplemented>
756 1001
757=item B<< C<ESC Z> >> 1002=item B<< C<ESC Z> >>
758 1003
759Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1004Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
760 1005
761=item B<< C<ESC c> >> 1006=item B<< C<ESC c> >>
762 1007
763Full reset (RIS) 1008Full reset (RIS)
764 1009
… …
768 1013
769=item B<< C<ESC o> >> 1014=item B<< C<ESC o> >>
770 1015
771Invoke the G3 Character Set (LS3) 1016Invoke the G3 Character Set (LS3)
772 1017
773=item B<< C<ESC> ( C> >> 1018=item B<< C<ESC ( C> >>
774 1019
775Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1020Designate G0 Character Set (ISO 2022), see below for values of C<C>.
776 1021
777=item B<< C<ESC> ) C> >> 1022=item B<< C<ESC ) C> >>
778 1023
779Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1024Designate G1 Character Set (ISO 2022), see below for values of C<C>.
780 1025
781=item B<< C<ESC * C> >> 1026=item B<< C<ESC * C> >>
782 1027
… …
923 1168
924=item B<< C<ESC [ Ps c> >> 1169=item B<< C<ESC [ Ps c> >>
925 1170
926Send Device Attributes (DA) 1171Send Device Attributes (DA)
927B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1172B<< C<Ps = 0> >> (or omitted): request attributes from terminal
928returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1173returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
929Option'') 1174Option'')
930 1175
931=item B<< C<ESC [ Ps d> >> 1176=item B<< C<ESC [ Ps d> >>
932 1177
933Cursor to Line B<< C<Ps> >> (VPA) 1178Cursor to Line B<< C<Ps> >> (VPA)
… …
1049 1294
1050=item B<< C<ESC [ s> >> 1295=item B<< C<ESC [ s> >>
1051 1296
1052Save Cursor (SC) 1297Save Cursor (SC)
1053 1298
1299=item B<< C<ESC [ Ps;Pt t> >>
1300
1301Window Operations
1302
1303=begin table
1304
1305 B<< C<Ps = 1> >> Deiconify (map) window
1306 B<< C<Ps = 2> >> Iconify window
1307 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1308 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1309 B<< C<Ps = 5> >> Raise window
1310 B<< C<Ps = 6> >> Lower window
1311 B<< C<Ps = 7> >> Refresh screen once
1312 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1313 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1314 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1315 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1316 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1317 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1318 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1319 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1320 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1321
1322=end table
1323
1324=item B<< C<ESC [ u> >>
1325
1326Restore Cursor
1327
1054=item B<< C<ESC [ Ps x> >> 1328=item B<< C<ESC [ Ps x> >>
1055 1329
1056Request Terminal Parameters (DECREQTPARM) 1330Request Terminal Parameters (DECREQTPARM)
1057
1058=item B<< C<ESC [ u> >>
1059
1060Restore Cursor
1061 1331
1062=back 1332=back
1063 1333
1064X<PrivateModes> 1334X<PrivateModes>
1065 1335
… …
1299 1569
1300=begin table 1570=begin table
1301 1571
1302 B<< C<h> >> Scroll to bottom when a key is pressed 1572 B<< C<h> >> Scroll to bottom when a key is pressed
1303 B<< C<l> >> Don't scroll to bottom when a key is pressed 1573 B<< C<l> >> Don't scroll to bottom when a key is pressed
1574
1575=end table
1576
1577=item B<< C<Ps = 1021> >> (B<rxvt>)
1578
1579=begin table
1580
1581 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1582 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1304 1583
1305=end table 1584=end table
1306 1585
1307=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
1308 1587
… …
1357 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1636 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1358 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1637 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1359 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1638 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1360 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1361 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1362 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1363 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1364 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1365 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1366 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1367 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1368 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1647 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1369 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1370 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1649 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1371 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1372 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1373 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1654 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1374 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1655 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1375 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1656 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1376 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1657 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1377 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1658 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1659 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1660 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1661 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1378 1662
1379=end table 1663=end table
1380 1664
1381=back 1665=back
1382 1666
… …
1434 1718
1435=item B<< [title:+I<string>] >> 1719=item B<< [title:+I<string>] >>
1436 1720
1437set the current menuBar's title to I<string>, which may contain the 1721set the current menuBar's title to I<string>, which may contain the
1438following format specifiers: 1722following format specifiers:
1439B<%%> : literal B<%> character 1723
1440B<%n> : rxvt name (as per the B<-name> command-line option) 1724 B<%n> rxvt name (as per the B<-name> command-line option)
1441B<%v> : rxvt version 1725 B<%v> rxvt version
1726 B<%%> literal B<%> character
1442 1727
1443=item B<[done]> 1728=item B<[done]>
1444 1729
1445set menuBar access as B<readonly>. 1730set menuBar access as B<readonly>.
1446End-of-file tag for B<< [read:+I<file>] >> operations. 1731End-of-file tag for B<< [read:+I<file>] >> operations.
… …
1592 1877
1593As a convenience for the many Emacs-type editors, I<action> may start 1878As a convenience for the many Emacs-type editors, I<action> may start
1594with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1879with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1595appended if missed from B<M-x> commands. 1880appended if missed from B<M-x> commands.
1596 1881
1597As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1882As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1598quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1883quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1599 1884
1600=over 4 1885=over 4
1601 1886
1602=item For example, 1887=item For example,
… …
2038=end table 2323=end table
2039 2324
2040=head1 CONFIGURE OPTIONS 2325=head1 CONFIGURE OPTIONS
2041 2326
2042General hint: if you get compile errors, then likely your configuration 2327General hint: if you get compile errors, then likely your configuration
2043hasn't been tested well. Either try with --enable-everything or use the 2328hasn't been tested well. Either try with C<--enable-everything> or use
2044./reconf script as a base for experiments. ./reconf is used by myself, 2329the F<./reconf> script as a base for experiments. F<./reconf> is used by
2045so it should generally be a working config. Of course, you should always 2330myself, so it should generally be a working config. Of course, you should
2046report when a combination doesn't work, so it can be fixed. Marc Lehmann 2331always report when a combination doesn't work, so it can be fixed. Marc
2047<rxvt@schmorp.de>. 2332Lehmann <rxvt@schmorp.de>.
2333
2334All
2048 2335
2049=over 4 2336=over 4
2050 2337
2051=item --enable-everything 2338=item --enable-everything
2052 2339
2053Add support for all non-multichoice options listed in "./configure 2340Add (or remove) support for all non-multichoice options listed in "./configure
2054--help". Note that unlike other enable options this is order dependant. 2341--help".
2342
2055You can specify this and then disable options which this enables by 2343You can specify this and then disable options you do not like by
2056I<following> this with the appropriate commands. 2344I<following> this with the appropriate C<--disable-...> arguments,
2345or you can start with a minimal configuration by specifying
2346C<--disable-everything> and than adding just the C<--enable-...> arguments
2347you want.
2057 2348
2058=item --enable-xft 2349=item --enable-xft (default: enabled)
2059 2350
2060Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2351Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2061slower and require lots of memory, but as long as you don't use them, you 2352slower and require lots of memory, but as long as you don't use them, you
2062don't pay for them. 2353don't pay for them.
2063 2354
2064=item --enable-font-styles 2355=item --enable-font-styles (default: on)
2065 2356
2066Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2357Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2067styles. The fonts can be set manually or automatically. 2358styles. The fonts can be set manually or automatically.
2068 2359
2069=item --with-codesets=NAME,... 2360=item --with-codesets=NAME,... (default: all)
2070 2361
2071Compile in support for additional codeset (encoding) groups (eu, vn are 2362Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2072always compiled in, which includes most 8-bit character sets). These 2363are always compiled in, which includes most 8-bit character sets). These
2073codeset tables are currently only used for driving X11 core fonts, they 2364codeset tables are used for driving X11 core fonts, they are not required
2074are not required for Xft fonts. Compiling them in will make your binary 2365for Xft fonts, although having them compiled in lets rxvt-unicode choose
2075bigger (together about 700kB), but it doesn't increase memory usage unless 2366replacement fonts more intelligently. Compiling them in will make your
2367binary bigger (all of together cost about 700kB), but it doesn't increase
2076you use an X11 font requiring one of these encodings. 2368memory usage unless you use a font requiring one of these encodings.
2077 2369
2078=begin table 2370=begin table
2079 2371
2080 all all available codeset groups 2372 all all available codeset groups
2081 zh common chinese encodings 2373 zh common chinese encodings
… …
2084 jp_ext rarely used but big japanese encodings 2376 jp_ext rarely used but big japanese encodings
2085 kr korean encodings 2377 kr korean encodings
2086 2378
2087=end table 2379=end table
2088 2380
2089=item --enable-xim 2381=item --enable-xim (default: on)
2090 2382
2091Add support for XIM (X Input Method) protocol. This allows using 2383Add support for XIM (X Input Method) protocol. This allows using
2092alternative input methods (e.g. kinput2) and will also correctly 2384alternative input methods (e.g. kinput2) and will also correctly
2093set up the input for people using dead keys or compose keys. 2385set up the input for people using dead keys or compose keys.
2094 2386
2095=item --enable-unicode3 2387=item --enable-unicode3 (default: off)
2096 2388
2097Enable direct support for displaying unicode codepoints above 2389Enable direct support for displaying unicode codepoints above
209865535 (the basic multilingual page). This increases storage 239065535 (the basic multilingual page). This increases storage
2099requirements per character from 2 to 4 bytes. X11 fonts do not yet 2391requirements per character from 2 to 4 bytes. X11 fonts do not yet
2100support these extra characters, but Xft does. 2392support these extra characters, but Xft does.
… …
2103even without this flag, but the number of such characters is 2395even without this flag, but the number of such characters is
2104limited to a view thousand (shared with combining characters, 2396limited to a view thousand (shared with combining characters,
2105see next switch), and right now rxvt-unicode cannot display them 2397see next switch), and right now rxvt-unicode cannot display them
2106(input/output and cut&paste still work, though). 2398(input/output and cut&paste still work, though).
2107 2399
2108=item --enable-combining 2400=item --enable-combining (default: on)
2109 2401
2110Enable automatic composition of combining characters into 2402Enable automatic composition of combining characters into
2111composite characters. This is required for proper viewing of text 2403composite characters. This is required for proper viewing of text
2112where accents are encoded as seperate unicode characters. This is 2404where accents are encoded as seperate unicode characters. This is
2113done by using precomposited characters when available or creating 2405done by using precomposited characters when available or creating
2114new pseudo-characters when no precomposed form exists. 2406new pseudo-characters when no precomposed form exists.
2115 2407
2116Without --enable-unicode3, the number of additional precomposed 2408Without --enable-unicode3, the number of additional precomposed characters
2117characters is rather limited (2048, if this is full, rxvt will use the 2409is rather limited (2048, if this is full, rxvt-unicode will use the
2118private use area, extending the number of combinations to 8448). With 2410private use area, extending the number of combinations to 8448). With
2119--enable-unicode3, no practical limit exists. This will also enable 2411--enable-unicode3, no practical limit exists.
2120storage of characters >65535. 2412
2413This option will also enable storage (but not display) of characters
2414beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2121 2415
2122The combining table also contains entries for arabic presentation forms, 2416The combining table also contains entries for arabic presentation forms,
2123but these are not currently used. Bug me if you want these to be used. 2417but these are not currently used. Bug me if you want these to be used (and
2418tell me how these are to be used...).
2124 2419
2125=item --enable-fallback(=CLASS) 2420=item --enable-fallback(=CLASS) (default: Rxvt)
2126 2421
2127When reading resource settings, also read settings for class CLASS 2422When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2128(default: Rxvt). To disable resource fallback use --disable-fallback.
2129 2423
2130=item --with-res-name=NAME 2424=item --with-res-name=NAME (default: urxvt)
2131 2425
2132Use the given name (default: urxvt) as default application name when 2426Use the given name as default application name when
2133reading resources. Specify --with-res-name=rxvt to replace rxvt. 2427reading resources. Specify --with-res-name=rxvt to replace rxvt.
2134 2428
2135=item --with-res-class=CLASS 2429=item --with-res-class=CLASS /default: URxvt)
2136 2430
2137Use the given class (default: URxvt) as default application class 2431Use the given class as default application class
2138when reading resources. Specify --with-res-class=Rxvt to replace 2432when reading resources. Specify --with-res-class=Rxvt to replace
2139rxvt. 2433rxvt.
2140 2434
2141=item --enable-utmp 2435=item --enable-utmp (default: on)
2142 2436
2143Write user and tty to utmp file (used by programs like F<w>) at 2437Write user and tty to utmp file (used by programs like F<w>) at
2144start of rxvt execution and delete information when rxvt exits. 2438start of rxvt execution and delete information when rxvt exits.
2145 2439
2146=item --enable-wtmp 2440=item --enable-wtmp (default: on)
2147 2441
2148Write user and tty to wtmp file (used by programs like F<last>) at 2442Write user and tty to wtmp file (used by programs like F<last>) at
2149start of rxvt execution and write logout when rxvt exits. This 2443start of rxvt execution and write logout when rxvt exits. This
2150option requires --enable-utmp to also be specified. 2444option requires --enable-utmp to also be specified.
2151 2445
2152=item --enable-lastlog 2446=item --enable-lastlog (default: on)
2153 2447
2154Write user and tty to lastlog file (used by programs like 2448Write user and tty to lastlog file (used by programs like
2155F<lastlogin>) at start of rxvt execution. This option requires 2449F<lastlogin>) at start of rxvt execution. This option requires
2156--enable-utmp to also be specified. 2450--enable-utmp to also be specified.
2157 2451
2158=item --enable-xpm-background 2452=item --enable-xpm-background (default: on)
2159 2453
2160Add support for XPM background pixmaps. 2454Add support for XPM background pixmaps.
2161 2455
2162=item --enable-transparency 2456=item --enable-transparency (default: on)
2163 2457
2164Add support for inheriting parent backgrounds thus giving a fake 2458Add support for inheriting parent backgrounds thus giving a fake
2165transparency to the term. 2459transparency to the term.
2166 2460
2167=item --enable-fading 2461=item --enable-fading (default: on)
2168 2462
2169Add support for fading the text when focus is lost. 2463Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2170 2464
2171=item --enable-tinting 2465=item --enable-tinting (default: on)
2172 2466
2173Add support for tinting of transparent backgrounds. 2467Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2174 2468
2175=item --enable-menubar 2469=item --enable-menubar (default: off) [DEPRECATED]
2176 2470
2177Add support for our menu bar system (this interacts badly with 2471Add support for our menu bar system (this interacts badly with dynamic
2178dynamic locale switching currently). 2472locale switching currently). This option is DEPRECATED and will be removed
2473in the future.
2179 2474
2180=item --enable-rxvt-scroll 2475=item --enable-rxvt-scroll (default: on)
2181 2476
2182Add support for the original rxvt scrollbar. 2477Add support for the original rxvt scrollbar.
2183 2478
2184=item --enable-next-scroll 2479=item --enable-next-scroll (default: on)
2185 2480
2186Add support for a NeXT-like scrollbar. 2481Add support for a NeXT-like scrollbar.
2187 2482
2188=item --enable-xterm-scroll 2483=item --enable-xterm-scroll (default: on)
2189 2484
2190Add support for an Xterm-like scrollbar. 2485Add support for an Xterm-like scrollbar.
2191 2486
2192=item --enable-plain-scroll 2487=item --enable-plain-scroll (default: on)
2193 2488
2194Add support for a very unobtrusive, plain-looking scrollbar that 2489Add support for a very unobtrusive, plain-looking scrollbar that
2195is the favourite of the rxvt-unicode author, having used it for 2490is the favourite of the rxvt-unicode author, having used it for
2196many years. 2491many years.
2197 2492
2198=item --enable-half-shadow 2493=item --enable-half-shadow (default: off)
2199 2494
2200Make shadows on the scrollbar only half the normal width & height. 2495Make shadows on the scrollbar only half the normal width & height.
2201only applicable to rxvt scrollbars. 2496only applicable to rxvt scrollbars.
2202 2497
2203=item --enable-ttygid 2498=item --enable-ttygid (default: off)
2204 2499
2205Change tty device setting to group "tty" - only use this if 2500Change tty device setting to group "tty" - only use this if
2206your system uses this type of security. 2501your system uses this type of security.
2207 2502
2208=item --disable-backspace-key 2503=item --disable-backspace-key
2209 2504
2210Disable any handling of the backspace key by us - let the X server 2505Removes any handling of the backspace key by us - let the X server do it.
2506
2507=item --disable-delete-key
2508
2509Removes any handling of the delete key by us - let the X server
2211do it. 2510do it.
2212 2511
2213=item --disable-delete-key
2214
2215Disable any handling of the delete key by us - let the X server
2216do it.
2217
2218=item --disable-resources 2512=item --disable-resources
2219 2513
2220Remove all resources checking. 2514Removes any support for resource checking.
2221 2515
2222=item --enable-xgetdefault 2516=item --enable-xgetdefault
2223 2517
2224Make resources checking via XGetDefault() instead of our small 2518Make resources checking via XGetDefault() instead of our small
2225version which only checks ~/.Xdefaults, or if that doesn't exist 2519version which only checks ~/.Xdefaults, or if that doesn't exist then
2226then ~/.Xresources. 2520~/.Xresources.
2227 2521
2228=item --enable-strings 2522Please note that nowadays, things like XIM will automatically pull in and
2523use the full X resource manager, so the overhead of using it might be very
2524small, if nonexistant.
2525
2526=item --enable-strings (default: off)
2229 2527
2230Add support for our possibly faster memset() function and other 2528Add support for our possibly faster memset() function and other
2231various routines, overriding your system's versions which may 2529various routines, overriding your system's versions which may
2232have been hand-crafted in assembly or may require extra libraries 2530have been hand-crafted in assembly or may require extra libraries
2233to link in. (this breaks ANSI-C rules and has problems on many 2531to link in. (this breaks ANSI-C rules and has problems on many
2234GNU/Linux systems). 2532GNU/Linux systems).
2235 2533
2236=item --disable-swapscreen 2534=item --disable-swapscreen
2237 2535
2238Remove support for swap screen. 2536Remove support for secondary/swap screen.
2239 2537
2240=item --enable-frills 2538=item --enable-frills (default: on)
2241 2539
2242Add support for many small features that are not essential but nice to 2540Add support for many small features that are not essential but nice to
2243have. Normally you want this, but for very small binaries you may want to 2541have. Normally you want this, but for very small binaries you may want to
2244disable this. 2542disable this.
2245 2543
2544A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2545in combination with other switches) is:
2546
2547 MWM-hints
2548 EWMH-hints (pid, utf8 names) and protocols (ping)
2549 seperate underline colour (-underlineColor)
2550 settable border widths and borderless switch (-w, -b, -bl)
2551 settable extra linespacing /-lsp)
2552 iso-14755-2 and -3, and visual feedback
2553 backindex and forwardindex escape sequence
2554 window op and some xterm/OSC escape sequences
2555 tripleclickwords (-tcw)
2556 settable insecure mode (-insecure)
2557 keysym remapping support
2558 cursor blinking and underline cursor (-cb, -uc)
2559 XEmbed support (-embed)
2560 user-pty (-pty-fd)
2561 hold on exit (-hold)
2562 skip builtin block graphics (-sbg)
2563 sgr modes 90..97 and 100..107
2564
2246=item --enable-iso14755 2565=item --enable-iso14755 (default: on)
2247 2566
2248Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2567Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2249F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2568F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2250C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2569C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2251this switch. 2570this switch.
2252 2571
2253=item --enable-linespace
2254
2255Add support to provide user specified line spacing between text rows.
2256
2257=item --enable-keepscrolling 2572=item --enable-keepscrolling (default: on)
2258 2573
2259Add support for continual scrolling of the display when you hold 2574Add support for continual scrolling of the display when you hold
2260the mouse button down on a scrollbar arrow. 2575the mouse button down on a scrollbar arrow.
2261 2576
2262=item --enable-mousewheel 2577=item --enable-mousewheel (default: on)
2263 2578
2264Add support for scrolling via mouse wheel or buttons 4 & 5. 2579Add support for scrolling via mouse wheel or buttons 4 & 5.
2265 2580
2266=item --enable-slipwheeling 2581=item --enable-slipwheeling (default: on)
2267 2582
2268Add support for continual scrolling (using the mouse wheel as an 2583Add support for continual scrolling (using the mouse wheel as an
2269accelerator) while the control key is held down. This option 2584accelerator) while the control key is held down. This option
2270requires --enable-mousewheel to also be specified. 2585requires --enable-mousewheel to also be specified.
2271 2586
2272=item --disable-new-selection 2587=item --disable-new-selection
2273 2588
2274Remove support for mouse selection style like that of xterm. 2589Remove support for mouse selection style like that of xterm.
2275 2590
2276=item --enable-dmalloc 2591=item --enable-dmalloc (default: off)
2277 2592
2278Use Gray Watson's malloc - which is good for debugging See 2593Use Gray Watson's malloc - which is good for debugging See
2279http://www.letters.com/dmalloc/ for details If you use either this or the 2594http://www.letters.com/dmalloc/ for details If you use either this or the
2280next option, you may need to edit src/Makefile after compiling to point 2595next option, you may need to edit src/Makefile after compiling to point
2281DINCLUDE and DLIB to the right places. 2596DINCLUDE and DLIB to the right places.
2282 2597
2283You can only use either this option and the following (should 2598You can only use either this option and the following (should
2284you use either) . 2599you use either) .
2285 2600
2286=item --enable-dlmalloc 2601=item --enable-dlmalloc (default: off)
2287 2602
2288Use Doug Lea's malloc - which is good for a production version 2603Use Doug Lea's malloc - which is good for a production version
2289See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2604See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2290 2605
2291=item --enable-smart-resize 2606=item --enable-smart-resize (default: on)
2292 2607
2293Add smart growth/shrink behaviour when changing font size via from hot 2608Add smart growth/shrink behaviour when changing font size via hot
2294keys. This should keep in a fixed position the rxvt corner which is 2609keys. This should keep the window corner which is closest to a corner of
2295closest to a corner of the screen. 2610the screen in a fixed position.
2296 2611
2297=item --enable-cursor-blink
2298
2299Add support for a blinking cursor.
2300
2301=item --enable-pointer-blank 2612=item --enable-pointer-blank (default: on)
2302 2613
2303Add support to have the pointer disappear when typing or inactive. 2614Add support to have the pointer disappear when typing or inactive.
2304 2615
2305=item --with-name=NAME 2616=item --enable-perl (default: off)
2306 2617
2618Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2619manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2620in F<src/perl-ext/> for the extensions that are installed by default. The
2621perl interpreter that is used can be specified via the C<PERL> environment
2622variable when running configure.
2623
2624=item --with-name=NAME (default: urxvt)
2625
2307Set the basename for the installed binaries (default: urxvt, resulting in 2626Set the basename for the installed binaries, resulting
2308urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2627in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2628C<rxvt>.
2309 2629
2310=item --with-term=NAME 2630=item --with-term=NAME (default: rxvt-unicode)
2311 2631
2312Change the environmental variable for the terminal to NAME (default 2632Change the environmental variable for the terminal to NAME.
2313"rxvt")
2314 2633
2315=item --with-terminfo=PATH 2634=item --with-terminfo=PATH
2316 2635
2317Change the environmental variable for the path to the terminfo tree to 2636Change the environmental variable for the path to the terminfo tree to
2318PATH. 2637PATH.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines