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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines