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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines