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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines