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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines