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.34 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.109 by root, Tue Jan 31 21:06:26 2006 UTC

1=head1 NAME 1=head1 NAME
2 2
3RXVT REFERENCE - FAQ, command sequences and other background information 3RXVT REFERENCE - FAQ, command sequences and other background information
4 4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23
5=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
6 25
7=over 4
8 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
9=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?
10 52
11The version number is displayed with the usage (-h). Also the escape 53The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> 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.
13 57
14=item When I log-in to another system it tells me about missing terminfo data?
15
16The terminal description used by rxvt-unicode is not as widely available
17as that for xterm, or even rxvt (for which the same problem often arises).
18
19The correct solution for this problem is to install the terminfo, this can
20be done like this (with ncurses' infocmp):
21
22 REMOTE=remotesystem.domain
23 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
24
25... or by installing rxvt-unicode normally on the remote system,
26
27If you cannot or do not want to do this, then you can simply set
28C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though.
32
33If you always want to do this you can either recompile rxvt-unicode with
34the desired TERM value or use a resource to set it:
35
36 URxvt.termName: rxvt
37
38If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one.
40
41=item I need a termcap file entry.
42
43You could use rxvt's termcap entry with resonable results in many cases.
44You can also create a termcap entry by using terminfo's infocmp program
45like this:
46
47 infocmp -C rxvt-unicode
48
49OR you could this termcap entry:
50
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h:
70
71=item Why does C<ls> no longer have coloured output?
72
73The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
74decide wether a terminal has colour, but uses it's own configuration
75file. Needless to say, C<rxvt-unicode> is not in it's default file (among
76with most other terminals supporting colour). Either add:
77
78 TERM rxvt-unicode
79
80to C</etc/DIR_COLORS> or simply add:
81
82 alias ls='ls --color=auto'
83
84to your C<.profile> or C<.bashrc>.
85
86=item Why doesn't vim/emacs etc. use the 88 colour mode?
87
88=item Why doesn't vim/emacs etc. make use of italic?
89
90=item Why are the secondary screen-related options not working properly?
91
92Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
93distributions (most notably Debian GNU/Linux) break rxvt-unicode
94by setting C<TERM> to C<rxvt>, which doesn't have these extra
95features. Unfortunately, some of these (most notably, again, Debian
96GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
97file, so you will need to install it on your own (See the question B<When
98I log-in to another system it tells me about missing terminfo data?> on
99how to do this).
100
101=item Rxvt-unicode does not seem to understand the selected encoding?
102
103=item Unicode does not seem to work?
104
105If you encounter strange problems like typing an accented character but
106getting two unrelated other characters or similar, or if program output is
107subtly garbled, then you should check your locale settings.
108
109Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
110programs. Often rxvt-unicode is started in the C<C> locale, while the
111login script running within the rxvt-unicode window changes the locale to
112sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
113
114The best thing is to fix your startup environment, as you will likely run
115into other problems. If nothing works you can try this in your .profile.
116
117 printf '\e]701;%s\007' "$LC_CTYPE"
118
119If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
120supported on your systems. Some systems have a C<locale> command which
121displays this. If it displays sth. like:
122
123 locale: Cannot set LC_CTYPE to default locale: ...
124
125Then the locale you specified is not supported on your system.
126
127If nothing works and you are sure that everything is set correctly then
128you will need to remember a little known fact: Some programs just don't
129support locales :(
130
131=item Why do some characters look so much different than others?
132
133=item How does rxvt-unicode choose fonts?
134
135Most fonts do not contain the full range of Unicode, which is
136fine. Chances are that the font you (or the admin/package maintainer of
137your system/os) have specified does not cover all the characters you want
138to display.
139
140B<rxvt-unicode> makes a best-effort try at finding a replacement
141font. Often the result is fine, but sometimes the chosen font looks
142bad. Many fonts have totally strange characters that don't resemble the
143correct glyph at all, and rxvt-unicode lacks the artificial intelligence
144to detect that a specific glyph is wrong: it has to believe the font that
145the characters it contains indeed look correct.
146
147In that case, select a font of your taste and add it to the font list,
148e.g.:
149
150 @@RXVT_NAME@@ -fn basefont,font2,font3...
151
152When rxvt-unicode sees a character, it will first look at the base
153font. If the base font does not contain the character, it will go to the
154next font, and so on. Specifying your own fonts will also speed up this
155search and use less resources within rxvt-unicode and the X-server.
156
157The only limitation is that all the fonts must not be larger than the base
158font, as the base font defines the principal cell size, which must be the
159same due to the way terminals work.
160
161=item Why do some chinese characters look so different than others?
162
163This is because there is a difference between script and language --
164rxvt-unicode does not know which language the text that is output
165is, as it only knows the unicode character codes. If rxvt-unicode
166first sees a japanese character, it might choose a japanese font for
167it. Subsequent japanese characters will take that font. Now, many chinese
168characters aren't represented in japanese fonts, so when the first
169non-japanese character comes up, rxvt-unicode will look for a chinese font
170-- unfortunately at this point, it will still use the japanese font for
171japanese characters that are also chinese.
172
173The workaround is easy: just tag a chinese font at the end of your font
174list (see the previous question). The key is to view the font list as
175a preference list: If you expect more japanese, list a japanese font
176first. If you expect more chinese, put a chinese font first.
177
178In the future it might be possible to switch preferences at runtime (the
179internal data structure has no problem with using different fonts for
180the same character at the same time, but no interface for this has been
181designed yet).
182
183=item Why does rxvt-unicode sometimes leave pixel droppings?
184
185Most fonts were not designed for terminal use, which means that character
186size varies a lot. A font that is otherwise fine for terminal use might
187contain some characters that are simply too wide. Rxvt-unicode will avoid
188these characters. For characters that are just "a bit" too wide a special
189"careful" rendering mode is used that redraws adjacent characters.
190
191All of this requires that fonts do not lie about character sizes,
192however: Xft fonts often draw glyphs larger than their acclaimed bounding
193box, and rxvt-unicode has no way of detecting this (the correct way is to
194ask for the character bounding box, which unfortunately is wrong in these
195cases).
196
197It's not clear (to me at least), wether this is a bug in Xft, freetype,
198or the respective font. If you encounter this problem you might try using
199the C<-lsp> option to give the font more height. If that doesn't work, you
200might be forced to use a different font.
201
202All of this is not a problem when using X11 core fonts, as their bounding
203box data is correct.
204
205=item My Compose (Multi_key) key is no longer working.
206
207The most common causes for this are that either your locale is not set
208correctly, or you specified a B<preeditStyle> that is not supported by
209your input method. For example, if you specified B<OverTheSpot> and
210your input method (e.g. the default input method handling Compose keys)
211does not support this (for instance because it is not visual), then
212rxvt-unicode will continue without an input method.
213
214In this case either do not specify a B<preeditStyle> or specify more than
215one pre-edit style, such as B<OverTheSpot,Root,None>.
216
217=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
218
219Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
220international keyboards) or simply use ISO 14755 support to your
221advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
222codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
223character and so on.
224
225=item How can I keep rxvt-unicode from using reverse video so much?
226
227First of all, make sure you are running with the right terminfo
228(C<urxvt>), which will get rid of most of these effects. Then make sure
229you have specified colours for italic and bold, as otherwise rxvt-unicode
230might use reverse video to simulate the effect:
231
232 URxvt*colorBD: white
233 URxvt*colorIT: green
234
235=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
236
237For some unexplainable reason, some programs (i.e. irssi) assume a very
238weird colour palette when confronted with a terminal with more than the
239standard 8 colours (rxvt-unicode supports 88). The right fix is, of
240course, to fix these programs not to assume non-ISO colours without very
241good reasons.
242
243In the meantime, you can either edit your C<urxvt> terminfo definition to
244only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
245but keep you from using other rxvt-unicode features.
246
247=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
248
249Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
250in your compile environment, or an implementation that implements it,
251wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
252B<wchar_t> is represented as unicode.
253
254As you might have guessed, FreeBSD does neither define this symobl nor
255does it support it. Instead, it uses it's own internal representation of
256B<wchar_t>. This is, of course, completely legal.
257
258However, C<__STDC_ISO_10646__> is the only sane way to support
259multi-language apps in an OS, as using a locale-dependent (and
260non-standardized) representation of B<wchar_t> makes it impossible to
261convert between B<wchar_t> (as used by X11 and your applications) and any
262other encoding without implementing OS-specific-wrappers for each and
263every locale. There simply are no APIs to convert B<wchar_t> into anything
264except the current locale encoding.
265
266Some applications (such as the formidable B<mlterm>) work around this
267by carrying their own replacement functions for character set handling
268with them, and either implementing OS-dependent hacks or doing multiple
269conversions (which is slow and unreliable in case the OS implements
270encodings slightly different than the terminal emulator).
271
272The rxvt-unicode author insists that the right way to fix this is in the
273system libraries once and for all, instead of forcing every app to carry
274complete replacements.
275
276=item How does rxvt-unicode determine the encoding to use?
277
278=item Is there an option to switch encodings?
279
280Unlike some other terminals, rxvt-unicode has no encoding switch, and no
281specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
282UTF-8 or any other encodings with respect to terminal I/O.
283
284The reasons is that there exists a perfectly fine mechanism for selecting
285the encoding, doing I/O and (most important) communicating this to all
286applications so everybody agrees on character properties such as width and
287code number. This mechanism is the I<locale>.
288
289Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
290programs doing the same (that is, most) will automatically agree in the
291interpretation of characters.
292
293Unfortunately, there is no system-independent way to select locales, nor
294is there a standard on how locale specifiers will look like.
295
296On most systems, the content of the C<LC_CTYPE> environment variable
297contains an arbitrary string which corresponds to an already-installed
298locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
299C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
300(i.e. C<de> or C<german>) are also common.
301
302Rxvt-unicode ignores all other locale categories, and except for
303the encoding, ignores country or language-specific settings,
304i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
305
306If you want to use a specific encoding you have to make sure you start
307rxvt-unicode with the correct C<LC_CTYPE> category.
308
309=item Can I switch locales at runtime?
310
311Yes, using an escape sequence. Try sth. like this, which sets
312rxvt-unicode's idea of C<LC_CTYPE>.
313
314 printf '\e]701;%s\007' ja_JP.SJIS
315
316See also the previous question.
317
318Sometimes this capability is rather handy when you want to work in one
319locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
320example, I use this script to start C<xjdic>, which first switches to a
321locale supported by xjdic and back later:
322
323 printf '\e]701;%s\007' ja_JP.SJIS
324 xjdic -js
325 printf '\e]701;%s\007' de_DE.UTF-8
326
327=item Can I switch the fonts at runtime?
328
329Yes, using an escape sequence. Try sth. like this, which has the same
330effect as using the C<-fn> switch, and takes effect immediately:
331
332 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
333
334This is useful if you e.g. work primarily with japanese (and prefer a
335japanese font), but you have to switch to chinese temporarily, where
336japanese fonts would only be in your way.
337
338You can think of this as a kind of manual ISO-2022 switching.
339
340=item Why do italic characters look as if clipped?
341
342Many fonts have difficulties with italic characters and hinting. For
343example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
344Mono> completely fails in it's italic face. A workaround is to enable
345freetype autohinting, i.e. like this:
346
347 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
348 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
349
350=item My input method wants <some encoding> but I want UTF-8, what can I do?
351
352You can specify separate locales for the input method and the rest of the
353terminal, using the resource C<imlocale>:
354
355 URxvt*imlocale: ja_JP.EUC-JP
356
357Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
358use your input method. Please note, however, that you will not be able to
359input characters outside C<EUC-JP> in a normal way then, as your input
360method limits you.
361
362=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?
363 59
364Rxvt-unicode tries to obey the rule of not charging you for sth. you 60Rxvt-unicode tries to obey the rule of not charging you for something you
365don'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
366you 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,
367when 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
368accidentally when rxvt-unicode tries to find a font for your characters. 64accidentally when rxvt-unicode tries to find a font for your characters.
369 65
3726 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
373kilobyte 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)
374use 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
375rxvt-unicode then uses 8 bytes per screen cell. 71rxvt-unicode then uses 8 bytes per screen cell.
376 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 do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266
267=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268
269Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might
271contain some characters that are simply too wide. Rxvt-unicode will avoid
272these characters. For characters that are just "a bit" too wide a special
273"careful" rendering mode is used that redraws adjacent characters.
274
275All of this requires that fonts do not lie about character sizes,
276however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these
279cases).
280
281It's not clear (to me at least), wether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font.
285
286All of this is not a problem when using X11 core fonts, as their bounding
287box data is correct.
288
289=head3 How can I keep rxvt-unicode from using reverse video so much?
290
291First of all, make sure you are running with the right terminal settings
292(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
293make sure you have specified colours for italic and bold, as otherwise
294rxvt-unicode might use reverse video to simulate the effect:
295
296 URxvt.colorBD: white
297 URxvt.colorIT: green
298
299=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
300
301For some unexplainable reason, some rare programs assume a very weird
302colour palette when confronted with a terminal with more than the standard
3038 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
304these programs not to assume non-ISO colours without very good reasons.
305
306In the meantime, you can either edit your C<rxvt-unicode> terminfo
307definition to only claim 8 colour support or use C<TERM=rxvt>, which will
308fix colours but keep you from using other rxvt-unicode features.
309
310=head3 Can I switch the fonts at runtime?
311
312Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately:
314
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
316
317This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way.
320
321You can think of this as a kind of manual ISO-2022 switching.
322
323=head3 Why do italic characters look as if clipped?
324
325Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to
328enable freetype autohinting, i.e. like this:
329
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332
377=item Can I speed up Xft rendering somehow? 333=head3 Can I speed up Xft rendering somehow?
378 334
379Yes, the most obvious way to speed it up is to avoid Xft entirely, as 335Yes, the most obvious way to speed it up is to avoid Xft entirely, as
380it is simply slow. If you still want Xft fonts you might try to disable 336it is simply slow. If you still want Xft fonts you might try to disable
381antialiasing (by appending C<:antialiasing=false>), which saves lots of 337antialiasing (by appending C<:antialias=false>), which saves lots of
382memory and also speeds up rendering considerably. 338memory and also speeds up rendering considerably.
383 339
384=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385 341
386Rxvt-unicode will use whatever you specify as a font. If it needs to 342Rxvt-unicode will use whatever you specify as a font. If it needs to
387fall back to it's default font search list it will prefer X11 core 343fall back to it's default font search list it will prefer X11 core
388fonts, because they are small and fast, and then use Xft fonts. It has 344fonts, because they are small and fast, and then use Xft fonts. It has
389antialiasing disabled for most of them, because the author thinks they 345antialiasing disabled for most of them, because the author thinks they
390look best that way. 346look best that way.
391 347
392If you want antialiasing, you have to specify the fonts manually. 348If you want antialiasing, you have to specify the fonts manually.
393 349
394=item Mouse cut/paste suddenly no longer works.
395
396Make sure that mouse reporting is actually turned off since killing
397some editors prematurely may leave the mouse in mouse report mode. I've
398heard that tcsh may use mouse reporting unless it otherwise specified. A
399quick check is to see if cut/paste works when the Alt or Shift keys are
400depressed. See @@RXVT_NAME@@(7)
401
402=item What's with this bold/blink stuff? 350=head3 What's with this bold/blink stuff?
403 351
404If no bold colour is set via C<colorBD:>, bold will invert text using the 352If no bold colour is set via C<colorBD:>, bold will invert text using the
405standard foreground colour. 353standard foreground colour.
406 354
407For the standard background colour, blinking will actually make the 355For the standard background colour, blinking will actually make the
414 362
415color0-7 are the low-intensity colors. 363color0-7 are the low-intensity colors.
416 364
417color8-15 are the corresponding high-intensity colors. 365color8-15 are the corresponding high-intensity colors.
418 366
419=item I don't like the screen colors. How do I change them? 367=head3 I don't like the screen colors. How do I change them?
420 368
421You can change the screen colors at run-time using F<~/.Xdefaults> 369You can change the screen colors at run-time using F<~/.Xdefaults>
422resources (or as long-options). 370resources (or as long-options).
423 371
424Here are values that are supposed to resemble a VGA screen, 372Here are values that are supposed to resemble a VGA screen,
425including the murky brown that passes for low-intensity yellow: 373including the murky brown that passes for low-intensity yellow:
426 374
427 URxvt*color0: #000000 375 URxvt.color0: #000000
428 URxvt*color1: #A80000 376 URxvt.color1: #A80000
429 URxvt*color2: #00A800 377 URxvt.color2: #00A800
430 URxvt*color3: #A8A800 378 URxvt.color3: #A8A800
431 URxvt*color4: #0000A8 379 URxvt.color4: #0000A8
432 URxvt*color5: #A800A8 380 URxvt.color5: #A800A8
433 URxvt*color6: #00A8A8 381 URxvt.color6: #00A8A8
434 URxvt*color7: #A8A8A8 382 URxvt.color7: #A8A8A8
435 383
436 URxvt*color8: #000054 384 URxvt.color8: #000054
437 URxvt*color9: #FF0054 385 URxvt.color9: #FF0054
438 URxvt*color10: #00FF54 386 URxvt.color10: #00FF54
439 URxvt*color11: #FFFF54 387 URxvt.color11: #FFFF54
440 URxvt*color12: #0000FF 388 URxvt.color12: #0000FF
441 URxvt*color13: #FF00FF 389 URxvt.color13: #FF00FF
442 URxvt*color14: #00FFFF 390 URxvt.color14: #00FFFF
443 URxvt*color15: #FFFFFF 391 URxvt.color15: #FFFFFF
444 392
445And here is a more complete set of non-standard colors described as 393And here is a more complete set of non-standard colors.
446"pretty girly":
447 394
448 URxvt.cursorColor: #dc74d1 395 URxvt.cursorColor: #dc74d1
449 URxvt.pointerColor: #dc74d1 396 URxvt.pointerColor: #dc74d1
450 URxvt.background: #0e0e0e 397 URxvt.background: #0e0e0e
451 URxvt.foreground: #4ad5e1 398 URxvt.foreground: #4ad5e1
462 URxvt.color6: #73f7ff 409 URxvt.color6: #73f7ff
463 URxvt.color14: #73f7ff 410 URxvt.color14: #73f7ff
464 URxvt.color7: #e1dddd 411 URxvt.color7: #e1dddd
465 URxvt.color15: #e1dddd 412 URxvt.color15: #e1dddd
466 413
414They have been described (not by me) as "pretty girly".
415
416=head3 Why do some characters look so much different than others?
417
418See next entry.
419
420=head3 How does rxvt-unicode choose fonts?
421
422Most fonts do not contain the full range of Unicode, which is
423fine. Chances are that the font you (or the admin/package maintainer of
424your system/os) have specified does not cover all the characters you want
425to display.
426
427B<rxvt-unicode> makes a best-effort try at finding a replacement
428font. Often the result is fine, but sometimes the chosen font looks
429bad/ugly/wrong. Some fonts have totally strange characters that don't
430resemble the correct glyph at all, and rxvt-unicode lacks the artificial
431intelligence to detect that a specific glyph is wrong: it has to believe
432the font that the characters it claims to contain indeed look correct.
433
434In that case, select a font of your taste and add it to the font list,
435e.g.:
436
437 @@URXVT_NAME@@ -fn basefont,font2,font3...
438
439When rxvt-unicode sees a character, it will first look at the base
440font. If the base font does not contain the character, it will go to the
441next font, and so on. Specifying your own fonts will also speed up this
442search and use less resources within rxvt-unicode and the X-server.
443
444The only limitation is that none of the fonts may be larger than the base
445font, as the base font defines the terminal character cell size, which
446must be the same due to the way terminals work.
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
467=item What's with the strange Backspace/Delete key behaviour? 542=head3 What's with the strange Backspace/Delete key behaviour?
468 543
469Assuming that the physical Backspace key corresponds to the 544Assuming that the physical Backspace key corresponds to the
470BackSpace keysym (not likely for Linux ... see the following 545BackSpace keysym (not likely for Linux ... see the following
471question) there are two standard values that can be used for 546question) there are two standard values that can be used for
472Backspace: C<^H> and C<^?>. 547Backspace: C<^H> and C<^?>.
483 558
484For starting a new rxvt-unicode: 559For starting a new rxvt-unicode:
485 560
486 # use Backspace = ^H 561 # use Backspace = ^H
487 $ stty erase ^H 562 $ stty erase ^H
488 $ @@RXVT_NAME@@ 563 $ @@URXVT_NAME@@
489 564
490 # use Backspace = ^? 565 # use Backspace = ^?
491 $ stty erase ^? 566 $ stty erase ^?
492 $ @@RXVT_NAME@@ 567 $ @@URXVT_NAME@@
493 568
494Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495 570
496For an existing rxvt-unicode: 571For an existing rxvt-unicode:
497 572
498 # use Backspace = ^H 573 # use Backspace = ^H
499 $ stty erase ^H 574 $ stty erase ^H
508properly reflects that. 583properly reflects that.
509 584
510The Delete key is a another casualty of the ill-defined Backspace problem. 585The Delete key is a another casualty of the ill-defined Backspace problem.
511To avoid confusion between the Backspace and Delete keys, the Delete 586To avoid confusion between the Backspace and Delete keys, the Delete
512key 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
513(ESC[3~) and is in the supplied termcap/terminfo. 588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514 589
515Some other Backspace problems: 590Some other Backspace problems:
516 591
517some editors use termcap/terminfo, 592some editors use termcap/terminfo,
518some editors (vim I'm told) expect Backspace = ^H, 593some editors (vim I'm told) expect Backspace = ^H,
519GNU Emacs (and Emacs-like editors) use ^H for help. 594GNU Emacs (and Emacs-like editors) use ^H for help.
520 595
521Perhaps someday this will all be resolved in a consistent manner. 596Perhaps someday this will all be resolved in a consistent manner.
522 597
523=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?
524 599
525There are some compile-time selections available via configure. Unless 600There are some compile-time selections available via configure. Unless
526you have run "configure" with the C<--disable-resources> option you can 601you have run "configure" with the C<--disable-resources> option you can
527use the `keysym' resource to alter the keystrings associated with keysyms. 602use the `keysym' resource to alter the keystrings associated with keysyms.
528 603
529Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt' 604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
530 605
531 URxvt.keysym.Home: \033[1~ 606 URxvt.keysym.Home: \033[1~
532 URxvt.keysym.End: \033[4~ 607 URxvt.keysym.End: \033[4~
533 URxvt.keysym.C-apostrophe: \033<C-'> 608 URxvt.keysym.C-apostrophe: \033<C-'>
534 URxvt.keysym.C-slash: \033<C-/> 609 URxvt.keysym.C-slash: \033<C-/>
549 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
551 626
552See some more examples in the documentation for the B<keysym> resource. 627See some more examples in the documentation for the B<keysym> resource.
553 628
554=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
555How do I make use of them? For example, the Sun Keyboard type 4
556has the following mappings that rxvt-unicode doesn't recognize.
557 630
558 KP_Insert == Insert 631 KP_Insert == Insert
559 F22 == Print 632 F22 == Print
560 F27 == Home 633 F27 == Home
561 F29 == Prior 634 F29 == Prior
564 637
565Rather than have rxvt-unicode try to accommodate all the various possible 638Rather than have rxvt-unicode try to accommodate all the various possible
566keyboard 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
567required for your particular machine. 640required for your particular machine.
568 641
569=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
570I need this to decide about setting colors etc.
571 642
572rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
573check and see if that is set. Note that several programs, JED, slrn,
574Midnight Commander automatically check this variable to decide whether or
575not to use color.
576 643
577=item How do I set the correct, full IP address for the DISPLAY variable? 644=head2 Terminal Configuration
578 645
579If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 646=head3 Why doesn't rxvt-unicode read my resources?
580insecure mode then it is possible to use the following shell script
581snippets to correctly set the display. If your version of rxvt-unicode
582wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
583the COLORTERM variable can be used to distinguish rxvt-unicode from a
584regular xterm.
585 647
586Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 648Well, why, indeed? It does, in a way very similar to other X
587snippets: 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.
588 653
589 # Bourne/Korn/POSIX family of shells: 654If you have or use an F<$HOME/.Xresources> file, chances are that
590 [ ${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
591 if [ ${TERM:-foo} = xterm ]; then 656re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
592 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
593 echo -n '^[Z'
594 read term_id
595 stty icanon echo
596 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
597 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
598 read DISPLAY # set it in our local shell
599 fi
600 fi
601 657
602=item How do I compile the manual pages for myself? 658Also consider the form resources have to use:
603 659
604You need to have a recent version of perl installed as F</usr/bin/perl>, 660 URxvt.resource: value
605one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
606the doc subdirectory and enter C<make alldoc>.
607 661
608=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.
609 665
610Before 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?
611channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
612interested in learning about new and exciting problems (but not FAQs :).
613 667
614=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).
615 670
616=head1 SYNOPSIS 671The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp):
617 673
618 # set a new font set 674 REMOTE=remotesystem.domain
619 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" 675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
620 676
621 # change the locale and tell rxvt-unicode about it 677... or by installing rxvt-unicode normally on the remote system,
622 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
623 678
624 # set window title 679If you cannot or do not want to do this, then you can simply set
625 printf '\33]2;%s\007' "new window title" 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
1008=head1 RXVT-UNICODE TECHNICAL REFERENCE
626 1009
627=head1 DESCRIPTION 1010=head1 DESCRIPTION
628 1011
629The rest of this document describes various technical aspects of 1012The rest of this document describes various technical aspects of
630B<rxvt-unicode>. First the description of supported command sequences, 1013B<rxvt-unicode>. First the description of supported command sequences,
631followed by menu and pixmap support and last by a description of all 1014followed by pixmap support and last by a description of all features
632features selectable at C<configure> time. 1015selectable at C<configure> time.
633
634=head1 RXVT TECHNICAL REFERENCE
635 1016
636=head1 Definitions 1017=head1 Definitions
637 1018
638=over 4 1019=over 4
639 1020
768Single Shift Select of G3 Character Set (SS3): affects next character 1149Single Shift Select of G3 Character Set (SS3): affects next character
769only I<unimplemented> 1150only I<unimplemented>
770 1151
771=item B<< C<ESC Z> >> 1152=item B<< C<ESC Z> >>
772 1153
773Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1154Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
774 1155
775=item B<< C<ESC c> >> 1156=item B<< C<ESC c> >>
776 1157
777Full reset (RIS) 1158Full reset (RIS)
778 1159
782 1163
783=item B<< C<ESC o> >> 1164=item B<< C<ESC o> >>
784 1165
785Invoke the G3 Character Set (LS3) 1166Invoke the G3 Character Set (LS3)
786 1167
787=item B<< C<ESC> ( C> >> 1168=item B<< C<ESC ( C> >>
788 1169
789Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1170Designate G0 Character Set (ISO 2022), see below for values of C<C>.
790 1171
791=item B<< C<ESC> ) C> >> 1172=item B<< C<ESC ) C> >>
792 1173
793Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1174Designate G1 Character Set (ISO 2022), see below for values of C<C>.
794 1175
795=item B<< C<ESC * C> >> 1176=item B<< C<ESC * C> >>
796 1177
937 1318
938=item B<< C<ESC [ Ps c> >> 1319=item B<< C<ESC [ Ps c> >>
939 1320
940Send Device Attributes (DA) 1321Send Device Attributes (DA)
941B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1322B<< C<Ps = 0> >> (or omitted): request attributes from terminal
942returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1323returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
943Option'') 1324Option'')
944 1325
945=item B<< C<ESC [ Ps d> >> 1326=item B<< C<ESC [ Ps d> >>
946 1327
947Cursor to Line B<< C<Ps> >> (VPA) 1328Cursor to Line B<< C<Ps> >> (VPA)
1077 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels 1458 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1078 B<< C<Ps = 5> >> Raise window 1459 B<< C<Ps = 5> >> Raise window
1079 B<< C<Ps = 6> >> Lower window 1460 B<< C<Ps = 6> >> Lower window
1080 B<< C<Ps = 7> >> Refresh screen once 1461 B<< C<Ps = 7> >> Refresh screen once
1081 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns 1462 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1082 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2> 1463 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1083 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) 1464 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1084 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) 1465 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1085 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) 1466 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1086 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> 1467 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1087 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) 1468 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1207 B<< C<h> >> Send Mouse X & Y on button press. 1588 B<< C<h> >> Send Mouse X & Y on button press.
1208 B<< C<l> >> No mouse reporting. 1589 B<< C<l> >> No mouse reporting.
1209 1590
1210=end table 1591=end table
1211 1592
1212=item B<< C<Ps = 10> >> (B<rxvt>)
1213
1214=begin table
1215
1216 B<< C<h> >> menuBar visible
1217 B<< C<l> >> menuBar invisible
1218
1219=end table
1220
1221=item B<< C<Ps = 25> >> 1593=item B<< C<Ps = 25> >>
1222 1594
1223=begin table 1595=begin table
1224 1596
1225 B<< C<h> >> Visible cursor {cnorm/cvvis} 1597 B<< C<h> >> Visible cursor {cnorm/cvvis}
1338 1710
1339=begin table 1711=begin table
1340 1712
1341 B<< C<h> >> Scroll to bottom when a key is pressed 1713 B<< C<h> >> Scroll to bottom when a key is pressed
1342 B<< C<l> >> Don't scroll to bottom when a key is pressed 1714 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715
1716=end table
1717
1718=item B<< C<Ps = 1021> >> (B<rxvt>)
1719
1720=begin table
1721
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1343 1724
1344=end table 1725=end table
1345 1726
1346=item B<< C<Ps = 1047> >> 1727=item B<< C<Ps = 1047> >>
1347 1728
1396 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1777 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1397 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1778 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1398 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1399 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1400 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1401 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1402 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1403 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1404 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1405 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1786 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1406 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1787 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1407 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> >> 1788 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> >>
1408 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1409 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) 1790 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).
1410 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1791 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>.
1411 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1412 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1413 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1414 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1415 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1416 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1801 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1802 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1417 1803
1418=end table 1804=end table
1419 1805
1420=back 1806=back
1421 1807
1422X<menuBar>
1423
1424=head1 menuBar
1425
1426B<< The exact syntax used is I<almost> solidified. >>
1427In the menus, B<DON'T> try to use menuBar commands that add or remove a
1428menuBar.
1429
1430Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1431omitted: use B<./> to specify a menu relative to the current menu.
1432
1433=head2 Overview of menuBar operation
1434
1435For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1436of C<Pt> can be used for a variety of tasks:
1437
1438At the top level is the current menuBar which is a member of a circular
1439linked-list of other such menuBars.
1440
1441The menuBar acts as a parent for the various drop-down menus, which in
1442turn, may have labels, separator lines, menuItems and subMenus.
1443
1444The menuItems are the useful bits: you can use them to mimic keyboard
1445input or even to send text or escape sequences back to rxvt.
1446
1447The menuBar syntax is intended to provide a simple yet robust method of
1448constructing and manipulating menus and navigating through the
1449menuBars.
1450
1451The first step is to use the tag B<< [menu:I<name>] >> which creates
1452the menuBar called I<name> and allows access. You may now or menus,
1453subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1454menuBar access as B<readonly> to prevent accidental corruption of the
1455menus. To re-access the current menuBar for alterations, use the tag
1456B<[menu]>, make the alterations and then use B<[done]>
1457
1458X<menuBarCommands>
1459
1460=head2 Commands
1461
1462=over 4
1463
1464=item B<< [menu:+I<name>] >>
1465
1466access the named menuBar for creation or alteration. If a new menuBar
1467is created, it is called I<name> (max of 15 chars) and the current
1468menuBar is pushed onto the stack
1469
1470=item B<[menu]>
1471
1472access the current menuBar for alteration
1473
1474=item B<< [title:+I<string>] >>
1475
1476set the current menuBar's title to I<string>, which may contain the
1477following format specifiers:
1478B<%%> : literal B<%> character
1479B<%n> : rxvt name (as per the B<-name> command-line option)
1480B<%v> : rxvt version
1481
1482=item B<[done]>
1483
1484set menuBar access as B<readonly>.
1485End-of-file tag for B<< [read:+I<file>] >> operations.
1486
1487=item B<< [read:+I<file>] >>
1488
1489read menu commands directly from I<file> (extension ".menu" will be
1490appended if required.) Start reading at a line with B<[menu]> or B<<
1491[menu:+I<name> >> and continuing until B<[done]> is encountered.
1492
1493Blank and comment lines (starting with B<#>) are ignored. Actually,
1494since any invalid menu commands are also ignored, almost anything could
1495be construed as a comment line, but this may be tightened up in the
1496future ... so don't count on it!.
1497
1498=item B<< [read:+I<file>;+I<name>] >>
1499
1500The same as B<< [read:+I<file>] >>, but start reading at a line with
1501B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1502B<[done]> is encountered.
1503
1504=item B<[dump]>
1505
1506dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1507later rereading.
1508
1509=item B<[rm:name]>
1510
1511remove the named menuBar
1512
1513=item B<[rm] [rm:]>
1514
1515remove the current menuBar
1516
1517=item B<[rm*] [rm:*]>
1518
1519remove all menuBars
1520
1521=item B<[swap]>
1522
1523swap the top two menuBars
1524
1525=item B<[prev]>
1526
1527access the previous menuBar
1528
1529=item B<[next]>
1530
1531access the next menuBar
1532
1533=item B<[show]>
1534
1535Enable display of the menuBar
1536
1537=item B<[hide]>
1538
1539Disable display of the menuBar
1540
1541=item B<< [pixmap:+I<name>] >>
1542
1543=item B<< [pixmap:+I<name>;I<scaling>] >>
1544
1545(set the background pixmap globally
1546
1547B<< A Future implementation I<may> make this local to the menubar >>)
1548
1549=item B<< [:+I<command>:] >>
1550
1551ignore the menu readonly status and issue a I<command> to or a menu or
1552menuitem or change the ; a useful shortcut for setting the quick arrows
1553from a menuBar.
1554
1555=back
1556
1557X<menuBarAdd>
1558
1559=head2 Adding and accessing menus
1560
1561The following commands may also be B<+> prefixed.
1562
1563=over 4
1564
1565=item B</+>
1566
1567access menuBar top level
1568
1569=item B<./+>
1570
1571access current menu level
1572
1573=item B<../+>
1574
1575access parent menu (1 level up)
1576
1577=item B<../../>
1578
1579access parent menu (multiple levels up)
1580
1581=item B<< I</path/>menu >>
1582
1583add/access menu
1584
1585=item B<< I</path/>menu/* >>
1586
1587add/access menu and clear it if it exists
1588
1589=item B<< I</path/>{-} >>
1590
1591add separator
1592
1593=item B<< I</path/>{item} >>
1594
1595add B<item> as a label
1596
1597=item B<< I</path/>{item} action >>
1598
1599add/alter I<menuitem> with an associated I<action>
1600
1601=item B<< I</path/>{item}{right-text} >>
1602
1603add/alter I<menuitem> with B<right-text> as the right-justified text
1604and as the associated I<action>
1605
1606=item B<< I</path/>{item}{rtext} action >>
1607
1608add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1609the right-justified text.
1610
1611=back
1612
1613=over 4
1614
1615=item Special characters in I<action> must be backslash-escaped:
1616
1617B<\a \b \E \e \n \r \t \octal>
1618
1619=item or in control-character notation:
1620
1621B<^@, ^A .. ^Z .. ^_, ^?>
1622
1623=back
1624
1625To send a string starting with a B<NUL> (B<^@>) character to the
1626program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1627the first of which will be stripped off and the balance directed to the
1628program. Otherwise if I<action> begins with B<NUL> followed by
1629non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1630balance is sent back to rxvt.
1631
1632As a convenience for the many Emacs-type editors, I<action> may start
1633with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1634appended if missed from B<M-x> commands.
1635
1636As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1637quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1638
1639=over 4
1640
1641=item For example,
1642
1643B<M-xapropos> is equivalent to B<\Exapropos\r>
1644
1645=item and
1646
1647B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1648
1649=back
1650
1651The option B<< {I<right-rtext>} >> will be right-justified. In the
1652absence of a specified action, this text will be used as the I<action>
1653as well.
1654
1655=over 4
1656
1657=item For example,
1658
1659B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1660
1661=back
1662
1663The left label I<is> necessary, since it's used for matching, but
1664implicitly hiding the left label (by using same name for both left and
1665right labels), or explicitly hiding the left label (by preceeding it
1666with a dot), makes it possible to have right-justified text only.
1667
1668=over 4
1669
1670=item For example,
1671
1672B</File/{Open}{Open} Open-File-Action>
1673
1674=item or hiding it
1675
1676B</File/{.anylabel}{Open} Open-File-Action>
1677
1678=back
1679
1680X<menuBarRemove>
1681
1682=head2 Removing menus
1683
1684=over 4
1685
1686=item B<< -/*+ >>
1687
1688remove all menus from the menuBar, the same as B<[clear]>
1689
1690=item B<< -+I</path>menu+ >>
1691
1692remove menu
1693
1694=item B<< -+I</path>{item}+ >>
1695
1696remove item
1697
1698=item B<< -+I</path>{-} >>
1699
1700remove separator)
1701
1702=item B<-/path/menu/*>
1703
1704remove all items, separators and submenus from menu
1705
1706=back
1707
1708X<menuBarArrows>
1709
1710=head2 Quick Arrows
1711
1712The menus also provide a hook for I<quick arrows> to provide easier
1713user access. If nothing has been explicitly set, the default is to
1714emulate the curror keys. The syntax permits each arrow to be altered
1715individually or all four at once without re-entering their common
1716beginning/end text. For example, to explicitly associate cursor actions
1717with the arrows, any of the following forms could be used:
1718
1719=over 4
1720
1721=item B<< <r>+I<Right> >>
1722
1723=item B<< <l>+I<Left> >>
1724
1725=item B<< <u>+I<Up> >>
1726
1727=item B<< <d>+I<Down> >>
1728
1729Define actions for the respective arrow buttons
1730
1731=item B<< <b>+I<Begin> >>
1732
1733=item B<< <e>+I<End> >>
1734
1735Define common beginning/end parts for I<quick arrows> which used in
1736conjunction with the above <r> <l> <u> <d> constructs
1737
1738=back
1739
1740=over 4
1741
1742=item For example, define arrows individually,
1743
1744 <u>\E[A
1745
1746 <d>\E[B
1747
1748 <r>\E[C
1749
1750 <l>\E[D
1751
1752=item or all at once
1753
1754 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1755
1756=item or more compactly (factoring out common parts)
1757
1758 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1759
1760=back
1761
1762X<menuBarSummary>
1763
1764=head2 Command Summary
1765
1766A short summary of the most I<common> commands:
1767
1768=over 4
1769
1770=item [menu:name]
1771
1772use an existing named menuBar or start a new one
1773
1774=item [menu]
1775
1776use the current menuBar
1777
1778=item [title:string]
1779
1780set menuBar title
1781
1782=item [done]
1783
1784set menu access to readonly and, if reading from a file, signal EOF
1785
1786=item [done:name]
1787
1788if reading from a file using [read:file;name] signal EOF
1789
1790=item [rm:name]
1791
1792remove named menuBar(s)
1793
1794=item [rm] [rm:]
1795
1796remove current menuBar
1797
1798=item [rm*] [rm:*]
1799
1800remove all menuBar(s)
1801
1802=item [swap]
1803
1804swap top two menuBars
1805
1806=item [prev]
1807
1808access the previous menuBar
1809
1810=item [next]
1811
1812access the next menuBar
1813
1814=item [show]
1815
1816map menuBar
1817
1818=item [hide]
1819
1820unmap menuBar
1821
1822=item [pixmap;file]
1823
1824=item [pixmap;file;scaling]
1825
1826set a background pixmap
1827
1828=item [read:file]
1829
1830=item [read:file;name]
1831
1832read in a menu from a file
1833
1834=item [dump]
1835
1836dump out all menuBars to /tmp/rxvt-PID
1837
1838=item /
1839
1840access menuBar top level
1841
1842=item ./
1843
1844=item ../
1845
1846=item ../../
1847
1848access current or parent menu level
1849
1850=item /path/menu
1851
1852add/access menu
1853
1854=item /path/{-}
1855
1856add separator
1857
1858=item /path/{item}{rtext} action
1859
1860add/alter menu item
1861
1862=item -/*
1863
1864remove all menus from the menuBar
1865
1866=item -/path/menu
1867
1868remove menu items, separators and submenus from menu
1869
1870=item -/path/menu
1871
1872remove menu
1873
1874=item -/path/{item}
1875
1876remove item
1877
1878=item -/path/{-}
1879
1880remove separator
1881
1882=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1883
1884menu quick arrows
1885
1886=back
1887X<XPM> 1808X<XPM>
1888 1809
1889=head1 XPM 1810=head1 XPM
1890 1811
1891For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1990=begin table 1911=begin table
1991 1912
1992 4 Shift 1913 4 Shift
1993 8 Meta 1914 8 Meta
1994 16 Control 1915 16 Control
1995 32 Double Click I<(Rxvt extension)> 1916 32 Double Click I<(rxvt extension)>
1996 1917
1997=end table 1918=end table
1998 1919
1999Col = B<< C<< <x> - SPACE >> >> 1920Col = B<< C<< <x> - SPACE >> >>
2000 1921
2077=end table 1998=end table
2078 1999
2079=head1 CONFIGURE OPTIONS 2000=head1 CONFIGURE OPTIONS
2080 2001
2081General hint: if you get compile errors, then likely your configuration 2002General hint: if you get compile errors, then likely your configuration
2082hasn't been tested well. Either try with --enable-everything or use the 2003hasn't been tested well. Either try with C<--enable-everything> or use
2083./reconf script as a base for experiments. ./reconf is used by myself, 2004the F<./reconf> script as a base for experiments. F<./reconf> is used by
2084so it should generally be a working config. Of course, you should always 2005myself, so it should generally be a working config. Of course, you should
2085report when a combination doesn't work, so it can be fixed. Marc Lehmann 2006always report when a combination doesn't work, so it can be fixed. Marc
2086<rxvt@schmorp.de>. 2007Lehmann <rxvt@schmorp.de>.
2008
2009All
2087 2010
2088=over 4 2011=over 4
2089 2012
2090=item --enable-everything 2013=item --enable-everything
2091 2014
2092Add support for all non-multichoice options listed in "./configure 2015Add (or remove) support for all non-multichoice options listed in "./configure
2093--help". Note that unlike other enable options this is order dependant. 2016--help".
2017
2094You can specify this and then disable options which this enables by 2018You can specify this and then disable options you do not like by
2095I<following> this with the appropriate commands. 2019I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want.
2096 2023
2097=item --enable-xft 2024=item --enable-xft (default: enabled)
2098 2025
2099Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2026Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2100slower and require lots of memory, but as long as you don't use them, you 2027slower and require lots of memory, but as long as you don't use them, you
2101don't pay for them. 2028don't pay for them.
2102 2029
2103=item --enable-font-styles 2030=item --enable-font-styles (default: on)
2104 2031
2105Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2032Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2106styles. The fonts can be set manually or automatically. 2033styles. The fonts can be set manually or automatically.
2107 2034
2108=item --with-codesets=NAME,... 2035=item --with-codesets=NAME,... (default: all)
2109 2036
2110Compile in support for additional codeset (encoding) groups (eu, vn are 2037Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2111always compiled in, which includes most 8-bit character sets). These 2038are always compiled in, which includes most 8-bit character sets). These
2112codeset tables are currently only used for driving X11 core fonts, they 2039codeset tables are used for driving X11 core fonts, they are not required
2113are not required for Xft fonts. Compiling them in will make your binary 2040for Xft fonts, although having them compiled in lets rxvt-unicode choose
2114bigger (together about 700kB), but it doesn't increase memory usage unless 2041replacement fonts more intelligently. Compiling them in will make your
2042binary bigger (all of together cost about 700kB), but it doesn't increase
2115you use an X11 font requiring one of these encodings. 2043memory usage unless you use a font requiring one of these encodings.
2116 2044
2117=begin table 2045=begin table
2118 2046
2119 all all available codeset groups 2047 all all available codeset groups
2120 zh common chinese encodings 2048 zh common chinese encodings
2123 jp_ext rarely used but big japanese encodings 2051 jp_ext rarely used but big japanese encodings
2124 kr korean encodings 2052 kr korean encodings
2125 2053
2126=end table 2054=end table
2127 2055
2128=item --enable-xim 2056=item --enable-xim (default: on)
2129 2057
2130Add support for XIM (X Input Method) protocol. This allows using 2058Add support for XIM (X Input Method) protocol. This allows using
2131alternative input methods (e.g. kinput2) and will also correctly 2059alternative input methods (e.g. kinput2) and will also correctly
2132set up the input for people using dead keys or compose keys. 2060set up the input for people using dead keys or compose keys.
2133 2061
2134=item --enable-unicode3 2062=item --enable-unicode3 (default: off)
2063
2064Recommended to stay off unless you really need non-BMP characters.
2135 2065
2136Enable direct support for displaying unicode codepoints above 2066Enable direct support for displaying unicode codepoints above
213765535 (the basic multilingual page). This increases storage 206765535 (the basic multilingual page). This increases storage
2138requirements per character from 2 to 4 bytes. X11 fonts do not yet 2068requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139support these extra characters, but Xft does. 2069support these extra characters, but Xft does.
2142even without this flag, but the number of such characters is 2072even without this flag, but the number of such characters is
2143limited to a view thousand (shared with combining characters, 2073limited to a view thousand (shared with combining characters,
2144see next switch), and right now rxvt-unicode cannot display them 2074see next switch), and right now rxvt-unicode cannot display them
2145(input/output and cut&paste still work, though). 2075(input/output and cut&paste still work, though).
2146 2076
2147=item --enable-combining 2077=item --enable-combining (default: on)
2148 2078
2149Enable automatic composition of combining characters into 2079Enable automatic composition of combining characters into
2150composite characters. This is required for proper viewing of text 2080composite characters. This is required for proper viewing of text
2151where accents are encoded as seperate unicode characters. This is 2081where accents are encoded as seperate unicode characters. This is
2152done by using precomposited characters when available or creating 2082done by using precomposited characters when available or creating
2153new pseudo-characters when no precomposed form exists. 2083new pseudo-characters when no precomposed form exists.
2154 2084
2155Without --enable-unicode3, the number of additional precomposed 2085Without --enable-unicode3, the number of additional precomposed
2156characters is rather limited (2048, if this is full, rxvt will use the 2086characters is somewhat limited (the 6400 private use characters will be
2157private use area, extending the number of combinations to 8448). With 2087(ab-)used). With --enable-unicode3, no practical limit exists.
2158--enable-unicode3, no practical limit exists. This will also enable 2088
2159storage of characters >65535. 2089This option will also enable storage (but not display) of characters
2090beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2160 2091
2161The combining table also contains entries for arabic presentation forms, 2092The combining table also contains entries for arabic presentation forms,
2162but these are not currently used. Bug me if you want these to be used. 2093but these are not currently used. Bug me if you want these to be used (and
2094tell me how these are to be used...).
2163 2095
2164=item --enable-fallback(=CLASS) 2096=item --enable-fallback(=CLASS) (default: Rxvt)
2165 2097
2166When reading resource settings, also read settings for class CLASS 2098When reading resource settings, also read settings for class CLASS. To
2167(default: Rxvt). To disable resource fallback use --disable-fallback. 2099disable resource fallback use --disable-fallback.
2168 2100
2169=item --with-res-name=NAME 2101=item --with-res-name=NAME (default: urxvt)
2170 2102
2171Use the given name (default: urxvt) as default application name when 2103Use the given name as default application name when
2172reading resources. Specify --with-res-name=rxvt to replace rxvt. 2104reading resources. Specify --with-res-name=rxvt to replace rxvt.
2173 2105
2174=item --with-res-class=CLASS 2106=item --with-res-class=CLASS /default: URxvt)
2175 2107
2176Use the given class (default: URxvt) as default application class 2108Use the given class as default application class
2177when reading resources. Specify --with-res-class=Rxvt to replace 2109when reading resources. Specify --with-res-class=Rxvt to replace
2178rxvt. 2110rxvt.
2179 2111
2180=item --enable-utmp 2112=item --enable-utmp (default: on)
2181 2113
2182Write user and tty to utmp file (used by programs like F<w>) at 2114Write user and tty to utmp file (used by programs like F<w>) at
2183start of rxvt execution and delete information when rxvt exits. 2115start of rxvt execution and delete information when rxvt exits.
2184 2116
2185=item --enable-wtmp 2117=item --enable-wtmp (default: on)
2186 2118
2187Write user and tty to wtmp file (used by programs like F<last>) at 2119Write user and tty to wtmp file (used by programs like F<last>) at
2188start of rxvt execution and write logout when rxvt exits. This 2120start of rxvt execution and write logout when rxvt exits. This
2189option requires --enable-utmp to also be specified. 2121option requires --enable-utmp to also be specified.
2190 2122
2191=item --enable-lastlog 2123=item --enable-lastlog (default: on)
2192 2124
2193Write user and tty to lastlog file (used by programs like 2125Write user and tty to lastlog file (used by programs like
2194F<lastlogin>) at start of rxvt execution. This option requires 2126F<lastlogin>) at start of rxvt execution. This option requires
2195--enable-utmp to also be specified. 2127--enable-utmp to also be specified.
2196 2128
2197=item --enable-xpm-background 2129=item --enable-xpm-background (default: on)
2198 2130
2199Add support for XPM background pixmaps. 2131Add support for XPM background pixmaps.
2200 2132
2201=item --enable-transparency 2133=item --enable-transparency (default: on)
2202 2134
2203Add support for inheriting parent backgrounds thus giving a fake 2135Add support for inheriting parent backgrounds thus giving a fake
2204transparency to the term. 2136transparency to the term.
2205 2137
2206=item --enable-fading 2138=item --enable-fading (default: on)
2207 2139
2208Add support for fading the text when focus is lost. 2140Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2209 2141
2210=item --enable-tinting 2142=item --enable-tinting (default: on)
2211 2143
2212Add support for tinting of transparent backgrounds. 2144Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2213 2145
2214=item --enable-menubar
2215
2216Add support for our menu bar system (this interacts badly with
2217dynamic locale switching currently).
2218
2219=item --enable-rxvt-scroll 2146=item --enable-rxvt-scroll (default: on)
2220 2147
2221Add support for the original rxvt scrollbar. 2148Add support for the original rxvt scrollbar.
2222 2149
2223=item --enable-next-scroll 2150=item --enable-next-scroll (default: on)
2224 2151
2225Add support for a NeXT-like scrollbar. 2152Add support for a NeXT-like scrollbar.
2226 2153
2227=item --enable-xterm-scroll 2154=item --enable-xterm-scroll (default: on)
2228 2155
2229Add support for an Xterm-like scrollbar. 2156Add support for an Xterm-like scrollbar.
2230 2157
2231=item --enable-plain-scroll 2158=item --enable-plain-scroll (default: on)
2232 2159
2233Add support for a very unobtrusive, plain-looking scrollbar that 2160Add support for a very unobtrusive, plain-looking scrollbar that
2234is the favourite of the rxvt-unicode author, having used it for 2161is the favourite of the rxvt-unicode author, having used it for
2235many years. 2162many years.
2236 2163
2237=item --enable-half-shadow 2164=item --enable-ttygid (default: off)
2238
2239Make shadows on the scrollbar only half the normal width & height.
2240only applicable to rxvt scrollbars.
2241
2242=item --enable-ttygid
2243 2165
2244Change tty device setting to group "tty" - only use this if 2166Change tty device setting to group "tty" - only use this if
2245your system uses this type of security. 2167your system uses this type of security.
2246 2168
2247=item --disable-backspace-key 2169=item --disable-backspace-key
2248 2170
2249Disable any handling of the backspace key by us - let the X server 2171Removes any handling of the backspace key by us - let the X server do it.
2172
2173=item --disable-delete-key
2174
2175Removes any handling of the delete key by us - let the X server
2250do it. 2176do it.
2251 2177
2252=item --disable-delete-key
2253
2254Disable any handling of the delete key by us - let the X server
2255do it.
2256
2257=item --disable-resources 2178=item --disable-resources
2258 2179
2259Remove all resources checking. 2180Removes any support for resource checking.
2260
2261=item --enable-xgetdefault
2262
2263Make resources checking via XGetDefault() instead of our small
2264version which only checks ~/.Xdefaults, or if that doesn't exist
2265then ~/.Xresources.
2266
2267=item --enable-strings
2268
2269Add support for our possibly faster memset() function and other
2270various routines, overriding your system's versions which may
2271have been hand-crafted in assembly or may require extra libraries
2272to link in. (this breaks ANSI-C rules and has problems on many
2273GNU/Linux systems).
2274 2181
2275=item --disable-swapscreen 2182=item --disable-swapscreen
2276 2183
2277Remove support for swap screen. 2184Remove support for secondary/swap screen.
2278 2185
2279=item --enable-frills 2186=item --enable-frills (default: on)
2280 2187
2281Add support for many small features that are not essential but nice to 2188Add support for many small features that are not essential but nice to
2282have. Normally you want this, but for very small binaries you may want to 2189have. Normally you want this, but for very small binaries you may want to
2283disable this. 2190disable this.
2284 2191
2285A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2286in combination with other switches) is: 2193in combination with other switches) is:
2287 2194
2288 MWM-hints 2195 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping)
2289 seperate underline colour 2197 seperate underline colour (-underlineColor)
2290 settable border widths and borderless switch 2198 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth)
2291 settable extra linespacing 2200 settable extra linespacing /-lsp)
2292 extra window properties (e.g. UTF-8 window names and PID)
2293 iso-14755-2 and -3, and visual feedback 2201 iso-14755-2 and -3, and visual feedback
2202 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure)
2204 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc)
2206 XEmbed support (-embed)
2207 user-pty (-pty-fd)
2208 hold on exit (-hold)
2209 skip builtin block graphics (-sbg)
2210
2211It also enabled some non-essential features otherwise disabled, such as:
2212
2213 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection
2216 sgr modes 90..97 and 100..107
2294 backindex and forwardindex escape sequence 2217 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences
2219 locale switching escape sequence
2295 window op and locale change escape sequences 2220 window op and some xterm/OSC escape sequences
2296 tripleclickwords 2221 rectangular selections
2297 settable insecure mode 2222 trailing space removal for selections
2223 verbose X error handling
2298 2224
2299=item --enable-iso14755 2225=item --enable-iso14755 (default: on)
2300 2226
2301Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2302F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2303C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2229C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2304this switch. 2230this switch.
2305 2231
2306=item --enable-keepscrolling 2232=item --enable-keepscrolling (default: on)
2307 2233
2308Add support for continual scrolling of the display when you hold 2234Add support for continual scrolling of the display when you hold
2309the mouse button down on a scrollbar arrow. 2235the mouse button down on a scrollbar arrow.
2310 2236
2311=item --enable-mousewheel 2237=item --enable-mousewheel (default: on)
2312 2238
2313Add support for scrolling via mouse wheel or buttons 4 & 5. 2239Add support for scrolling via mouse wheel or buttons 4 & 5.
2314 2240
2315=item --enable-slipwheeling 2241=item --enable-slipwheeling (default: on)
2316 2242
2317Add support for continual scrolling (using the mouse wheel as an 2243Add support for continual scrolling (using the mouse wheel as an
2318accelerator) while the control key is held down. This option 2244accelerator) while the control key is held down. This option
2319requires --enable-mousewheel to also be specified. 2245requires --enable-mousewheel to also be specified.
2320 2246
2321=item --disable-new-selection 2247=item --disable-new-selection
2322 2248
2323Remove support for mouse selection style like that of xterm. 2249Remove support for mouse selection style like that of xterm.
2324 2250
2325=item --enable-dmalloc 2251=item --enable-dmalloc (default: off)
2326 2252
2327Use Gray Watson's malloc - which is good for debugging See 2253Use Gray Watson's malloc - which is good for debugging See
2328http://www.letters.com/dmalloc/ for details If you use either this or the 2254http://www.letters.com/dmalloc/ for details If you use either this or the
2329next option, you may need to edit src/Makefile after compiling to point 2255next option, you may need to edit src/Makefile after compiling to point
2330DINCLUDE and DLIB to the right places. 2256DINCLUDE and DLIB to the right places.
2331 2257
2332You can only use either this option and the following (should 2258You can only use either this option and the following (should
2333you use either) . 2259you use either) .
2334 2260
2335=item --enable-dlmalloc 2261=item --enable-dlmalloc (default: off)
2336 2262
2337Use Doug Lea's malloc - which is good for a production version 2263Use Doug Lea's malloc - which is good for a production version
2338See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2264See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2339 2265
2340=item --enable-smart-resize 2266=item --enable-smart-resize (default: on)
2341 2267
2342Add smart growth/shrink behaviour when changing font size via from hot 2268Add smart growth/shrink behaviour when changing font size via hot
2343keys. This should keep in a fixed position the rxvt corner which is 2269keys. This should keep the window corner which is closest to a corner of
2344closest to a corner of the screen. 2270the screen in a fixed position.
2345 2271
2346=item --enable-cursor-blink
2347
2348Add support for a blinking cursor.
2349
2350=item --enable-pointer-blank 2272=item --enable-pointer-blank (default: on)
2351 2273
2352Add support to have the pointer disappear when typing or inactive. 2274Add support to have the pointer disappear when typing or inactive.
2353 2275
2354=item --with-name=NAME 2276=item --enable-perl (default: on)
2355 2277
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2280in F<src/perl-ext/> for the extensions that are installed by default. The
2281perl interpreter that is used can be specified via the C<PERL> environment
2282variable when running configure.
2283
2284=item --with-name=NAME (default: urxvt)
2285
2356Set the basename for the installed binaries (default: C<urxvt>, resulting 2286Set the basename for the installed binaries, resulting
2357in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2358C<rxvt>. 2288C<rxvt>.
2359 2289
2360=item --with-term=NAME 2290=item --with-term=NAME (default: rxvt-unicode)
2361 2291
2362Change the environmental variable for the terminal to NAME (default 2292Change the environmental variable for the terminal to NAME.
2363C<rxvt-unicode>)
2364 2293
2365=item --with-terminfo=PATH 2294=item --with-terminfo=PATH
2366 2295
2367Change the environmental variable for the path to the terminfo tree to 2296Change the environmental variable for the path to the terminfo tree to
2368PATH. 2297PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines