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.33 by root, Sun Jan 16 18:48:04 2005 UTC vs.
Revision 1.113 by root, Thu Feb 2 18:04:45 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: \e[1~ 623 URxvt.keysym.Home: \033[1~
532 URxvt*keysym.End: \e[4~ 624 URxvt.keysym.End: \033[4~
533 URxvt*keysym.C-apostrophe: \e<C-'> 625 URxvt.keysym.C-apostrophe: \033<C-'>
534 URxvt*keysym.C-slash: \e<C-/> 626 URxvt.keysym.C-slash: \033<C-/>
535 URxvt*keysym.C-semicolon: \e<C-;> 627 URxvt.keysym.C-semicolon: \033<C-;>
536 URxvt*keysym.C-grave: \e<C-`> 628 URxvt.keysym.C-grave: \033<C-`>
537 URxvt*keysym.C-comma: \e<C-,> 629 URxvt.keysym.C-comma: \033<C-,>
538 URxvt*keysym.C-period: \e<C-.> 630 URxvt.keysym.C-period: \033<C-.>
539 URxvt*keysym.C-0x60: \e<C-`> 631 URxvt.keysym.C-0x60: \033<C-`>
540 URxvt*keysym.C-Tab: \e<C-Tab> 632 URxvt.keysym.C-Tab: \033<C-Tab>
541 URxvt*keysym.C-Return: \e<C-Return> 633 URxvt.keysym.C-Return: \033<C-Return>
542 URxvt*keysym.S-Return: \e<S-Return> 634 URxvt.keysym.S-Return: \033<S-Return>
543 URxvt*keysym.S-space: \e<S-Space> 635 URxvt.keysym.S-space: \033<S-Space>
544 URxvt*keysym.M-Up: \e<M-Up> 636 URxvt.keysym.M-Up: \033<M-Up>
545 URxvt*keysym.M-Down: \e<M-Down> 637 URxvt.keysym.M-Down: \033<M-Down>
546 URxvt*keysym.M-Left: \e<M-Left> 638 URxvt.keysym.M-Left: \033<M-Left>
547 URxvt*keysym.M-Right: \e<M-Right> 639 URxvt.keysym.M-Right: \033<M-Right>
548 URxvt*keysym.M-C-0: list.0123456789.\e<M-C-.> 640 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
549 URxvt*keysym.M-C-a: list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.> 641 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550 URxvt*keysym.F12: proto:\033]701;zh_CN.GBK\007 642 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
551 643
552=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 644See some more examples in the documentation for the B<keysym> resource.
553How do I make use of them? For example, the Sun Keyboard type 4 645
554has the following mappings that rxvt-unicode doesn't recognize. 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
555 647
556 KP_Insert == Insert 648 KP_Insert == Insert
557 F22 == Print 649 F22 == Print
558 F27 == Home 650 F27 == Home
559 F29 == Prior 651 F29 == Prior
560 F33 == End 652 F33 == End
561 F35 == Next 653 F35 == Next
562 654
563Rather than have rxvt-unicode try to accommodate all the various possible keyboard 655Rather than have rxvt-unicode try to accommodate all the various possible
564mappings, it is better to use `xmodmap' to remap the keys as required for 656keyboard mappings, it is better to use `xmodmap' to remap the keys as
565your particular machine. 657required for your particular machine.
566 658
567=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
568I need this to decide about setting colors etc.
569 659
570rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
571check and see if that is set. Note that several programs, JED, slrn,
572Midnight Commander automatically check this variable to decide whether or
573not to use color.
574 660
575=item How do I set the correct, full IP address for the DISPLAY variable? 661=head2 Terminal Configuration
576 662
577If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 663=head3 Why doesn't rxvt-unicode read my resources?
578insecure mode then it is possible to use the following shell script
579snippets to correctly set the display. If your version of rxvt-unicode
580wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
581the COLORTERM variable can be used to distinguish rxvt-unicode from a
582regular xterm.
583 664
584Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 665Well, why, indeed? It does, in a way very similar to other X
585snippets: 666applications. Most importantly, this means that if you or your OS loads
667resources into the X display (the right way to do it), rxvt-unicode will
668ignore any resource files in your home directory. It will only read
669F<$HOME/.Xdefaults> when no resources are attached to the display.
586 670
587 # Bourne/Korn/POSIX family of shells: 671If you have or use an F<$HOME/.Xresources> file, chances are that
588 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 672resources are loaded into your X-server. In this case, you have to
589 if [ ${TERM:-foo} = xterm ]; then 673re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
590 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
591 echo -n '^[Z'
592 read term_id
593 stty icanon echo
594 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
595 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
596 read DISPLAY # set it in our local shell
597 fi
598 fi
599 674
600=item How do I compile the manual pages for myself? 675Also consider the form resources have to use:
601 676
602You need to have a recent version of perl installed as F</usr/bin/perl>, 677 URxvt.resource: value
603one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
604the doc subdirectory and enter C<make alldoc>.
605 678
606=item My question isn't answered here, can I ask a human? 679If you want to use another form (there are lots of different ways of
680specifying resources), make sure you understand wether and why it
681works. If unsure, use the form above.
607 682
608Before sending me mail, you could go to IRC: C<irc.freenode.net>, 683=head3 When I log-in to another system it tells me about missing terminfo data?
609channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 684
610interested in learning about new and exciting problems (but not FAQs :). 685The terminal description used by rxvt-unicode is not as widely available
686as that for xterm, or even rxvt (for which the same problem often arises).
687
688The correct solution for this problem is to install the terminfo, this can
689be done like this (with ncurses' infocmp):
690
691 REMOTE=remotesystem.domain
692 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
693
694... or by installing rxvt-unicode normally on the remote system,
695
696If you cannot or do not want to do this, then you can simply set
697C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
698problems arising, which includes wrong keymapping, less and different
699colours and some refresh errors in fullscreen applications. It's a nice
700quick-and-dirty workaround for rare cases, though.
701
702If you always want to do this (and are fine with the consequences) you
703can either recompile rxvt-unicode with the desired TERM value or use a
704resource to set it:
705
706 URxvt.termName: rxvt
707
708If you don't plan to use B<rxvt> (quite common...) you could also replace
709the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
710
711=head3 C<tic> outputs some error when compiling the terminfo entry.
712
713Most likely it's the empty definition for C<enacs=>. Just replace it by
714C<enacs=\E[0@> and try again.
715
716=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
717
718See next entry.
719
720=head3 I need a termcap file entry.
721
722One reason you might want this is that some distributions or operating
723systems still compile some programs using the long-obsoleted termcap
724library (Fedora Core's bash is one example) and rely on a termcap entry
725for C<rxvt-unicode>.
726
727You could use rxvt's termcap entry with resonable results in many cases.
728You can also create a termcap entry by using terminfo's infocmp program
729like this:
730
731 infocmp -C rxvt-unicode
732
733Or you could use this termcap entry, generated by the command above:
734
735 rxvt-unicode|rxvt-unicode terminal (X Window System):\
736 :am:bw:eo:km:mi:ms:xn:xo:\
737 :co#80:it#8:li#24:lm#0:\
738 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
739 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
740 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
741 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
742 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
743 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
744 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
745 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
746 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
747 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
748 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
749 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
750 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
751 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
752 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
753 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
754 :vs=\E[?25h:
755
756=head3 Why does C<ls> no longer have coloured output?
757
758The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
759decide wether a terminal has colour, but uses it's own configuration
760file. Needless to say, C<rxvt-unicode> is not in it's default file (among
761with most other terminals supporting colour). Either add:
762
763 TERM rxvt-unicode
764
765to C</etc/DIR_COLORS> or simply add:
766
767 alias ls='ls --color=auto'
768
769to your C<.profile> or C<.bashrc>.
770
771=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
772
773See next entry.
774
775=head3 Why doesn't vim/emacs etc. make use of italic?
776
777See next entry.
778
779=head3 Why are the secondary screen-related options not working properly?
780
781Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
782distributions (most notably Debian GNU/Linux) break rxvt-unicode
783by setting C<TERM> to C<rxvt>, which doesn't have these extra
784features. Unfortunately, some of these (most notably, again, Debian
785GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
786file, so you will need to install it on your own (See the question B<When
787I log-in to another system it tells me about missing terminfo data?> on
788how to do this).
789
790
791=head2 Encoding / Locale / Input Method Issues
792
793=head3 Rxvt-unicode does not seem to understand the selected encoding?
794
795See next entry.
796
797=head3 Unicode does not seem to work?
798
799If you encounter strange problems like typing an accented character but
800getting two unrelated other characters or similar, or if program output is
801subtly garbled, then you should check your locale settings.
802
803Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
804programs. Often rxvt-unicode is started in the C<C> locale, while the
805login script running within the rxvt-unicode window changes the locale to
806something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
807
808The best thing is to fix your startup environment, as you will likely run
809into other problems. If nothing works you can try this in your .profile.
810
811 printf '\e]701;%s\007' "$LC_CTYPE"
812
813If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
814supported on your systems. Some systems have a C<locale> command which
815displays this (also, C<perl -e0> can be used to check locale settings, as
816it will complain loudly if it cannot set the locale). If it displays something
817like:
818
819 locale: Cannot set LC_CTYPE to default locale: ...
820
821Then the locale you specified is not supported on your system.
822
823If nothing works and you are sure that everything is set correctly then
824you will need to remember a little known fact: Some programs just don't
825support locales :(
826
827=head3 How does rxvt-unicode determine the encoding to use?
828
829See next entry.
830
831=head3 Is there an option to switch encodings?
832
833Unlike some other terminals, rxvt-unicode has no encoding switch, and no
834specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
835UTF-8 or any other encodings with respect to terminal I/O.
836
837The reasons is that there exists a perfectly fine mechanism for selecting
838the encoding, doing I/O and (most important) communicating this to all
839applications so everybody agrees on character properties such as width
840and code number. This mechanism is the I<locale>. Applications not using
841that info will have problems (for example, C<xterm> gets the width of
842characters wrong as it uses it's own, locale-independent table under all
843locales).
844
845Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
846programs doing the same (that is, most) will automatically agree in the
847interpretation of characters.
848
849Unfortunately, there is no system-independent way to select locales, nor
850is there a standard on how locale specifiers will look like.
851
852On most systems, the content of the C<LC_CTYPE> environment variable
853contains an arbitrary string which corresponds to an already-installed
854locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
855C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
856(i.e. C<de> or C<german>) are also common.
857
858Rxvt-unicode ignores all other locale categories, and except for
859the encoding, ignores country or language-specific settings,
860i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
861rxvt-unicode.
862
863If you want to use a specific encoding you have to make sure you start
864rxvt-unicode with the correct C<LC_CTYPE> category.
865
866=head3 Can I switch locales at runtime?
867
868Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>.
870
871 printf '\e]701;%s\007' ja_JP.SJIS
872
873See also the previous answer.
874
875Sometimes this capability is rather handy when you want to work in
876one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
877(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
878first switches to a locale supported by xjdic and back later:
879
880 printf '\e]701;%s\007' ja_JP.SJIS
881 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8
883
884You can also use xterm's C<luit> program, which usually works fine, except
885for some locales where character width differs between program- and
886rxvt-unicode-locales.
887
888=head3 I have problems getting my input method working.
889
890Try a search engine, as this is slightly different for every input method server.
891
892Here is a checklist:
893
894=over 4
895
896=item - Make sure your locale I<and> the imLocale are supported on your OS.
897
898Try C<locale -a> or check the documentation for your OS.
899
900=item - Make sure your locale or imLocale matches a locale supported by your XIM.
901
902For example, B<kinput2> does not support UTF-8 locales, you should use
903C<ja_JP.EUC-JP> or equivalent.
904
905=item - Make sure your XIM server is actually running.
906
907=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
908
909When you want to use e.g. B<kinput2>, it must be set to
910C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
911method servers are running with this command:
912
913 xprop -root XIM_SERVERS
914
915=item
611 916
612=back 917=back
613 918
614=head1 SYNOPSIS 919=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
615 920
616 # set a new font set 921You can specify separate locales for the input method and the rest of the
617 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" 922terminal, using the resource C<imlocale>:
618 923
619 # change the locale and tell rxvt-unicode about it 924 URxvt.imlocale: ja_JP.EUC-JP
620 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
621 925
622 # set window title 926Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
623 printf '\33]2;%s\007' "new window title" 927use your input method. Please note, however, that, depending on your Xlib
928version, you may not be able to input characters outside C<EUC-JP> in a
929normal way then, as your input method limits you.
624 930
625=head1 DESCRIPTION 931=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
932
933Unfortunately, this is unavoidable, as the XIM protocol is racy by
934design. Applications can avoid some crashes at the expense of memory
935leaks, and Input Methods can avoid some crashes by careful ordering at
936exit time. B<kinput2> (and derived input methods) generally succeeds,
937while B<SCIM> (or similar input methods) fails. In the end, however,
938crashes cannot be completely avoided even if both sides cooperate.
939
940So the only workaround is not to kill your Input Method Servers.
941
942
943=head2 Operating Systems / Package Maintaining
944
945=head3 I am using Debian GNU/Linux and have a problem...
946
947The Debian GNU/Linux package of rxvt-unicode in sarge contains large
948patches that considerably change the behaviour of rxvt-unicode (but
949unfortunately this notice has been removed). Before reporting a bug to
950the original rxvt-unicode author please download and install the genuine
951version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
952the problem. If you cannot, chances are that the problems are specific to
953Debian GNU/Linux, in which case it should be reported via the Debian Bug
954Tracking System (use C<reportbug> to report the bug).
955
956For other problems that also affect the Debian package, you can and
957probably should use the Debian BTS, too, because, after all, it's also a
958bug in the Debian version and it serves as a reminder for other users that
959might encounter the same issue.
960
961=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
962
963You should build one binary with the default options. F<configure>
964now enables most useful options, and the trend goes to making them
965runtime-switchable, too, so there is usually no drawback to enbaling them,
966except higher disk and possibly memory usage. The perl interpreter should
967be enabled, as important functionality (menus, selection, likely more in
968the future) depends on it.
969
970You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
971system-wide (except maybe with C<defaults>). This will result in useful
972behaviour. If your distribution aims at low memory, add an empty
973C<perl-ext-common> resource to the app-defaults file. This will keep the
974perl interpreter disabled until the user enables it.
975
976If you can/want build more binaries, I recommend building a minimal
977one with C<--disable-everything> (very useful) and a maximal one with
978C<--enable-everything> (less useful, it will be very big due to a lot of
979encodings built-in that increase download times and are rarely used).
980
981=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
982
983It should be, starting with release 7.1. You are encouraged to properly
984install urxvt with privileges necessary for your OS now.
985
986When rxvt-unicode detects that it runs setuid or setgid, it will fork
987into a helper process for privileged operations (pty handling on some
988systems, utmp/wtmp/lastlog handling on others) and drop privileges
989immediately. This is much safer than most other terminals that keep
990privileges while running (but is more relevant to urxvt, as it contains
991things as perl interpreters, which might be "helpful" to attackers).
992
993This forking is done as the very first within main(), which is very early
994and reduces possible bugs to initialisation code run before main(), or
995things like the dynamic loader of your system, which should result in very
996little risk.
997
998=head3 On Solaris 9, many line-drawing characters are too wide.
999
1000Seems to be a known bug, read
1001L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1002following ugly workaround to get non-double-wide-characters working:
1003
1004 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1005
1006=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1007
1008Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1009in your compile environment, or an implementation that implements it,
1010wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1011B<wchar_t> is represented as unicode.
1012
1013As you might have guessed, FreeBSD does neither define this symobl nor
1014does it support it. Instead, it uses it's own internal representation of
1015B<wchar_t>. This is, of course, completely fine with respect to standards.
1016
1017However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1018C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1019
1020C<__STDC_ISO_10646__> is the only sane way to support multi-language
1021apps in an OS, as using a locale-dependent (and non-standardized)
1022representation of B<wchar_t> makes it impossible to convert between
1023B<wchar_t> (as used by X11 and your applications) and any other encoding
1024without implementing OS-specific-wrappers for each and every locale. There
1025simply are no APIs to convert B<wchar_t> into anything except the current
1026locale encoding.
1027
1028Some applications (such as the formidable B<mlterm>) work around this
1029by carrying their own replacement functions for character set handling
1030with them, and either implementing OS-dependent hacks or doing multiple
1031conversions (which is slow and unreliable in case the OS implements
1032encodings slightly different than the terminal emulator).
1033
1034The rxvt-unicode author insists that the right way to fix this is in the
1035system libraries once and for all, instead of forcing every app to carry
1036complete replacements for them :)
1037
1038=head3 I use Solaris 9 and it doesn't compile/work/etc.
1039
1040Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1041problems with C<wcwidth> and a compile problem.
1042
1043=head3 How can I use rxvt-unicode under cygwin?
1044
1045rxvt-unicode should compile and run out of the box on cygwin, using
1046the X11 libraries that come with cygwin. libW11 emulation is no
1047longer supported (and makes no sense, either, as it only supported a
1048single font). I recommend starting the X-server in C<-multiwindow> or
1049C<-rootless> mode instead, which will result in similar look&feel as the
1050old libW11 emulation.
1051
1052At the time of this writing, cygwin didn't seem to support any multi-byte
1053encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1054to 8-bit encodings.
1055
1056=head1 RXVT-UNICODE TECHNICAL REFERENCE
626 1057
627The rest of this document describes various technical aspects of 1058The rest of this document describes various technical aspects of
628B<rxvt-unicode>. First the description of supported command sequences, 1059B<rxvt-unicode>. First the description of supported command sequences,
629followed by menu and pixmap support and last by a description of all 1060followed by pixmap support and last by a description of all features
630features selectable at C<configure> time. 1061selectable at C<configure> time.
631 1062
632=head1 RXVT TECHNICAL REFERENCE
633
634=head1 Definitions 1063=head2 Definitions
635 1064
636=over 4 1065=over 4
637 1066
638=item B<< C<c> >> 1067=item B<< C<c> >>
639 1068
657 1086
658A text parameter composed of printable characters. 1087A text parameter composed of printable characters.
659 1088
660=back 1089=back
661 1090
662=head1 Values 1091=head2 Values
663 1092
664=over 4 1093=over 4
665 1094
666=item B<< C<ENQ> >> 1095=item B<< C<ENQ> >>
667 1096
710 1139
711Space Character 1140Space Character
712 1141
713=back 1142=back
714 1143
715=head1 Escape Sequences 1144=head2 Escape Sequences
716 1145
717=over 4 1146=over 4
718 1147
719=item B<< C<ESC # 8> >> 1148=item B<< C<ESC # 8> >>
720 1149
766Single Shift Select of G3 Character Set (SS3): affects next character 1195Single Shift Select of G3 Character Set (SS3): affects next character
767only I<unimplemented> 1196only I<unimplemented>
768 1197
769=item B<< C<ESC Z> >> 1198=item B<< C<ESC Z> >>
770 1199
771Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1200Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
772 1201
773=item B<< C<ESC c> >> 1202=item B<< C<ESC c> >>
774 1203
775Full reset (RIS) 1204Full reset (RIS)
776 1205
780 1209
781=item B<< C<ESC o> >> 1210=item B<< C<ESC o> >>
782 1211
783Invoke the G3 Character Set (LS3) 1212Invoke the G3 Character Set (LS3)
784 1213
785=item B<< C<ESC> ( C> >> 1214=item B<< C<ESC ( C> >>
786 1215
787Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1216Designate G0 Character Set (ISO 2022), see below for values of C<C>.
788 1217
789=item B<< C<ESC> ) C> >> 1218=item B<< C<ESC ) C> >>
790 1219
791Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1220Designate G1 Character Set (ISO 2022), see below for values of C<C>.
792 1221
793=item B<< C<ESC * C> >> 1222=item B<< C<ESC * C> >>
794 1223
818 1247
819=back 1248=back
820 1249
821X<CSI> 1250X<CSI>
822 1251
823=head1 CSI (Command Sequence Introducer) Sequences 1252=head2 CSI (Command Sequence Introducer) Sequences
824 1253
825=over 4 1254=over 4
826 1255
827=item B<< C<ESC [ Ps @> >> 1256=item B<< C<ESC [ Ps @> >>
828 1257
935 1364
936=item B<< C<ESC [ Ps c> >> 1365=item B<< C<ESC [ Ps c> >>
937 1366
938Send Device Attributes (DA) 1367Send Device Attributes (DA)
939B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1368B<< C<Ps = 0> >> (or omitted): request attributes from terminal
940returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1369returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
941Option'') 1370Option'')
942 1371
943=item B<< C<ESC [ Ps d> >> 1372=item B<< C<ESC [ Ps d> >>
944 1373
945Cursor to Line B<< C<Ps> >> (VPA) 1374Cursor to Line B<< C<Ps> >> (VPA)
1061 1490
1062=item B<< C<ESC [ s> >> 1491=item B<< C<ESC [ s> >>
1063 1492
1064Save Cursor (SC) 1493Save Cursor (SC)
1065 1494
1495=item B<< C<ESC [ Ps;Pt t> >>
1496
1497Window Operations
1498
1499=begin table
1500
1501 B<< C<Ps = 1> >> Deiconify (map) window
1502 B<< C<Ps = 2> >> Iconify window
1503 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1504 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1505 B<< C<Ps = 5> >> Raise window
1506 B<< C<Ps = 6> >> Lower window
1507 B<< C<Ps = 7> >> Refresh screen once
1508 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1509 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1510 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1511 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1512 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1513 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1514 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1515 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1516 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1517
1518=end table
1519
1520=item B<< C<ESC [ u> >>
1521
1522Restore Cursor
1523
1066=item B<< C<ESC [ Ps x> >> 1524=item B<< C<ESC [ Ps x> >>
1067 1525
1068Request Terminal Parameters (DECREQTPARM) 1526Request Terminal Parameters (DECREQTPARM)
1069 1527
1070=item B<< C<ESC [ u> >>
1071
1072Restore Cursor
1073
1074=back 1528=back
1075 1529
1076X<PrivateModes> 1530X<PrivateModes>
1077 1531
1078=head1 DEC Private Modes 1532=head2 DEC Private Modes
1079 1533
1080=over 4 1534=over 4
1081 1535
1082=item B<< C<ESC [ ? Pm h> >> 1536=item B<< C<ESC [ ? Pm h> >>
1083 1537
1180 B<< C<h> >> Send Mouse X & Y on button press. 1634 B<< C<h> >> Send Mouse X & Y on button press.
1181 B<< C<l> >> No mouse reporting. 1635 B<< C<l> >> No mouse reporting.
1182 1636
1183=end table 1637=end table
1184 1638
1185=item B<< C<Ps = 10> >> (B<rxvt>)
1186
1187=begin table
1188
1189 B<< C<h> >> menuBar visible
1190 B<< C<l> >> menuBar invisible
1191
1192=end table
1193
1194=item B<< C<Ps = 25> >> 1639=item B<< C<Ps = 25> >>
1195 1640
1196=begin table 1641=begin table
1197 1642
1198 B<< C<h> >> Visible cursor {cnorm/cvvis} 1643 B<< C<h> >> Visible cursor {cnorm/cvvis}
1314 B<< C<h> >> Scroll to bottom when a key is pressed 1759 B<< C<h> >> Scroll to bottom when a key is pressed
1315 B<< C<l> >> Don't scroll to bottom when a key is pressed 1760 B<< C<l> >> Don't scroll to bottom when a key is pressed
1316 1761
1317=end table 1762=end table
1318 1763
1764=item B<< C<Ps = 1021> >> (B<rxvt>)
1765
1766=begin table
1767
1768 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1769 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1770
1771=end table
1772
1319=item B<< C<Ps = 1047> >> 1773=item B<< C<Ps = 1047> >>
1320 1774
1321=begin table 1775=begin table
1322 1776
1323 B<< C<h> >> Use Alternate Screen Buffer 1777 B<< C<h> >> Use Alternate Screen Buffer
1347 1801
1348=back 1802=back
1349 1803
1350X<XTerm> 1804X<XTerm>
1351 1805
1352=head1 XTerm Operating System Commands 1806=head2 XTerm Operating System Commands
1353 1807
1354=over 4 1808=over 4
1355 1809
1356=item B<< C<ESC ] Ps;Pt ST> >> 1810=item B<< C<ESC ] Ps;Pt ST> >>
1357 1811
1369 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1823 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1370 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1824 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1371 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1825 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1372 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1826 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1373 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1827 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1374 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1828 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1375 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1829 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1830 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1376 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1831 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1377 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1378 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1832 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1379 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1833 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1380 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> >> 1834 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> >>
1381 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1835 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1382 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) 1836 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).
1383 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1837 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>.
1384 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1838 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1385 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1839 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1840 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1841 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1386 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1842 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1387 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1843 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1388 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1844 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1389 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1845 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1846 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1847 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1848 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1390 1849
1391=end table 1850=end table
1392 1851
1393=back 1852=back
1394
1395X<menuBar>
1396
1397=head1 menuBar
1398
1399B<< The exact syntax used is I<almost> solidified. >>
1400In the menus, B<DON'T> try to use menuBar commands that add or remove a
1401menuBar.
1402
1403Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1404omitted: use B<./> to specify a menu relative to the current menu.
1405
1406=head2 Overview of menuBar operation
1407
1408For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1409of C<Pt> can be used for a variety of tasks:
1410
1411At the top level is the current menuBar which is a member of a circular
1412linked-list of other such menuBars.
1413
1414The menuBar acts as a parent for the various drop-down menus, which in
1415turn, may have labels, separator lines, menuItems and subMenus.
1416
1417The menuItems are the useful bits: you can use them to mimic keyboard
1418input or even to send text or escape sequences back to rxvt.
1419
1420The menuBar syntax is intended to provide a simple yet robust method of
1421constructing and manipulating menus and navigating through the
1422menuBars.
1423
1424The first step is to use the tag B<< [menu:I<name>] >> which creates
1425the menuBar called I<name> and allows access. You may now or menus,
1426subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1427menuBar access as B<readonly> to prevent accidental corruption of the
1428menus. To re-access the current menuBar for alterations, use the tag
1429B<[menu]>, make the alterations and then use B<[done]>
1430
1431X<menuBarCommands>
1432
1433=head2 Commands
1434
1435=over 4
1436
1437=item B<< [menu:+I<name>] >>
1438
1439access the named menuBar for creation or alteration. If a new menuBar
1440is created, it is called I<name> (max of 15 chars) and the current
1441menuBar is pushed onto the stack
1442
1443=item B<[menu]>
1444
1445access the current menuBar for alteration
1446
1447=item B<< [title:+I<string>] >>
1448
1449set the current menuBar's title to I<string>, which may contain the
1450following format specifiers:
1451B<%%> : literal B<%> character
1452B<%n> : rxvt name (as per the B<-name> command-line option)
1453B<%v> : rxvt version
1454
1455=item B<[done]>
1456
1457set menuBar access as B<readonly>.
1458End-of-file tag for B<< [read:+I<file>] >> operations.
1459
1460=item B<< [read:+I<file>] >>
1461
1462read menu commands directly from I<file> (extension ".menu" will be
1463appended if required.) Start reading at a line with B<[menu]> or B<<
1464[menu:+I<name> >> and continuing until B<[done]> is encountered.
1465
1466Blank and comment lines (starting with B<#>) are ignored. Actually,
1467since any invalid menu commands are also ignored, almost anything could
1468be construed as a comment line, but this may be tightened up in the
1469future ... so don't count on it!.
1470
1471=item B<< [read:+I<file>;+I<name>] >>
1472
1473The same as B<< [read:+I<file>] >>, but start reading at a line with
1474B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1475B<[done]> is encountered.
1476
1477=item B<[dump]>
1478
1479dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1480later rereading.
1481
1482=item B<[rm:name]>
1483
1484remove the named menuBar
1485
1486=item B<[rm] [rm:]>
1487
1488remove the current menuBar
1489
1490=item B<[rm*] [rm:*]>
1491
1492remove all menuBars
1493
1494=item B<[swap]>
1495
1496swap the top two menuBars
1497
1498=item B<[prev]>
1499
1500access the previous menuBar
1501
1502=item B<[next]>
1503
1504access the next menuBar
1505
1506=item B<[show]>
1507
1508Enable display of the menuBar
1509
1510=item B<[hide]>
1511
1512Disable display of the menuBar
1513
1514=item B<< [pixmap:+I<name>] >>
1515
1516=item B<< [pixmap:+I<name>;I<scaling>] >>
1517
1518(set the background pixmap globally
1519
1520B<< A Future implementation I<may> make this local to the menubar >>)
1521
1522=item B<< [:+I<command>:] >>
1523
1524ignore the menu readonly status and issue a I<command> to or a menu or
1525menuitem or change the ; a useful shortcut for setting the quick arrows
1526from a menuBar.
1527
1528=back
1529
1530X<menuBarAdd>
1531
1532=head2 Adding and accessing menus
1533
1534The following commands may also be B<+> prefixed.
1535
1536=over 4
1537
1538=item B</+>
1539
1540access menuBar top level
1541
1542=item B<./+>
1543
1544access current menu level
1545
1546=item B<../+>
1547
1548access parent menu (1 level up)
1549
1550=item B<../../>
1551
1552access parent menu (multiple levels up)
1553
1554=item B<< I</path/>menu >>
1555
1556add/access menu
1557
1558=item B<< I</path/>menu/* >>
1559
1560add/access menu and clear it if it exists
1561
1562=item B<< I</path/>{-} >>
1563
1564add separator
1565
1566=item B<< I</path/>{item} >>
1567
1568add B<item> as a label
1569
1570=item B<< I</path/>{item} action >>
1571
1572add/alter I<menuitem> with an associated I<action>
1573
1574=item B<< I</path/>{item}{right-text} >>
1575
1576add/alter I<menuitem> with B<right-text> as the right-justified text
1577and as the associated I<action>
1578
1579=item B<< I</path/>{item}{rtext} action >>
1580
1581add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1582the right-justified text.
1583
1584=back
1585
1586=over 4
1587
1588=item Special characters in I<action> must be backslash-escaped:
1589
1590B<\a \b \E \e \n \r \t \octal>
1591
1592=item or in control-character notation:
1593
1594B<^@, ^A .. ^Z .. ^_, ^?>
1595
1596=back
1597
1598To send a string starting with a B<NUL> (B<^@>) character to the
1599program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1600the first of which will be stripped off and the balance directed to the
1601program. Otherwise if I<action> begins with B<NUL> followed by
1602non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1603balance is sent back to rxvt.
1604
1605As a convenience for the many Emacs-type editors, I<action> may start
1606with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1607appended if missed from B<M-x> commands.
1608
1609As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1610quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1611
1612=over 4
1613
1614=item For example,
1615
1616B<M-xapropos> is equivalent to B<\Exapropos\r>
1617
1618=item and
1619
1620B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1621
1622=back
1623
1624The option B<< {I<right-rtext>} >> will be right-justified. In the
1625absence of a specified action, this text will be used as the I<action>
1626as well.
1627
1628=over 4
1629
1630=item For example,
1631
1632B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1633
1634=back
1635
1636The left label I<is> necessary, since it's used for matching, but
1637implicitly hiding the left label (by using same name for both left and
1638right labels), or explicitly hiding the left label (by preceeding it
1639with a dot), makes it possible to have right-justified text only.
1640
1641=over 4
1642
1643=item For example,
1644
1645B</File/{Open}{Open} Open-File-Action>
1646
1647=item or hiding it
1648
1649B</File/{.anylabel}{Open} Open-File-Action>
1650
1651=back
1652
1653X<menuBarRemove>
1654
1655=head2 Removing menus
1656
1657=over 4
1658
1659=item B<< -/*+ >>
1660
1661remove all menus from the menuBar, the same as B<[clear]>
1662
1663=item B<< -+I</path>menu+ >>
1664
1665remove menu
1666
1667=item B<< -+I</path>{item}+ >>
1668
1669remove item
1670
1671=item B<< -+I</path>{-} >>
1672
1673remove separator)
1674
1675=item B<-/path/menu/*>
1676
1677remove all items, separators and submenus from menu
1678
1679=back
1680
1681X<menuBarArrows>
1682
1683=head2 Quick Arrows
1684
1685The menus also provide a hook for I<quick arrows> to provide easier
1686user access. If nothing has been explicitly set, the default is to
1687emulate the curror keys. The syntax permits each arrow to be altered
1688individually or all four at once without re-entering their common
1689beginning/end text. For example, to explicitly associate cursor actions
1690with the arrows, any of the following forms could be used:
1691
1692=over 4
1693
1694=item B<< <r>+I<Right> >>
1695
1696=item B<< <l>+I<Left> >>
1697
1698=item B<< <u>+I<Up> >>
1699
1700=item B<< <d>+I<Down> >>
1701
1702Define actions for the respective arrow buttons
1703
1704=item B<< <b>+I<Begin> >>
1705
1706=item B<< <e>+I<End> >>
1707
1708Define common beginning/end parts for I<quick arrows> which used in
1709conjunction with the above <r> <l> <u> <d> constructs
1710
1711=back
1712
1713=over 4
1714
1715=item For example, define arrows individually,
1716
1717 <u>\E[A
1718
1719 <d>\E[B
1720
1721 <r>\E[C
1722
1723 <l>\E[D
1724
1725=item or all at once
1726
1727 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1728
1729=item or more compactly (factoring out common parts)
1730
1731 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1732
1733=back
1734
1735X<menuBarSummary>
1736
1737=head2 Command Summary
1738
1739A short summary of the most I<common> commands:
1740
1741=over 4
1742
1743=item [menu:name]
1744
1745use an existing named menuBar or start a new one
1746
1747=item [menu]
1748
1749use the current menuBar
1750
1751=item [title:string]
1752
1753set menuBar title
1754
1755=item [done]
1756
1757set menu access to readonly and, if reading from a file, signal EOF
1758
1759=item [done:name]
1760
1761if reading from a file using [read:file;name] signal EOF
1762
1763=item [rm:name]
1764
1765remove named menuBar(s)
1766
1767=item [rm] [rm:]
1768
1769remove current menuBar
1770
1771=item [rm*] [rm:*]
1772
1773remove all menuBar(s)
1774
1775=item [swap]
1776
1777swap top two menuBars
1778
1779=item [prev]
1780
1781access the previous menuBar
1782
1783=item [next]
1784
1785access the next menuBar
1786
1787=item [show]
1788
1789map menuBar
1790
1791=item [hide]
1792
1793unmap menuBar
1794
1795=item [pixmap;file]
1796
1797=item [pixmap;file;scaling]
1798
1799set a background pixmap
1800
1801=item [read:file]
1802
1803=item [read:file;name]
1804
1805read in a menu from a file
1806
1807=item [dump]
1808
1809dump out all menuBars to /tmp/rxvt-PID
1810
1811=item /
1812
1813access menuBar top level
1814
1815=item ./
1816
1817=item ../
1818
1819=item ../../
1820
1821access current or parent menu level
1822
1823=item /path/menu
1824
1825add/access menu
1826
1827=item /path/{-}
1828
1829add separator
1830
1831=item /path/{item}{rtext} action
1832
1833add/alter menu item
1834
1835=item -/*
1836
1837remove all menus from the menuBar
1838
1839=item -/path/menu
1840
1841remove menu items, separators and submenus from menu
1842
1843=item -/path/menu
1844
1845remove menu
1846
1847=item -/path/{item}
1848
1849remove item
1850
1851=item -/path/{-}
1852
1853remove separator
1854
1855=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1856
1857menu quick arrows
1858
1859=back
1860X<XPM>
1861 1853
1862=head1 XPM 1854=head1 XPM
1863 1855
1864For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1856For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1865of B<< C<Pt> >> can be the name of the background pixmap followed by a 1857of B<< C<Pt> >> can be the name of the background pixmap followed by a
1963=begin table 1955=begin table
1964 1956
1965 4 Shift 1957 4 Shift
1966 8 Meta 1958 8 Meta
1967 16 Control 1959 16 Control
1968 32 Double Click I<(Rxvt extension)> 1960 32 Double Click I<(rxvt extension)>
1969 1961
1970=end table 1962=end table
1971 1963
1972Col = B<< C<< <x> - SPACE >> >> 1964Col = B<< C<< <x> - SPACE >> >>
1973 1965
2050=end table 2042=end table
2051 2043
2052=head1 CONFIGURE OPTIONS 2044=head1 CONFIGURE OPTIONS
2053 2045
2054General hint: if you get compile errors, then likely your configuration 2046General hint: if you get compile errors, then likely your configuration
2055hasn't been tested well. Either try with --enable-everything or use the 2047hasn't been tested well. Either try with C<--enable-everything> or use
2056./reconf script as a base for experiments. ./reconf is used by myself, 2048the F<./reconf> script as a base for experiments. F<./reconf> is used by
2057so it should generally be a working config. Of course, you should always 2049myself, so it should generally be a working config. Of course, you should
2058report when a combination doesn't work, so it can be fixed. Marc Lehmann 2050always report when a combination doesn't work, so it can be fixed. Marc
2059<rxvt@schmorp.de>. 2051Lehmann <rxvt@schmorp.de>.
2052
2053All
2060 2054
2061=over 4 2055=over 4
2062 2056
2063=item --enable-everything 2057=item --enable-everything
2064 2058
2065Add support for all non-multichoice options listed in "./configure 2059Add (or remove) support for all non-multichoice options listed in "./configure
2066--help". Note that unlike other enable options this is order dependant. 2060--help".
2061
2067You can specify this and then disable options which this enables by 2062You can specify this and then disable options you do not like by
2068I<following> this with the appropriate commands. 2063I<following> this with the appropriate C<--disable-...> arguments,
2064or you can start with a minimal configuration by specifying
2065C<--disable-everything> and than adding just the C<--enable-...> arguments
2066you want.
2069 2067
2070=item --enable-xft 2068=item --enable-xft (default: enabled)
2071 2069
2072Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2070Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2073slower and require lots of memory, but as long as you don't use them, you 2071slower and require lots of memory, but as long as you don't use them, you
2074don't pay for them. 2072don't pay for them.
2075 2073
2076=item --enable-font-styles 2074=item --enable-font-styles (default: on)
2077 2075
2078Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2076Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2079styles. The fonts can be set manually or automatically. 2077styles. The fonts can be set manually or automatically.
2080 2078
2081=item --with-codesets=NAME,... 2079=item --with-codesets=NAME,... (default: all)
2082 2080
2083Compile in support for additional codeset (encoding) groups (eu, vn are 2081Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2084always compiled in, which includes most 8-bit character sets). These 2082are always compiled in, which includes most 8-bit character sets). These
2085codeset tables are currently only used for driving X11 core fonts, they 2083codeset tables are used for driving X11 core fonts, they are not required
2086are not required for Xft fonts. Compiling them in will make your binary 2084for Xft fonts, although having them compiled in lets rxvt-unicode choose
2087bigger (together about 700kB), but it doesn't increase memory usage unless 2085replacement fonts more intelligently. Compiling them in will make your
2086binary bigger (all of together cost about 700kB), but it doesn't increase
2088you use an X11 font requiring one of these encodings. 2087memory usage unless you use a font requiring one of these encodings.
2089 2088
2090=begin table 2089=begin table
2091 2090
2092 all all available codeset groups 2091 all all available codeset groups
2093 zh common chinese encodings 2092 zh common chinese encodings
2096 jp_ext rarely used but big japanese encodings 2095 jp_ext rarely used but big japanese encodings
2097 kr korean encodings 2096 kr korean encodings
2098 2097
2099=end table 2098=end table
2100 2099
2101=item --enable-xim 2100=item --enable-xim (default: on)
2102 2101
2103Add support for XIM (X Input Method) protocol. This allows using 2102Add support for XIM (X Input Method) protocol. This allows using
2104alternative input methods (e.g. kinput2) and will also correctly 2103alternative input methods (e.g. kinput2) and will also correctly
2105set up the input for people using dead keys or compose keys. 2104set up the input for people using dead keys or compose keys.
2106 2105
2107=item --enable-unicode3 2106=item --enable-unicode3 (default: off)
2107
2108Recommended to stay off unless you really need non-BMP characters.
2108 2109
2109Enable direct support for displaying unicode codepoints above 2110Enable direct support for displaying unicode codepoints above
211065535 (the basic multilingual page). This increases storage 211165535 (the basic multilingual page). This increases storage
2111requirements per character from 2 to 4 bytes. X11 fonts do not yet 2112requirements per character from 2 to 4 bytes. X11 fonts do not yet
2112support these extra characters, but Xft does. 2113support these extra characters, but Xft does.
2115even without this flag, but the number of such characters is 2116even without this flag, but the number of such characters is
2116limited to a view thousand (shared with combining characters, 2117limited to a view thousand (shared with combining characters,
2117see next switch), and right now rxvt-unicode cannot display them 2118see next switch), and right now rxvt-unicode cannot display them
2118(input/output and cut&paste still work, though). 2119(input/output and cut&paste still work, though).
2119 2120
2120=item --enable-combining 2121=item --enable-combining (default: on)
2121 2122
2122Enable automatic composition of combining characters into 2123Enable automatic composition of combining characters into
2123composite characters. This is required for proper viewing of text 2124composite characters. This is required for proper viewing of text
2124where accents are encoded as seperate unicode characters. This is 2125where accents are encoded as seperate unicode characters. This is
2125done by using precomposited characters when available or creating 2126done by using precomposited characters when available or creating
2126new pseudo-characters when no precomposed form exists. 2127new pseudo-characters when no precomposed form exists.
2127 2128
2128Without --enable-unicode3, the number of additional precomposed 2129Without --enable-unicode3, the number of additional precomposed
2129characters is rather limited (2048, if this is full, rxvt will use the 2130characters is somewhat limited (the 6400 private use characters will be
2130private use area, extending the number of combinations to 8448). With 2131(ab-)used). With --enable-unicode3, no practical limit exists.
2131--enable-unicode3, no practical limit exists. This will also enable 2132
2132storage of characters >65535. 2133This option will also enable storage (but not display) of characters
2134beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2133 2135
2134The combining table also contains entries for arabic presentation forms, 2136The combining table also contains entries for arabic presentation forms,
2135but these are not currently used. Bug me if you want these to be used. 2137but these are not currently used. Bug me if you want these to be used (and
2138tell me how these are to be used...).
2136 2139
2137=item --enable-fallback(=CLASS) 2140=item --enable-fallback(=CLASS) (default: Rxvt)
2138 2141
2139When reading resource settings, also read settings for class CLASS 2142When reading resource settings, also read settings for class CLASS. To
2140(default: Rxvt). To disable resource fallback use --disable-fallback. 2143disable resource fallback use --disable-fallback.
2141 2144
2142=item --with-res-name=NAME 2145=item --with-res-name=NAME (default: urxvt)
2143 2146
2144Use the given name (default: urxvt) as default application name when 2147Use the given name as default application name when
2145reading resources. Specify --with-res-name=rxvt to replace rxvt. 2148reading resources. Specify --with-res-name=rxvt to replace rxvt.
2146 2149
2147=item --with-res-class=CLASS 2150=item --with-res-class=CLASS /default: URxvt)
2148 2151
2149Use the given class (default: URxvt) as default application class 2152Use the given class as default application class
2150when reading resources. Specify --with-res-class=Rxvt to replace 2153when reading resources. Specify --with-res-class=Rxvt to replace
2151rxvt. 2154rxvt.
2152 2155
2153=item --enable-utmp 2156=item --enable-utmp (default: on)
2154 2157
2155Write user and tty to utmp file (used by programs like F<w>) at 2158Write user and tty to utmp file (used by programs like F<w>) at
2156start of rxvt execution and delete information when rxvt exits. 2159start of rxvt execution and delete information when rxvt exits.
2157 2160
2158=item --enable-wtmp 2161=item --enable-wtmp (default: on)
2159 2162
2160Write user and tty to wtmp file (used by programs like F<last>) at 2163Write user and tty to wtmp file (used by programs like F<last>) at
2161start of rxvt execution and write logout when rxvt exits. This 2164start of rxvt execution and write logout when rxvt exits. This
2162option requires --enable-utmp to also be specified. 2165option requires --enable-utmp to also be specified.
2163 2166
2164=item --enable-lastlog 2167=item --enable-lastlog (default: on)
2165 2168
2166Write user and tty to lastlog file (used by programs like 2169Write user and tty to lastlog file (used by programs like
2167F<lastlogin>) at start of rxvt execution. This option requires 2170F<lastlogin>) at start of rxvt execution. This option requires
2168--enable-utmp to also be specified. 2171--enable-utmp to also be specified.
2169 2172
2170=item --enable-xpm-background 2173=item --enable-xpm-background (default: on)
2171 2174
2172Add support for XPM background pixmaps. 2175Add support for XPM background pixmaps.
2173 2176
2174=item --enable-transparency 2177=item --enable-transparency (default: on)
2175 2178
2176Add support for inheriting parent backgrounds thus giving a fake 2179Add support for inheriting parent backgrounds thus giving a fake
2177transparency to the term. 2180transparency to the term.
2178 2181
2179=item --enable-fading 2182=item --enable-fading (default: on)
2180 2183
2181Add support for fading the text when focus is lost. 2184Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2182 2185
2183=item --enable-tinting 2186=item --enable-tinting (default: on)
2184 2187
2185Add support for tinting of transparent backgrounds. 2188Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2186 2189
2187=item --enable-menubar
2188
2189Add support for our menu bar system (this interacts badly with
2190dynamic locale switching currently).
2191
2192=item --enable-rxvt-scroll 2190=item --enable-rxvt-scroll (default: on)
2193 2191
2194Add support for the original rxvt scrollbar. 2192Add support for the original rxvt scrollbar.
2195 2193
2196=item --enable-next-scroll 2194=item --enable-next-scroll (default: on)
2197 2195
2198Add support for a NeXT-like scrollbar. 2196Add support for a NeXT-like scrollbar.
2199 2197
2200=item --enable-xterm-scroll 2198=item --enable-xterm-scroll (default: on)
2201 2199
2202Add support for an Xterm-like scrollbar. 2200Add support for an Xterm-like scrollbar.
2203 2201
2204=item --enable-plain-scroll 2202=item --enable-plain-scroll (default: on)
2205 2203
2206Add support for a very unobtrusive, plain-looking scrollbar that 2204Add support for a very unobtrusive, plain-looking scrollbar that
2207is the favourite of the rxvt-unicode author, having used it for 2205is the favourite of the rxvt-unicode author, having used it for
2208many years. 2206many years.
2209 2207
2210=item --enable-half-shadow 2208=item --enable-ttygid (default: off)
2211
2212Make shadows on the scrollbar only half the normal width & height.
2213only applicable to rxvt scrollbars.
2214
2215=item --enable-ttygid
2216 2209
2217Change tty device setting to group "tty" - only use this if 2210Change tty device setting to group "tty" - only use this if
2218your system uses this type of security. 2211your system uses this type of security.
2219 2212
2220=item --disable-backspace-key 2213=item --disable-backspace-key
2221 2214
2222Disable any handling of the backspace key by us - let the X server 2215Removes any handling of the backspace key by us - let the X server do it.
2216
2217=item --disable-delete-key
2218
2219Removes any handling of the delete key by us - let the X server
2223do it. 2220do it.
2224 2221
2225=item --disable-delete-key
2226
2227Disable any handling of the delete key by us - let the X server
2228do it.
2229
2230=item --disable-resources 2222=item --disable-resources
2231 2223
2232Remove all resources checking. 2224Removes any support for resource checking.
2233
2234=item --enable-xgetdefault
2235
2236Make resources checking via XGetDefault() instead of our small
2237version which only checks ~/.Xdefaults, or if that doesn't exist
2238then ~/.Xresources.
2239
2240=item --enable-strings
2241
2242Add support for our possibly faster memset() function and other
2243various routines, overriding your system's versions which may
2244have been hand-crafted in assembly or may require extra libraries
2245to link in. (this breaks ANSI-C rules and has problems on many
2246GNU/Linux systems).
2247 2225
2248=item --disable-swapscreen 2226=item --disable-swapscreen
2249 2227
2250Remove support for swap screen. 2228Remove support for secondary/swap screen.
2251 2229
2252=item --enable-frills 2230=item --enable-frills (default: on)
2253 2231
2254Add support for many small features that are not essential but nice to 2232Add support for many small features that are not essential but nice to
2255have. Normally you want this, but for very small binaries you may want to 2233have. Normally you want this, but for very small binaries you may want to
2256disable this. 2234disable this.
2257 2235
2258A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2236A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2259in combination with other switches) is: 2237in combination with other switches) is:
2260 2238
2261 MWM-hints 2239 MWM-hints
2240 EWMH-hints (pid, utf8 names) and protocols (ping)
2262 seperate underline colour 2241 seperate underline colour (-underlineColor)
2263 settable border widths and borderless switch 2242 settable border widths and borderless switch (-w, -b, -bl)
2243 visual depth selection (-depth)
2264 settable extra linespacing 2244 settable extra linespacing /-lsp)
2265 extra window properties (e.g. UTF-8 window names and PID)
2266 iso-14755-2 and -3, and visual feedback 2245 iso-14755-2 and -3, and visual feedback
2246 tripleclickwords (-tcw)
2247 settable insecure mode (-insecure)
2248 keysym remapping support
2249 cursor blinking and underline cursor (-cb, -uc)
2250 XEmbed support (-embed)
2251 user-pty (-pty-fd)
2252 hold on exit (-hold)
2253 skip builtin block graphics (-sbg)
2254
2255It also enabled some non-essential features otherwise disabled, such as:
2256
2257 some round-trip time optimisations
2258 nearest color allocation on pseudocolor screens
2259 UTF8_STRING supporr for selection
2260 sgr modes 90..97 and 100..107
2267 backindex and forwardindex escape sequence 2261 backindex and forwardindex escape sequences
2262 view change/zero scorllback esacpe sequences
2263 locale switching escape sequence
2268 window op and locale change escape sequences 2264 window op and some xterm/OSC escape sequences
2269 tripleclickwords 2265 rectangular selections
2270 settable insecure mode 2266 trailing space removal for selections
2267 verbose X error handling
2271 2268
2272=item --enable-iso14755 2269=item --enable-iso14755 (default: on)
2273 2270
2274Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2271Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2275F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2272F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2276C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2273C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2277this switch. 2274this switch.
2278 2275
2279=item --enable-keepscrolling 2276=item --enable-keepscrolling (default: on)
2280 2277
2281Add support for continual scrolling of the display when you hold 2278Add support for continual scrolling of the display when you hold
2282the mouse button down on a scrollbar arrow. 2279the mouse button down on a scrollbar arrow.
2283 2280
2284=item --enable-mousewheel 2281=item --enable-mousewheel (default: on)
2285 2282
2286Add support for scrolling via mouse wheel or buttons 4 & 5. 2283Add support for scrolling via mouse wheel or buttons 4 & 5.
2287 2284
2288=item --enable-slipwheeling 2285=item --enable-slipwheeling (default: on)
2289 2286
2290Add support for continual scrolling (using the mouse wheel as an 2287Add support for continual scrolling (using the mouse wheel as an
2291accelerator) while the control key is held down. This option 2288accelerator) while the control key is held down. This option
2292requires --enable-mousewheel to also be specified. 2289requires --enable-mousewheel to also be specified.
2293 2290
2294=item --disable-new-selection 2291=item --disable-new-selection
2295 2292
2296Remove support for mouse selection style like that of xterm. 2293Remove support for mouse selection style like that of xterm.
2297 2294
2298=item --enable-dmalloc 2295=item --enable-dmalloc (default: off)
2299 2296
2300Use Gray Watson's malloc - which is good for debugging See 2297Use Gray Watson's malloc - which is good for debugging See
2301http://www.letters.com/dmalloc/ for details If you use either this or the 2298L<http://www.letters.com/dmalloc/> for details If you use either this or the
2302next option, you may need to edit src/Makefile after compiling to point 2299next option, you may need to edit src/Makefile after compiling to point
2303DINCLUDE and DLIB to the right places. 2300DINCLUDE and DLIB to the right places.
2304 2301
2305You can only use either this option and the following (should 2302You can only use either this option and the following (should
2306you use either) . 2303you use either) .
2307 2304
2308=item --enable-dlmalloc 2305=item --enable-dlmalloc (default: off)
2309 2306
2310Use Doug Lea's malloc - which is good for a production version 2307Use Doug Lea's malloc - which is good for a production version
2311See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2308See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2312 2309
2313=item --enable-smart-resize 2310=item --enable-smart-resize (default: on)
2314 2311
2315Add smart growth/shrink behaviour when changing font size via from hot 2312Add smart growth/shrink behaviour when changing font size via hot
2316keys. This should keep in a fixed position the rxvt corner which is 2313keys. This should keep the window corner which is closest to a corner of
2317closest to a corner of the screen. 2314the screen in a fixed position.
2318 2315
2319=item --enable-cursor-blink
2320
2321Add support for a blinking cursor.
2322
2323=item --enable-pointer-blank 2316=item --enable-pointer-blank (default: on)
2324 2317
2325Add support to have the pointer disappear when typing or inactive. 2318Add support to have the pointer disappear when typing or inactive.
2326 2319
2327=item --with-name=NAME 2320=item --enable-perl (default: on)
2328 2321
2322Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2323manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2324in F<src/perl-ext/> for the extensions that are installed by default. The
2325perl interpreter that is used can be specified via the C<PERL> environment
2326variable when running configure.
2327
2328=item --with-name=NAME (default: urxvt)
2329
2329Set the basename for the installed binaries (default: C<urxvt>, resulting 2330Set the basename for the installed binaries, resulting
2330in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2331in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2331C<rxvt>. 2332C<rxvt>.
2332 2333
2333=item --with-term=NAME 2334=item --with-term=NAME (default: rxvt-unicode)
2334 2335
2335Change the environmental variable for the terminal to NAME (default 2336Change the environmental variable for the terminal to NAME.
2336C<rxvt-unicode>)
2337 2337
2338=item --with-terminfo=PATH 2338=item --with-terminfo=PATH
2339 2339
2340Change the environmental variable for the path to the terminfo tree to 2340Change the environmental variable for the path to the terminfo tree to
2341PATH. 2341PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines