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.89 by root, Wed Jan 18 21:00:39 2006 UTC vs.
Revision 1.171 by root, Sun Jun 15 10:15:39 2008 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
25=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 28
27=over 4
28 29
29=item The new selection selects pieces that are too big, how can I select 30=head2 Meta, Features & Commandline Issues
30single words?
31 31
32Yes. For example, if you want to select alphanumeric words, you can use 32=head3 My question isn't answered here, can I ask a human?
33the following resource:
34 33
35 URxvt.selection.pattern-0: ([[:word:]]+) 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
36 37
37If you click more than twice, the selection will be extended 38=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
38more and more.
39 39
40To get a selection that is very similar to the old code, try this pattern: 40Beginning with version 7.3, there is a perl extension that implements a
41simple tabbed terminal. It is installed by default, so any of these should
42give you tabs:
41 43
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 44 @@URXVT_NAME@@ -pe tabbed
43 45
44Please also note that the I<LeftClick Shift-LeftClik> combination also 46 URxvt.perl-ext-common: default,tabbed
45selects words like the old code.
46 47
47=item I don't like the new selection/popups/hotkeys/perl, how do I 48It will also work fine with tabbing functionality of many window managers
48change/disable it? 49or similar tabbing programs, and its embedding-features allow it to be
50embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
51the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
52(murxvt) terminal as an example embedding application.
49 53
50You can disable the perl extension completely by setting the 54=head3 How do I know which rxvt-unicode version I'm using?
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53 55
54If you only want to disable specific features, you first have to 56The version number is displayed with the usage (-h). Also the escape
55identify which perl extension is responsible. For this, read the section 57sequence C<ESC [ 8 n> sets the window title to the version number. When
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 58using the @@URXVT_NAME@@c client, the version displayed is that of the
57example, to disable the B<selection-popup> and B<option-popup>, specify 59daemon.
58this B<perl-ext-common> resource:
59 60
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup 61=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
61 62
62This will keep the default extensions, but disable the two popup 63Rxvt-unicode tries to obey the rule of not charging you for something you
63extensions. Some extensions can also be configured, for example, 64don't use. One thing you should try is to configure out all settings that
64scrollback search mode is triggered by B<M-s>. You can move it to any 65you don't need, for example, Xft support is a resource hog by design,
65other combination either by setting the B<searchable-scrollback> resource: 66when used. Compiling it out ensures that no Xft font will be loaded
67accidentally when rxvt-unicode tries to find a font for your characters.
66 68
67 URxvt.searchable-scrollback: CM-s 69Also, many people (me included) like large windows and even larger
70scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
716 bytes per screen cell. For a 160x?? window this amounts to almost a
72kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
73use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
74rxvt-unicode then uses 8 bytes per screen cell.
68 75
76=head3 How can I start @@URXVT_NAME@@d in a race-free way?
77
78Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
79display, create the listening socket and then fork.
80
81=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
82
83If you want to start @@URXVT_NAME@@d automatically whenever you run
84@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
85
86 #!/bin/sh
87 @@URXVT_NAME@@c "$@"
88 if [ $? -eq 2 ]; then
89 @@URXVT_NAME@@d -q -o -f
90 @@URXVT_NAME@@c "$@"
91 fi
92
93This tries to create a new terminal, and if fails with exit status 2,
94meaning it couldn't connect to the daemon, it will start the daemon and
95re-run the command. Subsequent invocations of the script will re-use the
96existing daemon.
97
98=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
99
100The original rxvt and rxvt-unicode always export the variable "COLORTERM",
101so you can check and see if that is set. Note that several programs, JED,
102slrn, Midnight Commander automatically check this variable to decide
103whether or not to use color.
104
105=head3 How do I set the correct, full IP address for the DISPLAY variable?
106
107If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
108insecure mode then it is possible to use the following shell script
109snippets to correctly set the display. If your version of rxvt-unicode
110wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
111the COLORTERM variable can be used to distinguish rxvt-unicode from a
112regular xterm.
113
114Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
115snippets:
116
117 # Bourne/Korn/POSIX family of shells:
118 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
119 if [ ${TERM:-foo} = xterm ]; then
120 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
121 echo -n '^[Z'
122 read term_id
123 stty icanon echo
124 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
125 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
126 read DISPLAY # set it in our local shell
127 fi
128 fi
129
130=head3 How do I compile the manual pages on my own?
131
132You need to have a recent version of perl installed as F</usr/bin/perl>,
133one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
134F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
135
69=item Isn't rxvt supposed to be small? Don't all those features bloat? 136=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
70 137
71I often get asked about this, and I think, no, they didn't cause extra 138I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 139bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73that the urxvt binary is larger (due to some encoding tables always being 140that the urxvt binary is larger (due to some encoding tables always being
74compiled in), but it actually uses less memory (RSS) after startup. Even 141compiled in), but it actually uses less memory (RSS) after startup. Even
78 145
79 text data bss drs rss filename 146 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything 147 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything 148 188985 9048 66616 18222 1788 urxvt --disable-everything
82 149
83When you C<--enable-everything> (which _is_ unfair, as this involves xft 150When you C<--enable-everything> (which I<is> unfair, as this involves xft
84and full locale/XIM support which are quite bloaty inside libX11 and my 151and full locale/XIM support which are quite bloaty inside libX11 and my
85libc), the two diverge, but not unreasnobaly so. 152libc), the two diverge, but not unreasonably so.
86 153
87 text data bss drs rss filename 154 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything 155 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything 156 1035683 49680 66648 29096 3680 urxvt --enable-everything
90 157
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra 173(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k in daemons that stay around after exit, plus half a minute of 17443180k in daemons that stay around after exit, plus half a minute of
108startup time, including the hundreds of warnings it spits out), it fares 175startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*. 176extremely well *g*.
110 177
111=item Why C++, isn't that unportable/bloated/uncool? 178=head3 Why C++, isn't that unportable/bloated/uncool?
112 179
113Is this a question? :) It comes up very often. The simple answer is: I had 180Is this a question? :) It comes up very often. The simple answer is: I had
114to write it, and C++ allowed me to write and maintain it in a fraction 181to write it, and C++ allowed me to write and maintain it in a fraction
115of the time and effort (which is a scarce resource for me). Put even 182of the time and effort (which is a scarce resource for me). Put even
116shorter: It simply wouldn't exist without C++. 183shorter: It simply wouldn't exist without C++.
133 200
134And here is rxvt-unicode: 201And here is rxvt-unicode:
135 202
136 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
139 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141 208
142No large bloated libraries (of course, none were linked in statically), 209No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :) 210except maybe libX11 :)
144 211
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146 212
147rxvt-unicode does not directly support tabs. It will work fine with 213=head2 Rendering, Font & Look and Feel Issues
148tabbing functionality of many window managers or similar tabbing programs,
149and its embedding-features allow it to be embedded into other programs,
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
151module, which features a tabbed urxvt (murxvt) terminal as an example
152embedding application.
153 214
154=item How do I know which rxvt-unicode version I'm using? 215=head3 I can't get transparency working, what am I doing wrong?
155 216
156The version number is displayed with the usage (-h). Also the escape 217First of all, please address all transparency related issues to Sasha Vasko at
157sequence C<ESC [ 8 n> sets the window title to the version number. When 218sasha@aftercode.net and do not bug the author about it. Also, if you can't
158using the @@RXVT_NAME@@c client, the version displayed is that of the 219get it working consider it a rite of passage: ... and you failed.
159daemon.
160 220
161=item I am using Debian GNU/Linux and have a problem... 221Here are four ways to get transparency. B<Do> read the manpage and option
222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
162 223
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large 2241. Use transparent mode:
164patches that considerably change the behaviour of rxvt-unicode (but
165unfortunately this notice has been removed). Before reporting a bug to
166the original rxvt-unicode author please download and install the genuine
167version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168the problem. If you cannot, chances are that the problems are specific to
169Debian GNU/Linux, in which case it should be reported via the Debian Bug
170Tracking System (use C<reportbug> to report the bug).
171 225
172For other problems that also affect the Debian package, you can and 226 Esetroot wallpaper.jpg
173probably should use the Debian BTS, too, because, after all, it's also a 227 @@URXVT_NAME@@ -tr -tint red -sh 40
174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue.
176 228
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any 229That works. If you think it doesn't, you lack transparency and tinting
178recommendation? 230support, or you are unable to read.
179 231
180You should build one binary with the default options. F<configure> 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
181now enables most useful options, and the trend goes to making them 233to use effects other than tinting and shading: Just shade/tint/whatever
182runtime-switchable, too, so there is usually no drawback to enbaling them, 234your picture with gimp or any other tool:
183except higher disk and possibly memory usage. The perl interpreter should
184be enabled, as important functionality (menus, selection, likely more in
185the future) depends on it.
186 235
187You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
188system-wide (except maybe with C<defaults>). This will result in useful 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
189behaviour. If your distribution aims at low memory, add an empty
190C<perl-ext-common> resource to the app-defaults file. This will keep the
191perl interpreter disabled until the user enables it.
192 238
193If you can/want build more binaries, I recommend building a minimal 239That works. If you think it doesn't, you lack AfterImage support, or you
194one with C<--disable-everything> (very useful) and a maximal one with 240are unable to read.
195C<--enable-everything> (less useful, it will be very big due to a lot of
196encodings built-in that increase download times and are rarely used).
197 241
198=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 2423. Use an ARGB visual:
199 243
200It should be, starting with release 7.1. You are encouraged to properly 244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
201install urxvt with privileges necessary for your OS now.
202 245
203When rxvt-unicode detects that it runs setuid or setgid, it will fork 246This requires XFT support, and the support of your X-server. If that
204into a helper process for privileged operations (pty handling on some 247doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
205systems, utmp/wtmp/lastlog handling on others) and drop privileges 248there yet, no matter what they claim. Rxvt-Unicode contains the necessary
206immediately. This is much safer than most other terminals that keep 249bugfixes and workarounds for Xft and Xlib to make it work, but that
207privileges while running (but is more relevant to urxvt, as it contains 250doesn't mean that your WM has the required kludges in place.
208things as perl interpreters, which might be "helpful" to attackers).
209 251
210This forking is done as the very first within main(), which is very early 2524. Use xcompmgr and let it do the job:
211and reduces possible bugs to initialisation code run before main(), or
212things like the dynamic loader of your system, which should result in very
213little risk.
214 253
215=item When I log-in to another system it tells me about missing terminfo data? 254 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
255 -set _NET_WM_WINDOW_OPACITY 0xc0000000
216 256
217The terminal description used by rxvt-unicode is not as widely available 257Then click on a window you want to make transparent. Replace C<0xc0000000>
218as that for xterm, or even rxvt (for which the same problem often arises). 258by other values to change the degree of opacity. If it doesn't work and
259your server crashes, you got to keep the pieces.
219 260
220The correct solution for this problem is to install the terminfo, this can
221be done like this (with ncurses' infocmp):
222
223 REMOTE=remotesystem.domain
224 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
225
226... or by installing rxvt-unicode normally on the remote system,
227
228If you cannot or do not want to do this, then you can simply set
229C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
230problems arising, which includes wrong keymapping, less and different
231colours and some refresh errors in fullscreen applications. It's a nice
232quick-and-dirty workaround for rare cases, though.
233
234If you always want to do this (and are fine with the consequences) you
235can either recompile rxvt-unicode with the desired TERM value or use a
236resource to set it:
237
238 URxvt.termName: rxvt
239
240If you don't plan to use B<rxvt> (quite common...) you could also replace
241the rxvt terminfo file with the rxvt-unicode one.
242
243=item C<tic> outputs some error when compiling the terminfo entry.
244
245Most likely it's the empty definition for C<enacs=>. Just replace it by
246C<enacs=\E[0@> and try again.
247
248=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
249
250=item I need a termcap file entry.
251
252One reason you might want this is that some distributions or operating
253systems still compile some programs using the long-obsoleted termcap
254library (Fedora Core's bash is one example) and rely on a termcap entry
255for C<rxvt-unicode>.
256
257You could use rxvt's termcap entry with resonable results in many cases.
258You can also create a termcap entry by using terminfo's infocmp program
259like this:
260
261 infocmp -C rxvt-unicode
262
263Or you could use this termcap entry, generated by the command above:
264
265 rxvt-unicode|rxvt-unicode terminal (X Window System):\
266 :am:bw:eo:km:mi:ms:xn:xo:\
267 :co#80:it#8:li#24:lm#0:\
268 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
269 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
270 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
271 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
272 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
273 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
274 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
275 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
276 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
277 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
278 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
279 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
280 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
281 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
282 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
283 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
284 :vs=\E[?25h:
285
286=item Why does C<ls> no longer have coloured output?
287
288The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
289decide wether a terminal has colour, but uses it's own configuration
290file. Needless to say, C<rxvt-unicode> is not in it's default file (among
291with most other terminals supporting colour). Either add:
292
293 TERM rxvt-unicode
294
295to C</etc/DIR_COLORS> or simply add:
296
297 alias ls='ls --color=auto'
298
299to your C<.profile> or C<.bashrc>.
300
301=item Why doesn't vim/emacs etc. use the 88 colour mode?
302
303=item Why doesn't vim/emacs etc. make use of italic?
304
305=item Why are the secondary screen-related options not working properly?
306
307Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
308distributions (most notably Debian GNU/Linux) break rxvt-unicode
309by setting C<TERM> to C<rxvt>, which doesn't have these extra
310features. Unfortunately, some of these (most notably, again, Debian
311GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
312file, so you will need to install it on your own (See the question B<When
313I log-in to another system it tells me about missing terminfo data?> on
314how to do this).
315
316=item My numerical keypad acts weird and generates differing output?
317
318Some Debian GNUL/Linux users seem to have this problem, although no
319specific details were reported so far. It is possible that this is caused
320by the wrong C<TERM> setting, although the details of wether and how
321this can happen are unknown, as C<TERM=rxvt> should offer a compatible
322keymap. See the answer to the previous question, and please report if that
323helped.
324
325=item Rxvt-unicode does not seem to understand the selected encoding?
326
327=item Unicode does not seem to work?
328
329If you encounter strange problems like typing an accented character but
330getting two unrelated other characters or similar, or if program output is
331subtly garbled, then you should check your locale settings.
332
333Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
334programs. Often rxvt-unicode is started in the C<C> locale, while the
335login script running within the rxvt-unicode window changes the locale to
336something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
337
338The best thing is to fix your startup environment, as you will likely run
339into other problems. If nothing works you can try this in your .profile.
340
341 printf '\e]701;%s\007' "$LC_CTYPE"
342
343If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
344supported on your systems. Some systems have a C<locale> command which
345displays this (also, C<perl -e0> can be used to check locale settings, as
346it will complain loudly if it cannot set the locale). If it displays something
347like:
348
349 locale: Cannot set LC_CTYPE to default locale: ...
350
351Then the locale you specified is not supported on your system.
352
353If nothing works and you are sure that everything is set correctly then
354you will need to remember a little known fact: Some programs just don't
355support locales :(
356
357=item Why do some characters look so much different than others?
358
359=item How does rxvt-unicode choose fonts?
360
361Most fonts do not contain the full range of Unicode, which is
362fine. Chances are that the font you (or the admin/package maintainer of
363your system/os) have specified does not cover all the characters you want
364to display.
365
366B<rxvt-unicode> makes a best-effort try at finding a replacement
367font. Often the result is fine, but sometimes the chosen font looks
368bad/ugly/wrong. Some fonts have totally strange characters that don't
369resemble the correct glyph at all, and rxvt-unicode lacks the artificial
370intelligence to detect that a specific glyph is wrong: it has to believe
371the font that the characters it claims to contain indeed look correct.
372
373In that case, select a font of your taste and add it to the font list,
374e.g.:
375
376 @@RXVT_NAME@@ -fn basefont,font2,font3...
377
378When rxvt-unicode sees a character, it will first look at the base
379font. If the base font does not contain the character, it will go to the
380next font, and so on. Specifying your own fonts will also speed up this
381search and use less resources within rxvt-unicode and the X-server.
382
383The only limitation is that none of the fonts may be larger than the base
384font, as the base font defines the terminal character cell size, which
385must be the same due to the way terminals work.
386
387=item Why do some chinese characters look so different than others?
388
389This is because there is a difference between script and language --
390rxvt-unicode does not know which language the text that is output is,
391as it only knows the unicode character codes. If rxvt-unicode first
392sees a japanese/chinese character, it might choose a japanese font for
393display. Subsequent japanese characters will use that font. Now, many
394chinese characters aren't represented in japanese fonts, so when the first
395non-japanese character comes up, rxvt-unicode will look for a chinese font
396-- unfortunately at this point, it will still use the japanese font for
397chinese characters that are also in the japanese font.
398
399The workaround is easy: just tag a chinese font at the end of your font
400list (see the previous question). The key is to view the font list as
401a preference list: If you expect more japanese, list a japanese font
402first. If you expect more chinese, put a chinese font first.
403
404In the future it might be possible to switch language preferences at
405runtime (the internal data structure has no problem with using different
406fonts for the same character at the same time, but no interface for this
407has been designed yet).
408
409Until then, you might get away with switching fonts at runtime (see L<Can
410I switch the fonts at runtime?> later in this document).
411
412=item Why does rxvt-unicode sometimes leave pixel droppings? 261=head3 Why does rxvt-unicode sometimes leave pixel droppings?
413 262
414Most fonts were not designed for terminal use, which means that character 263Most fonts were not designed for terminal use, which means that character
415size varies a lot. A font that is otherwise fine for terminal use might 264size varies a lot. A font that is otherwise fine for terminal use might
416contain some characters that are simply too wide. Rxvt-unicode will avoid 265contain some characters that are simply too wide. Rxvt-unicode will avoid
417these characters. For characters that are just "a bit" too wide a special 266these characters. For characters that are just "a bit" too wide a special
421however: Xft fonts often draw glyphs larger than their acclaimed bounding 270however: Xft fonts often draw glyphs larger than their acclaimed bounding
422box, and rxvt-unicode has no way of detecting this (the correct way is to 271box, and rxvt-unicode has no way of detecting this (the correct way is to
423ask for the character bounding box, which unfortunately is wrong in these 272ask for the character bounding box, which unfortunately is wrong in these
424cases). 273cases).
425 274
426It's not clear (to me at least), wether this is a bug in Xft, freetype, 275It's not clear (to me at least), whether this is a bug in Xft, freetype,
427or the respective font. If you encounter this problem you might try using 276or the respective font. If you encounter this problem you might try using
428the C<-lsp> option to give the font more height. If that doesn't work, you 277the C<-lsp> option to give the font more height. If that doesn't work, you
429might be forced to use a different font. 278might be forced to use a different font.
430 279
431All of this is not a problem when using X11 core fonts, as their bounding 280All of this is not a problem when using X11 core fonts, as their bounding
432box data is correct. 281box data is correct.
433 282
434=item On Solaris 9, many line-drawing characters are too wide.
435
436Seems to be a known bug, read
437L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
438following ugly workaround to get non-double-wide-characters working:
439
440 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
441
442=item My Compose (Multi_key) key is no longer working.
443
444The most common causes for this are that either your locale is not set
445correctly, or you specified a B<preeditStyle> that is not supported by
446your input method. For example, if you specified B<OverTheSpot> and
447your input method (e.g. the default input method handling Compose keys)
448does not support this (for instance because it is not visual), then
449rxvt-unicode will continue without an input method.
450
451In this case either do not specify a B<preeditStyle> or specify more than
452one pre-edit style, such as B<OverTheSpot,Root,None>.
453
454=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
455
456Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
457international keyboards) or simply use ISO 14755 support to your
458advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
459codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
460character and so on.
461
462=item How can I keep rxvt-unicode from using reverse video so much? 283=head3 How can I keep rxvt-unicode from using reverse video so much?
463 284
464First of all, make sure you are running with the right terminal settings 285First of all, make sure you are running with the right terminal settings
465(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 286(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
466make sure you have specified colours for italic and bold, as otherwise 287make sure you have specified colours for italic and bold, as otherwise
467rxvt-unicode might use reverse video to simulate the effect: 288rxvt-unicode might use reverse video to simulate the effect:
468 289
469 URxvt.colorBD: white 290 URxvt.colorBD: white
470 URxvt.colorIT: green 291 URxvt.colorIT: green
471 292
472=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 293=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
473 294
474For some unexplainable reason, some rare programs assume a very weird 295For some unexplainable reason, some rare programs assume a very weird
475colour palette when confronted with a terminal with more than the standard 296colour palette when confronted with a terminal with more than the standard
4768 colours (rxvt-unicode supports 88). The right fix is, of course, to fix 2978 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
477these programs not to assume non-ISO colours without very good reasons. 298these programs not to assume non-ISO colours without very good reasons.
478 299
479In the meantime, you can either edit your C<rxvt-unicode> terminfo 300In the meantime, you can either edit your C<rxvt-unicode> terminfo
480definition to only claim 8 colour support or use C<TERM=rxvt>, which will 301definition to only claim 8 colour support or use C<TERM=rxvt>, which will
481fix colours but keep you from using other rxvt-unicode features. 302fix colours but keep you from using other rxvt-unicode features.
482 303
483=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
484
485Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
486in your compile environment, or an implementation that implements it,
487wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
488B<wchar_t> is represented as unicode.
489
490As you might have guessed, FreeBSD does neither define this symobl nor
491does it support it. Instead, it uses it's own internal representation of
492B<wchar_t>. This is, of course, completely fine with respect to standards.
493
494However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
495C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
496
497C<__STDC_ISO_10646__> is the only sane way to support multi-language
498apps in an OS, as using a locale-dependent (and non-standardized)
499representation of B<wchar_t> makes it impossible to convert between
500B<wchar_t> (as used by X11 and your applications) and any other encoding
501without implementing OS-specific-wrappers for each and every locale. There
502simply are no APIs to convert B<wchar_t> into anything except the current
503locale encoding.
504
505Some applications (such as the formidable B<mlterm>) work around this
506by carrying their own replacement functions for character set handling
507with them, and either implementing OS-dependent hacks or doing multiple
508conversions (which is slow and unreliable in case the OS implements
509encodings slightly different than the terminal emulator).
510
511The rxvt-unicode author insists that the right way to fix this is in the
512system libraries once and for all, instead of forcing every app to carry
513complete replacements for them :)
514
515=item I use Solaris 9 and it doesn't compile/work/etc.
516
517Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
518problems with C<wcwidth> and a compile problem.
519
520=item How can I use rxvt-unicode under cygwin?
521
522rxvt-unicode should compile and run out of the box on cygwin, using
523the X11 libraries that come with cygwin. libW11 emulation is no
524longer supported (and makes no sense, either, as it only supported a
525single font). I recommend starting the X-server in C<-multiwindow> or
526C<-rootless> mode instead, which will result in similar look&feel as the
527old libW11 emulation.
528
529At the time of this writing, cygwin didn't seem to support any multi-byte
530encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
531to 8-bit encodings.
532
533=item How does rxvt-unicode determine the encoding to use?
534
535=item Is there an option to switch encodings?
536
537Unlike some other terminals, rxvt-unicode has no encoding switch, and no
538specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
539UTF-8 or any other encodings with respect to terminal I/O.
540
541The reasons is that there exists a perfectly fine mechanism for selecting
542the encoding, doing I/O and (most important) communicating this to all
543applications so everybody agrees on character properties such as width
544and code number. This mechanism is the I<locale>. Applications not using
545that info will have problems (for example, C<xterm> gets the width of
546characters wrong as it uses it's own, locale-independent table under all
547locales).
548
549Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
550programs doing the same (that is, most) will automatically agree in the
551interpretation of characters.
552
553Unfortunately, there is no system-independent way to select locales, nor
554is there a standard on how locale specifiers will look like.
555
556On most systems, the content of the C<LC_CTYPE> environment variable
557contains an arbitrary string which corresponds to an already-installed
558locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
559C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
560(i.e. C<de> or C<german>) are also common.
561
562Rxvt-unicode ignores all other locale categories, and except for
563the encoding, ignores country or language-specific settings,
564i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
565rxvt-unicode.
566
567If you want to use a specific encoding you have to make sure you start
568rxvt-unicode with the correct C<LC_CTYPE> category.
569
570=item Can I switch locales at runtime?
571
572Yes, using an escape sequence. Try something like this, which sets
573rxvt-unicode's idea of C<LC_CTYPE>.
574
575 printf '\e]701;%s\007' ja_JP.SJIS
576
577See also the previous answer.
578
579Sometimes this capability is rather handy when you want to work in
580one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
581(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
582first switches to a locale supported by xjdic and back later:
583
584 printf '\e]701;%s\007' ja_JP.SJIS
585 xjdic -js
586 printf '\e]701;%s\007' de_DE.UTF-8
587
588You can also use xterm's C<luit> program, which usually works fine, except
589for some locales where character width differs between program- and
590rxvt-unicode-locales.
591
592=item Can I switch the fonts at runtime? 304=head3 Can I switch the fonts at runtime?
593 305
594Yes, using an escape sequence. Try something like this, which has the same 306Yes, using an escape sequence. Try something like this, which has the same
595effect as using the C<-fn> switch, and takes effect immediately: 307effect as using the C<-fn> switch, and takes effect immediately:
596 308
597 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 309 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
598 310
599This is useful if you e.g. work primarily with japanese (and prefer a 311This is useful if you e.g. work primarily with japanese (and prefer a
600japanese font), but you have to switch to chinese temporarily, where 312japanese font), but you have to switch to chinese temporarily, where
601japanese fonts would only be in your way. 313japanese fonts would only be in your way.
602 314
603You can think of this as a kind of manual ISO-2022 switching. 315You can think of this as a kind of manual ISO-2022 switching.
604 316
605=item Why do italic characters look as if clipped? 317=head3 Why do italic characters look as if clipped?
606 318
607Many fonts have difficulties with italic characters and hinting. For 319Many fonts have difficulties with italic characters and hinting. For
608example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
609Mono> completely fails in it's italic face. A workaround might be to 321Mono> completely fails in its italic face. A workaround might be to
610enable freetype autohinting, i.e. like this: 322enable freetype autohinting, i.e. like this:
611 323
612 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 324 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
613 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 325 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
614 326
615=item My input method wants <some encoding> but I want UTF-8, what can I do?
616
617You can specify separate locales for the input method and the rest of the
618terminal, using the resource C<imlocale>:
619
620 URxvt.imlocale: ja_JP.EUC-JP
621
622Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
623use your input method. Please note, however, that you will not be able to
624input characters outside C<EUC-JP> in a normal way then, as your input
625method limits you.
626
627=item Rxvt-unicode crashes when the X Input Method changes or exits.
628
629Unfortunately, this is unavoidable, as the XIM protocol is racy by
630design. Applications can avoid some crashes at the expense of memory
631leaks, and Input Methods can avoid some crashes by careful ordering at
632exit time. B<kinput2> (and derived input methods) generally succeeds,
633while B<SCIM> (or similar input methods) fails. In the end, however,
634crashes cannot be completely avoided even if both sides cooperate.
635
636So the only workaround is not to kill your Input Method Servers.
637
638=item Rxvt-unicode uses gobs of memory, how can I reduce that?
639
640Rxvt-unicode tries to obey the rule of not charging you for something you
641don't use. One thing you should try is to configure out all settings that
642you don't need, for example, Xft support is a resource hog by design,
643when used. Compiling it out ensures that no Xft font will be loaded
644accidentally when rxvt-unicode tries to find a font for your characters.
645
646Also, many people (me included) like large windows and even larger
647scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6486 bytes per screen cell. For a 160x?? window this amounts to almost a
649kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
650use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
651rxvt-unicode then uses 8 bytes per screen cell.
652
653=item Can I speed up Xft rendering somehow? 327=head3 Can I speed up Xft rendering somehow?
654 328
655Yes, the most obvious way to speed it up is to avoid Xft entirely, as 329Yes, the most obvious way to speed it up is to avoid Xft entirely, as
656it is simply slow. If you still want Xft fonts you might try to disable 330it is simply slow. If you still want Xft fonts you might try to disable
657antialiasing (by appending C<:antialias=false>), which saves lots of 331antialiasing (by appending C<:antialias=false>), which saves lots of
658memory and also speeds up rendering considerably. 332memory and also speeds up rendering considerably.
659 333
660=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 334=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
661 335
662Rxvt-unicode will use whatever you specify as a font. If it needs to 336Rxvt-unicode will use whatever you specify as a font. If it needs to
663fall back to it's default font search list it will prefer X11 core 337fall back to its default font search list it will prefer X11 core
664fonts, because they are small and fast, and then use Xft fonts. It has 338fonts, because they are small and fast, and then use Xft fonts. It has
665antialiasing disabled for most of them, because the author thinks they 339antialiasing disabled for most of them, because the author thinks they
666look best that way. 340look best that way.
667 341
668If you want antialiasing, you have to specify the fonts manually. 342If you want antialiasing, you have to specify the fonts manually.
669 343
670=item Mouse cut/paste suddenly no longer works.
671
672Make sure that mouse reporting is actually turned off since killing
673some editors prematurely may leave the mouse in mouse report mode. I've
674heard that tcsh may use mouse reporting unless it otherwise specified. A
675quick check is to see if cut/paste works when the Alt or Shift keys are
676depressed.
677
678=item What's with this bold/blink stuff? 344=head3 What's with this bold/blink stuff?
679 345
680If no bold colour is set via C<colorBD:>, bold will invert text using the 346If no bold colour is set via C<colorBD:>, bold will invert text using the
681standard foreground colour. 347standard foreground colour.
682 348
683For the standard background colour, blinking will actually make the 349For the standard background colour, blinking will actually make
684text blink when compiled with C<--enable-blinking>. with standard 350the text blink when compiled with C<--enable-text-blink>. Without
685colours. Without C<--enable-blinking>, the blink attribute will be 351C<--enable-text-blink>, the blink attribute will be ignored.
686ignored.
687 352
688On ANSI colours, bold/blink attributes are used to set high-intensity 353On ANSI colours, bold/blink attributes are used to set high-intensity
689foreground/background colors. 354foreground/background colors.
690 355
691color0-7 are the low-intensity colors. 356color0-7 are the low-intensity colors.
692 357
693color8-15 are the corresponding high-intensity colors. 358color8-15 are the corresponding high-intensity colors.
694 359
695=item I don't like the screen colors. How do I change them? 360=head3 I don't like the screen colors. How do I change them?
696 361
697You can change the screen colors at run-time using F<~/.Xdefaults> 362You can change the screen colors at run-time using F<~/.Xdefaults>
698resources (or as long-options). 363resources (or as long-options).
699 364
700Here are values that are supposed to resemble a VGA screen, 365Here are values that are supposed to resemble a VGA screen,
716 URxvt.color12: #0000FF 381 URxvt.color12: #0000FF
717 URxvt.color13: #FF00FF 382 URxvt.color13: #FF00FF
718 URxvt.color14: #00FFFF 383 URxvt.color14: #00FFFF
719 URxvt.color15: #FFFFFF 384 URxvt.color15: #FFFFFF
720 385
721And here is a more complete set of non-standard colors described (not by 386And here is a more complete set of non-standard colors.
722me) as "pretty girly".
723 387
724 URxvt.cursorColor: #dc74d1 388 URxvt.cursorColor: #dc74d1
725 URxvt.pointerColor: #dc74d1 389 URxvt.pointerColor: #dc74d1
726 URxvt.background: #0e0e0e 390 URxvt.background: #0e0e0e
727 URxvt.foreground: #4ad5e1 391 URxvt.foreground: #4ad5e1
738 URxvt.color6: #73f7ff 402 URxvt.color6: #73f7ff
739 URxvt.color14: #73f7ff 403 URxvt.color14: #73f7ff
740 URxvt.color7: #e1dddd 404 URxvt.color7: #e1dddd
741 URxvt.color15: #e1dddd 405 URxvt.color15: #e1dddd
742 406
743=item How can I start @@RXVT_NAME@@d in a race-free way? 407They have been described (not by me) as "pretty girly".
744 408
745Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 409=head3 Why do some characters look so much different than others?
746display, create the listening socket and then fork.
747 410
411See next entry.
412
413=head3 How does rxvt-unicode choose fonts?
414
415Most fonts do not contain the full range of Unicode, which is
416fine. Chances are that the font you (or the admin/package maintainer of
417your system/os) have specified does not cover all the characters you want
418to display.
419
420B<rxvt-unicode> makes a best-effort try at finding a replacement
421font. Often the result is fine, but sometimes the chosen font looks
422bad/ugly/wrong. Some fonts have totally strange characters that don't
423resemble the correct glyph at all, and rxvt-unicode lacks the artificial
424intelligence to detect that a specific glyph is wrong: it has to believe
425the font that the characters it claims to contain indeed look correct.
426
427In that case, select a font of your taste and add it to the font list,
428e.g.:
429
430 @@URXVT_NAME@@ -fn basefont,font2,font3...
431
432When rxvt-unicode sees a character, it will first look at the base
433font. If the base font does not contain the character, it will go to the
434next font, and so on. Specifying your own fonts will also speed up this
435search and use less resources within rxvt-unicode and the X-server.
436
437The only limitation is that none of the fonts may be larger than the base
438font, as the base font defines the terminal character cell size, which
439must be the same due to the way terminals work.
440
441=head3 Why do some chinese characters look so different than others?
442
443This is because there is a difference between script and language --
444rxvt-unicode does not know which language the text that is output is,
445as it only knows the unicode character codes. If rxvt-unicode first
446sees a japanese/chinese character, it might choose a japanese font for
447display. Subsequent japanese characters will use that font. Now, many
448chinese characters aren't represented in japanese fonts, so when the first
449non-japanese character comes up, rxvt-unicode will look for a chinese font
450-- unfortunately at this point, it will still use the japanese font for
451chinese characters that are also in the japanese font.
452
453The workaround is easy: just tag a chinese font at the end of your font
454list (see the previous question). The key is to view the font list as
455a preference list: If you expect more japanese, list a japanese font
456first. If you expect more chinese, put a chinese font first.
457
458In the future it might be possible to switch language preferences at
459runtime (the internal data structure has no problem with using different
460fonts for the same character at the same time, but no interface for this
461has been designed yet).
462
463Until then, you might get away with switching fonts at runtime (see L<Can
464I switch the fonts at runtime?> later in this document).
465
466=head3 How can I make mplayer display video correctly?
467
468We are working on it, in the meantime, as a workaround, use something like:
469
470 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
471
472
473=head2 Keyboard, Mouse & User Interaction
474
475=head3 The new selection selects pieces that are too big, how can I select single words?
476
477If you want to select e.g. alphanumeric words, you can use the following
478setting:
479
480 URxvt.selection.pattern-0: ([[:word:]]+)
481
482If you click more than twice, the selection will be extended
483more and more.
484
485To get a selection that is very similar to the old code, try this pattern:
486
487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
488
489Please also note that the I<LeftClick Shift-LeftClick> combination also
490selects words like the old code.
491
492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
493
494You can disable the perl extension completely by setting the
495B<perl-ext-common> resource to the empty string, which also keeps
496rxvt-unicode from initialising perl, saving memory.
497
498If you only want to disable specific features, you first have to
499identify which perl extension is responsible. For this, read the section
500B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
501example, to disable the B<selection-popup> and B<option-popup>, specify
502this B<perl-ext-common> resource:
503
504 URxvt.perl-ext-common: default,-selection-popup,-option-popup
505
506This will keep the default extensions, but disable the two popup
507extensions. Some extensions can also be configured, for example,
508scrollback search mode is triggered by B<M-s>. You can move it to any
509other combination either by setting the B<searchable-scrollback> resource:
510
511 URxvt.searchable-scrollback: CM-s
512
513=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
514
515See next entry.
516
517=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
518
519These are caused by the C<readline> perl extension. Under normal
520circumstances, it will move your cursor around when you click into the
521line that contains it. It tries hard not to do this at the wrong moment,
522but when running a program that doesn't parse cursor movements or in some
523cases during rlogin sessions, it fails to detect this properly.
524
525You can permanently switch this feature off by disabling the C<readline>
526extension:
527
528 URxvt.perl-ext-common: default,-readline
529
530=head3 My numerical keypad acts weird and generates differing output?
531
532Some Debian GNUL/Linux users seem to have this problem, although no
533specific details were reported so far. It is possible that this is caused
534by the wrong C<TERM> setting, although the details of whether and how
535this can happen are unknown, as C<TERM=rxvt> should offer a compatible
536keymap. See the answer to the previous question, and please report if that
537helped.
538
539=head3 My Compose (Multi_key) key is no longer working.
540
541The most common causes for this are that either your locale is not set
542correctly, or you specified a B<preeditStyle> that is not supported by
543your input method. For example, if you specified B<OverTheSpot> and
544your input method (e.g. the default input method handling Compose keys)
545does not support this (for instance because it is not visual), then
546rxvt-unicode will continue without an input method.
547
548In this case either do not specify a B<preeditStyle> or specify more than
549one pre-edit style, such as B<OverTheSpot,Root,None>.
550
551=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
552
553Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
554international keyboards) or simply use ISO 14755 support to your
555advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
556codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
557character and so on.
558
559=head3 Mouse cut/paste suddenly no longer works.
560
561Make sure that mouse reporting is actually turned off since killing
562some editors prematurely may leave the mouse in mouse report mode. I've
563heard that tcsh may use mouse reporting unless it otherwise specified. A
564quick check is to see if cut/paste works when the Alt or Shift keys are
565depressed.
566
748=item What's with the strange Backspace/Delete key behaviour? 567=head3 What's with the strange Backspace/Delete key behaviour?
749 568
750Assuming that the physical Backspace key corresponds to the 569Assuming that the physical Backspace key corresponds to the
751BackSpace keysym (not likely for Linux ... see the following 570Backspace keysym (not likely for Linux ... see the following
752question) there are two standard values that can be used for 571question) there are two standard values that can be used for
753Backspace: C<^H> and C<^?>. 572Backspace: C<^H> and C<^?>.
754 573
755Historically, either value is correct, but rxvt-unicode adopts the debian 574Historically, either value is correct, but rxvt-unicode adopts the debian
756policy of using C<^?> when unsure, because it's the one only only correct 575policy of using C<^?> when unsure, because it's the one and only correct
757choice :). 576choice :).
758 577
759Rxvt-unicode tries to inherit the current stty settings and uses the value 578Rxvt-unicode tries to inherit the current stty settings and uses the value
760of `erase' to guess the value for backspace. If rxvt-unicode wasn't 579of `erase' to guess the value for backspace. If rxvt-unicode wasn't
761started from a terminal (say, from a menu or by remote shell), then the 580started from a terminal (say, from a menu or by remote shell), then the
764 583
765For starting a new rxvt-unicode: 584For starting a new rxvt-unicode:
766 585
767 # use Backspace = ^H 586 # use Backspace = ^H
768 $ stty erase ^H 587 $ stty erase ^H
769 $ @@RXVT_NAME@@ 588 $ @@URXVT_NAME@@
770 589
771 # use Backspace = ^? 590 # use Backspace = ^?
772 $ stty erase ^? 591 $ stty erase ^?
773 $ @@RXVT_NAME@@ 592 $ @@URXVT_NAME@@
774 593
775Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. 594Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
776 595
777For an existing rxvt-unicode: 596For an existing rxvt-unicode:
778 597
799some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
800GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
801 620
802Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
803 622
804=item I don't like the key-bindings. How do I change them? 623=head3 I don't like the key-bindings. How do I change them?
805 624
806There are some compile-time selections available via configure. Unless 625There are some compile-time selections available via configure. Unless
807you have run "configure" with the C<--disable-resources> option you can 626you have run "configure" with the C<--disable-resources> option you can
808use the `keysym' resource to alter the keystrings associated with keysyms. 627use the `keysym' resource to alter the keystrings associated with keysyms.
809 628
810Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 629Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
811 630
812 URxvt.keysym.Home: \033[1~ 631 URxvt.keysym.Home: \033[1~
813 URxvt.keysym.End: \033[4~ 632 URxvt.keysym.End: \033[4~
814 URxvt.keysym.C-apostrophe: \033<C-'> 633 URxvt.keysym.C-apostrophe: \033<C-'>
815 URxvt.keysym.C-slash: \033<C-/> 634 URxvt.keysym.C-slash: \033<C-/>
830 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 649 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
831 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 650 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
832 651
833See some more examples in the documentation for the B<keysym> resource. 652See some more examples in the documentation for the B<keysym> resource.
834 653
835=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 654=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
836How do I make use of them? For example, the Sun Keyboard type 4
837has the following mappings that rxvt-unicode doesn't recognize.
838 655
839 KP_Insert == Insert 656 KP_Insert == Insert
840 F22 == Print 657 F22 == Print
841 F27 == Home 658 F27 == Home
842 F29 == Prior 659 F29 == Prior
845 662
846Rather than have rxvt-unicode try to accommodate all the various possible 663Rather than have rxvt-unicode try to accommodate all the various possible
847keyboard mappings, it is better to use `xmodmap' to remap the keys as 664keyboard mappings, it is better to use `xmodmap' to remap the keys as
848required for your particular machine. 665required for your particular machine.
849 666
850=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
851I need this to decide about setting colors etc.
852 667
853rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 668=head2 Terminal Configuration
854check and see if that is set. Note that several programs, JED, slrn,
855Midnight Commander automatically check this variable to decide whether or
856not to use color.
857 669
858=item How do I set the correct, full IP address for the DISPLAY variable? 670=head3 Can I see a typical configuration?
859 671
860If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 672The default configuration tries to be xterm-like, which I don't like that
861insecure mode then it is possible to use the following shell script 673much, but it's least surprise to regular users.
862snippets to correctly set the display. If your version of rxvt-unicode
863wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
864the COLORTERM variable can be used to distinguish rxvt-unicode from a
865regular xterm.
866 674
867Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 675As a rxvt or rxvt-unicode user, you are practically supposed to invest
868snippets: 676time into customising your terminal. To get you started, here is the
677author's .Xdefaults entries, with comments on what they do. It's certainly
678not I<typical>, but what's typical...
869 679
870 # Bourne/Korn/POSIX family of shells: 680 URxvt.cutchars: "()*,<>[]{}|'
871 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 681 URxvt.print-pipe: cat >/tmp/xxx
872 if [ ${TERM:-foo} = xterm ]; then
873 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
874 echo -n '^[Z'
875 read term_id
876 stty icanon echo
877 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
878 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
879 read DISPLAY # set it in our local shell
880 fi
881 fi
882 682
883=item How do I compile the manual pages for myself? 683These are just for testing stuff.
884 684
885You need to have a recent version of perl installed as F</usr/bin/perl>, 685 URxvt.imLocale: ja_JP.UTF-8
886one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 686 URxvt.preeditType: OnTheSpot,None
887the doc subdirectory and enter C<make alldoc>.
888 687
889=item My question isn't answered here, can I ask a human? 688This tells rxvt-unicode to use a special locale when communicating with
689the X Input Method, and also tells it to only use the OnTheSpot pre-edit
690type, which requires the C<xim-onthespot> perl extension but rewards me
691with correct-looking fonts.
890 692
891Before sending me mail, you could go to IRC: C<irc.freenode.net>, 693 URxvt.perl-lib: /root/lib/urxvt
892channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 694 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
893interested in learning about new and exciting problems (but not FAQs :). 695 URxvt.selection.pattern-0: ( at .*? line \\d+)
696 URxvt.selection.pattern-1: ^(/[^:]+):\
697 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
698 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
699
700This is my perl configuration. The first two set the perl library
701directory and also tells urxvt to use a large number of extensions. I
702develop for myself mostly, so I actually use most of the extensions I
703write.
704
705The selection stuff mainly makes the selection perl-error-message aware
706and tells it to convert perl error messages into vi-commands to load the
707relevant file and go tot he error line number.
708
709 URxvt.scrollstyle: plain
710 URxvt.secondaryScroll: true
711
712As the documentation says: plain is the preferred scrollbar for the
713author. The C<secondaryScroll> configures urxvt to scroll in full-screen
714apps, like screen, so lines scrolled out of screen end up in urxvt's
715scrollback buffer.
716
717 URxvt.background: #000000
718 URxvt.foreground: gray90
719 URxvt.color7: gray90
720 URxvt.colorBD: #ffffff
721 URxvt.cursorColor: #e0e080
722 URxvt.throughColor: #8080f0
723 URxvt.highlightColor: #f0f0f0
724
725Some colours. Not sure which ones are being used or even non-defaults, but
726these are in my .Xdefaults. Most notably, they set foreground/background
727to light gray/black, and also make sure that the colour 7 matches the
728default foreground colour.
729
730 URxvt.underlineColor: yellow
731
732Another colour, makes underline lines look different. Sometimes hurts, but
733is mostly a nice effect.
734
735 URxvt.geometry: 154x36
736 URxvt.loginShell: false
737 URxvt.meta: ignore
738 URxvt.utmpInhibit: true
739
740Uh, well, should be mostly self-explanatory. By specifying some defaults
741manually, I can quickly switch them for testing.
742
743 URxvt.saveLines: 8192
744
745A large scrollback buffer is essential. Really.
746
747 URxvt.mapAlert: true
748
749The only case I use it is for my IRC window, which I like to keep
750iconified till people msg me (which beeps).
751
752 URxvt.visualBell: true
753
754The audible bell is often annoying, especially when in a crowd.
755
756 URxvt.insecure: true
757
758Please don't hack my mutt! Ooops...
759
760 URxvt.pastableTabs: false
761
762I once thought this is a great idea.
763
764 urxvt.font: 9x15bold,\
765 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
766 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
767 [codeset=JISX0208]xft:Kochi Gothic, \
768 xft:Bitstream Vera Sans Mono:autohint=true, \
769 xft:Code2000:antialias=false
770 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
771 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
772 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
773
774I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
775overwhelmed. A special note: the C<9x15bold> mentioned above is actually
776the version from XFree-3.3, as XFree-4 replaced it by a totally different
777font (different glyphs for C<;> and many other harmless characters),
778while the second font is actually the C<9x15bold> from XFree4/XOrg. The
779bold version has less chars than the medium version, so I use it for rare
780characters, too. When editing sources with vim, I use italic for comments
781and other stuff, which looks quite good with Bitstream Vera anti-aliased.
782
783Terminus is a quite bad font (many very wrong glyphs), but for most of my
784purposes, it works, and gives a different look, as my normal (Non-bold)
785font is already bold, and I want to see a difference between bold and
786normal fonts.
787
788Please note that I used the C<urxvt> instance name and not the C<URxvt>
789class name. Thats because I use different configs for different purposes,
790for example, my IRC window is started with C<-name IRC>, and uses these
791defaults:
792
793 IRC*title: IRC
794 IRC*geometry: 87x12+535+542
795 IRC*saveLines: 0
796 IRC*mapAlert: true
797 IRC*font: suxuseuro
798 IRC*boldFont: suxuseuro
799 IRC*colorBD: white
800 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
801 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
802
803C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
804sizes. C<suxuseuro> allows me to keep an eye (and actually read)
805stuff while keeping a very small window. If somebody pastes something
806complicated (e.g. japanese), I temporarily switch to a larger font.
807
808The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
809C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
810file for different hosts, for example, on ym main desktop, I use:
811
812 URxvt.keysym.C-M-q: command:\033[3;5;5t
813 URxvt.keysym.C-M-y: command:\033[3;5;606t
814 URxvt.keysym.C-M-e: command:\033[3;1605;5t
815 URxvt.keysym.C-M-c: command:\033[3;1605;606t
816 URxvt.keysym.C-M-p: perl:test
817
818The first for keysym definitions allow me to quickly bring some windows
819in the layout I like most. Ion users might start laughing but will stop
820immediately when I tell them that I use my own Fvwm2 module for much the
821same effect as Ion provides, and I only very rarely use the above key
822combinations :->
823
824=head3 Why doesn't rxvt-unicode read my resources?
825
826Well, why, indeed? It does, in a way very similar to other X
827applications. Most importantly, this means that if you or your OS loads
828resources into the X display (the right way to do it), rxvt-unicode will
829ignore any resource files in your home directory. It will only read
830F<$HOME/.Xdefaults> when no resources are attached to the display.
831
832If you have or use an F<$HOME/.Xresources> file, chances are that
833resources are loaded into your X-server. In this case, you have to
834re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
835
836Also consider the form resources have to use:
837
838 URxvt.resource: value
839
840If you want to use another form (there are lots of different ways of
841specifying resources), make sure you understand whether and why it
842works. If unsure, use the form above.
843
844=head3 When I log-in to another system it tells me about missing terminfo data?
845
846The terminal description used by rxvt-unicode is not as widely available
847as that for xterm, or even rxvt (for which the same problem often arises).
848
849The correct solution for this problem is to install the terminfo, this can
850be done like this (with ncurses' infocmp and works as user and admin):
851
852 REMOTE=remotesystem.domain
853 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
854
855... or by installing rxvt-unicode normally on the remote system,
856
857One some systems you might need to set C<$TERMINFO> to the full path of
858F<$HOME/.terminfo> for this to work.
859
860If you cannot or do not want to do this, then you can simply set
861C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
862problems arising, which includes wrong keymapping, less and different
863colours and some refresh errors in fullscreen applications. It's a nice
864quick-and-dirty workaround for rare cases, though.
865
866If you always want to do this (and are fine with the consequences) you
867can either recompile rxvt-unicode with the desired TERM value or use a
868resource to set it:
869
870 URxvt.termName: rxvt
871
872If you don't plan to use B<rxvt> (quite common...) you could also replace
873the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
874
875=head3 C<tic> outputs some error when compiling the terminfo entry.
876
877Most likely it's the empty definition for C<enacs=>. Just replace it by
878C<enacs=\E[0@> and try again.
879
880=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
881
882See next entry.
883
884=head3 I need a termcap file entry.
885
886One reason you might want this is that some distributions or operating
887systems still compile some programs using the long-obsoleted termcap
888library (Fedora Core's bash is one example) and rely on a termcap entry
889for C<rxvt-unicode>.
890
891You could use rxvt's termcap entry with reasonable results in many cases.
892You can also create a termcap entry by using terminfo's infocmp program
893like this:
894
895 infocmp -C rxvt-unicode
896
897Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
898generated by the command above.
899
900=head3 Why does C<ls> no longer have coloured output?
901
902The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
903decide whether a terminal has colour, but uses its own configuration
904file. Needless to say, C<rxvt-unicode> is not in its default file (among
905with most other terminals supporting colour). Either add:
906
907 TERM rxvt-unicode
908
909to C</etc/DIR_COLORS> or simply add:
910
911 alias ls='ls --color=auto'
912
913to your C<.profile> or C<.bashrc>.
914
915=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
916
917See next entry.
918
919=head3 Why doesn't vim/emacs etc. make use of italic?
920
921See next entry.
922
923=head3 Why are the secondary screen-related options not working properly?
924
925Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
926distributions (most notably Debian GNU/Linux) break rxvt-unicode
927by setting C<TERM> to C<rxvt>, which doesn't have these extra
928features. Unfortunately, some of these (most notably, again, Debian
929GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
930file, so you will need to install it on your own (See the question B<When
931I log-in to another system it tells me about missing terminfo data?> on
932how to do this).
933
934
935=head2 Encoding / Locale / Input Method Issues
936
937=head3 Rxvt-unicode does not seem to understand the selected encoding?
938
939See next entry.
940
941=head3 Unicode does not seem to work?
942
943If you encounter strange problems like typing an accented character but
944getting two unrelated other characters or similar, or if program output is
945subtly garbled, then you should check your locale settings.
946
947Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
948programs running in it. Often rxvt-unicode is started in the C<C> locale,
949while the login script running within the rxvt-unicode window changes the
950locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
951not going to work, and is the most common cause for problems.
952
953The best thing is to fix your startup environment, as you will likely run
954into other problems. If nothing works you can try this in your .profile.
955
956 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
957
958If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
959supported on your systems. Some systems have a C<locale> command which
960displays this (also, C<perl -e0> can be used to check locale settings, as
961it will complain loudly if it cannot set the locale). If it displays something
962like:
963
964 locale: Cannot set LC_CTYPE to default locale: ...
965
966Then the locale you specified is not supported on your system.
967
968If nothing works and you are sure that everything is set correctly then
969you will need to remember a little known fact: Some programs just don't
970support locales :(
971
972=head3 How does rxvt-unicode determine the encoding to use?
973
974See next entry.
975
976=head3 Is there an option to switch encodings?
977
978Unlike some other terminals, rxvt-unicode has no encoding switch, and no
979specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
980UTF-8 or any other encodings with respect to terminal I/O.
981
982The reasons is that there exists a perfectly fine mechanism for selecting
983the encoding, doing I/O and (most important) communicating this to all
984applications so everybody agrees on character properties such as width
985and code number. This mechanism is the I<locale>. Applications not using
986that info will have problems (for example, C<xterm> gets the width of
987characters wrong as it uses its own, locale-independent table under all
988locales).
989
990Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
991programs doing the same (that is, most) will automatically agree in the
992interpretation of characters.
993
994Unfortunately, there is no system-independent way to select locales, nor
995is there a standard on how locale specifiers will look like.
996
997On most systems, the content of the C<LC_CTYPE> environment variable
998contains an arbitrary string which corresponds to an already-installed
999locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1000C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1001(i.e. C<de> or C<german>) are also common.
1002
1003Rxvt-unicode ignores all other locale categories, and except for
1004the encoding, ignores country or language-specific settings,
1005i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1006rxvt-unicode.
1007
1008If you want to use a specific encoding you have to make sure you start
1009rxvt-unicode with the correct C<LC_CTYPE> category.
1010
1011=head3 Can I switch locales at runtime?
1012
1013Yes, using an escape sequence. Try something like this, which sets
1014rxvt-unicode's idea of C<LC_CTYPE>.
1015
1016 printf '\33]701;%s\007' ja_JP.SJIS
1017
1018See also the previous answer.
1019
1020Sometimes this capability is rather handy when you want to work in
1021one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1022(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1023first switches to a locale supported by xjdic and back later:
1024
1025 printf '\33]701;%s\007' ja_JP.SJIS
1026 xjdic -js
1027 printf '\33]701;%s\007' de_DE.UTF-8
1028
1029You can also use xterm's C<luit> program, which usually works fine, except
1030for some locales where character width differs between program- and
1031rxvt-unicode-locales.
1032
1033=head3 I have problems getting my input method working.
1034
1035Try a search engine, as this is slightly different for every input method server.
1036
1037Here is a checklist:
1038
1039=over 4
1040
1041=item - Make sure your locale I<and> the imLocale are supported on your OS.
1042
1043Try C<locale -a> or check the documentation for your OS.
1044
1045=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1046
1047For example, B<kinput2> does not support UTF-8 locales, you should use
1048C<ja_JP.EUC-JP> or equivalent.
1049
1050=item - Make sure your XIM server is actually running.
1051
1052=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1053
1054When you want to use e.g. B<kinput2>, it must be set to
1055C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1056method servers are running with this command:
1057
1058 xprop -root XIM_SERVERS
1059
1060=item
894 1061
895=back 1062=back
896 1063
1064=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1065
1066You can specify separate locales for the input method and the rest of the
1067terminal, using the resource C<imlocale>:
1068
1069 URxvt.imlocale: ja_JP.EUC-JP
1070
1071Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1072use your input method. Please note, however, that, depending on your Xlib
1073version, you may not be able to input characters outside C<EUC-JP> in a
1074normal way then, as your input method limits you.
1075
1076=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1077
1078Unfortunately, this is unavoidable, as the XIM protocol is racy by
1079design. Applications can avoid some crashes at the expense of memory
1080leaks, and Input Methods can avoid some crashes by careful ordering at
1081exit time. B<kinput2> (and derived input methods) generally succeeds,
1082while B<SCIM> (or similar input methods) fails. In the end, however,
1083crashes cannot be completely avoided even if both sides cooperate.
1084
1085So the only workaround is not to kill your Input Method Servers.
1086
1087
1088=head2 Operating Systems / Package Maintaining
1089
1090=head3 I am using Debian GNU/Linux and have a problem...
1091
1092The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1093patches that considerably change the behaviour of rxvt-unicode (but
1094unfortunately this notice has been removed). Before reporting a bug to
1095the original rxvt-unicode author please download and install the genuine
1096version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1097the problem. If you cannot, chances are that the problems are specific to
1098Debian GNU/Linux, in which case it should be reported via the Debian Bug
1099Tracking System (use C<reportbug> to report the bug).
1100
1101For other problems that also affect the Debian package, you can and
1102probably should use the Debian BTS, too, because, after all, it's also a
1103bug in the Debian version and it serves as a reminder for other users that
1104might encounter the same issue.
1105
1106=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1107
1108You should build one binary with the default options. F<configure>
1109now enables most useful options, and the trend goes to making them
1110runtime-switchable, too, so there is usually no drawback to enabling them,
1111except higher disk and possibly memory usage. The perl interpreter should
1112be enabled, as important functionality (menus, selection, likely more in
1113the future) depends on it.
1114
1115You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1116system-wide (except maybe with C<defaults>). This will result in useful
1117behaviour. If your distribution aims at low memory, add an empty
1118C<perl-ext-common> resource to the app-defaults file. This will keep the
1119perl interpreter disabled until the user enables it.
1120
1121If you can/want build more binaries, I recommend building a minimal
1122one with C<--disable-everything> (very useful) and a maximal one with
1123C<--enable-everything> (less useful, it will be very big due to a lot of
1124encodings built-in that increase download times and are rarely used).
1125
1126=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1127
1128It should be, starting with release 7.1. You are encouraged to properly
1129install urxvt with privileges necessary for your OS now.
1130
1131When rxvt-unicode detects that it runs setuid or setgid, it will fork
1132into a helper process for privileged operations (pty handling on some
1133systems, utmp/wtmp/lastlog handling on others) and drop privileges
1134immediately. This is much safer than most other terminals that keep
1135privileges while running (but is more relevant to urxvt, as it contains
1136things as perl interpreters, which might be "helpful" to attackers).
1137
1138This forking is done as the very first within main(), which is very early
1139and reduces possible bugs to initialisation code run before main(), or
1140things like the dynamic loader of your system, which should result in very
1141little risk.
1142
1143=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1144
1145Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1146in your compile environment, or an implementation that implements it,
1147whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1148B<wchar_t> is represented as unicode.
1149
1150As you might have guessed, FreeBSD does neither define this symbol nor
1151does it support it. Instead, it uses its own internal representation of
1152B<wchar_t>. This is, of course, completely fine with respect to standards.
1153
1154However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1155C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1156
1157C<__STDC_ISO_10646__> is the only sane way to support multi-language
1158apps in an OS, as using a locale-dependent (and non-standardized)
1159representation of B<wchar_t> makes it impossible to convert between
1160B<wchar_t> (as used by X11 and your applications) and any other encoding
1161without implementing OS-specific-wrappers for each and every locale. There
1162simply are no APIs to convert B<wchar_t> into anything except the current
1163locale encoding.
1164
1165Some applications (such as the formidable B<mlterm>) work around this
1166by carrying their own replacement functions for character set handling
1167with them, and either implementing OS-dependent hacks or doing multiple
1168conversions (which is slow and unreliable in case the OS implements
1169encodings slightly different than the terminal emulator).
1170
1171The rxvt-unicode author insists that the right way to fix this is in the
1172system libraries once and for all, instead of forcing every app to carry
1173complete replacements for them :)
1174
1175=head3 How can I use rxvt-unicode under cygwin?
1176
1177rxvt-unicode should compile and run out of the box on cygwin, using
1178the X11 libraries that come with cygwin. libW11 emulation is no
1179longer supported (and makes no sense, either, as it only supported a
1180single font). I recommend starting the X-server in C<-multiwindow> or
1181C<-rootless> mode instead, which will result in similar look&feel as the
1182old libW11 emulation.
1183
1184At the time of this writing, cygwin didn't seem to support any multi-byte
1185encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1186to 8-bit encodings.
1187
1188=head3 Character widths are not correct.
1189
1190urxvt uses the system wcwidth function to know the information about
1191the width of characters, so on systems with incorrect locale data you
1192will likely get bad results. Two notorious examples are Solaris 9,
1193where single-width characters like U+2514 are reported as double-width,
1194and Darwin 8, where combining chars are reported having width 1.
1195
1196The solution is to upgrade your system or switch to a better one. A
1197possibly working workaround is to use a wcwidth implementation like
1198
1199http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1200
897=head1 RXVT TECHNICAL REFERENCE 1201=head1 RXVT-UNICODE TECHNICAL REFERENCE
898
899=head1 DESCRIPTION
900 1202
901The rest of this document describes various technical aspects of 1203The rest of this document describes various technical aspects of
902B<rxvt-unicode>. First the description of supported command sequences, 1204B<rxvt-unicode>. First the description of supported command sequences,
903followed by pixmap support and last by a description of all features 1205followed by pixmap support and last by a description of all features
904selectable at C<configure> time. 1206selectable at C<configure> time.
905 1207
906=head1 Definitions 1208=head2 Definitions
907 1209
908=over 4 1210=over 4
909 1211
910=item B<< C<c> >> 1212=item B<< C<c> >>
911 1213
929 1231
930A text parameter composed of printable characters. 1232A text parameter composed of printable characters.
931 1233
932=back 1234=back
933 1235
934=head1 Values 1236=head2 Values
935 1237
936=over 4 1238=over 4
937 1239
938=item B<< C<ENQ> >> 1240=item B<< C<ENQ> >>
939 1241
982 1284
983Space Character 1285Space Character
984 1286
985=back 1287=back
986 1288
987=head1 Escape Sequences 1289=head2 Escape Sequences
988 1290
989=over 4 1291=over 4
990 1292
991=item B<< C<ESC # 8> >> 1293=item B<< C<ESC # 8> >>
992 1294
1090 1392
1091=back 1393=back
1092 1394
1093X<CSI> 1395X<CSI>
1094 1396
1095=head1 CSI (Command Sequence Introducer) Sequences 1397=head2 CSI (Command Sequence Introducer) Sequences
1096 1398
1097=over 4 1399=over 4
1098 1400
1099=item B<< C<ESC [ Ps @> >> 1401=item B<< C<ESC [ Ps @> >>
1100 1402
1155=begin table 1457=begin table
1156 1458
1157 B<< C<Ps = 0> >> Clear to Right (default) 1459 B<< C<Ps = 0> >> Clear to Right (default)
1158 B<< C<Ps = 1> >> Clear to Left 1460 B<< C<Ps = 1> >> Clear to Left
1159 B<< C<Ps = 2> >> Clear All 1461 B<< C<Ps = 2> >> Clear All
1462 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1463 (@@RXVT_NAME@@ extension)
1160 1464
1161=end table 1465=end table
1162 1466
1163=item B<< C<ESC [ Ps L> >> 1467=item B<< C<ESC [ Ps L> >>
1164 1468
1370 1674
1371=back 1675=back
1372 1676
1373X<PrivateModes> 1677X<PrivateModes>
1374 1678
1375=head1 DEC Private Modes 1679=head2 DEC Private Modes
1376 1680
1377=over 4 1681=over 4
1378 1682
1379=item B<< C<ESC [ ? Pm h> >> 1683=item B<< C<ESC [ ? Pm h> >>
1380 1684
1396 1700
1397Toggle DEC Private Mode Values (rxvt extension). I<where> 1701Toggle DEC Private Mode Values (rxvt extension). I<where>
1398 1702
1399=over 4 1703=over 4
1400 1704
1401=item B<< C<Ps = 1> >> (DECCKM) 1705=item B<< C<Pm = 1> >> (DECCKM)
1402 1706
1403=begin table 1707=begin table
1404 1708
1405 B<< C<h> >> Application Cursor Keys 1709 B<< C<h> >> Application Cursor Keys
1406 B<< C<l> >> Normal Cursor Keys 1710 B<< C<l> >> Normal Cursor Keys
1407 1711
1408=end table 1712=end table
1409 1713
1410=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1714=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1411 1715
1412=begin table 1716=begin table
1413 1717
1414 B<< C<h> >> Enter VT52 mode 1718 B<< C<h> >> Enter VT52 mode
1415 B<< C<l> >> Enter VT52 mode 1719 B<< C<l> >> Enter VT52 mode
1416 1720
1417=end table 1721=end table
1418 1722
1419=item B<< C<Ps = 3> >> 1723=item B<< C<Pm = 3> >>
1420 1724
1421=begin table 1725=begin table
1422 1726
1423 B<< C<h> >> 132 Column Mode (DECCOLM) 1727 B<< C<h> >> 132 Column Mode (DECCOLM)
1424 B<< C<l> >> 80 Column Mode (DECCOLM) 1728 B<< C<l> >> 80 Column Mode (DECCOLM)
1425 1729
1426=end table 1730=end table
1427 1731
1428=item B<< C<Ps = 4> >> 1732=item B<< C<Pm = 4> >>
1429 1733
1430=begin table 1734=begin table
1431 1735
1432 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1736 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1433 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1737 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1434 1738
1435=end table 1739=end table
1436 1740
1437=item B<< C<Ps = 5> >> 1741=item B<< C<Pm = 5> >>
1438 1742
1439=begin table 1743=begin table
1440 1744
1441 B<< C<h> >> Reverse Video (DECSCNM) 1745 B<< C<h> >> Reverse Video (DECSCNM)
1442 B<< C<l> >> Normal Video (DECSCNM) 1746 B<< C<l> >> Normal Video (DECSCNM)
1443 1747
1444=end table 1748=end table
1445 1749
1446=item B<< C<Ps = 6> >> 1750=item B<< C<Pm = 6> >>
1447 1751
1448=begin table 1752=begin table
1449 1753
1450 B<< C<h> >> Origin Mode (DECOM) 1754 B<< C<h> >> Origin Mode (DECOM)
1451 B<< C<l> >> Normal Cursor Mode (DECOM) 1755 B<< C<l> >> Normal Cursor Mode (DECOM)
1452 1756
1453=end table 1757=end table
1454 1758
1455=item B<< C<Ps = 7> >> 1759=item B<< C<Pm = 7> >>
1456 1760
1457=begin table 1761=begin table
1458 1762
1459 B<< C<h> >> Wraparound Mode (DECAWM) 1763 B<< C<h> >> Wraparound Mode (DECAWM)
1460 B<< C<l> >> No Wraparound Mode (DECAWM) 1764 B<< C<l> >> No Wraparound Mode (DECAWM)
1461 1765
1462=end table 1766=end table
1463 1767
1464=item B<< C<Ps = 8> >> I<unimplemented> 1768=item B<< C<Pm = 8> >> I<unimplemented>
1465 1769
1466=begin table 1770=begin table
1467 1771
1468 B<< C<h> >> Auto-repeat Keys (DECARM) 1772 B<< C<h> >> Auto-repeat Keys (DECARM)
1469 B<< C<l> >> No Auto-repeat Keys (DECARM) 1773 B<< C<l> >> No Auto-repeat Keys (DECARM)
1470 1774
1471=end table 1775=end table
1472 1776
1473=item B<< C<Ps = 9> >> X10 XTerm 1777=item B<< C<Pm = 9> >> X10 XTerm
1474 1778
1475=begin table 1779=begin table
1476 1780
1477 B<< C<h> >> Send Mouse X & Y on button press. 1781 B<< C<h> >> Send Mouse X & Y on button press.
1478 B<< C<l> >> No mouse reporting. 1782 B<< C<l> >> No mouse reporting.
1479 1783
1480=end table 1784=end table
1481 1785
1482=item B<< C<Ps = 25> >> 1786=item B<< C<Pm = 25> >>
1483 1787
1484=begin table 1788=begin table
1485 1789
1486 B<< C<h> >> Visible cursor {cnorm/cvvis} 1790 B<< C<h> >> Visible cursor {cnorm/cvvis}
1487 B<< C<l> >> Invisible cursor {civis} 1791 B<< C<l> >> Invisible cursor {civis}
1488 1792
1489=end table 1793=end table
1490 1794
1491=item B<< C<Ps = 30> >> 1795=item B<< C<Pm = 30> >>
1492 1796
1493=begin table 1797=begin table
1494 1798
1495 B<< C<h> >> scrollBar visisble 1799 B<< C<h> >> scrollBar visible
1496 B<< C<l> >> scrollBar invisisble 1800 B<< C<l> >> scrollBar invisible
1497 1801
1498=end table 1802=end table
1499 1803
1500=item B<< C<Ps = 35> >> (B<rxvt>) 1804=item B<< C<Pm = 35> >> (B<rxvt>)
1501 1805
1502=begin table 1806=begin table
1503 1807
1504 B<< C<h> >> Allow XTerm Shift+key sequences 1808 B<< C<h> >> Allow XTerm Shift+key sequences
1505 B<< C<l> >> Disallow XTerm Shift+key sequences 1809 B<< C<l> >> Disallow XTerm Shift+key sequences
1506 1810
1507=end table 1811=end table
1508 1812
1509=item B<< C<Ps = 38> >> I<unimplemented> 1813=item B<< C<Pm = 38> >> I<unimplemented>
1510 1814
1511Enter Tektronix Mode (DECTEK) 1815Enter Tektronix Mode (DECTEK)
1512 1816
1513=item B<< C<Ps = 40> >> 1817=item B<< C<Pm = 40> >>
1514 1818
1515=begin table 1819=begin table
1516 1820
1517 B<< C<h> >> Allow 80/132 Mode 1821 B<< C<h> >> Allow 80/132 Mode
1518 B<< C<l> >> Disallow 80/132 Mode 1822 B<< C<l> >> Disallow 80/132 Mode
1519 1823
1520=end table 1824=end table
1521 1825
1522=item B<< C<Ps = 44> >> I<unimplemented> 1826=item B<< C<Pm = 44> >> I<unimplemented>
1523 1827
1524=begin table 1828=begin table
1525 1829
1526 B<< C<h> >> Turn On Margin Bell 1830 B<< C<h> >> Turn On Margin Bell
1527 B<< C<l> >> Turn Off Margin Bell 1831 B<< C<l> >> Turn Off Margin Bell
1528 1832
1529=end table 1833=end table
1530 1834
1531=item B<< C<Ps = 45> >> I<unimplemented> 1835=item B<< C<Pm = 45> >> I<unimplemented>
1532 1836
1533=begin table 1837=begin table
1534 1838
1535 B<< C<h> >> Reverse-wraparound Mode 1839 B<< C<h> >> Reverse-wraparound Mode
1536 B<< C<l> >> No Reverse-wraparound Mode 1840 B<< C<l> >> No Reverse-wraparound Mode
1537 1841
1538=end table 1842=end table
1539 1843
1540=item B<< C<Ps = 46> >> I<unimplemented> 1844=item B<< C<Pm = 46> >> I<unimplemented>
1541 1845
1542=item B<< C<Ps = 47> >> 1846=item B<< C<Pm = 47> >>
1543 1847
1544=begin table 1848=begin table
1545 1849
1546 B<< C<h> >> Use Alternate Screen Buffer 1850 B<< C<h> >> Use Alternate Screen Buffer
1547 B<< C<l> >> Use Normal Screen Buffer 1851 B<< C<l> >> Use Normal Screen Buffer
1548 1852
1549=end table 1853=end table
1550 1854
1551X<Priv66> 1855X<Priv66>
1552 1856
1553=item B<< C<Ps = 66> >> 1857=item B<< C<Pm = 66> >>
1554 1858
1555=begin table 1859=begin table
1556 1860
1557 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1861 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1558 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1862 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1559 1863
1560=end table 1864=end table
1561 1865
1562=item B<< C<Ps = 67> >> 1866=item B<< C<Pm = 67> >>
1563 1867
1564=begin table 1868=begin table
1565 1869
1566 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1870 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1567 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1871 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1568 1872
1569=end table 1873=end table
1570 1874
1571=item B<< C<Ps = 1000> >> (X11 XTerm) 1875=item B<< C<Pm = 1000> >> (X11 XTerm)
1572 1876
1573=begin table 1877=begin table
1574 1878
1575 B<< C<h> >> Send Mouse X & Y on button press and release. 1879 B<< C<h> >> Send Mouse X & Y on button press and release.
1576 B<< C<l> >> No mouse reporting. 1880 B<< C<l> >> No mouse reporting.
1577 1881
1578=end table 1882=end table
1579 1883
1580=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1884=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1581 1885
1582=begin table 1886=begin table
1583 1887
1584 B<< C<h> >> Use Hilite Mouse Tracking. 1888 B<< C<h> >> Use Hilite Mouse Tracking.
1585 B<< C<l> >> No mouse reporting. 1889 B<< C<l> >> No mouse reporting.
1586 1890
1587=end table 1891=end table
1588 1892
1893=item B<< C<Pm = 1002> >> (X11 XTerm)
1894
1895=begin table
1896
1897 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1898 B<< C<l> >> No mouse reporting.
1899
1900=end table
1901
1902=item B<< C<Pm = 1003> >> (X11 XTerm)
1903
1904=begin table
1905
1906 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1907 B<< C<l> >> No mouse reporting.
1908
1909=end table
1910
1589=item B<< C<Ps = 1010> >> (B<rxvt>) 1911=item B<< C<Pm = 1010> >> (B<rxvt>)
1590 1912
1591=begin table 1913=begin table
1592 1914
1593 B<< C<h> >> Don't scroll to bottom on TTY output 1915 B<< C<h> >> Don't scroll to bottom on TTY output
1594 B<< C<l> >> Scroll to bottom on TTY output 1916 B<< C<l> >> Scroll to bottom on TTY output
1595 1917
1596=end table 1918=end table
1597 1919
1598=item B<< C<Ps = 1011> >> (B<rxvt>) 1920=item B<< C<Pm = 1011> >> (B<rxvt>)
1599 1921
1600=begin table 1922=begin table
1601 1923
1602 B<< C<h> >> Scroll to bottom when a key is pressed 1924 B<< C<h> >> Scroll to bottom when a key is pressed
1603 B<< C<l> >> Don't scroll to bottom when a key is pressed 1925 B<< C<l> >> Don't scroll to bottom when a key is pressed
1604 1926
1605=end table 1927=end table
1606 1928
1607=item B<< C<Ps = 1021> >> (B<rxvt>) 1929=item B<< C<Pm = 1021> >> (B<rxvt>)
1608 1930
1609=begin table 1931=begin table
1610 1932
1611 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1933 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1612 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1934 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1613 1935
1614=end table 1936=end table
1615 1937
1616=item B<< C<Ps = 1047> >> 1938=item B<< C<Pm = 1047> >>
1617 1939
1618=begin table 1940=begin table
1619 1941
1620 B<< C<h> >> Use Alternate Screen Buffer 1942 B<< C<h> >> Use Alternate Screen Buffer
1621 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1943 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1622 1944
1623=end table 1945=end table
1624 1946
1625=item B<< C<Ps = 1048> >> 1947=item B<< C<Pm = 1048> >>
1626 1948
1627=begin table 1949=begin table
1628 1950
1629 B<< C<h> >> Save cursor position 1951 B<< C<h> >> Save cursor position
1630 B<< C<l> >> Restore cursor position 1952 B<< C<l> >> Restore cursor position
1631 1953
1632=end table 1954=end table
1633 1955
1634=item B<< C<Ps = 1049> >> 1956=item B<< C<Pm = 1049> >>
1635 1957
1636=begin table 1958=begin table
1637 1959
1638 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1960 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1639 B<< C<l> >> Use Normal Screen Buffer 1961 B<< C<l> >> Use Normal Screen Buffer
1640 1962
1641=end table 1963=end table
1642 1964
1965=item B<< C<Pm = 2004> >>
1966
1967=begin table
1968
1969 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1970 B<< C<l> >> Disable bracketed paste mode
1971
1972=end table
1973
1643=back 1974=back
1644 1975
1645=back 1976=back
1646 1977
1647X<XTerm> 1978X<XTerm>
1648 1979
1649=head1 XTerm Operating System Commands 1980=head2 XTerm Operating System Commands
1650 1981
1651=over 4 1982=over 4
1652 1983
1653=item B<< C<ESC ] Ps;Pt ST> >> 1984=item B<< C<ESC ] Ps;Pt ST> >>
1654 1985
1661 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 1992 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1662 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 1993 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1663 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 1994 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1664 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 1995 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1665 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 1996 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1666 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1997 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1667 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1998 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1668 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1999 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1669 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2000 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1670 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2001 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1671 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2002 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1672 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2003 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1673 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2004 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1674 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2005 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1675 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2006 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1676 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2007 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1677 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> >> 2008 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> >>
1678 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2009 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1679 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). 2010 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).
2011 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>.
1680 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2012 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1681 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2013 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1682 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2014 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1683 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2015 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1684 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2016 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1691 2023
1692=end table 2024=end table
1693 2025
1694=back 2026=back
1695 2027
1696X<XPM> 2028=head1 BACKGROUND IMAGE
1697 2029
1698=head1 XPM
1699
1700For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2030For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1701of B<< C<Pt> >> can be the name of the background pixmap followed by a 2031of B<< C<Pt> >> can be the name of the background image file followed by a
1702sequence of scaling/positioning commands separated by semi-colons. The 2032sequence of scaling/positioning commands separated by semi-colons. The
1703scaling/positioning commands are as follows: 2033scaling/positioning commands are as follows:
1704 2034
1705=over 4 2035=over 4
1706 2036
1744 2074
1745For example: 2075For example:
1746 2076
1747=over 4 2077=over 4
1748 2078
1749=item B<\E]20;funky\a> 2079=item B<\E]20;funky.jpg\a>
1750 2080
1751load B<funky.xpm> as a tiled image 2081load B<funky.jpg> as a tiled image
1752 2082
1753=item B<\E]20;mona;100\a> 2083=item B<\E]20;mona.jpg;100\a>
1754 2084
1755load B<mona.xpm> with a scaling of 100% 2085load B<mona.jpg> with a scaling of 100%
1756 2086
1757=item B<\E]20;;200;?\a> 2087=item B<\E]20;;200;?\a>
1758 2088
1759rescale the current pixmap to 200% and display the image geometry in 2089rescale the current pixmap to 200% and display the image geometry in
1760the title 2090the title
1761 2091
1762=back 2092=back
2093
1763X<Mouse> 2094X<Mouse>
1764 2095
1765=head1 Mouse Reporting 2096=head1 Mouse Reporting
1766 2097
1767=over 4 2098=over 4
1799=begin table 2130=begin table
1800 2131
1801 4 Shift 2132 4 Shift
1802 8 Meta 2133 8 Meta
1803 16 Control 2134 16 Control
1804 32 Double Click I<(Rxvt extension)> 2135 32 Double Click I<(rxvt extension)>
1805 2136
1806=end table 2137=end table
1807 2138
1808Col = B<< C<< <x> - SPACE >> >> 2139Col = B<< C<< <x> - SPACE >> >>
1809 2140
1810Row = B<< C<< <y> - SPACE >> >> 2141Row = B<< C<< <y> - SPACE >> >>
1811 2142
1812=back 2143=back
2144
2145=head1 Key Codes
2146
1813X<KeyCodes> 2147X<KeyCodes>
1814
1815=head1 Key Codes
1816 2148
1817Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2149Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1818 2150
1819For the keypad, use B<Shift> to temporarily override Application-Keypad 2151For the keypad, use B<Shift> to temporarily override Application-Keypad
1820setting use B<Num_Lock> to toggle Application-Keypad setting if 2152setting use B<Num_Lock> to toggle Application-Keypad setting if
1887 2219
1888=head1 CONFIGURE OPTIONS 2220=head1 CONFIGURE OPTIONS
1889 2221
1890General hint: if you get compile errors, then likely your configuration 2222General hint: if you get compile errors, then likely your configuration
1891hasn't been tested well. Either try with C<--enable-everything> or use 2223hasn't been tested well. Either try with C<--enable-everything> or use
1892the F<./reconf> script as a base for experiments. F<./reconf> is used by 2224the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
1893myself, so it should generally be a working config. Of course, you should 2225switches). Of course, you should always report when a combination doesn't
1894always report when a combination doesn't work, so it can be fixed. Marc 2226work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
1895Lehmann <rxvt@schmorp.de>.
1896 2227
1897All 2228All
1898 2229
1899=over 4 2230=over 4
1900 2231
1932 2263
1933=begin table 2264=begin table
1934 2265
1935 all all available codeset groups 2266 all all available codeset groups
1936 zh common chinese encodings 2267 zh common chinese encodings
1937 zh_ext rarely used but very big chinese encodigs 2268 zh_ext rarely used but very big chinese encodings
1938 jp common japanese encodings 2269 jp common japanese encodings
1939 jp_ext rarely used but big japanese encodings 2270 jp_ext rarely used but big japanese encodings
1940 kr korean encodings 2271 kr korean encodings
1941 2272
1942=end table 2273=end table
1946Add support for XIM (X Input Method) protocol. This allows using 2277Add support for XIM (X Input Method) protocol. This allows using
1947alternative input methods (e.g. kinput2) and will also correctly 2278alternative input methods (e.g. kinput2) and will also correctly
1948set up the input for people using dead keys or compose keys. 2279set up the input for people using dead keys or compose keys.
1949 2280
1950=item --enable-unicode3 (default: off) 2281=item --enable-unicode3 (default: off)
2282
2283Recommended to stay off unless you really need non-BMP characters.
1951 2284
1952Enable direct support for displaying unicode codepoints above 2285Enable direct support for displaying unicode codepoints above
195365535 (the basic multilingual page). This increases storage 228665535 (the basic multilingual page). This increases storage
1954requirements per character from 2 to 4 bytes. X11 fonts do not yet 2287requirements per character from 2 to 4 bytes. X11 fonts do not yet
1955support these extra characters, but Xft does. 2288support these extra characters, but Xft does.
1956 2289
1957Please note that rxvt-unicode can store unicode code points >65535 2290Please note that rxvt-unicode can store unicode code points >65535
1958even without this flag, but the number of such characters is 2291even without this flag, but the number of such characters is
1959limited to a view thousand (shared with combining characters, 2292limited to a few thousand (shared with combining characters,
1960see next switch), and right now rxvt-unicode cannot display them 2293see next switch), and right now rxvt-unicode cannot display them
1961(input/output and cut&paste still work, though). 2294(input/output and cut&paste still work, though).
1962 2295
1963=item --enable-combining (default: on) 2296=item --enable-combining (default: on)
1964 2297
1966composite characters. This is required for proper viewing of text 2299composite characters. This is required for proper viewing of text
1967where accents are encoded as seperate unicode characters. This is 2300where accents are encoded as seperate unicode characters. This is
1968done by using precomposited characters when available or creating 2301done by using precomposited characters when available or creating
1969new pseudo-characters when no precomposed form exists. 2302new pseudo-characters when no precomposed form exists.
1970 2303
1971Without --enable-unicode3, the number of additional precomposed characters 2304Without --enable-unicode3, the number of additional precomposed
1972is rather limited (2048, if this is full, rxvt-unicode will use the 2305characters is somewhat limited (the 6400 private use characters will be
1973private use area, extending the number of combinations to 8448). With
1974--enable-unicode3, no practical limit exists. 2306(ab-)used). With --enable-unicode3, no practical limit exists.
1975 2307
1976This option will also enable storage (but not display) of characters 2308This option will also enable storage (but not display) of characters
1977beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2309beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1978 2310
1979The combining table also contains entries for arabic presentation forms, 2311The combining table also contains entries for arabic presentation forms,
1980but these are not currently used. Bug me if you want these to be used (and 2312but these are not currently used. Bug me if you want these to be used (and
1981tell me how these are to be used...). 2313tell me how these are to be used...).
1982 2314
1983=item --enable-fallback(=CLASS) (default: Rxvt) 2315=item --enable-fallback(=CLASS) (default: Rxvt)
1984 2316
1985When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2317When reading resource settings, also read settings for class CLASS. To
2318disable resource fallback use --disable-fallback.
1986 2319
1987=item --with-res-name=NAME (default: urxvt) 2320=item --with-res-name=NAME (default: urxvt)
1988 2321
1989Use the given name as default application name when 2322Use the given name as default application name when
1990reading resources. Specify --with-res-name=rxvt to replace rxvt. 2323reading resources. Specify --with-res-name=rxvt to replace rxvt.
1991 2324
1992=item --with-res-class=CLASS /default: URxvt) 2325=item --with-res-class=CLASS (default: URxvt)
1993 2326
1994Use the given class as default application class 2327Use the given class as default application class
1995when reading resources. Specify --with-res-class=Rxvt to replace 2328when reading resources. Specify --with-res-class=Rxvt to replace
1996rxvt. 2329rxvt.
1997 2330
2010 2343
2011Write user and tty to lastlog file (used by programs like 2344Write user and tty to lastlog file (used by programs like
2012F<lastlogin>) at start of rxvt execution. This option requires 2345F<lastlogin>) at start of rxvt execution. This option requires
2013--enable-utmp to also be specified. 2346--enable-utmp to also be specified.
2014 2347
2015=item --enable-xpm-background (default: on) 2348=item --enable-afterimage (default: on)
2016 2349
2017Add support for XPM background pixmaps. 2350Add support for libAfterImage to be used for transparency and background
2351images. It adds support for many file formats including JPG, PNG,
2352SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2353(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2354
2355This option also adds such eye candy as blending an image over the root
2356background, as well as dynamic scaling and bluring of background images.
2357
2358Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2359increase by a few megabytes even if no extra features are used (mostly due
2360to third-party libraries used by libAI). Memory footprint may somewhat be
2361lowered if libAfterImage is configured without support for SVG.
2018 2362
2019=item --enable-transparency (default: on) 2363=item --enable-transparency (default: on)
2020 2364
2021Add support for inheriting parent backgrounds thus giving a fake 2365Add support for backgrounds, creating illusion of transparency in the term.
2022transparency to the term.
2023 2366
2024=item --enable-fading (default: on) 2367=item --enable-fading (default: on)
2025 2368
2026Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2369Add support for fading the text when focus is lost.
2027
2028=item --enable-tinting (default: on)
2029
2030Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2031 2370
2032=item --enable-rxvt-scroll (default: on) 2371=item --enable-rxvt-scroll (default: on)
2033 2372
2034Add support for the original rxvt scrollbar. 2373Add support for the original rxvt scrollbar.
2035 2374
2038Add support for a NeXT-like scrollbar. 2377Add support for a NeXT-like scrollbar.
2039 2378
2040=item --enable-xterm-scroll (default: on) 2379=item --enable-xterm-scroll (default: on)
2041 2380
2042Add support for an Xterm-like scrollbar. 2381Add support for an Xterm-like scrollbar.
2043
2044=item --enable-plain-scroll (default: on)
2045
2046Add support for a very unobtrusive, plain-looking scrollbar that
2047is the favourite of the rxvt-unicode author, having used it for
2048many years.
2049
2050=item --enable-ttygid (default: off)
2051
2052Change tty device setting to group "tty" - only use this if
2053your system uses this type of security.
2054 2382
2055=item --disable-backspace-key 2383=item --disable-backspace-key
2056 2384
2057Removes any handling of the backspace key by us - let the X server do it. 2385Removes any handling of the backspace key by us - let the X server do it.
2058 2386
2078A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2406A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2079in combination with other switches) is: 2407in combination with other switches) is:
2080 2408
2081 MWM-hints 2409 MWM-hints
2082 EWMH-hints (pid, utf8 names) and protocols (ping) 2410 EWMH-hints (pid, utf8 names) and protocols (ping)
2411 urgency hint
2083 seperate underline colour (-underlineColor) 2412 seperate underline colour (-underlineColor)
2084 settable border widths and borderless switch (-w, -b, -bl) 2413 settable border widths and borderless switch (-w, -b, -bl)
2414 visual depth selection (-depth)
2085 settable extra linespacing /-lsp) 2415 settable extra linespacing /-lsp)
2086 iso-14755-2 and -3, and visual feedback 2416 iso-14755 5.1 (basic) support
2087 backindex and forwardindex escape sequence
2088 window op and some xterm/OSC escape sequences
2089 tripleclickwords (-tcw) 2417 tripleclickwords (-tcw)
2090 settable insecure mode (-insecure) 2418 settable insecure mode (-insecure)
2091 keysym remapping support 2419 keysym remapping support
2092 cursor blinking and underline cursor (-cb, -uc) 2420 cursor blinking and underline cursor (-cb, -uc)
2093 XEmbed support (-embed) 2421 XEmbed support (-embed)
2094 user-pty (-pty-fd) 2422 user-pty (-pty-fd)
2095 hold on exit (-hold) 2423 hold on exit (-hold)
2424 compile in built-in block graphics
2096 skip builtin block graphics (-sbg) 2425 skip builtin block graphics (-sbg)
2426 separate highlightcolor support (-hc)
2427
2428It also enables some non-essential features otherwise disabled, such as:
2429
2430 some round-trip time optimisations
2431 nearest color allocation on pseudocolor screens
2432 UTF8_STRING support for selection
2097 sgr modes 90..97 and 100..107 2433 sgr modes 90..97 and 100..107
2434 backindex and forwardindex escape sequences
2435 view change/zero scrollback escape sequences
2436 locale switching escape sequence
2437 window op and some xterm/OSC escape sequences
2438 rectangular selections
2439 trailing space removal for selections
2440 verbose X error handling
2098 2441
2099=item --enable-iso14755 (default: on) 2442=item --enable-iso14755 (default: on)
2100 2443
2101Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2444Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2102F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2445Basic support (section 5.1) is enabled by C<--enable-frills>, while
2103C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2446support for 5.2, 5.3 and 5.4 is enabled with this switch.
2104this switch.
2105 2447
2106=item --enable-keepscrolling (default: on) 2448=item --enable-keepscrolling (default: on)
2107 2449
2108Add support for continual scrolling of the display when you hold 2450Add support for continual scrolling of the display when you hold
2109the mouse button down on a scrollbar arrow. 2451the mouse button down on a scrollbar arrow.
2452
2453=item --enable-selectionscrolling (default: on)
2454
2455Add support for scrolling when the selection moves to the top or
2456bottom of the screen.
2110 2457
2111=item --enable-mousewheel (default: on) 2458=item --enable-mousewheel (default: on)
2112 2459
2113Add support for scrolling via mouse wheel or buttons 4 & 5. 2460Add support for scrolling via mouse wheel or buttons 4 & 5.
2114 2461
2116 2463
2117Add support for continual scrolling (using the mouse wheel as an 2464Add support for continual scrolling (using the mouse wheel as an
2118accelerator) while the control key is held down. This option 2465accelerator) while the control key is held down. This option
2119requires --enable-mousewheel to also be specified. 2466requires --enable-mousewheel to also be specified.
2120 2467
2121=item --disable-new-selection
2122
2123Remove support for mouse selection style like that of xterm.
2124
2125=item --enable-dmalloc (default: off)
2126
2127Use Gray Watson's malloc - which is good for debugging See
2128http://www.letters.com/dmalloc/ for details If you use either this or the
2129next option, you may need to edit src/Makefile after compiling to point
2130DINCLUDE and DLIB to the right places.
2131
2132You can only use either this option and the following (should
2133you use either) .
2134
2135=item --enable-dlmalloc (default: off)
2136
2137Use Doug Lea's malloc - which is good for a production version
2138See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2139
2140=item --enable-smart-resize (default: on) 2468=item --enable-smart-resize (default: off)
2141 2469
2142Add smart growth/shrink behaviour when changing font size via hot 2470Add smart growth/shrink behaviour when resizing.
2143keys. This should keep the window corner which is closest to a corner of 2471This should keep the window corner which is closest to a corner of
2144the screen in a fixed position. 2472the screen in a fixed position.
2145 2473
2474=item --enable-text-blink (default: on)
2475
2476Add support for blinking text.
2477
2146=item --enable-pointer-blank (default: on) 2478=item --enable-pointer-blank (default: on)
2147 2479
2148Add support to have the pointer disappear when typing or inactive. 2480Add support to have the pointer disappear when typing or inactive.
2149 2481
2150=item --enable-perl (default: off) 2482=item --enable-perl (default: on)
2151 2483
2152Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2484Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2153manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2485manpage for more info on this feature, or the files in F<src/perl/>
2154in F<src/perl-ext/> for the extensions that are installed by default. The 2486for the extensions that are installed by default.
2155perl interpreter that is used can be specified via the C<PERL> environment 2487The perl interpreter that is used can be specified via the C<PERL>
2156variable when running configure. 2488environment variable when running configure. Even when compiled in,
2489perl will I<not> be initialised when all extensions have been disabled
2490C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2491resource standpoint.
2492
2493=item --with-afterimage-config=DIR
2494
2495Look for the libAfterImage config script in DIR.
2157 2496
2158=item --with-name=NAME (default: urxvt) 2497=item --with-name=NAME (default: urxvt)
2159 2498
2160Set the basename for the installed binaries, resulting 2499Set the basename for the installed binaries, resulting
2161in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2500in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2171PATH. 2510PATH.
2172 2511
2173=item --with-x 2512=item --with-x
2174 2513
2175Use the X Window System (pretty much default, eh?). 2514Use the X Window System (pretty much default, eh?).
2176
2177=item --with-xpm-includes=DIR
2178
2179Look for the XPM includes in DIR.
2180
2181=item --with-xpm-library=DIR
2182
2183Look for the XPM library in DIR.
2184
2185=item --with-xpm
2186
2187Not needed - define via --enable-xpm-background.
2188 2515
2189=back 2516=back
2190 2517
2191=head1 AUTHORS 2518=head1 AUTHORS
2192 2519

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines