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.85 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.216 by mikachu, Sun Nov 13 16:03:31 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines