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.234 by sf-exg, Mon Nov 24 21:46:04 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines