ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines