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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines