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.25 by root, Mon Sep 6 06:20:40 2004 UTC vs.
Revision 1.64 by root, Sat Dec 24 12:55:17 2005 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 aminute 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.
13 136
14=item When I log-in to another system it tells me about missing terminfo data? 137=item When I log-in to another system it tells me about missing terminfo data?
15 138
16The terminal description used by rxvt-unicode is not as widely available 139The 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). 140as 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 151C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different 152problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice 153colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though. 154quick-and-dirty workaround for rare cases, though.
32 155
33If you always want to do this you can either recompile rxvt-unicode with 156If you always want to do this (and are fine with the consequences) you
34the desired TERM value or use a resource to set it: 157can either recompile rxvt-unicode with the desired TERM value or use a
158resource to set it:
35 159
36 URxvt.termName: rxvt 160 URxvt.termName: rxvt
37 161
38If you don't plan to use B<rxvt> (quite common...) you could also replace 162If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one. 163the rxvt terminfo file with the rxvt-unicode one.
40 164
165=item C<tic> outputs some error when compiling the terminfo entry.
166
167Most likely it's the empty definition for C<enacs=>. Just replace it by
168C<enacs=\E[0@> and try again.
169
170=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
171
41=item I need a termcap file entry. 172=item I need a termcap file entry.
173
174One reason you might want this is that some distributions or operating
175systems still compile some programs using the long-obsoleted termcap
176library (Fedora Core's bash is one example) and rely on a termcap entry
177for C<rxvt-unicode>.
42 178
43You could use rxvt's termcap entry with resonable results in many cases. 179You 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 180You can also create a termcap entry by using terminfo's infocmp program
45like this: 181like this:
46 182
47 infocmp -C rxvt-unicode 183 infocmp -C rxvt-unicode
48 184
49OR you could this termcap entry: 185Or you could use this termcap entry, generated by the command above:
50 186
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 187 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\ 188 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\ 189 :co#80:it#8:li#24:lm#0:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 190 :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:\ 191 :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:\ 192 :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:\ 193 :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:\ 194 :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[@:\ 195 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
196 :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:\ 197 :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~:\ 198 :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~:\ 199 :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:\ 200 :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=:\ 201 :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:\ 202 :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:\ 203 :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:\ 204 :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:\ 205 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h: 206 :vs=\E[?25h:
70 207
71=item How can I configure rxvt-unicode so that it looks similar to the original rxvt? 208=item Why does C<ls> no longer have coloured output?
72 209
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode 210The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
74behave similar to the original rxvt: 211decide wether a terminal has colour, but uses it's own configuration
212file. Needless to say, C<rxvt-unicode> is not in it's default file (among
213with most other terminals supporting colour). Either add:
75 214
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 215 TERM rxvt-unicode
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1 216
217to C</etc/DIR_COLORS> or simply add:
218
219 alias ls='ls --color=auto'
220
221to your C<.profile> or C<.bashrc>.
222
223=item Why doesn't vim/emacs etc. use the 88 colour mode?
224
225=item Why doesn't vim/emacs etc. make use of italic?
226
227=item Why are the secondary screen-related options not working properly?
228
229Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
230distributions (most notably Debian GNU/Linux) break rxvt-unicode
231by setting C<TERM> to C<rxvt>, which doesn't have these extra
232features. Unfortunately, some of these (most notably, again, Debian
233GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
234file, so you will need to install it on your own (See the question B<When
235I log-in to another system it tells me about missing terminfo data?> on
236how to do this).
237
238=item My numerical keypad acts weird and generates differing output?
239
240Some Debian GNUL/Linux users seem to have this problem, although no
241specific details were reported so far. It is possible that this is caused
242by the wrong C<TERM> setting, although the details of wether and how
243this can happen are unknown, as C<TERM=rxvt> should offer a compatible
244keymap. See the answer to the previous question, and please report if that
245helped.
78 246
79=item Rxvt-unicode does not seem to understand the selected encoding? 247=item Rxvt-unicode does not seem to understand the selected encoding?
80 248
81=item Unicode does not seem to work? 249=item Unicode does not seem to work?
82 250
85subtly garbled, then you should check your locale settings. 253subtly garbled, then you should check your locale settings.
86 254
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 255Rxvt-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 256programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to 257login 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. 258something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91 259
92The best thing is to fix your startup environment, as you will likely run 260The 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. 261into other problems. If nothing works you can try this in your .profile.
94 262
95 printf '\e]701;%s\007' "$LC_CTYPE" 263 printf '\e]701;%s\007' "$LC_CTYPE"
96 264
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 265If 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 266supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like: 267displays this (also, C<perl -e0> can be used to check locale settings, as
268it will complain loudly if it cannot set the locale). If it displays something
269like:
100 270
101 locale: Cannot set LC_CTYPE to default locale: ... 271 locale: Cannot set LC_CTYPE to default locale: ...
102 272
103Then the locale you specified is not supported on your system. 273Then the locale you specified is not supported on your system.
104 274
115your system/os) have specified does not cover all the characters you want 285your system/os) have specified does not cover all the characters you want
116to display. 286to display.
117 287
118B<rxvt-unicode> makes a best-effort try at finding a replacement 288B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks 289font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the 290bad/ugly/wrong. Some fonts have totally strange characters that don't
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence 291resemble 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 292intelligence to detect that a specific glyph is wrong: it has to believe
123the characters it contains indeed look correct. 293the font that the characters it claims to contain indeed look correct.
124 294
125In that case, select a font of your taste and add it to the font list, 295In that case, select a font of your taste and add it to the font list,
126e.g.: 296e.g.:
127 297
128 @@RXVT_NAME@@ -fn basefont,font2,font3... 298 @@RXVT_NAME@@ -fn basefont,font2,font3...
130When rxvt-unicode sees a character, it will first look at the base 300When 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 301font. 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 302next 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. 303search and use less resources within rxvt-unicode and the X-server.
134 304
135The only limitation is that all the fonts must not be larger than the base 305The 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 306font, as the base font defines the terminal character cell size, which
137same due to the way terminals work. 307must be the same due to the way terminals work.
138 308
139=item Why do some chinese characters look so different than others? 309=item Why do some chinese characters look so different than others?
140 310
141This is because there is a difference between script and language -- 311This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output 312rxvt-unicode does not know which language the text that is output is,
143is, as it only knows the unicode character codes. If rxvt-unicode 313as it only knows the unicode character codes. If rxvt-unicode first
144first sees a japanese character, it might choose a japanese font for 314sees a japanese/chinese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese 315display. Subsequent japanese characters will use that font. Now, many
146characters aren't represented in japanese fonts, so when the first 316chinese characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font 317non-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 318-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese. 319chinese characters that are also in the japanese font.
150 320
151The workaround is easy: just tag a chinese font at the end of your font 321The 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 322list (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 323a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first. 324first. If you expect more chinese, put a chinese font first.
155 325
156In the future it might be possible to switch preferences at runtime (the 326In the future it might be possible to switch language preferences at
157internal data structure has no problem with using different fonts for 327runtime (the internal data structure has no problem with using different
158the same character at the same time, but no interface for this has been 328fonts for the same character at the same time, but no interface for this
159designed yet). 329has been designed yet).
330
331Until then, you might get away with switching fonts at runtime (see L<Can
332I switch the fonts at runtime?> later in this document).
160 333
161=item Why does rxvt-unicode sometimes leave pixel droppings? 334=item Why does rxvt-unicode sometimes leave pixel droppings?
162 335
163Most fonts were not designed for terminal use, which means that character 336Most 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 337size varies a lot. A font that is otherwise fine for terminal use might
170however: Xft fonts often draw glyphs larger than their acclaimed bounding 343however: 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 344box, 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 345ask for the character bounding box, which unfortunately is wrong in these
173cases). 346cases).
174 347
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or 348It'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 349or the respective font. If you encounter this problem you might try using
177around this except by using a different font. 350the C<-lsp> option to give the font more height. If that doesn't work, you
351might be forced to use a different font.
178 352
179All of this is not a problem when using X11 core fonts, as their bounding 353All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct. 354box data is correct.
355
356=item On Solaris 9, many line-drawing characters are too wide.
357
358Seems to be a known bug, read
359L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
360following ugly workaround to get non-double-wide-characters working:
361
362 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
181 363
182=item My Compose (Multi_key) key is no longer working. 364=item My Compose (Multi_key) key is no longer working.
183 365
184The most common causes for this are that either your locale is not set 366The 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 367correctly, or you specified a B<preeditStyle> that is not supported by
189rxvt-unicode will continue without an input method. 371rxvt-unicode will continue without an input method.
190 372
191In this case either do not specify a B<preeditStyle> or specify more than 373In this case either do not specify a B<preeditStyle> or specify more than
192one pre-edit style, such as B<OverTheSpot,Root,None>. 374one pre-edit style, such as B<OverTheSpot,Root,None>.
193 375
376=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
377
378Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
379international keyboards) or simply use ISO 14755 support to your
380advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
381codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
382character and so on.
383
194=item How can I keep rxvt-unicode from using reverse video so much? 384=item How can I keep rxvt-unicode from using reverse video so much?
195 385
196First of all, make sure you are running with the right terminfo 386First 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 387(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 388make sure you have specified colours for italic and bold, as otherwise
199might use reverse video to simulate the effect: 389rxvt-unicode might use reverse video to simulate the effect:
200 390
201 URxvt*colorBD: white 391 URxvt.colorBD: white
202 URxvt*colorIT: green 392 URxvt.colorIT: green
203 393
204=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 394=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
205 395
206For some unexplainable reason, some programs (i.e. irssi) assume a very 396For some unexplainable reason, some rare programs assume a very weird
207weird colour palette when confronted with a terminal with more than the 397colour palette when confronted with a terminal with more than the standard
208standard 8 colours (rxvt-unicode supports 88). The right fix is, of 3988 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 399these programs not to assume non-ISO colours without very good reasons.
210good reasons.
211 400
212In the meantime, you can either edit your C<urxvt> terminfo definition to 401In 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 402definition to only claim 8 colour support or use C<TERM=rxvt>, which will
214but keep you from using other rxvt-unicode features. 403fix colours but keep you from using other rxvt-unicode features.
215 404
216=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 405=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
217 406
218Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 407Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219in your compile environment, or an implementation that implements it, 408in your compile environment, or an implementation that implements it,
220wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 409wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221B<wchar_t> is represented as unicode. 410B<wchar_t> is represented as unicode.
222 411
223As you might have guessed, FreeBSD does neither define this symobl nor 412As you might have guessed, FreeBSD does neither define this symobl nor
224does it support it. Instead, it uses it's own internal representation of 413does it support it. Instead, it uses it's own internal representation of
225B<wchar_t>. This is, of course, completely legal. 414B<wchar_t>. This is, of course, completely fine with respect to standards.
226 415
416However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
417C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
418
227However, C<__STDC_ISO_10646__> is the only sane way to support 419C<__STDC_ISO_10646__> is the only sane way to support multi-language
228multi-language apps in an OS, as using a locale-dependent (and 420apps in an OS, as using a locale-dependent (and non-standardized)
229non-standardized) representation of B<wchar_t> makes it impossible to 421representation of B<wchar_t> makes it impossible to convert between
230convert between B<wchar_t> (as used by X11 and your applications) and any 422B<wchar_t> (as used by X11 and your applications) and any other encoding
231other encoding without implementing OS-specific-wrappers for each and 423without implementing OS-specific-wrappers for each and every locale. There
232every locale. There simply are no APIs to convert B<wchar_t> into anything 424simply are no APIs to convert B<wchar_t> into anything except the current
233except the current locale encoding. 425locale encoding.
234 426
235Some applications (such as the formidable B<mlterm>) work around this 427Some applications (such as the formidable B<mlterm>) work around this
236by carrying their own replacement functions for character set handling 428by carrying their own replacement functions for character set handling
237with them, and either implementing OS-dependent hacks or doing multiple 429with them, and either implementing OS-dependent hacks or doing multiple
238conversions (which is slow and unreliable in case the OS implements 430conversions (which is slow and unreliable in case the OS implements
239encodings slightly different than the terminal emulator). 431encodings slightly different than the terminal emulator).
240 432
241The rxvt-unicode author insists that the right way to fix this is in the 433The 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 434system libraries once and for all, instead of forcing every app to carry
243complete replacements. 435complete replacements for them :)
436
437=item I use Solaris 9 and it doesn't compile/work/etc.
438
439Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
440problems with C<wcwidth> and a compile problem.
441
442=item How can I use rxvt-unicode under cygwin?
443
444rxvt-unicode should compile and run out of the box on cygwin, using
445the X11 libraries that come with cygwin. libW11 emulation is no
446longer supported (and makes no sense, either, as it only supported a
447single font). I recommend starting the X-server in C<-multiwindow> or
448C<-rootless> mode instead, which will result in similar look&feel as the
449old libW11 emulation.
450
451At the time of this writing, cygwin didn't seem to support any multi-byte
452encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
453to 8-bit encodings.
244 454
245=item How does rxvt-unicode determine the encoding to use? 455=item How does rxvt-unicode determine the encoding to use?
246 456
247=item Is there an option to switch encodings? 457=item Is there an option to switch encodings?
248 458
250specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 460specific "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. 461UTF-8 or any other encodings with respect to terminal I/O.
252 462
253The reasons is that there exists a perfectly fine mechanism for selecting 463The reasons is that there exists a perfectly fine mechanism for selecting
254the encoding, doing I/O and (most important) communicating this to all 464the encoding, doing I/O and (most important) communicating this to all
255applications so everybody agrees on character properties such as width and 465applications so everybody agrees on character properties such as width
256code number. This mechanism is the I<locale>. 466and code number. This mechanism is the I<locale>. Applications not using
467that info will have problems (for example, C<xterm> gets the width of
468characters wrong as it uses it's own, locale-independent table under all
469locales).
257 470
258Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 471Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259programs doing the same (that is, most) will automatically agree in the 472programs doing the same (that is, most) will automatically agree in the
260interpretation of characters. 473interpretation of characters.
261 474
268C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms 481C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269(i.e. C<de> or C<german>) are also common. 482(i.e. C<de> or C<german>) are also common.
270 483
271Rxvt-unicode ignores all other locale categories, and except for 484Rxvt-unicode ignores all other locale categories, and except for
272the encoding, ignores country or language-specific settings, 485the 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. 486i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
487rxvt-unicode.
274 488
275If you want to use a specific encoding you have to make sure you start 489If you want to use a specific encoding you have to make sure you start
276rxvt-unicode with the correct C<LC_CTYPE> category. 490rxvt-unicode with the correct C<LC_CTYPE> category.
277 491
278=item Can I switch locales at runtime? 492=item Can I switch locales at runtime?
279 493
280Yes, using an escape sequence. Try sth. like this, which sets 494Yes, using an escape sequence. Try something like this, which sets
281rxvt-unicode's idea of C<LC_CTYPE>. 495rxvt-unicode's idea of C<LC_CTYPE>.
282 496
283 printf '\e]701;%s\007' ja_JP.SJIS 497 printf '\e]701;%s\007' ja_JP.SJIS
284 498
285See also the previous question. 499See also the previous answer.
286 500
287Sometimes this capability is rather handy when you want to work in one 501Sometimes 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 502one 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 503(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
290locale supported by xjdic and back later: 504first switches to a locale supported by xjdic and back later:
291 505
292 printf '\e]701;%s\007' ja_JP.SJIS 506 printf '\e]701;%s\007' ja_JP.SJIS
293 xjdic -js 507 xjdic -js
294 printf '\e]701;%s\007' de_DE.UTF-8 508 printf '\e]701;%s\007' de_DE.UTF-8
295 509
510You can also use xterm's C<luit> program, which usually works fine, except
511for some locales where character width differs between program- and
512rxvt-unicode-locales.
513
296=item Can I switch the fonts at runtime? 514=item Can I switch the fonts at runtime?
297 515
298Yes, using an escape sequence. Try sth. like this, which has the same 516Yes, using an escape sequence. Try something like this, which has the same
299effect as using the C<-fn> switch, and takes effect immediately: 517effect as using the C<-fn> switch, and takes effect immediately:
300 518
301 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 519 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
302 520
303This is useful if you e.g. work primarily with japanese (and prefer a 521This is useful if you e.g. work primarily with japanese (and prefer a
308 526
309=item Why do italic characters look as if clipped? 527=item Why do italic characters look as if clipped?
310 528
311Many fonts have difficulties with italic characters and hinting. For 529Many fonts have difficulties with italic characters and hinting. For
312example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 530example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313Mono> completely fails in it's italic face. A workaround is to enable 531Mono> completely fails in it's italic face. A workaround might be to
314freetype autohinting, i.e. like this: 532enable freetype autohinting, i.e. like this:
315 533
316 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 534 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 535 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
318 536
319=item My input method wants <some encoding> but I want UTF-8, what can I do? 537=item My input method wants <some encoding> but I want UTF-8, what can I do?
320 538
321You can specify separate locales for the input method and the rest of the 539You can specify separate locales for the input method and the rest of the
322terminal, using the resource C<imlocale>: 540terminal, using the resource C<imlocale>:
326Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 544Now 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 545use 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 546input characters outside C<EUC-JP> in a normal way then, as your input
329method limits you. 547method limits you.
330 548
549=item Rxvt-unicode crashes when the X Input Method changes or exits.
550
551Unfortunately, this is unavoidable, as the XIM protocol is racy by
552design. Applications can avoid some crashes at the expense of memory
553leaks, and Input Methods can avoid some crashes by careful ordering at
554exit time. B<kinput2> (and derived input methods) generally succeeds,
555while B<SCIM> (or similar input methods) fails. In the end, however,
556crashes cannot be completely avoided even if both sides cooperate.
557
558So the only workaround is not to kill your Input Method Servers.
559
331=item Rxvt-unicode uses gobs of memory, how can I reduce that? 560=item Rxvt-unicode uses gobs of memory, how can I reduce that?
332 561
333Rxvt-unicode tries to obey the rule of not charging you for sth. you 562Rxvt-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 563don'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, 564you 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 565when used. Compiling it out ensures that no Xft font will be loaded
337accidentally when rxvt-unicode tries to find a font for your characters. 566accidentally when rxvt-unicode tries to find a font for your characters.
338 567
345 574
346=item Can I speed up Xft rendering somehow? 575=item Can I speed up Xft rendering somehow?
347 576
348Yes, the most obvious way to speed it up is to avoid Xft entirely, as 577Yes, 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 578it is simply slow. If you still want Xft fonts you might try to disable
350antialiasing (by appending C<:antialiasing=false>), which saves lots of 579antialiasing (by appending C<:antialias=false>), which saves lots of
351memory and also speeds up rendering considerably. 580memory and also speeds up rendering considerably.
352 581
353=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 582=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
354 583
355Rxvt-unicode will use whatever you specify as a font. If it needs to 584Rxvt-unicode will use whatever you specify as a font. If it needs to
391resources (or as long-options). 620resources (or as long-options).
392 621
393Here are values that are supposed to resemble a VGA screen, 622Here are values that are supposed to resemble a VGA screen,
394including the murky brown that passes for low-intensity yellow: 623including the murky brown that passes for low-intensity yellow:
395 624
396 Rxvt*color0: #000000 625 URxvt.color0: #000000
397 Rxvt*color1: #A80000 626 URxvt.color1: #A80000
398 Rxvt*color2: #00A800 627 URxvt.color2: #00A800
399 Rxvt*color3: #A8A800 628 URxvt.color3: #A8A800
400 Rxvt*color4: #0000A8 629 URxvt.color4: #0000A8
401 Rxvt*color5: #A800A8 630 URxvt.color5: #A800A8
402 Rxvt*color6: #00A8A8 631 URxvt.color6: #00A8A8
403 Rxvt*color7: #A8A8A8 632 URxvt.color7: #A8A8A8
404 633
405 Rxvt*color8: #000054 634 URxvt.color8: #000054
406 Rxvt*color9: #FF0054 635 URxvt.color9: #FF0054
407 Rxvt*color10: #00FF54 636 URxvt.color10: #00FF54
408 Rxvt*color11: #FFFF54 637 URxvt.color11: #FFFF54
409 Rxvt*color12: #0000FF 638 URxvt.color12: #0000FF
410 Rxvt*color13: #FF00FF 639 URxvt.color13: #FF00FF
411 Rxvt*color14: #00FFFF 640 URxvt.color14: #00FFFF
412 Rxvt*color15: #FFFFFF 641 URxvt.color15: #FFFFFF
642
643And here is a more complete set of non-standard colors described (not by
644me) as "pretty girly".
645
646 URxvt.cursorColor: #dc74d1
647 URxvt.pointerColor: #dc74d1
648 URxvt.background: #0e0e0e
649 URxvt.foreground: #4ad5e1
650 URxvt.color0: #000000
651 URxvt.color8: #8b8f93
652 URxvt.color1: #dc74d1
653 URxvt.color9: #dc74d1
654 URxvt.color2: #0eb8c7
655 URxvt.color10: #0eb8c7
656 URxvt.color3: #dfe37e
657 URxvt.color11: #dfe37e
658 URxvt.color5: #9e88f0
659 URxvt.color13: #9e88f0
660 URxvt.color6: #73f7ff
661 URxvt.color14: #73f7ff
662 URxvt.color7: #e1dddd
663 URxvt.color15: #e1dddd
664
665=item How can I start @@RXVT_NAME@@d in a race-free way?
666
667Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
668display, create the listening socket and then fork.
413 669
414=item What's with the strange Backspace/Delete key behaviour? 670=item What's with the strange Backspace/Delete key behaviour?
415 671
416Assuming that the physical Backspace key corresponds to the 672Assuming that the physical Backspace key corresponds to the
417BackSpace keysym (not likely for Linux ... see the following 673BackSpace keysym (not likely for Linux ... see the following
436 692
437 # use Backspace = ^? 693 # use Backspace = ^?
438 $ stty erase ^? 694 $ stty erase ^?
439 $ @@RXVT_NAME@@ 695 $ @@RXVT_NAME@@
440 696
441Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 697Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
442 698
443For an existing rxvt-unicode: 699For an existing rxvt-unicode:
444 700
445 # use Backspace = ^H 701 # use Backspace = ^H
446 $ stty erase ^H 702 $ stty erase ^H
455properly reflects that. 711properly reflects that.
456 712
457The Delete key is a another casualty of the ill-defined Backspace problem. 713The Delete key is a another casualty of the ill-defined Backspace problem.
458To avoid confusion between the Backspace and Delete keys, the Delete 714To avoid confusion between the Backspace and Delete keys, the Delete
459key has been assigned an escape sequence to match the vt100 for Execute 715key has been assigned an escape sequence to match the vt100 for Execute
460(ESC[3~) and is in the supplied termcap/terminfo. 716(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
461 717
462Some other Backspace problems: 718Some other Backspace problems:
463 719
464some editors use termcap/terminfo, 720some editors use termcap/terminfo,
465some editors (vim I'm told) expect Backspace = ^H, 721some editors (vim I'm told) expect Backspace = ^H,
469 725
470=item I don't like the key-bindings. How do I change them? 726=item I don't like the key-bindings. How do I change them?
471 727
472There are some compile-time selections available via configure. Unless 728There are some compile-time selections available via configure. Unless
473you have run "configure" with the C<--disable-resources> option you can 729you have run "configure" with the C<--disable-resources> option you can
474use the `keysym' resource to alter the keystrings associated with keysym 730use the `keysym' resource to alter the keystrings associated with keysyms.
4750xFF00 - 0xFFFF (function, cursor keys, etc).
476 731
477Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' 732Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
478 733
479 !# ----- special uses ------: 734 URxvt.keysym.Home: \033[1~
480 ! tn3270 login, remap function and arrow keys. 735 URxvt.keysym.End: \033[4~
481 tn3270*font: *clean-bold-*-*--15-* 736 URxvt.keysym.C-apostrophe: \033<C-'>
737 URxvt.keysym.C-slash: \033<C-/>
738 URxvt.keysym.C-semicolon: \033<C-;>
739 URxvt.keysym.C-grave: \033<C-`>
740 URxvt.keysym.C-comma: \033<C-,>
741 URxvt.keysym.C-period: \033<C-.>
742 URxvt.keysym.C-0x60: \033<C-`>
743 URxvt.keysym.C-Tab: \033<C-Tab>
744 URxvt.keysym.C-Return: \033<C-Return>
745 URxvt.keysym.S-Return: \033<S-Return>
746 URxvt.keysym.S-space: \033<S-Space>
747 URxvt.keysym.M-Up: \033<M-Up>
748 URxvt.keysym.M-Down: \033<M-Down>
749 URxvt.keysym.M-Left: \033<M-Left>
750 URxvt.keysym.M-Right: \033<M-Right>
751 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
752 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
753 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
482 754
483 ! keysym - used by rxvt only 755See some more examples in the documentation for the B<keysym> resource.
484 ! Delete - ^D
485 tn3270*keysym.0xFFFF: \004
486
487 ! Home - ^A
488 tn3270*keysym.0xFF50: \001
489 ! Left - ^B
490 tn3270*keysym.0xFF51: \002
491 ! Up - ^P
492 tn3270*keysym.0xFF52: \020
493 ! Right - ^F
494 tn3270*keysym.0xFF53: \006
495 ! Down - ^N
496 tn3270*keysym.0xFF54: \016
497 ! End - ^E
498 tn3270*keysym.0xFF57: \005
499
500 ! F1 - F12
501 tn3270*keysym.0xFFBE: \e1
502 tn3270*keysym.0xFFBF: \e2
503 tn3270*keysym.0xFFC0: \e3
504 tn3270*keysym.0xFFC1: \e4
505 tn3270*keysym.0xFFC2: \e5
506 tn3270*keysym.0xFFC3: \e6
507 tn3270*keysym.0xFFC4: \e7
508 tn3270*keysym.0xFFC5: \e8
509 tn3270*keysym.0xFFC6: \e9
510 tn3270*keysym.0xFFC7: \e0
511 tn3270*keysym.0xFFC8: \e-
512 tn3270*keysym.0xFFC9: \e=
513
514 ! map Prior/Next to F7/F8
515 tn3270*keysym.0xFF55: \e7
516 tn3270*keysym.0xFF56: \e8
517 756
518=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 757=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
519How do I make use of them? For example, the Sun Keyboard type 4 758How do I make use of them? For example, the Sun Keyboard type 4
520has the following mappings that rxvt-unicode doesn't recognize. 759has the following mappings that rxvt-unicode doesn't recognize.
521 760
524 F27 == Home 763 F27 == Home
525 F29 == Prior 764 F29 == Prior
526 F33 == End 765 F33 == End
527 F35 == Next 766 F35 == Next
528 767
529Rather than have rxvt-unicode try to accommodate all the various possible keyboard 768Rather than have rxvt-unicode try to accommodate all the various possible
530mappings, it is better to use `xmodmap' to remap the keys as required for 769keyboard mappings, it is better to use `xmodmap' to remap the keys as
531your particular machine. 770required for your particular machine.
532 771
533=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? 772=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
534I need this to decide about setting colors etc. 773I need this to decide about setting colors etc.
535 774
536rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 775rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
537check and see if that is set. Note that several programs, JED, slrn, 776check and see if that is set. Note that several programs, JED, slrn,
538Midnight Commander automatically check this variable to decide whether or 777Midnight Commander automatically check this variable to decide whether or
567 806
568You need to have a recent version of perl installed as F</usr/bin/perl>, 807You need to have a recent version of perl installed as F</usr/bin/perl>,
569one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 808one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
570the doc subdirectory and enter C<make alldoc>. 809the doc subdirectory and enter C<make alldoc>.
571 810
811=item My question isn't answered here, can I ask a human?
812
813Before sending me mail, you could go to IRC: C<irc.freenode.net>,
814channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
815interested in learning about new and exciting problems (but not FAQs :).
816
572=back 817=back
573 818
574=head1 SYNOPSIS 819=head1 RXVT TECHNICAL REFERENCE
575
576 # set a new font set
577 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
578
579 # change the locale and tell rxvt-unicode about it
580 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
581
582 # set window title
583 printf '\33]2;%s\007' "new window title"
584 820
585=head1 DESCRIPTION 821=head1 DESCRIPTION
586 822
587The rest of this document describes various technical aspects of 823The rest of this document describes various technical aspects of
588B<rxvt-unicode>. First the description of supported command sequences, 824B<rxvt-unicode>. First the description of supported command sequences,
589followed by menu and pixmap support and last by a description of all 825followed by menu and pixmap support and last by a description of all
590features selectable at C<configure> time. 826features selectable at C<configure> time.
591 827
592=head1 RXVT TECHNICAL REFERENCE
593
594=head1 Definitions 828=head1 Definitions
595 829
596=over 4 830=over 4
597 831
598=item B<< C<c> >> 832=item B<< C<c> >>
726Single Shift Select of G3 Character Set (SS3): affects next character 960Single Shift Select of G3 Character Set (SS3): affects next character
727only I<unimplemented> 961only I<unimplemented>
728 962
729=item B<< C<ESC Z> >> 963=item B<< C<ESC Z> >>
730 964
731Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 965Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
732 966
733=item B<< C<ESC c> >> 967=item B<< C<ESC c> >>
734 968
735Full reset (RIS) 969Full reset (RIS)
736 970
740 974
741=item B<< C<ESC o> >> 975=item B<< C<ESC o> >>
742 976
743Invoke the G3 Character Set (LS3) 977Invoke the G3 Character Set (LS3)
744 978
745=item B<< C<ESC> ( C> >> 979=item B<< C<ESC ( C> >>
746 980
747Designate G0 Character Set (ISO 2022), see below for values of C<C>. 981Designate G0 Character Set (ISO 2022), see below for values of C<C>.
748 982
749=item B<< C<ESC> ) C> >> 983=item B<< C<ESC ) C> >>
750 984
751Designate G1 Character Set (ISO 2022), see below for values of C<C>. 985Designate G1 Character Set (ISO 2022), see below for values of C<C>.
752 986
753=item B<< C<ESC * C> >> 987=item B<< C<ESC * C> >>
754 988
895 1129
896=item B<< C<ESC [ Ps c> >> 1130=item B<< C<ESC [ Ps c> >>
897 1131
898Send Device Attributes (DA) 1132Send Device Attributes (DA)
899B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1133B<< C<Ps = 0> >> (or omitted): request attributes from terminal
900returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1134returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
901Option'') 1135Option'')
902 1136
903=item B<< C<ESC [ Ps d> >> 1137=item B<< C<ESC [ Ps d> >>
904 1138
905Cursor to Line B<< C<Ps> >> (VPA) 1139Cursor to Line B<< C<Ps> >> (VPA)
1021 1255
1022=item B<< C<ESC [ s> >> 1256=item B<< C<ESC [ s> >>
1023 1257
1024Save Cursor (SC) 1258Save Cursor (SC)
1025 1259
1260=item B<< C<ESC [ Ps;Pt t> >>
1261
1262Window Operations
1263
1264=begin table
1265
1266 B<< C<Ps = 1> >> Deiconify (map) window
1267 B<< C<Ps = 2> >> Iconify window
1268 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1269 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1270 B<< C<Ps = 5> >> Raise window
1271 B<< C<Ps = 6> >> Lower window
1272 B<< C<Ps = 7> >> Refresh screen once
1273 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1274 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1275 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1276 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1277 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1278 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1279 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1280 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1281 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1282
1283=end table
1284
1285=item B<< C<ESC [ u> >>
1286
1287Restore Cursor
1288
1026=item B<< C<ESC [ Ps x> >> 1289=item B<< C<ESC [ Ps x> >>
1027 1290
1028Request Terminal Parameters (DECREQTPARM) 1291Request Terminal Parameters (DECREQTPARM)
1029
1030=item B<< C<ESC [ u> >>
1031
1032Restore Cursor
1033 1292
1034=back 1293=back
1035 1294
1036X<PrivateModes> 1295X<PrivateModes>
1037 1296
1332 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1591 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1333 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1592 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1334 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1593 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1335 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1594 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1336 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1595 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1337 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1596 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1338 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1597 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1339 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1598 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1340 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> >> 1599 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> >>
1341 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1600 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1342 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) 1601 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).
1343 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1602 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1344 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1603 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1345 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1604 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1346 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1605 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1347 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1606 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1348 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1607 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1349 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1608 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1609 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1610 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1350 1611
1351=end table 1612=end table
1352 1613
1353=back 1614=back
1354 1615
1406 1667
1407=item B<< [title:+I<string>] >> 1668=item B<< [title:+I<string>] >>
1408 1669
1409set the current menuBar's title to I<string>, which may contain the 1670set the current menuBar's title to I<string>, which may contain the
1410following format specifiers: 1671following format specifiers:
1411B<%%> : literal B<%> character 1672
1412B<%n> : rxvt name (as per the B<-name> command-line option) 1673 B<%n> rxvt name (as per the B<-name> command-line option)
1413B<%v> : rxvt version 1674 B<%v> rxvt version
1675 B<%%> literal B<%> character
1414 1676
1415=item B<[done]> 1677=item B<[done]>
1416 1678
1417set menuBar access as B<readonly>. 1679set menuBar access as B<readonly>.
1418End-of-file tag for B<< [read:+I<file>] >> operations. 1680End-of-file tag for B<< [read:+I<file>] >> operations.
1564 1826
1565As a convenience for the many Emacs-type editors, I<action> may start 1827As a convenience for the many Emacs-type editors, I<action> may start
1566with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1828with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1567appended if missed from B<M-x> commands. 1829appended if missed from B<M-x> commands.
1568 1830
1569As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1831As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1570quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1832quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1571 1833
1572=over 4 1834=over 4
1573 1835
1574=item For example, 1836=item For example,
2010=end table 2272=end table
2011 2273
2012=head1 CONFIGURE OPTIONS 2274=head1 CONFIGURE OPTIONS
2013 2275
2014General hint: if you get compile errors, then likely your configuration 2276General hint: if you get compile errors, then likely your configuration
2015hasn't been tested well. Either try with --enable-everything or use the 2277hasn't been tested well. Either try with C<--enable-everything> or use
2016./reconf script as a base for experiments. ./reconf is used by myself, 2278the F<./reconf> script as a base for experiments. F<./reconf> is used by
2017so it should generally be a working config. Of course, you should always 2279myself, so it should generally be a working config. Of course, you should
2018report when a combination doesn't work, so it can be fixed. Marc Lehmann 2280always report when a combination doesn't work, so it can be fixed. Marc
2019<rxvt@schmorp.de>. 2281Lehmann <rxvt@schmorp.de>.
2282
2283All
2020 2284
2021=over 4 2285=over 4
2022 2286
2023=item --enable-everything 2287=item --enable-everything
2024 2288
2025Add support for all non-multichoice options listed in "./configure 2289Add (or remove) support for all non-multichoice options listed in "./configure
2026--help". Note that unlike other enable options this is order dependant. 2290--help".
2291
2027You can specify this and then disable options which this enables by 2292You can specify this and then disable options you do not like by
2028I<following> this with the appropriate commands. 2293I<following> this with the appropriate C<--disable-...> arguments,
2294or you can start with a minimal configuration by specifying
2295C<--disable-everything> and than adding just the C<--enable-...> arguments
2296you want.
2029 2297
2030=item --enable-xft 2298=item --enable-xft (default: enabled)
2031 2299
2032Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2300Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2033slower and require lots of memory, but as long as you don't use them, you 2301slower and require lots of memory, but as long as you don't use them, you
2034don't pay for them. 2302don't pay for them.
2035 2303
2036=item --enable-font-styles 2304=item --enable-font-styles (default: on)
2037 2305
2038Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2306Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2039styles. The fonts can be set manually or automatically. 2307styles. The fonts can be set manually or automatically.
2040 2308
2041=item --with-codesets=NAME,... 2309=item --with-codesets=NAME,... (default: all)
2042 2310
2043Compile in support for additional codeset (encoding) groups (eu, vn are 2311Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2044always compiled in, which includes most 8-bit character sets). These 2312are always compiled in, which includes most 8-bit character sets). These
2045codeset tables are currently only used for driving X11 core fonts, they 2313codeset tables are used for driving X11 core fonts, they are not required
2046are not required for Xft fonts. Compiling them in will make your binary 2314for Xft fonts, although having them compiled in lets rxvt-unicode choose
2047bigger (together about 700kB), but it doesn't increase memory usage unless 2315replacement fonts more intelligently. Compiling them in will make your
2316binary bigger (all of together cost about 700kB), but it doesn't increase
2048you use an X11 font requiring one of these encodings. 2317memory usage unless you use a font requiring one of these encodings.
2049 2318
2050=begin table 2319=begin table
2051 2320
2052 all all available codeset groups 2321 all all available codeset groups
2053 cn common chinese encodings 2322 zh common chinese encodings
2054 cn_ext rarely used but very big chinese encodigs 2323 zh_ext rarely used but very big chinese encodigs
2055 jp common japanese encodings 2324 jp common japanese encodings
2056 jp_ext rarely used but big japanese encodings 2325 jp_ext rarely used but big japanese encodings
2057 kr korean encodings 2326 kr korean encodings
2058 2327
2059=end table 2328=end table
2060 2329
2061=item --enable-xim 2330=item --enable-xim (default: on)
2062 2331
2063Add support for XIM (X Input Method) protocol. This allows using 2332Add support for XIM (X Input Method) protocol. This allows using
2064alternative input methods (e.g. kinput2) and will also correctly 2333alternative input methods (e.g. kinput2) and will also correctly
2065set up the input for people using dead keys or compose keys. 2334set up the input for people using dead keys or compose keys.
2066 2335
2067=item --enable-unicode3 2336=item --enable-unicode3 (default: off)
2068 2337
2069Enable direct support for displaying unicode codepoints above 2338Enable direct support for displaying unicode codepoints above
207065535 (the basic multilingual page). This increases storage 233965535 (the basic multilingual page). This increases storage
2071requirements per character from 2 to 4 bytes. X11 fonts do not yet 2340requirements per character from 2 to 4 bytes. X11 fonts do not yet
2072support these extra characters, but Xft does. 2341support these extra characters, but Xft does.
2075even without this flag, but the number of such characters is 2344even without this flag, but the number of such characters is
2076limited to a view thousand (shared with combining characters, 2345limited to a view thousand (shared with combining characters,
2077see next switch), and right now rxvt-unicode cannot display them 2346see next switch), and right now rxvt-unicode cannot display them
2078(input/output and cut&paste still work, though). 2347(input/output and cut&paste still work, though).
2079 2348
2080=item --enable-combining 2349=item --enable-combining (default: on)
2081 2350
2082Enable automatic composition of combining characters into 2351Enable automatic composition of combining characters into
2083composite characters. This is required for proper viewing of text 2352composite characters. This is required for proper viewing of text
2084where accents are encoded as seperate unicode characters. This is 2353where accents are encoded as seperate unicode characters. This is
2085done by using precomposited characters when available or creating 2354done by using precomposited characters when available or creating
2086new pseudo-characters when no precomposed form exists. 2355new pseudo-characters when no precomposed form exists.
2087 2356
2088Without --enable-unicode3, the number of additional precomposed 2357Without --enable-unicode3, the number of additional precomposed characters
2089characters is rather limited (2048, if this is full, rxvt will use the 2358is rather limited (2048, if this is full, rxvt-unicode will use the
2090private use area, extending the number of combinations to 8448). With 2359private use area, extending the number of combinations to 8448). With
2091--enable-unicode3, no practical limit exists. This will also enable 2360--enable-unicode3, no practical limit exists.
2092storage of characters >65535. 2361
2362This option will also enable storage (but not display) of characters
2363beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2093 2364
2094The combining table also contains entries for arabic presentation forms, 2365The combining table also contains entries for arabic presentation forms,
2095but these are not currently used. Bug me if you want these to be used. 2366but these are not currently used. Bug me if you want these to be used (and
2367tell me how these are to be used...).
2096 2368
2097=item --enable-fallback(=CLASS) 2369=item --enable-fallback(=CLASS) (default: Rxvt)
2098 2370
2099When reading resource settings, also read settings for class CLASS 2371When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2100(default: Rxvt). To disable resource fallback use --disable-fallback.
2101 2372
2102=item --with-res-name=NAME 2373=item --with-res-name=NAME (default: urxvt)
2103 2374
2104Use the given name (default: urxvt) as default application name when 2375Use the given name as default application name when
2105reading resources. Specify --with-res-name=rxvt to replace rxvt. 2376reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106 2377
2107=item --with-res-class=CLASS 2378=item --with-res-class=CLASS /default: URxvt)
2108 2379
2109Use the given class (default: URxvt) as default application class 2380Use the given class as default application class
2110when reading resources. Specify --with-res-class=Rxvt to replace 2381when reading resources. Specify --with-res-class=Rxvt to replace
2111rxvt. 2382rxvt.
2112 2383
2113=item --enable-utmp 2384=item --enable-utmp (default: on)
2114 2385
2115Write user and tty to utmp file (used by programs like F<w>) at 2386Write user and tty to utmp file (used by programs like F<w>) at
2116start of rxvt execution and delete information when rxvt exits. 2387start of rxvt execution and delete information when rxvt exits.
2117 2388
2118=item --enable-wtmp 2389=item --enable-wtmp (default: on)
2119 2390
2120Write user and tty to wtmp file (used by programs like F<last>) at 2391Write user and tty to wtmp file (used by programs like F<last>) at
2121start of rxvt execution and write logout when rxvt exits. This 2392start of rxvt execution and write logout when rxvt exits. This
2122option requires --enable-utmp to also be specified. 2393option requires --enable-utmp to also be specified.
2123 2394
2124=item --enable-lastlog 2395=item --enable-lastlog (default: on)
2125 2396
2126Write user and tty to lastlog file (used by programs like 2397Write user and tty to lastlog file (used by programs like
2127F<lastlogin>) at start of rxvt execution. This option requires 2398F<lastlogin>) at start of rxvt execution. This option requires
2128--enable-utmp to also be specified. 2399--enable-utmp to also be specified.
2129 2400
2130=item --enable-xpm-background 2401=item --enable-xpm-background (default: off)
2131 2402
2132Add support for XPM background pixmaps. 2403Add support for XPM background pixmaps.
2133 2404
2134=item --enable-transparency 2405=item --enable-transparency (default: off)
2135 2406
2136Add support for inheriting parent backgrounds thus giving a fake 2407Add support for inheriting parent backgrounds thus giving a fake
2137transparency to the term. 2408transparency to the term.
2138 2409
2139=item --enable-fading 2410=item --enable-fading (default: on)
2140 2411
2141Add support for fading the text when focus is lost. 2412Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2142 2413
2143=item --enable-tinting 2414=item --enable-tinting (default: on)
2144 2415
2145Add support for tinting of transparent backgrounds. 2416Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2146 2417
2147=item --enable-menubar 2418=item --enable-menubar (default: off)
2148 2419
2149Add support for our menu bar system (this interacts badly with 2420Add support for our menu bar system (this interacts badly with
2150dynamic locale switching currently). 2421dynamic locale switching currently).
2151 2422
2152=item --enable-rxvt-scroll 2423=item --enable-rxvt-scroll (default: on)
2153 2424
2154Add support for the original rxvt scrollbar. 2425Add support for the original rxvt scrollbar.
2155 2426
2156=item --enable-next-scroll 2427=item --enable-next-scroll (default: on)
2157 2428
2158Add support for a NeXT-like scrollbar. 2429Add support for a NeXT-like scrollbar.
2159 2430
2160=item --enable-xterm-scroll 2431=item --enable-xterm-scroll (default: on)
2161 2432
2162Add support for an Xterm-like scrollbar. 2433Add support for an Xterm-like scrollbar.
2163 2434
2164=item --enable-plain-scroll 2435=item --enable-plain-scroll (default: on)
2165 2436
2166Add support for a very unobtrusive, plain-looking scrollbar that 2437Add support for a very unobtrusive, plain-looking scrollbar that
2167is the favourite of the rxvt-unicode author, having used it for 2438is the favourite of the rxvt-unicode author, having used it for
2168many years. 2439many years.
2169 2440
2170=item --enable-half-shadow 2441=item --enable-half-shadow (default: off)
2171 2442
2172Make shadows on the scrollbar only half the normal width & height. 2443Make shadows on the scrollbar only half the normal width & height.
2173only applicable to rxvt scrollbars. 2444only applicable to rxvt scrollbars.
2174 2445
2175=item --enable-ttygid 2446=item --enable-ttygid (default: off)
2176 2447
2177Change tty device setting to group "tty" - only use this if 2448Change tty device setting to group "tty" - only use this if
2178your system uses this type of security. 2449your system uses this type of security.
2179 2450
2180=item --disable-backspace-key 2451=item --disable-backspace-key
2181 2452
2182Disable any handling of the backspace key by us - let the X server 2453Removes any handling of the backspace key by us - let the X server do it.
2454
2455=item --disable-delete-key
2456
2457Removes any handling of the delete key by us - let the X server
2183do it. 2458do it.
2184 2459
2185=item --disable-delete-key
2186
2187Disable any handling of the delete key by us - let the X server
2188do it.
2189
2190=item --disable-resources 2460=item --disable-resources
2191 2461
2192Remove all resources checking. 2462Removes any support for resource checking.
2193 2463
2194=item --enable-xgetdefault 2464=item --enable-xgetdefault
2195 2465
2196Make resources checking via XGetDefault() instead of our small 2466Make resources checking via XGetDefault() instead of our small
2197version which only checks ~/.Xdefaults, or if that doesn't exist 2467version which only checks ~/.Xdefaults, or if that doesn't exist then
2198then ~/.Xresources. 2468~/.Xresources.
2199 2469
2200=item --enable-strings 2470Please note that nowadays, things like XIM will automatically pull in and
2471use the full X resource manager, so the overhead of using it might be very
2472small, if nonexistant.
2473
2474=item --enable-strings (default: off)
2201 2475
2202Add support for our possibly faster memset() function and other 2476Add support for our possibly faster memset() function and other
2203various routines, overriding your system's versions which may 2477various routines, overriding your system's versions which may
2204have been hand-crafted in assembly or may require extra libraries 2478have been hand-crafted in assembly or may require extra libraries
2205to link in. (this breaks ANSI-C rules and has problems on many 2479to link in. (this breaks ANSI-C rules and has problems on many
2206GNU/Linux systems). 2480GNU/Linux systems).
2207 2481
2208=item --disable-swapscreen 2482=item --disable-swapscreen
2209 2483
2210Remove support for swap screen. 2484Remove support for secondary/swap screen.
2211 2485
2212=item --enable-frills 2486=item --enable-frills (default: on)
2213 2487
2214Add support for many small features that are not essential but nice to 2488Add support for many small features that are not essential but nice to
2215have. Normally you want this, but for very small binaries you may want to 2489have. Normally you want this, but for very small binaries you may want to
2216disable this. 2490disable this.
2217 2491
2492A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2493in combination with other switches) is:
2494
2495 MWM-hints
2496 EWMH-hints (pid, utf8 names) and protocols (ping)
2497 seperate underline colour
2498 settable border widths and borderless switch
2499 settable extra linespacing
2500 iso-14755-2 and -3, and visual feedback
2501 backindex and forwardindex escape sequence
2502 window op and some xterm/OSC escape sequences
2503 tripleclickwords
2504 settable insecure mode
2505 keysym remapping support
2506 cursor blinking and underline cursor
2507 -embed, -pty-fd and -hold options
2508
2218=item --enable-iso14755 2509=item --enable-iso14755 (default: on)
2219 2510
2220Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2511Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2221F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2512F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2222C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2513C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2223this switch. 2514this switch.
2224 2515
2225=item --enable-linespace
2226
2227Add support to provide user specified line spacing between text rows.
2228
2229=item --enable-keepscrolling 2516=item --enable-keepscrolling (default: on)
2230 2517
2231Add support for continual scrolling of the display when you hold 2518Add support for continual scrolling of the display when you hold
2232the mouse button down on a scrollbar arrow. 2519the mouse button down on a scrollbar arrow.
2233 2520
2234=item --enable-mousewheel 2521=item --enable-mousewheel (default: on)
2235 2522
2236Add support for scrolling via mouse wheel or buttons 4 & 5. 2523Add support for scrolling via mouse wheel or buttons 4 & 5.
2237 2524
2238=item --enable-slipwheeling 2525=item --enable-slipwheeling (default: on)
2239 2526
2240Add support for continual scrolling (using the mouse wheel as an 2527Add support for continual scrolling (using the mouse wheel as an
2241accelerator) while the control key is held down. This option 2528accelerator) while the control key is held down. This option
2242requires --enable-mousewheel to also be specified. 2529requires --enable-mousewheel to also be specified.
2243 2530
2244=item --disable-new-selection 2531=item --disable-new-selection
2245 2532
2246Remove support for mouse selection style like that of xterm. 2533Remove support for mouse selection style like that of xterm.
2247 2534
2248=item --enable-dmalloc 2535=item --enable-dmalloc (default: off)
2249 2536
2250Use Gray Watson's malloc - which is good for debugging See 2537Use Gray Watson's malloc - which is good for debugging See
2251http://www.letters.com/dmalloc/ for details If you use either this or the 2538http://www.letters.com/dmalloc/ for details If you use either this or the
2252next option, you may need to edit src/Makefile after compiling to point 2539next option, you may need to edit src/Makefile after compiling to point
2253DINCLUDE and DLIB to the right places. 2540DINCLUDE and DLIB to the right places.
2254 2541
2255You can only use either this option and the following (should 2542You can only use either this option and the following (should
2256you use either) . 2543you use either) .
2257 2544
2258=item --enable-dlmalloc 2545=item --enable-dlmalloc (default: off)
2259 2546
2260Use Doug Lea's malloc - which is good for a production version 2547Use Doug Lea's malloc - which is good for a production version
2261See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2548See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2262 2549
2263=item --enable-smart-resize 2550=item --enable-smart-resize (default: on)
2264 2551
2265Add smart growth/shrink behaviour when changing font size via from hot 2552Add smart growth/shrink behaviour when changing font size via hot
2266keys. This should keep in a fixed position the rxvt corner which is 2553keys. This should keep the window corner which is closest to a corner of
2267closest to a corner of the screen. 2554the screen in a fixed position.
2268 2555
2269=item --enable-cursor-blink
2270
2271Add support for a blinking cursor.
2272
2273=item --enable-pointer-blank 2556=item --enable-pointer-blank (default: on)
2274 2557
2275Add support to have the pointer disappear when typing or inactive. 2558Add support to have the pointer disappear when typing or inactive.
2276 2559
2277=item --with-name=NAME 2560=item --with-name=NAME (default: urxvt)
2278 2561
2279Set the basename for the installed binaries (default: urxvt, resulting in 2562Set the basename for the installed binaries, resulting
2280urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2563in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2564C<rxvt>.
2281 2565
2282=item --with-term=NAME 2566=item --with-term=NAME (default: rxvt-unicode)
2283 2567
2284Change the environmental variable for the terminal to NAME (default 2568Change the environmental variable for the terminal to NAME.
2285"rxvt")
2286 2569
2287=item --with-terminfo=PATH 2570=item --with-terminfo=PATH
2288 2571
2289Change the environmental variable for the path to the terminfo tree to 2572Change the environmental variable for the path to the terminfo tree to
2290PATH. 2573PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines