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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines