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.114 by root, Tue Feb 21 00:59:59 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 can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
95=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color.
101
102=head3 How do I set the correct, full IP address for the DISPLAY variable?
103
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script
106snippets to correctly set the display. If your version of rxvt-unicode
107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
108the COLORTERM variable can be used to distinguish rxvt-unicode from a
109regular xterm.
110
111Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
112snippets:
113
114 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z'
119 read term_id
120 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell
124 fi
125 fi
126
127=head3 How do I compile the manual pages on my own?
128
129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
131the doc subdirectory and enter C<make alldoc>.
132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134
135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
137that the urxvt binary is larger (due to some encoding tables always being
138compiled in), but it actually uses less memory (RSS) after startup. Even
139with C<--disable-everything>, this comparison is a bit unfair, as many
140features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
141already in use in this mode.
142
143 text data bss drs rss filename
144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything
146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasnobaly so.
150
151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154
155The very large size of the text section is explained by the east-asian
156encoding tables, which, if unused, take up disk space but nothing else
157and can be compiled out unless you rely on X11 core fonts that use those
158encodings. The BSS size comes from the 64k emergency buffer that my c++
159compiler allocates (but of course doesn't use unless you are out of
160memory). Also, using an xft font instead of a core font immediately adds a
161few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
162not used.
163
164Of course, due to every character using two or four bytes instead of one,
165a large scrollback buffer will ultimately make rxvt-unicode use more
166memory.
167
168Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.
174
175=head3 Why C++, isn't that unportable/bloated/uncool?
176
177Is this a question? :) It comes up very often. The simple answer is: I had
178to write it, and C++ allowed me to write and maintain it in a fraction
179of the time and effort (which is a scarce resource for me). Put even
180shorter: It simply wouldn't exist without C++.
181
182My personal stance on this is that C++ is less portable than C, but in
183the case of rxvt-unicode this hardly matters, as its portability limits
184are defined by things like X11, pseudo terminals, locale support and unix
185domain sockets, which are all less portable than C++ itself.
186
187Regarding the bloat, see the above question: It's easy to write programs
188in C that use gobs of memory, an certainly possible to write programs in
189C++ that don't. C++ also often comes with large libraries, but this is
190not necessarily the case with GCC. Here is what rxvt links against on my
191system with a minimal config:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
195 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
196 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
197
198And here is rxvt-unicode:
199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205
206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :)
208
209
210=head2 Rendering, Font & Look and Feel Issues
211
212=head3 I can't get transparency working, what am I doing wrong?
213
214First of all, transparency isn't officially supported in rxvt-unicode, so
215you are mostly on your own. Do not bug the author about it (but you may
216bug everybody else). Also, if you can't get it working consider it a rite
217of passage: ... and you failed.
218
219Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221
2221. Use inheritPixmap:
223
224 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40
226
227That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read.
229
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool:
233
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
236
237That works. If you think it doesn't, you lack XPM and Perl support, or you
238are unable to read.
239
2403. Use an ARGB visual:
241
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
243
244This requires XFT support, and the support of your X-server. If that
245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
247bugfixes and workarounds for Xft and Xlib to make it work, but that
248doesn't mean that your WM has the required kludges in place.
249
2504. Use xcompmgr and let it do the job:
251
252 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
253 -set _NET_WM_WINDOW_OPACITY 0xc0000000
254
255Then click on a window you want to make transparent. Replace C<0xc0000000>
256by other values to change the degree of opacity. If it doesn't work and
257your server crashes, you got to keep the pieces.
258
259=head3 Why does rxvt-unicode sometimes leave pixel droppings?
260
261Most fonts were not designed for terminal use, which means that character
262size varies a lot. A font that is otherwise fine for terminal use might
263contain some characters that are simply too wide. Rxvt-unicode will avoid
264these characters. For characters that are just "a bit" too wide a special
265"careful" rendering mode is used that redraws adjacent characters.
266
267All of this requires that fonts do not lie about character sizes,
268however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, and rxvt-unicode has no way of detecting this (the correct way is to
270ask for the character bounding box, which unfortunately is wrong in these
271cases).
272
273It's not clear (to me at least), wether this is a bug in Xft, freetype,
274or the respective font. If you encounter this problem you might try using
275the C<-lsp> option to give the font more height. If that doesn't work, you
276might be forced to use a different font.
277
278All of this is not a problem when using X11 core fonts, as their bounding
279box data is correct.
280
281=head3 How can I keep rxvt-unicode from using reverse video so much?
282
283First of all, make sure you are running with the right terminal settings
284(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
285make sure you have specified colours for italic and bold, as otherwise
286rxvt-unicode might use reverse video to simulate the effect:
287
288 URxvt.colorBD: white
289 URxvt.colorIT: green
290
291=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
292
293For some unexplainable reason, some rare programs assume a very weird
294colour palette when confronted with a terminal with more than the standard
2958 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
296these programs not to assume non-ISO colours without very good reasons.
297
298In the meantime, you can either edit your C<rxvt-unicode> terminfo
299definition to only claim 8 colour support or use C<TERM=rxvt>, which will
300fix colours but keep you from using other rxvt-unicode features.
301
302=head3 Can I switch the fonts at runtime?
303
304Yes, using an escape sequence. Try something like this, which has the same
305effect as using the C<-fn> switch, and takes effect immediately:
306
307 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
308
309This is useful if you e.g. work primarily with japanese (and prefer a
310japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way.
312
313You can think of this as a kind of manual ISO-2022 switching.
314
315=head3 Why do italic characters look as if clipped?
316
317Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to
320enable freetype autohinting, i.e. like this:
321
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324
377=item Can I speed up Xft rendering somehow? 325=head3 Can I speed up Xft rendering somehow?
378 326
379Yes, the most obvious way to speed it up is to avoid Xft entirely, as 327Yes, the most obvious way to speed it up is to avoid Xft entirely, as
380it is simply slow. If you still want Xft fonts you might try to disable 328it is simply slow. If you still want Xft fonts you might try to disable
381antialiasing (by appending C<:antialiasing=false>), which saves lots of 329antialiasing (by appending C<:antialias=false>), which saves lots of
382memory and also speeds up rendering considerably. 330memory and also speeds up rendering considerably.
383 331
384=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385 333
386Rxvt-unicode will use whatever you specify as a font. If it needs to 334Rxvt-unicode will use whatever you specify as a font. If it needs to
387fall back to it's default font search list it will prefer X11 core 335fall 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 336fonts, because they are small and fast, and then use Xft fonts. It has
389antialiasing disabled for most of them, because the author thinks they 337antialiasing disabled for most of them, because the author thinks they
390look best that way. 338look best that way.
391 339
392If you want antialiasing, you have to specify the fonts manually. 340If you want antialiasing, you have to specify the fonts manually.
393 341
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? 342=head3 What's with this bold/blink stuff?
403 343
404If no bold colour is set via C<colorBD:>, bold will invert text using the 344If no bold colour is set via C<colorBD:>, bold will invert text using the
405standard foreground colour. 345standard foreground colour.
406 346
407For the standard background colour, blinking will actually make the 347For the standard background colour, blinking will actually make the
414 354
415color0-7 are the low-intensity colors. 355color0-7 are the low-intensity colors.
416 356
417color8-15 are the corresponding high-intensity colors. 357color8-15 are the corresponding high-intensity colors.
418 358
419=item I don't like the screen colors. How do I change them? 359=head3 I don't like the screen colors. How do I change them?
420 360
421You can change the screen colors at run-time using F<~/.Xdefaults> 361You can change the screen colors at run-time using F<~/.Xdefaults>
422resources (or as long-options). 362resources (or as long-options).
423 363
424Here are values that are supposed to resemble a VGA screen, 364Here are values that are supposed to resemble a VGA screen,
425including the murky brown that passes for low-intensity yellow: 365including the murky brown that passes for low-intensity yellow:
426 366
427 URxvt*color0: #000000 367 URxvt.color0: #000000
428 URxvt*color1: #A80000 368 URxvt.color1: #A80000
429 URxvt*color2: #00A800 369 URxvt.color2: #00A800
430 URxvt*color3: #A8A800 370 URxvt.color3: #A8A800
431 URxvt*color4: #0000A8 371 URxvt.color4: #0000A8
432 URxvt*color5: #A800A8 372 URxvt.color5: #A800A8
433 URxvt*color6: #00A8A8 373 URxvt.color6: #00A8A8
434 URxvt*color7: #A8A8A8 374 URxvt.color7: #A8A8A8
435 375
436 URxvt*color8: #000054 376 URxvt.color8: #000054
437 URxvt*color9: #FF0054 377 URxvt.color9: #FF0054
438 URxvt*color10: #00FF54 378 URxvt.color10: #00FF54
439 URxvt*color11: #FFFF54 379 URxvt.color11: #FFFF54
440 URxvt*color12: #0000FF 380 URxvt.color12: #0000FF
441 URxvt*color13: #FF00FF 381 URxvt.color13: #FF00FF
442 URxvt*color14: #00FFFF 382 URxvt.color14: #00FFFF
443 URxvt*color15: #FFFFFF 383 URxvt.color15: #FFFFFF
444 384
445And here is a more complete set of non-standard colors described as 385And here is a more complete set of non-standard colors.
446"pretty girly":
447 386
448 URxvt.cursorColor: #dc74d1 387 URxvt.cursorColor: #dc74d1
449 URxvt.pointerColor: #dc74d1 388 URxvt.pointerColor: #dc74d1
450 URxvt.background: #0e0e0e 389 URxvt.background: #0e0e0e
451 URxvt.foreground: #4ad5e1 390 URxvt.foreground: #4ad5e1
462 URxvt.color6: #73f7ff 401 URxvt.color6: #73f7ff
463 URxvt.color14: #73f7ff 402 URxvt.color14: #73f7ff
464 URxvt.color7: #e1dddd 403 URxvt.color7: #e1dddd
465 URxvt.color15: #e1dddd 404 URxvt.color15: #e1dddd
466 405
406They have been described (not by me) as "pretty girly".
407
408=head3 Why do some characters look so much different than others?
409
410See next entry.
411
412=head3 How does rxvt-unicode choose fonts?
413
414Most fonts do not contain the full range of Unicode, which is
415fine. Chances are that the font you (or the admin/package maintainer of
416your system/os) have specified does not cover all the characters you want
417to display.
418
419B<rxvt-unicode> makes a best-effort try at finding a replacement
420font. Often the result is fine, but sometimes the chosen font looks
421bad/ugly/wrong. Some fonts have totally strange characters that don't
422resemble the correct glyph at all, and rxvt-unicode lacks the artificial
423intelligence to detect that a specific glyph is wrong: it has to believe
424the font that the characters it claims to contain indeed look correct.
425
426In that case, select a font of your taste and add it to the font list,
427e.g.:
428
429 @@URXVT_NAME@@ -fn basefont,font2,font3...
430
431When rxvt-unicode sees a character, it will first look at the base
432font. If the base font does not contain the character, it will go to the
433next font, and so on. Specifying your own fonts will also speed up this
434search and use less resources within rxvt-unicode and the X-server.
435
436The only limitation is that none of the fonts may be larger than the base
437font, as the base font defines the terminal character cell size, which
438must be the same due to the way terminals work.
439
440=head3 Why do some chinese characters look so different than others?
441
442This is because there is a difference between script and language --
443rxvt-unicode does not know which language the text that is output is,
444as it only knows the unicode character codes. If rxvt-unicode first
445sees a japanese/chinese character, it might choose a japanese font for
446display. Subsequent japanese characters will use that font. Now, many
447chinese characters aren't represented in japanese fonts, so when the first
448non-japanese character comes up, rxvt-unicode will look for a chinese font
449-- unfortunately at this point, it will still use the japanese font for
450chinese characters that are also in the japanese font.
451
452The workaround is easy: just tag a chinese font at the end of your font
453list (see the previous question). The key is to view the font list as
454a preference list: If you expect more japanese, list a japanese font
455first. If you expect more chinese, put a chinese font first.
456
457In the future it might be possible to switch language preferences at
458runtime (the internal data structure has no problem with using different
459fonts for the same character at the same time, but no interface for this
460has been designed yet).
461
462Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document).
464
465=head2 Keyboard, Mouse & User Interaction
466
467=head3 The new selection selects pieces that are too big, how can I select single words?
468
469If you want to select e.g. alphanumeric words, you can use the following
470setting:
471
472 URxvt.selection.pattern-0: ([[:word:]]+)
473
474If you click more than twice, the selection will be extended
475more and more.
476
477To get a selection that is very similar to the old code, try this pattern:
478
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480
481Please also note that the I<LeftClick Shift-LeftClik> combination also
482selects words like the old code.
483
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485
486You can disable the perl extension completely by setting the
487B<perl-ext-common> resource to the empty string, which also keeps
488rxvt-unicode from initialising perl, saving memory.
489
490If you only want to disable specific features, you first have to
491identify which perl extension is responsible. For this, read the section
492B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
493example, to disable the B<selection-popup> and B<option-popup>, specify
494this B<perl-ext-common> resource:
495
496 URxvt.perl-ext-common: default,-selection-popup,-option-popup
497
498This will keep the default extensions, but disable the two popup
499extensions. Some extensions can also be configured, for example,
500scrollback search mode is triggered by B<M-s>. You can move it to any
501other combination either by setting the B<searchable-scrollback> resource:
502
503 URxvt.searchable-scrollback: CM-s
504
505=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
506
507See next entry.
508
509=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
510
511These are caused by the C<readline> perl extension. Under normal
512circumstances, it will move your cursor around when you click into the
513line that contains it. It tries hard not to do this at the wrong moment,
514but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly.
516
517You can permamently switch this feature off by disabling the C<readline>
518extension:
519
520 URxvt.perl-ext-common: default,-readline
521
522=head3 My numerical keypad acts weird and generates differing output?
523
524Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of wether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that
529helped.
530
531=head3 My Compose (Multi_key) key is no longer working.
532
533The most common causes for this are that either your locale is not set
534correctly, or you specified a B<preeditStyle> that is not supported by
535your input method. For example, if you specified B<OverTheSpot> and
536your input method (e.g. the default input method handling Compose keys)
537does not support this (for instance because it is not visual), then
538rxvt-unicode will continue without an input method.
539
540In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>.
542
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
548codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
549character and so on.
550
551=head3 Mouse cut/paste suddenly no longer works.
552
553Make sure that mouse reporting is actually turned off since killing
554some editors prematurely may leave the mouse in mouse report mode. I've
555heard that tcsh may use mouse reporting unless it otherwise specified. A
556quick check is to see if cut/paste works when the Alt or Shift keys are
557depressed.
558
467=item What's with the strange Backspace/Delete key behaviour? 559=head3 What's with the strange Backspace/Delete key behaviour?
468 560
469Assuming that the physical Backspace key corresponds to the 561Assuming that the physical Backspace key corresponds to the
470BackSpace keysym (not likely for Linux ... see the following 562BackSpace keysym (not likely for Linux ... see the following
471question) there are two standard values that can be used for 563question) there are two standard values that can be used for
472Backspace: C<^H> and C<^?>. 564Backspace: C<^H> and C<^?>.
483 575
484For starting a new rxvt-unicode: 576For starting a new rxvt-unicode:
485 577
486 # use Backspace = ^H 578 # use Backspace = ^H
487 $ stty erase ^H 579 $ stty erase ^H
488 $ @@RXVT_NAME@@ 580 $ @@URXVT_NAME@@
489 581
490 # use Backspace = ^? 582 # use Backspace = ^?
491 $ stty erase ^? 583 $ stty erase ^?
492 $ @@RXVT_NAME@@ 584 $ @@URXVT_NAME@@
493 585
494Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 586Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495 587
496For an existing rxvt-unicode: 588For an existing rxvt-unicode:
497 589
498 # use Backspace = ^H 590 # use Backspace = ^H
499 $ stty erase ^H 591 $ stty erase ^H
508properly reflects that. 600properly reflects that.
509 601
510The Delete key is a another casualty of the ill-defined Backspace problem. 602The Delete key is a another casualty of the ill-defined Backspace problem.
511To avoid confusion between the Backspace and Delete keys, the Delete 603To avoid confusion between the Backspace and Delete keys, the Delete
512key has been assigned an escape sequence to match the vt100 for Execute 604key has been assigned an escape sequence to match the vt100 for Execute
513(ESC[3~) and is in the supplied termcap/terminfo. 605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514 606
515Some other Backspace problems: 607Some other Backspace problems:
516 608
517some editors use termcap/terminfo, 609some editors use termcap/terminfo,
518some editors (vim I'm told) expect Backspace = ^H, 610some editors (vim I'm told) expect Backspace = ^H,
519GNU Emacs (and Emacs-like editors) use ^H for help. 611GNU Emacs (and Emacs-like editors) use ^H for help.
520 612
521Perhaps someday this will all be resolved in a consistent manner. 613Perhaps someday this will all be resolved in a consistent manner.
522 614
523=item I don't like the key-bindings. How do I change them? 615=head3 I don't like the key-bindings. How do I change them?
524 616
525There are some compile-time selections available via configure. Unless 617There are some compile-time selections available via configure. Unless
526you have run "configure" with the C<--disable-resources> option you can 618you have run "configure" with the C<--disable-resources> option you can
527use the `keysym' resource to alter the keystrings associated with keysyms. 619use the `keysym' resource to alter the keystrings associated with keysyms.
528 620
529Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt' 621Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
530 622
531 URxvt.keysym.Home: \033[1~ 623 URxvt.keysym.Home: \033[1~
532 URxvt.keysym.End: \033[4~ 624 URxvt.keysym.End: \033[4~
533 URxvt.keysym.C-apostrophe: \033<C-'> 625 URxvt.keysym.C-apostrophe: \033<C-'>
534 URxvt.keysym.C-slash: \033<C-/> 626 URxvt.keysym.C-slash: \033<C-/>
549 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 641 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 642 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
551 643
552See some more examples in the documentation for the B<keysym> resource. 644See some more examples in the documentation for the B<keysym> resource.
553 645
554=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 646=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
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 647
558 KP_Insert == Insert 648 KP_Insert == Insert
559 F22 == Print 649 F22 == Print
560 F27 == Home 650 F27 == Home
561 F29 == Prior 651 F29 == Prior
564 654
565Rather than have rxvt-unicode try to accommodate all the various possible 655Rather than have rxvt-unicode try to accommodate all the various possible
566keyboard mappings, it is better to use `xmodmap' to remap the keys as 656keyboard mappings, it is better to use `xmodmap' to remap the keys as
567required for your particular machine. 657required for your particular machine.
568 658
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 659
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 660
577=item How do I set the correct, full IP address for the DISPLAY variable? 661=head2 Terminal Configuration
578 662
579If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 663=head3 Can I see a typical configuration?
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 664
586Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 665The default configuration tries to be xterm-like, which I don't like that
587snippets: 666much, but it's least surprise to regular users.
588 667
589 # Bourne/Korn/POSIX family of shells: 668As a rxvt or rxvt-unicode user, you are practically supposed to invest
590 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 669time into customising your terminal. To get you started, here is the
591 if [ ${TERM:-foo} = xterm ]; then 670author's .Xdefaults entries, with comments on what they do:
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 671
602=item How do I compile the manual pages for myself? 672 URxvt.cutchars: "()*,<>[]{}|'
673 URxvt.print-pipe: cat >/tmp/xxx
603 674
604You need to have a recent version of perl installed as F</usr/bin/perl>, 675These are just for testing stuff.
605one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
606the doc subdirectory and enter C<make alldoc>.
607 676
608=item My question isn't answered here, can I ask a human? 677 URxvt.imLocale: ja_JP.UTF-8
678 URxvt.preeditType: OnTheSpot,None
609 679
610Before sending me mail, you could go to IRC: C<irc.freenode.net>, 680This tells rxvt-unicode to use a special locale when communicating with
611channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 681the X Input Method, and also tells it to only use the OnTheSpot pre-edit
612interested in learning about new and exciting problems (but not FAQs :). 682type, which requires the C<xim-onthespot> perl extension but rewards me
683with correct-looking fonts.
684
685 URxvt.perl-lib: /root/lib/urxvt
686 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
687 URxvt.selection.pattern-0: ( at .*? line \\d+)
688 URxvt.selection.pattern-1: ^(/[^:]+):\
689 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
690 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
691
692This is my perl configuration. The first two set the perl library
693directory and also tells urxvt to use a large number of extensions. I
694develop for myself mostly, so I actually use most of the extensions I
695write.
696
697The selection stuff mainly makes the selection perl-error-message aware
698and tells it to convert pelr error mssages into vi-commands to load the
699relevant file and go tot he error line number.
700
701 URxvt.scrollstyle: plain
702 URxvt.secondaryScroll: true
703
704As the documentation says: plain is the preferred scrollbar for the
705author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
706apps, like screen, so lines scorlled out of screen end up in urxvt's
707scrollback buffer.
708
709 URxvt.background: #000000
710 URxvt.foreground: gray90
711 URxvt.color7: gray90
712 URxvt.colorBD: #ffffff
713 URxvt.cursorColor: #e0e080
714 URxvt.throughColor: #8080f0
715 URxvt.highlightColor: #f0f0f0
716
717Some colours. Not sure which ones are being used or even non-defaults, but
718these are in my .Xdefaults. Most notably, they set foreground/background
719to light gray/black, and also make sure that the colour 7 matches the
720default foreground colour.
721
722 URxvt.underlineColor: yellow
723
724Another colour, makes underline lines look different. Sometimes hurts, but
725is mostly a nice effect.
726
727 URxvt.geometry: 154x36
728 URxvt.loginShell: false
729 URxvt.meta: ignore
730 URxvt.utmpInhibit: true
731
732Uh, well, should be mostly self-explanatory. By specifying some defaults
733manually, I can quickly switch them for testing.
734
735 URxvt.saveLines: 8192
736
737A large scrollback buffer is essential. Really.
738
739 URxvt.mapAlert: true
740
741The only case I use it is for my IRC window, which I like to keep
742iconified till people msg me (which beeps).
743
744 URxvt.visualBell: true
745
746The audible bell is often annoying, especially when in a crowd.
747
748 URxvt.insecure: true
749
750Please don't hack my mutt! Ooops...
751
752 URxvt.pastableTabs: false
753
754I once thought this is a great idea.
755
756 urxvt.font: 9x15bold,\
757 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
758 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
759 [codeset=JISX0208]xft:Kochi Gothic, \
760 xft:Bitstream Vera Sans Mono:autohint=true, \
761 xft:Code2000:antialias=false
762 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
763 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
764 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
765
766I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
767overwhelmed. A special note: the C<9x15bold> mentioend above is actually
768the version from XFree-3.3, as XFree-4 replaced it by a totally different
769font (different glyphs for C<;> and many other harmless characters),
770while the second font is actually the C<9x15bold> from XFree4/XOrg. The
771bold version has less chars than the medium version, so I use it for rare
772characters, too. Whene ditign sources with vim, I use italic for comments
773and other stuff, which looks quite good with Bitstream Vera anti-aliased.
774
775Terminus is a quite bad font (many very wrong glyphs), but for most of my
776purposes, it works, and gives a different look, as my normal (Non-bold)
777font is already bold, and I want to see a difference between bold and
778normal fonts.
779
780Please note that I used the C<urxvt> instance name and not the C<URxvt>
781class name. Thats because I use different configs for different purposes,
782for example, my IRC window is started with C<-name IRC>, and uses these
783defaults:
784
785 IRC*title: IRC
786 IRC*geometry: 87x12+535+542
787 IRC*saveLines: 0
788 IRC*mapAlert: true
789 IRC*font: suxuseuro
790 IRC*boldFont: suxuseuro
791 IRC*colorBD: white
792 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
793 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
794
795C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
796sizes. C<suxuseuro> allows me to keep an eye (and actually read)
797stuff while keeping a very small window. If somebody pastes something
798complicated (e.g. japanese), I temporarily switch to a larger font.
799
800The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
801C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
802file for different hosts, for example, on ym main desktop, I use:
803
804 URxvt.keysym.C-M-q: command:\033[3;5;5t
805 URxvt.keysym.C-M-y: command:\033[3;5;606t
806 URxvt.keysym.C-M-e: command:\033[3;1605;5t
807 URxvt.keysym.C-M-c: command:\033[3;1605;606t
808 URxvt.keysym.C-M-p: perl:test
809
810The first for keysym definitions allow me to quickly bring some windows
811in the layout I like most. Ion users might start laughing but will stop
812immediately when I tell them that I use my own Fvwm2 module for much the
813same effect as Ion provides, and I only very rarely use the above key
814combinations :->
815
816=head3 Why doesn't rxvt-unicode read my resources?
817
818Well, why, indeed? It does, in a way very similar to other X
819applications. Most importantly, this means that if you or your OS loads
820resources into the X display (the right way to do it), rxvt-unicode will
821ignore any resource files in your home directory. It will only read
822F<$HOME/.Xdefaults> when no resources are attached to the display.
823
824If you have or use an F<$HOME/.Xresources> file, chances are that
825resources are loaded into your X-server. In this case, you have to
826re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
827
828Also consider the form resources have to use:
829
830 URxvt.resource: value
831
832If you want to use another form (there are lots of different ways of
833specifying resources), make sure you understand wether and why it
834works. If unsure, use the form above.
835
836=head3 When I log-in to another system it tells me about missing terminfo data?
837
838The terminal description used by rxvt-unicode is not as widely available
839as that for xterm, or even rxvt (for which the same problem often arises).
840
841The correct solution for this problem is to install the terminfo, this can
842be done like this (with ncurses' infocmp):
843
844 REMOTE=remotesystem.domain
845 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
846
847... or by installing rxvt-unicode normally on the remote system,
848
849If you cannot or do not want to do this, then you can simply set
850C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
851problems arising, which includes wrong keymapping, less and different
852colours and some refresh errors in fullscreen applications. It's a nice
853quick-and-dirty workaround for rare cases, though.
854
855If you always want to do this (and are fine with the consequences) you
856can either recompile rxvt-unicode with the desired TERM value or use a
857resource to set it:
858
859 URxvt.termName: rxvt
860
861If you don't plan to use B<rxvt> (quite common...) you could also replace
862the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
863
864=head3 C<tic> outputs some error when compiling the terminfo entry.
865
866Most likely it's the empty definition for C<enacs=>. Just replace it by
867C<enacs=\E[0@> and try again.
868
869=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
870
871See next entry.
872
873=head3 I need a termcap file entry.
874
875One reason you might want this is that some distributions or operating
876systems still compile some programs using the long-obsoleted termcap
877library (Fedora Core's bash is one example) and rely on a termcap entry
878for C<rxvt-unicode>.
879
880You could use rxvt's termcap entry with resonable results in many cases.
881You can also create a termcap entry by using terminfo's infocmp program
882like this:
883
884 infocmp -C rxvt-unicode
885
886Or you could use this termcap entry, generated by the command above:
887
888 rxvt-unicode|rxvt-unicode terminal (X Window System):\
889 :am:bw:eo:km:mi:ms:xn:xo:\
890 :co#80:it#8:li#24:lm#0:\
891 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
892 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
893 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
894 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
895 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
896 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
897 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
898 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
899 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
900 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
901 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
902 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
903 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
904 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
905 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
906 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
907 :vs=\E[?25h:
908
909=head3 Why does C<ls> no longer have coloured output?
910
911The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
912decide wether a terminal has colour, but uses it's own configuration
913file. Needless to say, C<rxvt-unicode> is not in it's default file (among
914with most other terminals supporting colour). Either add:
915
916 TERM rxvt-unicode
917
918to C</etc/DIR_COLORS> or simply add:
919
920 alias ls='ls --color=auto'
921
922to your C<.profile> or C<.bashrc>.
923
924=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
925
926See next entry.
927
928=head3 Why doesn't vim/emacs etc. make use of italic?
929
930See next entry.
931
932=head3 Why are the secondary screen-related options not working properly?
933
934Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
935distributions (most notably Debian GNU/Linux) break rxvt-unicode
936by setting C<TERM> to C<rxvt>, which doesn't have these extra
937features. Unfortunately, some of these (most notably, again, Debian
938GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
939file, so you will need to install it on your own (See the question B<When
940I log-in to another system it tells me about missing terminfo data?> on
941how to do this).
942
943
944=head2 Encoding / Locale / Input Method Issues
945
946=head3 Rxvt-unicode does not seem to understand the selected encoding?
947
948See next entry.
949
950=head3 Unicode does not seem to work?
951
952If you encounter strange problems like typing an accented character but
953getting two unrelated other characters or similar, or if program output is
954subtly garbled, then you should check your locale settings.
955
956Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
957programs. Often rxvt-unicode is started in the C<C> locale, while the
958login script running within the rxvt-unicode window changes the locale to
959something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
960
961The best thing is to fix your startup environment, as you will likely run
962into other problems. If nothing works you can try this in your .profile.
963
964 printf '\e]701;%s\007' "$LC_CTYPE"
965
966If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
967supported on your systems. Some systems have a C<locale> command which
968displays this (also, C<perl -e0> can be used to check locale settings, as
969it will complain loudly if it cannot set the locale). If it displays something
970like:
971
972 locale: Cannot set LC_CTYPE to default locale: ...
973
974Then the locale you specified is not supported on your system.
975
976If nothing works and you are sure that everything is set correctly then
977you will need to remember a little known fact: Some programs just don't
978support locales :(
979
980=head3 How does rxvt-unicode determine the encoding to use?
981
982See next entry.
983
984=head3 Is there an option to switch encodings?
985
986Unlike some other terminals, rxvt-unicode has no encoding switch, and no
987specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
988UTF-8 or any other encodings with respect to terminal I/O.
989
990The reasons is that there exists a perfectly fine mechanism for selecting
991the encoding, doing I/O and (most important) communicating this to all
992applications so everybody agrees on character properties such as width
993and code number. This mechanism is the I<locale>. Applications not using
994that info will have problems (for example, C<xterm> gets the width of
995characters wrong as it uses it's own, locale-independent table under all
996locales).
997
998Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
999programs doing the same (that is, most) will automatically agree in the
1000interpretation of characters.
1001
1002Unfortunately, there is no system-independent way to select locales, nor
1003is there a standard on how locale specifiers will look like.
1004
1005On most systems, the content of the C<LC_CTYPE> environment variable
1006contains an arbitrary string which corresponds to an already-installed
1007locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1008C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1009(i.e. C<de> or C<german>) are also common.
1010
1011Rxvt-unicode ignores all other locale categories, and except for
1012the encoding, ignores country or language-specific settings,
1013i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1014rxvt-unicode.
1015
1016If you want to use a specific encoding you have to make sure you start
1017rxvt-unicode with the correct C<LC_CTYPE> category.
1018
1019=head3 Can I switch locales at runtime?
1020
1021Yes, using an escape sequence. Try something like this, which sets
1022rxvt-unicode's idea of C<LC_CTYPE>.
1023
1024 printf '\e]701;%s\007' ja_JP.SJIS
1025
1026See also the previous answer.
1027
1028Sometimes this capability is rather handy when you want to work in
1029one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1030(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1031first switches to a locale supported by xjdic and back later:
1032
1033 printf '\e]701;%s\007' ja_JP.SJIS
1034 xjdic -js
1035 printf '\e]701;%s\007' de_DE.UTF-8
1036
1037You can also use xterm's C<luit> program, which usually works fine, except
1038for some locales where character width differs between program- and
1039rxvt-unicode-locales.
1040
1041=head3 I have problems getting my input method working.
1042
1043Try a search engine, as this is slightly different for every input method server.
1044
1045Here is a checklist:
1046
1047=over 4
1048
1049=item - Make sure your locale I<and> the imLocale are supported on your OS.
1050
1051Try C<locale -a> or check the documentation for your OS.
1052
1053=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1054
1055For example, B<kinput2> does not support UTF-8 locales, you should use
1056C<ja_JP.EUC-JP> or equivalent.
1057
1058=item - Make sure your XIM server is actually running.
1059
1060=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1061
1062When you want to use e.g. B<kinput2>, it must be set to
1063C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
1064method servers are running with this command:
1065
1066 xprop -root XIM_SERVERS
1067
1068=item
613 1069
614=back 1070=back
615 1071
616=head1 SYNOPSIS 1072=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
617 1073
618 # set a new font set 1074You can specify separate locales for the input method and the rest of the
619 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" 1075terminal, using the resource C<imlocale>:
620 1076
621 # change the locale and tell rxvt-unicode about it 1077 URxvt.imlocale: ja_JP.EUC-JP
622 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
623 1078
624 # set window title 1079Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
625 printf '\33]2;%s\007' "new window title" 1080use your input method. Please note, however, that, depending on your Xlib
1081version, you may not be able to input characters outside C<EUC-JP> in a
1082normal way then, as your input method limits you.
626 1083
627=head1 DESCRIPTION 1084=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1085
1086Unfortunately, this is unavoidable, as the XIM protocol is racy by
1087design. Applications can avoid some crashes at the expense of memory
1088leaks, and Input Methods can avoid some crashes by careful ordering at
1089exit time. B<kinput2> (and derived input methods) generally succeeds,
1090while B<SCIM> (or similar input methods) fails. In the end, however,
1091crashes cannot be completely avoided even if both sides cooperate.
1092
1093So the only workaround is not to kill your Input Method Servers.
1094
1095
1096=head2 Operating Systems / Package Maintaining
1097
1098=head3 I am using Debian GNU/Linux and have a problem...
1099
1100The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1101patches that considerably change the behaviour of rxvt-unicode (but
1102unfortunately this notice has been removed). Before reporting a bug to
1103the original rxvt-unicode author please download and install the genuine
1104version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1105the problem. If you cannot, chances are that the problems are specific to
1106Debian GNU/Linux, in which case it should be reported via the Debian Bug
1107Tracking System (use C<reportbug> to report the bug).
1108
1109For other problems that also affect the Debian package, you can and
1110probably should use the Debian BTS, too, because, after all, it's also a
1111bug in the Debian version and it serves as a reminder for other users that
1112might encounter the same issue.
1113
1114=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1115
1116You should build one binary with the default options. F<configure>
1117now enables most useful options, and the trend goes to making them
1118runtime-switchable, too, so there is usually no drawback to enbaling them,
1119except higher disk and possibly memory usage. The perl interpreter should
1120be enabled, as important functionality (menus, selection, likely more in
1121the future) depends on it.
1122
1123You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1124system-wide (except maybe with C<defaults>). This will result in useful
1125behaviour. If your distribution aims at low memory, add an empty
1126C<perl-ext-common> resource to the app-defaults file. This will keep the
1127perl interpreter disabled until the user enables it.
1128
1129If you can/want build more binaries, I recommend building a minimal
1130one with C<--disable-everything> (very useful) and a maximal one with
1131C<--enable-everything> (less useful, it will be very big due to a lot of
1132encodings built-in that increase download times and are rarely used).
1133
1134=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1135
1136It should be, starting with release 7.1. You are encouraged to properly
1137install urxvt with privileges necessary for your OS now.
1138
1139When rxvt-unicode detects that it runs setuid or setgid, it will fork
1140into a helper process for privileged operations (pty handling on some
1141systems, utmp/wtmp/lastlog handling on others) and drop privileges
1142immediately. This is much safer than most other terminals that keep
1143privileges while running (but is more relevant to urxvt, as it contains
1144things as perl interpreters, which might be "helpful" to attackers).
1145
1146This forking is done as the very first within main(), which is very early
1147and reduces possible bugs to initialisation code run before main(), or
1148things like the dynamic loader of your system, which should result in very
1149little risk.
1150
1151=head3 On Solaris 9, many line-drawing characters are too wide.
1152
1153Seems to be a known bug, read
1154L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1155following ugly workaround to get non-double-wide-characters working:
1156
1157 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1158
1159=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1160
1161Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1162in your compile environment, or an implementation that implements it,
1163wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1164B<wchar_t> is represented as unicode.
1165
1166As you might have guessed, FreeBSD does neither define this symobl nor
1167does it support it. Instead, it uses it's own internal representation of
1168B<wchar_t>. This is, of course, completely fine with respect to standards.
1169
1170However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1171C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1172
1173C<__STDC_ISO_10646__> is the only sane way to support multi-language
1174apps in an OS, as using a locale-dependent (and non-standardized)
1175representation of B<wchar_t> makes it impossible to convert between
1176B<wchar_t> (as used by X11 and your applications) and any other encoding
1177without implementing OS-specific-wrappers for each and every locale. There
1178simply are no APIs to convert B<wchar_t> into anything except the current
1179locale encoding.
1180
1181Some applications (such as the formidable B<mlterm>) work around this
1182by carrying their own replacement functions for character set handling
1183with them, and either implementing OS-dependent hacks or doing multiple
1184conversions (which is slow and unreliable in case the OS implements
1185encodings slightly different than the terminal emulator).
1186
1187The rxvt-unicode author insists that the right way to fix this is in the
1188system libraries once and for all, instead of forcing every app to carry
1189complete replacements for them :)
1190
1191=head3 I use Solaris 9 and it doesn't compile/work/etc.
1192
1193Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1194problems with C<wcwidth> and a compile problem.
1195
1196=head3 How can I use rxvt-unicode under cygwin?
1197
1198rxvt-unicode should compile and run out of the box on cygwin, using
1199the X11 libraries that come with cygwin. libW11 emulation is no
1200longer supported (and makes no sense, either, as it only supported a
1201single font). I recommend starting the X-server in C<-multiwindow> or
1202C<-rootless> mode instead, which will result in similar look&feel as the
1203old libW11 emulation.
1204
1205At the time of this writing, cygwin didn't seem to support any multi-byte
1206encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1207to 8-bit encodings.
1208
1209=head1 RXVT-UNICODE TECHNICAL REFERENCE
628 1210
629The rest of this document describes various technical aspects of 1211The rest of this document describes various technical aspects of
630B<rxvt-unicode>. First the description of supported command sequences, 1212B<rxvt-unicode>. First the description of supported command sequences,
631followed by menu and pixmap support and last by a description of all 1213followed by pixmap support and last by a description of all features
632features selectable at C<configure> time. 1214selectable at C<configure> time.
633 1215
634=head1 RXVT TECHNICAL REFERENCE
635
636=head1 Definitions 1216=head2 Definitions
637 1217
638=over 4 1218=over 4
639 1219
640=item B<< C<c> >> 1220=item B<< C<c> >>
641 1221
659 1239
660A text parameter composed of printable characters. 1240A text parameter composed of printable characters.
661 1241
662=back 1242=back
663 1243
664=head1 Values 1244=head2 Values
665 1245
666=over 4 1246=over 4
667 1247
668=item B<< C<ENQ> >> 1248=item B<< C<ENQ> >>
669 1249
712 1292
713Space Character 1293Space Character
714 1294
715=back 1295=back
716 1296
717=head1 Escape Sequences 1297=head2 Escape Sequences
718 1298
719=over 4 1299=over 4
720 1300
721=item B<< C<ESC # 8> >> 1301=item B<< C<ESC # 8> >>
722 1302
768Single Shift Select of G3 Character Set (SS3): affects next character 1348Single Shift Select of G3 Character Set (SS3): affects next character
769only I<unimplemented> 1349only I<unimplemented>
770 1350
771=item B<< C<ESC Z> >> 1351=item B<< C<ESC Z> >>
772 1352
773Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1353Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
774 1354
775=item B<< C<ESC c> >> 1355=item B<< C<ESC c> >>
776 1356
777Full reset (RIS) 1357Full reset (RIS)
778 1358
782 1362
783=item B<< C<ESC o> >> 1363=item B<< C<ESC o> >>
784 1364
785Invoke the G3 Character Set (LS3) 1365Invoke the G3 Character Set (LS3)
786 1366
787=item B<< C<ESC> ( C> >> 1367=item B<< C<ESC ( C> >>
788 1368
789Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1369Designate G0 Character Set (ISO 2022), see below for values of C<C>.
790 1370
791=item B<< C<ESC> ) C> >> 1371=item B<< C<ESC ) C> >>
792 1372
793Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1373Designate G1 Character Set (ISO 2022), see below for values of C<C>.
794 1374
795=item B<< C<ESC * C> >> 1375=item B<< C<ESC * C> >>
796 1376
820 1400
821=back 1401=back
822 1402
823X<CSI> 1403X<CSI>
824 1404
825=head1 CSI (Command Sequence Introducer) Sequences 1405=head2 CSI (Command Sequence Introducer) Sequences
826 1406
827=over 4 1407=over 4
828 1408
829=item B<< C<ESC [ Ps @> >> 1409=item B<< C<ESC [ Ps @> >>
830 1410
937 1517
938=item B<< C<ESC [ Ps c> >> 1518=item B<< C<ESC [ Ps c> >>
939 1519
940Send Device Attributes (DA) 1520Send Device Attributes (DA)
941B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1521B<< C<Ps = 0> >> (or omitted): request attributes from terminal
942returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1522returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
943Option'') 1523Option'')
944 1524
945=item B<< C<ESC [ Ps d> >> 1525=item B<< C<ESC [ Ps d> >>
946 1526
947Cursor to Line B<< C<Ps> >> (VPA) 1527Cursor to Line B<< C<Ps> >> (VPA)
1077 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels 1657 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1078 B<< C<Ps = 5> >> Raise window 1658 B<< C<Ps = 5> >> Raise window
1079 B<< C<Ps = 6> >> Lower window 1659 B<< C<Ps = 6> >> Lower window
1080 B<< C<Ps = 7> >> Refresh screen once 1660 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 1661 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> 1662 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>) 1663 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>) 1664 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>) 1665 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> 1666 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> >>) 1667 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1100 1680
1101=back 1681=back
1102 1682
1103X<PrivateModes> 1683X<PrivateModes>
1104 1684
1105=head1 DEC Private Modes 1685=head2 DEC Private Modes
1106 1686
1107=over 4 1687=over 4
1108 1688
1109=item B<< C<ESC [ ? Pm h> >> 1689=item B<< C<ESC [ ? Pm h> >>
1110 1690
1207 B<< C<h> >> Send Mouse X & Y on button press. 1787 B<< C<h> >> Send Mouse X & Y on button press.
1208 B<< C<l> >> No mouse reporting. 1788 B<< C<l> >> No mouse reporting.
1209 1789
1210=end table 1790=end table
1211 1791
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> >> 1792=item B<< C<Ps = 25> >>
1222 1793
1223=begin table 1794=begin table
1224 1795
1225 B<< C<h> >> Visible cursor {cnorm/cvvis} 1796 B<< C<h> >> Visible cursor {cnorm/cvvis}
1341 B<< C<h> >> Scroll to bottom when a key is pressed 1912 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 1913 B<< C<l> >> Don't scroll to bottom when a key is pressed
1343 1914
1344=end table 1915=end table
1345 1916
1917=item B<< C<Ps = 1021> >> (B<rxvt>)
1918
1919=begin table
1920
1921 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1922 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1923
1924=end table
1925
1346=item B<< C<Ps = 1047> >> 1926=item B<< C<Ps = 1047> >>
1347 1927
1348=begin table 1928=begin table
1349 1929
1350 B<< C<h> >> Use Alternate Screen Buffer 1930 B<< C<h> >> Use Alternate Screen Buffer
1374 1954
1375=back 1955=back
1376 1956
1377X<XTerm> 1957X<XTerm>
1378 1958
1379=head1 XTerm Operating System Commands 1959=head2 XTerm Operating System Commands
1380 1960
1381=over 4 1961=over 4
1382 1962
1383=item B<< C<ESC ] Ps;Pt ST> >> 1963=item B<< C<ESC ] Ps;Pt ST> >>
1384 1964
1396 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1976 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)> 1977 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> >> 1978 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> >> 1979 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> >> 1980 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> >> 1981 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> >> 1982 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1983 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> >> 1984 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> 1985 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> 1986 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> >> 1987 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> >> 1988 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) 1989 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) 1990 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> >> 1991 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> >> 1992 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1993 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1994 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>. 1995 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>. 1996 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>. 1997 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>. 1998 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1999 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2000 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2001 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1417 2002
1418=end table 2003=end table
1419 2004
1420=back 2005=back
1421
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>
1888 2006
1889=head1 XPM 2007=head1 XPM
1890 2008
1891For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2009For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1892of B<< C<Pt> >> can be the name of the background pixmap followed by a 2010of B<< C<Pt> >> can be the name of the background pixmap followed by a
1990=begin table 2108=begin table
1991 2109
1992 4 Shift 2110 4 Shift
1993 8 Meta 2111 8 Meta
1994 16 Control 2112 16 Control
1995 32 Double Click I<(Rxvt extension)> 2113 32 Double Click I<(rxvt extension)>
1996 2114
1997=end table 2115=end table
1998 2116
1999Col = B<< C<< <x> - SPACE >> >> 2117Col = B<< C<< <x> - SPACE >> >>
2000 2118
2077=end table 2195=end table
2078 2196
2079=head1 CONFIGURE OPTIONS 2197=head1 CONFIGURE OPTIONS
2080 2198
2081General hint: if you get compile errors, then likely your configuration 2199General hint: if you get compile errors, then likely your configuration
2082hasn't been tested well. Either try with --enable-everything or use the 2200hasn'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, 2201the 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 2202myself, 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 2203always report when a combination doesn't work, so it can be fixed. Marc
2086<rxvt@schmorp.de>. 2204Lehmann <rxvt@schmorp.de>.
2205
2206All
2087 2207
2088=over 4 2208=over 4
2089 2209
2090=item --enable-everything 2210=item --enable-everything
2091 2211
2092Add support for all non-multichoice options listed in "./configure 2212Add (or remove) support for all non-multichoice options listed in "./configure
2093--help". Note that unlike other enable options this is order dependant. 2213--help".
2214
2094You can specify this and then disable options which this enables by 2215You can specify this and then disable options you do not like by
2095I<following> this with the appropriate commands. 2216I<following> this with the appropriate C<--disable-...> arguments,
2217or you can start with a minimal configuration by specifying
2218C<--disable-everything> and than adding just the C<--enable-...> arguments
2219you want.
2096 2220
2097=item --enable-xft 2221=item --enable-xft (default: enabled)
2098 2222
2099Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2223Add 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 2224slower and require lots of memory, but as long as you don't use them, you
2101don't pay for them. 2225don't pay for them.
2102 2226
2103=item --enable-font-styles 2227=item --enable-font-styles (default: on)
2104 2228
2105Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2229Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2106styles. The fonts can be set manually or automatically. 2230styles. The fonts can be set manually or automatically.
2107 2231
2108=item --with-codesets=NAME,... 2232=item --with-codesets=NAME,... (default: all)
2109 2233
2110Compile in support for additional codeset (encoding) groups (eu, vn are 2234Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2111always compiled in, which includes most 8-bit character sets). These 2235are always compiled in, which includes most 8-bit character sets). These
2112codeset tables are currently only used for driving X11 core fonts, they 2236codeset 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 2237for Xft fonts, although having them compiled in lets rxvt-unicode choose
2114bigger (together about 700kB), but it doesn't increase memory usage unless 2238replacement fonts more intelligently. Compiling them in will make your
2239binary bigger (all of together cost about 700kB), but it doesn't increase
2115you use an X11 font requiring one of these encodings. 2240memory usage unless you use a font requiring one of these encodings.
2116 2241
2117=begin table 2242=begin table
2118 2243
2119 all all available codeset groups 2244 all all available codeset groups
2120 zh common chinese encodings 2245 zh common chinese encodings
2123 jp_ext rarely used but big japanese encodings 2248 jp_ext rarely used but big japanese encodings
2124 kr korean encodings 2249 kr korean encodings
2125 2250
2126=end table 2251=end table
2127 2252
2128=item --enable-xim 2253=item --enable-xim (default: on)
2129 2254
2130Add support for XIM (X Input Method) protocol. This allows using 2255Add support for XIM (X Input Method) protocol. This allows using
2131alternative input methods (e.g. kinput2) and will also correctly 2256alternative input methods (e.g. kinput2) and will also correctly
2132set up the input for people using dead keys or compose keys. 2257set up the input for people using dead keys or compose keys.
2133 2258
2134=item --enable-unicode3 2259=item --enable-unicode3 (default: off)
2260
2261Recommended to stay off unless you really need non-BMP characters.
2135 2262
2136Enable direct support for displaying unicode codepoints above 2263Enable direct support for displaying unicode codepoints above
213765535 (the basic multilingual page). This increases storage 226465535 (the basic multilingual page). This increases storage
2138requirements per character from 2 to 4 bytes. X11 fonts do not yet 2265requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139support these extra characters, but Xft does. 2266support these extra characters, but Xft does.
2142even without this flag, but the number of such characters is 2269even without this flag, but the number of such characters is
2143limited to a view thousand (shared with combining characters, 2270limited to a view thousand (shared with combining characters,
2144see next switch), and right now rxvt-unicode cannot display them 2271see next switch), and right now rxvt-unicode cannot display them
2145(input/output and cut&paste still work, though). 2272(input/output and cut&paste still work, though).
2146 2273
2147=item --enable-combining 2274=item --enable-combining (default: on)
2148 2275
2149Enable automatic composition of combining characters into 2276Enable automatic composition of combining characters into
2150composite characters. This is required for proper viewing of text 2277composite characters. This is required for proper viewing of text
2151where accents are encoded as seperate unicode characters. This is 2278where accents are encoded as seperate unicode characters. This is
2152done by using precomposited characters when available or creating 2279done by using precomposited characters when available or creating
2153new pseudo-characters when no precomposed form exists. 2280new pseudo-characters when no precomposed form exists.
2154 2281
2155Without --enable-unicode3, the number of additional precomposed 2282Without --enable-unicode3, the number of additional precomposed
2156characters is rather limited (2048, if this is full, rxvt will use the 2283characters is somewhat limited (the 6400 private use characters will be
2157private use area, extending the number of combinations to 8448). With 2284(ab-)used). With --enable-unicode3, no practical limit exists.
2158--enable-unicode3, no practical limit exists. This will also enable 2285
2159storage of characters >65535. 2286This option will also enable storage (but not display) of characters
2287beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2160 2288
2161The combining table also contains entries for arabic presentation forms, 2289The combining table also contains entries for arabic presentation forms,
2162but these are not currently used. Bug me if you want these to be used. 2290but these are not currently used. Bug me if you want these to be used (and
2291tell me how these are to be used...).
2163 2292
2164=item --enable-fallback(=CLASS) 2293=item --enable-fallback(=CLASS) (default: Rxvt)
2165 2294
2166When reading resource settings, also read settings for class CLASS 2295When reading resource settings, also read settings for class CLASS. To
2167(default: Rxvt). To disable resource fallback use --disable-fallback. 2296disable resource fallback use --disable-fallback.
2168 2297
2169=item --with-res-name=NAME 2298=item --with-res-name=NAME (default: urxvt)
2170 2299
2171Use the given name (default: urxvt) as default application name when 2300Use the given name as default application name when
2172reading resources. Specify --with-res-name=rxvt to replace rxvt. 2301reading resources. Specify --with-res-name=rxvt to replace rxvt.
2173 2302
2174=item --with-res-class=CLASS 2303=item --with-res-class=CLASS /default: URxvt)
2175 2304
2176Use the given class (default: URxvt) as default application class 2305Use the given class as default application class
2177when reading resources. Specify --with-res-class=Rxvt to replace 2306when reading resources. Specify --with-res-class=Rxvt to replace
2178rxvt. 2307rxvt.
2179 2308
2180=item --enable-utmp 2309=item --enable-utmp (default: on)
2181 2310
2182Write user and tty to utmp file (used by programs like F<w>) at 2311Write user and tty to utmp file (used by programs like F<w>) at
2183start of rxvt execution and delete information when rxvt exits. 2312start of rxvt execution and delete information when rxvt exits.
2184 2313
2185=item --enable-wtmp 2314=item --enable-wtmp (default: on)
2186 2315
2187Write user and tty to wtmp file (used by programs like F<last>) at 2316Write user and tty to wtmp file (used by programs like F<last>) at
2188start of rxvt execution and write logout when rxvt exits. This 2317start of rxvt execution and write logout when rxvt exits. This
2189option requires --enable-utmp to also be specified. 2318option requires --enable-utmp to also be specified.
2190 2319
2191=item --enable-lastlog 2320=item --enable-lastlog (default: on)
2192 2321
2193Write user and tty to lastlog file (used by programs like 2322Write user and tty to lastlog file (used by programs like
2194F<lastlogin>) at start of rxvt execution. This option requires 2323F<lastlogin>) at start of rxvt execution. This option requires
2195--enable-utmp to also be specified. 2324--enable-utmp to also be specified.
2196 2325
2197=item --enable-xpm-background 2326=item --enable-xpm-background (default: on)
2198 2327
2199Add support for XPM background pixmaps. 2328Add support for XPM background pixmaps.
2200 2329
2201=item --enable-transparency 2330=item --enable-transparency (default: on)
2202 2331
2203Add support for inheriting parent backgrounds thus giving a fake 2332Add support for inheriting parent backgrounds thus giving a fake
2204transparency to the term. 2333transparency to the term.
2205 2334
2206=item --enable-fading 2335=item --enable-fading (default: on)
2207 2336
2208Add support for fading the text when focus is lost. 2337Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2209 2338
2210=item --enable-tinting 2339=item --enable-tinting (default: on)
2211 2340
2212Add support for tinting of transparent backgrounds. 2341Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2213 2342
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 2343=item --enable-rxvt-scroll (default: on)
2220 2344
2221Add support for the original rxvt scrollbar. 2345Add support for the original rxvt scrollbar.
2222 2346
2223=item --enable-next-scroll 2347=item --enable-next-scroll (default: on)
2224 2348
2225Add support for a NeXT-like scrollbar. 2349Add support for a NeXT-like scrollbar.
2226 2350
2227=item --enable-xterm-scroll 2351=item --enable-xterm-scroll (default: on)
2228 2352
2229Add support for an Xterm-like scrollbar. 2353Add support for an Xterm-like scrollbar.
2230 2354
2231=item --enable-plain-scroll 2355=item --enable-plain-scroll (default: on)
2232 2356
2233Add support for a very unobtrusive, plain-looking scrollbar that 2357Add support for a very unobtrusive, plain-looking scrollbar that
2234is the favourite of the rxvt-unicode author, having used it for 2358is the favourite of the rxvt-unicode author, having used it for
2235many years. 2359many years.
2236 2360
2237=item --enable-half-shadow 2361=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 2362
2244Change tty device setting to group "tty" - only use this if 2363Change tty device setting to group "tty" - only use this if
2245your system uses this type of security. 2364your system uses this type of security.
2246 2365
2247=item --disable-backspace-key 2366=item --disable-backspace-key
2248 2367
2249Disable any handling of the backspace key by us - let the X server 2368Removes any handling of the backspace key by us - let the X server do it.
2369
2370=item --disable-delete-key
2371
2372Removes any handling of the delete key by us - let the X server
2250do it. 2373do it.
2251 2374
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 2375=item --disable-resources
2258 2376
2259Remove all resources checking. 2377Removes 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 2378
2275=item --disable-swapscreen 2379=item --disable-swapscreen
2276 2380
2277Remove support for swap screen. 2381Remove support for secondary/swap screen.
2278 2382
2279=item --enable-frills 2383=item --enable-frills (default: on)
2280 2384
2281Add support for many small features that are not essential but nice to 2385Add 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 2386have. Normally you want this, but for very small binaries you may want to
2283disable this. 2387disable this.
2284 2388
2285A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2389A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2286in combination with other switches) is: 2390in combination with other switches) is:
2287 2391
2288 MWM-hints 2392 MWM-hints
2393 EWMH-hints (pid, utf8 names) and protocols (ping)
2289 seperate underline colour 2394 seperate underline colour (-underlineColor)
2290 settable border widths and borderless switch 2395 settable border widths and borderless switch (-w, -b, -bl)
2396 visual depth selection (-depth)
2291 settable extra linespacing 2397 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 2398 iso-14755-2 and -3, and visual feedback
2399 tripleclickwords (-tcw)
2400 settable insecure mode (-insecure)
2401 keysym remapping support
2402 cursor blinking and underline cursor (-cb, -uc)
2403 XEmbed support (-embed)
2404 user-pty (-pty-fd)
2405 hold on exit (-hold)
2406 skip builtin block graphics (-sbg)
2407
2408It also enabled some non-essential features otherwise disabled, such as:
2409
2410 some round-trip time optimisations
2411 nearest color allocation on pseudocolor screens
2412 UTF8_STRING supporr for selection
2413 sgr modes 90..97 and 100..107
2294 backindex and forwardindex escape sequence 2414 backindex and forwardindex escape sequences
2415 view change/zero scorllback esacpe sequences
2416 locale switching escape sequence
2295 window op and locale change escape sequences 2417 window op and some xterm/OSC escape sequences
2296 tripleclickwords 2418 rectangular selections
2297 settable insecure mode 2419 trailing space removal for selections
2420 verbose X error handling
2298 2421
2299=item --enable-iso14755 2422=item --enable-iso14755 (default: on)
2300 2423
2301Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2424Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2302F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2425F<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 2426C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2304this switch. 2427this switch.
2305 2428
2306=item --enable-keepscrolling 2429=item --enable-keepscrolling (default: on)
2307 2430
2308Add support for continual scrolling of the display when you hold 2431Add support for continual scrolling of the display when you hold
2309the mouse button down on a scrollbar arrow. 2432the mouse button down on a scrollbar arrow.
2310 2433
2311=item --enable-mousewheel 2434=item --enable-mousewheel (default: on)
2312 2435
2313Add support for scrolling via mouse wheel or buttons 4 & 5. 2436Add support for scrolling via mouse wheel or buttons 4 & 5.
2314 2437
2315=item --enable-slipwheeling 2438=item --enable-slipwheeling (default: on)
2316 2439
2317Add support for continual scrolling (using the mouse wheel as an 2440Add support for continual scrolling (using the mouse wheel as an
2318accelerator) while the control key is held down. This option 2441accelerator) while the control key is held down. This option
2319requires --enable-mousewheel to also be specified. 2442requires --enable-mousewheel to also be specified.
2320 2443
2321=item --disable-new-selection 2444=item --disable-new-selection
2322 2445
2323Remove support for mouse selection style like that of xterm. 2446Remove support for mouse selection style like that of xterm.
2324 2447
2325=item --enable-dmalloc 2448=item --enable-dmalloc (default: off)
2326 2449
2327Use Gray Watson's malloc - which is good for debugging See 2450Use Gray Watson's malloc - which is good for debugging See
2328http://www.letters.com/dmalloc/ for details If you use either this or the 2451L<http://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 2452next option, you may need to edit src/Makefile after compiling to point
2330DINCLUDE and DLIB to the right places. 2453DINCLUDE and DLIB to the right places.
2331 2454
2332You can only use either this option and the following (should 2455You can only use either this option and the following (should
2333you use either) . 2456you use either) .
2334 2457
2335=item --enable-dlmalloc 2458=item --enable-dlmalloc (default: off)
2336 2459
2337Use Doug Lea's malloc - which is good for a production version 2460Use Doug Lea's malloc - which is good for a production version
2338See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2461See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2339 2462
2340=item --enable-smart-resize 2463=item --enable-smart-resize (default: on)
2341 2464
2342Add smart growth/shrink behaviour when changing font size via from hot 2465Add smart growth/shrink behaviour when changing font size via hot
2343keys. This should keep in a fixed position the rxvt corner which is 2466keys. This should keep the window corner which is closest to a corner of
2344closest to a corner of the screen. 2467the screen in a fixed position.
2345 2468
2346=item --enable-cursor-blink
2347
2348Add support for a blinking cursor.
2349
2350=item --enable-pointer-blank 2469=item --enable-pointer-blank (default: on)
2351 2470
2352Add support to have the pointer disappear when typing or inactive. 2471Add support to have the pointer disappear when typing or inactive.
2353 2472
2354=item --with-name=NAME 2473=item --enable-perl (default: on)
2355 2474
2475Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2476manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2477in F<src/perl-ext/> for the extensions that are installed by default. The
2478perl interpreter that is used can be specified via the C<PERL> environment
2479variable when running configure.
2480
2481=item --with-name=NAME (default: urxvt)
2482
2356Set the basename for the installed binaries (default: C<urxvt>, resulting 2483Set the basename for the installed binaries, resulting
2357in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2484in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2358C<rxvt>. 2485C<rxvt>.
2359 2486
2360=item --with-term=NAME 2487=item --with-term=NAME (default: rxvt-unicode)
2361 2488
2362Change the environmental variable for the terminal to NAME (default 2489Change the environmental variable for the terminal to NAME.
2363C<rxvt-unicode>)
2364 2490
2365=item --with-terminfo=PATH 2491=item --with-terminfo=PATH
2366 2492
2367Change the environmental variable for the path to the terminfo tree to 2493Change the environmental variable for the path to the terminfo tree to
2368PATH. 2494PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines