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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines