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.34 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.95 by root, Mon Jan 30 22:49:30 2006 UTC

1=head1 NAME 1=head1 NAME
2 2
3RXVT REFERENCE - FAQ, command sequences and other background information 3RXVT REFERENCE - FAQ, command sequences and other background information
4 4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
5=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
6 26
7=over 4 27=over 4
8 28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
68
69=item Why doesn't rxvt-unicode read my resources?
70
71Well, why, indeed? It does, in a way very similar to other X
72applications. Most importantly, this means that if you or your OS loads
73resources into the X display (the right way to do it), rxvt-unicode will
74ignore any resource files in your home directory. It will only read
75F<$HOME/.Xdefaults> when no resources are attached to the display.
76
77If you have or use an F<$HOME/.Xresources> file, chances are that
78resources are loaded into your X-server. In this case, you have to
79re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
80
81Also consider the form resources have to use:
82
83 URxvt.resource: value
84
85If you want to use another form (there are lots of different ways of
86specifying resources), make sure you understand wether and why it
87works. If unsure, use the form above.
88
89=item I can't get transparency working, what am I doing wrong?
90
91First of all, transparency isn't officially supported in rxvt-unicode, so
92you are mostly on your own. Do not bug the author about it (but you may
93bug everybody else). Also, if you can't get it working consider it a rite
94of passage, and you failed.
95
96Here are three ways to get transparency. B<Do> read the manpage and option
97descriptions for the programs mentioned and rxvt-unicode. Really, do it!
98
991. Use inheritPixmap:
100
101 Esetroot wallpaper.jpg
102 @@RXVT_NAME@@ -ip -tint red -sh 40
103
104That works. If you think it doesn't, you lack transparency and tinting
105support, or you are unable to read.
106
1072. Use a simple pixmap and emulate pseudo-transparency. This enables you
108to use effects other than tinting and shading: Just shade/tint/whatever
109your picture with gimp:
110
111 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
112 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
113
114That works. If you think it doesn't, you lack XPM and Perl support, or you
115are unable to read.
116
1173. Use an ARGB visual:
118
119 @@RXVT_NAME@@ -depth 432 -fg grey90 -bg rgba:0000/0000/0000/c000
120
121This requires XFT support, and support form your X-server. If that doesn't
122work for you, blame Xorg and Keith Packard. ARGB visuals aren't there yet,
123no matter what they claim. Rxvt-Unicode contains the neccessary bugfixes
124and workarounds for Xft and Xlib to make it work.
125
126=item Isn't rxvt supposed to be small? Don't all those features bloat?
127
128I often get asked about this, and I think, no, they didn't cause extra
129bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
130that the urxvt binary is larger (due to some encoding tables always being
131compiled in), but it actually uses less memory (RSS) after startup. Even
132with C<--disable-everything>, this comparison is a bit unfair, as many
133features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
134already in use in this mode.
135
136 text data bss drs rss filename
137 98398 1664 24 15695 1824 rxvt --disable-everything
138 188985 9048 66616 18222 1788 urxvt --disable-everything
139
140When you C<--enable-everything> (which _is_ unfair, as this involves xft
141and full locale/XIM support which are quite bloaty inside libX11 and my
142libc), the two diverge, but not unreasnobaly so.
143
144 text data bss drs rss filename
145 163431 2152 24 20123 2060 rxvt --enable-everything
146 1035683 49680 66648 29096 3680 urxvt --enable-everything
147
148The very large size of the text section is explained by the east-asian
149encoding tables, which, if unused, take up disk space but nothing else
150and can be compiled out unless you rely on X11 core fonts that use those
151encodings. The BSS size comes from the 64k emergency buffer that my c++
152compiler allocates (but of course doesn't use unless you are out of
153memory). Also, using an xft font instead of a core font immediately adds a
154few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
155not used.
156
157Of course, due to every character using two or four bytes instead of one,
158a large scrollback buffer will ultimately make rxvt-unicode use more
159memory.
160
161Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
162still fares rather well. And compared to some monsters like gnome-terminal
163(21152k + extra 4204k in separate processes) or konsole (22200k + extra
16443180k in daemons that stay around after exit, plus half a minute of
165startup time, including the hundreds of warnings it spits out), it fares
166extremely well *g*.
167
168=item Why C++, isn't that unportable/bloated/uncool?
169
170Is this a question? :) It comes up very often. The simple answer is: I had
171to write it, and C++ allowed me to write and maintain it in a fraction
172of the time and effort (which is a scarce resource for me). Put even
173shorter: It simply wouldn't exist without C++.
174
175My personal stance on this is that C++ is less portable than C, but in
176the case of rxvt-unicode this hardly matters, as its portability limits
177are defined by things like X11, pseudo terminals, locale support and unix
178domain sockets, which are all less portable than C++ itself.
179
180Regarding the bloat, see the above question: It's easy to write programs
181in C that use gobs of memory, an certainly possible to write programs in
182C++ that don't. C++ also often comes with large libraries, but this is
183not necessarily the case with GCC. Here is what rxvt links against on my
184system with a minimal config:
185
186 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
187 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
188 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
189 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
190
191And here is rxvt-unicode:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
195 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
196 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
197 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
198
199No large bloated libraries (of course, none were linked in statically),
200except maybe libX11 :)
201
202=item Does it support tabs, can I have a tabbed rxvt-unicode?
203
204Beginning with version 7.3, there is a perl extension that implements a
205simple tabbed terminal. It is installed by default, so any of these should
206give you tabs:
207
208 @@RXVT_NAME@@ -pe tabbed
209
210 URxvt.perl-ext-common: default,tabbed
211
212It will also work fine with tabbing functionality of many window managers
213or similar tabbing programs, and its embedding-features allow it to be
214embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
215the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
216(murxvt) terminal as an example embedding application.
217
9=item How do I know which rxvt-unicode version I'm using? 218=item How do I know which rxvt-unicode version I'm using?
10 219
11The version number is displayed with the usage (-h). Also the escape 220The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 221sequence C<ESC [ 8 n> sets the window title to the version number. When
222using the @@RXVT_NAME@@c client, the version displayed is that of the
223daemon.
224
225=item I am using Debian GNU/Linux and have a problem...
226
227The Debian GNU/Linux package of rxvt-unicode in sarge contains large
228patches that considerably change the behaviour of rxvt-unicode (but
229unfortunately this notice has been removed). Before reporting a bug to
230the original rxvt-unicode author please download and install the genuine
231version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
232the problem. If you cannot, chances are that the problems are specific to
233Debian GNU/Linux, in which case it should be reported via the Debian Bug
234Tracking System (use C<reportbug> to report the bug).
235
236For other problems that also affect the Debian package, you can and
237probably should use the Debian BTS, too, because, after all, it's also a
238bug in the Debian version and it serves as a reminder for other users that
239might encounter the same issue.
240
241=item I am maintaining rxvt-unicode for distribution/OS XXX, any
242recommendation?
243
244You should build one binary with the default options. F<configure>
245now enables most useful options, and the trend goes to making them
246runtime-switchable, too, so there is usually no drawback to enbaling them,
247except higher disk and possibly memory usage. The perl interpreter should
248be enabled, as important functionality (menus, selection, likely more in
249the future) depends on it.
250
251You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
252system-wide (except maybe with C<defaults>). This will result in useful
253behaviour. If your distribution aims at low memory, add an empty
254C<perl-ext-common> resource to the app-defaults file. This will keep the
255perl interpreter disabled until the user enables it.
256
257If you can/want build more binaries, I recommend building a minimal
258one with C<--disable-everything> (very useful) and a maximal one with
259C<--enable-everything> (less useful, it will be very big due to a lot of
260encodings built-in that increase download times and are rarely used).
261
262=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
263
264It should be, starting with release 7.1. You are encouraged to properly
265install urxvt with privileges necessary for your OS now.
266
267When rxvt-unicode detects that it runs setuid or setgid, it will fork
268into a helper process for privileged operations (pty handling on some
269systems, utmp/wtmp/lastlog handling on others) and drop privileges
270immediately. This is much safer than most other terminals that keep
271privileges while running (but is more relevant to urxvt, as it contains
272things as perl interpreters, which might be "helpful" to attackers).
273
274This forking is done as the very first within main(), which is very early
275and reduces possible bugs to initialisation code run before main(), or
276things like the dynamic loader of your system, which should result in very
277little risk.
13 278
14=item When I log-in to another system it tells me about missing terminfo data? 279=item When I log-in to another system it tells me about missing terminfo data?
15 280
16The terminal description used by rxvt-unicode is not as widely available 281The 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). 282as 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 293C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different 294problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice 295colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though. 296quick-and-dirty workaround for rare cases, though.
32 297
33If you always want to do this you can either recompile rxvt-unicode with 298If you always want to do this (and are fine with the consequences) you
34the desired TERM value or use a resource to set it: 299can either recompile rxvt-unicode with the desired TERM value or use a
300resource to set it:
35 301
36 URxvt.termName: rxvt 302 URxvt.termName: rxvt
37 303
38If you don't plan to use B<rxvt> (quite common...) you could also replace 304If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one. 305the rxvt terminfo file with the rxvt-unicode one.
40 306
307=item C<tic> outputs some error when compiling the terminfo entry.
308
309Most likely it's the empty definition for C<enacs=>. Just replace it by
310C<enacs=\E[0@> and try again.
311
312=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
313
41=item I need a termcap file entry. 314=item I need a termcap file entry.
315
316One reason you might want this is that some distributions or operating
317systems still compile some programs using the long-obsoleted termcap
318library (Fedora Core's bash is one example) and rely on a termcap entry
319for C<rxvt-unicode>.
42 320
43You could use rxvt's termcap entry with resonable results in many cases. 321You 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 322You can also create a termcap entry by using terminfo's infocmp program
45like this: 323like this:
46 324
47 infocmp -C rxvt-unicode 325 infocmp -C rxvt-unicode
48 326
49OR you could this termcap entry: 327Or you could use this termcap entry, generated by the command above:
50 328
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 329 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\ 330 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\ 331 :co#80:it#8:li#24:lm#0:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 332 :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:\ 333 :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:\ 334 :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:\ 335 :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:\ 336 :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[@:\ 337 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
338 :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:\ 339 :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~:\ 340 :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~:\ 341 :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:\ 342 :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=:\ 343 :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:\ 344 :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:\ 345 :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:\ 346 :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:\ 347 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h: 348 :vs=\E[?25h:
70 349
71=item Why does C<ls> no longer have coloured output? 350=item Why does C<ls> no longer have coloured output?
72 351
73The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 352The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
96GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 375GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
97file, so you will need to install it on your own (See the question B<When 376file, so you will need to install it on your own (See the question B<When
98I log-in to another system it tells me about missing terminfo data?> on 377I log-in to another system it tells me about missing terminfo data?> on
99how to do this). 378how to do this).
100 379
380=item My numerical keypad acts weird and generates differing output?
381
382Some Debian GNUL/Linux users seem to have this problem, although no
383specific details were reported so far. It is possible that this is caused
384by the wrong C<TERM> setting, although the details of wether and how
385this can happen are unknown, as C<TERM=rxvt> should offer a compatible
386keymap. See the answer to the previous question, and please report if that
387helped.
388
101=item Rxvt-unicode does not seem to understand the selected encoding? 389=item Rxvt-unicode does not seem to understand the selected encoding?
102 390
103=item Unicode does not seem to work? 391=item Unicode does not seem to work?
104 392
105If you encounter strange problems like typing an accented character but 393If you encounter strange problems like typing an accented character but
107subtly garbled, then you should check your locale settings. 395subtly garbled, then you should check your locale settings.
108 396
109Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 397Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
110programs. Often rxvt-unicode is started in the C<C> locale, while the 398programs. Often rxvt-unicode is started in the C<C> locale, while the
111login script running within the rxvt-unicode window changes the locale to 399login script running within the rxvt-unicode window changes the locale to
112sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. 400something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
113 401
114The best thing is to fix your startup environment, as you will likely run 402The best thing is to fix your startup environment, as you will likely run
115into other problems. If nothing works you can try this in your .profile. 403into other problems. If nothing works you can try this in your .profile.
116 404
117 printf '\e]701;%s\007' "$LC_CTYPE" 405 printf '\e]701;%s\007' "$LC_CTYPE"
118 406
119If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 407If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
120supported on your systems. Some systems have a C<locale> command which 408supported on your systems. Some systems have a C<locale> command which
121displays this. If it displays sth. like: 409displays this (also, C<perl -e0> can be used to check locale settings, as
410it will complain loudly if it cannot set the locale). If it displays something
411like:
122 412
123 locale: Cannot set LC_CTYPE to default locale: ... 413 locale: Cannot set LC_CTYPE to default locale: ...
124 414
125Then the locale you specified is not supported on your system. 415Then the locale you specified is not supported on your system.
126 416
137your system/os) have specified does not cover all the characters you want 427your system/os) have specified does not cover all the characters you want
138to display. 428to display.
139 429
140B<rxvt-unicode> makes a best-effort try at finding a replacement 430B<rxvt-unicode> makes a best-effort try at finding a replacement
141font. Often the result is fine, but sometimes the chosen font looks 431font. Often the result is fine, but sometimes the chosen font looks
142bad. Many fonts have totally strange characters that don't resemble the 432bad/ugly/wrong. Some fonts have totally strange characters that don't
143correct glyph at all, and rxvt-unicode lacks the artificial intelligence 433resemble the correct glyph at all, and rxvt-unicode lacks the artificial
144to detect that a specific glyph is wrong: it has to believe the font that 434intelligence to detect that a specific glyph is wrong: it has to believe
145the characters it contains indeed look correct. 435the font that the characters it claims to contain indeed look correct.
146 436
147In that case, select a font of your taste and add it to the font list, 437In that case, select a font of your taste and add it to the font list,
148e.g.: 438e.g.:
149 439
150 @@RXVT_NAME@@ -fn basefont,font2,font3... 440 @@RXVT_NAME@@ -fn basefont,font2,font3...
152When rxvt-unicode sees a character, it will first look at the base 442When rxvt-unicode sees a character, it will first look at the base
153font. If the base font does not contain the character, it will go to the 443font. If the base font does not contain the character, it will go to the
154next font, and so on. Specifying your own fonts will also speed up this 444next font, and so on. Specifying your own fonts will also speed up this
155search and use less resources within rxvt-unicode and the X-server. 445search and use less resources within rxvt-unicode and the X-server.
156 446
157The only limitation is that all the fonts must not be larger than the base 447The only limitation is that none of the fonts may be larger than the base
158font, as the base font defines the principal cell size, which must be the 448font, as the base font defines the terminal character cell size, which
159same due to the way terminals work. 449must be the same due to the way terminals work.
160 450
161=item Why do some chinese characters look so different than others? 451=item Why do some chinese characters look so different than others?
162 452
163This is because there is a difference between script and language -- 453This is because there is a difference between script and language --
164rxvt-unicode does not know which language the text that is output 454rxvt-unicode does not know which language the text that is output is,
165is, as it only knows the unicode character codes. If rxvt-unicode 455as it only knows the unicode character codes. If rxvt-unicode first
166first sees a japanese character, it might choose a japanese font for 456sees a japanese/chinese character, it might choose a japanese font for
167it. Subsequent japanese characters will take that font. Now, many chinese 457display. Subsequent japanese characters will use that font. Now, many
168characters aren't represented in japanese fonts, so when the first 458chinese characters aren't represented in japanese fonts, so when the first
169non-japanese character comes up, rxvt-unicode will look for a chinese font 459non-japanese character comes up, rxvt-unicode will look for a chinese font
170-- unfortunately at this point, it will still use the japanese font for 460-- unfortunately at this point, it will still use the japanese font for
171japanese characters that are also chinese. 461chinese characters that are also in the japanese font.
172 462
173The workaround is easy: just tag a chinese font at the end of your font 463The workaround is easy: just tag a chinese font at the end of your font
174list (see the previous question). The key is to view the font list as 464list (see the previous question). The key is to view the font list as
175a preference list: If you expect more japanese, list a japanese font 465a preference list: If you expect more japanese, list a japanese font
176first. If you expect more chinese, put a chinese font first. 466first. If you expect more chinese, put a chinese font first.
177 467
178In the future it might be possible to switch preferences at runtime (the 468In the future it might be possible to switch language preferences at
179internal data structure has no problem with using different fonts for 469runtime (the internal data structure has no problem with using different
180the same character at the same time, but no interface for this has been 470fonts for the same character at the same time, but no interface for this
181designed yet). 471has been designed yet).
472
473Until then, you might get away with switching fonts at runtime (see L<Can
474I switch the fonts at runtime?> later in this document).
182 475
183=item Why does rxvt-unicode sometimes leave pixel droppings? 476=item Why does rxvt-unicode sometimes leave pixel droppings?
184 477
185Most fonts were not designed for terminal use, which means that character 478Most fonts were not designed for terminal use, which means that character
186size varies a lot. A font that is otherwise fine for terminal use might 479size varies a lot. A font that is otherwise fine for terminal use might
199the C<-lsp> option to give the font more height. If that doesn't work, you 492the C<-lsp> option to give the font more height. If that doesn't work, you
200might be forced to use a different font. 493might be forced to use a different font.
201 494
202All of this is not a problem when using X11 core fonts, as their bounding 495All of this is not a problem when using X11 core fonts, as their bounding
203box data is correct. 496box data is correct.
497
498=item On Solaris 9, many line-drawing characters are too wide.
499
500Seems to be a known bug, read
501L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
502following ugly workaround to get non-double-wide-characters working:
503
504 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
204 505
205=item My Compose (Multi_key) key is no longer working. 506=item My Compose (Multi_key) key is no longer working.
206 507
207The most common causes for this are that either your locale is not set 508The most common causes for this are that either your locale is not set
208correctly, or you specified a B<preeditStyle> that is not supported by 509correctly, or you specified a B<preeditStyle> that is not supported by
222codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 523codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
223character and so on. 524character and so on.
224 525
225=item How can I keep rxvt-unicode from using reverse video so much? 526=item How can I keep rxvt-unicode from using reverse video so much?
226 527
227First of all, make sure you are running with the right terminfo 528First of all, make sure you are running with the right terminal settings
228(C<urxvt>), which will get rid of most of these effects. Then make sure 529(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
229you have specified colours for italic and bold, as otherwise rxvt-unicode 530make sure you have specified colours for italic and bold, as otherwise
230might use reverse video to simulate the effect: 531rxvt-unicode might use reverse video to simulate the effect:
231 532
232 URxvt*colorBD: white 533 URxvt.colorBD: white
233 URxvt*colorIT: green 534 URxvt.colorIT: green
234 535
235=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 536=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
236 537
237For some unexplainable reason, some programs (i.e. irssi) assume a very 538For some unexplainable reason, some rare programs assume a very weird
238weird colour palette when confronted with a terminal with more than the 539colour palette when confronted with a terminal with more than the standard
239standard 8 colours (rxvt-unicode supports 88). The right fix is, of 5408 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
240course, to fix these programs not to assume non-ISO colours without very 541these programs not to assume non-ISO colours without very good reasons.
241good reasons.
242 542
243In the meantime, you can either edit your C<urxvt> terminfo definition to 543In the meantime, you can either edit your C<rxvt-unicode> terminfo
244only claim 8 colour support or use C<TERM=rxvt>, which will fix colours 544definition to only claim 8 colour support or use C<TERM=rxvt>, which will
245but keep you from using other rxvt-unicode features. 545fix colours but keep you from using other rxvt-unicode features.
246 546
247=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 547=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
248 548
249Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 549Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
250in your compile environment, or an implementation that implements it, 550in your compile environment, or an implementation that implements it,
251wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 551wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
252B<wchar_t> is represented as unicode. 552B<wchar_t> is represented as unicode.
253 553
254As you might have guessed, FreeBSD does neither define this symobl nor 554As you might have guessed, FreeBSD does neither define this symobl nor
255does it support it. Instead, it uses it's own internal representation of 555does it support it. Instead, it uses it's own internal representation of
256B<wchar_t>. This is, of course, completely legal. 556B<wchar_t>. This is, of course, completely fine with respect to standards.
257 557
558However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
559C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
560
258However, C<__STDC_ISO_10646__> is the only sane way to support 561C<__STDC_ISO_10646__> is the only sane way to support multi-language
259multi-language apps in an OS, as using a locale-dependent (and 562apps in an OS, as using a locale-dependent (and non-standardized)
260non-standardized) representation of B<wchar_t> makes it impossible to 563representation of B<wchar_t> makes it impossible to convert between
261convert between B<wchar_t> (as used by X11 and your applications) and any 564B<wchar_t> (as used by X11 and your applications) and any other encoding
262other encoding without implementing OS-specific-wrappers for each and 565without implementing OS-specific-wrappers for each and every locale. There
263every locale. There simply are no APIs to convert B<wchar_t> into anything 566simply are no APIs to convert B<wchar_t> into anything except the current
264except the current locale encoding. 567locale encoding.
265 568
266Some applications (such as the formidable B<mlterm>) work around this 569Some applications (such as the formidable B<mlterm>) work around this
267by carrying their own replacement functions for character set handling 570by carrying their own replacement functions for character set handling
268with them, and either implementing OS-dependent hacks or doing multiple 571with them, and either implementing OS-dependent hacks or doing multiple
269conversions (which is slow and unreliable in case the OS implements 572conversions (which is slow and unreliable in case the OS implements
270encodings slightly different than the terminal emulator). 573encodings slightly different than the terminal emulator).
271 574
272The rxvt-unicode author insists that the right way to fix this is in the 575The rxvt-unicode author insists that the right way to fix this is in the
273system libraries once and for all, instead of forcing every app to carry 576system libraries once and for all, instead of forcing every app to carry
274complete replacements. 577complete replacements for them :)
578
579=item I use Solaris 9 and it doesn't compile/work/etc.
580
581Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
582problems with C<wcwidth> and a compile problem.
583
584=item How can I use rxvt-unicode under cygwin?
585
586rxvt-unicode should compile and run out of the box on cygwin, using
587the X11 libraries that come with cygwin. libW11 emulation is no
588longer supported (and makes no sense, either, as it only supported a
589single font). I recommend starting the X-server in C<-multiwindow> or
590C<-rootless> mode instead, which will result in similar look&feel as the
591old libW11 emulation.
592
593At the time of this writing, cygwin didn't seem to support any multi-byte
594encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
595to 8-bit encodings.
275 596
276=item How does rxvt-unicode determine the encoding to use? 597=item How does rxvt-unicode determine the encoding to use?
277 598
278=item Is there an option to switch encodings? 599=item Is there an option to switch encodings?
279 600
281specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 602specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
282UTF-8 or any other encodings with respect to terminal I/O. 603UTF-8 or any other encodings with respect to terminal I/O.
283 604
284The reasons is that there exists a perfectly fine mechanism for selecting 605The reasons is that there exists a perfectly fine mechanism for selecting
285the encoding, doing I/O and (most important) communicating this to all 606the encoding, doing I/O and (most important) communicating this to all
286applications so everybody agrees on character properties such as width and 607applications so everybody agrees on character properties such as width
287code number. This mechanism is the I<locale>. 608and code number. This mechanism is the I<locale>. Applications not using
609that info will have problems (for example, C<xterm> gets the width of
610characters wrong as it uses it's own, locale-independent table under all
611locales).
288 612
289Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 613Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
290programs doing the same (that is, most) will automatically agree in the 614programs doing the same (that is, most) will automatically agree in the
291interpretation of characters. 615interpretation of characters.
292 616
299C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms 623C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
300(i.e. C<de> or C<german>) are also common. 624(i.e. C<de> or C<german>) are also common.
301 625
302Rxvt-unicode ignores all other locale categories, and except for 626Rxvt-unicode ignores all other locale categories, and except for
303the encoding, ignores country or language-specific settings, 627the encoding, ignores country or language-specific settings,
304i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode. 628i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
629rxvt-unicode.
305 630
306If you want to use a specific encoding you have to make sure you start 631If you want to use a specific encoding you have to make sure you start
307rxvt-unicode with the correct C<LC_CTYPE> category. 632rxvt-unicode with the correct C<LC_CTYPE> category.
308 633
309=item Can I switch locales at runtime? 634=item Can I switch locales at runtime?
310 635
311Yes, using an escape sequence. Try sth. like this, which sets 636Yes, using an escape sequence. Try something like this, which sets
312rxvt-unicode's idea of C<LC_CTYPE>. 637rxvt-unicode's idea of C<LC_CTYPE>.
313 638
314 printf '\e]701;%s\007' ja_JP.SJIS 639 printf '\e]701;%s\007' ja_JP.SJIS
315 640
316See also the previous question. 641See also the previous answer.
317 642
318Sometimes this capability is rather handy when you want to work in one 643Sometimes this capability is rather handy when you want to work in
319locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For 644one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
320example, I use this script to start C<xjdic>, which first switches to a 645(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
321locale supported by xjdic and back later: 646first switches to a locale supported by xjdic and back later:
322 647
323 printf '\e]701;%s\007' ja_JP.SJIS 648 printf '\e]701;%s\007' ja_JP.SJIS
324 xjdic -js 649 xjdic -js
325 printf '\e]701;%s\007' de_DE.UTF-8 650 printf '\e]701;%s\007' de_DE.UTF-8
326 651
652You can also use xterm's C<luit> program, which usually works fine, except
653for some locales where character width differs between program- and
654rxvt-unicode-locales.
655
327=item Can I switch the fonts at runtime? 656=item Can I switch the fonts at runtime?
328 657
329Yes, using an escape sequence. Try sth. like this, which has the same 658Yes, using an escape sequence. Try something like this, which has the same
330effect as using the C<-fn> switch, and takes effect immediately: 659effect as using the C<-fn> switch, and takes effect immediately:
331 660
332 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 661 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
333 662
334This is useful if you e.g. work primarily with japanese (and prefer a 663This is useful if you e.g. work primarily with japanese (and prefer a
339 668
340=item Why do italic characters look as if clipped? 669=item Why do italic characters look as if clipped?
341 670
342Many fonts have difficulties with italic characters and hinting. For 671Many fonts have difficulties with italic characters and hinting. For
343example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 672example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
344Mono> completely fails in it's italic face. A workaround is to enable 673Mono> completely fails in it's italic face. A workaround might be to
345freetype autohinting, i.e. like this: 674enable freetype autohinting, i.e. like this:
346 675
347 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 676 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
348 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 677 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
349 678
350=item My input method wants <some encoding> but I want UTF-8, what can I do? 679=item My input method wants <some encoding> but I want UTF-8, what can I do?
351 680
352You can specify separate locales for the input method and the rest of the 681You can specify separate locales for the input method and the rest of the
353terminal, using the resource C<imlocale>: 682terminal, using the resource C<imlocale>:
354 683
355 URxvt*imlocale: ja_JP.EUC-JP 684 URxvt.imlocale: ja_JP.EUC-JP
356 685
357Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 686Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
358use your input method. Please note, however, that you will not be able to 687use your input method. Please note, however, that you will not be able to
359input characters outside C<EUC-JP> in a normal way then, as your input 688input characters outside C<EUC-JP> in a normal way then, as your input
360method limits you. 689method limits you.
361 690
691=item Rxvt-unicode crashes when the X Input Method changes or exits.
692
693Unfortunately, this is unavoidable, as the XIM protocol is racy by
694design. Applications can avoid some crashes at the expense of memory
695leaks, and Input Methods can avoid some crashes by careful ordering at
696exit time. B<kinput2> (and derived input methods) generally succeeds,
697while B<SCIM> (or similar input methods) fails. In the end, however,
698crashes cannot be completely avoided even if both sides cooperate.
699
700So the only workaround is not to kill your Input Method Servers.
701
362=item Rxvt-unicode uses gobs of memory, how can I reduce that? 702=item Rxvt-unicode uses gobs of memory, how can I reduce that?
363 703
364Rxvt-unicode tries to obey the rule of not charging you for sth. you 704Rxvt-unicode tries to obey the rule of not charging you for something you
365don't use. One thing you should try is to configure out all settings that 705don't use. One thing you should try is to configure out all settings that
366you don't need, for example, Xft support is a resource hog by design, 706you don't need, for example, Xft support is a resource hog by design,
367when used. Compiling it out ensures that no Xft font will be loaded 707when used. Compiling it out ensures that no Xft font will be loaded
368accidentally when rxvt-unicode tries to find a font for your characters. 708accidentally when rxvt-unicode tries to find a font for your characters.
369 709
376 716
377=item Can I speed up Xft rendering somehow? 717=item Can I speed up Xft rendering somehow?
378 718
379Yes, the most obvious way to speed it up is to avoid Xft entirely, as 719Yes, the most obvious way to speed it up is to avoid Xft entirely, as
380it is simply slow. If you still want Xft fonts you might try to disable 720it is simply slow. If you still want Xft fonts you might try to disable
381antialiasing (by appending C<:antialiasing=false>), which saves lots of 721antialiasing (by appending C<:antialias=false>), which saves lots of
382memory and also speeds up rendering considerably. 722memory and also speeds up rendering considerably.
383 723
384=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 724=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385 725
386Rxvt-unicode will use whatever you specify as a font. If it needs to 726Rxvt-unicode will use whatever you specify as a font. If it needs to
395 735
396Make sure that mouse reporting is actually turned off since killing 736Make sure that mouse reporting is actually turned off since killing
397some editors prematurely may leave the mouse in mouse report mode. I've 737some editors prematurely may leave the mouse in mouse report mode. I've
398heard that tcsh may use mouse reporting unless it otherwise specified. A 738heard that tcsh may use mouse reporting unless it otherwise specified. A
399quick check is to see if cut/paste works when the Alt or Shift keys are 739quick check is to see if cut/paste works when the Alt or Shift keys are
400depressed. See @@RXVT_NAME@@(7) 740depressed.
401 741
402=item What's with this bold/blink stuff? 742=item What's with this bold/blink stuff?
403 743
404If no bold colour is set via C<colorBD:>, bold will invert text using the 744If no bold colour is set via C<colorBD:>, bold will invert text using the
405standard foreground colour. 745standard foreground colour.
422resources (or as long-options). 762resources (or as long-options).
423 763
424Here are values that are supposed to resemble a VGA screen, 764Here are values that are supposed to resemble a VGA screen,
425including the murky brown that passes for low-intensity yellow: 765including the murky brown that passes for low-intensity yellow:
426 766
427 URxvt*color0: #000000 767 URxvt.color0: #000000
428 URxvt*color1: #A80000 768 URxvt.color1: #A80000
429 URxvt*color2: #00A800 769 URxvt.color2: #00A800
430 URxvt*color3: #A8A800 770 URxvt.color3: #A8A800
431 URxvt*color4: #0000A8 771 URxvt.color4: #0000A8
432 URxvt*color5: #A800A8 772 URxvt.color5: #A800A8
433 URxvt*color6: #00A8A8 773 URxvt.color6: #00A8A8
434 URxvt*color7: #A8A8A8 774 URxvt.color7: #A8A8A8
435 775
436 URxvt*color8: #000054 776 URxvt.color8: #000054
437 URxvt*color9: #FF0054 777 URxvt.color9: #FF0054
438 URxvt*color10: #00FF54 778 URxvt.color10: #00FF54
439 URxvt*color11: #FFFF54 779 URxvt.color11: #FFFF54
440 URxvt*color12: #0000FF 780 URxvt.color12: #0000FF
441 URxvt*color13: #FF00FF 781 URxvt.color13: #FF00FF
442 URxvt*color14: #00FFFF 782 URxvt.color14: #00FFFF
443 URxvt*color15: #FFFFFF 783 URxvt.color15: #FFFFFF
444 784
445And here is a more complete set of non-standard colors described as 785And here is a more complete set of non-standard colors described (not by
446"pretty girly": 786me) as "pretty girly".
447 787
448 URxvt.cursorColor: #dc74d1 788 URxvt.cursorColor: #dc74d1
449 URxvt.pointerColor: #dc74d1 789 URxvt.pointerColor: #dc74d1
450 URxvt.background: #0e0e0e 790 URxvt.background: #0e0e0e
451 URxvt.foreground: #4ad5e1 791 URxvt.foreground: #4ad5e1
462 URxvt.color6: #73f7ff 802 URxvt.color6: #73f7ff
463 URxvt.color14: #73f7ff 803 URxvt.color14: #73f7ff
464 URxvt.color7: #e1dddd 804 URxvt.color7: #e1dddd
465 URxvt.color15: #e1dddd 805 URxvt.color15: #e1dddd
466 806
807=item How can I start @@RXVT_NAME@@d in a race-free way?
808
809Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
810display, create the listening socket and then fork.
811
467=item What's with the strange Backspace/Delete key behaviour? 812=item What's with the strange Backspace/Delete key behaviour?
468 813
469Assuming that the physical Backspace key corresponds to the 814Assuming that the physical Backspace key corresponds to the
470BackSpace keysym (not likely for Linux ... see the following 815BackSpace keysym (not likely for Linux ... see the following
471question) there are two standard values that can be used for 816question) there are two standard values that can be used for
489 834
490 # use Backspace = ^? 835 # use Backspace = ^?
491 $ stty erase ^? 836 $ stty erase ^?
492 $ @@RXVT_NAME@@ 837 $ @@RXVT_NAME@@
493 838
494Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 839Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495 840
496For an existing rxvt-unicode: 841For an existing rxvt-unicode:
497 842
498 # use Backspace = ^H 843 # use Backspace = ^H
499 $ stty erase ^H 844 $ stty erase ^H
508properly reflects that. 853properly reflects that.
509 854
510The Delete key is a another casualty of the ill-defined Backspace problem. 855The Delete key is a another casualty of the ill-defined Backspace problem.
511To avoid confusion between the Backspace and Delete keys, the Delete 856To avoid confusion between the Backspace and Delete keys, the Delete
512key has been assigned an escape sequence to match the vt100 for Execute 857key has been assigned an escape sequence to match the vt100 for Execute
513(ESC[3~) and is in the supplied termcap/terminfo. 858(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514 859
515Some other Backspace problems: 860Some other Backspace problems:
516 861
517some editors use termcap/terminfo, 862some editors use termcap/terminfo,
518some editors (vim I'm told) expect Backspace = ^H, 863some editors (vim I'm told) expect Backspace = ^H,
524 869
525There are some compile-time selections available via configure. Unless 870There are some compile-time selections available via configure. Unless
526you have run "configure" with the C<--disable-resources> option you can 871you have run "configure" with the C<--disable-resources> option you can
527use the `keysym' resource to alter the keystrings associated with keysyms. 872use the `keysym' resource to alter the keystrings associated with keysyms.
528 873
529Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt' 874Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
530 875
531 URxvt.keysym.Home: \033[1~ 876 URxvt.keysym.Home: \033[1~
532 URxvt.keysym.End: \033[4~ 877 URxvt.keysym.End: \033[4~
533 URxvt.keysym.C-apostrophe: \033<C-'> 878 URxvt.keysym.C-apostrophe: \033<C-'>
534 URxvt.keysym.C-slash: \033<C-/> 879 URxvt.keysym.C-slash: \033<C-/>
564 909
565Rather than have rxvt-unicode try to accommodate all the various possible 910Rather than have rxvt-unicode try to accommodate all the various possible
566keyboard mappings, it is better to use `xmodmap' to remap the keys as 911keyboard mappings, it is better to use `xmodmap' to remap the keys as
567required for your particular machine. 912required for your particular machine.
568 913
569=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? 914=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
570I need this to decide about setting colors etc. 915I need this to decide about setting colors etc.
571 916
572rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 917rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
573check and see if that is set. Note that several programs, JED, slrn, 918check and see if that is set. Note that several programs, JED, slrn,
574Midnight Commander automatically check this variable to decide whether or 919Midnight Commander automatically check this variable to decide whether or
611channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 956channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
612interested in learning about new and exciting problems (but not FAQs :). 957interested in learning about new and exciting problems (but not FAQs :).
613 958
614=back 959=back
615 960
616=head1 SYNOPSIS 961=head1 RXVT TECHNICAL REFERENCE
617
618 # set a new font set
619 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
620
621 # change the locale and tell rxvt-unicode about it
622 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
623
624 # set window title
625 printf '\33]2;%s\007' "new window title"
626 962
627=head1 DESCRIPTION 963=head1 DESCRIPTION
628 964
629The rest of this document describes various technical aspects of 965The rest of this document describes various technical aspects of
630B<rxvt-unicode>. First the description of supported command sequences, 966B<rxvt-unicode>. First the description of supported command sequences,
631followed by menu and pixmap support and last by a description of all 967followed by pixmap support and last by a description of all features
632features selectable at C<configure> time. 968selectable at C<configure> time.
633
634=head1 RXVT TECHNICAL REFERENCE
635 969
636=head1 Definitions 970=head1 Definitions
637 971
638=over 4 972=over 4
639 973
768Single Shift Select of G3 Character Set (SS3): affects next character 1102Single Shift Select of G3 Character Set (SS3): affects next character
769only I<unimplemented> 1103only I<unimplemented>
770 1104
771=item B<< C<ESC Z> >> 1105=item B<< C<ESC Z> >>
772 1106
773Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1107Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
774 1108
775=item B<< C<ESC c> >> 1109=item B<< C<ESC c> >>
776 1110
777Full reset (RIS) 1111Full reset (RIS)
778 1112
782 1116
783=item B<< C<ESC o> >> 1117=item B<< C<ESC o> >>
784 1118
785Invoke the G3 Character Set (LS3) 1119Invoke the G3 Character Set (LS3)
786 1120
787=item B<< C<ESC> ( C> >> 1121=item B<< C<ESC ( C> >>
788 1122
789Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1123Designate G0 Character Set (ISO 2022), see below for values of C<C>.
790 1124
791=item B<< C<ESC> ) C> >> 1125=item B<< C<ESC ) C> >>
792 1126
793Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1127Designate G1 Character Set (ISO 2022), see below for values of C<C>.
794 1128
795=item B<< C<ESC * C> >> 1129=item B<< C<ESC * C> >>
796 1130
937 1271
938=item B<< C<ESC [ Ps c> >> 1272=item B<< C<ESC [ Ps c> >>
939 1273
940Send Device Attributes (DA) 1274Send Device Attributes (DA)
941B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1275B<< C<Ps = 0> >> (or omitted): request attributes from terminal
942returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1276returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
943Option'') 1277Option'')
944 1278
945=item B<< C<ESC [ Ps d> >> 1279=item B<< C<ESC [ Ps d> >>
946 1280
947Cursor to Line B<< C<Ps> >> (VPA) 1281Cursor to Line B<< C<Ps> >> (VPA)
1077 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels 1411 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1078 B<< C<Ps = 5> >> Raise window 1412 B<< C<Ps = 5> >> Raise window
1079 B<< C<Ps = 6> >> Lower window 1413 B<< C<Ps = 6> >> Lower window
1080 B<< C<Ps = 7> >> Refresh screen once 1414 B<< C<Ps = 7> >> Refresh screen once
1081 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns 1415 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1082 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2> 1416 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1083 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) 1417 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1084 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) 1418 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1085 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) 1419 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1086 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> 1420 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1087 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) 1421 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1207 B<< C<h> >> Send Mouse X & Y on button press. 1541 B<< C<h> >> Send Mouse X & Y on button press.
1208 B<< C<l> >> No mouse reporting. 1542 B<< C<l> >> No mouse reporting.
1209 1543
1210=end table 1544=end table
1211 1545
1212=item B<< C<Ps = 10> >> (B<rxvt>)
1213
1214=begin table
1215
1216 B<< C<h> >> menuBar visible
1217 B<< C<l> >> menuBar invisible
1218
1219=end table
1220
1221=item B<< C<Ps = 25> >> 1546=item B<< C<Ps = 25> >>
1222 1547
1223=begin table 1548=begin table
1224 1549
1225 B<< C<h> >> Visible cursor {cnorm/cvvis} 1550 B<< C<h> >> Visible cursor {cnorm/cvvis}
1338 1663
1339=begin table 1664=begin table
1340 1665
1341 B<< C<h> >> Scroll to bottom when a key is pressed 1666 B<< C<h> >> Scroll to bottom when a key is pressed
1342 B<< C<l> >> Don't scroll to bottom when a key is pressed 1667 B<< C<l> >> Don't scroll to bottom when a key is pressed
1668
1669=end table
1670
1671=item B<< C<Ps = 1021> >> (B<rxvt>)
1672
1673=begin table
1674
1675 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1676 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1343 1677
1344=end table 1678=end table
1345 1679
1346=item B<< C<Ps = 1047> >> 1680=item B<< C<Ps = 1047> >>
1347 1681
1396 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1730 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1397 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1731 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1398 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1732 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1399 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1733 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1400 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1734 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1401 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1735 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1402 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1736 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1737 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1403 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1738 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1404 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1405 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1739 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1406 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1740 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1407 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> >> 1741 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> >>
1408 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1742 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1409 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) 1743 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).
1410 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1744 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>.
1411 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1745 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1412 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1746 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1747 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1748 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1413 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1749 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1414 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1750 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1415 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1751 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1416 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1752 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1753 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1754 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1755 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1417 1756
1418=end table 1757=end table
1419 1758
1420=back 1759=back
1421 1760
1422X<menuBar>
1423
1424=head1 menuBar
1425
1426B<< The exact syntax used is I<almost> solidified. >>
1427In the menus, B<DON'T> try to use menuBar commands that add or remove a
1428menuBar.
1429
1430Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1431omitted: use B<./> to specify a menu relative to the current menu.
1432
1433=head2 Overview of menuBar operation
1434
1435For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1436of C<Pt> can be used for a variety of tasks:
1437
1438At the top level is the current menuBar which is a member of a circular
1439linked-list of other such menuBars.
1440
1441The menuBar acts as a parent for the various drop-down menus, which in
1442turn, may have labels, separator lines, menuItems and subMenus.
1443
1444The menuItems are the useful bits: you can use them to mimic keyboard
1445input or even to send text or escape sequences back to rxvt.
1446
1447The menuBar syntax is intended to provide a simple yet robust method of
1448constructing and manipulating menus and navigating through the
1449menuBars.
1450
1451The first step is to use the tag B<< [menu:I<name>] >> which creates
1452the menuBar called I<name> and allows access. You may now or menus,
1453subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1454menuBar access as B<readonly> to prevent accidental corruption of the
1455menus. To re-access the current menuBar for alterations, use the tag
1456B<[menu]>, make the alterations and then use B<[done]>
1457
1458X<menuBarCommands>
1459
1460=head2 Commands
1461
1462=over 4
1463
1464=item B<< [menu:+I<name>] >>
1465
1466access the named menuBar for creation or alteration. If a new menuBar
1467is created, it is called I<name> (max of 15 chars) and the current
1468menuBar is pushed onto the stack
1469
1470=item B<[menu]>
1471
1472access the current menuBar for alteration
1473
1474=item B<< [title:+I<string>] >>
1475
1476set the current menuBar's title to I<string>, which may contain the
1477following format specifiers:
1478B<%%> : literal B<%> character
1479B<%n> : rxvt name (as per the B<-name> command-line option)
1480B<%v> : rxvt version
1481
1482=item B<[done]>
1483
1484set menuBar access as B<readonly>.
1485End-of-file tag for B<< [read:+I<file>] >> operations.
1486
1487=item B<< [read:+I<file>] >>
1488
1489read menu commands directly from I<file> (extension ".menu" will be
1490appended if required.) Start reading at a line with B<[menu]> or B<<
1491[menu:+I<name> >> and continuing until B<[done]> is encountered.
1492
1493Blank and comment lines (starting with B<#>) are ignored. Actually,
1494since any invalid menu commands are also ignored, almost anything could
1495be construed as a comment line, but this may be tightened up in the
1496future ... so don't count on it!.
1497
1498=item B<< [read:+I<file>;+I<name>] >>
1499
1500The same as B<< [read:+I<file>] >>, but start reading at a line with
1501B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1502B<[done]> is encountered.
1503
1504=item B<[dump]>
1505
1506dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1507later rereading.
1508
1509=item B<[rm:name]>
1510
1511remove the named menuBar
1512
1513=item B<[rm] [rm:]>
1514
1515remove the current menuBar
1516
1517=item B<[rm*] [rm:*]>
1518
1519remove all menuBars
1520
1521=item B<[swap]>
1522
1523swap the top two menuBars
1524
1525=item B<[prev]>
1526
1527access the previous menuBar
1528
1529=item B<[next]>
1530
1531access the next menuBar
1532
1533=item B<[show]>
1534
1535Enable display of the menuBar
1536
1537=item B<[hide]>
1538
1539Disable display of the menuBar
1540
1541=item B<< [pixmap:+I<name>] >>
1542
1543=item B<< [pixmap:+I<name>;I<scaling>] >>
1544
1545(set the background pixmap globally
1546
1547B<< A Future implementation I<may> make this local to the menubar >>)
1548
1549=item B<< [:+I<command>:] >>
1550
1551ignore the menu readonly status and issue a I<command> to or a menu or
1552menuitem or change the ; a useful shortcut for setting the quick arrows
1553from a menuBar.
1554
1555=back
1556
1557X<menuBarAdd>
1558
1559=head2 Adding and accessing menus
1560
1561The following commands may also be B<+> prefixed.
1562
1563=over 4
1564
1565=item B</+>
1566
1567access menuBar top level
1568
1569=item B<./+>
1570
1571access current menu level
1572
1573=item B<../+>
1574
1575access parent menu (1 level up)
1576
1577=item B<../../>
1578
1579access parent menu (multiple levels up)
1580
1581=item B<< I</path/>menu >>
1582
1583add/access menu
1584
1585=item B<< I</path/>menu/* >>
1586
1587add/access menu and clear it if it exists
1588
1589=item B<< I</path/>{-} >>
1590
1591add separator
1592
1593=item B<< I</path/>{item} >>
1594
1595add B<item> as a label
1596
1597=item B<< I</path/>{item} action >>
1598
1599add/alter I<menuitem> with an associated I<action>
1600
1601=item B<< I</path/>{item}{right-text} >>
1602
1603add/alter I<menuitem> with B<right-text> as the right-justified text
1604and as the associated I<action>
1605
1606=item B<< I</path/>{item}{rtext} action >>
1607
1608add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1609the right-justified text.
1610
1611=back
1612
1613=over 4
1614
1615=item Special characters in I<action> must be backslash-escaped:
1616
1617B<\a \b \E \e \n \r \t \octal>
1618
1619=item or in control-character notation:
1620
1621B<^@, ^A .. ^Z .. ^_, ^?>
1622
1623=back
1624
1625To send a string starting with a B<NUL> (B<^@>) character to the
1626program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1627the first of which will be stripped off and the balance directed to the
1628program. Otherwise if I<action> begins with B<NUL> followed by
1629non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1630balance is sent back to rxvt.
1631
1632As a convenience for the many Emacs-type editors, I<action> may start
1633with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1634appended if missed from B<M-x> commands.
1635
1636As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1637quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1638
1639=over 4
1640
1641=item For example,
1642
1643B<M-xapropos> is equivalent to B<\Exapropos\r>
1644
1645=item and
1646
1647B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1648
1649=back
1650
1651The option B<< {I<right-rtext>} >> will be right-justified. In the
1652absence of a specified action, this text will be used as the I<action>
1653as well.
1654
1655=over 4
1656
1657=item For example,
1658
1659B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1660
1661=back
1662
1663The left label I<is> necessary, since it's used for matching, but
1664implicitly hiding the left label (by using same name for both left and
1665right labels), or explicitly hiding the left label (by preceeding it
1666with a dot), makes it possible to have right-justified text only.
1667
1668=over 4
1669
1670=item For example,
1671
1672B</File/{Open}{Open} Open-File-Action>
1673
1674=item or hiding it
1675
1676B</File/{.anylabel}{Open} Open-File-Action>
1677
1678=back
1679
1680X<menuBarRemove>
1681
1682=head2 Removing menus
1683
1684=over 4
1685
1686=item B<< -/*+ >>
1687
1688remove all menus from the menuBar, the same as B<[clear]>
1689
1690=item B<< -+I</path>menu+ >>
1691
1692remove menu
1693
1694=item B<< -+I</path>{item}+ >>
1695
1696remove item
1697
1698=item B<< -+I</path>{-} >>
1699
1700remove separator)
1701
1702=item B<-/path/menu/*>
1703
1704remove all items, separators and submenus from menu
1705
1706=back
1707
1708X<menuBarArrows>
1709
1710=head2 Quick Arrows
1711
1712The menus also provide a hook for I<quick arrows> to provide easier
1713user access. If nothing has been explicitly set, the default is to
1714emulate the curror keys. The syntax permits each arrow to be altered
1715individually or all four at once without re-entering their common
1716beginning/end text. For example, to explicitly associate cursor actions
1717with the arrows, any of the following forms could be used:
1718
1719=over 4
1720
1721=item B<< <r>+I<Right> >>
1722
1723=item B<< <l>+I<Left> >>
1724
1725=item B<< <u>+I<Up> >>
1726
1727=item B<< <d>+I<Down> >>
1728
1729Define actions for the respective arrow buttons
1730
1731=item B<< <b>+I<Begin> >>
1732
1733=item B<< <e>+I<End> >>
1734
1735Define common beginning/end parts for I<quick arrows> which used in
1736conjunction with the above <r> <l> <u> <d> constructs
1737
1738=back
1739
1740=over 4
1741
1742=item For example, define arrows individually,
1743
1744 <u>\E[A
1745
1746 <d>\E[B
1747
1748 <r>\E[C
1749
1750 <l>\E[D
1751
1752=item or all at once
1753
1754 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1755
1756=item or more compactly (factoring out common parts)
1757
1758 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1759
1760=back
1761
1762X<menuBarSummary>
1763
1764=head2 Command Summary
1765
1766A short summary of the most I<common> commands:
1767
1768=over 4
1769
1770=item [menu:name]
1771
1772use an existing named menuBar or start a new one
1773
1774=item [menu]
1775
1776use the current menuBar
1777
1778=item [title:string]
1779
1780set menuBar title
1781
1782=item [done]
1783
1784set menu access to readonly and, if reading from a file, signal EOF
1785
1786=item [done:name]
1787
1788if reading from a file using [read:file;name] signal EOF
1789
1790=item [rm:name]
1791
1792remove named menuBar(s)
1793
1794=item [rm] [rm:]
1795
1796remove current menuBar
1797
1798=item [rm*] [rm:*]
1799
1800remove all menuBar(s)
1801
1802=item [swap]
1803
1804swap top two menuBars
1805
1806=item [prev]
1807
1808access the previous menuBar
1809
1810=item [next]
1811
1812access the next menuBar
1813
1814=item [show]
1815
1816map menuBar
1817
1818=item [hide]
1819
1820unmap menuBar
1821
1822=item [pixmap;file]
1823
1824=item [pixmap;file;scaling]
1825
1826set a background pixmap
1827
1828=item [read:file]
1829
1830=item [read:file;name]
1831
1832read in a menu from a file
1833
1834=item [dump]
1835
1836dump out all menuBars to /tmp/rxvt-PID
1837
1838=item /
1839
1840access menuBar top level
1841
1842=item ./
1843
1844=item ../
1845
1846=item ../../
1847
1848access current or parent menu level
1849
1850=item /path/menu
1851
1852add/access menu
1853
1854=item /path/{-}
1855
1856add separator
1857
1858=item /path/{item}{rtext} action
1859
1860add/alter menu item
1861
1862=item -/*
1863
1864remove all menus from the menuBar
1865
1866=item -/path/menu
1867
1868remove menu items, separators and submenus from menu
1869
1870=item -/path/menu
1871
1872remove menu
1873
1874=item -/path/{item}
1875
1876remove item
1877
1878=item -/path/{-}
1879
1880remove separator
1881
1882=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1883
1884menu quick arrows
1885
1886=back
1887X<XPM> 1761X<XPM>
1888 1762
1889=head1 XPM 1763=head1 XPM
1890 1764
1891For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1765For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2077=end table 1951=end table
2078 1952
2079=head1 CONFIGURE OPTIONS 1953=head1 CONFIGURE OPTIONS
2080 1954
2081General hint: if you get compile errors, then likely your configuration 1955General hint: if you get compile errors, then likely your configuration
2082hasn't been tested well. Either try with --enable-everything or use the 1956hasn't been tested well. Either try with C<--enable-everything> or use
2083./reconf script as a base for experiments. ./reconf is used by myself, 1957the F<./reconf> script as a base for experiments. F<./reconf> is used by
2084so it should generally be a working config. Of course, you should always 1958myself, so it should generally be a working config. Of course, you should
2085report when a combination doesn't work, so it can be fixed. Marc Lehmann 1959always report when a combination doesn't work, so it can be fixed. Marc
2086<rxvt@schmorp.de>. 1960Lehmann <rxvt@schmorp.de>.
1961
1962All
2087 1963
2088=over 4 1964=over 4
2089 1965
2090=item --enable-everything 1966=item --enable-everything
2091 1967
2092Add support for all non-multichoice options listed in "./configure 1968Add (or remove) support for all non-multichoice options listed in "./configure
2093--help". Note that unlike other enable options this is order dependant. 1969--help".
1970
2094You can specify this and then disable options which this enables by 1971You can specify this and then disable options you do not like by
2095I<following> this with the appropriate commands. 1972I<following> this with the appropriate C<--disable-...> arguments,
1973or you can start with a minimal configuration by specifying
1974C<--disable-everything> and than adding just the C<--enable-...> arguments
1975you want.
2096 1976
2097=item --enable-xft 1977=item --enable-xft (default: enabled)
2098 1978
2099Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1979Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2100slower and require lots of memory, but as long as you don't use them, you 1980slower and require lots of memory, but as long as you don't use them, you
2101don't pay for them. 1981don't pay for them.
2102 1982
2103=item --enable-font-styles 1983=item --enable-font-styles (default: on)
2104 1984
2105Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 1985Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2106styles. The fonts can be set manually or automatically. 1986styles. The fonts can be set manually or automatically.
2107 1987
2108=item --with-codesets=NAME,... 1988=item --with-codesets=NAME,... (default: all)
2109 1989
2110Compile in support for additional codeset (encoding) groups (eu, vn are 1990Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2111always compiled in, which includes most 8-bit character sets). These 1991are always compiled in, which includes most 8-bit character sets). These
2112codeset tables are currently only used for driving X11 core fonts, they 1992codeset tables are used for driving X11 core fonts, they are not required
2113are not required for Xft fonts. Compiling them in will make your binary 1993for Xft fonts, although having them compiled in lets rxvt-unicode choose
2114bigger (together about 700kB), but it doesn't increase memory usage unless 1994replacement fonts more intelligently. Compiling them in will make your
1995binary bigger (all of together cost about 700kB), but it doesn't increase
2115you use an X11 font requiring one of these encodings. 1996memory usage unless you use a font requiring one of these encodings.
2116 1997
2117=begin table 1998=begin table
2118 1999
2119 all all available codeset groups 2000 all all available codeset groups
2120 zh common chinese encodings 2001 zh common chinese encodings
2123 jp_ext rarely used but big japanese encodings 2004 jp_ext rarely used but big japanese encodings
2124 kr korean encodings 2005 kr korean encodings
2125 2006
2126=end table 2007=end table
2127 2008
2128=item --enable-xim 2009=item --enable-xim (default: on)
2129 2010
2130Add support for XIM (X Input Method) protocol. This allows using 2011Add support for XIM (X Input Method) protocol. This allows using
2131alternative input methods (e.g. kinput2) and will also correctly 2012alternative input methods (e.g. kinput2) and will also correctly
2132set up the input for people using dead keys or compose keys. 2013set up the input for people using dead keys or compose keys.
2133 2014
2134=item --enable-unicode3 2015=item --enable-unicode3 (default: off)
2016
2017Recommended to stay off unless you really need non-BMP characters.
2135 2018
2136Enable direct support for displaying unicode codepoints above 2019Enable direct support for displaying unicode codepoints above
213765535 (the basic multilingual page). This increases storage 202065535 (the basic multilingual page). This increases storage
2138requirements per character from 2 to 4 bytes. X11 fonts do not yet 2021requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139support these extra characters, but Xft does. 2022support these extra characters, but Xft does.
2142even without this flag, but the number of such characters is 2025even without this flag, but the number of such characters is
2143limited to a view thousand (shared with combining characters, 2026limited to a view thousand (shared with combining characters,
2144see next switch), and right now rxvt-unicode cannot display them 2027see next switch), and right now rxvt-unicode cannot display them
2145(input/output and cut&paste still work, though). 2028(input/output and cut&paste still work, though).
2146 2029
2147=item --enable-combining 2030=item --enable-combining (default: on)
2148 2031
2149Enable automatic composition of combining characters into 2032Enable automatic composition of combining characters into
2150composite characters. This is required for proper viewing of text 2033composite characters. This is required for proper viewing of text
2151where accents are encoded as seperate unicode characters. This is 2034where accents are encoded as seperate unicode characters. This is
2152done by using precomposited characters when available or creating 2035done by using precomposited characters when available or creating
2153new pseudo-characters when no precomposed form exists. 2036new pseudo-characters when no precomposed form exists.
2154 2037
2155Without --enable-unicode3, the number of additional precomposed 2038Without --enable-unicode3, the number of additional precomposed
2156characters is rather limited (2048, if this is full, rxvt will use the 2039characters is somewhat limited (the 6400 private use characters will be
2157private use area, extending the number of combinations to 8448). With 2040(ab-)used). With --enable-unicode3, no practical limit exists.
2158--enable-unicode3, no practical limit exists. This will also enable 2041
2159storage of characters >65535. 2042This option will also enable storage (but not display) of characters
2043beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2160 2044
2161The combining table also contains entries for arabic presentation forms, 2045The combining table also contains entries for arabic presentation forms,
2162but these are not currently used. Bug me if you want these to be used. 2046but these are not currently used. Bug me if you want these to be used (and
2047tell me how these are to be used...).
2163 2048
2164=item --enable-fallback(=CLASS) 2049=item --enable-fallback(=CLASS) (default: Rxvt)
2165 2050
2166When reading resource settings, also read settings for class CLASS 2051When reading resource settings, also read settings for class CLASS. To
2167(default: Rxvt). To disable resource fallback use --disable-fallback. 2052disable resource fallback use --disable-fallback.
2168 2053
2169=item --with-res-name=NAME 2054=item --with-res-name=NAME (default: urxvt)
2170 2055
2171Use the given name (default: urxvt) as default application name when 2056Use the given name as default application name when
2172reading resources. Specify --with-res-name=rxvt to replace rxvt. 2057reading resources. Specify --with-res-name=rxvt to replace rxvt.
2173 2058
2174=item --with-res-class=CLASS 2059=item --with-res-class=CLASS /default: URxvt)
2175 2060
2176Use the given class (default: URxvt) as default application class 2061Use the given class as default application class
2177when reading resources. Specify --with-res-class=Rxvt to replace 2062when reading resources. Specify --with-res-class=Rxvt to replace
2178rxvt. 2063rxvt.
2179 2064
2180=item --enable-utmp 2065=item --enable-utmp (default: on)
2181 2066
2182Write user and tty to utmp file (used by programs like F<w>) at 2067Write user and tty to utmp file (used by programs like F<w>) at
2183start of rxvt execution and delete information when rxvt exits. 2068start of rxvt execution and delete information when rxvt exits.
2184 2069
2185=item --enable-wtmp 2070=item --enable-wtmp (default: on)
2186 2071
2187Write user and tty to wtmp file (used by programs like F<last>) at 2072Write user and tty to wtmp file (used by programs like F<last>) at
2188start of rxvt execution and write logout when rxvt exits. This 2073start of rxvt execution and write logout when rxvt exits. This
2189option requires --enable-utmp to also be specified. 2074option requires --enable-utmp to also be specified.
2190 2075
2191=item --enable-lastlog 2076=item --enable-lastlog (default: on)
2192 2077
2193Write user and tty to lastlog file (used by programs like 2078Write user and tty to lastlog file (used by programs like
2194F<lastlogin>) at start of rxvt execution. This option requires 2079F<lastlogin>) at start of rxvt execution. This option requires
2195--enable-utmp to also be specified. 2080--enable-utmp to also be specified.
2196 2081
2197=item --enable-xpm-background 2082=item --enable-xpm-background (default: on)
2198 2083
2199Add support for XPM background pixmaps. 2084Add support for XPM background pixmaps.
2200 2085
2201=item --enable-transparency 2086=item --enable-transparency (default: on)
2202 2087
2203Add support for inheriting parent backgrounds thus giving a fake 2088Add support for inheriting parent backgrounds thus giving a fake
2204transparency to the term. 2089transparency to the term.
2205 2090
2206=item --enable-fading 2091=item --enable-fading (default: on)
2207 2092
2208Add support for fading the text when focus is lost. 2093Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2209 2094
2210=item --enable-tinting 2095=item --enable-tinting (default: on)
2211 2096
2212Add support for tinting of transparent backgrounds. 2097Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2213 2098
2214=item --enable-menubar
2215
2216Add support for our menu bar system (this interacts badly with
2217dynamic locale switching currently).
2218
2219=item --enable-rxvt-scroll 2099=item --enable-rxvt-scroll (default: on)
2220 2100
2221Add support for the original rxvt scrollbar. 2101Add support for the original rxvt scrollbar.
2222 2102
2223=item --enable-next-scroll 2103=item --enable-next-scroll (default: on)
2224 2104
2225Add support for a NeXT-like scrollbar. 2105Add support for a NeXT-like scrollbar.
2226 2106
2227=item --enable-xterm-scroll 2107=item --enable-xterm-scroll (default: on)
2228 2108
2229Add support for an Xterm-like scrollbar. 2109Add support for an Xterm-like scrollbar.
2230 2110
2231=item --enable-plain-scroll 2111=item --enable-plain-scroll (default: on)
2232 2112
2233Add support for a very unobtrusive, plain-looking scrollbar that 2113Add support for a very unobtrusive, plain-looking scrollbar that
2234is the favourite of the rxvt-unicode author, having used it for 2114is the favourite of the rxvt-unicode author, having used it for
2235many years. 2115many years.
2236 2116
2237=item --enable-half-shadow 2117=item --enable-ttygid (default: off)
2238
2239Make shadows on the scrollbar only half the normal width & height.
2240only applicable to rxvt scrollbars.
2241
2242=item --enable-ttygid
2243 2118
2244Change tty device setting to group "tty" - only use this if 2119Change tty device setting to group "tty" - only use this if
2245your system uses this type of security. 2120your system uses this type of security.
2246 2121
2247=item --disable-backspace-key 2122=item --disable-backspace-key
2248 2123
2249Disable any handling of the backspace key by us - let the X server 2124Removes any handling of the backspace key by us - let the X server do it.
2125
2126=item --disable-delete-key
2127
2128Removes any handling of the delete key by us - let the X server
2250do it. 2129do it.
2251 2130
2252=item --disable-delete-key
2253
2254Disable any handling of the delete key by us - let the X server
2255do it.
2256
2257=item --disable-resources 2131=item --disable-resources
2258 2132
2259Remove all resources checking. 2133Removes any support for resource checking.
2260
2261=item --enable-xgetdefault
2262
2263Make resources checking via XGetDefault() instead of our small
2264version which only checks ~/.Xdefaults, or if that doesn't exist
2265then ~/.Xresources.
2266
2267=item --enable-strings
2268
2269Add support for our possibly faster memset() function and other
2270various routines, overriding your system's versions which may
2271have been hand-crafted in assembly or may require extra libraries
2272to link in. (this breaks ANSI-C rules and has problems on many
2273GNU/Linux systems).
2274 2134
2275=item --disable-swapscreen 2135=item --disable-swapscreen
2276 2136
2277Remove support for swap screen. 2137Remove support for secondary/swap screen.
2278 2138
2279=item --enable-frills 2139=item --enable-frills (default: on)
2280 2140
2281Add support for many small features that are not essential but nice to 2141Add support for many small features that are not essential but nice to
2282have. Normally you want this, but for very small binaries you may want to 2142have. Normally you want this, but for very small binaries you may want to
2283disable this. 2143disable this.
2284 2144
2285A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2145A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2286in combination with other switches) is: 2146in combination with other switches) is:
2287 2147
2288 MWM-hints 2148 MWM-hints
2149 EWMH-hints (pid, utf8 names) and protocols (ping)
2289 seperate underline colour 2150 seperate underline colour (-underlineColor)
2290 settable border widths and borderless switch 2151 settable border widths and borderless switch (-w, -b, -bl)
2152 visual depth selection (-depth)
2291 settable extra linespacing 2153 settable extra linespacing /-lsp)
2292 extra window properties (e.g. UTF-8 window names and PID)
2293 iso-14755-2 and -3, and visual feedback 2154 iso-14755-2 and -3, and visual feedback
2155 tripleclickwords (-tcw)
2156 settable insecure mode (-insecure)
2157 keysym remapping support
2158 cursor blinking and underline cursor (-cb, -uc)
2159 XEmbed support (-embed)
2160 user-pty (-pty-fd)
2161 hold on exit (-hold)
2162 skip builtin block graphics (-sbg)
2163
2164It also enabled some non-essential features otherwise disabled, such as:
2165
2166 some round-trip time optimisations
2167 nearest color allocation on pseudocolor screens
2168 UTF8_STRING supporr for selection
2169 sgr modes 90..97 and 100..107
2294 backindex and forwardindex escape sequence 2170 backindex and forwardindex escape sequences
2171 view change/zero scorllback esacpe sequences
2172 locale switching escape sequence
2295 window op and locale change escape sequences 2173 window op and some xterm/OSC escape sequences
2296 tripleclickwords 2174 rectangular selections
2297 settable insecure mode 2175 trailing space removal for selections
2176 verbose X error handling
2298 2177
2299=item --enable-iso14755 2178=item --enable-iso14755 (default: on)
2300 2179
2301Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2180Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2302F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2181F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2303C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2182C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2304this switch. 2183this switch.
2305 2184
2306=item --enable-keepscrolling 2185=item --enable-keepscrolling (default: on)
2307 2186
2308Add support for continual scrolling of the display when you hold 2187Add support for continual scrolling of the display when you hold
2309the mouse button down on a scrollbar arrow. 2188the mouse button down on a scrollbar arrow.
2310 2189
2311=item --enable-mousewheel 2190=item --enable-mousewheel (default: on)
2312 2191
2313Add support for scrolling via mouse wheel or buttons 4 & 5. 2192Add support for scrolling via mouse wheel or buttons 4 & 5.
2314 2193
2315=item --enable-slipwheeling 2194=item --enable-slipwheeling (default: on)
2316 2195
2317Add support for continual scrolling (using the mouse wheel as an 2196Add support for continual scrolling (using the mouse wheel as an
2318accelerator) while the control key is held down. This option 2197accelerator) while the control key is held down. This option
2319requires --enable-mousewheel to also be specified. 2198requires --enable-mousewheel to also be specified.
2320 2199
2321=item --disable-new-selection 2200=item --disable-new-selection
2322 2201
2323Remove support for mouse selection style like that of xterm. 2202Remove support for mouse selection style like that of xterm.
2324 2203
2325=item --enable-dmalloc 2204=item --enable-dmalloc (default: off)
2326 2205
2327Use Gray Watson's malloc - which is good for debugging See 2206Use Gray Watson's malloc - which is good for debugging See
2328http://www.letters.com/dmalloc/ for details If you use either this or the 2207http://www.letters.com/dmalloc/ for details If you use either this or the
2329next option, you may need to edit src/Makefile after compiling to point 2208next option, you may need to edit src/Makefile after compiling to point
2330DINCLUDE and DLIB to the right places. 2209DINCLUDE and DLIB to the right places.
2331 2210
2332You can only use either this option and the following (should 2211You can only use either this option and the following (should
2333you use either) . 2212you use either) .
2334 2213
2335=item --enable-dlmalloc 2214=item --enable-dlmalloc (default: off)
2336 2215
2337Use Doug Lea's malloc - which is good for a production version 2216Use Doug Lea's malloc - which is good for a production version
2338See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2217See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2339 2218
2340=item --enable-smart-resize 2219=item --enable-smart-resize (default: on)
2341 2220
2342Add smart growth/shrink behaviour when changing font size via from hot 2221Add smart growth/shrink behaviour when changing font size via hot
2343keys. This should keep in a fixed position the rxvt corner which is 2222keys. This should keep the window corner which is closest to a corner of
2344closest to a corner of the screen. 2223the screen in a fixed position.
2345 2224
2346=item --enable-cursor-blink
2347
2348Add support for a blinking cursor.
2349
2350=item --enable-pointer-blank 2225=item --enable-pointer-blank (default: on)
2351 2226
2352Add support to have the pointer disappear when typing or inactive. 2227Add support to have the pointer disappear when typing or inactive.
2353 2228
2354=item --with-name=NAME 2229=item --enable-perl (default: on)
2355 2230
2231Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2232manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2233in F<src/perl-ext/> for the extensions that are installed by default. The
2234perl interpreter that is used can be specified via the C<PERL> environment
2235variable when running configure.
2236
2237=item --with-name=NAME (default: urxvt)
2238
2356Set the basename for the installed binaries (default: C<urxvt>, resulting 2239Set the basename for the installed binaries, resulting
2357in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2240in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2358C<rxvt>. 2241C<rxvt>.
2359 2242
2360=item --with-term=NAME 2243=item --with-term=NAME (default: rxvt-unicode)
2361 2244
2362Change the environmental variable for the terminal to NAME (default 2245Change the environmental variable for the terminal to NAME.
2363C<rxvt-unicode>)
2364 2246
2365=item --with-terminfo=PATH 2247=item --with-terminfo=PATH
2366 2248
2367Change the environmental variable for the path to the terminfo tree to 2249Change the environmental variable for the path to the terminfo tree to
2368PATH. 2250PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines