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.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.202 by root, Tue Nov 23 22:58:08 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines