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.29 by root, Wed Dec 29 19:17:18 2004 UTC vs.
Revision 1.74 by root, Mon Jan 9 07:24:43 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
160not bad at it, I think it is simply unreasonable to expect all of
161freetype + fontconfig + xft + xlib + ... + 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.
164
165Elevated privileges are only required for utmp and pty operations on some
166systems (for example, GNU/Linux doesn't need any extra privileges for
167ptys, but some need it for utmp support). If rxvt-unicode doesn't support
168the library/setuid helper that your OS needs I'll be happy to assist you
169in implementing support for it.
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
199codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 420codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
200character and so on. 421character and so on.
201 422
202=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?
203 424
204First of all, make sure you are running with the right terminfo 425First of all, make sure you are running with the right terminal settings
205(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
206you have specified colours for italic and bold, as otherwise rxvt-unicode 427make sure you have specified colours for italic and bold, as otherwise
207might use reverse video to simulate the effect: 428rxvt-unicode might use reverse video to simulate the effect:
208 429
209 URxvt*colorBD: white 430 URxvt.colorBD: white
210 URxvt*colorIT: green 431 URxvt.colorIT: green
211 432
212=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?
213 434
214For some unexplainable reason, some programs (i.e. irssi) assume a very 435For some unexplainable reason, some rare programs assume a very weird
215weird colour palette when confronted with a terminal with more than the 436colour palette when confronted with a terminal with more than the standard
216standard 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
217course, to fix these programs not to assume non-ISO colours without very 438these programs not to assume non-ISO colours without very good reasons.
218good reasons.
219 439
220In the meantime, you can either edit your C<urxvt> terminfo definition to 440In the meantime, you can either edit your C<rxvt-unicode> terminfo
221only 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
222but keep you from using other rxvt-unicode features. 442fix colours but keep you from using other rxvt-unicode features.
223 443
224=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.
225 445
226Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 446Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
227in your compile environment, or an implementation that implements it, 447in your compile environment, or an implementation that implements it,
228wether 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
229B<wchar_t> is represented as unicode. 449B<wchar_t> is represented as unicode.
230 450
231As you might have guessed, FreeBSD does neither define this symobl nor 451As you might have guessed, FreeBSD does neither define this symobl nor
232does 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
233B<wchar_t>. This is, of course, completely legal. 453B<wchar_t>. This is, of course, completely fine with respect to standards.
234 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
235However, C<__STDC_ISO_10646__> is the only sane way to support 458C<__STDC_ISO_10646__> is the only sane way to support multi-language
236multi-language apps in an OS, as using a locale-dependent (and 459apps in an OS, as using a locale-dependent (and non-standardized)
237non-standardized) representation of B<wchar_t> makes it impossible to 460representation of B<wchar_t> makes it impossible to convert between
238convert 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
239other encoding without implementing OS-specific-wrappers for each and 462without implementing OS-specific-wrappers for each and every locale. There
240every 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
241except the current locale encoding. 464locale encoding.
242 465
243Some applications (such as the formidable B<mlterm>) work around this 466Some applications (such as the formidable B<mlterm>) work around this
244by carrying their own replacement functions for character set handling 467by carrying their own replacement functions for character set handling
245with them, and either implementing OS-dependent hacks or doing multiple 468with them, and either implementing OS-dependent hacks or doing multiple
246conversions (which is slow and unreliable in case the OS implements 469conversions (which is slow and unreliable in case the OS implements
247encodings slightly different than the terminal emulator). 470encodings slightly different than the terminal emulator).
248 471
249The 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
250system 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
251complete 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.
252 493
253=item How does rxvt-unicode determine the encoding to use? 494=item How does rxvt-unicode determine the encoding to use?
254 495
255=item Is there an option to switch encodings? 496=item Is there an option to switch encodings?
256 497
258specific "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
259UTF-8 or any other encodings with respect to terminal I/O. 500UTF-8 or any other encodings with respect to terminal I/O.
260 501
261The reasons is that there exists a perfectly fine mechanism for selecting 502The reasons is that there exists a perfectly fine mechanism for selecting
262the encoding, doing I/O and (most important) communicating this to all 503the encoding, doing I/O and (most important) communicating this to all
263applications so everybody agrees on character properties such as width and 504applications so everybody agrees on character properties such as width
264code 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).
265 509
266Rxvt-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
267programs doing the same (that is, most) will automatically agree in the 511programs doing the same (that is, most) will automatically agree in the
268interpretation of characters. 512interpretation of characters.
269 513
276C<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
277(i.e. C<de> or C<german>) are also common. 521(i.e. C<de> or C<german>) are also common.
278 522
279Rxvt-unicode ignores all other locale categories, and except for 523Rxvt-unicode ignores all other locale categories, and except for
280the encoding, ignores country or language-specific settings, 524the encoding, ignores country or language-specific settings,
281i.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.
282 527
283If 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
284rxvt-unicode with the correct C<LC_CTYPE> category. 529rxvt-unicode with the correct C<LC_CTYPE> category.
285 530
286=item Can I switch locales at runtime? 531=item Can I switch locales at runtime?
287 532
288Yes, using an escape sequence. Try sth. like this, which sets 533Yes, using an escape sequence. Try something like this, which sets
289rxvt-unicode's idea of C<LC_CTYPE>. 534rxvt-unicode's idea of C<LC_CTYPE>.
290 535
291 printf '\e]701;%s\007' ja_JP.SJIS 536 printf '\e]701;%s\007' ja_JP.SJIS
292 537
293See also the previous question. 538See also the previous answer.
294 539
295Sometimes this capability is rather handy when you want to work in one 540Sometimes this capability is rather handy when you want to work in
296locale (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
297example, 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
298locale supported by xjdic and back later: 543first switches to a locale supported by xjdic and back later:
299 544
300 printf '\e]701;%s\007' ja_JP.SJIS 545 printf '\e]701;%s\007' ja_JP.SJIS
301 xjdic -js 546 xjdic -js
302 printf '\e]701;%s\007' de_DE.UTF-8 547 printf '\e]701;%s\007' de_DE.UTF-8
303 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
304=item Can I switch the fonts at runtime? 553=item Can I switch the fonts at runtime?
305 554
306Yes, 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
307effect as using the C<-fn> switch, and takes effect immediately: 556effect as using the C<-fn> switch, and takes effect immediately:
308 557
309 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 558 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
310 559
311This 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
316 565
317=item Why do italic characters look as if clipped? 566=item Why do italic characters look as if clipped?
318 567
319Many fonts have difficulties with italic characters and hinting. For 568Many fonts have difficulties with italic characters and hinting. For
320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 569example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
321Mono> 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
322freetype autohinting, i.e. like this: 571enable freetype autohinting, i.e. like this:
323 572
324 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 573 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
325 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 574 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
326 575
327=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?
328 577
329You 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
330terminal, using the resource C<imlocale>: 579terminal, using the resource C<imlocale>:
334Now 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
335use 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
336input 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
337method limits you. 586method limits you.
338 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
339=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?
340 600
341Rxvt-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
342don'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
343you 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,
344when 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
345accidentally when rxvt-unicode tries to find a font for your characters. 605accidentally when rxvt-unicode tries to find a font for your characters.
346 606
353 613
354=item Can I speed up Xft rendering somehow? 614=item Can I speed up Xft rendering somehow?
355 615
356Yes, 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
357it 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
358antialiasing (by appending C<:antialiasing=false>), which saves lots of 618antialiasing (by appending C<:antialias=false>), which saves lots of
359memory and also speeds up rendering considerably. 619memory and also speeds up rendering considerably.
360 620
361=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?
362 622
363Rxvt-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
399resources (or as long-options). 659resources (or as long-options).
400 660
401Here are values that are supposed to resemble a VGA screen, 661Here are values that are supposed to resemble a VGA screen,
402including the murky brown that passes for low-intensity yellow: 662including the murky brown that passes for low-intensity yellow:
403 663
404 URxvt*color0: #000000 664 URxvt.color0: #000000
405 URxvt*color1: #A80000 665 URxvt.color1: #A80000
406 URxvt*color2: #00A800 666 URxvt.color2: #00A800
407 URxvt*color3: #A8A800 667 URxvt.color3: #A8A800
408 URxvt*color4: #0000A8 668 URxvt.color4: #0000A8
409 URxvt*color5: #A800A8 669 URxvt.color5: #A800A8
410 URxvt*color6: #00A8A8 670 URxvt.color6: #00A8A8
411 URxvt*color7: #A8A8A8 671 URxvt.color7: #A8A8A8
412 672
413 URxvt*color8: #000054 673 URxvt.color8: #000054
414 URxvt*color9: #FF0054 674 URxvt.color9: #FF0054
415 URxvt*color10: #00FF54 675 URxvt.color10: #00FF54
416 URxvt*color11: #FFFF54 676 URxvt.color11: #FFFF54
417 URxvt*color12: #0000FF 677 URxvt.color12: #0000FF
418 URxvt*color13: #FF00FF 678 URxvt.color13: #FF00FF
419 URxvt*color14: #00FFFF 679 URxvt.color14: #00FFFF
420 URxvt*color15: #FFFFFF 680 URxvt.color15: #FFFFFF
421 681
422And 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
423"pretty girly": 683me) as "pretty girly".
424 684
425 URxvt.cursorColor: #dc74d1 685 URxvt.cursorColor: #dc74d1
426 URxvt.pointerColor: #dc74d1 686 URxvt.pointerColor: #dc74d1
427 URxvt.background: #0e0e0e 687 URxvt.background: #0e0e0e
428 URxvt.foreground: #4ad5e1 688 URxvt.foreground: #4ad5e1
439 URxvt.color6: #73f7ff 699 URxvt.color6: #73f7ff
440 URxvt.color14: #73f7ff 700 URxvt.color14: #73f7ff
441 URxvt.color7: #e1dddd 701 URxvt.color7: #e1dddd
442 URxvt.color15: #e1dddd 702 URxvt.color15: #e1dddd
443 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
444=item What's with the strange Backspace/Delete key behaviour? 709=item What's with the strange Backspace/Delete key behaviour?
445 710
446Assuming that the physical Backspace key corresponds to the 711Assuming that the physical Backspace key corresponds to the
447BackSpace keysym (not likely for Linux ... see the following 712BackSpace keysym (not likely for Linux ... see the following
448question) there are two standard values that can be used for 713question) there are two standard values that can be used for
466 731
467 # use Backspace = ^? 732 # use Backspace = ^?
468 $ stty erase ^? 733 $ stty erase ^?
469 $ @@RXVT_NAME@@ 734 $ @@RXVT_NAME@@
470 735
471Toggle 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).
472 737
473For an existing rxvt-unicode: 738For an existing rxvt-unicode:
474 739
475 # use Backspace = ^H 740 # use Backspace = ^H
476 $ stty erase ^H 741 $ stty erase ^H
485properly reflects that. 750properly reflects that.
486 751
487The 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.
488To avoid confusion between the Backspace and Delete keys, the Delete 753To avoid confusion between the Backspace and Delete keys, the Delete
489key 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
490(ESC[3~) and is in the supplied termcap/terminfo. 755(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
491 756
492Some other Backspace problems: 757Some other Backspace problems:
493 758
494some editors use termcap/terminfo, 759some editors use termcap/terminfo,
495some editors (vim I'm told) expect Backspace = ^H, 760some editors (vim I'm told) expect Backspace = ^H,
499 764
500=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?
501 766
502There are some compile-time selections available via configure. Unless 767There are some compile-time selections available via configure. Unless
503you have run "configure" with the C<--disable-resources> option you can 768you have run "configure" with the C<--disable-resources> option you can
504use the `keysym' resource to alter the keystrings associated with keysym 769use the `keysym' resource to alter the keystrings associated with keysyms.
5050xFF00 - 0xFFFF (function, cursor keys, etc).
506 770
507Here'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>
508 772
509 !# ----- special uses ------: 773 URxvt.keysym.Home: \033[1~
510 ! tn3270 login, remap function and arrow keys. 774 URxvt.keysym.End: \033[4~
511 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
512 793
513 ! keysym - used by rxvt only 794See some more examples in the documentation for the B<keysym> resource.
514 ! Delete - ^D
515 tn3270*keysym.0xFFFF: \004
516
517 ! Home - ^A
518 tn3270*keysym.0xFF50: \001
519 ! Left - ^B
520 tn3270*keysym.0xFF51: \002
521 ! Up - ^P
522 tn3270*keysym.0xFF52: \020
523 ! Right - ^F
524 tn3270*keysym.0xFF53: \006
525 ! Down - ^N
526 tn3270*keysym.0xFF54: \016
527 ! End - ^E
528 tn3270*keysym.0xFF57: \005
529
530 ! F1 - F12
531 tn3270*keysym.0xFFBE: \e1
532 tn3270*keysym.0xFFBF: \e2
533 tn3270*keysym.0xFFC0: \e3
534 tn3270*keysym.0xFFC1: \e4
535 tn3270*keysym.0xFFC2: \e5
536 tn3270*keysym.0xFFC3: \e6
537 tn3270*keysym.0xFFC4: \e7
538 tn3270*keysym.0xFFC5: \e8
539 tn3270*keysym.0xFFC6: \e9
540 tn3270*keysym.0xFFC7: \e0
541 tn3270*keysym.0xFFC8: \e-
542 tn3270*keysym.0xFFC9: \e=
543
544 ! map Prior/Next to F7/F8
545 tn3270*keysym.0xFF55: \e7
546 tn3270*keysym.0xFF56: \e8
547 795
548=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.
549How 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
550has the following mappings that rxvt-unicode doesn't recognize. 798has the following mappings that rxvt-unicode doesn't recognize.
551 799
554 F27 == Home 802 F27 == Home
555 F29 == Prior 803 F29 == Prior
556 F33 == End 804 F33 == End
557 F35 == Next 805 F35 == Next
558 806
559Rather than have rxvt-unicode try to accommodate all the various possible keyboard 807Rather than have rxvt-unicode try to accommodate all the various possible
560mappings, 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
561your particular machine. 809required for your particular machine.
562 810
563=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?
564I need this to decide about setting colors etc. 812I need this to decide about setting colors etc.
565 813
566rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 814rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
567check 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,
568Midnight Commander automatically check this variable to decide whether or 816Midnight Commander automatically check this variable to decide whether or
605channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 853channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
606interested in learning about new and exciting problems (but not FAQs :). 854interested in learning about new and exciting problems (but not FAQs :).
607 855
608=back 856=back
609 857
610=head1 SYNOPSIS 858=head1 RXVT TECHNICAL REFERENCE
611
612 # set a new font set
613 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
614
615 # change the locale and tell rxvt-unicode about it
616 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
617
618 # set window title
619 printf '\33]2;%s\007' "new window title"
620 859
621=head1 DESCRIPTION 860=head1 DESCRIPTION
622 861
623The rest of this document describes various technical aspects of 862The rest of this document describes various technical aspects of
624B<rxvt-unicode>. First the description of supported command sequences, 863B<rxvt-unicode>. First the description of supported command sequences,
625followed 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
626features selectable at C<configure> time. 865features selectable at C<configure> time.
627 866
628=head1 RXVT TECHNICAL REFERENCE
629
630=head1 Definitions 867=head1 Definitions
631 868
632=over 4 869=over 4
633 870
634=item B<< C<c> >> 871=item B<< C<c> >>
762Single Shift Select of G3 Character Set (SS3): affects next character 999Single Shift Select of G3 Character Set (SS3): affects next character
763only I<unimplemented> 1000only I<unimplemented>
764 1001
765=item B<< C<ESC Z> >> 1002=item B<< C<ESC Z> >>
766 1003
767Obsolete 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>
768 1005
769=item B<< C<ESC c> >> 1006=item B<< C<ESC c> >>
770 1007
771Full reset (RIS) 1008Full reset (RIS)
772 1009
776 1013
777=item B<< C<ESC o> >> 1014=item B<< C<ESC o> >>
778 1015
779Invoke the G3 Character Set (LS3) 1016Invoke the G3 Character Set (LS3)
780 1017
781=item B<< C<ESC> ( C> >> 1018=item B<< C<ESC ( C> >>
782 1019
783Designate 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>.
784 1021
785=item B<< C<ESC> ) C> >> 1022=item B<< C<ESC ) C> >>
786 1023
787Designate 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>.
788 1025
789=item B<< C<ESC * C> >> 1026=item B<< C<ESC * C> >>
790 1027
931 1168
932=item B<< C<ESC [ Ps c> >> 1169=item B<< C<ESC [ Ps c> >>
933 1170
934Send Device Attributes (DA) 1171Send Device Attributes (DA)
935B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1172B<< C<Ps = 0> >> (or omitted): request attributes from terminal
936returns: 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
937Option'') 1174Option'')
938 1175
939=item B<< C<ESC [ Ps d> >> 1176=item B<< C<ESC [ Ps d> >>
940 1177
941Cursor to Line B<< C<Ps> >> (VPA) 1178Cursor to Line B<< C<Ps> >> (VPA)
1057 1294
1058=item B<< C<ESC [ s> >> 1295=item B<< C<ESC [ s> >>
1059 1296
1060Save Cursor (SC) 1297Save Cursor (SC)
1061 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
1062=item B<< C<ESC [ Ps x> >> 1328=item B<< C<ESC [ Ps x> >>
1063 1329
1064Request Terminal Parameters (DECREQTPARM) 1330Request Terminal Parameters (DECREQTPARM)
1065
1066=item B<< C<ESC [ u> >>
1067
1068Restore Cursor
1069 1331
1070=back 1332=back
1071 1333
1072X<PrivateModes> 1334X<PrivateModes>
1073 1335
1307 1569
1308=begin table 1570=begin table
1309 1571
1310 B<< C<h> >> Scroll to bottom when a key is pressed 1572 B<< C<h> >> Scroll to bottom when a key is pressed
1311 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)
1312 1583
1313=end table 1584=end table
1314 1585
1315=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
1316 1587
1368 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> >>
1369 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> >>
1370 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> >>
1371 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> >>
1372 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1373 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> >>.
1374 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>
1375 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> >>.
1376 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> >>
1377 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> >>
1378 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).
1379 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).
1380 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> >>
1381 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).
1382 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1653 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1383 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1654 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1384 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1655 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1385 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1656 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1657 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1658 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1659 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1386 1660
1387=end table 1661=end table
1388 1662
1389=back 1663=back
1390 1664
1442 1716
1443=item B<< [title:+I<string>] >> 1717=item B<< [title:+I<string>] >>
1444 1718
1445set the current menuBar's title to I<string>, which may contain the 1719set the current menuBar's title to I<string>, which may contain the
1446following format specifiers: 1720following format specifiers:
1447B<%%> : literal B<%> character 1721
1448B<%n> : rxvt name (as per the B<-name> command-line option) 1722 B<%n> rxvt name (as per the B<-name> command-line option)
1449B<%v> : rxvt version 1723 B<%v> rxvt version
1724 B<%%> literal B<%> character
1450 1725
1451=item B<[done]> 1726=item B<[done]>
1452 1727
1453set menuBar access as B<readonly>. 1728set menuBar access as B<readonly>.
1454End-of-file tag for B<< [read:+I<file>] >> operations. 1729End-of-file tag for B<< [read:+I<file>] >> operations.
1600 1875
1601As a convenience for the many Emacs-type editors, I<action> may start 1876As a convenience for the many Emacs-type editors, I<action> may start
1602with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1877with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1603appended if missed from B<M-x> commands. 1878appended if missed from B<M-x> commands.
1604 1879
1605As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1880As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1606quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1881quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1607 1882
1608=over 4 1883=over 4
1609 1884
1610=item For example, 1885=item For example,
2046=end table 2321=end table
2047 2322
2048=head1 CONFIGURE OPTIONS 2323=head1 CONFIGURE OPTIONS
2049 2324
2050General hint: if you get compile errors, then likely your configuration 2325General hint: if you get compile errors, then likely your configuration
2051hasn't been tested well. Either try with --enable-everything or use the 2326hasn't been tested well. Either try with C<--enable-everything> or use
2052./reconf script as a base for experiments. ./reconf is used by myself, 2327the F<./reconf> script as a base for experiments. F<./reconf> is used by
2053so it should generally be a working config. Of course, you should always 2328myself, so it should generally be a working config. Of course, you should
2054report when a combination doesn't work, so it can be fixed. Marc Lehmann 2329always report when a combination doesn't work, so it can be fixed. Marc
2055<rxvt@schmorp.de>. 2330Lehmann <rxvt@schmorp.de>.
2331
2332All
2056 2333
2057=over 4 2334=over 4
2058 2335
2059=item --enable-everything 2336=item --enable-everything
2060 2337
2061Add support for all non-multichoice options listed in "./configure 2338Add (or remove) support for all non-multichoice options listed in "./configure
2062--help". Note that unlike other enable options this is order dependant. 2339--help".
2340
2063You can specify this and then disable options which this enables by 2341You can specify this and then disable options you do not like by
2064I<following> this with the appropriate commands. 2342I<following> this with the appropriate C<--disable-...> arguments,
2343or you can start with a minimal configuration by specifying
2344C<--disable-everything> and than adding just the C<--enable-...> arguments
2345you want.
2065 2346
2066=item --enable-xft 2347=item --enable-xft (default: enabled)
2067 2348
2068Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2349Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2069slower and require lots of memory, but as long as you don't use them, you 2350slower and require lots of memory, but as long as you don't use them, you
2070don't pay for them. 2351don't pay for them.
2071 2352
2072=item --enable-font-styles 2353=item --enable-font-styles (default: on)
2073 2354
2074Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2355Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2075styles. The fonts can be set manually or automatically. 2356styles. The fonts can be set manually or automatically.
2076 2357
2077=item --with-codesets=NAME,... 2358=item --with-codesets=NAME,... (default: all)
2078 2359
2079Compile in support for additional codeset (encoding) groups (eu, vn are 2360Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2080always compiled in, which includes most 8-bit character sets). These 2361are always compiled in, which includes most 8-bit character sets). These
2081codeset tables are currently only used for driving X11 core fonts, they 2362codeset tables are used for driving X11 core fonts, they are not required
2082are not required for Xft fonts. Compiling them in will make your binary 2363for Xft fonts, although having them compiled in lets rxvt-unicode choose
2083bigger (together about 700kB), but it doesn't increase memory usage unless 2364replacement fonts more intelligently. Compiling them in will make your
2365binary bigger (all of together cost about 700kB), but it doesn't increase
2084you use an X11 font requiring one of these encodings. 2366memory usage unless you use a font requiring one of these encodings.
2085 2367
2086=begin table 2368=begin table
2087 2369
2088 all all available codeset groups 2370 all all available codeset groups
2089 zh common chinese encodings 2371 zh common chinese encodings
2092 jp_ext rarely used but big japanese encodings 2374 jp_ext rarely used but big japanese encodings
2093 kr korean encodings 2375 kr korean encodings
2094 2376
2095=end table 2377=end table
2096 2378
2097=item --enable-xim 2379=item --enable-xim (default: on)
2098 2380
2099Add support for XIM (X Input Method) protocol. This allows using 2381Add support for XIM (X Input Method) protocol. This allows using
2100alternative input methods (e.g. kinput2) and will also correctly 2382alternative input methods (e.g. kinput2) and will also correctly
2101set up the input for people using dead keys or compose keys. 2383set up the input for people using dead keys or compose keys.
2102 2384
2103=item --enable-unicode3 2385=item --enable-unicode3 (default: off)
2104 2386
2105Enable direct support for displaying unicode codepoints above 2387Enable direct support for displaying unicode codepoints above
210665535 (the basic multilingual page). This increases storage 238865535 (the basic multilingual page). This increases storage
2107requirements per character from 2 to 4 bytes. X11 fonts do not yet 2389requirements per character from 2 to 4 bytes. X11 fonts do not yet
2108support these extra characters, but Xft does. 2390support these extra characters, but Xft does.
2111even without this flag, but the number of such characters is 2393even without this flag, but the number of such characters is
2112limited to a view thousand (shared with combining characters, 2394limited to a view thousand (shared with combining characters,
2113see next switch), and right now rxvt-unicode cannot display them 2395see next switch), and right now rxvt-unicode cannot display them
2114(input/output and cut&paste still work, though). 2396(input/output and cut&paste still work, though).
2115 2397
2116=item --enable-combining 2398=item --enable-combining (default: on)
2117 2399
2118Enable automatic composition of combining characters into 2400Enable automatic composition of combining characters into
2119composite characters. This is required for proper viewing of text 2401composite characters. This is required for proper viewing of text
2120where accents are encoded as seperate unicode characters. This is 2402where accents are encoded as seperate unicode characters. This is
2121done by using precomposited characters when available or creating 2403done by using precomposited characters when available or creating
2122new pseudo-characters when no precomposed form exists. 2404new pseudo-characters when no precomposed form exists.
2123 2405
2124Without --enable-unicode3, the number of additional precomposed 2406Without --enable-unicode3, the number of additional precomposed characters
2125characters is rather limited (2048, if this is full, rxvt will use the 2407is rather limited (2048, if this is full, rxvt-unicode will use the
2126private use area, extending the number of combinations to 8448). With 2408private use area, extending the number of combinations to 8448). With
2127--enable-unicode3, no practical limit exists. This will also enable 2409--enable-unicode3, no practical limit exists.
2128storage of characters >65535. 2410
2411This option will also enable storage (but not display) of characters
2412beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2129 2413
2130The combining table also contains entries for arabic presentation forms, 2414The combining table also contains entries for arabic presentation forms,
2131but these are not currently used. Bug me if you want these to be used. 2415but these are not currently used. Bug me if you want these to be used (and
2416tell me how these are to be used...).
2132 2417
2133=item --enable-fallback(=CLASS) 2418=item --enable-fallback(=CLASS) (default: Rxvt)
2134 2419
2135When reading resource settings, also read settings for class CLASS 2420When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2136(default: Rxvt). To disable resource fallback use --disable-fallback.
2137 2421
2138=item --with-res-name=NAME 2422=item --with-res-name=NAME (default: urxvt)
2139 2423
2140Use the given name (default: urxvt) as default application name when 2424Use the given name as default application name when
2141reading resources. Specify --with-res-name=rxvt to replace rxvt. 2425reading resources. Specify --with-res-name=rxvt to replace rxvt.
2142 2426
2143=item --with-res-class=CLASS 2427=item --with-res-class=CLASS /default: URxvt)
2144 2428
2145Use the given class (default: URxvt) as default application class 2429Use the given class as default application class
2146when reading resources. Specify --with-res-class=Rxvt to replace 2430when reading resources. Specify --with-res-class=Rxvt to replace
2147rxvt. 2431rxvt.
2148 2432
2149=item --enable-utmp 2433=item --enable-utmp (default: on)
2150 2434
2151Write user and tty to utmp file (used by programs like F<w>) at 2435Write user and tty to utmp file (used by programs like F<w>) at
2152start of rxvt execution and delete information when rxvt exits. 2436start of rxvt execution and delete information when rxvt exits.
2153 2437
2154=item --enable-wtmp 2438=item --enable-wtmp (default: on)
2155 2439
2156Write user and tty to wtmp file (used by programs like F<last>) at 2440Write user and tty to wtmp file (used by programs like F<last>) at
2157start of rxvt execution and write logout when rxvt exits. This 2441start of rxvt execution and write logout when rxvt exits. This
2158option requires --enable-utmp to also be specified. 2442option requires --enable-utmp to also be specified.
2159 2443
2160=item --enable-lastlog 2444=item --enable-lastlog (default: on)
2161 2445
2162Write user and tty to lastlog file (used by programs like 2446Write user and tty to lastlog file (used by programs like
2163F<lastlogin>) at start of rxvt execution. This option requires 2447F<lastlogin>) at start of rxvt execution. This option requires
2164--enable-utmp to also be specified. 2448--enable-utmp to also be specified.
2165 2449
2166=item --enable-xpm-background 2450=item --enable-xpm-background (default: on)
2167 2451
2168Add support for XPM background pixmaps. 2452Add support for XPM background pixmaps.
2169 2453
2170=item --enable-transparency 2454=item --enable-transparency (default: on)
2171 2455
2172Add support for inheriting parent backgrounds thus giving a fake 2456Add support for inheriting parent backgrounds thus giving a fake
2173transparency to the term. 2457transparency to the term.
2174 2458
2175=item --enable-fading 2459=item --enable-fading (default: on)
2176 2460
2177Add support for fading the text when focus is lost. 2461Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2178 2462
2179=item --enable-tinting 2463=item --enable-tinting (default: on)
2180 2464
2181Add support for tinting of transparent backgrounds. 2465Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2182 2466
2183=item --enable-menubar 2467=item --enable-menubar (default: off) [DEPRECATED]
2184 2468
2185Add support for our menu bar system (this interacts badly with 2469Add support for our menu bar system (this interacts badly with dynamic
2186dynamic locale switching currently). 2470locale switching currently). This option is DEPRECATED and will be removed
2471in the future.
2187 2472
2188=item --enable-rxvt-scroll 2473=item --enable-rxvt-scroll (default: on)
2189 2474
2190Add support for the original rxvt scrollbar. 2475Add support for the original rxvt scrollbar.
2191 2476
2192=item --enable-next-scroll 2477=item --enable-next-scroll (default: on)
2193 2478
2194Add support for a NeXT-like scrollbar. 2479Add support for a NeXT-like scrollbar.
2195 2480
2196=item --enable-xterm-scroll 2481=item --enable-xterm-scroll (default: on)
2197 2482
2198Add support for an Xterm-like scrollbar. 2483Add support for an Xterm-like scrollbar.
2199 2484
2200=item --enable-plain-scroll 2485=item --enable-plain-scroll (default: on)
2201 2486
2202Add support for a very unobtrusive, plain-looking scrollbar that 2487Add support for a very unobtrusive, plain-looking scrollbar that
2203is the favourite of the rxvt-unicode author, having used it for 2488is the favourite of the rxvt-unicode author, having used it for
2204many years. 2489many years.
2205 2490
2206=item --enable-half-shadow 2491=item --enable-half-shadow (default: off)
2207 2492
2208Make shadows on the scrollbar only half the normal width & height. 2493Make shadows on the scrollbar only half the normal width & height.
2209only applicable to rxvt scrollbars. 2494only applicable to rxvt scrollbars.
2210 2495
2211=item --enable-ttygid 2496=item --enable-ttygid (default: off)
2212 2497
2213Change tty device setting to group "tty" - only use this if 2498Change tty device setting to group "tty" - only use this if
2214your system uses this type of security. 2499your system uses this type of security.
2215 2500
2216=item --disable-backspace-key 2501=item --disable-backspace-key
2217 2502
2218Disable any handling of the backspace key by us - let the X server 2503Removes any handling of the backspace key by us - let the X server do it.
2504
2505=item --disable-delete-key
2506
2507Removes any handling of the delete key by us - let the X server
2219do it. 2508do it.
2220 2509
2221=item --disable-delete-key
2222
2223Disable any handling of the delete key by us - let the X server
2224do it.
2225
2226=item --disable-resources 2510=item --disable-resources
2227 2511
2228Remove all resources checking. 2512Removes any support for resource checking.
2229 2513
2230=item --enable-xgetdefault 2514=item --enable-xgetdefault
2231 2515
2232Make resources checking via XGetDefault() instead of our small 2516Make resources checking via XGetDefault() instead of our small
2233version which only checks ~/.Xdefaults, or if that doesn't exist 2517version which only checks ~/.Xdefaults, or if that doesn't exist then
2234then ~/.Xresources. 2518~/.Xresources.
2235 2519
2236=item --enable-strings 2520Please note that nowadays, things like XIM will automatically pull in and
2521use the full X resource manager, so the overhead of using it might be very
2522small, if nonexistant.
2523
2524=item --enable-strings (default: off)
2237 2525
2238Add support for our possibly faster memset() function and other 2526Add support for our possibly faster memset() function and other
2239various routines, overriding your system's versions which may 2527various routines, overriding your system's versions which may
2240have been hand-crafted in assembly or may require extra libraries 2528have been hand-crafted in assembly or may require extra libraries
2241to link in. (this breaks ANSI-C rules and has problems on many 2529to link in. (this breaks ANSI-C rules and has problems on many
2242GNU/Linux systems). 2530GNU/Linux systems).
2243 2531
2244=item --disable-swapscreen 2532=item --disable-swapscreen
2245 2533
2246Remove support for swap screen. 2534Remove support for secondary/swap screen.
2247 2535
2248=item --enable-frills 2536=item --enable-frills (default: on)
2249 2537
2250Add support for many small features that are not essential but nice to 2538Add support for many small features that are not essential but nice to
2251have. Normally you want this, but for very small binaries you may want to 2539have. Normally you want this, but for very small binaries you may want to
2252disable this. 2540disable this.
2253 2541
2542A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2543in combination with other switches) is:
2544
2545 MWM-hints
2546 EWMH-hints (pid, utf8 names) and protocols (ping)
2547 seperate underline colour (-underlineColor)
2548 settable border widths and borderless switch (-w, -b, -bl)
2549 settable extra linespacing /-lsp)
2550 iso-14755-2 and -3, and visual feedback
2551 backindex and forwardindex escape sequence
2552 window op and some xterm/OSC escape sequences
2553 tripleclickwords (-tcw)
2554 settable insecure mode (-insecure)
2555 keysym remapping support
2556 cursor blinking and underline cursor (-cb, -uc)
2557 XEmbed support (-embed)
2558 user-pty (-pty-fd)
2559 hold on exit (-hold)
2560 skip builtin block graphics (-sbg)
2561 sgr modes 90..97 and 100..107
2562
2254=item --enable-iso14755 2563=item --enable-iso14755 (default: on)
2255 2564
2256Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2565Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2257F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2566F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2258C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2567C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2259this switch. 2568this switch.
2260 2569
2261=item --enable-linespace
2262
2263Add support to provide user specified line spacing between text rows.
2264
2265=item --enable-keepscrolling 2570=item --enable-keepscrolling (default: on)
2266 2571
2267Add support for continual scrolling of the display when you hold 2572Add support for continual scrolling of the display when you hold
2268the mouse button down on a scrollbar arrow. 2573the mouse button down on a scrollbar arrow.
2269 2574
2270=item --enable-mousewheel 2575=item --enable-mousewheel (default: on)
2271 2576
2272Add support for scrolling via mouse wheel or buttons 4 & 5. 2577Add support for scrolling via mouse wheel or buttons 4 & 5.
2273 2578
2274=item --enable-slipwheeling 2579=item --enable-slipwheeling (default: on)
2275 2580
2276Add support for continual scrolling (using the mouse wheel as an 2581Add support for continual scrolling (using the mouse wheel as an
2277accelerator) while the control key is held down. This option 2582accelerator) while the control key is held down. This option
2278requires --enable-mousewheel to also be specified. 2583requires --enable-mousewheel to also be specified.
2279 2584
2280=item --disable-new-selection 2585=item --disable-new-selection
2281 2586
2282Remove support for mouse selection style like that of xterm. 2587Remove support for mouse selection style like that of xterm.
2283 2588
2284=item --enable-dmalloc 2589=item --enable-dmalloc (default: off)
2285 2590
2286Use Gray Watson's malloc - which is good for debugging See 2591Use Gray Watson's malloc - which is good for debugging See
2287http://www.letters.com/dmalloc/ for details If you use either this or the 2592http://www.letters.com/dmalloc/ for details If you use either this or the
2288next option, you may need to edit src/Makefile after compiling to point 2593next option, you may need to edit src/Makefile after compiling to point
2289DINCLUDE and DLIB to the right places. 2594DINCLUDE and DLIB to the right places.
2290 2595
2291You can only use either this option and the following (should 2596You can only use either this option and the following (should
2292you use either) . 2597you use either) .
2293 2598
2294=item --enable-dlmalloc 2599=item --enable-dlmalloc (default: off)
2295 2600
2296Use Doug Lea's malloc - which is good for a production version 2601Use Doug Lea's malloc - which is good for a production version
2297See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2602See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2298 2603
2299=item --enable-smart-resize 2604=item --enable-smart-resize (default: on)
2300 2605
2301Add smart growth/shrink behaviour when changing font size via from hot 2606Add smart growth/shrink behaviour when changing font size via hot
2302keys. This should keep in a fixed position the rxvt corner which is 2607keys. This should keep the window corner which is closest to a corner of
2303closest to a corner of the screen. 2608the screen in a fixed position.
2304 2609
2305=item --enable-cursor-blink
2306
2307Add support for a blinking cursor.
2308
2309=item --enable-pointer-blank 2610=item --enable-pointer-blank (default: on)
2310 2611
2311Add support to have the pointer disappear when typing or inactive. 2612Add support to have the pointer disappear when typing or inactive.
2312 2613
2313=item --with-name=NAME 2614=item --enable-perl (default: off)
2314 2615
2616Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2617manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2618in F<src/perl-ext/> for the extensions that are installed by default. The
2619perl interpreter that is used can be specified via the C<PERL> environment
2620variable when running configure.
2621
2622=item --with-name=NAME (default: urxvt)
2623
2315Set the basename for the installed binaries (default: urxvt, resulting in 2624Set the basename for the installed binaries, resulting
2316urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2625in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2626C<rxvt>.
2317 2627
2318=item --with-term=NAME 2628=item --with-term=NAME (default: rxvt-unicode)
2319 2629
2320Change the environmental variable for the terminal to NAME (default 2630Change the environmental variable for the terminal to NAME.
2321"rxvt")
2322 2631
2323=item --with-terminfo=PATH 2632=item --with-terminfo=PATH
2324 2633
2325Change the environmental variable for the path to the terminfo tree to 2634Change the environmental variable for the path to the terminfo tree to
2326PATH. 2635PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines