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.96 by root, Tue Jan 31 00:25:16 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 also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23
5=head1 FREQUENTLY ASKED QUESTIONS 24=head1 FREQUENTLY ASKED QUESTIONS
6 25
7=over 4 26=over 4
8 27
28=item The new selection selects pieces that are too big, how can I select
29single words?
30
31Yes. For example, if you want to select alphanumeric words, you can use
32the following resource:
33
34 URxvt.selection.pattern-0: ([[:word:]]+)
35
36If you click more than twice, the selection will be extended
37more and more.
38
39To get a selection that is very similar to the old code, try this pattern:
40
41 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
42
43Please also note that the I<LeftClick Shift-LeftClik> combination also
44selects words like the old code.
45
46=item I don't like the new selection/popups/hotkeys/perl, how do I
47change/disable it?
48
49You can disable the perl extension completely by setting the
50B<perl-ext-common> resource to the empty string, which also keeps
51rxvt-unicode from initialising perl, saving memory.
52
53If you only want to disable specific features, you first have to
54identify which perl extension is responsible. For this, read the section
55B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
56example, to disable the B<selection-popup> and B<option-popup>, specify
57this B<perl-ext-common> resource:
58
59 URxvt.perl-ext-common: default,-selection-popup,-option-popup
60
61This will keep the default extensions, but disable the two popup
62extensions. Some extensions can also be configured, for example,
63scrollback search mode is triggered by B<M-s>. You can move it to any
64other combination either by setting the B<searchable-scrollback> resource:
65
66 URxvt.searchable-scrollback: CM-s
67
68=item Why doesn't rxvt-unicode read my resources?
69
70Well, why, indeed? It does, in a way very similar to other X
71applications. Most importantly, this means that if you or your OS loads
72resources into the X display (the right way to do it), rxvt-unicode will
73ignore any resource files in your home directory. It will only read
74F<$HOME/.Xdefaults> when no resources are attached to the display.
75
76If you have or use an F<$HOME/.Xresources> file, chances are that
77resources are loaded into your X-server. In this case, you have to
78re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
79
80Also consider the form resources have to use:
81
82 URxvt.resource: value
83
84If you want to use another form (there are lots of different ways of
85specifying resources), make sure you understand wether and why it
86works. If unsure, use the form above.
87
88=item I can't get transparency working, what am I doing wrong?
89
90First of all, transparency isn't officially supported in rxvt-unicode, so
91you are mostly on your own. Do not bug the author about it (but you may
92bug everybody else). Also, if you can't get it working consider it a rite
93of passage: ... and you failed.
94
95Here are four ways to get transparency. B<Do> read the manpage and option
96descriptions for the programs mentioned and rxvt-unicode. Really, do it!
97
981. Use inheritPixmap:
99
100 Esetroot wallpaper.jpg
101 @@RXVT_NAME@@ -ip -tint red -sh 40
102
103That works. If you think it doesn't, you lack transparency and tinting
104support, or you are unable to read.
105
1062. Use a simple pixmap and emulate pseudo-transparency. This enables you
107to use effects other than tinting and shading: Just shade/tint/whatever
108your picture with gimp:
109
110 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
111 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
112
113That works. If you think it doesn't, you lack XPM and Perl support, or you
114are unable to read.
115
1163. Use an ARGB visual:
117
118 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
119
120This requires XFT support, and the support of your X-server. If that
121doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
122there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
123bugfixes and workarounds for Xft and Xlib to make it work, but that
124doesn't mean that your WM has the required kludges in place.
125
1264. Use xcompmgr and let it do the job:
127
128 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
129 -set _NET_WM_WINDOW_OPACITY 0xc0000000
130
131Then click on a window you want to make transparent. Replace C<0xc0000000>
132by other values to change the degree of opacity. If it doesn't work and
133your server crashes, you got to keep the pieces.
134
135=item Isn't rxvt supposed to be small? Don't all those features bloat?
136
137I often get asked about this, and I think, no, they didn't cause extra
138bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
139that the urxvt binary is larger (due to some encoding tables always being
140compiled in), but it actually uses less memory (RSS) after startup. Even
141with C<--disable-everything>, this comparison is a bit unfair, as many
142features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
143already in use in this mode.
144
145 text data bss drs rss filename
146 98398 1664 24 15695 1824 rxvt --disable-everything
147 188985 9048 66616 18222 1788 urxvt --disable-everything
148
149When you C<--enable-everything> (which _is_ unfair, as this involves xft
150and full locale/XIM support which are quite bloaty inside libX11 and my
151libc), the two diverge, but not unreasnobaly so.
152
153 text data bss drs rss filename
154 163431 2152 24 20123 2060 rxvt --enable-everything
155 1035683 49680 66648 29096 3680 urxvt --enable-everything
156
157The very large size of the text section is explained by the east-asian
158encoding tables, which, if unused, take up disk space but nothing else
159and can be compiled out unless you rely on X11 core fonts that use those
160encodings. The BSS size comes from the 64k emergency buffer that my c++
161compiler allocates (but of course doesn't use unless you are out of
162memory). Also, using an xft font instead of a core font immediately adds a
163few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
164not used.
165
166Of course, due to every character using two or four bytes instead of one,
167a large scrollback buffer will ultimately make rxvt-unicode use more
168memory.
169
170Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
171still fares rather well. And compared to some monsters like gnome-terminal
172(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17343180k in daemons that stay around after exit, plus half a minute of
174startup time, including the hundreds of warnings it spits out), it fares
175extremely well *g*.
176
177=item Why C++, isn't that unportable/bloated/uncool?
178
179Is this a question? :) It comes up very often. The simple answer is: I had
180to write it, and C++ allowed me to write and maintain it in a fraction
181of the time and effort (which is a scarce resource for me). Put even
182shorter: It simply wouldn't exist without C++.
183
184My personal stance on this is that C++ is less portable than C, but in
185the case of rxvt-unicode this hardly matters, as its portability limits
186are defined by things like X11, pseudo terminals, locale support and unix
187domain sockets, which are all less portable than C++ itself.
188
189Regarding the bloat, see the above question: It's easy to write programs
190in C that use gobs of memory, an certainly possible to write programs in
191C++ that don't. C++ also often comes with large libraries, but this is
192not necessarily the case with GCC. Here is what rxvt links against on my
193system with a minimal config:
194
195 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
196 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
197 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
198 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
199
200And here is rxvt-unicode:
201
202 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
203 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
204 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
205 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
206 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
207
208No large bloated libraries (of course, none were linked in statically),
209except maybe libX11 :)
210
211=item Does it support tabs, can I have a tabbed rxvt-unicode?
212
213Beginning with version 7.3, there is a perl extension that implements a
214simple tabbed terminal. It is installed by default, so any of these should
215give you tabs:
216
217 @@RXVT_NAME@@ -pe tabbed
218
219 URxvt.perl-ext-common: default,tabbed
220
221It will also work fine with tabbing functionality of many window managers
222or similar tabbing programs, and its embedding-features allow it to be
223embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
224the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
225(murxvt) terminal as an example embedding application.
226
9=item How do I know which rxvt-unicode version I'm using? 227=item How do I know which rxvt-unicode version I'm using?
10 228
11The version number is displayed with the usage (-h). Also the escape 229The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 230sequence C<ESC [ 8 n> sets the window title to the version number. When
231using the @@RXVT_NAME@@c client, the version displayed is that of the
232daemon.
233
234=item I am using Debian GNU/Linux and have a problem...
235
236The Debian GNU/Linux package of rxvt-unicode in sarge contains large
237patches that considerably change the behaviour of rxvt-unicode (but
238unfortunately this notice has been removed). Before reporting a bug to
239the original rxvt-unicode author please download and install the genuine
240version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
241the problem. If you cannot, chances are that the problems are specific to
242Debian GNU/Linux, in which case it should be reported via the Debian Bug
243Tracking System (use C<reportbug> to report the bug).
244
245For other problems that also affect the Debian package, you can and
246probably should use the Debian BTS, too, because, after all, it's also a
247bug in the Debian version and it serves as a reminder for other users that
248might encounter the same issue.
249
250=item I am maintaining rxvt-unicode for distribution/OS XXX, any
251recommendation?
252
253You should build one binary with the default options. F<configure>
254now enables most useful options, and the trend goes to making them
255runtime-switchable, too, so there is usually no drawback to enbaling them,
256except higher disk and possibly memory usage. The perl interpreter should
257be enabled, as important functionality (menus, selection, likely more in
258the future) depends on it.
259
260You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
261system-wide (except maybe with C<defaults>). This will result in useful
262behaviour. If your distribution aims at low memory, add an empty
263C<perl-ext-common> resource to the app-defaults file. This will keep the
264perl interpreter disabled until the user enables it.
265
266If you can/want build more binaries, I recommend building a minimal
267one with C<--disable-everything> (very useful) and a maximal one with
268C<--enable-everything> (less useful, it will be very big due to a lot of
269encodings built-in that increase download times and are rarely used).
270
271=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
272
273It should be, starting with release 7.1. You are encouraged to properly
274install urxvt with privileges necessary for your OS now.
275
276When rxvt-unicode detects that it runs setuid or setgid, it will fork
277into a helper process for privileged operations (pty handling on some
278systems, utmp/wtmp/lastlog handling on others) and drop privileges
279immediately. This is much safer than most other terminals that keep
280privileges while running (but is more relevant to urxvt, as it contains
281things as perl interpreters, which might be "helpful" to attackers).
282
283This forking is done as the very first within main(), which is very early
284and reduces possible bugs to initialisation code run before main(), or
285things like the dynamic loader of your system, which should result in very
286little risk.
13 287
14=item When I log-in to another system it tells me about missing terminfo data? 288=item When I log-in to another system it tells me about missing terminfo data?
15 289
16The terminal description used by rxvt-unicode is not as widely available 290The 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). 291as 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 302C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different 303problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice 304colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though. 305quick-and-dirty workaround for rare cases, though.
32 306
33If you always want to do this you can either recompile rxvt-unicode with 307If you always want to do this (and are fine with the consequences) you
34the desired TERM value or use a resource to set it: 308can either recompile rxvt-unicode with the desired TERM value or use a
309resource to set it:
35 310
36 URxvt.termName: rxvt 311 URxvt.termName: rxvt
37 312
38If you don't plan to use B<rxvt> (quite common...) you could also replace 313If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one. 314the rxvt terminfo file with the rxvt-unicode one.
40 315
316=item C<tic> outputs some error when compiling the terminfo entry.
317
318Most likely it's the empty definition for C<enacs=>. Just replace it by
319C<enacs=\E[0@> and try again.
320
321=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
322
41=item I need a termcap file entry. 323=item I need a termcap file entry.
324
325One reason you might want this is that some distributions or operating
326systems still compile some programs using the long-obsoleted termcap
327library (Fedora Core's bash is one example) and rely on a termcap entry
328for C<rxvt-unicode>.
42 329
43You could use rxvt's termcap entry with resonable results in many cases. 330You 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 331You can also create a termcap entry by using terminfo's infocmp program
45like this: 332like this:
46 333
47 infocmp -C rxvt-unicode 334 infocmp -C rxvt-unicode
48 335
49OR you could this termcap entry: 336Or you could use this termcap entry, generated by the command above:
50 337
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 338 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\ 339 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\ 340 :co#80:it#8:li#24:lm#0:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 341 :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:\ 342 :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:\ 343 :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:\ 344 :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:\ 345 :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[@:\ 346 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
347 :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:\ 348 :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~:\ 349 :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~:\ 350 :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:\ 351 :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=:\ 352 :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:\ 353 :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:\ 354 :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:\ 355 :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:\ 356 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h: 357 :vs=\E[?25h:
70 358
71=item Why does C<ls> no longer have coloured output? 359=item Why does C<ls> no longer have coloured output?
72 360
73The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 361The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
… …
96GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 384GNU/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 385file, 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 386I log-in to another system it tells me about missing terminfo data?> on
99how to do this). 387how to do this).
100 388
389=item My numerical keypad acts weird and generates differing output?
390
391Some Debian GNUL/Linux users seem to have this problem, although no
392specific details were reported so far. It is possible that this is caused
393by the wrong C<TERM> setting, although the details of wether and how
394this can happen are unknown, as C<TERM=rxvt> should offer a compatible
395keymap. See the answer to the previous question, and please report if that
396helped.
397
101=item Rxvt-unicode does not seem to understand the selected encoding? 398=item Rxvt-unicode does not seem to understand the selected encoding?
102 399
103=item Unicode does not seem to work? 400=item Unicode does not seem to work?
104 401
105If you encounter strange problems like typing an accented character but 402If you encounter strange problems like typing an accented character but
… …
107subtly garbled, then you should check your locale settings. 404subtly garbled, then you should check your locale settings.
108 405
109Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 406Rxvt-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 407programs. Often rxvt-unicode is started in the C<C> locale, while the
111login script running within the rxvt-unicode window changes the locale to 408login 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. 409something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
113 410
114The best thing is to fix your startup environment, as you will likely run 411The 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. 412into other problems. If nothing works you can try this in your .profile.
116 413
117 printf '\e]701;%s\007' "$LC_CTYPE" 414 printf '\e]701;%s\007' "$LC_CTYPE"
118 415
119If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 416If 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 417supported on your systems. Some systems have a C<locale> command which
121displays this. If it displays sth. like: 418displays this (also, C<perl -e0> can be used to check locale settings, as
419it will complain loudly if it cannot set the locale). If it displays something
420like:
122 421
123 locale: Cannot set LC_CTYPE to default locale: ... 422 locale: Cannot set LC_CTYPE to default locale: ...
124 423
125Then the locale you specified is not supported on your system. 424Then the locale you specified is not supported on your system.
126 425
… …
137your system/os) have specified does not cover all the characters you want 436your system/os) have specified does not cover all the characters you want
138to display. 437to display.
139 438
140B<rxvt-unicode> makes a best-effort try at finding a replacement 439B<rxvt-unicode> makes a best-effort try at finding a replacement
141font. Often the result is fine, but sometimes the chosen font looks 440font. Often the result is fine, but sometimes the chosen font looks
142bad. Many fonts have totally strange characters that don't resemble the 441bad/ugly/wrong. Some fonts have totally strange characters that don't
143correct glyph at all, and rxvt-unicode lacks the artificial intelligence 442resemble 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 443intelligence to detect that a specific glyph is wrong: it has to believe
145the characters it contains indeed look correct. 444the font that the characters it claims to contain indeed look correct.
146 445
147In that case, select a font of your taste and add it to the font list, 446In that case, select a font of your taste and add it to the font list,
148e.g.: 447e.g.:
149 448
150 @@RXVT_NAME@@ -fn basefont,font2,font3... 449 @@RXVT_NAME@@ -fn basefont,font2,font3...
… …
152When rxvt-unicode sees a character, it will first look at the base 451When 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 452font. 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 453next 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. 454search and use less resources within rxvt-unicode and the X-server.
156 455
157The only limitation is that all the fonts must not be larger than the base 456The 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 457font, as the base font defines the terminal character cell size, which
159same due to the way terminals work. 458must be the same due to the way terminals work.
160 459
161=item Why do some chinese characters look so different than others? 460=item Why do some chinese characters look so different than others?
162 461
163This is because there is a difference between script and language -- 462This is because there is a difference between script and language --
164rxvt-unicode does not know which language the text that is output 463rxvt-unicode does not know which language the text that is output is,
165is, as it only knows the unicode character codes. If rxvt-unicode 464as it only knows the unicode character codes. If rxvt-unicode first
166first sees a japanese character, it might choose a japanese font for 465sees a japanese/chinese character, it might choose a japanese font for
167it. Subsequent japanese characters will take that font. Now, many chinese 466display. Subsequent japanese characters will use that font. Now, many
168characters aren't represented in japanese fonts, so when the first 467chinese characters aren't represented in japanese fonts, so when the first
169non-japanese character comes up, rxvt-unicode will look for a chinese font 468non-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 469-- unfortunately at this point, it will still use the japanese font for
171japanese characters that are also chinese. 470chinese characters that are also in the japanese font.
172 471
173The workaround is easy: just tag a chinese font at the end of your font 472The 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 473list (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 474a preference list: If you expect more japanese, list a japanese font
176first. If you expect more chinese, put a chinese font first. 475first. If you expect more chinese, put a chinese font first.
177 476
178In the future it might be possible to switch preferences at runtime (the 477In the future it might be possible to switch language preferences at
179internal data structure has no problem with using different fonts for 478runtime (the internal data structure has no problem with using different
180the same character at the same time, but no interface for this has been 479fonts for the same character at the same time, but no interface for this
181designed yet). 480has been designed yet).
481
482Until then, you might get away with switching fonts at runtime (see L<Can
483I switch the fonts at runtime?> later in this document).
182 484
183=item Why does rxvt-unicode sometimes leave pixel droppings? 485=item Why does rxvt-unicode sometimes leave pixel droppings?
184 486
185Most fonts were not designed for terminal use, which means that character 487Most 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 488size 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 501the C<-lsp> option to give the font more height. If that doesn't work, you
200might be forced to use a different font. 502might be forced to use a different font.
201 503
202All of this is not a problem when using X11 core fonts, as their bounding 504All of this is not a problem when using X11 core fonts, as their bounding
203box data is correct. 505box data is correct.
506
507=item On Solaris 9, many line-drawing characters are too wide.
508
509Seems to be a known bug, read
510L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
511following ugly workaround to get non-double-wide-characters working:
512
513 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
204 514
205=item My Compose (Multi_key) key is no longer working. 515=item My Compose (Multi_key) key is no longer working.
206 516
207The most common causes for this are that either your locale is not set 517The 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 518correctly, 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 532codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
223character and so on. 533character and so on.
224 534
225=item How can I keep rxvt-unicode from using reverse video so much? 535=item How can I keep rxvt-unicode from using reverse video so much?
226 536
227First of all, make sure you are running with the right terminfo 537First 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 538(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 539make sure you have specified colours for italic and bold, as otherwise
230might use reverse video to simulate the effect: 540rxvt-unicode might use reverse video to simulate the effect:
231 541
232 URxvt*colorBD: white 542 URxvt.colorBD: white
233 URxvt*colorIT: green 543 URxvt.colorIT: green
234 544
235=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 545=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
236 546
237For some unexplainable reason, some programs (i.e. irssi) assume a very 547For some unexplainable reason, some rare programs assume a very weird
238weird colour palette when confronted with a terminal with more than the 548colour palette when confronted with a terminal with more than the standard
239standard 8 colours (rxvt-unicode supports 88). The right fix is, of 5498 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 550these programs not to assume non-ISO colours without very good reasons.
241good reasons.
242 551
243In the meantime, you can either edit your C<urxvt> terminfo definition to 552In 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 553definition to only claim 8 colour support or use C<TERM=rxvt>, which will
245but keep you from using other rxvt-unicode features. 554fix colours but keep you from using other rxvt-unicode features.
246 555
247=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 556=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
248 557
249Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 558Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
250in your compile environment, or an implementation that implements it, 559in your compile environment, or an implementation that implements it,
251wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 560wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
252B<wchar_t> is represented as unicode. 561B<wchar_t> is represented as unicode.
253 562
254As you might have guessed, FreeBSD does neither define this symobl nor 563As you might have guessed, FreeBSD does neither define this symobl nor
255does it support it. Instead, it uses it's own internal representation of 564does it support it. Instead, it uses it's own internal representation of
256B<wchar_t>. This is, of course, completely legal. 565B<wchar_t>. This is, of course, completely fine with respect to standards.
257 566
567However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
568C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
569
258However, C<__STDC_ISO_10646__> is the only sane way to support 570C<__STDC_ISO_10646__> is the only sane way to support multi-language
259multi-language apps in an OS, as using a locale-dependent (and 571apps in an OS, as using a locale-dependent (and non-standardized)
260non-standardized) representation of B<wchar_t> makes it impossible to 572representation of B<wchar_t> makes it impossible to convert between
261convert between B<wchar_t> (as used by X11 and your applications) and any 573B<wchar_t> (as used by X11 and your applications) and any other encoding
262other encoding without implementing OS-specific-wrappers for each and 574without implementing OS-specific-wrappers for each and every locale. There
263every locale. There simply are no APIs to convert B<wchar_t> into anything 575simply are no APIs to convert B<wchar_t> into anything except the current
264except the current locale encoding. 576locale encoding.
265 577
266Some applications (such as the formidable B<mlterm>) work around this 578Some applications (such as the formidable B<mlterm>) work around this
267by carrying their own replacement functions for character set handling 579by carrying their own replacement functions for character set handling
268with them, and either implementing OS-dependent hacks or doing multiple 580with them, and either implementing OS-dependent hacks or doing multiple
269conversions (which is slow and unreliable in case the OS implements 581conversions (which is slow and unreliable in case the OS implements
270encodings slightly different than the terminal emulator). 582encodings slightly different than the terminal emulator).
271 583
272The rxvt-unicode author insists that the right way to fix this is in the 584The 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 585system libraries once and for all, instead of forcing every app to carry
274complete replacements. 586complete replacements for them :)
587
588=item I use Solaris 9 and it doesn't compile/work/etc.
589
590Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
591problems with C<wcwidth> and a compile problem.
592
593=item How can I use rxvt-unicode under cygwin?
594
595rxvt-unicode should compile and run out of the box on cygwin, using
596the X11 libraries that come with cygwin. libW11 emulation is no
597longer supported (and makes no sense, either, as it only supported a
598single font). I recommend starting the X-server in C<-multiwindow> or
599C<-rootless> mode instead, which will result in similar look&feel as the
600old libW11 emulation.
601
602At the time of this writing, cygwin didn't seem to support any multi-byte
603encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
604to 8-bit encodings.
275 605
276=item How does rxvt-unicode determine the encoding to use? 606=item How does rxvt-unicode determine the encoding to use?
277 607
278=item Is there an option to switch encodings? 608=item Is there an option to switch encodings?
279 609
… …
281specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 611specific "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. 612UTF-8 or any other encodings with respect to terminal I/O.
283 613
284The reasons is that there exists a perfectly fine mechanism for selecting 614The reasons is that there exists a perfectly fine mechanism for selecting
285the encoding, doing I/O and (most important) communicating this to all 615the encoding, doing I/O and (most important) communicating this to all
286applications so everybody agrees on character properties such as width and 616applications so everybody agrees on character properties such as width
287code number. This mechanism is the I<locale>. 617and code number. This mechanism is the I<locale>. Applications not using
618that info will have problems (for example, C<xterm> gets the width of
619characters wrong as it uses it's own, locale-independent table under all
620locales).
288 621
289Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 622Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
290programs doing the same (that is, most) will automatically agree in the 623programs doing the same (that is, most) will automatically agree in the
291interpretation of characters. 624interpretation of characters.
292 625
… …
299C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms 632C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
300(i.e. C<de> or C<german>) are also common. 633(i.e. C<de> or C<german>) are also common.
301 634
302Rxvt-unicode ignores all other locale categories, and except for 635Rxvt-unicode ignores all other locale categories, and except for
303the encoding, ignores country or language-specific settings, 636the 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. 637i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
638rxvt-unicode.
305 639
306If you want to use a specific encoding you have to make sure you start 640If you want to use a specific encoding you have to make sure you start
307rxvt-unicode with the correct C<LC_CTYPE> category. 641rxvt-unicode with the correct C<LC_CTYPE> category.
308 642
309=item Can I switch locales at runtime? 643=item Can I switch locales at runtime?
310 644
311Yes, using an escape sequence. Try sth. like this, which sets 645Yes, using an escape sequence. Try something like this, which sets
312rxvt-unicode's idea of C<LC_CTYPE>. 646rxvt-unicode's idea of C<LC_CTYPE>.
313 647
314 printf '\e]701;%s\007' ja_JP.SJIS 648 printf '\e]701;%s\007' ja_JP.SJIS
315 649
316See also the previous question. 650See also the previous answer.
317 651
318Sometimes this capability is rather handy when you want to work in one 652Sometimes 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 653one 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 654(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
321locale supported by xjdic and back later: 655first switches to a locale supported by xjdic and back later:
322 656
323 printf '\e]701;%s\007' ja_JP.SJIS 657 printf '\e]701;%s\007' ja_JP.SJIS
324 xjdic -js 658 xjdic -js
325 printf '\e]701;%s\007' de_DE.UTF-8 659 printf '\e]701;%s\007' de_DE.UTF-8
326 660
661You can also use xterm's C<luit> program, which usually works fine, except
662for some locales where character width differs between program- and
663rxvt-unicode-locales.
664
327=item Can I switch the fonts at runtime? 665=item Can I switch the fonts at runtime?
328 666
329Yes, using an escape sequence. Try sth. like this, which has the same 667Yes, using an escape sequence. Try something like this, which has the same
330effect as using the C<-fn> switch, and takes effect immediately: 668effect as using the C<-fn> switch, and takes effect immediately:
331 669
332 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 670 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
333 671
334This is useful if you e.g. work primarily with japanese (and prefer a 672This is useful if you e.g. work primarily with japanese (and prefer a
… …
339 677
340=item Why do italic characters look as if clipped? 678=item Why do italic characters look as if clipped?
341 679
342Many fonts have difficulties with italic characters and hinting. For 680Many fonts have difficulties with italic characters and hinting. For
343example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 681example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
344Mono> completely fails in it's italic face. A workaround is to enable 682Mono> completely fails in it's italic face. A workaround might be to
345freetype autohinting, i.e. like this: 683enable freetype autohinting, i.e. like this:
346 684
347 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 685 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
348 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 686 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
349 687
350=item My input method wants <some encoding> but I want UTF-8, what can I do? 688=item My input method wants <some encoding> but I want UTF-8, what can I do?
351 689
352You can specify separate locales for the input method and the rest of the 690You can specify separate locales for the input method and the rest of the
353terminal, using the resource C<imlocale>: 691terminal, using the resource C<imlocale>:
354 692
355 URxvt*imlocale: ja_JP.EUC-JP 693 URxvt.imlocale: ja_JP.EUC-JP
356 694
357Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 695Now 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 696use 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 697input characters outside C<EUC-JP> in a normal way then, as your input
360method limits you. 698method limits you.
361 699
700=item Rxvt-unicode crashes when the X Input Method changes or exits.
701
702Unfortunately, this is unavoidable, as the XIM protocol is racy by
703design. Applications can avoid some crashes at the expense of memory
704leaks, and Input Methods can avoid some crashes by careful ordering at
705exit time. B<kinput2> (and derived input methods) generally succeeds,
706while B<SCIM> (or similar input methods) fails. In the end, however,
707crashes cannot be completely avoided even if both sides cooperate.
708
709So the only workaround is not to kill your Input Method Servers.
710
362=item Rxvt-unicode uses gobs of memory, how can I reduce that? 711=item Rxvt-unicode uses gobs of memory, how can I reduce that?
363 712
364Rxvt-unicode tries to obey the rule of not charging you for sth. you 713Rxvt-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 714don'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, 715you 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 716when used. Compiling it out ensures that no Xft font will be loaded
368accidentally when rxvt-unicode tries to find a font for your characters. 717accidentally when rxvt-unicode tries to find a font for your characters.
369 718
… …
376 725
377=item Can I speed up Xft rendering somehow? 726=item Can I speed up Xft rendering somehow?
378 727
379Yes, the most obvious way to speed it up is to avoid Xft entirely, as 728Yes, 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 729it is simply slow. If you still want Xft fonts you might try to disable
381antialiasing (by appending C<:antialiasing=false>), which saves lots of 730antialiasing (by appending C<:antialias=false>), which saves lots of
382memory and also speeds up rendering considerably. 731memory and also speeds up rendering considerably.
383 732
384=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 733=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385 734
386Rxvt-unicode will use whatever you specify as a font. If it needs to 735Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
395 744
396Make sure that mouse reporting is actually turned off since killing 745Make sure that mouse reporting is actually turned off since killing
397some editors prematurely may leave the mouse in mouse report mode. I've 746some editors prematurely may leave the mouse in mouse report mode. I've
398heard that tcsh may use mouse reporting unless it otherwise specified. A 747heard 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 748quick check is to see if cut/paste works when the Alt or Shift keys are
400depressed. See @@RXVT_NAME@@(7) 749depressed.
401 750
402=item What's with this bold/blink stuff? 751=item What's with this bold/blink stuff?
403 752
404If no bold colour is set via C<colorBD:>, bold will invert text using the 753If no bold colour is set via C<colorBD:>, bold will invert text using the
405standard foreground colour. 754standard foreground colour.
… …
422resources (or as long-options). 771resources (or as long-options).
423 772
424Here are values that are supposed to resemble a VGA screen, 773Here are values that are supposed to resemble a VGA screen,
425including the murky brown that passes for low-intensity yellow: 774including the murky brown that passes for low-intensity yellow:
426 775
427 URxvt*color0: #000000 776 URxvt.color0: #000000
428 URxvt*color1: #A80000 777 URxvt.color1: #A80000
429 URxvt*color2: #00A800 778 URxvt.color2: #00A800
430 URxvt*color3: #A8A800 779 URxvt.color3: #A8A800
431 URxvt*color4: #0000A8 780 URxvt.color4: #0000A8
432 URxvt*color5: #A800A8 781 URxvt.color5: #A800A8
433 URxvt*color6: #00A8A8 782 URxvt.color6: #00A8A8
434 URxvt*color7: #A8A8A8 783 URxvt.color7: #A8A8A8
435 784
436 URxvt*color8: #000054 785 URxvt.color8: #000054
437 URxvt*color9: #FF0054 786 URxvt.color9: #FF0054
438 URxvt*color10: #00FF54 787 URxvt.color10: #00FF54
439 URxvt*color11: #FFFF54 788 URxvt.color11: #FFFF54
440 URxvt*color12: #0000FF 789 URxvt.color12: #0000FF
441 URxvt*color13: #FF00FF 790 URxvt.color13: #FF00FF
442 URxvt*color14: #00FFFF 791 URxvt.color14: #00FFFF
443 URxvt*color15: #FFFFFF 792 URxvt.color15: #FFFFFF
444 793
445And here is a more complete set of non-standard colors described as 794And here is a more complete set of non-standard colors described (not by
446"pretty girly": 795me) as "pretty girly".
447 796
448 URxvt.cursorColor: #dc74d1 797 URxvt.cursorColor: #dc74d1
449 URxvt.pointerColor: #dc74d1 798 URxvt.pointerColor: #dc74d1
450 URxvt.background: #0e0e0e 799 URxvt.background: #0e0e0e
451 URxvt.foreground: #4ad5e1 800 URxvt.foreground: #4ad5e1
… …
462 URxvt.color6: #73f7ff 811 URxvt.color6: #73f7ff
463 URxvt.color14: #73f7ff 812 URxvt.color14: #73f7ff
464 URxvt.color7: #e1dddd 813 URxvt.color7: #e1dddd
465 URxvt.color15: #e1dddd 814 URxvt.color15: #e1dddd
466 815
816=item How can I start @@RXVT_NAME@@d in a race-free way?
817
818Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
819display, create the listening socket and then fork.
820
467=item What's with the strange Backspace/Delete key behaviour? 821=item What's with the strange Backspace/Delete key behaviour?
468 822
469Assuming that the physical Backspace key corresponds to the 823Assuming that the physical Backspace key corresponds to the
470BackSpace keysym (not likely for Linux ... see the following 824BackSpace keysym (not likely for Linux ... see the following
471question) there are two standard values that can be used for 825question) there are two standard values that can be used for
… …
489 843
490 # use Backspace = ^? 844 # use Backspace = ^?
491 $ stty erase ^? 845 $ stty erase ^?
492 $ @@RXVT_NAME@@ 846 $ @@RXVT_NAME@@
493 847
494Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 848Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495 849
496For an existing rxvt-unicode: 850For an existing rxvt-unicode:
497 851
498 # use Backspace = ^H 852 # use Backspace = ^H
499 $ stty erase ^H 853 $ stty erase ^H
… …
508properly reflects that. 862properly reflects that.
509 863
510The Delete key is a another casualty of the ill-defined Backspace problem. 864The Delete key is a another casualty of the ill-defined Backspace problem.
511To avoid confusion between the Backspace and Delete keys, the Delete 865To avoid confusion between the Backspace and Delete keys, the Delete
512key has been assigned an escape sequence to match the vt100 for Execute 866key has been assigned an escape sequence to match the vt100 for Execute
513(ESC[3~) and is in the supplied termcap/terminfo. 867(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514 868
515Some other Backspace problems: 869Some other Backspace problems:
516 870
517some editors use termcap/terminfo, 871some editors use termcap/terminfo,
518some editors (vim I'm told) expect Backspace = ^H, 872some editors (vim I'm told) expect Backspace = ^H,
… …
524 878
525There are some compile-time selections available via configure. Unless 879There are some compile-time selections available via configure. Unless
526you have run "configure" with the C<--disable-resources> option you can 880you have run "configure" with the C<--disable-resources> option you can
527use the `keysym' resource to alter the keystrings associated with keysyms. 881use the `keysym' resource to alter the keystrings associated with keysyms.
528 882
529Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt' 883Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
530 884
531 URxvt.keysym.Home: \033[1~ 885 URxvt.keysym.Home: \033[1~
532 URxvt.keysym.End: \033[4~ 886 URxvt.keysym.End: \033[4~
533 URxvt.keysym.C-apostrophe: \033<C-'> 887 URxvt.keysym.C-apostrophe: \033<C-'>
534 URxvt.keysym.C-slash: \033<C-/> 888 URxvt.keysym.C-slash: \033<C-/>
… …
564 918
565Rather than have rxvt-unicode try to accommodate all the various possible 919Rather than have rxvt-unicode try to accommodate all the various possible
566keyboard mappings, it is better to use `xmodmap' to remap the keys as 920keyboard mappings, it is better to use `xmodmap' to remap the keys as
567required for your particular machine. 921required for your particular machine.
568 922
569=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? 923=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
570I need this to decide about setting colors etc. 924I need this to decide about setting colors etc.
571 925
572rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 926rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
573check and see if that is set. Note that several programs, JED, slrn, 927check and see if that is set. Note that several programs, JED, slrn,
574Midnight Commander automatically check this variable to decide whether or 928Midnight Commander automatically check this variable to decide whether or
… …
611channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 965channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
612interested in learning about new and exciting problems (but not FAQs :). 966interested in learning about new and exciting problems (but not FAQs :).
613 967
614=back 968=back
615 969
616=head1 SYNOPSIS 970=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 971
627=head1 DESCRIPTION 972=head1 DESCRIPTION
628 973
629The rest of this document describes various technical aspects of 974The rest of this document describes various technical aspects of
630B<rxvt-unicode>. First the description of supported command sequences, 975B<rxvt-unicode>. First the description of supported command sequences,
631followed by menu and pixmap support and last by a description of all 976followed by pixmap support and last by a description of all features
632features selectable at C<configure> time. 977selectable at C<configure> time.
633
634=head1 RXVT TECHNICAL REFERENCE
635 978
636=head1 Definitions 979=head1 Definitions
637 980
638=over 4 981=over 4
639 982
… …
768Single Shift Select of G3 Character Set (SS3): affects next character 1111Single Shift Select of G3 Character Set (SS3): affects next character
769only I<unimplemented> 1112only I<unimplemented>
770 1113
771=item B<< C<ESC Z> >> 1114=item B<< C<ESC Z> >>
772 1115
773Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1116Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
774 1117
775=item B<< C<ESC c> >> 1118=item B<< C<ESC c> >>
776 1119
777Full reset (RIS) 1120Full reset (RIS)
778 1121
… …
782 1125
783=item B<< C<ESC o> >> 1126=item B<< C<ESC o> >>
784 1127
785Invoke the G3 Character Set (LS3) 1128Invoke the G3 Character Set (LS3)
786 1129
787=item B<< C<ESC> ( C> >> 1130=item B<< C<ESC ( C> >>
788 1131
789Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1132Designate G0 Character Set (ISO 2022), see below for values of C<C>.
790 1133
791=item B<< C<ESC> ) C> >> 1134=item B<< C<ESC ) C> >>
792 1135
793Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1136Designate G1 Character Set (ISO 2022), see below for values of C<C>.
794 1137
795=item B<< C<ESC * C> >> 1138=item B<< C<ESC * C> >>
796 1139
… …
937 1280
938=item B<< C<ESC [ Ps c> >> 1281=item B<< C<ESC [ Ps c> >>
939 1282
940Send Device Attributes (DA) 1283Send Device Attributes (DA)
941B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1284B<< C<Ps = 0> >> (or omitted): request attributes from terminal
942returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1285returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
943Option'') 1286Option'')
944 1287
945=item B<< C<ESC [ Ps d> >> 1288=item B<< C<ESC [ Ps d> >>
946 1289
947Cursor to Line B<< C<Ps> >> (VPA) 1290Cursor to Line B<< C<Ps> >> (VPA)
… …
1077 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels 1420 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1078 B<< C<Ps = 5> >> Raise window 1421 B<< C<Ps = 5> >> Raise window
1079 B<< C<Ps = 6> >> Lower window 1422 B<< C<Ps = 6> >> Lower window
1080 B<< C<Ps = 7> >> Refresh screen once 1423 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 1424 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> 1425 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>) 1426 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>) 1427 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>) 1428 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> 1429 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> >>) 1430 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
… …
1207 B<< C<h> >> Send Mouse X & Y on button press. 1550 B<< C<h> >> Send Mouse X & Y on button press.
1208 B<< C<l> >> No mouse reporting. 1551 B<< C<l> >> No mouse reporting.
1209 1552
1210=end table 1553=end table
1211 1554
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> >> 1555=item B<< C<Ps = 25> >>
1222 1556
1223=begin table 1557=begin table
1224 1558
1225 B<< C<h> >> Visible cursor {cnorm/cvvis} 1559 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1338 1672
1339=begin table 1673=begin table
1340 1674
1341 B<< C<h> >> Scroll to bottom when a key is pressed 1675 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 1676 B<< C<l> >> Don't scroll to bottom when a key is pressed
1677
1678=end table
1679
1680=item B<< C<Ps = 1021> >> (B<rxvt>)
1681
1682=begin table
1683
1684 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1685 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1343 1686
1344=end table 1687=end table
1345 1688
1346=item B<< C<Ps = 1047> >> 1689=item B<< C<Ps = 1047> >>
1347 1690
… …
1396 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1739 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)> 1740 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> >> 1741 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> >> 1742 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> >> 1743 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> >> 1744 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> >> 1745 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1746 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> >> 1747 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> 1748 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> 1749 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> >> 1750 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> >> 1751 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) 1752 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) 1753 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> >> 1754 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> >> 1755 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1756 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1757 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>. 1758 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>. 1759 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>. 1760 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>. 1761 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1762 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1763 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1764 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1417 1765
1418=end table 1766=end table
1419 1767
1420=back 1768=back
1421 1769
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> 1770X<XPM>
1888 1771
1889=head1 XPM 1772=head1 XPM
1890 1773
1891For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1774For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
2077=end table 1960=end table
2078 1961
2079=head1 CONFIGURE OPTIONS 1962=head1 CONFIGURE OPTIONS
2080 1963
2081General hint: if you get compile errors, then likely your configuration 1964General hint: if you get compile errors, then likely your configuration
2082hasn't been tested well. Either try with --enable-everything or use the 1965hasn'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, 1966the 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 1967myself, 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 1968always report when a combination doesn't work, so it can be fixed. Marc
2086<rxvt@schmorp.de>. 1969Lehmann <rxvt@schmorp.de>.
1970
1971All
2087 1972
2088=over 4 1973=over 4
2089 1974
2090=item --enable-everything 1975=item --enable-everything
2091 1976
2092Add support for all non-multichoice options listed in "./configure 1977Add (or remove) support for all non-multichoice options listed in "./configure
2093--help". Note that unlike other enable options this is order dependant. 1978--help".
1979
2094You can specify this and then disable options which this enables by 1980You can specify this and then disable options you do not like by
2095I<following> this with the appropriate commands. 1981I<following> this with the appropriate C<--disable-...> arguments,
1982or you can start with a minimal configuration by specifying
1983C<--disable-everything> and than adding just the C<--enable-...> arguments
1984you want.
2096 1985
2097=item --enable-xft 1986=item --enable-xft (default: enabled)
2098 1987
2099Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1988Add 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 1989slower and require lots of memory, but as long as you don't use them, you
2101don't pay for them. 1990don't pay for them.
2102 1991
2103=item --enable-font-styles 1992=item --enable-font-styles (default: on)
2104 1993
2105Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 1994Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2106styles. The fonts can be set manually or automatically. 1995styles. The fonts can be set manually or automatically.
2107 1996
2108=item --with-codesets=NAME,... 1997=item --with-codesets=NAME,... (default: all)
2109 1998
2110Compile in support for additional codeset (encoding) groups (eu, vn are 1999Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2111always compiled in, which includes most 8-bit character sets). These 2000are always compiled in, which includes most 8-bit character sets). These
2112codeset tables are currently only used for driving X11 core fonts, they 2001codeset 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 2002for Xft fonts, although having them compiled in lets rxvt-unicode choose
2114bigger (together about 700kB), but it doesn't increase memory usage unless 2003replacement fonts more intelligently. Compiling them in will make your
2004binary bigger (all of together cost about 700kB), but it doesn't increase
2115you use an X11 font requiring one of these encodings. 2005memory usage unless you use a font requiring one of these encodings.
2116 2006
2117=begin table 2007=begin table
2118 2008
2119 all all available codeset groups 2009 all all available codeset groups
2120 zh common chinese encodings 2010 zh common chinese encodings
… …
2123 jp_ext rarely used but big japanese encodings 2013 jp_ext rarely used but big japanese encodings
2124 kr korean encodings 2014 kr korean encodings
2125 2015
2126=end table 2016=end table
2127 2017
2128=item --enable-xim 2018=item --enable-xim (default: on)
2129 2019
2130Add support for XIM (X Input Method) protocol. This allows using 2020Add support for XIM (X Input Method) protocol. This allows using
2131alternative input methods (e.g. kinput2) and will also correctly 2021alternative input methods (e.g. kinput2) and will also correctly
2132set up the input for people using dead keys or compose keys. 2022set up the input for people using dead keys or compose keys.
2133 2023
2134=item --enable-unicode3 2024=item --enable-unicode3 (default: off)
2025
2026Recommended to stay off unless you really need non-BMP characters.
2135 2027
2136Enable direct support for displaying unicode codepoints above 2028Enable direct support for displaying unicode codepoints above
213765535 (the basic multilingual page). This increases storage 202965535 (the basic multilingual page). This increases storage
2138requirements per character from 2 to 4 bytes. X11 fonts do not yet 2030requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139support these extra characters, but Xft does. 2031support these extra characters, but Xft does.
… …
2142even without this flag, but the number of such characters is 2034even without this flag, but the number of such characters is
2143limited to a view thousand (shared with combining characters, 2035limited to a view thousand (shared with combining characters,
2144see next switch), and right now rxvt-unicode cannot display them 2036see next switch), and right now rxvt-unicode cannot display them
2145(input/output and cut&paste still work, though). 2037(input/output and cut&paste still work, though).
2146 2038
2147=item --enable-combining 2039=item --enable-combining (default: on)
2148 2040
2149Enable automatic composition of combining characters into 2041Enable automatic composition of combining characters into
2150composite characters. This is required for proper viewing of text 2042composite characters. This is required for proper viewing of text
2151where accents are encoded as seperate unicode characters. This is 2043where accents are encoded as seperate unicode characters. This is
2152done by using precomposited characters when available or creating 2044done by using precomposited characters when available or creating
2153new pseudo-characters when no precomposed form exists. 2045new pseudo-characters when no precomposed form exists.
2154 2046
2155Without --enable-unicode3, the number of additional precomposed 2047Without --enable-unicode3, the number of additional precomposed
2156characters is rather limited (2048, if this is full, rxvt will use the 2048characters is somewhat limited (the 6400 private use characters will be
2157private use area, extending the number of combinations to 8448). With 2049(ab-)used). With --enable-unicode3, no practical limit exists.
2158--enable-unicode3, no practical limit exists. This will also enable 2050
2159storage of characters >65535. 2051This option will also enable storage (but not display) of characters
2052beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2160 2053
2161The combining table also contains entries for arabic presentation forms, 2054The combining table also contains entries for arabic presentation forms,
2162but these are not currently used. Bug me if you want these to be used. 2055but these are not currently used. Bug me if you want these to be used (and
2056tell me how these are to be used...).
2163 2057
2164=item --enable-fallback(=CLASS) 2058=item --enable-fallback(=CLASS) (default: Rxvt)
2165 2059
2166When reading resource settings, also read settings for class CLASS 2060When reading resource settings, also read settings for class CLASS. To
2167(default: Rxvt). To disable resource fallback use --disable-fallback. 2061disable resource fallback use --disable-fallback.
2168 2062
2169=item --with-res-name=NAME 2063=item --with-res-name=NAME (default: urxvt)
2170 2064
2171Use the given name (default: urxvt) as default application name when 2065Use the given name as default application name when
2172reading resources. Specify --with-res-name=rxvt to replace rxvt. 2066reading resources. Specify --with-res-name=rxvt to replace rxvt.
2173 2067
2174=item --with-res-class=CLASS 2068=item --with-res-class=CLASS /default: URxvt)
2175 2069
2176Use the given class (default: URxvt) as default application class 2070Use the given class as default application class
2177when reading resources. Specify --with-res-class=Rxvt to replace 2071when reading resources. Specify --with-res-class=Rxvt to replace
2178rxvt. 2072rxvt.
2179 2073
2180=item --enable-utmp 2074=item --enable-utmp (default: on)
2181 2075
2182Write user and tty to utmp file (used by programs like F<w>) at 2076Write user and tty to utmp file (used by programs like F<w>) at
2183start of rxvt execution and delete information when rxvt exits. 2077start of rxvt execution and delete information when rxvt exits.
2184 2078
2185=item --enable-wtmp 2079=item --enable-wtmp (default: on)
2186 2080
2187Write user and tty to wtmp file (used by programs like F<last>) at 2081Write user and tty to wtmp file (used by programs like F<last>) at
2188start of rxvt execution and write logout when rxvt exits. This 2082start of rxvt execution and write logout when rxvt exits. This
2189option requires --enable-utmp to also be specified. 2083option requires --enable-utmp to also be specified.
2190 2084
2191=item --enable-lastlog 2085=item --enable-lastlog (default: on)
2192 2086
2193Write user and tty to lastlog file (used by programs like 2087Write user and tty to lastlog file (used by programs like
2194F<lastlogin>) at start of rxvt execution. This option requires 2088F<lastlogin>) at start of rxvt execution. This option requires
2195--enable-utmp to also be specified. 2089--enable-utmp to also be specified.
2196 2090
2197=item --enable-xpm-background 2091=item --enable-xpm-background (default: on)
2198 2092
2199Add support for XPM background pixmaps. 2093Add support for XPM background pixmaps.
2200 2094
2201=item --enable-transparency 2095=item --enable-transparency (default: on)
2202 2096
2203Add support for inheriting parent backgrounds thus giving a fake 2097Add support for inheriting parent backgrounds thus giving a fake
2204transparency to the term. 2098transparency to the term.
2205 2099
2206=item --enable-fading 2100=item --enable-fading (default: on)
2207 2101
2208Add support for fading the text when focus is lost. 2102Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2209 2103
2210=item --enable-tinting 2104=item --enable-tinting (default: on)
2211 2105
2212Add support for tinting of transparent backgrounds. 2106Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2213 2107
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 2108=item --enable-rxvt-scroll (default: on)
2220 2109
2221Add support for the original rxvt scrollbar. 2110Add support for the original rxvt scrollbar.
2222 2111
2223=item --enable-next-scroll 2112=item --enable-next-scroll (default: on)
2224 2113
2225Add support for a NeXT-like scrollbar. 2114Add support for a NeXT-like scrollbar.
2226 2115
2227=item --enable-xterm-scroll 2116=item --enable-xterm-scroll (default: on)
2228 2117
2229Add support for an Xterm-like scrollbar. 2118Add support for an Xterm-like scrollbar.
2230 2119
2231=item --enable-plain-scroll 2120=item --enable-plain-scroll (default: on)
2232 2121
2233Add support for a very unobtrusive, plain-looking scrollbar that 2122Add support for a very unobtrusive, plain-looking scrollbar that
2234is the favourite of the rxvt-unicode author, having used it for 2123is the favourite of the rxvt-unicode author, having used it for
2235many years. 2124many years.
2236 2125
2237=item --enable-half-shadow 2126=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 2127
2244Change tty device setting to group "tty" - only use this if 2128Change tty device setting to group "tty" - only use this if
2245your system uses this type of security. 2129your system uses this type of security.
2246 2130
2247=item --disable-backspace-key 2131=item --disable-backspace-key
2248 2132
2249Disable any handling of the backspace key by us - let the X server 2133Removes any handling of the backspace key by us - let the X server do it.
2134
2135=item --disable-delete-key
2136
2137Removes any handling of the delete key by us - let the X server
2250do it. 2138do it.
2251 2139
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 2140=item --disable-resources
2258 2141
2259Remove all resources checking. 2142Removes 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 2143
2275=item --disable-swapscreen 2144=item --disable-swapscreen
2276 2145
2277Remove support for swap screen. 2146Remove support for secondary/swap screen.
2278 2147
2279=item --enable-frills 2148=item --enable-frills (default: on)
2280 2149
2281Add support for many small features that are not essential but nice to 2150Add 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 2151have. Normally you want this, but for very small binaries you may want to
2283disable this. 2152disable this.
2284 2153
2285A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2154A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2286in combination with other switches) is: 2155in combination with other switches) is:
2287 2156
2288 MWM-hints 2157 MWM-hints
2158 EWMH-hints (pid, utf8 names) and protocols (ping)
2289 seperate underline colour 2159 seperate underline colour (-underlineColor)
2290 settable border widths and borderless switch 2160 settable border widths and borderless switch (-w, -b, -bl)
2161 visual depth selection (-depth)
2291 settable extra linespacing 2162 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 2163 iso-14755-2 and -3, and visual feedback
2164 tripleclickwords (-tcw)
2165 settable insecure mode (-insecure)
2166 keysym remapping support
2167 cursor blinking and underline cursor (-cb, -uc)
2168 XEmbed support (-embed)
2169 user-pty (-pty-fd)
2170 hold on exit (-hold)
2171 skip builtin block graphics (-sbg)
2172
2173It also enabled some non-essential features otherwise disabled, such as:
2174
2175 some round-trip time optimisations
2176 nearest color allocation on pseudocolor screens
2177 UTF8_STRING supporr for selection
2178 sgr modes 90..97 and 100..107
2294 backindex and forwardindex escape sequence 2179 backindex and forwardindex escape sequences
2180 view change/zero scorllback esacpe sequences
2181 locale switching escape sequence
2295 window op and locale change escape sequences 2182 window op and some xterm/OSC escape sequences
2296 tripleclickwords 2183 rectangular selections
2297 settable insecure mode 2184 trailing space removal for selections
2185 verbose X error handling
2298 2186
2299=item --enable-iso14755 2187=item --enable-iso14755 (default: on)
2300 2188
2301Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2189Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2302F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2190F<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 2191C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2304this switch. 2192this switch.
2305 2193
2306=item --enable-keepscrolling 2194=item --enable-keepscrolling (default: on)
2307 2195
2308Add support for continual scrolling of the display when you hold 2196Add support for continual scrolling of the display when you hold
2309the mouse button down on a scrollbar arrow. 2197the mouse button down on a scrollbar arrow.
2310 2198
2311=item --enable-mousewheel 2199=item --enable-mousewheel (default: on)
2312 2200
2313Add support for scrolling via mouse wheel or buttons 4 & 5. 2201Add support for scrolling via mouse wheel or buttons 4 & 5.
2314 2202
2315=item --enable-slipwheeling 2203=item --enable-slipwheeling (default: on)
2316 2204
2317Add support for continual scrolling (using the mouse wheel as an 2205Add support for continual scrolling (using the mouse wheel as an
2318accelerator) while the control key is held down. This option 2206accelerator) while the control key is held down. This option
2319requires --enable-mousewheel to also be specified. 2207requires --enable-mousewheel to also be specified.
2320 2208
2321=item --disable-new-selection 2209=item --disable-new-selection
2322 2210
2323Remove support for mouse selection style like that of xterm. 2211Remove support for mouse selection style like that of xterm.
2324 2212
2325=item --enable-dmalloc 2213=item --enable-dmalloc (default: off)
2326 2214
2327Use Gray Watson's malloc - which is good for debugging See 2215Use Gray Watson's malloc - which is good for debugging See
2328http://www.letters.com/dmalloc/ for details If you use either this or the 2216http://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 2217next option, you may need to edit src/Makefile after compiling to point
2330DINCLUDE and DLIB to the right places. 2218DINCLUDE and DLIB to the right places.
2331 2219
2332You can only use either this option and the following (should 2220You can only use either this option and the following (should
2333you use either) . 2221you use either) .
2334 2222
2335=item --enable-dlmalloc 2223=item --enable-dlmalloc (default: off)
2336 2224
2337Use Doug Lea's malloc - which is good for a production version 2225Use Doug Lea's malloc - which is good for a production version
2338See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2226See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2339 2227
2340=item --enable-smart-resize 2228=item --enable-smart-resize (default: on)
2341 2229
2342Add smart growth/shrink behaviour when changing font size via from hot 2230Add smart growth/shrink behaviour when changing font size via hot
2343keys. This should keep in a fixed position the rxvt corner which is 2231keys. This should keep the window corner which is closest to a corner of
2344closest to a corner of the screen. 2232the screen in a fixed position.
2345 2233
2346=item --enable-cursor-blink
2347
2348Add support for a blinking cursor.
2349
2350=item --enable-pointer-blank 2234=item --enable-pointer-blank (default: on)
2351 2235
2352Add support to have the pointer disappear when typing or inactive. 2236Add support to have the pointer disappear when typing or inactive.
2353 2237
2354=item --with-name=NAME 2238=item --enable-perl (default: on)
2355 2239
2240Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2241manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2242in F<src/perl-ext/> for the extensions that are installed by default. The
2243perl interpreter that is used can be specified via the C<PERL> environment
2244variable when running configure.
2245
2246=item --with-name=NAME (default: urxvt)
2247
2356Set the basename for the installed binaries (default: C<urxvt>, resulting 2248Set the basename for the installed binaries, resulting
2357in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2249in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2358C<rxvt>. 2250C<rxvt>.
2359 2251
2360=item --with-term=NAME 2252=item --with-term=NAME (default: rxvt-unicode)
2361 2253
2362Change the environmental variable for the terminal to NAME (default 2254Change the environmental variable for the terminal to NAME.
2363C<rxvt-unicode>)
2364 2255
2365=item --with-terminfo=PATH 2256=item --with-terminfo=PATH
2366 2257
2367Change the environmental variable for the path to the terminfo tree to 2258Change the environmental variable for the path to the terminfo tree to
2368PATH. 2259PATH.

Diff Legend

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