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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines