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.110 by root, Tue Jan 31 21:10:44 2006 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/*checkout*/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 do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79
80The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81so you can check and see if that is set. Note that several programs, JED,
82slrn, Midnight Commander automatically check this variable to decide
83whether or not to use color.
84
85=head3 How do I set the correct, full IP address for the DISPLAY variable?
86
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script
89snippets to correctly set the display. If your version of rxvt-unicode
90wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
91the COLORTERM variable can be used to distinguish rxvt-unicode from a
92regular xterm.
93
94Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
95snippets:
96
97 # Bourne/Korn/POSIX family of shells:
98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
99 if [ ${TERM:-foo} = xterm ]; then
100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
101 echo -n '^[Z'
102 read term_id
103 stty icanon echo
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell
107 fi
108 fi
109
110=head3 How do I compile the manual pages on my own?
111
112You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
114the doc subdirectory and enter C<make alldoc>.
115
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117
118I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
120that the urxvt binary is larger (due to some encoding tables always being
121compiled in), but it actually uses less memory (RSS) after startup. Even
122with C<--disable-everything>, this comparison is a bit unfair, as many
123features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
124already in use in this mode.
125
126 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything
129
130When you C<--enable-everything> (which I<is> unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so.
133
134 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything
137
138The very large size of the text section is explained by the east-asian
139encoding tables, which, if unused, take up disk space but nothing else
140and can be compiled out unless you rely on X11 core fonts that use those
141encodings. The BSS size comes from the 64k emergency buffer that my c++
142compiler allocates (but of course doesn't use unless you are out of
143memory). Also, using an xft font instead of a core font immediately adds a
144few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
145not used.
146
147Of course, due to every character using two or four bytes instead of one,
148a large scrollback buffer will ultimately make rxvt-unicode use more
149memory.
150
151Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
152still fares rather well. And compared to some monsters like gnome-terminal
153(21152k + extra 4204k in separate processes) or konsole (22200k + extra
15443180k in daemons that stay around after exit, plus half a minute of
155startup time, including the hundreds of warnings it spits out), it fares
156extremely well *g*.
157
158=head3 Why C++, isn't that unportable/bloated/uncool?
159
160Is this a question? :) It comes up very often. The simple answer is: I had
161to write it, and C++ allowed me to write and maintain it in a fraction
162of the time and effort (which is a scarce resource for me). Put even
163shorter: It simply wouldn't exist without C++.
164
165My personal stance on this is that C++ is less portable than C, but in
166the case of rxvt-unicode this hardly matters, as its portability limits
167are defined by things like X11, pseudo terminals, locale support and unix
168domain sockets, which are all less portable than C++ itself.
169
170Regarding the bloat, see the above question: It's easy to write programs
171in C that use gobs of memory, an certainly possible to write programs in
172C++ that don't. C++ also often comes with large libraries, but this is
173not necessarily the case with GCC. Here is what rxvt links against on my
174system with a minimal config:
175
176 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
177 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
178 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
179 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
180
181And here is rxvt-unicode:
182
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188
189No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :)
191
192
193=head2 Rendering, Font & Look and Feel Issues
194
195=head3 I can't get transparency working, what am I doing wrong?
196
197First of all, transparency isn't officially supported in rxvt-unicode, so
198you are mostly on your own. Do not bug the author about it (but you may
199bug everybody else). Also, if you can't get it working consider it a rite
200of passage: ... and you failed.
201
202Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204
2051. Use inheritPixmap:
206
207 Esetroot wallpaper.jpg
208 @@URXVT_NAME@@ -ip -tint red -sh 40
209
210That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read.
212
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool:
216
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
219
220That works. If you think it doesn't, you lack XPM and Perl support, or you
221are unable to read.
222
2233. Use an ARGB visual:
224
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226
227This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place.
232
2334. Use xcompmgr and let it do the job:
234
235 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237
238Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces.
241
242=head3 Why does rxvt-unicode sometimes leave pixel droppings?
243
244Most fonts were not designed for terminal use, which means that character
245size varies a lot. A font that is otherwise fine for terminal use might
246contain some characters that are simply too wide. Rxvt-unicode will avoid
247these characters. For characters that are just "a bit" too wide a special
248"careful" rendering mode is used that redraws adjacent characters.
249
250All of this requires that fonts do not lie about character sizes,
251however: Xft fonts often draw glyphs larger than their acclaimed bounding
252box, and rxvt-unicode has no way of detecting this (the correct way is to
253ask for the character bounding box, which unfortunately is wrong in these
254cases).
255
256It's not clear (to me at least), wether this is a bug in Xft, freetype,
257or the respective font. If you encounter this problem you might try using
258the C<-lsp> option to give the font more height. If that doesn't work, you
259might be forced to use a different font.
260
261All of this is not a problem when using X11 core fonts, as their bounding
262box data is correct.
263
264=head3 How can I keep rxvt-unicode from using reverse video so much?
265
266First of all, make sure you are running with the right terminal settings
267(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
268make sure you have specified colours for italic and bold, as otherwise
269rxvt-unicode might use reverse video to simulate the effect:
270
271 URxvt.colorBD: white
272 URxvt.colorIT: green
273
274=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
275
276For some unexplainable reason, some rare programs assume a very weird
277colour palette when confronted with a terminal with more than the standard
2788 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
279these programs not to assume non-ISO colours without very good reasons.
280
281In the meantime, you can either edit your C<rxvt-unicode> terminfo
282definition to only claim 8 colour support or use C<TERM=rxvt>, which will
283fix colours but keep you from using other rxvt-unicode features.
284
285=head3 Can I switch the fonts at runtime?
286
287Yes, using an escape sequence. Try something like this, which has the same
288effect as using the C<-fn> switch, and takes effect immediately:
289
290 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
291
292This is useful if you e.g. work primarily with japanese (and prefer a
293japanese font), but you have to switch to chinese temporarily, where
294japanese fonts would only be in your way.
295
296You can think of this as a kind of manual ISO-2022 switching.
297
298=head3 Why do italic characters look as if clipped?
299
300Many fonts have difficulties with italic characters and hinting. For
301example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
302Mono> completely fails in it's italic face. A workaround might be to
303enable freetype autohinting, i.e. like this:
304
305 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
306 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
307
452=item Can I speed up Xft rendering somehow? 308=head3 Can I speed up Xft rendering somehow?
453 309
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as 310Yes, 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 311it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of 312antialiasing (by appending C<:antialias=false>), which saves lots of
457memory and also speeds up rendering considerably. 313memory and also speeds up rendering considerably.
458 314
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 315=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460 316
461Rxvt-unicode will use whatever you specify as a font. If it needs to 317Rxvt-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 318fall back to it's default font search list it will prefer X11 core
463fonts, because they are small and fast, and then use Xft fonts. It has 319fonts, because they are small and fast, and then use Xft fonts. It has
464antialiasing disabled for most of them, because the author thinks they 320antialiasing disabled for most of them, because the author thinks they
465look best that way. 321look best that way.
466 322
467If you want antialiasing, you have to specify the fonts manually. 323If you want antialiasing, you have to specify the fonts manually.
468 324
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? 325=head3 What's with this bold/blink stuff?
478 326
479If no bold colour is set via C<colorBD:>, bold will invert text using the 327If no bold colour is set via C<colorBD:>, bold will invert text using the
480standard foreground colour. 328standard foreground colour.
481 329
482For the standard background colour, blinking will actually make the 330For the standard background colour, blinking will actually make the
489 337
490color0-7 are the low-intensity colors. 338color0-7 are the low-intensity colors.
491 339
492color8-15 are the corresponding high-intensity colors. 340color8-15 are the corresponding high-intensity colors.
493 341
494=item I don't like the screen colors. How do I change them? 342=head3 I don't like the screen colors. How do I change them?
495 343
496You can change the screen colors at run-time using F<~/.Xdefaults> 344You can change the screen colors at run-time using F<~/.Xdefaults>
497resources (or as long-options). 345resources (or as long-options).
498 346
499Here are values that are supposed to resemble a VGA screen, 347Here are values that are supposed to resemble a VGA screen,
515 URxvt.color12: #0000FF 363 URxvt.color12: #0000FF
516 URxvt.color13: #FF00FF 364 URxvt.color13: #FF00FF
517 URxvt.color14: #00FFFF 365 URxvt.color14: #00FFFF
518 URxvt.color15: #FFFFFF 366 URxvt.color15: #FFFFFF
519 367
520And here is a more complete set of non-standard colors described (not by 368And here is a more complete set of non-standard colors.
521me) as "pretty girly".
522 369
523 URxvt.cursorColor: #dc74d1 370 URxvt.cursorColor: #dc74d1
524 URxvt.pointerColor: #dc74d1 371 URxvt.pointerColor: #dc74d1
525 URxvt.background: #0e0e0e 372 URxvt.background: #0e0e0e
526 URxvt.foreground: #4ad5e1 373 URxvt.foreground: #4ad5e1
537 URxvt.color6: #73f7ff 384 URxvt.color6: #73f7ff
538 URxvt.color14: #73f7ff 385 URxvt.color14: #73f7ff
539 URxvt.color7: #e1dddd 386 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd 387 URxvt.color15: #e1dddd
541 388
542=item How can I start @@RXVT_NAME@@d in a race-free way? 389They have been described (not by me) as "pretty girly".
543 390
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 391=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 392
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the 393See next entry.
549following method to wait for the startup message before continuing:
550 394
551 { @@RXVT_NAME@@d & } | read 395=head3 How does rxvt-unicode choose fonts?
552 396
397Most fonts do not contain the full range of Unicode, which is
398fine. Chances are that the font you (or the admin/package maintainer of
399your system/os) have specified does not cover all the characters you want
400to display.
401
402B<rxvt-unicode> makes a best-effort try at finding a replacement
403font. Often the result is fine, but sometimes the chosen font looks
404bad/ugly/wrong. Some fonts have totally strange characters that don't
405resemble the correct glyph at all, and rxvt-unicode lacks the artificial
406intelligence to detect that a specific glyph is wrong: it has to believe
407the font that the characters it claims to contain indeed look correct.
408
409In that case, select a font of your taste and add it to the font list,
410e.g.:
411
412 @@URXVT_NAME@@ -fn basefont,font2,font3...
413
414When rxvt-unicode sees a character, it will first look at the base
415font. If the base font does not contain the character, it will go to the
416next font, and so on. Specifying your own fonts will also speed up this
417search and use less resources within rxvt-unicode and the X-server.
418
419The only limitation is that none of the fonts may be larger than the base
420font, as the base font defines the terminal character cell size, which
421must be the same due to the way terminals work.
422
423=head3 Why do some chinese characters look so different than others?
424
425This is because there is a difference between script and language --
426rxvt-unicode does not know which language the text that is output is,
427as it only knows the unicode character codes. If rxvt-unicode first
428sees a japanese/chinese character, it might choose a japanese font for
429display. Subsequent japanese characters will use that font. Now, many
430chinese characters aren't represented in japanese fonts, so when the first
431non-japanese character comes up, rxvt-unicode will look for a chinese font
432-- unfortunately at this point, it will still use the japanese font for
433chinese characters that are also in the japanese font.
434
435The workaround is easy: just tag a chinese font at the end of your font
436list (see the previous question). The key is to view the font list as
437a preference list: If you expect more japanese, list a japanese font
438first. If you expect more chinese, put a chinese font first.
439
440In the future it might be possible to switch language preferences at
441runtime (the internal data structure has no problem with using different
442fonts for the same character at the same time, but no interface for this
443has been designed yet).
444
445Until then, you might get away with switching fonts at runtime (see L<Can
446I switch the fonts at runtime?> later in this document).
447
448=head2 Keyboard, Mouse & User Interaction
449
450=head3 The new selection selects pieces that are too big, how can I select single words?
451
452If you want to select e.g. alphanumeric words, you can use the following
453setting:
454
455 URxvt.selection.pattern-0: ([[:word:]]+)
456
457If you click more than twice, the selection will be extended
458more and more.
459
460To get a selection that is very similar to the old code, try this pattern:
461
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463
464Please also note that the I<LeftClick Shift-LeftClik> combination also
465selects words like the old code.
466
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468
469You can disable the perl extension completely by setting the
470B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory.
472
473If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource:
478
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480
481This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource:
485
486 URxvt.searchable-scrollback: CM-s
487
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489
490See next entry.
491
492=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
493
494These are caused by the C<readline> perl extension. Under normal
495circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly.
499
500You can permamently switch this feature off by disabling the C<readline>
501extension:
502
503 URxvt.perl-ext-common: default,-readline
504
505=head3 My numerical keypad acts weird and generates differing output?
506
507Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that
512helped.
513
514=head3 My Compose (Multi_key) key is no longer working.
515
516The most common causes for this are that either your locale is not set
517correctly, or you specified a B<preeditStyle> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method.
522
523In this case either do not specify a B<preeditStyle> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>.
525
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your
530advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
531codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
532character and so on.
533
534=head3 Mouse cut/paste suddenly no longer works.
535
536Make sure that mouse reporting is actually turned off since killing
537some editors prematurely may leave the mouse in mouse report mode. I've
538heard that tcsh may use mouse reporting unless it otherwise specified. A
539quick check is to see if cut/paste works when the Alt or Shift keys are
540depressed.
541
553=item What's with the strange Backspace/Delete key behaviour? 542=head3 What's with the strange Backspace/Delete key behaviour?
554 543
555Assuming that the physical Backspace key corresponds to the 544Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following 545BackSpace keysym (not likely for Linux ... see the following
557question) there are two standard values that can be used for 546question) there are two standard values that can be used for
558Backspace: C<^H> and C<^?>. 547Backspace: C<^H> and C<^?>.
569 558
570For starting a new rxvt-unicode: 559For starting a new rxvt-unicode:
571 560
572 # use Backspace = ^H 561 # use Backspace = ^H
573 $ stty erase ^H 562 $ stty erase ^H
574 $ @@RXVT_NAME@@ 563 $ @@URXVT_NAME@@
575 564
576 # use Backspace = ^? 565 # use Backspace = ^?
577 $ stty erase ^? 566 $ stty erase ^?
578 $ @@RXVT_NAME@@ 567 $ @@URXVT_NAME@@
579 568
580Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
581 570
582For an existing rxvt-unicode: 571For an existing rxvt-unicode:
583 572
584 # use Backspace = ^H 573 # use Backspace = ^H
585 $ stty erase ^H 574 $ stty erase ^H
598key has been assigned an escape sequence to match the vt100 for Execute 587key has been assigned an escape sequence to match the vt100 for Execute
599(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
600 589
601Some other Backspace problems: 590Some other Backspace problems:
602 591
603some editors use termcap/terminfo, 592some editors use termcap/terminfo,
604some editors (vim I'm told) expect Backspace = ^H, 593some editors (vim I'm told) expect Backspace = ^H,
605GNU Emacs (and Emacs-like editors) use ^H for help. 594GNU Emacs (and Emacs-like editors) use ^H for help.
606 595
607Perhaps someday this will all be resolved in a consistent manner. 596Perhaps someday this will all be resolved in a consistent manner.
608 597
609=item I don't like the key-bindings. How do I change them? 598=head3 I don't like the key-bindings. How do I change them?
610 599
611There are some compile-time selections available via configure. Unless 600There are some compile-time selections available via configure. Unless
612you have run "configure" with the C<--disable-resources> option you can 601you have run "configure" with the C<--disable-resources> option you can
613use the `keysym' resource to alter the keystrings associated with keysyms. 602use the `keysym' resource to alter the keystrings associated with keysyms.
614 603
615Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
616 605
617 URxvt.keysym.Home: \033[1~ 606 URxvt.keysym.Home: \033[1~
618 URxvt.keysym.End: \033[4~ 607 URxvt.keysym.End: \033[4~
619 URxvt.keysym.C-apostrophe: \033<C-'> 608 URxvt.keysym.C-apostrophe: \033<C-'>
620 URxvt.keysym.C-slash: \033<C-/> 609 URxvt.keysym.C-slash: \033<C-/>
635 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
636 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
637 626
638See some more examples in the documentation for the B<keysym> resource. 627See some more examples in the documentation for the B<keysym> resource.
639 628
640=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 629=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 630
644 KP_Insert == Insert 631 KP_Insert == Insert
645 F22 == Print 632 F22 == Print
646 F27 == Home 633 F27 == Home
647 F29 == Prior 634 F29 == Prior
650 637
651Rather than have rxvt-unicode try to accommodate all the various possible 638Rather than have rxvt-unicode try to accommodate all the various possible
652keyboard mappings, it is better to use `xmodmap' to remap the keys as 639keyboard mappings, it is better to use `xmodmap' to remap the keys as
653required for your particular machine. 640required for your particular machine.
654 641
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 642
658rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
659check and see if that is set. Note that several programs, JED, slrn,
660Midnight Commander automatically check this variable to decide whether or
661not to use color.
662 643
663=item How do I set the correct, full IP address for the DISPLAY variable? 644=head2 Terminal Configuration
664 645
665If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 646=head3 Why doesn't rxvt-unicode read my resources?
666insecure mode then it is possible to use the following shell script
667snippets to correctly set the display. If your version of rxvt-unicode
668wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
669the COLORTERM variable can be used to distinguish rxvt-unicode from a
670regular xterm.
671 647
672Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 648Well, why, indeed? It does, in a way very similar to other X
673snippets: 649applications. Most importantly, this means that if you or your OS loads
650resources into the X display (the right way to do it), rxvt-unicode will
651ignore any resource files in your home directory. It will only read
652F<$HOME/.Xdefaults> when no resources are attached to the display.
674 653
675 # Bourne/Korn/POSIX family of shells: 654If you have or use an F<$HOME/.Xresources> file, chances are that
676 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 655resources are loaded into your X-server. In this case, you have to
677 if [ ${TERM:-foo} = xterm ]; then 656re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
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 657
688=item How do I compile the manual pages for myself? 658Also consider the form resources have to use:
689 659
690You need to have a recent version of perl installed as F</usr/bin/perl>, 660 URxvt.resource: value
691one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
692the doc subdirectory and enter C<make alldoc>.
693 661
694=item My question isn't answered here, can I ask a human? 662If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it
664works. If unsure, use the form above.
695 665
696Before sending me mail, you could go to IRC: C<irc.freenode.net>, 666=head3 When I log-in to another system it tells me about missing terminfo data?
697channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
698interested in learning about new and exciting problems (but not FAQs :).
699 667
700=back 668The terminal description used by rxvt-unicode is not as widely available
669as that for xterm, or even rxvt (for which the same problem often arises).
701 670
671The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp):
673
674 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
676
677... or by installing rxvt-unicode normally on the remote system,
678
679If you cannot or do not want to do this, then you can simply set
680C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice
683quick-and-dirty workaround for rare cases, though.
684
685If you always want to do this (and are fine with the consequences) you
686can either recompile rxvt-unicode with the desired TERM value or use a
687resource to set it:
688
689 URxvt.termName: rxvt
690
691If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
693
694=head3 C<tic> outputs some error when compiling the terminfo entry.
695
696Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again.
698
699=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
700
701See next entry.
702
703=head3 I need a termcap file entry.
704
705One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>.
709
710You could use rxvt's termcap entry with resonable results in many cases.
711You can also create a termcap entry by using terminfo's infocmp program
712like this:
713
714 infocmp -C rxvt-unicode
715
716Or you could use this termcap entry, generated by the command above:
717
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
737 :vs=\E[?25h:
738
739=head3 Why does C<ls> no longer have coloured output?
740
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration
743file. Needless to say, C<rxvt-unicode> is not in it's default file (among
744with most other terminals supporting colour). Either add:
745
746 TERM rxvt-unicode
747
748to C</etc/DIR_COLORS> or simply add:
749
750 alias ls='ls --color=auto'
751
752to your C<.profile> or C<.bashrc>.
753
754=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
755
756See next entry.
757
758=head3 Why doesn't vim/emacs etc. make use of italic?
759
760See next entry.
761
762=head3 Why are the secondary screen-related options not working properly?
763
764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
765distributions (most notably Debian GNU/Linux) break rxvt-unicode
766by setting C<TERM> to C<rxvt>, which doesn't have these extra
767features. Unfortunately, some of these (most notably, again, Debian
768GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
769file, so you will need to install it on your own (See the question B<When
770I log-in to another system it tells me about missing terminfo data?> on
771how to do this).
772
773
774=head2 Encoding / Locale / Input Method Issues
775
776=head3 Rxvt-unicode does not seem to understand the selected encoding?
777
778See next entry.
779
780=head3 Unicode does not seem to work?
781
782If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings.
785
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the
788login script running within the rxvt-unicode window changes the locale to
789something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
790
791The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile.
793
794 printf '\e]701;%s\007' "$LC_CTYPE"
795
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which
798displays this (also, C<perl -e0> can be used to check locale settings, as
799it will complain loudly if it cannot set the locale). If it displays something
800like:
801
802 locale: Cannot set LC_CTYPE to default locale: ...
803
804Then the locale you specified is not supported on your system.
805
806If nothing works and you are sure that everything is set correctly then
807you will need to remember a little known fact: Some programs just don't
808support locales :(
809
810=head3 How does rxvt-unicode determine the encoding to use?
811
812See next entry.
813
814=head3 Is there an option to switch encodings?
815
816Unlike some other terminals, rxvt-unicode has no encoding switch, and no
817specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
818UTF-8 or any other encodings with respect to terminal I/O.
819
820The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of
825characters wrong as it uses it's own, locale-independent table under all
826locales).
827
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the
830interpretation of characters.
831
832Unfortunately, there is no system-independent way to select locales, nor
833is there a standard on how locale specifiers will look like.
834
835On most systems, the content of the C<LC_CTYPE> environment variable
836contains an arbitrary string which corresponds to an already-installed
837locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
838C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
839(i.e. C<de> or C<german>) are also common.
840
841Rxvt-unicode ignores all other locale categories, and except for
842the encoding, ignores country or language-specific settings,
843i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
844rxvt-unicode.
845
846If you want to use a specific encoding you have to make sure you start
847rxvt-unicode with the correct C<LC_CTYPE> category.
848
849=head3 Can I switch locales at runtime?
850
851Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>.
853
854 printf '\e]701;%s\007' ja_JP.SJIS
855
856See also the previous answer.
857
858Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later:
862
863 printf '\e]701;%s\007' ja_JP.SJIS
864 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8
866
867You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and
869rxvt-unicode-locales.
870
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872
873You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>:
875
876 URxvt.imlocale: ja_JP.EUC-JP
877
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879use your input method. Please note, however, that you will not be able to
880input characters outside C<EUC-JP> in a normal way then, as your input
881method limits you.
882
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884
885Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory
887leaks, and Input Methods can avoid some crashes by careful ordering at
888exit time. B<kinput2> (and derived input methods) generally succeeds,
889while B<SCIM> (or similar input methods) fails. In the end, however,
890crashes cannot be completely avoided even if both sides cooperate.
891
892So the only workaround is not to kill your Input Method Servers.
893
894
895=head2 Operating Systems / Package Maintaining
896
897=head3 I am using Debian GNU/Linux and have a problem...
898
899The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900patches that considerably change the behaviour of rxvt-unicode (but
901unfortunately this notice has been removed). Before reporting a bug to
902the original rxvt-unicode author please download and install the genuine
903version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904the problem. If you cannot, chances are that the problems are specific to
905Debian GNU/Linux, in which case it should be reported via the Debian Bug
906Tracking System (use C<reportbug> to report the bug).
907
908For other problems that also affect the Debian package, you can and
909probably should use the Debian BTS, too, because, after all, it's also a
910bug in the Debian version and it serves as a reminder for other users that
911might encounter the same issue.
912
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914
915You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them,
918except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it.
921
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it.
927
928If you can/want build more binaries, I recommend building a minimal
929one with C<--disable-everything> (very useful) and a maximal one with
930C<--enable-everything> (less useful, it will be very big due to a lot of
931encodings built-in that increase download times and are rarely used).
932
933=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
934
935It should be, starting with release 7.1. You are encouraged to properly
936install urxvt with privileges necessary for your OS now.
937
938When rxvt-unicode detects that it runs setuid or setgid, it will fork
939into a helper process for privileged operations (pty handling on some
940systems, utmp/wtmp/lastlog handling on others) and drop privileges
941immediately. This is much safer than most other terminals that keep
942privileges while running (but is more relevant to urxvt, as it contains
943things as perl interpreters, which might be "helpful" to attackers).
944
945This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very
948little risk.
949
950=head3 On Solaris 9, many line-drawing characters are too wide.
951
952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
955
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
957
958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode.
964
965As you might have guessed, FreeBSD does neither define this symobl nor
966does it support it. Instead, it uses it's own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards.
968
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
971
972C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding
976without implementing OS-specific-wrappers for each and every locale. There
977simply are no APIs to convert B<wchar_t> into anything except the current
978locale encoding.
979
980Some applications (such as the formidable B<mlterm>) work around this
981by carrying their own replacement functions for character set handling
982with them, and either implementing OS-dependent hacks or doing multiple
983conversions (which is slow and unreliable in case the OS implements
984encodings slightly different than the terminal emulator).
985
986The rxvt-unicode author insists that the right way to fix this is in the
987system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :)
989
990=head3 I use Solaris 9 and it doesn't compile/work/etc.
991
992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993problems with C<wcwidth> and a compile problem.
994
995=head3 How can I use rxvt-unicode under cygwin?
996
997rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a
1000single font). I recommend starting the X-server in C<-multiwindow> or
1001C<-rootless> mode instead, which will result in similar look&feel as the
1002old libW11 emulation.
1003
1004At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings.
1007
702=head1 RXVT TECHNICAL REFERENCE 1008=head1 RXVT-UNICODE TECHNICAL REFERENCE
703
704=head1 DESCRIPTION
705 1009
706The rest of this document describes various technical aspects of 1010The rest of this document describes various technical aspects of
707B<rxvt-unicode>. First the description of supported command sequences, 1011B<rxvt-unicode>. First the description of supported command sequences,
708followed by menu and pixmap support and last by a description of all 1012followed by pixmap support and last by a description of all features
709features selectable at C<configure> time. 1013selectable at C<configure> time.
710 1014
711=head1 Definitions 1015=head2 Definitions
712 1016
713=over 4 1017=over 4
714 1018
715=item B<< C<c> >> 1019=item B<< C<c> >>
716 1020
734 1038
735A text parameter composed of printable characters. 1039A text parameter composed of printable characters.
736 1040
737=back 1041=back
738 1042
739=head1 Values 1043=head2 Values
740 1044
741=over 4 1045=over 4
742 1046
743=item B<< C<ENQ> >> 1047=item B<< C<ENQ> >>
744 1048
787 1091
788Space Character 1092Space Character
789 1093
790=back 1094=back
791 1095
792=head1 Escape Sequences 1096=head2 Escape Sequences
793 1097
794=over 4 1098=over 4
795 1099
796=item B<< C<ESC # 8> >> 1100=item B<< C<ESC # 8> >>
797 1101
895 1199
896=back 1200=back
897 1201
898X<CSI> 1202X<CSI>
899 1203
900=head1 CSI (Command Sequence Introducer) Sequences 1204=head2 CSI (Command Sequence Introducer) Sequences
901 1205
902=over 4 1206=over 4
903 1207
904=item B<< C<ESC [ Ps @> >> 1208=item B<< C<ESC [ Ps @> >>
905 1209
1175 1479
1176=back 1480=back
1177 1481
1178X<PrivateModes> 1482X<PrivateModes>
1179 1483
1180=head1 DEC Private Modes 1484=head2 DEC Private Modes
1181 1485
1182=over 4 1486=over 4
1183 1487
1184=item B<< C<ESC [ ? Pm h> >> 1488=item B<< C<ESC [ ? Pm h> >>
1185 1489
1282 B<< C<h> >> Send Mouse X & Y on button press. 1586 B<< C<h> >> Send Mouse X & Y on button press.
1283 B<< C<l> >> No mouse reporting. 1587 B<< C<l> >> No mouse reporting.
1284 1588
1285=end table 1589=end table
1286 1590
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> >> 1591=item B<< C<Ps = 25> >>
1297 1592
1298=begin table 1593=begin table
1299 1594
1300 B<< C<h> >> Visible cursor {cnorm/cvvis} 1595 B<< C<h> >> Visible cursor {cnorm/cvvis}
1416 B<< C<h> >> Scroll to bottom when a key is pressed 1711 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 1712 B<< C<l> >> Don't scroll to bottom when a key is pressed
1418 1713
1419=end table 1714=end table
1420 1715
1716=item B<< C<Ps = 1021> >> (B<rxvt>)
1717
1718=begin table
1719
1720 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1721 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1722
1723=end table
1724
1421=item B<< C<Ps = 1047> >> 1725=item B<< C<Ps = 1047> >>
1422 1726
1423=begin table 1727=begin table
1424 1728
1425 B<< C<h> >> Use Alternate Screen Buffer 1729 B<< C<h> >> Use Alternate Screen Buffer
1449 1753
1450=back 1754=back
1451 1755
1452X<XTerm> 1756X<XTerm>
1453 1757
1454=head1 XTerm Operating System Commands 1758=head2 XTerm Operating System Commands
1455 1759
1456=over 4 1760=over 4
1457 1761
1458=item B<< C<ESC ] Ps;Pt ST> >> 1762=item B<< C<ESC ] Ps;Pt ST> >>
1459 1763
1471 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1775 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)> 1776 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> >> 1777 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> >> 1778 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> >> 1779 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> >> 1780 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> >> 1781 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1782 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> >> 1783 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> 1784 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> 1785 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> >> 1786 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> >> 1787 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) 1788 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) 1789 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> >> 1790 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> >> 1791 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1792 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1793 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>. 1794 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>. 1795 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>. 1796 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>. 1797 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1798 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1799 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1800 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1492 1801
1493=end table 1802=end table
1494 1803
1495=back 1804=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 1805
1965=head1 XPM 1806=head1 XPM
1966 1807
1967For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1808For 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 1809of B<< C<Pt> >> can be the name of the background pixmap followed by a
2066=begin table 1907=begin table
2067 1908
2068 4 Shift 1909 4 Shift
2069 8 Meta 1910 8 Meta
2070 16 Control 1911 16 Control
2071 32 Double Click I<(Rxvt extension)> 1912 32 Double Click I<(rxvt extension)>
2072 1913
2073=end table 1914=end table
2074 1915
2075Col = B<< C<< <x> - SPACE >> >> 1916Col = B<< C<< <x> - SPACE >> >>
2076 1917
2153=end table 1994=end table
2154 1995
2155=head1 CONFIGURE OPTIONS 1996=head1 CONFIGURE OPTIONS
2156 1997
2157General hint: if you get compile errors, then likely your configuration 1998General hint: if you get compile errors, then likely your configuration
2158hasn't been tested well. Either try with --enable-everything or use the 1999hasn'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, 2000the F<./reconf> script as a base for experiments. F<./reconf> is used by
2160so it should generally be a working config. Of course, you should always 2001myself, so it should generally be a working config. Of course, you should
2161report when a combination doesn't work, so it can be fixed. Marc Lehmann 2002always report when a combination doesn't work, so it can be fixed. Marc
2162<rxvt@schmorp.de>. 2003Lehmann <rxvt@schmorp.de>.
2004
2005All
2163 2006
2164=over 4 2007=over 4
2165 2008
2166=item --enable-everything 2009=item --enable-everything
2167 2010
2168Add support for all non-multichoice options listed in "./configure 2011Add (or remove) support for all non-multichoice options listed in "./configure
2169--help". Note that unlike other enable options this is order dependant. 2012--help".
2013
2170You can specify this and then disable options which this enables by 2014You can specify this and then disable options you do not like by
2171I<following> this with the appropriate commands. 2015I<following> this with the appropriate C<--disable-...> arguments,
2016or you can start with a minimal configuration by specifying
2017C<--disable-everything> and than adding just the C<--enable-...> arguments
2018you want.
2172 2019
2173=item --enable-xft 2020=item --enable-xft (default: enabled)
2174 2021
2175Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2022Add 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 2023slower and require lots of memory, but as long as you don't use them, you
2177don't pay for them. 2024don't pay for them.
2178 2025
2179=item --enable-font-styles 2026=item --enable-font-styles (default: on)
2180 2027
2181Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2028Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182styles. The fonts can be set manually or automatically. 2029styles. The fonts can be set manually or automatically.
2183 2030
2184=item --with-codesets=NAME,... 2031=item --with-codesets=NAME,... (default: all)
2185 2032
2186Compile in support for additional codeset (encoding) groups (eu, vn are 2033Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187always compiled in, which includes most 8-bit character sets). These 2034are always compiled in, which includes most 8-bit character sets). These
2188codeset tables are currently only used for driving X11 core fonts, they 2035codeset 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 2036for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190bigger (together about 700kB), but it doesn't increase memory usage unless 2037replacement fonts more intelligently. Compiling them in will make your
2038binary bigger (all of together cost about 700kB), but it doesn't increase
2191you use an X11 font requiring one of these encodings. 2039memory usage unless you use a font requiring one of these encodings.
2192 2040
2193=begin table 2041=begin table
2194 2042
2195 all all available codeset groups 2043 all all available codeset groups
2196 zh common chinese encodings 2044 zh common chinese encodings
2199 jp_ext rarely used but big japanese encodings 2047 jp_ext rarely used but big japanese encodings
2200 kr korean encodings 2048 kr korean encodings
2201 2049
2202=end table 2050=end table
2203 2051
2204=item --enable-xim 2052=item --enable-xim (default: on)
2205 2053
2206Add support for XIM (X Input Method) protocol. This allows using 2054Add support for XIM (X Input Method) protocol. This allows using
2207alternative input methods (e.g. kinput2) and will also correctly 2055alternative input methods (e.g. kinput2) and will also correctly
2208set up the input for people using dead keys or compose keys. 2056set up the input for people using dead keys or compose keys.
2209 2057
2210=item --enable-unicode3 2058=item --enable-unicode3 (default: off)
2059
2060Recommended to stay off unless you really need non-BMP characters.
2211 2061
2212Enable direct support for displaying unicode codepoints above 2062Enable direct support for displaying unicode codepoints above
221365535 (the basic multilingual page). This increases storage 206365535 (the basic multilingual page). This increases storage
2214requirements per character from 2 to 4 bytes. X11 fonts do not yet 2064requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215support these extra characters, but Xft does. 2065support these extra characters, but Xft does.
2218even without this flag, but the number of such characters is 2068even without this flag, but the number of such characters is
2219limited to a view thousand (shared with combining characters, 2069limited to a view thousand (shared with combining characters,
2220see next switch), and right now rxvt-unicode cannot display them 2070see next switch), and right now rxvt-unicode cannot display them
2221(input/output and cut&paste still work, though). 2071(input/output and cut&paste still work, though).
2222 2072
2223=item --enable-combining 2073=item --enable-combining (default: on)
2224 2074
2225Enable automatic composition of combining characters into 2075Enable automatic composition of combining characters into
2226composite characters. This is required for proper viewing of text 2076composite characters. This is required for proper viewing of text
2227where accents are encoded as seperate unicode characters. This is 2077where accents are encoded as seperate unicode characters. This is
2228done by using precomposited characters when available or creating 2078done by using precomposited characters when available or creating
2229new pseudo-characters when no precomposed form exists. 2079new pseudo-characters when no precomposed form exists.
2230 2080
2231Without --enable-unicode3, the number of additional precomposed characters 2081Without --enable-unicode3, the number of additional precomposed
2232is rather limited (2048, if this is full, rxvt-unicode will use the 2082characters 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. 2083(ab-)used). With --enable-unicode3, no practical limit exists.
2235 2084
2236This option will also enable storage (but not display) of characters 2085This option will also enable storage (but not display) of characters
2237beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2086beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2238 2087
2239The combining table also contains entries for arabic presentation forms, 2088The 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 2089but these are not currently used. Bug me if you want these to be used (and
2241tell me how these are to be used...). 2090tell me how these are to be used...).
2242 2091
2243=item --enable-fallback(=CLASS) 2092=item --enable-fallback(=CLASS) (default: Rxvt)
2244 2093
2245When reading resource settings, also read settings for class CLASS 2094When reading resource settings, also read settings for class CLASS. To
2246(default: Rxvt). To disable resource fallback use --disable-fallback. 2095disable resource fallback use --disable-fallback.
2247 2096
2248=item --with-res-name=NAME 2097=item --with-res-name=NAME (default: urxvt)
2249 2098
2250Use the given name (default: urxvt) as default application name when 2099Use the given name as default application name when
2251reading resources. Specify --with-res-name=rxvt to replace rxvt. 2100reading resources. Specify --with-res-name=rxvt to replace rxvt.
2252 2101
2253=item --with-res-class=CLASS 2102=item --with-res-class=CLASS /default: URxvt)
2254 2103
2255Use the given class (default: URxvt) as default application class 2104Use the given class as default application class
2256when reading resources. Specify --with-res-class=Rxvt to replace 2105when reading resources. Specify --with-res-class=Rxvt to replace
2257rxvt. 2106rxvt.
2258 2107
2259=item --enable-utmp 2108=item --enable-utmp (default: on)
2260 2109
2261Write user and tty to utmp file (used by programs like F<w>) at 2110Write user and tty to utmp file (used by programs like F<w>) at
2262start of rxvt execution and delete information when rxvt exits. 2111start of rxvt execution and delete information when rxvt exits.
2263 2112
2264=item --enable-wtmp 2113=item --enable-wtmp (default: on)
2265 2114
2266Write user and tty to wtmp file (used by programs like F<last>) at 2115Write user and tty to wtmp file (used by programs like F<last>) at
2267start of rxvt execution and write logout when rxvt exits. This 2116start of rxvt execution and write logout when rxvt exits. This
2268option requires --enable-utmp to also be specified. 2117option requires --enable-utmp to also be specified.
2269 2118
2270=item --enable-lastlog 2119=item --enable-lastlog (default: on)
2271 2120
2272Write user and tty to lastlog file (used by programs like 2121Write user and tty to lastlog file (used by programs like
2273F<lastlogin>) at start of rxvt execution. This option requires 2122F<lastlogin>) at start of rxvt execution. This option requires
2274--enable-utmp to also be specified. 2123--enable-utmp to also be specified.
2275 2124
2276=item --enable-xpm-background 2125=item --enable-xpm-background (default: on)
2277 2126
2278Add support for XPM background pixmaps. 2127Add support for XPM background pixmaps.
2279 2128
2280=item --enable-transparency 2129=item --enable-transparency (default: on)
2281 2130
2282Add support for inheriting parent backgrounds thus giving a fake 2131Add support for inheriting parent backgrounds thus giving a fake
2283transparency to the term. 2132transparency to the term.
2284 2133
2285=item --enable-fading 2134=item --enable-fading (default: on)
2286 2135
2287Add support for fading the text when focus is lost. 2136Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2288 2137
2289=item --enable-tinting 2138=item --enable-tinting (default: on)
2290 2139
2291Add support for tinting of transparent backgrounds. 2140Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2292 2141
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 2142=item --enable-rxvt-scroll (default: on)
2299 2143
2300Add support for the original rxvt scrollbar. 2144Add support for the original rxvt scrollbar.
2301 2145
2302=item --enable-next-scroll 2146=item --enable-next-scroll (default: on)
2303 2147
2304Add support for a NeXT-like scrollbar. 2148Add support for a NeXT-like scrollbar.
2305 2149
2306=item --enable-xterm-scroll 2150=item --enable-xterm-scroll (default: on)
2307 2151
2308Add support for an Xterm-like scrollbar. 2152Add support for an Xterm-like scrollbar.
2309 2153
2310=item --enable-plain-scroll 2154=item --enable-plain-scroll (default: on)
2311 2155
2312Add support for a very unobtrusive, plain-looking scrollbar that 2156Add support for a very unobtrusive, plain-looking scrollbar that
2313is the favourite of the rxvt-unicode author, having used it for 2157is the favourite of the rxvt-unicode author, having used it for
2314many years. 2158many years.
2315 2159
2316=item --enable-half-shadow 2160=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 2161
2323Change tty device setting to group "tty" - only use this if 2162Change tty device setting to group "tty" - only use this if
2324your system uses this type of security. 2163your system uses this type of security.
2325 2164
2326=item --disable-backspace-key 2165=item --disable-backspace-key
2327 2166
2328Disable any handling of the backspace key by us - let the X server 2167Removes any handling of the backspace key by us - let the X server do it.
2168
2169=item --disable-delete-key
2170
2171Removes any handling of the delete key by us - let the X server
2329do it. 2172do it.
2330 2173
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 2174=item --disable-resources
2337 2175
2338Remove all resources checking. 2176Removes 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 2177
2358=item --disable-swapscreen 2178=item --disable-swapscreen
2359 2179
2360Remove support for swap screen. 2180Remove support for secondary/swap screen.
2361 2181
2362=item --enable-frills 2182=item --enable-frills (default: on)
2363 2183
2364Add support for many small features that are not essential but nice to 2184Add 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 2185have. Normally you want this, but for very small binaries you may want to
2366disable this. 2186disable this.
2367 2187
2368A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2188A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369in combination with other switches) is: 2189in combination with other switches) is:
2370 2190
2371 MWM-hints 2191 MWM-hints
2192 EWMH-hints (pid, utf8 names) and protocols (ping)
2372 seperate underline colour 2193 seperate underline colour (-underlineColor)
2373 settable border widths and borderless switch 2194 settable border widths and borderless switch (-w, -b, -bl)
2195 visual depth selection (-depth)
2374 settable extra linespacing 2196 settable extra linespacing /-lsp)
2375 extra window properties (e.g. UTF-8 window names and PID)
2376 iso-14755-2 and -3, and visual feedback 2197 iso-14755-2 and -3, and visual feedback
2377 backindex and forwardindex escape sequence
2378 window op and locale change escape sequences
2379 tripleclickwords 2198 tripleclickwords (-tcw)
2380 settable insecure mode 2199 settable insecure mode (-insecure)
2381 keysym remapping support 2200 keysym remapping support
2201 cursor blinking and underline cursor (-cb, -uc)
2202 XEmbed support (-embed)
2203 user-pty (-pty-fd)
2204 hold on exit (-hold)
2205 skip builtin block graphics (-sbg)
2382 2206
2207It also enabled some non-essential features otherwise disabled, such as:
2208
2209 some round-trip time optimisations
2210 nearest color allocation on pseudocolor screens
2211 UTF8_STRING supporr for selection
2212 sgr modes 90..97 and 100..107
2213 backindex and forwardindex escape sequences
2214 view change/zero scorllback esacpe sequences
2215 locale switching escape sequence
2216 window op and some xterm/OSC escape sequences
2217 rectangular selections
2218 trailing space removal for selections
2219 verbose X error handling
2220
2383=item --enable-iso14755 2221=item --enable-iso14755 (default: on)
2384 2222
2385Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2223Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2224F<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 2225C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2388this switch. 2226this switch.
2389 2227
2390=item --enable-keepscrolling 2228=item --enable-keepscrolling (default: on)
2391 2229
2392Add support for continual scrolling of the display when you hold 2230Add support for continual scrolling of the display when you hold
2393the mouse button down on a scrollbar arrow. 2231the mouse button down on a scrollbar arrow.
2394 2232
2395=item --enable-mousewheel 2233=item --enable-mousewheel (default: on)
2396 2234
2397Add support for scrolling via mouse wheel or buttons 4 & 5. 2235Add support for scrolling via mouse wheel or buttons 4 & 5.
2398 2236
2399=item --enable-slipwheeling 2237=item --enable-slipwheeling (default: on)
2400 2238
2401Add support for continual scrolling (using the mouse wheel as an 2239Add support for continual scrolling (using the mouse wheel as an
2402accelerator) while the control key is held down. This option 2240accelerator) while the control key is held down. This option
2403requires --enable-mousewheel to also be specified. 2241requires --enable-mousewheel to also be specified.
2404 2242
2405=item --disable-new-selection 2243=item --disable-new-selection
2406 2244
2407Remove support for mouse selection style like that of xterm. 2245Remove support for mouse selection style like that of xterm.
2408 2246
2409=item --enable-dmalloc 2247=item --enable-dmalloc (default: off)
2410 2248
2411Use Gray Watson's malloc - which is good for debugging See 2249Use Gray Watson's malloc - which is good for debugging See
2412http://www.letters.com/dmalloc/ for details If you use either this or the 2250http://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 2251next option, you may need to edit src/Makefile after compiling to point
2414DINCLUDE and DLIB to the right places. 2252DINCLUDE and DLIB to the right places.
2415 2253
2416You can only use either this option and the following (should 2254You can only use either this option and the following (should
2417you use either) . 2255you use either) .
2418 2256
2419=item --enable-dlmalloc 2257=item --enable-dlmalloc (default: off)
2420 2258
2421Use Doug Lea's malloc - which is good for a production version 2259Use Doug Lea's malloc - which is good for a production version
2422See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2260See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2423 2261
2424=item --enable-smart-resize 2262=item --enable-smart-resize (default: on)
2425 2263
2426Add smart growth/shrink behaviour when changing font size via from hot 2264Add smart growth/shrink behaviour when changing font size via hot
2427keys. This should keep in a fixed position the rxvt corner which is 2265keys. This should keep the window corner which is closest to a corner of
2428closest to a corner of the screen. 2266the screen in a fixed position.
2429 2267
2430=item --enable-cursor-blink
2431
2432Add support for a blinking cursor.
2433
2434=item --enable-pointer-blank 2268=item --enable-pointer-blank (default: on)
2435 2269
2436Add support to have the pointer disappear when typing or inactive. 2270Add support to have the pointer disappear when typing or inactive.
2437 2271
2438=item --with-name=NAME 2272=item --enable-perl (default: on)
2439 2273
2274Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2275manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2276in F<src/perl-ext/> for the extensions that are installed by default. The
2277perl interpreter that is used can be specified via the C<PERL> environment
2278variable when running configure.
2279
2280=item --with-name=NAME (default: urxvt)
2281
2440Set the basename for the installed binaries (default: C<urxvt>, resulting 2282Set the basename for the installed binaries, resulting
2441in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2283in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2442C<rxvt>. 2284C<rxvt>.
2443 2285
2444=item --with-term=NAME 2286=item --with-term=NAME (default: rxvt-unicode)
2445 2287
2446Change the environmental variable for the terminal to NAME (default 2288Change the environmental variable for the terminal to NAME.
2447C<rxvt-unicode>)
2448 2289
2449=item --with-terminfo=PATH 2290=item --with-terminfo=PATH
2450 2291
2451Change the environmental variable for the path to the terminfo tree to 2292Change the environmental variable for the path to the terminfo tree to
2452PATH. 2293PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines