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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines