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.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.99 by root, Tue Jan 31 00:57:35 2006 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 FREQUENTLY ASKED QUESTIONS
26 25
27=over 4 26=head2 The new selection selects pieces that are too big, how can I select
27single words?
28 28
29If you want to select e.g. alphanumeric words, you can use the following
30setting:
31
32 URxvt.selection.pattern-0: ([[:word:]]+)
33
34If you click more than twice, the selection will be extended
35more and more.
36
37To get a selection that is very similar to the old code, try this pattern:
38
39 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
40
41Please also note that the I<LeftClick Shift-LeftClik> combination also
42selects words like the old code.
43
44=head2 I don't like the new selection/popups/hotkeys/perl, how do I
45change/disable it?
46
47You can disable the perl extension completely by setting the
48B<perl-ext-common> resource to the empty string, which also keeps
49rxvt-unicode from initialising perl, saving memory.
50
51If you only want to disable specific features, you first have to
52identify which perl extension is responsible. For this, read the section
53B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
54example, to disable the B<selection-popup> and B<option-popup>, specify
55this B<perl-ext-common> resource:
56
57 URxvt.perl-ext-common: default,-selection-popup,-option-popup
58
59This will keep the default extensions, but disable the two popup
60extensions. Some extensions can also be configured, for example,
61scrollback search mode is triggered by B<M-s>. You can move it to any
62other combination either by setting the B<searchable-scrollback> resource:
63
64 URxvt.searchable-scrollback: CM-s
65
66=head2 The cursor moves when selecting text in the current input line, how
67do I switch this off?
68
69=head2 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor
70outputs strange escape sequences, how do I fix this?
71
72These are caused by the C<readline> perl extension. Under normal
73circumstances, it will move your cursor around when you click into the
74line that contains it. It tries hard not to do this at the wrong moment,
75but when running a program that doesn't parse cursor movements or in some
76cases during rlogin sessions, it fails to detect this properly.
77
78You can permamently switch this feature off by disabling the C<readline>
79extension:
80
81 URxvt.perl-ext-common: default,-readline
82
83=head2 Why doesn't rxvt-unicode read my resources?
84
85Well, why, indeed? It does, in a way very similar to other X
86applications. Most importantly, this means that if you or your OS loads
87resources into the X display (the right way to do it), rxvt-unicode will
88ignore any resource files in your home directory. It will only read
89F<$HOME/.Xdefaults> when no resources are attached to the display.
90
91If you have or use an F<$HOME/.Xresources> file, chances are that
92resources are loaded into your X-server. In this case, you have to
93re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
94
95Also consider the form resources have to use:
96
97 URxvt.resource: value
98
99If you want to use another form (there are lots of different ways of
100specifying resources), make sure you understand wether and why it
101works. If unsure, use the form above.
102
103=head2 I can't get transparency working, what am I doing wrong?
104
105First of all, transparency isn't officially supported in rxvt-unicode, so
106you are mostly on your own. Do not bug the author about it (but you may
107bug everybody else). Also, if you can't get it working consider it a rite
108of passage: ... and you failed.
109
110Here are four ways to get transparency. B<Do> read the manpage and option
111descriptions for the programs mentioned and rxvt-unicode. Really, do it!
112
1131. Use inheritPixmap:
114
115 Esetroot wallpaper.jpg
116 @@RXVT_NAME@@ -ip -tint red -sh 40
117
118That works. If you think it doesn't, you lack transparency and tinting
119support, or you are unable to read.
120
1212. Use a simple pixmap and emulate pseudo-transparency. This enables you
122to use effects other than tinting and shading: Just shade/tint/whatever
123your picture with gimp:
124
125 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
126 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
127
128That works. If you think it doesn't, you lack XPM and Perl support, or you
129are unable to read.
130
1313. Use an ARGB visual:
132
133 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
134
135This requires XFT support, and the support of your X-server. If that
136doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
137there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
138bugfixes and workarounds for Xft and Xlib to make it work, but that
139doesn't mean that your WM has the required kludges in place.
140
1414. Use xcompmgr and let it do the job:
142
143 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
144 -set _NET_WM_WINDOW_OPACITY 0xc0000000
145
146Then click on a window you want to make transparent. Replace C<0xc0000000>
147by other values to change the degree of opacity. If it doesn't work and
148your server crashes, you got to keep the pieces.
149
150=head2 Isn't rxvt supposed to be small? Don't all those features bloat?
151
152I often get asked about this, and I think, no, they didn't cause extra
153bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
154that the urxvt binary is larger (due to some encoding tables always being
155compiled in), but it actually uses less memory (RSS) after startup. Even
156with C<--disable-everything>, this comparison is a bit unfair, as many
157features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
158already in use in this mode.
159
160 text data bss drs rss filename
161 98398 1664 24 15695 1824 rxvt --disable-everything
162 188985 9048 66616 18222 1788 urxvt --disable-everything
163
164When you C<--enable-everything> (which _is_ unfair, as this involves xft
165and full locale/XIM support which are quite bloaty inside libX11 and my
166libc), the two diverge, but not unreasnobaly so.
167
168 text data bss drs rss filename
169 163431 2152 24 20123 2060 rxvt --enable-everything
170 1035683 49680 66648 29096 3680 urxvt --enable-everything
171
172The very large size of the text section is explained by the east-asian
173encoding tables, which, if unused, take up disk space but nothing else
174and can be compiled out unless you rely on X11 core fonts that use those
175encodings. The BSS size comes from the 64k emergency buffer that my c++
176compiler allocates (but of course doesn't use unless you are out of
177memory). Also, using an xft font instead of a core font immediately adds a
178few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
179not used.
180
181Of course, due to every character using two or four bytes instead of one,
182a large scrollback buffer will ultimately make rxvt-unicode use more
183memory.
184
185Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
186still fares rather well. And compared to some monsters like gnome-terminal
187(21152k + extra 4204k in separate processes) or konsole (22200k + extra
18843180k in daemons that stay around after exit, plus half a minute of
189startup time, including the hundreds of warnings it spits out), it fares
190extremely well *g*.
191
192=head2 Why C++, isn't that unportable/bloated/uncool?
193
194Is this a question? :) It comes up very often. The simple answer is: I had
195to write it, and C++ allowed me to write and maintain it in a fraction
196of the time and effort (which is a scarce resource for me). Put even
197shorter: It simply wouldn't exist without C++.
198
199My personal stance on this is that C++ is less portable than C, but in
200the case of rxvt-unicode this hardly matters, as its portability limits
201are defined by things like X11, pseudo terminals, locale support and unix
202domain sockets, which are all less portable than C++ itself.
203
204Regarding the bloat, see the above question: It's easy to write programs
205in C that use gobs of memory, an certainly possible to write programs in
206C++ that don't. C++ also often comes with large libraries, but this is
207not necessarily the case with GCC. Here is what rxvt links against on my
208system with a minimal config:
209
210 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
211 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
212 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
213 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
214
215And here is rxvt-unicode:
216
217 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
218 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
219 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
220 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
221 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
222
223No large bloated libraries (of course, none were linked in statically),
224except maybe libX11 :)
225
226=head2 Does it support tabs, can I have a tabbed rxvt-unicode?
227
228Beginning with version 7.3, there is a perl extension that implements a
229simple tabbed terminal. It is installed by default, so any of these should
230give you tabs:
231
232 @@RXVT_NAME@@ -pe tabbed
233
234 URxvt.perl-ext-common: default,tabbed
235
236It will also work fine with tabbing functionality of many window managers
237or similar tabbing programs, and its embedding-features allow it to be
238embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
239the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
240(murxvt) terminal as an example embedding application.
241
29=item How do I know which rxvt-unicode version I'm using? 242=head2 How do I know which rxvt-unicode version I'm using?
30 243
31The version number is displayed with the usage (-h). Also the escape 244The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 245sequence C<ESC [ 8 n> sets the window title to the version number. When
246using the @@RXVT_NAME@@c client, the version displayed is that of the
247daemon.
33 248
34=item I am using Debian GNU/Linux and have a problem... 249=head2 I am using Debian GNU/Linux and have a problem...
35 250
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 251The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 252patches that considerably change the behaviour of rxvt-unicode (but
253unfortunately this notice has been removed). Before reporting a bug to
38bug to the original rxvt-unicode author please download and install the 254the original rxvt-unicode author please download and install the genuine
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 255version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
40reproduce the problem. If you cannot, chances are that the problems are 256the problem. If you cannot, chances are that the problems are specific to
41specific to Debian GNU/Linux, in which case it should be reported via the 257Debian GNU/Linux, in which case it should be reported via the Debian Bug
42Debian Bug Tracking System (use C<reportbug> to report the bug). 258Tracking System (use C<reportbug> to report the bug).
43 259
44For other problems that also affect the Debian package, you can and 260For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a 261probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that 262bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 263might encounter the same issue.
48 264
265=head2 I am maintaining rxvt-unicode for distribution/OS XXX, any
266recommendation?
267
268You should build one binary with the default options. F<configure>
269now enables most useful options, and the trend goes to making them
270runtime-switchable, too, so there is usually no drawback to enbaling them,
271except higher disk and possibly memory usage. The perl interpreter should
272be enabled, as important functionality (menus, selection, likely more in
273the future) depends on it.
274
275You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
276system-wide (except maybe with C<defaults>). This will result in useful
277behaviour. If your distribution aims at low memory, add an empty
278C<perl-ext-common> resource to the app-defaults file. This will keep the
279perl interpreter disabled until the user enables it.
280
281If you can/want build more binaries, I recommend building a minimal
282one with C<--disable-everything> (very useful) and a maximal one with
283C<--enable-everything> (less useful, it will be very big due to a lot of
284encodings built-in that increase download times and are rarely used).
285
286=head2 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
287
288It should be, starting with release 7.1. You are encouraged to properly
289install urxvt with privileges necessary for your OS now.
290
291When rxvt-unicode detects that it runs setuid or setgid, it will fork
292into a helper process for privileged operations (pty handling on some
293systems, utmp/wtmp/lastlog handling on others) and drop privileges
294immediately. This is much safer than most other terminals that keep
295privileges while running (but is more relevant to urxvt, as it contains
296things as perl interpreters, which might be "helpful" to attackers).
297
298This forking is done as the very first within main(), which is very early
299and reduces possible bugs to initialisation code run before main(), or
300things like the dynamic loader of your system, which should result in very
301little risk.
302
49=item When I log-in to another system it tells me about missing terminfo data? 303=head2 When I log-in to another system it tells me about missing terminfo data?
50 304
51The terminal description used by rxvt-unicode is not as widely available 305The terminal description used by rxvt-unicode is not as widely available
52as that for xterm, or even rxvt (for which the same problem often arises). 306as that for xterm, or even rxvt (for which the same problem often arises).
53 307
54The correct solution for this problem is to install the terminfo, this can 308The correct solution for this problem is to install the terminfo, this can
72 URxvt.termName: rxvt 326 URxvt.termName: rxvt
73 327
74If you don't plan to use B<rxvt> (quite common...) you could also replace 328If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 329the rxvt terminfo file with the rxvt-unicode one.
76 330
331=head2 C<tic> outputs some error when compiling the terminfo entry.
332
333Most likely it's the empty definition for C<enacs=>. Just replace it by
334C<enacs=\E[0@> and try again.
335
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 336=head2 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 337
79=item I need a termcap file entry. 338=head2 I need a termcap file entry.
80 339
81One reason you might want this is that some distributions or operating 340One reason you might want this is that some distributions or operating
82systems still compile some programs using the long-obsoleted termcap 341systems still compile some programs using the long-obsoleted termcap
83library (Fedora Core's bash is one example) and rely on a termcap entry 342library (Fedora Core's bash is one example) and rely on a termcap entry
84for C<rxvt-unicode>. 343for C<rxvt-unicode>.
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 353 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\ 354 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:lm#0:\ 355 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 356 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 357 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 358 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 359 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 360 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 361 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
362 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
103 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 363 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ 364 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ 365 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ 366 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ 367 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ 368 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
109 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 369 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
110 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 370 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
111 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 371 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
112 :vs=\E[?25h: 372 :vs=\E[?25h:
113 373
114=item Why does C<ls> no longer have coloured output? 374=head2 Why does C<ls> no longer have coloured output?
115 375
116The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 376The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
117decide wether a terminal has colour, but uses it's own configuration 377decide wether a terminal has colour, but uses it's own configuration
118file. Needless to say, C<rxvt-unicode> is not in it's default file (among 378file. Needless to say, C<rxvt-unicode> is not in it's default file (among
119with most other terminals supporting colour). Either add: 379with most other terminals supporting colour). Either add:
124 384
125 alias ls='ls --color=auto' 385 alias ls='ls --color=auto'
126 386
127to your C<.profile> or C<.bashrc>. 387to your C<.profile> or C<.bashrc>.
128 388
129=item Why doesn't vim/emacs etc. use the 88 colour mode? 389=head2 Why doesn't vim/emacs etc. use the 88 colour mode?
130 390
131=item Why doesn't vim/emacs etc. make use of italic? 391=head2 Why doesn't vim/emacs etc. make use of italic?
132 392
133=item Why are the secondary screen-related options not working properly? 393=head2 Why are the secondary screen-related options not working properly?
134 394
135Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 395Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
136distributions (most notably Debian GNU/Linux) break rxvt-unicode 396distributions (most notably Debian GNU/Linux) break rxvt-unicode
137by setting C<TERM> to C<rxvt>, which doesn't have these extra 397by setting C<TERM> to C<rxvt>, which doesn't have these extra
138features. Unfortunately, some of these (most notably, again, Debian 398features. Unfortunately, some of these (most notably, again, Debian
139GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 399GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
140file, so you will need to install it on your own (See the question B<When 400file, so you will need to install it on your own (See the question B<When
141I log-in to another system it tells me about missing terminfo data?> on 401I log-in to another system it tells me about missing terminfo data?> on
142how to do this). 402how to do this).
143 403
144=item My numerical keypad acts weird and generates differing output? 404=head2 My numerical keypad acts weird and generates differing output?
145 405
146Some Debian GNUL/Linux users seem to have this problem, although no 406Some Debian GNUL/Linux users seem to have this problem, although no
147specific details were reported so far. It is possible that this is caused 407specific details were reported so far. It is possible that this is caused
148by the wrong C<TERM> setting, although the details of wether and how 408by the wrong C<TERM> setting, although the details of wether and how
149this can happen are unknown, as C<TERM=rxvt> should offer a compatible 409this can happen are unknown, as C<TERM=rxvt> should offer a compatible
150keymap. See the answer to the previous question, and please report if that 410keymap. See the answer to the previous question, and please report if that
151helped. 411helped.
152 412
153=item Rxvt-unicode does not seem to understand the selected encoding? 413=head2 Rxvt-unicode does not seem to understand the selected encoding?
154 414
155=item Unicode does not seem to work? 415=head2 Unicode does not seem to work?
156 416
157If you encounter strange problems like typing an accented character but 417If you encounter strange problems like typing an accented character but
158getting two unrelated other characters or similar, or if program output is 418getting two unrelated other characters or similar, or if program output is
159subtly garbled, then you should check your locale settings. 419subtly garbled, then you should check your locale settings.
160 420
180 440
181If nothing works and you are sure that everything is set correctly then 441If nothing works and you are sure that everything is set correctly then
182you will need to remember a little known fact: Some programs just don't 442you will need to remember a little known fact: Some programs just don't
183support locales :( 443support locales :(
184 444
185=item Why do some characters look so much different than others? 445=head2 Why do some characters look so much different than others?
186 446
187=item How does rxvt-unicode choose fonts? 447=head2 How does rxvt-unicode choose fonts?
188 448
189Most fonts do not contain the full range of Unicode, which is 449Most fonts do not contain the full range of Unicode, which is
190fine. Chances are that the font you (or the admin/package maintainer of 450fine. Chances are that the font you (or the admin/package maintainer of
191your system/os) have specified does not cover all the characters you want 451your system/os) have specified does not cover all the characters you want
192to display. 452to display.
210 470
211The only limitation is that none of the fonts may be larger than the base 471The only limitation is that none of the fonts may be larger than the base
212font, as the base font defines the terminal character cell size, which 472font, as the base font defines the terminal character cell size, which
213must be the same due to the way terminals work. 473must be the same due to the way terminals work.
214 474
215=item Why do some chinese characters look so different than others? 475=head2 Why do some chinese characters look so different than others?
216 476
217This is because there is a difference between script and language -- 477This is because there is a difference between script and language --
218rxvt-unicode does not know which language the text that is output is, 478rxvt-unicode does not know which language the text that is output is,
219as it only knows the unicode character codes. If rxvt-unicode first 479as it only knows the unicode character codes. If rxvt-unicode first
220sees a japanese/chinese character, it might choose a japanese font for 480sees a japanese/chinese character, it might choose a japanese font for
235has been designed yet). 495has been designed yet).
236 496
237Until then, you might get away with switching fonts at runtime (see L<Can 497Until then, you might get away with switching fonts at runtime (see L<Can
238I switch the fonts at runtime?> later in this document). 498I switch the fonts at runtime?> later in this document).
239 499
240=item Why does rxvt-unicode sometimes leave pixel droppings? 500=head2 Why does rxvt-unicode sometimes leave pixel droppings?
241 501
242Most fonts were not designed for terminal use, which means that character 502Most fonts were not designed for terminal use, which means that character
243size varies a lot. A font that is otherwise fine for terminal use might 503size varies a lot. A font that is otherwise fine for terminal use might
244contain some characters that are simply too wide. Rxvt-unicode will avoid 504contain some characters that are simply too wide. Rxvt-unicode will avoid
245these characters. For characters that are just "a bit" too wide a special 505these characters. For characters that are just "a bit" too wide a special
257might be forced to use a different font. 517might be forced to use a different font.
258 518
259All of this is not a problem when using X11 core fonts, as their bounding 519All of this is not a problem when using X11 core fonts, as their bounding
260box data is correct. 520box data is correct.
261 521
522=head2 On Solaris 9, many line-drawing characters are too wide.
523
524Seems to be a known bug, read
525L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
526following ugly workaround to get non-double-wide-characters working:
527
528 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
529
262=item My Compose (Multi_key) key is no longer working. 530=head2 My Compose (Multi_key) key is no longer working.
263 531
264The most common causes for this are that either your locale is not set 532The most common causes for this are that either your locale is not set
265correctly, or you specified a B<preeditStyle> that is not supported by 533correctly, or you specified a B<preeditStyle> that is not supported by
266your input method. For example, if you specified B<OverTheSpot> and 534your input method. For example, if you specified B<OverTheSpot> and
267your input method (e.g. the default input method handling Compose keys) 535your input method (e.g. the default input method handling Compose keys)
269rxvt-unicode will continue without an input method. 537rxvt-unicode will continue without an input method.
270 538
271In this case either do not specify a B<preeditStyle> or specify more than 539In this case either do not specify a B<preeditStyle> or specify more than
272one pre-edit style, such as B<OverTheSpot,Root,None>. 540one pre-edit style, such as B<OverTheSpot,Root,None>.
273 541
274=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 542=head2 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
275 543
276Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 544Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
277international keyboards) or simply use ISO 14755 support to your 545international keyboards) or simply use ISO 14755 support to your
278advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 546advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
279codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 547codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
280character and so on. 548character and so on.
281 549
282=item How can I keep rxvt-unicode from using reverse video so much? 550=head2 How can I keep rxvt-unicode from using reverse video so much?
283 551
284First of all, make sure you are running with the right terminal settings 552First of all, make sure you are running with the right terminal settings
285(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 553(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
286make sure you have specified colours for italic and bold, as otherwise 554make sure you have specified colours for italic and bold, as otherwise
287rxvt-unicode might use reverse video to simulate the effect: 555rxvt-unicode might use reverse video to simulate the effect:
288 556
289 URxvt.colorBD: white 557 URxvt.colorBD: white
290 URxvt.colorIT: green 558 URxvt.colorIT: green
291 559
292=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 560=head2 Some programs assume totally weird colours (red instead of blue), how can I fix that?
293 561
294For some unexplainable reason, some rare programs assume a very weird 562For some unexplainable reason, some rare programs assume a very weird
295colour palette when confronted with a terminal with more than the standard 563colour palette when confronted with a terminal with more than the standard
2968 colours (rxvt-unicode supports 88). The right fix is, of course, to fix 5648 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
297these programs not to assume non-ISO colours without very good reasons. 565these programs not to assume non-ISO colours without very good reasons.
298 566
299In the meantime, you can either edit your C<rxvt-unicode> terminfo 567In the meantime, you can either edit your C<rxvt-unicode> terminfo
300definition to only claim 8 colour support or use C<TERM=rxvt>, which will 568definition to only claim 8 colour support or use C<TERM=rxvt>, which will
301fix colours but keep you from using other rxvt-unicode features. 569fix colours but keep you from using other rxvt-unicode features.
302 570
303=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 571=head2 I am on FreeBSD and rxvt-unicode does not seem to work at all.
304 572
305Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 573Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
306in your compile environment, or an implementation that implements it, 574in your compile environment, or an implementation that implements it,
307wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 575wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
308B<wchar_t> is represented as unicode. 576B<wchar_t> is represented as unicode.
309 577
310As you might have guessed, FreeBSD does neither define this symobl nor 578As you might have guessed, FreeBSD does neither define this symobl nor
311does it support it. Instead, it uses it's own internal representation of 579does it support it. Instead, it uses it's own internal representation of
312B<wchar_t>. This is, of course, completely fine with respect to standards. 580B<wchar_t>. This is, of course, completely fine with respect to standards.
313 581
582However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
583C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
584
314However, C<__STDC_ISO_10646__> is the only sane way to support 585C<__STDC_ISO_10646__> is the only sane way to support multi-language
315multi-language apps in an OS, as using a locale-dependent (and 586apps in an OS, as using a locale-dependent (and non-standardized)
316non-standardized) representation of B<wchar_t> makes it impossible to 587representation of B<wchar_t> makes it impossible to convert between
317convert between B<wchar_t> (as used by X11 and your applications) and any 588B<wchar_t> (as used by X11 and your applications) and any other encoding
318other encoding without implementing OS-specific-wrappers for each and 589without implementing OS-specific-wrappers for each and every locale. There
319every locale. There simply are no APIs to convert B<wchar_t> into anything 590simply are no APIs to convert B<wchar_t> into anything except the current
320except the current locale encoding. 591locale encoding.
321 592
322Some applications (such as the formidable B<mlterm>) work around this 593Some applications (such as the formidable B<mlterm>) work around this
323by carrying their own replacement functions for character set handling 594by carrying their own replacement functions for character set handling
324with them, and either implementing OS-dependent hacks or doing multiple 595with them, and either implementing OS-dependent hacks or doing multiple
325conversions (which is slow and unreliable in case the OS implements 596conversions (which is slow and unreliable in case the OS implements
327 598
328The rxvt-unicode author insists that the right way to fix this is in the 599The rxvt-unicode author insists that the right way to fix this is in the
329system libraries once and for all, instead of forcing every app to carry 600system libraries once and for all, instead of forcing every app to carry
330complete replacements for them :) 601complete replacements for them :)
331 602
603=head2 I use Solaris 9 and it doesn't compile/work/etc.
604
605Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
606problems with C<wcwidth> and a compile problem.
607
608=head2 How can I use rxvt-unicode under cygwin?
609
610rxvt-unicode should compile and run out of the box on cygwin, using
611the X11 libraries that come with cygwin. libW11 emulation is no
612longer supported (and makes no sense, either, as it only supported a
613single font). I recommend starting the X-server in C<-multiwindow> or
614C<-rootless> mode instead, which will result in similar look&feel as the
615old libW11 emulation.
616
617At the time of this writing, cygwin didn't seem to support any multi-byte
618encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
619to 8-bit encodings.
620
332=item How does rxvt-unicode determine the encoding to use? 621=head2 How does rxvt-unicode determine the encoding to use?
333 622
334=item Is there an option to switch encodings? 623=head2 Is there an option to switch encodings?
335 624
336Unlike some other terminals, rxvt-unicode has no encoding switch, and no 625Unlike some other terminals, rxvt-unicode has no encoding switch, and no
337specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 626specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
338UTF-8 or any other encodings with respect to terminal I/O. 627UTF-8 or any other encodings with respect to terminal I/O.
339 628
364rxvt-unicode. 653rxvt-unicode.
365 654
366If you want to use a specific encoding you have to make sure you start 655If you want to use a specific encoding you have to make sure you start
367rxvt-unicode with the correct C<LC_CTYPE> category. 656rxvt-unicode with the correct C<LC_CTYPE> category.
368 657
369=item Can I switch locales at runtime? 658=head2 Can I switch locales at runtime?
370 659
371Yes, using an escape sequence. Try something like this, which sets 660Yes, using an escape sequence. Try something like this, which sets
372rxvt-unicode's idea of C<LC_CTYPE>. 661rxvt-unicode's idea of C<LC_CTYPE>.
373 662
374 printf '\e]701;%s\007' ja_JP.SJIS 663 printf '\e]701;%s\007' ja_JP.SJIS
386 675
387You can also use xterm's C<luit> program, which usually works fine, except 676You can also use xterm's C<luit> program, which usually works fine, except
388for some locales where character width differs between program- and 677for some locales where character width differs between program- and
389rxvt-unicode-locales. 678rxvt-unicode-locales.
390 679
391=item Can I switch the fonts at runtime? 680=head2 Can I switch the fonts at runtime?
392 681
393Yes, using an escape sequence. Try something like this, which has the same 682Yes, using an escape sequence. Try something like this, which has the same
394effect as using the C<-fn> switch, and takes effect immediately: 683effect as using the C<-fn> switch, and takes effect immediately:
395 684
396 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 685 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
399japanese font), but you have to switch to chinese temporarily, where 688japanese font), but you have to switch to chinese temporarily, where
400japanese fonts would only be in your way. 689japanese fonts would only be in your way.
401 690
402You can think of this as a kind of manual ISO-2022 switching. 691You can think of this as a kind of manual ISO-2022 switching.
403 692
404=item Why do italic characters look as if clipped? 693=head2 Why do italic characters look as if clipped?
405 694
406Many fonts have difficulties with italic characters and hinting. For 695Many fonts have difficulties with italic characters and hinting. For
407example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 696example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
408Mono> completely fails in it's italic face. A workaround might be to 697Mono> completely fails in it's italic face. A workaround might be to
409enable freetype autohinting, i.e. like this: 698enable freetype autohinting, i.e. like this:
410 699
411 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 700 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
412 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 701 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
413 702
414=item My input method wants <some encoding> but I want UTF-8, what can I do? 703=head2 My input method wants <some encoding> but I want UTF-8, what can I do?
415 704
416You can specify separate locales for the input method and the rest of the 705You can specify separate locales for the input method and the rest of the
417terminal, using the resource C<imlocale>: 706terminal, using the resource C<imlocale>:
418 707
419 URxvt*imlocale: ja_JP.EUC-JP 708 URxvt.imlocale: ja_JP.EUC-JP
420 709
421Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 710Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
422use your input method. Please note, however, that you will not be able to 711use your input method. Please note, however, that you will not be able to
423input characters outside C<EUC-JP> in a normal way then, as your input 712input characters outside C<EUC-JP> in a normal way then, as your input
424method limits you. 713method limits you.
425 714
426=item Rxvt-unicode crashes when the X Input Method changes or exits. 715=head2 Rxvt-unicode crashes when the X Input Method changes or exits.
427 716
428Unfortunately, this is unavoidable, as the XIM protocol is racy by 717Unfortunately, this is unavoidable, as the XIM protocol is racy by
429design. Applications can avoid some crashes at the expense of memory 718design. Applications can avoid some crashes at the expense of memory
430leaks, and Input Methods can avoid some crashes by careful ordering at 719leaks, and Input Methods can avoid some crashes by careful ordering at
431exit time. B<kinput2> (and derived input methods) generally succeeds, 720exit time. B<kinput2> (and derived input methods) generally succeeds,
432while B<SCIM> (or similar input methods) fails. In the end, however, 721while B<SCIM> (or similar input methods) fails. In the end, however,
433crashes cannot be completely avoided even if both sides cooperate. 722crashes cannot be completely avoided even if both sides cooperate.
434 723
435So the only workaround is not to kill your Input Method Servers. 724So the only workaround is not to kill your Input Method Servers.
436 725
437=item Rxvt-unicode uses gobs of memory, how can I reduce that? 726=head2 Rxvt-unicode uses gobs of memory, how can I reduce that?
438 727
439Rxvt-unicode tries to obey the rule of not charging you for something you 728Rxvt-unicode tries to obey the rule of not charging you for something you
440don't use. One thing you should try is to configure out all settings that 729don't use. One thing you should try is to configure out all settings that
441you don't need, for example, Xft support is a resource hog by design, 730you don't need, for example, Xft support is a resource hog by design,
442when used. Compiling it out ensures that no Xft font will be loaded 731when used. Compiling it out ensures that no Xft font will be loaded
4476 bytes per screen cell. For a 160x?? window this amounts to almost a 7366 bytes per screen cell. For a 160x?? window this amounts to almost a
448kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 737kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
449use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 738use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
450rxvt-unicode then uses 8 bytes per screen cell. 739rxvt-unicode then uses 8 bytes per screen cell.
451 740
452=item Can I speed up Xft rendering somehow? 741=head2 Can I speed up Xft rendering somehow?
453 742
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as 743Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455it is simply slow. If you still want Xft fonts you might try to disable 744it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of 745antialiasing (by appending C<:antialias=false>), which saves lots of
457memory and also speeds up rendering considerably. 746memory and also speeds up rendering considerably.
458 747
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 748=head2 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460 749
461Rxvt-unicode will use whatever you specify as a font. If it needs to 750Rxvt-unicode will use whatever you specify as a font. If it needs to
462fall back to it's default font search list it will prefer X11 core 751fall back to it's default font search list it will prefer X11 core
463fonts, because they are small and fast, and then use Xft fonts. It has 752fonts, because they are small and fast, and then use Xft fonts. It has
464antialiasing disabled for most of them, because the author thinks they 753antialiasing disabled for most of them, because the author thinks they
465look best that way. 754look best that way.
466 755
467If you want antialiasing, you have to specify the fonts manually. 756If you want antialiasing, you have to specify the fonts manually.
468 757
469=item Mouse cut/paste suddenly no longer works. 758=head2 Mouse cut/paste suddenly no longer works.
470 759
471Make sure that mouse reporting is actually turned off since killing 760Make sure that mouse reporting is actually turned off since killing
472some editors prematurely may leave the mouse in mouse report mode. I've 761some editors prematurely may leave the mouse in mouse report mode. I've
473heard that tcsh may use mouse reporting unless it otherwise specified. A 762heard that tcsh may use mouse reporting unless it otherwise specified. A
474quick check is to see if cut/paste works when the Alt or Shift keys are 763quick check is to see if cut/paste works when the Alt or Shift keys are
475depressed. See @@RXVT_NAME@@(7) 764depressed.
476 765
477=item What's with this bold/blink stuff? 766=head2 What's with this bold/blink stuff?
478 767
479If no bold colour is set via C<colorBD:>, bold will invert text using the 768If no bold colour is set via C<colorBD:>, bold will invert text using the
480standard foreground colour. 769standard foreground colour.
481 770
482For the standard background colour, blinking will actually make the 771For the standard background colour, blinking will actually make the
489 778
490color0-7 are the low-intensity colors. 779color0-7 are the low-intensity colors.
491 780
492color8-15 are the corresponding high-intensity colors. 781color8-15 are the corresponding high-intensity colors.
493 782
494=item I don't like the screen colors. How do I change them? 783=head2 I don't like the screen colors. How do I change them?
495 784
496You can change the screen colors at run-time using F<~/.Xdefaults> 785You can change the screen colors at run-time using F<~/.Xdefaults>
497resources (or as long-options). 786resources (or as long-options).
498 787
499Here are values that are supposed to resemble a VGA screen, 788Here are values that are supposed to resemble a VGA screen,
537 URxvt.color6: #73f7ff 826 URxvt.color6: #73f7ff
538 URxvt.color14: #73f7ff 827 URxvt.color14: #73f7ff
539 URxvt.color7: #e1dddd 828 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd 829 URxvt.color15: #e1dddd
541 830
542=item How can I start @@RXVT_NAME@@d in a race-free way? 831=head2 How can I start @@RXVT_NAME@@d in a race-free way?
543 832
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 833Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
545server that answers @@RXVT_NAME@@c's requests, so it doesn't background 834display, create the listening socket and then fork.
546itself.
547 835
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549following method to wait for the startup message before continuing:
550
551 { @@RXVT_NAME@@d & } | read
552
553=item What's with the strange Backspace/Delete key behaviour? 836=head2 What's with the strange Backspace/Delete key behaviour?
554 837
555Assuming that the physical Backspace key corresponds to the 838Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following 839BackSpace keysym (not likely for Linux ... see the following
557question) there are two standard values that can be used for 840question) there are two standard values that can be used for
558Backspace: C<^H> and C<^?>. 841Backspace: C<^H> and C<^?>.
575 858
576 # use Backspace = ^? 859 # use Backspace = ^?
577 $ stty erase ^? 860 $ stty erase ^?
578 $ @@RXVT_NAME@@ 861 $ @@RXVT_NAME@@
579 862
580Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 863Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
581 864
582For an existing rxvt-unicode: 865For an existing rxvt-unicode:
583 866
584 # use Backspace = ^H 867 # use Backspace = ^H
585 $ stty erase ^H 868 $ stty erase ^H
604some editors (vim I'm told) expect Backspace = ^H, 887some editors (vim I'm told) expect Backspace = ^H,
605GNU Emacs (and Emacs-like editors) use ^H for help. 888GNU Emacs (and Emacs-like editors) use ^H for help.
606 889
607Perhaps someday this will all be resolved in a consistent manner. 890Perhaps someday this will all be resolved in a consistent manner.
608 891
609=item I don't like the key-bindings. How do I change them? 892=head2 I don't like the key-bindings. How do I change them?
610 893
611There are some compile-time selections available via configure. Unless 894There are some compile-time selections available via configure. Unless
612you have run "configure" with the C<--disable-resources> option you can 895you have run "configure" with the C<--disable-resources> option you can
613use the `keysym' resource to alter the keystrings associated with keysyms. 896use the `keysym' resource to alter the keystrings associated with keysyms.
614 897
635 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 918 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
636 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 919 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
637 920
638See some more examples in the documentation for the B<keysym> resource. 921See some more examples in the documentation for the B<keysym> resource.
639 922
640=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 923=head2 I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
641How do I make use of them? For example, the Sun Keyboard type 4 924How do I make use of them? For example, the Sun Keyboard type 4
642has the following mappings that rxvt-unicode doesn't recognize. 925has the following mappings that rxvt-unicode doesn't recognize.
643 926
644 KP_Insert == Insert 927 KP_Insert == Insert
645 F22 == Print 928 F22 == Print
650 933
651Rather than have rxvt-unicode try to accommodate all the various possible 934Rather than have rxvt-unicode try to accommodate all the various possible
652keyboard mappings, it is better to use `xmodmap' to remap the keys as 935keyboard mappings, it is better to use `xmodmap' to remap the keys as
653required for your particular machine. 936required for your particular machine.
654 937
655=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm? 938=head2 How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
656I need this to decide about setting colors etc. 939I need this to decide about setting colors etc.
657 940
658rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 941rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
659check and see if that is set. Note that several programs, JED, slrn, 942check and see if that is set. Note that several programs, JED, slrn,
660Midnight Commander automatically check this variable to decide whether or 943Midnight Commander automatically check this variable to decide whether or
661not to use color. 944not to use color.
662 945
663=item How do I set the correct, full IP address for the DISPLAY variable? 946=head2 How do I set the correct, full IP address for the DISPLAY variable?
664 947
665If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 948If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
666insecure mode then it is possible to use the following shell script 949insecure mode then it is possible to use the following shell script
667snippets to correctly set the display. If your version of rxvt-unicode 950snippets to correctly set the display. If your version of rxvt-unicode
668wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then 951wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
683 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 966 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
684 read DISPLAY # set it in our local shell 967 read DISPLAY # set it in our local shell
685 fi 968 fi
686 fi 969 fi
687 970
688=item How do I compile the manual pages for myself? 971=head2 How do I compile the manual pages for myself?
689 972
690You need to have a recent version of perl installed as F</usr/bin/perl>, 973You need to have a recent version of perl installed as F</usr/bin/perl>,
691one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 974one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
692the doc subdirectory and enter C<make alldoc>. 975the doc subdirectory and enter C<make alldoc>.
693 976
694=item My question isn't answered here, can I ask a human? 977=head2 My question isn't answered here, can I ask a human?
695 978
696Before sending me mail, you could go to IRC: C<irc.freenode.net>, 979Before sending me mail, you could go to IRC: C<irc.freenode.net>,
697channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 980channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
698interested in learning about new and exciting problems (but not FAQs :). 981interested in learning about new and exciting problems (but not FAQs :).
699 982
700=back
701
702=head1 RXVT TECHNICAL REFERENCE 983=head1 RXVT TECHNICAL REFERENCE
703 984
704=head1 DESCRIPTION 985=head1 DESCRIPTION
705 986
706The rest of this document describes various technical aspects of 987The rest of this document describes various technical aspects of
707B<rxvt-unicode>. First the description of supported command sequences, 988B<rxvt-unicode>. First the description of supported command sequences,
708followed by menu and pixmap support and last by a description of all 989followed by pixmap support and last by a description of all features
709features selectable at C<configure> time. 990selectable at C<configure> time.
710 991
711=head1 Definitions 992=head1 Definitions
712 993
713=over 4 994=over 4
714 995
1282 B<< C<h> >> Send Mouse X & Y on button press. 1563 B<< C<h> >> Send Mouse X & Y on button press.
1283 B<< C<l> >> No mouse reporting. 1564 B<< C<l> >> No mouse reporting.
1284 1565
1285=end table 1566=end table
1286 1567
1287=item B<< C<Ps = 10> >> (B<rxvt>)
1288
1289=begin table
1290
1291 B<< C<h> >> menuBar visible
1292 B<< C<l> >> menuBar invisible
1293
1294=end table
1295
1296=item B<< C<Ps = 25> >> 1568=item B<< C<Ps = 25> >>
1297 1569
1298=begin table 1570=begin table
1299 1571
1300 B<< C<h> >> Visible cursor {cnorm/cvvis} 1572 B<< C<h> >> Visible cursor {cnorm/cvvis}
1413 1685
1414=begin table 1686=begin table
1415 1687
1416 B<< C<h> >> Scroll to bottom when a key is pressed 1688 B<< C<h> >> Scroll to bottom when a key is pressed
1417 B<< C<l> >> Don't scroll to bottom when a key is pressed 1689 B<< C<l> >> Don't scroll to bottom when a key is pressed
1690
1691=end table
1692
1693=item B<< C<Ps = 1021> >> (B<rxvt>)
1694
1695=begin table
1696
1697 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1698 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1418 1699
1419=end table 1700=end table
1420 1701
1421=item B<< C<Ps = 1047> >> 1702=item B<< C<Ps = 1047> >>
1422 1703
1471 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1752 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1472 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1753 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1473 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1754 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1474 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1755 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1756 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1757 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1477 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1758 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1759 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1478 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1760 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1479 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1480 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1761 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1762 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482 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> >> 1763 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> >>
1483 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1764 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484 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) 1765 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).
1485 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1766 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1486 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1767 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1768 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1769 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1770 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1488 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1771 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1772 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1773 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1774 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1775 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1776 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1777 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1492 1778
1493=end table 1779=end table
1494 1780
1495=back 1781=back
1496 1782
1497X<menuBar>
1498
1499=head1 menuBar
1500
1501B<< The exact syntax used is I<almost> solidified. >>
1502In the menus, B<DON'T> try to use menuBar commands that add or remove a
1503menuBar.
1504
1505Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1506omitted: use B<./> to specify a menu relative to the current menu.
1507
1508=head2 Overview of menuBar operation
1509
1510For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1511of C<Pt> can be used for a variety of tasks:
1512
1513At the top level is the current menuBar which is a member of a circular
1514linked-list of other such menuBars.
1515
1516The menuBar acts as a parent for the various drop-down menus, which in
1517turn, may have labels, separator lines, menuItems and subMenus.
1518
1519The menuItems are the useful bits: you can use them to mimic keyboard
1520input or even to send text or escape sequences back to rxvt.
1521
1522The menuBar syntax is intended to provide a simple yet robust method of
1523constructing and manipulating menus and navigating through the
1524menuBars.
1525
1526The first step is to use the tag B<< [menu:I<name>] >> which creates
1527the menuBar called I<name> and allows access. You may now or menus,
1528subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1529menuBar access as B<readonly> to prevent accidental corruption of the
1530menus. To re-access the current menuBar for alterations, use the tag
1531B<[menu]>, make the alterations and then use B<[done]>
1532
1533X<menuBarCommands>
1534
1535=head2 Commands
1536
1537=over 4
1538
1539=item B<< [menu:+I<name>] >>
1540
1541access the named menuBar for creation or alteration. If a new menuBar
1542is created, it is called I<name> (max of 15 chars) and the current
1543menuBar is pushed onto the stack
1544
1545=item B<[menu]>
1546
1547access the current menuBar for alteration
1548
1549=item B<< [title:+I<string>] >>
1550
1551set the current menuBar's title to I<string>, which may contain the
1552following format specifiers:
1553
1554 B<%n> rxvt name (as per the B<-name> command-line option)
1555 B<%v> rxvt version
1556 B<%%> literal B<%> character
1557
1558=item B<[done]>
1559
1560set menuBar access as B<readonly>.
1561End-of-file tag for B<< [read:+I<file>] >> operations.
1562
1563=item B<< [read:+I<file>] >>
1564
1565read menu commands directly from I<file> (extension ".menu" will be
1566appended if required.) Start reading at a line with B<[menu]> or B<<
1567[menu:+I<name> >> and continuing until B<[done]> is encountered.
1568
1569Blank and comment lines (starting with B<#>) are ignored. Actually,
1570since any invalid menu commands are also ignored, almost anything could
1571be construed as a comment line, but this may be tightened up in the
1572future ... so don't count on it!.
1573
1574=item B<< [read:+I<file>;+I<name>] >>
1575
1576The same as B<< [read:+I<file>] >>, but start reading at a line with
1577B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1578B<[done]> is encountered.
1579
1580=item B<[dump]>
1581
1582dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1583later rereading.
1584
1585=item B<[rm:name]>
1586
1587remove the named menuBar
1588
1589=item B<[rm] [rm:]>
1590
1591remove the current menuBar
1592
1593=item B<[rm*] [rm:*]>
1594
1595remove all menuBars
1596
1597=item B<[swap]>
1598
1599swap the top two menuBars
1600
1601=item B<[prev]>
1602
1603access the previous menuBar
1604
1605=item B<[next]>
1606
1607access the next menuBar
1608
1609=item B<[show]>
1610
1611Enable display of the menuBar
1612
1613=item B<[hide]>
1614
1615Disable display of the menuBar
1616
1617=item B<< [pixmap:+I<name>] >>
1618
1619=item B<< [pixmap:+I<name>;I<scaling>] >>
1620
1621(set the background pixmap globally
1622
1623B<< A Future implementation I<may> make this local to the menubar >>)
1624
1625=item B<< [:+I<command>:] >>
1626
1627ignore the menu readonly status and issue a I<command> to or a menu or
1628menuitem or change the ; a useful shortcut for setting the quick arrows
1629from a menuBar.
1630
1631=back
1632
1633X<menuBarAdd>
1634
1635=head2 Adding and accessing menus
1636
1637The following commands may also be B<+> prefixed.
1638
1639=over 4
1640
1641=item B</+>
1642
1643access menuBar top level
1644
1645=item B<./+>
1646
1647access current menu level
1648
1649=item B<../+>
1650
1651access parent menu (1 level up)
1652
1653=item B<../../>
1654
1655access parent menu (multiple levels up)
1656
1657=item B<< I</path/>menu >>
1658
1659add/access menu
1660
1661=item B<< I</path/>menu/* >>
1662
1663add/access menu and clear it if it exists
1664
1665=item B<< I</path/>{-} >>
1666
1667add separator
1668
1669=item B<< I</path/>{item} >>
1670
1671add B<item> as a label
1672
1673=item B<< I</path/>{item} action >>
1674
1675add/alter I<menuitem> with an associated I<action>
1676
1677=item B<< I</path/>{item}{right-text} >>
1678
1679add/alter I<menuitem> with B<right-text> as the right-justified text
1680and as the associated I<action>
1681
1682=item B<< I</path/>{item}{rtext} action >>
1683
1684add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1685the right-justified text.
1686
1687=back
1688
1689=over 4
1690
1691=item Special characters in I<action> must be backslash-escaped:
1692
1693B<\a \b \E \e \n \r \t \octal>
1694
1695=item or in control-character notation:
1696
1697B<^@, ^A .. ^Z .. ^_, ^?>
1698
1699=back
1700
1701To send a string starting with a B<NUL> (B<^@>) character to the
1702program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1703the first of which will be stripped off and the balance directed to the
1704program. Otherwise if I<action> begins with B<NUL> followed by
1705non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1706balance is sent back to rxvt.
1707
1708As a convenience for the many Emacs-type editors, I<action> may start
1709with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1710appended if missed from B<M-x> commands.
1711
1712As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1713quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1714
1715=over 4
1716
1717=item For example,
1718
1719B<M-xapropos> is equivalent to B<\Exapropos\r>
1720
1721=item and
1722
1723B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1724
1725=back
1726
1727The option B<< {I<right-rtext>} >> will be right-justified. In the
1728absence of a specified action, this text will be used as the I<action>
1729as well.
1730
1731=over 4
1732
1733=item For example,
1734
1735B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1736
1737=back
1738
1739The left label I<is> necessary, since it's used for matching, but
1740implicitly hiding the left label (by using same name for both left and
1741right labels), or explicitly hiding the left label (by preceeding it
1742with a dot), makes it possible to have right-justified text only.
1743
1744=over 4
1745
1746=item For example,
1747
1748B</File/{Open}{Open} Open-File-Action>
1749
1750=item or hiding it
1751
1752B</File/{.anylabel}{Open} Open-File-Action>
1753
1754=back
1755
1756X<menuBarRemove>
1757
1758=head2 Removing menus
1759
1760=over 4
1761
1762=item B<< -/*+ >>
1763
1764remove all menus from the menuBar, the same as B<[clear]>
1765
1766=item B<< -+I</path>menu+ >>
1767
1768remove menu
1769
1770=item B<< -+I</path>{item}+ >>
1771
1772remove item
1773
1774=item B<< -+I</path>{-} >>
1775
1776remove separator)
1777
1778=item B<-/path/menu/*>
1779
1780remove all items, separators and submenus from menu
1781
1782=back
1783
1784X<menuBarArrows>
1785
1786=head2 Quick Arrows
1787
1788The menus also provide a hook for I<quick arrows> to provide easier
1789user access. If nothing has been explicitly set, the default is to
1790emulate the curror keys. The syntax permits each arrow to be altered
1791individually or all four at once without re-entering their common
1792beginning/end text. For example, to explicitly associate cursor actions
1793with the arrows, any of the following forms could be used:
1794
1795=over 4
1796
1797=item B<< <r>+I<Right> >>
1798
1799=item B<< <l>+I<Left> >>
1800
1801=item B<< <u>+I<Up> >>
1802
1803=item B<< <d>+I<Down> >>
1804
1805Define actions for the respective arrow buttons
1806
1807=item B<< <b>+I<Begin> >>
1808
1809=item B<< <e>+I<End> >>
1810
1811Define common beginning/end parts for I<quick arrows> which used in
1812conjunction with the above <r> <l> <u> <d> constructs
1813
1814=back
1815
1816=over 4
1817
1818=item For example, define arrows individually,
1819
1820 <u>\E[A
1821
1822 <d>\E[B
1823
1824 <r>\E[C
1825
1826 <l>\E[D
1827
1828=item or all at once
1829
1830 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1831
1832=item or more compactly (factoring out common parts)
1833
1834 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1835
1836=back
1837
1838X<menuBarSummary>
1839
1840=head2 Command Summary
1841
1842A short summary of the most I<common> commands:
1843
1844=over 4
1845
1846=item [menu:name]
1847
1848use an existing named menuBar or start a new one
1849
1850=item [menu]
1851
1852use the current menuBar
1853
1854=item [title:string]
1855
1856set menuBar title
1857
1858=item [done]
1859
1860set menu access to readonly and, if reading from a file, signal EOF
1861
1862=item [done:name]
1863
1864if reading from a file using [read:file;name] signal EOF
1865
1866=item [rm:name]
1867
1868remove named menuBar(s)
1869
1870=item [rm] [rm:]
1871
1872remove current menuBar
1873
1874=item [rm*] [rm:*]
1875
1876remove all menuBar(s)
1877
1878=item [swap]
1879
1880swap top two menuBars
1881
1882=item [prev]
1883
1884access the previous menuBar
1885
1886=item [next]
1887
1888access the next menuBar
1889
1890=item [show]
1891
1892map menuBar
1893
1894=item [hide]
1895
1896unmap menuBar
1897
1898=item [pixmap;file]
1899
1900=item [pixmap;file;scaling]
1901
1902set a background pixmap
1903
1904=item [read:file]
1905
1906=item [read:file;name]
1907
1908read in a menu from a file
1909
1910=item [dump]
1911
1912dump out all menuBars to /tmp/rxvt-PID
1913
1914=item /
1915
1916access menuBar top level
1917
1918=item ./
1919
1920=item ../
1921
1922=item ../../
1923
1924access current or parent menu level
1925
1926=item /path/menu
1927
1928add/access menu
1929
1930=item /path/{-}
1931
1932add separator
1933
1934=item /path/{item}{rtext} action
1935
1936add/alter menu item
1937
1938=item -/*
1939
1940remove all menus from the menuBar
1941
1942=item -/path/menu
1943
1944remove menu items, separators and submenus from menu
1945
1946=item -/path/menu
1947
1948remove menu
1949
1950=item -/path/{item}
1951
1952remove item
1953
1954=item -/path/{-}
1955
1956remove separator
1957
1958=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1959
1960menu quick arrows
1961
1962=back
1963X<XPM> 1783X<XPM>
1964 1784
1965=head1 XPM 1785=head1 XPM
1966 1786
1967For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1787For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2153=end table 1973=end table
2154 1974
2155=head1 CONFIGURE OPTIONS 1975=head1 CONFIGURE OPTIONS
2156 1976
2157General hint: if you get compile errors, then likely your configuration 1977General hint: if you get compile errors, then likely your configuration
2158hasn't been tested well. Either try with --enable-everything or use the 1978hasn't been tested well. Either try with C<--enable-everything> or use
2159./reconf script as a base for experiments. ./reconf is used by myself, 1979the F<./reconf> script as a base for experiments. F<./reconf> is used by
2160so it should generally be a working config. Of course, you should always 1980myself, so it should generally be a working config. Of course, you should
2161report when a combination doesn't work, so it can be fixed. Marc Lehmann 1981always report when a combination doesn't work, so it can be fixed. Marc
2162<rxvt@schmorp.de>. 1982Lehmann <rxvt@schmorp.de>.
1983
1984All
2163 1985
2164=over 4 1986=over 4
2165 1987
2166=item --enable-everything 1988=item --enable-everything
2167 1989
2168Add support for all non-multichoice options listed in "./configure 1990Add (or remove) support for all non-multichoice options listed in "./configure
2169--help". Note that unlike other enable options this is order dependant. 1991--help".
1992
2170You can specify this and then disable options which this enables by 1993You can specify this and then disable options you do not like by
2171I<following> this with the appropriate commands. 1994I<following> this with the appropriate C<--disable-...> arguments,
1995or you can start with a minimal configuration by specifying
1996C<--disable-everything> and than adding just the C<--enable-...> arguments
1997you want.
2172 1998
2173=item --enable-xft 1999=item --enable-xft (default: enabled)
2174 2000
2175Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2001Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2176slower and require lots of memory, but as long as you don't use them, you 2002slower and require lots of memory, but as long as you don't use them, you
2177don't pay for them. 2003don't pay for them.
2178 2004
2179=item --enable-font-styles 2005=item --enable-font-styles (default: on)
2180 2006
2181Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2007Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182styles. The fonts can be set manually or automatically. 2008styles. The fonts can be set manually or automatically.
2183 2009
2184=item --with-codesets=NAME,... 2010=item --with-codesets=NAME,... (default: all)
2185 2011
2186Compile in support for additional codeset (encoding) groups (eu, vn are 2012Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187always compiled in, which includes most 8-bit character sets). These 2013are always compiled in, which includes most 8-bit character sets). These
2188codeset tables are currently only used for driving X11 core fonts, they 2014codeset tables are used for driving X11 core fonts, they are not required
2189are not required for Xft fonts. Compiling them in will make your binary 2015for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190bigger (together about 700kB), but it doesn't increase memory usage unless 2016replacement fonts more intelligently. Compiling them in will make your
2017binary bigger (all of together cost about 700kB), but it doesn't increase
2191you use an X11 font requiring one of these encodings. 2018memory usage unless you use a font requiring one of these encodings.
2192 2019
2193=begin table 2020=begin table
2194 2021
2195 all all available codeset groups 2022 all all available codeset groups
2196 zh common chinese encodings 2023 zh common chinese encodings
2199 jp_ext rarely used but big japanese encodings 2026 jp_ext rarely used but big japanese encodings
2200 kr korean encodings 2027 kr korean encodings
2201 2028
2202=end table 2029=end table
2203 2030
2204=item --enable-xim 2031=item --enable-xim (default: on)
2205 2032
2206Add support for XIM (X Input Method) protocol. This allows using 2033Add support for XIM (X Input Method) protocol. This allows using
2207alternative input methods (e.g. kinput2) and will also correctly 2034alternative input methods (e.g. kinput2) and will also correctly
2208set up the input for people using dead keys or compose keys. 2035set up the input for people using dead keys or compose keys.
2209 2036
2210=item --enable-unicode3 2037=item --enable-unicode3 (default: off)
2038
2039Recommended to stay off unless you really need non-BMP characters.
2211 2040
2212Enable direct support for displaying unicode codepoints above 2041Enable direct support for displaying unicode codepoints above
221365535 (the basic multilingual page). This increases storage 204265535 (the basic multilingual page). This increases storage
2214requirements per character from 2 to 4 bytes. X11 fonts do not yet 2043requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215support these extra characters, but Xft does. 2044support these extra characters, but Xft does.
2218even without this flag, but the number of such characters is 2047even without this flag, but the number of such characters is
2219limited to a view thousand (shared with combining characters, 2048limited to a view thousand (shared with combining characters,
2220see next switch), and right now rxvt-unicode cannot display them 2049see next switch), and right now rxvt-unicode cannot display them
2221(input/output and cut&paste still work, though). 2050(input/output and cut&paste still work, though).
2222 2051
2223=item --enable-combining 2052=item --enable-combining (default: on)
2224 2053
2225Enable automatic composition of combining characters into 2054Enable automatic composition of combining characters into
2226composite characters. This is required for proper viewing of text 2055composite characters. This is required for proper viewing of text
2227where accents are encoded as seperate unicode characters. This is 2056where accents are encoded as seperate unicode characters. This is
2228done by using precomposited characters when available or creating 2057done by using precomposited characters when available or creating
2229new pseudo-characters when no precomposed form exists. 2058new pseudo-characters when no precomposed form exists.
2230 2059
2231Without --enable-unicode3, the number of additional precomposed characters 2060Without --enable-unicode3, the number of additional precomposed
2232is rather limited (2048, if this is full, rxvt-unicode will use the 2061characters is somewhat limited (the 6400 private use characters will be
2233private use area, extending the number of combinations to 8448). With
2234--enable-unicode3, no practical limit exists. 2062(ab-)used). With --enable-unicode3, no practical limit exists.
2235 2063
2236This option will also enable storage (but not display) of characters 2064This option will also enable storage (but not display) of characters
2237beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2065beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2238 2066
2239The combining table also contains entries for arabic presentation forms, 2067The combining table also contains entries for arabic presentation forms,
2240but these are not currently used. Bug me if you want these to be used (and 2068but these are not currently used. Bug me if you want these to be used (and
2241tell me how these are to be used...). 2069tell me how these are to be used...).
2242 2070
2243=item --enable-fallback(=CLASS) 2071=item --enable-fallback(=CLASS) (default: Rxvt)
2244 2072
2245When reading resource settings, also read settings for class CLASS 2073When reading resource settings, also read settings for class CLASS. To
2246(default: Rxvt). To disable resource fallback use --disable-fallback. 2074disable resource fallback use --disable-fallback.
2247 2075
2248=item --with-res-name=NAME 2076=item --with-res-name=NAME (default: urxvt)
2249 2077
2250Use the given name (default: urxvt) as default application name when 2078Use the given name as default application name when
2251reading resources. Specify --with-res-name=rxvt to replace rxvt. 2079reading resources. Specify --with-res-name=rxvt to replace rxvt.
2252 2080
2253=item --with-res-class=CLASS 2081=item --with-res-class=CLASS /default: URxvt)
2254 2082
2255Use the given class (default: URxvt) as default application class 2083Use the given class as default application class
2256when reading resources. Specify --with-res-class=Rxvt to replace 2084when reading resources. Specify --with-res-class=Rxvt to replace
2257rxvt. 2085rxvt.
2258 2086
2259=item --enable-utmp 2087=item --enable-utmp (default: on)
2260 2088
2261Write user and tty to utmp file (used by programs like F<w>) at 2089Write user and tty to utmp file (used by programs like F<w>) at
2262start of rxvt execution and delete information when rxvt exits. 2090start of rxvt execution and delete information when rxvt exits.
2263 2091
2264=item --enable-wtmp 2092=item --enable-wtmp (default: on)
2265 2093
2266Write user and tty to wtmp file (used by programs like F<last>) at 2094Write user and tty to wtmp file (used by programs like F<last>) at
2267start of rxvt execution and write logout when rxvt exits. This 2095start of rxvt execution and write logout when rxvt exits. This
2268option requires --enable-utmp to also be specified. 2096option requires --enable-utmp to also be specified.
2269 2097
2270=item --enable-lastlog 2098=item --enable-lastlog (default: on)
2271 2099
2272Write user and tty to lastlog file (used by programs like 2100Write user and tty to lastlog file (used by programs like
2273F<lastlogin>) at start of rxvt execution. This option requires 2101F<lastlogin>) at start of rxvt execution. This option requires
2274--enable-utmp to also be specified. 2102--enable-utmp to also be specified.
2275 2103
2276=item --enable-xpm-background 2104=item --enable-xpm-background (default: on)
2277 2105
2278Add support for XPM background pixmaps. 2106Add support for XPM background pixmaps.
2279 2107
2280=item --enable-transparency 2108=item --enable-transparency (default: on)
2281 2109
2282Add support for inheriting parent backgrounds thus giving a fake 2110Add support for inheriting parent backgrounds thus giving a fake
2283transparency to the term. 2111transparency to the term.
2284 2112
2285=item --enable-fading 2113=item --enable-fading (default: on)
2286 2114
2287Add support for fading the text when focus is lost. 2115Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2288 2116
2289=item --enable-tinting 2117=item --enable-tinting (default: on)
2290 2118
2291Add support for tinting of transparent backgrounds. 2119Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2292 2120
2293=item --enable-menubar
2294
2295Add support for our menu bar system (this interacts badly with
2296dynamic locale switching currently).
2297
2298=item --enable-rxvt-scroll 2121=item --enable-rxvt-scroll (default: on)
2299 2122
2300Add support for the original rxvt scrollbar. 2123Add support for the original rxvt scrollbar.
2301 2124
2302=item --enable-next-scroll 2125=item --enable-next-scroll (default: on)
2303 2126
2304Add support for a NeXT-like scrollbar. 2127Add support for a NeXT-like scrollbar.
2305 2128
2306=item --enable-xterm-scroll 2129=item --enable-xterm-scroll (default: on)
2307 2130
2308Add support for an Xterm-like scrollbar. 2131Add support for an Xterm-like scrollbar.
2309 2132
2310=item --enable-plain-scroll 2133=item --enable-plain-scroll (default: on)
2311 2134
2312Add support for a very unobtrusive, plain-looking scrollbar that 2135Add support for a very unobtrusive, plain-looking scrollbar that
2313is the favourite of the rxvt-unicode author, having used it for 2136is the favourite of the rxvt-unicode author, having used it for
2314many years. 2137many years.
2315 2138
2316=item --enable-half-shadow 2139=item --enable-ttygid (default: off)
2317
2318Make shadows on the scrollbar only half the normal width & height.
2319only applicable to rxvt scrollbars.
2320
2321=item --enable-ttygid
2322 2140
2323Change tty device setting to group "tty" - only use this if 2141Change tty device setting to group "tty" - only use this if
2324your system uses this type of security. 2142your system uses this type of security.
2325 2143
2326=item --disable-backspace-key 2144=item --disable-backspace-key
2327 2145
2328Disable any handling of the backspace key by us - let the X server 2146Removes any handling of the backspace key by us - let the X server do it.
2147
2148=item --disable-delete-key
2149
2150Removes any handling of the delete key by us - let the X server
2329do it. 2151do it.
2330 2152
2331=item --disable-delete-key
2332
2333Disable any handling of the delete key by us - let the X server
2334do it.
2335
2336=item --disable-resources 2153=item --disable-resources
2337 2154
2338Remove all resources checking. 2155Removes any support for resource checking.
2339
2340=item --enable-xgetdefault
2341
2342Make resources checking via XGetDefault() instead of our small
2343version which only checks ~/.Xdefaults, or if that doesn't exist then
2344~/.Xresources.
2345
2346Please note that nowadays, things like XIM will automatically pull in and
2347use the full X resource manager, so the overhead of using it might be very
2348small, if nonexistant.
2349
2350=item --enable-strings
2351
2352Add support for our possibly faster memset() function and other
2353various routines, overriding your system's versions which may
2354have been hand-crafted in assembly or may require extra libraries
2355to link in. (this breaks ANSI-C rules and has problems on many
2356GNU/Linux systems).
2357 2156
2358=item --disable-swapscreen 2157=item --disable-swapscreen
2359 2158
2360Remove support for swap screen. 2159Remove support for secondary/swap screen.
2361 2160
2362=item --enable-frills 2161=item --enable-frills (default: on)
2363 2162
2364Add support for many small features that are not essential but nice to 2163Add support for many small features that are not essential but nice to
2365have. Normally you want this, but for very small binaries you may want to 2164have. Normally you want this, but for very small binaries you may want to
2366disable this. 2165disable this.
2367 2166
2368A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2167A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369in combination with other switches) is: 2168in combination with other switches) is:
2370 2169
2371 MWM-hints 2170 MWM-hints
2171 EWMH-hints (pid, utf8 names) and protocols (ping)
2372 seperate underline colour 2172 seperate underline colour (-underlineColor)
2373 settable border widths and borderless switch 2173 settable border widths and borderless switch (-w, -b, -bl)
2174 visual depth selection (-depth)
2374 settable extra linespacing 2175 settable extra linespacing /-lsp)
2375 extra window properties (e.g. UTF-8 window names and PID)
2376 iso-14755-2 and -3, and visual feedback 2176 iso-14755-2 and -3, and visual feedback
2377 backindex and forwardindex escape sequence
2378 window op and locale change escape sequences
2379 tripleclickwords 2177 tripleclickwords (-tcw)
2380 settable insecure mode 2178 settable insecure mode (-insecure)
2381 keysym remapping support 2179 keysym remapping support
2180 cursor blinking and underline cursor (-cb, -uc)
2181 XEmbed support (-embed)
2182 user-pty (-pty-fd)
2183 hold on exit (-hold)
2184 skip builtin block graphics (-sbg)
2382 2185
2186It also enabled some non-essential features otherwise disabled, such as:
2187
2188 some round-trip time optimisations
2189 nearest color allocation on pseudocolor screens
2190 UTF8_STRING supporr for selection
2191 sgr modes 90..97 and 100..107
2192 backindex and forwardindex escape sequences
2193 view change/zero scorllback esacpe sequences
2194 locale switching escape sequence
2195 window op and some xterm/OSC escape sequences
2196 rectangular selections
2197 trailing space removal for selections
2198 verbose X error handling
2199
2383=item --enable-iso14755 2200=item --enable-iso14755 (default: on)
2384 2201
2385Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2202Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2203F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2387C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2204C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2388this switch. 2205this switch.
2389 2206
2390=item --enable-keepscrolling 2207=item --enable-keepscrolling (default: on)
2391 2208
2392Add support for continual scrolling of the display when you hold 2209Add support for continual scrolling of the display when you hold
2393the mouse button down on a scrollbar arrow. 2210the mouse button down on a scrollbar arrow.
2394 2211
2395=item --enable-mousewheel 2212=item --enable-mousewheel (default: on)
2396 2213
2397Add support for scrolling via mouse wheel or buttons 4 & 5. 2214Add support for scrolling via mouse wheel or buttons 4 & 5.
2398 2215
2399=item --enable-slipwheeling 2216=item --enable-slipwheeling (default: on)
2400 2217
2401Add support for continual scrolling (using the mouse wheel as an 2218Add support for continual scrolling (using the mouse wheel as an
2402accelerator) while the control key is held down. This option 2219accelerator) while the control key is held down. This option
2403requires --enable-mousewheel to also be specified. 2220requires --enable-mousewheel to also be specified.
2404 2221
2405=item --disable-new-selection 2222=item --disable-new-selection
2406 2223
2407Remove support for mouse selection style like that of xterm. 2224Remove support for mouse selection style like that of xterm.
2408 2225
2409=item --enable-dmalloc 2226=item --enable-dmalloc (default: off)
2410 2227
2411Use Gray Watson's malloc - which is good for debugging See 2228Use Gray Watson's malloc - which is good for debugging See
2412http://www.letters.com/dmalloc/ for details If you use either this or the 2229http://www.letters.com/dmalloc/ for details If you use either this or the
2413next option, you may need to edit src/Makefile after compiling to point 2230next option, you may need to edit src/Makefile after compiling to point
2414DINCLUDE and DLIB to the right places. 2231DINCLUDE and DLIB to the right places.
2415 2232
2416You can only use either this option and the following (should 2233You can only use either this option and the following (should
2417you use either) . 2234you use either) .
2418 2235
2419=item --enable-dlmalloc 2236=item --enable-dlmalloc (default: off)
2420 2237
2421Use Doug Lea's malloc - which is good for a production version 2238Use Doug Lea's malloc - which is good for a production version
2422See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2239See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2423 2240
2424=item --enable-smart-resize 2241=item --enable-smart-resize (default: on)
2425 2242
2426Add smart growth/shrink behaviour when changing font size via from hot 2243Add smart growth/shrink behaviour when changing font size via hot
2427keys. This should keep in a fixed position the rxvt corner which is 2244keys. This should keep the window corner which is closest to a corner of
2428closest to a corner of the screen. 2245the screen in a fixed position.
2429 2246
2430=item --enable-cursor-blink
2431
2432Add support for a blinking cursor.
2433
2434=item --enable-pointer-blank 2247=item --enable-pointer-blank (default: on)
2435 2248
2436Add support to have the pointer disappear when typing or inactive. 2249Add support to have the pointer disappear when typing or inactive.
2437 2250
2438=item --with-name=NAME 2251=item --enable-perl (default: on)
2439 2252
2253Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2254manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2255in F<src/perl-ext/> for the extensions that are installed by default. The
2256perl interpreter that is used can be specified via the C<PERL> environment
2257variable when running configure.
2258
2259=item --with-name=NAME (default: urxvt)
2260
2440Set the basename for the installed binaries (default: C<urxvt>, resulting 2261Set the basename for the installed binaries, resulting
2441in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2262in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2442C<rxvt>. 2263C<rxvt>.
2443 2264
2444=item --with-term=NAME 2265=item --with-term=NAME (default: rxvt-unicode)
2445 2266
2446Change the environmental variable for the terminal to NAME (default 2267Change the environmental variable for the terminal to NAME.
2447C<rxvt-unicode>)
2448 2268
2449=item --with-terminfo=PATH 2269=item --with-terminfo=PATH
2450 2270
2451Change the environmental variable for the path to the terminfo tree to 2271Change the environmental variable for the path to the terminfo tree to
2452PATH. 2272PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines