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.29 by root, Wed Dec 29 19:17:18 2004 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 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://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
5=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
6 28
7=over 4
8 29
30=head2 Meta, Features & Commandline Issues
31
32=head3 My question isn't answered here, can I ask a human?
33
34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
49
50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
51
52Beginning with version 7.3, there is a perl extension that implements a
53simple tabbed terminal. It is installed by default, so any of these should
54give you tabs:
55
56 @@URXVT_NAME@@ -pe tabbed
57
58 URxvt.perl-ext-common: default,tabbed
59
60It will also work fine with tabbing functionality of many window managers
61or similar tabbing programs, and its embedding-features allow it to be
62embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
63the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
64(murxvt) terminal as an example embedding application.
65
9=item How do I know which rxvt-unicode version I'm using? 66=head3 How do I know which rxvt-unicode version I'm using?
10 67
11The version number is displayed with the usage (-h). Also the escape 68The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 69sequence C<ESC [ 8 n> sets the window title to the version number. When
70using the @@URXVT_NAME@@c client, the version displayed is that of the
71daemon.
13 72
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 How can I configure rxvt-unicode so that it looks similar to the original rxvt?
72
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
74behave similar to the original rxvt:
75
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
78
79=item Rxvt-unicode does not seem to understand the selected encoding?
80
81=item Unicode does not seem to work?
82
83If you encounter strange problems like typing an accented character but
84getting two unrelated other characters or similar, or if program output is
85subtly garbled, then you should check your locale settings.
86
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to
90sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91
92The best thing is to fix your startup environment, as you will likely run
93into other problems. If nothing works you can try this in your .profile.
94
95 printf '\e]701;%s\007' "$LC_CTYPE"
96
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like:
100
101 locale: Cannot set LC_CTYPE to default locale: ...
102
103Then the locale you specified is not supported on your system.
104
105If nothing works and you are sure that everything is set correctly then
106you will need to remember a little known fact: Some programs just don't
107support locales :(
108
109=item Why do some characters look so much different than others?
110
111=item How does rxvt-unicode choose fonts?
112
113Most fonts do not contain the full range of Unicode, which is
114fine. Chances are that the font you (or the admin/package maintainer of
115your system/os) have specified does not cover all the characters you want
116to display.
117
118B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence
122to detect that a specific glyph is wrong: it has to believe the font that
123the characters it contains indeed look correct.
124
125In that case, select a font of your taste and add it to the font list,
126e.g.:
127
128 @@RXVT_NAME@@ -fn basefont,font2,font3...
129
130When rxvt-unicode sees a character, it will first look at the base
131font. If the base font does not contain the character, it will go to the
132next font, and so on. Specifying your own fonts will also speed up this
133search and use less resources within rxvt-unicode and the X-server.
134
135The only limitation is that all the fonts must not be larger than the base
136font, as the base font defines the principal cell size, which must be the
137same due to the way terminals work.
138
139=item Why do some chinese characters look so different than others?
140
141This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output
143is, as it only knows the unicode character codes. If rxvt-unicode
144first sees a japanese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese
146characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font
148-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese.
150
151The workaround is easy: just tag a chinese font at the end of your font
152list (see the previous question). The key is to view the font list as
153a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first.
155
156In the future it might be possible to switch preferences at runtime (the
157internal data structure has no problem with using different fonts for
158the same character at the same time, but no interface for this has been
159designed yet).
160
161=item Why does rxvt-unicode sometimes leave pixel droppings?
162
163Most fonts were not designed for terminal use, which means that character
164size varies a lot. A font that is otherwise fine for terminal use might
165contain some characters that are simply too wide. Rxvt-unicode will avoid
166these characters. For characters that are just "a bit" too wide a special
167"careful" rendering mode is used that redraws adjacent characters.
168
169All of this requires that fonts do not lie about character sizes,
170however: Xft fonts often draw glyphs larger than their acclaimed bounding
171box, and rxvt-unicode has no way of detecting this (the correct way is to
172ask for the character bounding box, which unfortunately is wrong in these
173cases).
174
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or
176the respective font. If you encounter this problem there is no way to work
177around this except by using a different font.
178
179All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct.
181
182=item My Compose (Multi_key) key is no longer working.
183
184The most common causes for this are that either your locale is not set
185correctly, or you specified a B<preeditStyle> that is not supported by
186your input method. For example, if you specified B<OverTheSpot> and
187your input method (e.g. the default input method handling Compose keys)
188does not support this (for instance because it is not visual), then
189rxvt-unicode will continue without an input method.
190
191In this case either do not specify a B<preeditStyle> or specify more than
192one pre-edit style, such as B<OverTheSpot,Root,None>.
193
194=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
195
196Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
197international keyboards) or simply use ISO 14755 support to your
198advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
199codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
200character and so on.
201
202=item How can I keep rxvt-unicode from using reverse video so much?
203
204First of all, make sure you are running with the right terminfo
205(C<urxvt>), which will get rid of most of these effects. Then make sure
206you have specified colours for italic and bold, as otherwise rxvt-unicode
207might use reverse video to simulate the effect:
208
209 URxvt*colorBD: white
210 URxvt*colorIT: green
211
212=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
213
214For some unexplainable reason, some programs (i.e. irssi) assume a very
215weird colour palette when confronted with a terminal with more than the
216standard 8 colours (rxvt-unicode supports 88). The right fix is, of
217course, to fix these programs not to assume non-ISO colours without very
218good reasons.
219
220In the meantime, you can either edit your C<urxvt> terminfo definition to
221only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
222but keep you from using other rxvt-unicode features.
223
224=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
225
226Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
227in your compile environment, or an implementation that implements it,
228wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
229B<wchar_t> is represented as unicode.
230
231As you might have guessed, FreeBSD does neither define this symobl nor
232does it support it. Instead, it uses it's own internal representation of
233B<wchar_t>. This is, of course, completely legal.
234
235However, C<__STDC_ISO_10646__> is the only sane way to support
236multi-language apps in an OS, as using a locale-dependent (and
237non-standardized) representation of B<wchar_t> makes it impossible to
238convert between B<wchar_t> (as used by X11 and your applications) and any
239other encoding without implementing OS-specific-wrappers for each and
240every locale. There simply are no APIs to convert B<wchar_t> into anything
241except the current locale encoding.
242
243Some applications (such as the formidable B<mlterm>) work around this
244by carrying their own replacement functions for character set handling
245with them, and either implementing OS-dependent hacks or doing multiple
246conversions (which is slow and unreliable in case the OS implements
247encodings slightly different than the terminal emulator).
248
249The rxvt-unicode author insists that the right way to fix this is in the
250system libraries once and for all, instead of forcing every app to carry
251complete replacements.
252
253=item How does rxvt-unicode determine the encoding to use?
254
255=item Is there an option to switch encodings?
256
257Unlike some other terminals, rxvt-unicode has no encoding switch, and no
258specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
259UTF-8 or any other encodings with respect to terminal I/O.
260
261The reasons is that there exists a perfectly fine mechanism for selecting
262the encoding, doing I/O and (most important) communicating this to all
263applications so everybody agrees on character properties such as width and
264code number. This mechanism is the I<locale>.
265
266Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
267programs doing the same (that is, most) will automatically agree in the
268interpretation of characters.
269
270Unfortunately, there is no system-independent way to select locales, nor
271is there a standard on how locale specifiers will look like.
272
273On most systems, the content of the C<LC_CTYPE> environment variable
274contains an arbitrary string which corresponds to an already-installed
275locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
276C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
277(i.e. C<de> or C<german>) are also common.
278
279Rxvt-unicode ignores all other locale categories, and except for
280the encoding, ignores country or language-specific settings,
281i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
282
283If you want to use a specific encoding you have to make sure you start
284rxvt-unicode with the correct C<LC_CTYPE> category.
285
286=item Can I switch locales at runtime?
287
288Yes, using an escape sequence. Try sth. like this, which sets
289rxvt-unicode's idea of C<LC_CTYPE>.
290
291 printf '\e]701;%s\007' ja_JP.SJIS
292
293See also the previous question.
294
295Sometimes this capability is rather handy when you want to work in one
296locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
297example, I use this script to start C<xjdic>, which first switches to a
298locale supported by xjdic and back later:
299
300 printf '\e]701;%s\007' ja_JP.SJIS
301 xjdic -js
302 printf '\e]701;%s\007' de_DE.UTF-8
303
304=item Can I switch the fonts at runtime?
305
306Yes, using an escape sequence. Try sth. like this, which has the same
307effect as using the C<-fn> switch, and takes effect immediately:
308
309 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
310
311This is useful if you e.g. work primarily with japanese (and prefer a
312japanese font), but you have to switch to chinese temporarily, where
313japanese fonts would only be in your way.
314
315You can think of this as a kind of manual ISO-2022 switching.
316
317=item Why do italic characters look as if clipped?
318
319Many fonts have difficulties with italic characters and hinting. For
320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
321Mono> completely fails in it's italic face. A workaround is to enable
322freetype autohinting, i.e. like this:
323
324 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
325 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
326
327=item My input method wants <some encoding> but I want UTF-8, what can I do?
328
329You can specify separate locales for the input method and the rest of the
330terminal, using the resource C<imlocale>:
331
332 URxvt*imlocale: ja_JP.EUC-JP
333
334Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
335use your input method. Please note, however, that you will not be able to
336input characters outside C<EUC-JP> in a normal way then, as your input
337method limits you.
338
339=item Rxvt-unicode uses gobs of memory, how can I reduce that? 73=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
340 74
341Rxvt-unicode tries to obey the rule of not charging you for sth. you 75Rxvt-unicode tries to obey the rule of not charging you for something you
342don't use. One thing you should try is to configure out all settings that 76don't use. One thing you should try is to configure out all settings that
343you don't need, for example, Xft support is a resource hog by design, 77you don't need, for example, Xft support is a resource hog by design,
344when used. Compiling it out ensures that no Xft font will be loaded 78when used. Compiling it out ensures that no Xft font will be loaded
345accidentally when rxvt-unicode tries to find a font for your characters. 79accidentally when rxvt-unicode tries to find a font for your characters.
346 80
3496 bytes per screen cell. For a 160x?? window this amounts to almost a 836 bytes per screen cell. For a 160x?? window this amounts to almost a
350kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 84kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
351use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 85use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
352rxvt-unicode then uses 8 bytes per screen cell. 86rxvt-unicode then uses 8 bytes per screen cell.
353 87
88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
89
90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
91display, create the listening socket and then fork.
92
93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
94
95If you want to start @@URXVT_NAME@@d automatically whenever you run
96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
97
98 #!/bin/sh
99 @@URXVT_NAME@@c "$@"
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
102 @@URXVT_NAME@@c "$@"
103 fi
104
105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon.
109
110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
111
112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
113so you can check and see if that is set. Note that several programs, JED,
114slrn, Midnight Commander automatically check this variable to decide
115whether or not to use color.
116
117=head3 How do I set the correct, full IP address for the DISPLAY variable?
118
119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
120insecure mode then it is possible to use the following shell script
121snippets to correctly set the display. If your version of rxvt-unicode
122wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
123the COLORTERM variable can be used to distinguish rxvt-unicode from a
124regular xterm.
125
126Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
127snippets:
128
129 # Bourne/Korn/POSIX family of shells:
130 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
131 if [ ${TERM:-foo} = xterm ]; then
132 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
133 echo -n '^[Z'
134 read term_id
135 stty icanon echo
136 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
137 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
138 read DISPLAY # set it in our local shell
139 fi
140 fi
141
142=head3 How do I compile the manual pages on my own?
143
144You need to have a recent version of perl installed as F</usr/bin/perl>,
145one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
146F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
147
148=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
149
150I often get asked about this, and I think, no, they didn't cause extra
151bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
152that the urxvt binary is larger (due to some encoding tables always being
153compiled in), but it actually uses less memory (RSS) after startup. Even
154with C<--disable-everything>, this comparison is a bit unfair, as many
155features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
156already in use in this mode.
157
158 text data bss drs rss filename
159 98398 1664 24 15695 1824 rxvt --disable-everything
160 188985 9048 66616 18222 1788 urxvt --disable-everything
161
162When you C<--enable-everything> (which I<is> unfair, as this involves xft
163and full locale/XIM support which are quite bloaty inside libX11 and my
164libc), the two diverge, but not unreasonably so.
165
166 text data bss drs rss filename
167 163431 2152 24 20123 2060 rxvt --enable-everything
168 1035683 49680 66648 29096 3680 urxvt --enable-everything
169
170The very large size of the text section is explained by the east-asian
171encoding tables, which, if unused, take up disk space but nothing else
172and can be compiled out unless you rely on X11 core fonts that use those
173encodings. The BSS size comes from the 64k emergency buffer that my c++
174compiler allocates (but of course doesn't use unless you are out of
175memory). Also, using an xft font instead of a core font immediately adds a
176few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
177not used.
178
179Of course, due to every character using two or four bytes instead of one,
180a large scrollback buffer will ultimately make rxvt-unicode use more
181memory.
182
183Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
184still fares rather well. And compared to some monsters like gnome-terminal
185(21152k + extra 4204k in separate processes) or konsole (22200k + extra
18643180k in daemons that stay around after exit, plus half a minute of
187startup time, including the hundreds of warnings it spits out), it fares
188extremely well *g*.
189
190=head3 Why C++, isn't that unportable/bloated/uncool?
191
192Is this a question? :) It comes up very often. The simple answer is: I had
193to write it, and C++ allowed me to write and maintain it in a fraction
194of the time and effort (which is a scarce resource for me). Put even
195shorter: It simply wouldn't exist without C++.
196
197My personal stance on this is that C++ is less portable than C, but in
198the case of rxvt-unicode this hardly matters, as its portability limits
199are defined by things like X11, pseudo terminals, locale support and unix
200domain sockets, which are all less portable than C++ itself.
201
202Regarding the bloat, see the above question: It's easy to write programs
203in C that use gobs of memory, an certainly possible to write programs in
204C++ that don't. C++ also often comes with large libraries, but this is
205not necessarily the case with GCC. Here is what rxvt links against on my
206system with a minimal config:
207
208 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
209 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
210 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
211 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
212
213And here is rxvt-unicode:
214
215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
220
221No large bloated libraries (of course, none were linked in statically),
222except maybe libX11 :)
223
224
225=head2 Rendering, Font & Look and Feel Issues
226
227=head3 I can't get transparency working, what am I doing wrong?
228
229First of all, please address all transparency related issues to Sasha Vasko at
230sasha@aftercode.net and do not bug the author about it. Also, if you can't
231get it working consider it a rite of passage: ... and you failed.
232
233Here are four ways to get transparency. B<Do> read the manpage and option
234descriptions for the programs mentioned and rxvt-unicode. Really, do it!
235
2361. Use transparent mode:
237
238 Esetroot wallpaper.jpg
239 @@URXVT_NAME@@ -tr -tint red -sh 40
240
241That works. If you think it doesn't, you lack transparency and tinting
242support, or you are unable to read.
243
2442. Use a simple pixmap and emulate pseudo-transparency. This enables you
245to use effects other than tinting and shading: Just shade/tint/whatever
246your picture with gimp or any other tool:
247
248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
250
251That works. If you think it doesn't, you lack AfterImage support, or you
252are unable to read.
253
2543. Use an ARGB visual:
255
256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
257
258This requires XFT support, and the support of your X-server. If that
259doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
260there yet, no matter what they claim. Rxvt-Unicode contains the necessary
261bugfixes and workarounds for Xft and Xlib to make it work, but that
262doesn't mean that your WM has the required kludges in place.
263
2644. Use xcompmgr and let it do the job:
265
266 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
267 -set _NET_WM_WINDOW_OPACITY 0xc0000000
268
269Then click on a window you want to make transparent. Replace C<0xc0000000>
270by other values to change the degree of opacity. If it doesn't work and
271your server crashes, you got to keep the pieces.
272
273=head3 Why does rxvt-unicode sometimes leave pixel droppings?
274
275Most fonts were not designed for terminal use, which means that character
276size varies a lot. A font that is otherwise fine for terminal use might
277contain some characters that are simply too wide. Rxvt-unicode will avoid
278these characters. For characters that are just "a bit" too wide a special
279"careful" rendering mode is used that redraws adjacent characters.
280
281All of this requires that fonts do not lie about character sizes,
282however: Xft fonts often draw glyphs larger than their acclaimed bounding
283box, and rxvt-unicode has no way of detecting this (the correct way is to
284ask for the character bounding box, which unfortunately is wrong in these
285cases).
286
287It's not clear (to me at least), whether this is a bug in Xft, freetype,
288or the respective font. If you encounter this problem you might try using
289the C<-lsp> option to give the font more height. If that doesn't work, you
290might be forced to use a different font.
291
292All of this is not a problem when using X11 core fonts, as their bounding
293box data is correct.
294
295=head3 How can I keep rxvt-unicode from using reverse video so much?
296
297First of all, make sure you are running with the right terminal settings
298(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
299make sure you have specified colours for italic and bold, as otherwise
300rxvt-unicode might use reverse video to simulate the effect:
301
302 URxvt.colorBD: white
303 URxvt.colorIT: green
304
305=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
306
307For some unexplainable reason, some rare programs assume a very weird
308colour palette when confronted with a terminal with more than the standard
3098 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
310these programs not to assume non-ISO colours without very good reasons.
311
312In the meantime, you can either edit your C<rxvt-unicode> terminfo
313definition to only claim 8 colour support or use C<TERM=rxvt>, which will
314fix colours but keep you from using other rxvt-unicode features.
315
316=head3 Can I switch the fonts at runtime?
317
318Yes, using an escape sequence. Try something like this, which has the same
319effect as using the C<-fn> switch, and takes effect immediately:
320
321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
322
323This is useful if you e.g. work primarily with japanese (and prefer a
324japanese font), but you have to switch to chinese temporarily, where
325japanese fonts would only be in your way.
326
327You can think of this as a kind of manual ISO-2022 switching.
328
329=head3 Why do italic characters look as if clipped?
330
331Many fonts have difficulties with italic characters and hinting. For
332example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
333Mono> completely fails in its italic face. A workaround might be to
334enable freetype autohinting, i.e. like this:
335
336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
338
354=item Can I speed up Xft rendering somehow? 339=head3 Can I speed up Xft rendering somehow?
355 340
356Yes, the most obvious way to speed it up is to avoid Xft entirely, as 341Yes, the most obvious way to speed it up is to avoid Xft entirely, as
357it is simply slow. If you still want Xft fonts you might try to disable 342it is simply slow. If you still want Xft fonts you might try to disable
358antialiasing (by appending C<:antialiasing=false>), which saves lots of 343antialiasing (by appending C<:antialias=false>), which saves lots of
359memory and also speeds up rendering considerably. 344memory and also speeds up rendering considerably.
360 345
361=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 346=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
362 347
363Rxvt-unicode will use whatever you specify as a font. If it needs to 348Rxvt-unicode will use whatever you specify as a font. If it needs to
364fall back to it's default font search list it will prefer X11 core 349fall back to its default font search list it will prefer X11 core
365fonts, because they are small and fast, and then use Xft fonts. It has 350fonts, because they are small and fast, and then use Xft fonts. It has
366antialiasing disabled for most of them, because the author thinks they 351antialiasing disabled for most of them, because the author thinks they
367look best that way. 352look best that way.
368 353
369If you want antialiasing, you have to specify the fonts manually. 354If you want antialiasing, you have to specify the fonts manually.
370 355
371=item Mouse cut/paste suddenly no longer works.
372
373Make sure that mouse reporting is actually turned off since killing
374some editors prematurely may leave the mouse in mouse report mode. I've
375heard that tcsh may use mouse reporting unless it otherwise specified. A
376quick check is to see if cut/paste works when the Alt or Shift keys are
377depressed. See @@RXVT_NAME@@(7)
378
379=item What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
380 357
381If no bold colour is set via C<colorBD:>, bold will invert text using the 358If no bold colour is set via C<colorBD:>, bold will invert text using the
382standard foreground colour. 359standard foreground colour.
383 360
384For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
385text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
386colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
387ignored.
388 364
389On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
390foreground/background colors. 366foreground/background colors.
391 367
392color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
393 369
394color8-15 are the corresponding high-intensity colors. 370color8-15 are the corresponding high-intensity colors.
395 371
396=item I don't like the screen colors. How do I change them? 372=head3 I don't like the screen colors. How do I change them?
397 373
398You can change the screen colors at run-time using F<~/.Xdefaults> 374You can change the screen colors at run-time using F<~/.Xdefaults>
399resources (or as long-options). 375resources (or as long-options).
400 376
401Here are values that are supposed to resemble a VGA screen, 377Here are values that are supposed to resemble a VGA screen,
402including the murky brown that passes for low-intensity yellow: 378including the murky brown that passes for low-intensity yellow:
403 379
404 URxvt*color0: #000000 380 URxvt.color0: #000000
405 URxvt*color1: #A80000 381 URxvt.color1: #A80000
406 URxvt*color2: #00A800 382 URxvt.color2: #00A800
407 URxvt*color3: #A8A800 383 URxvt.color3: #A8A800
408 URxvt*color4: #0000A8 384 URxvt.color4: #0000A8
409 URxvt*color5: #A800A8 385 URxvt.color5: #A800A8
410 URxvt*color6: #00A8A8 386 URxvt.color6: #00A8A8
411 URxvt*color7: #A8A8A8 387 URxvt.color7: #A8A8A8
412 388
413 URxvt*color8: #000054 389 URxvt.color8: #000054
414 URxvt*color9: #FF0054 390 URxvt.color9: #FF0054
415 URxvt*color10: #00FF54 391 URxvt.color10: #00FF54
416 URxvt*color11: #FFFF54 392 URxvt.color11: #FFFF54
417 URxvt*color12: #0000FF 393 URxvt.color12: #0000FF
418 URxvt*color13: #FF00FF 394 URxvt.color13: #FF00FF
419 URxvt*color14: #00FFFF 395 URxvt.color14: #00FFFF
420 URxvt*color15: #FFFFFF 396 URxvt.color15: #FFFFFF
421 397
422And here is a more complete set of non-standard colors described as 398And here is a more complete set of non-standard colors.
423"pretty girly":
424 399
425 URxvt.cursorColor: #dc74d1 400 URxvt.cursorColor: #dc74d1
426 URxvt.pointerColor: #dc74d1 401 URxvt.pointerColor: #dc74d1
427 URxvt.background: #0e0e0e 402 URxvt.background: #0e0e0e
428 URxvt.foreground: #4ad5e1 403 URxvt.foreground: #4ad5e1
439 URxvt.color6: #73f7ff 414 URxvt.color6: #73f7ff
440 URxvt.color14: #73f7ff 415 URxvt.color14: #73f7ff
441 URxvt.color7: #e1dddd 416 URxvt.color7: #e1dddd
442 URxvt.color15: #e1dddd 417 URxvt.color15: #e1dddd
443 418
419They have been described (not by me) as "pretty girly".
420
421=head3 Why do some characters look so much different than others?
422
423See next entry.
424
425=head3 How does rxvt-unicode choose fonts?
426
427Most fonts do not contain the full range of Unicode, which is
428fine. Chances are that the font you (or the admin/package maintainer of
429your system/os) have specified does not cover all the characters you want
430to display.
431
432B<rxvt-unicode> makes a best-effort try at finding a replacement
433font. Often the result is fine, but sometimes the chosen font looks
434bad/ugly/wrong. Some fonts have totally strange characters that don't
435resemble the correct glyph at all, and rxvt-unicode lacks the artificial
436intelligence to detect that a specific glyph is wrong: it has to believe
437the font that the characters it claims to contain indeed look correct.
438
439In that case, select a font of your taste and add it to the font list,
440e.g.:
441
442 @@URXVT_NAME@@ -fn basefont,font2,font3...
443
444When rxvt-unicode sees a character, it will first look at the base
445font. If the base font does not contain the character, it will go to the
446next font, and so on. Specifying your own fonts will also speed up this
447search and use less resources within rxvt-unicode and the X-server.
448
449The only limitation is that none of the fonts may be larger than the base
450font, as the base font defines the terminal character cell size, which
451must be the same due to the way terminals work.
452
453=head3 Why do some chinese characters look so different than others?
454
455This is because there is a difference between script and language --
456rxvt-unicode does not know which language the text that is output is,
457as it only knows the unicode character codes. If rxvt-unicode first
458sees a japanese/chinese character, it might choose a japanese font for
459display. Subsequent japanese characters will use that font. Now, many
460chinese characters aren't represented in japanese fonts, so when the first
461non-japanese character comes up, rxvt-unicode will look for a chinese font
462-- unfortunately at this point, it will still use the japanese font for
463chinese characters that are also in the japanese font.
464
465The workaround is easy: just tag a chinese font at the end of your font
466list (see the previous question). The key is to view the font list as
467a preference list: If you expect more japanese, list a japanese font
468first. If you expect more chinese, put a chinese font first.
469
470In the future it might be possible to switch language preferences at
471runtime (the internal data structure has no problem with using different
472fonts for the same character at the same time, but no interface for this
473has been designed yet).
474
475Until then, you might get away with switching fonts at runtime (see L<Can
476I switch the fonts at runtime?> later in this document).
477
478=head3 How can I make mplayer display video correctly?
479
480We are working on it, in the meantime, as a workaround, use something like:
481
482 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
483
484
485=head2 Keyboard, Mouse & User Interaction
486
487=head3 The new selection selects pieces that are too big, how can I select single words?
488
489If you want to select e.g. alphanumeric words, you can use the following
490setting:
491
492 URxvt.selection.pattern-0: ([[:word:]]+)
493
494If you click more than twice, the selection will be extended
495more and more.
496
497To get a selection that is very similar to the old code, try this pattern:
498
499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
500
501Please also note that the I<LeftClick Shift-LeftClick> combination also
502selects words like the old code.
503
504=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
505
506You can disable the perl extension completely by setting the
507B<perl-ext-common> resource to the empty string, which also keeps
508rxvt-unicode from initialising perl, saving memory.
509
510If you only want to disable specific features, you first have to
511identify which perl extension is responsible. For this, read the section
512B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
513example, to disable the B<selection-popup> and B<option-popup>, specify
514this B<perl-ext-common> resource:
515
516 URxvt.perl-ext-common: default,-selection-popup,-option-popup
517
518This will keep the default extensions, but disable the two popup
519extensions. Some extensions can also be configured, for example,
520scrollback search mode is triggered by B<M-s>. You can move it to any
521other combination either by setting the B<searchable-scrollback> resource:
522
523 URxvt.searchable-scrollback: CM-s
524
525=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
526
527See next entry.
528
529=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
530
531These are caused by the C<readline> perl extension. Under normal
532circumstances, it will move your cursor around when you click into the
533line that contains it. It tries hard not to do this at the wrong moment,
534but when running a program that doesn't parse cursor movements or in some
535cases during rlogin sessions, it fails to detect this properly.
536
537You can permanently switch this feature off by disabling the C<readline>
538extension:
539
540 URxvt.perl-ext-common: default,-readline
541
542=head3 My numerical keypad acts weird and generates differing output?
543
544Some Debian GNUL/Linux users seem to have this problem, although no
545specific details were reported so far. It is possible that this is caused
546by the wrong C<TERM> setting, although the details of whether and how
547this can happen are unknown, as C<TERM=rxvt> should offer a compatible
548keymap. See the answer to the previous question, and please report if that
549helped.
550
551=head3 My Compose (Multi_key) key is no longer working.
552
553The most common causes for this are that either your locale is not set
554correctly, or you specified a B<preeditStyle> that is not supported by
555your input method. For example, if you specified B<OverTheSpot> and
556your input method (e.g. the default input method handling Compose keys)
557does not support this (for instance because it is not visual), then
558rxvt-unicode will continue without an input method.
559
560In this case either do not specify a B<preeditStyle> or specify more than
561one pre-edit style, such as B<OverTheSpot,Root,None>.
562
563=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
564
565Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
566international keyboards) or simply use ISO 14755 support to your
567advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
568codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
569character and so on.
570
571=head3 Mouse cut/paste suddenly no longer works.
572
573Make sure that mouse reporting is actually turned off since killing
574some editors prematurely may leave the mouse in mouse report mode. I've
575heard that tcsh may use mouse reporting unless it otherwise specified. A
576quick check is to see if cut/paste works when the Alt or Shift keys are
577depressed.
578
444=item What's with the strange Backspace/Delete key behaviour? 579=head3 What's with the strange Backspace/Delete key behaviour?
445 580
446Assuming that the physical Backspace key corresponds to the 581Assuming that the physical Backspace key corresponds to the
447BackSpace keysym (not likely for Linux ... see the following 582Backspace keysym (not likely for Linux ... see the following
448question) there are two standard values that can be used for 583question) there are two standard values that can be used for
449Backspace: C<^H> and C<^?>. 584Backspace: C<^H> and C<^?>.
450 585
451Historically, either value is correct, but rxvt-unicode adopts the debian 586Historically, either value is correct, but rxvt-unicode adopts the debian
452policy of using C<^?> when unsure, because it's the one only only correct 587policy of using C<^?> when unsure, because it's the one and only correct
453choice :). 588choice :).
454 589
455Rxvt-unicode tries to inherit the current stty settings and uses the value 590Rxvt-unicode tries to inherit the current stty settings and uses the value
456of `erase' to guess the value for backspace. If rxvt-unicode wasn't 591of `erase' to guess the value for backspace. If rxvt-unicode wasn't
457started from a terminal (say, from a menu or by remote shell), then the 592started from a terminal (say, from a menu or by remote shell), then the
460 595
461For starting a new rxvt-unicode: 596For starting a new rxvt-unicode:
462 597
463 # use Backspace = ^H 598 # use Backspace = ^H
464 $ stty erase ^H 599 $ stty erase ^H
465 $ @@RXVT_NAME@@ 600 $ @@URXVT_NAME@@
466 601
467 # use Backspace = ^? 602 # use Backspace = ^?
468 $ stty erase ^? 603 $ stty erase ^?
469 $ @@RXVT_NAME@@ 604 $ @@URXVT_NAME@@
470 605
471Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 606Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
472 607
473For an existing rxvt-unicode: 608For an existing rxvt-unicode:
474 609
475 # use Backspace = ^H 610 # use Backspace = ^H
476 $ stty erase ^H 611 $ stty erase ^H
485properly reflects that. 620properly reflects that.
486 621
487The Delete key is a another casualty of the ill-defined Backspace problem. 622The Delete key is a another casualty of the ill-defined Backspace problem.
488To avoid confusion between the Backspace and Delete keys, the Delete 623To avoid confusion between the Backspace and Delete keys, the Delete
489key has been assigned an escape sequence to match the vt100 for Execute 624key has been assigned an escape sequence to match the vt100 for Execute
490(ESC[3~) and is in the supplied termcap/terminfo. 625(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
491 626
492Some other Backspace problems: 627Some other Backspace problems:
493 628
494some editors use termcap/terminfo, 629some editors use termcap/terminfo,
495some editors (vim I'm told) expect Backspace = ^H, 630some editors (vim I'm told) expect Backspace = ^H,
496GNU Emacs (and Emacs-like editors) use ^H for help. 631GNU Emacs (and Emacs-like editors) use ^H for help.
497 632
498Perhaps someday this will all be resolved in a consistent manner. 633Perhaps someday this will all be resolved in a consistent manner.
499 634
500=item I don't like the key-bindings. How do I change them? 635=head3 I don't like the key-bindings. How do I change them?
501 636
502There are some compile-time selections available via configure. Unless 637There are some compile-time selections available via configure. Unless
503you have run "configure" with the C<--disable-resources> option you can 638you have run "configure" with the C<--disable-resources> option you can
504use the `keysym' resource to alter the keystrings associated with keysym 639use the `keysym' resource to alter the keystrings associated with keysyms.
5050xFF00 - 0xFFFF (function, cursor keys, etc).
506 640
507Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' 641Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
508 642
509 !# ----- special uses ------: 643 URxvt.keysym.Home: \033[1~
510 ! tn3270 login, remap function and arrow keys. 644 URxvt.keysym.End: \033[4~
511 tn3270*font: *clean-bold-*-*--15-* 645 URxvt.keysym.C-apostrophe: \033<C-'>
646 URxvt.keysym.C-slash: \033<C-/>
647 URxvt.keysym.C-semicolon: \033<C-;>
648 URxvt.keysym.C-grave: \033<C-`>
649 URxvt.keysym.C-comma: \033<C-,>
650 URxvt.keysym.C-period: \033<C-.>
651 URxvt.keysym.C-0x60: \033<C-`>
652 URxvt.keysym.C-Tab: \033<C-Tab>
653 URxvt.keysym.C-Return: \033<C-Return>
654 URxvt.keysym.S-Return: \033<S-Return>
655 URxvt.keysym.S-space: \033<S-Space>
656 URxvt.keysym.M-Up: \033<M-Up>
657 URxvt.keysym.M-Down: \033<M-Down>
658 URxvt.keysym.M-Left: \033<M-Left>
659 URxvt.keysym.M-Right: \033<M-Right>
660 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
661 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
662 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
512 663
513 ! keysym - used by rxvt only 664See some more examples in the documentation for the B<keysym> resource.
514 ! Delete - ^D
515 tn3270*keysym.0xFFFF: \004
516 665
517 ! Home - ^A 666=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
518 tn3270*keysym.0xFF50: \001
519 ! Left - ^B
520 tn3270*keysym.0xFF51: \002
521 ! Up - ^P
522 tn3270*keysym.0xFF52: \020
523 ! Right - ^F
524 tn3270*keysym.0xFF53: \006
525 ! Down - ^N
526 tn3270*keysym.0xFF54: \016
527 ! End - ^E
528 tn3270*keysym.0xFF57: \005
529
530 ! F1 - F12
531 tn3270*keysym.0xFFBE: \e1
532 tn3270*keysym.0xFFBF: \e2
533 tn3270*keysym.0xFFC0: \e3
534 tn3270*keysym.0xFFC1: \e4
535 tn3270*keysym.0xFFC2: \e5
536 tn3270*keysym.0xFFC3: \e6
537 tn3270*keysym.0xFFC4: \e7
538 tn3270*keysym.0xFFC5: \e8
539 tn3270*keysym.0xFFC6: \e9
540 tn3270*keysym.0xFFC7: \e0
541 tn3270*keysym.0xFFC8: \e-
542 tn3270*keysym.0xFFC9: \e=
543
544 ! map Prior/Next to F7/F8
545 tn3270*keysym.0xFF55: \e7
546 tn3270*keysym.0xFF56: \e8
547
548=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
549How do I make use of them? For example, the Sun Keyboard type 4
550has the following mappings that rxvt-unicode doesn't recognize.
551 667
552 KP_Insert == Insert 668 KP_Insert == Insert
553 F22 == Print 669 F22 == Print
554 F27 == Home 670 F27 == Home
555 F29 == Prior 671 F29 == Prior
556 F33 == End 672 F33 == End
557 F35 == Next 673 F35 == Next
558 674
559Rather than have rxvt-unicode try to accommodate all the various possible keyboard 675Rather than have rxvt-unicode try to accommodate all the various possible
560mappings, it is better to use `xmodmap' to remap the keys as required for 676keyboard mappings, it is better to use `xmodmap' to remap the keys as
561your particular machine. 677required for your particular machine.
562 678
563=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
564I need this to decide about setting colors etc.
565 679
566rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 680=head2 Terminal Configuration
567check and see if that is set. Note that several programs, JED, slrn,
568Midnight Commander automatically check this variable to decide whether or
569not to use color.
570 681
571=item How do I set the correct, full IP address for the DISPLAY variable? 682=head3 Can I see a typical configuration?
572 683
573If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 684The default configuration tries to be xterm-like, which I don't like that
574insecure mode then it is possible to use the following shell script 685much, but it's least surprise to regular users.
575snippets to correctly set the display. If your version of rxvt-unicode
576wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
577the COLORTERM variable can be used to distinguish rxvt-unicode from a
578regular xterm.
579 686
580Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 687As a rxvt or rxvt-unicode user, you are practically supposed to invest
581snippets: 688time into customising your terminal. To get you started, here is the
689author's .Xdefaults entries, with comments on what they do. It's certainly
690not I<typical>, but what's typical...
582 691
583 # Bourne/Korn/POSIX family of shells: 692 URxvt.cutchars: "()*,<>[]{}|'
584 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 693 URxvt.print-pipe: cat >/tmp/xxx
585 if [ ${TERM:-foo} = xterm ]; then
586 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
587 echo -n '^[Z'
588 read term_id
589 stty icanon echo
590 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
591 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
592 read DISPLAY # set it in our local shell
593 fi
594 fi
595 694
596=item How do I compile the manual pages for myself? 695These are just for testing stuff.
597 696
598You need to have a recent version of perl installed as F</usr/bin/perl>, 697 URxvt.imLocale: ja_JP.UTF-8
599one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 698 URxvt.preeditType: OnTheSpot,None
600the doc subdirectory and enter C<make alldoc>.
601 699
602=item My question isn't answered here, can I ask a human? 700This tells rxvt-unicode to use a special locale when communicating with
701the X Input Method, and also tells it to only use the OnTheSpot pre-edit
702type, which requires the C<xim-onthespot> perl extension but rewards me
703with correct-looking fonts.
603 704
604Before sending me mail, you could go to IRC: C<irc.freenode.net>, 705 URxvt.perl-lib: /root/lib/urxvt
605channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 706 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
606interested in learning about new and exciting problems (but not FAQs :). 707 URxvt.selection.pattern-0: ( at .*? line \\d+)
708 URxvt.selection.pattern-1: ^(/[^:]+):\
709 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
710 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
711
712This is my perl configuration. The first two set the perl library
713directory and also tells urxvt to use a large number of extensions. I
714develop for myself mostly, so I actually use most of the extensions I
715write.
716
717The selection stuff mainly makes the selection perl-error-message aware
718and tells it to convert perl error messages into vi-commands to load the
719relevant file and go tot he error line number.
720
721 URxvt.scrollstyle: plain
722 URxvt.secondaryScroll: true
723
724As the documentation says: plain is the preferred scrollbar for the
725author. The C<secondaryScroll> configures urxvt to scroll in full-screen
726apps, like screen, so lines scrolled out of screen end up in urxvt's
727scrollback buffer.
728
729 URxvt.background: #000000
730 URxvt.foreground: gray90
731 URxvt.color7: gray90
732 URxvt.colorBD: #ffffff
733 URxvt.cursorColor: #e0e080
734 URxvt.throughColor: #8080f0
735 URxvt.highlightColor: #f0f0f0
736
737Some colours. Not sure which ones are being used or even non-defaults, but
738these are in my .Xdefaults. Most notably, they set foreground/background
739to light gray/black, and also make sure that the colour 7 matches the
740default foreground colour.
741
742 URxvt.underlineColor: yellow
743
744Another colour, makes underline lines look different. Sometimes hurts, but
745is mostly a nice effect.
746
747 URxvt.geometry: 154x36
748 URxvt.loginShell: false
749 URxvt.meta: ignore
750 URxvt.utmpInhibit: true
751
752Uh, well, should be mostly self-explanatory. By specifying some defaults
753manually, I can quickly switch them for testing.
754
755 URxvt.saveLines: 8192
756
757A large scrollback buffer is essential. Really.
758
759 URxvt.mapAlert: true
760
761The only case I use it is for my IRC window, which I like to keep
762iconified till people msg me (which beeps).
763
764 URxvt.visualBell: true
765
766The audible bell is often annoying, especially when in a crowd.
767
768 URxvt.insecure: true
769
770Please don't hack my mutt! Ooops...
771
772 URxvt.pastableTabs: false
773
774I once thought this is a great idea.
775
776 urxvt.font: 9x15bold,\
777 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
778 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
779 [codeset=JISX0208]xft:Kochi Gothic, \
780 xft:Bitstream Vera Sans Mono:autohint=true, \
781 xft:Code2000:antialias=false
782 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
783 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
784 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
785
786I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
787overwhelmed. A special note: the C<9x15bold> mentioned above is actually
788the version from XFree-3.3, as XFree-4 replaced it by a totally different
789font (different glyphs for C<;> and many other harmless characters),
790while the second font is actually the C<9x15bold> from XFree4/XOrg. The
791bold version has less chars than the medium version, so I use it for rare
792characters, too. When editing sources with vim, I use italic for comments
793and other stuff, which looks quite good with Bitstream Vera anti-aliased.
794
795Terminus is a quite bad font (many very wrong glyphs), but for most of my
796purposes, it works, and gives a different look, as my normal (Non-bold)
797font is already bold, and I want to see a difference between bold and
798normal fonts.
799
800Please note that I used the C<urxvt> instance name and not the C<URxvt>
801class name. Thats because I use different configs for different purposes,
802for example, my IRC window is started with C<-name IRC>, and uses these
803defaults:
804
805 IRC*title: IRC
806 IRC*geometry: 87x12+535+542
807 IRC*saveLines: 0
808 IRC*mapAlert: true
809 IRC*font: suxuseuro
810 IRC*boldFont: suxuseuro
811 IRC*colorBD: white
812 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
813 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
814
815C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
816sizes. C<suxuseuro> allows me to keep an eye (and actually read)
817stuff while keeping a very small window. If somebody pastes something
818complicated (e.g. japanese), I temporarily switch to a larger font.
819
820The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
821C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
822file for different hosts, for example, on ym main desktop, I use:
823
824 URxvt.keysym.C-M-q: command:\033[3;5;5t
825 URxvt.keysym.C-M-y: command:\033[3;5;606t
826 URxvt.keysym.C-M-e: command:\033[3;1605;5t
827 URxvt.keysym.C-M-c: command:\033[3;1605;606t
828 URxvt.keysym.C-M-p: perl:test
829
830The first for keysym definitions allow me to quickly bring some windows
831in the layout I like most. Ion users might start laughing but will stop
832immediately when I tell them that I use my own Fvwm2 module for much the
833same effect as Ion provides, and I only very rarely use the above key
834combinations :->
835
836=head3 Why doesn't rxvt-unicode read my resources?
837
838Well, why, indeed? It does, in a way very similar to other X
839applications. Most importantly, this means that if you or your OS loads
840resources into the X display (the right way to do it), rxvt-unicode will
841ignore any resource files in your home directory. It will only read
842F<$HOME/.Xdefaults> when no resources are attached to the display.
843
844If you have or use an F<$HOME/.Xresources> file, chances are that
845resources are loaded into your X-server. In this case, you have to
846re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
847
848Also consider the form resources have to use:
849
850 URxvt.resource: value
851
852If you want to use another form (there are lots of different ways of
853specifying resources), make sure you understand whether and why it
854works. If unsure, use the form above.
855
856=head3 When I log-in to another system it tells me about missing terminfo data?
857
858The terminal description used by rxvt-unicode is not as widely available
859as that for xterm, or even rxvt (for which the same problem often arises).
860
861The correct solution for this problem is to install the terminfo, this can
862be done by simply installing rxvt-unicode on the remote system as well
863(in case you have a nice package manager ready), or you can install the
864terminfo database manually like this (with ncurses infocmp. works as
865user and root):
866
867 REMOTE=remotesystem.domain
868 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
869
870One some systems you might need to set C<$TERMINFO> to the full path of
871F<$HOME/.terminfo> for this to work.
872
873If you cannot or do not want to do this, then you can simply set
874C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
875problems arising, which includes wrong keymapping, less and different
876colours and some refresh errors in fullscreen applications. It's a nice
877quick-and-dirty workaround for rare cases, though.
878
879If you always want to do this (and are fine with the consequences) you
880can either recompile rxvt-unicode with the desired TERM value or use a
881resource to set it:
882
883 URxvt.termName: rxvt
884
885If you don't plan to use B<rxvt> (quite common...) you could also replace
886the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
887
888=head3 nano fails with "Error opening terminal: rxvt-unicode"
889
890This exceptionally confusing and useless error message is printed by nano
891when it can't find the terminfo database. Nothing is wrong with your
892terminal, read the previous answer for a solution.
893
894=head3 C<tic> outputs some error when compiling the terminfo entry.
895
896Most likely it's the empty definition for C<enacs=>. Just replace it by
897C<enacs=\E[0@> and try again.
898
899=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
900
901See next entry.
902
903=head3 I need a termcap file entry.
904
905One reason you might want this is that some distributions or operating
906systems still compile some programs using the long-obsoleted termcap
907library (Fedora Core's bash is one example) and rely on a termcap entry
908for C<rxvt-unicode>.
909
910You could use rxvt's termcap entry with reasonable results in many cases.
911You can also create a termcap entry by using terminfo's infocmp program
912like this:
913
914 infocmp -C rxvt-unicode
915
916Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
917generated by the command above.
918
919=head3 Why does C<ls> no longer have coloured output?
920
921The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
922decide whether a terminal has colour, but uses its own configuration
923file. Needless to say, C<rxvt-unicode> is not in its default file (among
924with most other terminals supporting colour). Either add:
925
926 TERM rxvt-unicode
927
928to C</etc/DIR_COLORS> or simply add:
929
930 alias ls='ls --color=auto'
931
932to your C<.profile> or C<.bashrc>.
933
934=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
935
936See next entry.
937
938=head3 Why doesn't vim/emacs etc. make use of italic?
939
940See next entry.
941
942=head3 Why are the secondary screen-related options not working properly?
943
944Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
945distributions (most notably Debian GNU/Linux) break rxvt-unicode
946by setting C<TERM> to C<rxvt>, which doesn't have these extra
947features. Unfortunately, some of these (most notably, again, Debian
948GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
949file, so you will need to install it on your own (See the question B<When
950I log-in to another system it tells me about missing terminfo data?> on
951how to do this).
952
953
954=head2 Encoding / Locale / Input Method Issues
955
956=head3 Rxvt-unicode does not seem to understand the selected encoding?
957
958See next entry.
959
960=head3 Unicode does not seem to work?
961
962If you encounter strange problems like typing an accented character but
963getting two unrelated other characters or similar, or if program output is
964subtly garbled, then you should check your locale settings.
965
966Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
967programs running in it. Often rxvt-unicode is started in the C<C> locale,
968while the login script running within the rxvt-unicode window changes the
969locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970not going to work, and is the most common cause for problems.
971
972The best thing is to fix your startup environment, as you will likely run
973into other problems. If nothing works you can try this in your .profile.
974
975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
976
977If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
978supported on your systems. Some systems have a C<locale> command which
979displays this (also, C<perl -e0> can be used to check locale settings, as
980it will complain loudly if it cannot set the locale). If it displays something
981like:
982
983 locale: Cannot set LC_CTYPE to default locale: ...
984
985Then the locale you specified is not supported on your system.
986
987If nothing works and you are sure that everything is set correctly then
988you will need to remember a little known fact: Some programs just don't
989support locales :(
990
991=head3 How does rxvt-unicode determine the encoding to use?
992
993See next entry.
994
995=head3 Is there an option to switch encodings?
996
997Unlike some other terminals, rxvt-unicode has no encoding switch, and no
998specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
999UTF-8 or any other encodings with respect to terminal I/O.
1000
1001The reasons is that there exists a perfectly fine mechanism for selecting
1002the encoding, doing I/O and (most important) communicating this to all
1003applications so everybody agrees on character properties such as width
1004and code number. This mechanism is the I<locale>. Applications not using
1005that info will have problems (for example, C<xterm> gets the width of
1006characters wrong as it uses its own, locale-independent table under all
1007locales).
1008
1009Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1010programs doing the same (that is, most) will automatically agree in the
1011interpretation of characters.
1012
1013Unfortunately, there is no system-independent way to select locales, nor
1014is there a standard on how locale specifiers will look like.
1015
1016On most systems, the content of the C<LC_CTYPE> environment variable
1017contains an arbitrary string which corresponds to an already-installed
1018locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1019C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1020(i.e. C<de> or C<german>) are also common.
1021
1022Rxvt-unicode ignores all other locale categories, and except for
1023the encoding, ignores country or language-specific settings,
1024i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1025rxvt-unicode.
1026
1027If you want to use a specific encoding you have to make sure you start
1028rxvt-unicode with the correct C<LC_CTYPE> category.
1029
1030=head3 Can I switch locales at runtime?
1031
1032Yes, using an escape sequence. Try something like this, which sets
1033rxvt-unicode's idea of C<LC_CTYPE>.
1034
1035 printf '\33]701;%s\007' ja_JP.SJIS
1036
1037See also the previous answer.
1038
1039Sometimes this capability is rather handy when you want to work in
1040one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1041(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1042first switches to a locale supported by xjdic and back later:
1043
1044 printf '\33]701;%s\007' ja_JP.SJIS
1045 xjdic -js
1046 printf '\33]701;%s\007' de_DE.UTF-8
1047
1048You can also use xterm's C<luit> program, which usually works fine, except
1049for some locales where character width differs between program- and
1050rxvt-unicode-locales.
1051
1052=head3 I have problems getting my input method working.
1053
1054Try a search engine, as this is slightly different for every input method server.
1055
1056Here is a checklist:
1057
1058=over 4
1059
1060=item - Make sure your locale I<and> the imLocale are supported on your OS.
1061
1062Try C<locale -a> or check the documentation for your OS.
1063
1064=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1065
1066For example, B<kinput2> does not support UTF-8 locales, you should use
1067C<ja_JP.EUC-JP> or equivalent.
1068
1069=item - Make sure your XIM server is actually running.
1070
1071=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1072
1073When you want to use e.g. B<kinput2>, it must be set to
1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075method servers are running with this command:
1076
1077 xprop -root XIM_SERVERS
1078
1079=item
607 1080
608=back 1081=back
609 1082
610=head1 SYNOPSIS 1083=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
611 1084
612 # set a new font set 1085You can specify separate locales for the input method and the rest of the
613 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" 1086terminal, using the resource C<imlocale>:
614 1087
615 # change the locale and tell rxvt-unicode about it 1088 URxvt.imlocale: ja_JP.EUC-JP
616 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
617 1089
618 # set window title 1090Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
619 printf '\33]2;%s\007' "new window title" 1091use your input method. Please note, however, that, depending on your Xlib
1092version, you may not be able to input characters outside C<EUC-JP> in a
1093normal way then, as your input method limits you.
620 1094
621=head1 DESCRIPTION 1095=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1096
1097Unfortunately, this is unavoidable, as the XIM protocol is racy by
1098design. Applications can avoid some crashes at the expense of memory
1099leaks, and Input Methods can avoid some crashes by careful ordering at
1100exit time. B<kinput2> (and derived input methods) generally succeeds,
1101while B<SCIM> (or similar input methods) fails. In the end, however,
1102crashes cannot be completely avoided even if both sides cooperate.
1103
1104So the only workaround is not to kill your Input Method Servers.
1105
1106
1107=head2 Operating Systems / Package Maintaining
1108
1109=head3 I am using Debian GNU/Linux and have a problem...
1110
1111The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1112patches that considerably change the behaviour of rxvt-unicode (but
1113unfortunately this notice has been removed). Before reporting a bug to
1114the original rxvt-unicode author please download and install the genuine
1115version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1116the problem. If you cannot, chances are that the problems are specific to
1117Debian GNU/Linux, in which case it should be reported via the Debian Bug
1118Tracking System (use C<reportbug> to report the bug).
1119
1120For other problems that also affect the Debian package, you can and
1121probably should use the Debian BTS, too, because, after all, it's also a
1122bug in the Debian version and it serves as a reminder for other users that
1123might encounter the same issue.
1124
1125=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1126
1127You should build one binary with the default options. F<configure>
1128now enables most useful options, and the trend goes to making them
1129runtime-switchable, too, so there is usually no drawback to enabling them,
1130except higher disk and possibly memory usage. The perl interpreter should
1131be enabled, as important functionality (menus, selection, likely more in
1132the future) depends on it.
1133
1134You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1135system-wide (except maybe with C<defaults>). This will result in useful
1136behaviour. If your distribution aims at low memory, add an empty
1137C<perl-ext-common> resource to the app-defaults file. This will keep the
1138perl interpreter disabled until the user enables it.
1139
1140If you can/want build more binaries, I recommend building a minimal
1141one with C<--disable-everything> (very useful) and a maximal one with
1142C<--enable-everything> (less useful, it will be very big due to a lot of
1143encodings built-in that increase download times and are rarely used).
1144
1145=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1146
1147It should be, starting with release 7.1. You are encouraged to properly
1148install urxvt with privileges necessary for your OS now.
1149
1150When rxvt-unicode detects that it runs setuid or setgid, it will fork
1151into a helper process for privileged operations (pty handling on some
1152systems, utmp/wtmp/lastlog handling on others) and drop privileges
1153immediately. This is much safer than most other terminals that keep
1154privileges while running (but is more relevant to urxvt, as it contains
1155things as perl interpreters, which might be "helpful" to attackers).
1156
1157This forking is done as the very first within main(), which is very early
1158and reduces possible bugs to initialisation code run before main(), or
1159things like the dynamic loader of your system, which should result in very
1160little risk.
1161
1162=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1163
1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1165in your compile environment, or an implementation that implements it,
1166whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1167B<wchar_t> is represented as unicode.
1168
1169As you might have guessed, FreeBSD does neither define this symbol nor
1170does it support it. Instead, it uses its own internal representation of
1171B<wchar_t>. This is, of course, completely fine with respect to standards.
1172
1173However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1174C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1175
1176C<__STDC_ISO_10646__> is the only sane way to support multi-language
1177apps in an OS, as using a locale-dependent (and non-standardized)
1178representation of B<wchar_t> makes it impossible to convert between
1179B<wchar_t> (as used by X11 and your applications) and any other encoding
1180without implementing OS-specific-wrappers for each and every locale. There
1181simply are no APIs to convert B<wchar_t> into anything except the current
1182locale encoding.
1183
1184Some applications (such as the formidable B<mlterm>) work around this
1185by carrying their own replacement functions for character set handling
1186with them, and either implementing OS-dependent hacks or doing multiple
1187conversions (which is slow and unreliable in case the OS implements
1188encodings slightly different than the terminal emulator).
1189
1190The rxvt-unicode author insists that the right way to fix this is in the
1191system libraries once and for all, instead of forcing every app to carry
1192complete replacements for them :)
1193
1194=head3 How can I use rxvt-unicode under cygwin?
1195
1196rxvt-unicode should compile and run out of the box on cygwin, using
1197the X11 libraries that come with cygwin. libW11 emulation is no
1198longer supported (and makes no sense, either, as it only supported a
1199single font). I recommend starting the X-server in C<-multiwindow> or
1200C<-rootless> mode instead, which will result in similar look&feel as the
1201old libW11 emulation.
1202
1203At the time of this writing, cygwin didn't seem to support any multi-byte
1204encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1205to 8-bit encodings.
1206
1207=head3 Character widths are not correct.
1208
1209urxvt uses the system wcwidth function to know the information about
1210the width of characters, so on systems with incorrect locale data you
1211will likely get bad results. Two notorious examples are Solaris 9,
1212where single-width characters like U+2514 are reported as double-width,
1213and Darwin 8, where combining chars are reported having width 1.
1214
1215The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like
1217
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1219
1220=head3 I want 256 colors
1221
1222Are you sure you need 256 colors? 88 colors should be enough for most
1223purposes. If you really need more, there is an unsupported patch for
1224it in the doc directory, but please do not ask for it to be applied.
1225
1226=head1 RXVT-UNICODE TECHNICAL REFERENCE
622 1227
623The rest of this document describes various technical aspects of 1228The rest of this document describes various technical aspects of
624B<rxvt-unicode>. First the description of supported command sequences, 1229B<rxvt-unicode>. First the description of supported command sequences,
625followed by menu and pixmap support and last by a description of all 1230followed by pixmap support and last by a description of all features
626features selectable at C<configure> time. 1231selectable at C<configure> time.
627 1232
628=head1 RXVT TECHNICAL REFERENCE
629
630=head1 Definitions 1233=head2 Definitions
631 1234
632=over 4 1235=over 4
633 1236
634=item B<< C<c> >> 1237=item B<< C<c> >>
635 1238
653 1256
654A text parameter composed of printable characters. 1257A text parameter composed of printable characters.
655 1258
656=back 1259=back
657 1260
658=head1 Values 1261=head2 Values
659 1262
660=over 4 1263=over 4
661 1264
662=item B<< C<ENQ> >> 1265=item B<< C<ENQ> >>
663 1266
706 1309
707Space Character 1310Space Character
708 1311
709=back 1312=back
710 1313
711=head1 Escape Sequences 1314=head2 Escape Sequences
712 1315
713=over 4 1316=over 4
714 1317
715=item B<< C<ESC # 8> >> 1318=item B<< C<ESC # 8> >>
716 1319
762Single Shift Select of G3 Character Set (SS3): affects next character 1365Single Shift Select of G3 Character Set (SS3): affects next character
763only I<unimplemented> 1366only I<unimplemented>
764 1367
765=item B<< C<ESC Z> >> 1368=item B<< C<ESC Z> >>
766 1369
767Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1370Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
768 1371
769=item B<< C<ESC c> >> 1372=item B<< C<ESC c> >>
770 1373
771Full reset (RIS) 1374Full reset (RIS)
772 1375
776 1379
777=item B<< C<ESC o> >> 1380=item B<< C<ESC o> >>
778 1381
779Invoke the G3 Character Set (LS3) 1382Invoke the G3 Character Set (LS3)
780 1383
781=item B<< C<ESC> ( C> >> 1384=item B<< C<ESC ( C> >>
782 1385
783Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1386Designate G0 Character Set (ISO 2022), see below for values of C<C>.
784 1387
785=item B<< C<ESC> ) C> >> 1388=item B<< C<ESC ) C> >>
786 1389
787Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1390Designate G1 Character Set (ISO 2022), see below for values of C<C>.
788 1391
789=item B<< C<ESC * C> >> 1392=item B<< C<ESC * C> >>
790 1393
814 1417
815=back 1418=back
816 1419
817X<CSI> 1420X<CSI>
818 1421
819=head1 CSI (Command Sequence Introducer) Sequences 1422=head2 CSI (Command Sequence Introducer) Sequences
820 1423
821=over 4 1424=over 4
822 1425
823=item B<< C<ESC [ Ps @> >> 1426=item B<< C<ESC [ Ps @> >>
824 1427
879=begin table 1482=begin table
880 1483
881 B<< C<Ps = 0> >> Clear to Right (default) 1484 B<< C<Ps = 0> >> Clear to Right (default)
882 B<< C<Ps = 1> >> Clear to Left 1485 B<< C<Ps = 1> >> Clear to Left
883 B<< C<Ps = 2> >> Clear All 1486 B<< C<Ps = 2> >> Clear All
1487 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1488 (@@RXVT_NAME@@ extension)
884 1489
885=end table 1490=end table
886 1491
887=item B<< C<ESC [ Ps L> >> 1492=item B<< C<ESC [ Ps L> >>
888 1493
931 1536
932=item B<< C<ESC [ Ps c> >> 1537=item B<< C<ESC [ Ps c> >>
933 1538
934Send Device Attributes (DA) 1539Send Device Attributes (DA)
935B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1540B<< C<Ps = 0> >> (or omitted): request attributes from terminal
936returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1541returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
937Option'') 1542Option'')
938 1543
939=item B<< C<ESC [ Ps d> >> 1544=item B<< C<ESC [ Ps d> >>
940 1545
941Cursor to Line B<< C<Ps> >> (VPA) 1546Cursor to Line B<< C<Ps> >> (VPA)
1057 1662
1058=item B<< C<ESC [ s> >> 1663=item B<< C<ESC [ s> >>
1059 1664
1060Save Cursor (SC) 1665Save Cursor (SC)
1061 1666
1667=item B<< C<ESC [ Ps;Pt t> >>
1668
1669Window Operations
1670
1671=begin table
1672
1673 B<< C<Ps = 1> >> Deiconify (map) window
1674 B<< C<Ps = 2> >> Iconify window
1675 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1676 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1677 B<< C<Ps = 5> >> Raise window
1678 B<< C<Ps = 6> >> Lower window
1679 B<< C<Ps = 7> >> Refresh screen once
1680 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1681 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1682 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1683 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1684 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1685 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1686 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1687 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1688 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1689
1690=end table
1691
1692=item B<< C<ESC [ u> >>
1693
1694Restore Cursor
1695
1062=item B<< C<ESC [ Ps x> >> 1696=item B<< C<ESC [ Ps x> >>
1063 1697
1064Request Terminal Parameters (DECREQTPARM) 1698Request Terminal Parameters (DECREQTPARM)
1065 1699
1066=item B<< C<ESC [ u> >>
1067
1068Restore Cursor
1069
1070=back 1700=back
1071 1701
1072X<PrivateModes> 1702X<PrivateModes>
1073 1703
1074=head1 DEC Private Modes 1704=head2 DEC Private Modes
1075 1705
1076=over 4 1706=over 4
1077 1707
1078=item B<< C<ESC [ ? Pm h> >> 1708=item B<< C<ESC [ ? Pm h> >>
1079 1709
1095 1725
1096Toggle DEC Private Mode Values (rxvt extension). I<where> 1726Toggle DEC Private Mode Values (rxvt extension). I<where>
1097 1727
1098=over 4 1728=over 4
1099 1729
1100=item B<< C<Ps = 1> >> (DECCKM) 1730=item B<< C<Pm = 1> >> (DECCKM)
1101 1731
1102=begin table 1732=begin table
1103 1733
1104 B<< C<h> >> Application Cursor Keys 1734 B<< C<h> >> Application Cursor Keys
1105 B<< C<l> >> Normal Cursor Keys 1735 B<< C<l> >> Normal Cursor Keys
1106 1736
1107=end table 1737=end table
1108 1738
1109=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1739=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1110 1740
1111=begin table 1741=begin table
1112 1742
1113 B<< C<h> >> Enter VT52 mode 1743 B<< C<h> >> Enter VT52 mode
1114 B<< C<l> >> Enter VT52 mode 1744 B<< C<l> >> Enter VT52 mode
1115 1745
1116=end table 1746=end table
1117 1747
1118=item B<< C<Ps = 3> >> 1748=item B<< C<Pm = 3> >>
1119 1749
1120=begin table 1750=begin table
1121 1751
1122 B<< C<h> >> 132 Column Mode (DECCOLM) 1752 B<< C<h> >> 132 Column Mode (DECCOLM)
1123 B<< C<l> >> 80 Column Mode (DECCOLM) 1753 B<< C<l> >> 80 Column Mode (DECCOLM)
1124 1754
1125=end table 1755=end table
1126 1756
1127=item B<< C<Ps = 4> >> 1757=item B<< C<Pm = 4> >>
1128 1758
1129=begin table 1759=begin table
1130 1760
1131 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1132 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1133 1763
1134=end table 1764=end table
1135 1765
1136=item B<< C<Ps = 5> >> 1766=item B<< C<Pm = 5> >>
1137 1767
1138=begin table 1768=begin table
1139 1769
1140 B<< C<h> >> Reverse Video (DECSCNM) 1770 B<< C<h> >> Reverse Video (DECSCNM)
1141 B<< C<l> >> Normal Video (DECSCNM) 1771 B<< C<l> >> Normal Video (DECSCNM)
1142 1772
1143=end table 1773=end table
1144 1774
1145=item B<< C<Ps = 6> >> 1775=item B<< C<Pm = 6> >>
1146 1776
1147=begin table 1777=begin table
1148 1778
1149 B<< C<h> >> Origin Mode (DECOM) 1779 B<< C<h> >> Origin Mode (DECOM)
1150 B<< C<l> >> Normal Cursor Mode (DECOM) 1780 B<< C<l> >> Normal Cursor Mode (DECOM)
1151 1781
1152=end table 1782=end table
1153 1783
1154=item B<< C<Ps = 7> >> 1784=item B<< C<Pm = 7> >>
1155 1785
1156=begin table 1786=begin table
1157 1787
1158 B<< C<h> >> Wraparound Mode (DECAWM) 1788 B<< C<h> >> Wraparound Mode (DECAWM)
1159 B<< C<l> >> No Wraparound Mode (DECAWM) 1789 B<< C<l> >> No Wraparound Mode (DECAWM)
1160 1790
1161=end table 1791=end table
1162 1792
1163=item B<< C<Ps = 8> >> I<unimplemented> 1793=item B<< C<Pm = 8> >> I<unimplemented>
1164 1794
1165=begin table 1795=begin table
1166 1796
1167 B<< C<h> >> Auto-repeat Keys (DECARM) 1797 B<< C<h> >> Auto-repeat Keys (DECARM)
1168 B<< C<l> >> No Auto-repeat Keys (DECARM) 1798 B<< C<l> >> No Auto-repeat Keys (DECARM)
1169 1799
1170=end table 1800=end table
1171 1801
1172=item B<< C<Ps = 9> >> X10 XTerm 1802=item B<< C<Pm = 9> >> X10 XTerm
1173 1803
1174=begin table 1804=begin table
1175 1805
1176 B<< C<h> >> Send Mouse X & Y on button press. 1806 B<< C<h> >> Send Mouse X & Y on button press.
1177 B<< C<l> >> No mouse reporting. 1807 B<< C<l> >> No mouse reporting.
1178 1808
1179=end table 1809=end table
1180 1810
1181=item B<< C<Ps = 10> >> (B<rxvt>)
1182
1183=begin table
1184
1185 B<< C<h> >> menuBar visible
1186 B<< C<l> >> menuBar invisible
1187
1188=end table
1189
1190=item B<< C<Ps = 25> >> 1811=item B<< C<Pm = 25> >>
1191 1812
1192=begin table 1813=begin table
1193 1814
1194 B<< C<h> >> Visible cursor {cnorm/cvvis} 1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1195 B<< C<l> >> Invisible cursor {civis} 1816 B<< C<l> >> Invisible cursor {civis}
1196 1817
1197=end table 1818=end table
1198 1819
1199=item B<< C<Ps = 30> >> 1820=item B<< C<Pm = 30> >>
1200 1821
1201=begin table 1822=begin table
1202 1823
1203 B<< C<h> >> scrollBar visisble 1824 B<< C<h> >> scrollBar visible
1204 B<< C<l> >> scrollBar invisisble 1825 B<< C<l> >> scrollBar invisible
1205 1826
1206=end table 1827=end table
1207 1828
1208=item B<< C<Ps = 35> >> (B<rxvt>) 1829=item B<< C<Pm = 35> >> (B<rxvt>)
1209 1830
1210=begin table 1831=begin table
1211 1832
1212 B<< C<h> >> Allow XTerm Shift+key sequences 1833 B<< C<h> >> Allow XTerm Shift+key sequences
1213 B<< C<l> >> Disallow XTerm Shift+key sequences 1834 B<< C<l> >> Disallow XTerm Shift+key sequences
1214 1835
1215=end table 1836=end table
1216 1837
1217=item B<< C<Ps = 38> >> I<unimplemented> 1838=item B<< C<Pm = 38> >> I<unimplemented>
1218 1839
1219Enter Tektronix Mode (DECTEK) 1840Enter Tektronix Mode (DECTEK)
1220 1841
1221=item B<< C<Ps = 40> >> 1842=item B<< C<Pm = 40> >>
1222 1843
1223=begin table 1844=begin table
1224 1845
1225 B<< C<h> >> Allow 80/132 Mode 1846 B<< C<h> >> Allow 80/132 Mode
1226 B<< C<l> >> Disallow 80/132 Mode 1847 B<< C<l> >> Disallow 80/132 Mode
1227 1848
1228=end table 1849=end table
1229 1850
1230=item B<< C<Ps = 44> >> I<unimplemented> 1851=item B<< C<Pm = 44> >> I<unimplemented>
1231 1852
1232=begin table 1853=begin table
1233 1854
1234 B<< C<h> >> Turn On Margin Bell 1855 B<< C<h> >> Turn On Margin Bell
1235 B<< C<l> >> Turn Off Margin Bell 1856 B<< C<l> >> Turn Off Margin Bell
1236 1857
1237=end table 1858=end table
1238 1859
1239=item B<< C<Ps = 45> >> I<unimplemented> 1860=item B<< C<Pm = 45> >> I<unimplemented>
1240 1861
1241=begin table 1862=begin table
1242 1863
1243 B<< C<h> >> Reverse-wraparound Mode 1864 B<< C<h> >> Reverse-wraparound Mode
1244 B<< C<l> >> No Reverse-wraparound Mode 1865 B<< C<l> >> No Reverse-wraparound Mode
1245 1866
1246=end table 1867=end table
1247 1868
1248=item B<< C<Ps = 46> >> I<unimplemented> 1869=item B<< C<Pm = 46> >> I<unimplemented>
1249 1870
1250=item B<< C<Ps = 47> >> 1871=item B<< C<Pm = 47> >>
1251 1872
1252=begin table 1873=begin table
1253 1874
1254 B<< C<h> >> Use Alternate Screen Buffer 1875 B<< C<h> >> Use Alternate Screen Buffer
1255 B<< C<l> >> Use Normal Screen Buffer 1876 B<< C<l> >> Use Normal Screen Buffer
1256 1877
1257=end table 1878=end table
1258 1879
1259X<Priv66> 1880X<Priv66>
1260 1881
1261=item B<< C<Ps = 66> >> 1882=item B<< C<Pm = 66> >>
1262 1883
1263=begin table 1884=begin table
1264 1885
1265 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1266 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1267 1888
1268=end table 1889=end table
1269 1890
1270=item B<< C<Ps = 67> >> 1891=item B<< C<Pm = 67> >>
1271 1892
1272=begin table 1893=begin table
1273 1894
1274 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1275 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1276 1897
1277=end table 1898=end table
1278 1899
1279=item B<< C<Ps = 1000> >> (X11 XTerm) 1900=item B<< C<Pm = 1000> >> (X11 XTerm)
1280 1901
1281=begin table 1902=begin table
1282 1903
1283 B<< C<h> >> Send Mouse X & Y on button press and release. 1904 B<< C<h> >> Send Mouse X & Y on button press and release.
1284 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1285 1906
1286=end table 1907=end table
1287 1908
1288=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1909=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1289 1910
1290=begin table 1911=begin table
1291 1912
1292 B<< C<h> >> Use Hilite Mouse Tracking. 1913 B<< C<h> >> Use Hilite Mouse Tracking.
1293 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1294 1915
1295=end table 1916=end table
1296 1917
1918=item B<< C<Pm = 1002> >> (X11 XTerm)
1919
1920=begin table
1921
1922 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1923 B<< C<l> >> No mouse reporting.
1924
1925=end table
1926
1927=item B<< C<Pm = 1003> >> (X11 XTerm)
1928
1929=begin table
1930
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1932 B<< C<l> >> No mouse reporting.
1933
1934=end table
1935
1297=item B<< C<Ps = 1010> >> (B<rxvt>) 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
1298 1937
1299=begin table 1938=begin table
1300 1939
1301 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
1302 B<< C<l> >> Scroll to bottom on TTY output 1941 B<< C<l> >> Scroll to bottom on TTY output
1303 1942
1304=end table 1943=end table
1305 1944
1306=item B<< C<Ps = 1011> >> (B<rxvt>) 1945=item B<< C<Pm = 1011> >> (B<rxvt>)
1307 1946
1308=begin table 1947=begin table
1309 1948
1310 B<< C<h> >> Scroll to bottom when a key is pressed 1949 B<< C<h> >> Scroll to bottom when a key is pressed
1311 B<< C<l> >> Don't scroll to bottom when a key is pressed 1950 B<< C<l> >> Don't scroll to bottom when a key is pressed
1312 1951
1313=end table 1952=end table
1314 1953
1954=item B<< C<Pm = 1021> >> (B<rxvt>)
1955
1956=begin table
1957
1958 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1959 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1960
1961=end table
1962
1315=item B<< C<Ps = 1047> >> 1963=item B<< C<Pm = 1047> >>
1316 1964
1317=begin table 1965=begin table
1318 1966
1319 B<< C<h> >> Use Alternate Screen Buffer 1967 B<< C<h> >> Use Alternate Screen Buffer
1320 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1968 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1321 1969
1322=end table 1970=end table
1323 1971
1324=item B<< C<Ps = 1048> >> 1972=item B<< C<Pm = 1048> >>
1325 1973
1326=begin table 1974=begin table
1327 1975
1328 B<< C<h> >> Save cursor position 1976 B<< C<h> >> Save cursor position
1329 B<< C<l> >> Restore cursor position 1977 B<< C<l> >> Restore cursor position
1330 1978
1331=end table 1979=end table
1332 1980
1333=item B<< C<Ps = 1049> >> 1981=item B<< C<Pm = 1049> >>
1334 1982
1335=begin table 1983=begin table
1336 1984
1337 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1985 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1338 B<< C<l> >> Use Normal Screen Buffer 1986 B<< C<l> >> Use Normal Screen Buffer
1339 1987
1340=end table 1988=end table
1341 1989
1990=item B<< C<Pm = 2004> >>
1991
1992=begin table
1993
1994 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1995 B<< C<l> >> Disable bracketed paste mode
1996
1997=end table
1998
1342=back 1999=back
1343 2000
1344=back 2001=back
1345 2002
1346X<XTerm> 2003X<XTerm>
1347 2004
1348=head1 XTerm Operating System Commands 2005=head2 XTerm Operating System Commands
1349 2006
1350=over 4 2007=over 4
1351 2008
1352=item B<< C<ESC ] Ps;Pt ST> >> 2009=item B<< C<ESC ] Ps;Pt ST> >>
1353 2010
1360 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2017 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1361 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1362 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2019 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1363 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2020 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1364 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2021 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1365 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2022 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1366 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2023 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1367 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2024 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1368 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2025 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1369 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2026 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1370 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2027 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1371 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2028 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1372 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2029 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1373 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1374 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2031 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1375 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 2032 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1376 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> >> 2033 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> >>
1377 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2034 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1378 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) 2035 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).
1379 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 2036 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>.
1380 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2037 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1381 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 2038 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2039 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2040 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2041 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1382 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2042 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1383 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2043 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1384 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2044 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1385 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2045 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2046 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2047 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2048 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1386 2049
1387=end table 2050=end table
1388 2051
1389=back 2052=back
1390 2053
1391X<menuBar> 2054=head1 BACKGROUND IMAGE
1392 2055
1393=head1 menuBar
1394
1395B<< The exact syntax used is I<almost> solidified. >>
1396In the menus, B<DON'T> try to use menuBar commands that add or remove a
1397menuBar.
1398
1399Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1400omitted: use B<./> to specify a menu relative to the current menu.
1401
1402=head2 Overview of menuBar operation
1403
1404For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1405of C<Pt> can be used for a variety of tasks:
1406
1407At the top level is the current menuBar which is a member of a circular
1408linked-list of other such menuBars.
1409
1410The menuBar acts as a parent for the various drop-down menus, which in
1411turn, may have labels, separator lines, menuItems and subMenus.
1412
1413The menuItems are the useful bits: you can use them to mimic keyboard
1414input or even to send text or escape sequences back to rxvt.
1415
1416The menuBar syntax is intended to provide a simple yet robust method of
1417constructing and manipulating menus and navigating through the
1418menuBars.
1419
1420The first step is to use the tag B<< [menu:I<name>] >> which creates
1421the menuBar called I<name> and allows access. You may now or menus,
1422subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1423menuBar access as B<readonly> to prevent accidental corruption of the
1424menus. To re-access the current menuBar for alterations, use the tag
1425B<[menu]>, make the alterations and then use B<[done]>
1426
1427X<menuBarCommands>
1428
1429=head2 Commands
1430
1431=over 4
1432
1433=item B<< [menu:+I<name>] >>
1434
1435access the named menuBar for creation or alteration. If a new menuBar
1436is created, it is called I<name> (max of 15 chars) and the current
1437menuBar is pushed onto the stack
1438
1439=item B<[menu]>
1440
1441access the current menuBar for alteration
1442
1443=item B<< [title:+I<string>] >>
1444
1445set the current menuBar's title to I<string>, which may contain the
1446following format specifiers:
1447B<%%> : literal B<%> character
1448B<%n> : rxvt name (as per the B<-name> command-line option)
1449B<%v> : rxvt version
1450
1451=item B<[done]>
1452
1453set menuBar access as B<readonly>.
1454End-of-file tag for B<< [read:+I<file>] >> operations.
1455
1456=item B<< [read:+I<file>] >>
1457
1458read menu commands directly from I<file> (extension ".menu" will be
1459appended if required.) Start reading at a line with B<[menu]> or B<<
1460[menu:+I<name> >> and continuing until B<[done]> is encountered.
1461
1462Blank and comment lines (starting with B<#>) are ignored. Actually,
1463since any invalid menu commands are also ignored, almost anything could
1464be construed as a comment line, but this may be tightened up in the
1465future ... so don't count on it!.
1466
1467=item B<< [read:+I<file>;+I<name>] >>
1468
1469The same as B<< [read:+I<file>] >>, but start reading at a line with
1470B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1471B<[done]> is encountered.
1472
1473=item B<[dump]>
1474
1475dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1476later rereading.
1477
1478=item B<[rm:name]>
1479
1480remove the named menuBar
1481
1482=item B<[rm] [rm:]>
1483
1484remove the current menuBar
1485
1486=item B<[rm*] [rm:*]>
1487
1488remove all menuBars
1489
1490=item B<[swap]>
1491
1492swap the top two menuBars
1493
1494=item B<[prev]>
1495
1496access the previous menuBar
1497
1498=item B<[next]>
1499
1500access the next menuBar
1501
1502=item B<[show]>
1503
1504Enable display of the menuBar
1505
1506=item B<[hide]>
1507
1508Disable display of the menuBar
1509
1510=item B<< [pixmap:+I<name>] >>
1511
1512=item B<< [pixmap:+I<name>;I<scaling>] >>
1513
1514(set the background pixmap globally
1515
1516B<< A Future implementation I<may> make this local to the menubar >>)
1517
1518=item B<< [:+I<command>:] >>
1519
1520ignore the menu readonly status and issue a I<command> to or a menu or
1521menuitem or change the ; a useful shortcut for setting the quick arrows
1522from a menuBar.
1523
1524=back
1525
1526X<menuBarAdd>
1527
1528=head2 Adding and accessing menus
1529
1530The following commands may also be B<+> prefixed.
1531
1532=over 4
1533
1534=item B</+>
1535
1536access menuBar top level
1537
1538=item B<./+>
1539
1540access current menu level
1541
1542=item B<../+>
1543
1544access parent menu (1 level up)
1545
1546=item B<../../>
1547
1548access parent menu (multiple levels up)
1549
1550=item B<< I</path/>menu >>
1551
1552add/access menu
1553
1554=item B<< I</path/>menu/* >>
1555
1556add/access menu and clear it if it exists
1557
1558=item B<< I</path/>{-} >>
1559
1560add separator
1561
1562=item B<< I</path/>{item} >>
1563
1564add B<item> as a label
1565
1566=item B<< I</path/>{item} action >>
1567
1568add/alter I<menuitem> with an associated I<action>
1569
1570=item B<< I</path/>{item}{right-text} >>
1571
1572add/alter I<menuitem> with B<right-text> as the right-justified text
1573and as the associated I<action>
1574
1575=item B<< I</path/>{item}{rtext} action >>
1576
1577add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1578the right-justified text.
1579
1580=back
1581
1582=over 4
1583
1584=item Special characters in I<action> must be backslash-escaped:
1585
1586B<\a \b \E \e \n \r \t \octal>
1587
1588=item or in control-character notation:
1589
1590B<^@, ^A .. ^Z .. ^_, ^?>
1591
1592=back
1593
1594To send a string starting with a B<NUL> (B<^@>) character to the
1595program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1596the first of which will be stripped off and the balance directed to the
1597program. Otherwise if I<action> begins with B<NUL> followed by
1598non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1599balance is sent back to rxvt.
1600
1601As a convenience for the many Emacs-type editors, I<action> may start
1602with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1603appended if missed from B<M-x> commands.
1604
1605As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1606quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1607
1608=over 4
1609
1610=item For example,
1611
1612B<M-xapropos> is equivalent to B<\Exapropos\r>
1613
1614=item and
1615
1616B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1617
1618=back
1619
1620The option B<< {I<right-rtext>} >> will be right-justified. In the
1621absence of a specified action, this text will be used as the I<action>
1622as well.
1623
1624=over 4
1625
1626=item For example,
1627
1628B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1629
1630=back
1631
1632The left label I<is> necessary, since it's used for matching, but
1633implicitly hiding the left label (by using same name for both left and
1634right labels), or explicitly hiding the left label (by preceeding it
1635with a dot), makes it possible to have right-justified text only.
1636
1637=over 4
1638
1639=item For example,
1640
1641B</File/{Open}{Open} Open-File-Action>
1642
1643=item or hiding it
1644
1645B</File/{.anylabel}{Open} Open-File-Action>
1646
1647=back
1648
1649X<menuBarRemove>
1650
1651=head2 Removing menus
1652
1653=over 4
1654
1655=item B<< -/*+ >>
1656
1657remove all menus from the menuBar, the same as B<[clear]>
1658
1659=item B<< -+I</path>menu+ >>
1660
1661remove menu
1662
1663=item B<< -+I</path>{item}+ >>
1664
1665remove item
1666
1667=item B<< -+I</path>{-} >>
1668
1669remove separator)
1670
1671=item B<-/path/menu/*>
1672
1673remove all items, separators and submenus from menu
1674
1675=back
1676
1677X<menuBarArrows>
1678
1679=head2 Quick Arrows
1680
1681The menus also provide a hook for I<quick arrows> to provide easier
1682user access. If nothing has been explicitly set, the default is to
1683emulate the curror keys. The syntax permits each arrow to be altered
1684individually or all four at once without re-entering their common
1685beginning/end text. For example, to explicitly associate cursor actions
1686with the arrows, any of the following forms could be used:
1687
1688=over 4
1689
1690=item B<< <r>+I<Right> >>
1691
1692=item B<< <l>+I<Left> >>
1693
1694=item B<< <u>+I<Up> >>
1695
1696=item B<< <d>+I<Down> >>
1697
1698Define actions for the respective arrow buttons
1699
1700=item B<< <b>+I<Begin> >>
1701
1702=item B<< <e>+I<End> >>
1703
1704Define common beginning/end parts for I<quick arrows> which used in
1705conjunction with the above <r> <l> <u> <d> constructs
1706
1707=back
1708
1709=over 4
1710
1711=item For example, define arrows individually,
1712
1713 <u>\E[A
1714
1715 <d>\E[B
1716
1717 <r>\E[C
1718
1719 <l>\E[D
1720
1721=item or all at once
1722
1723 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1724
1725=item or more compactly (factoring out common parts)
1726
1727 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1728
1729=back
1730
1731X<menuBarSummary>
1732
1733=head2 Command Summary
1734
1735A short summary of the most I<common> commands:
1736
1737=over 4
1738
1739=item [menu:name]
1740
1741use an existing named menuBar or start a new one
1742
1743=item [menu]
1744
1745use the current menuBar
1746
1747=item [title:string]
1748
1749set menuBar title
1750
1751=item [done]
1752
1753set menu access to readonly and, if reading from a file, signal EOF
1754
1755=item [done:name]
1756
1757if reading from a file using [read:file;name] signal EOF
1758
1759=item [rm:name]
1760
1761remove named menuBar(s)
1762
1763=item [rm] [rm:]
1764
1765remove current menuBar
1766
1767=item [rm*] [rm:*]
1768
1769remove all menuBar(s)
1770
1771=item [swap]
1772
1773swap top two menuBars
1774
1775=item [prev]
1776
1777access the previous menuBar
1778
1779=item [next]
1780
1781access the next menuBar
1782
1783=item [show]
1784
1785map menuBar
1786
1787=item [hide]
1788
1789unmap menuBar
1790
1791=item [pixmap;file]
1792
1793=item [pixmap;file;scaling]
1794
1795set a background pixmap
1796
1797=item [read:file]
1798
1799=item [read:file;name]
1800
1801read in a menu from a file
1802
1803=item [dump]
1804
1805dump out all menuBars to /tmp/rxvt-PID
1806
1807=item /
1808
1809access menuBar top level
1810
1811=item ./
1812
1813=item ../
1814
1815=item ../../
1816
1817access current or parent menu level
1818
1819=item /path/menu
1820
1821add/access menu
1822
1823=item /path/{-}
1824
1825add separator
1826
1827=item /path/{item}{rtext} action
1828
1829add/alter menu item
1830
1831=item -/*
1832
1833remove all menus from the menuBar
1834
1835=item -/path/menu
1836
1837remove menu items, separators and submenus from menu
1838
1839=item -/path/menu
1840
1841remove menu
1842
1843=item -/path/{item}
1844
1845remove item
1846
1847=item -/path/{-}
1848
1849remove separator
1850
1851=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1852
1853menu quick arrows
1854
1855=back
1856X<XPM>
1857
1858=head1 XPM
1859
1860For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2056For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1861of B<< C<Pt> >> can be the name of the background pixmap followed by a 2057of B<< C<Pt> >> can be the name of the background image file followed by a
1862sequence of scaling/positioning commands separated by semi-colons. The 2058sequence of scaling/positioning commands separated by semi-colons. The
1863scaling/positioning commands are as follows: 2059scaling/positioning commands are as follows:
1864 2060
1865=over 4 2061=over 4
1866 2062
1904 2100
1905For example: 2101For example:
1906 2102
1907=over 4 2103=over 4
1908 2104
1909=item B<\E]20;funky\a> 2105=item B<\E]20;funky.jpg\a>
1910 2106
1911load B<funky.xpm> as a tiled image 2107load B<funky.jpg> as a tiled image
1912 2108
1913=item B<\E]20;mona;100\a> 2109=item B<\E]20;mona.jpg;100\a>
1914 2110
1915load B<mona.xpm> with a scaling of 100% 2111load B<mona.jpg> with a scaling of 100%
1916 2112
1917=item B<\E]20;;200;?\a> 2113=item B<\E]20;;200;?\a>
1918 2114
1919rescale the current pixmap to 200% and display the image geometry in 2115rescale the current pixmap to 200% and display the image geometry in
1920the title 2116the title
1921 2117
1922=back 2118=back
2119
1923X<Mouse> 2120X<Mouse>
1924 2121
1925=head1 Mouse Reporting 2122=head1 Mouse Reporting
1926 2123
1927=over 4 2124=over 4
1959=begin table 2156=begin table
1960 2157
1961 4 Shift 2158 4 Shift
1962 8 Meta 2159 8 Meta
1963 16 Control 2160 16 Control
1964 32 Double Click I<(Rxvt extension)> 2161 32 Double Click I<(rxvt extension)>
1965 2162
1966=end table 2163=end table
1967 2164
1968Col = B<< C<< <x> - SPACE >> >> 2165Col = B<< C<< <x> - SPACE >> >>
1969 2166
1970Row = B<< C<< <y> - SPACE >> >> 2167Row = B<< C<< <y> - SPACE >> >>
1971 2168
1972=back 2169=back
2170
2171=head1 Key Codes
2172
1973X<KeyCodes> 2173X<KeyCodes>
1974
1975=head1 Key Codes
1976 2174
1977Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1978 2176
1979For the keypad, use B<Shift> to temporarily override Application-Keypad 2177For the keypad, use B<Shift> to temporarily override Application-Keypad
1980setting use B<Num_Lock> to toggle Application-Keypad setting if 2178setting use B<Num_Lock> to toggle Application-Keypad setting if
2046=end table 2244=end table
2047 2245
2048=head1 CONFIGURE OPTIONS 2246=head1 CONFIGURE OPTIONS
2049 2247
2050General hint: if you get compile errors, then likely your configuration 2248General hint: if you get compile errors, then likely your configuration
2051hasn't been tested well. Either try with --enable-everything or use the 2249hasn't been tested well. Either try with C<--enable-everything> or use
2052./reconf script as a base for experiments. ./reconf is used by myself, 2250the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2053so it should generally be a working config. Of course, you should always 2251switches). Of course, you should always report when a combination doesn't
2054report when a combination doesn't work, so it can be fixed. Marc Lehmann 2252work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2055<rxvt@schmorp.de>. 2253
2254All
2056 2255
2057=over 4 2256=over 4
2058 2257
2059=item --enable-everything 2258=item --enable-everything
2060 2259
2061Add support for all non-multichoice options listed in "./configure 2260Add (or remove) support for all non-multichoice options listed in "./configure
2062--help". Note that unlike other enable options this is order dependant. 2261--help".
2262
2063You can specify this and then disable options which this enables by 2263You can specify this and then disable options you do not like by
2064I<following> this with the appropriate commands. 2264I<following> this with the appropriate C<--disable-...> arguments,
2265or you can start with a minimal configuration by specifying
2266C<--disable-everything> and than adding just the C<--enable-...> arguments
2267you want.
2065 2268
2066=item --enable-xft 2269=item --enable-xft (default: enabled)
2067 2270
2068Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2271Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2069slower and require lots of memory, but as long as you don't use them, you 2272slower and require lots of memory, but as long as you don't use them, you
2070don't pay for them. 2273don't pay for them.
2071 2274
2072=item --enable-font-styles 2275=item --enable-font-styles (default: on)
2073 2276
2074Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2277Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2075styles. The fonts can be set manually or automatically. 2278styles. The fonts can be set manually or automatically.
2076 2279
2077=item --with-codesets=NAME,... 2280=item --with-codesets=NAME,... (default: all)
2078 2281
2079Compile in support for additional codeset (encoding) groups (eu, vn are 2282Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2080always compiled in, which includes most 8-bit character sets). These 2283are always compiled in, which includes most 8-bit character sets). These
2081codeset tables are currently only used for driving X11 core fonts, they 2284codeset tables are used for driving X11 core fonts, they are not required
2082are not required for Xft fonts. Compiling them in will make your binary 2285for Xft fonts, although having them compiled in lets rxvt-unicode choose
2083bigger (together about 700kB), but it doesn't increase memory usage unless 2286replacement fonts more intelligently. Compiling them in will make your
2287binary bigger (all of together cost about 700kB), but it doesn't increase
2084you use an X11 font requiring one of these encodings. 2288memory usage unless you use a font requiring one of these encodings.
2085 2289
2086=begin table 2290=begin table
2087 2291
2088 all all available codeset groups 2292 all all available codeset groups
2089 zh common chinese encodings 2293 zh common chinese encodings
2090 zh_ext rarely used but very big chinese encodigs 2294 zh_ext rarely used but very big chinese encodings
2091 jp common japanese encodings 2295 jp common japanese encodings
2092 jp_ext rarely used but big japanese encodings 2296 jp_ext rarely used but big japanese encodings
2093 kr korean encodings 2297 kr korean encodings
2094 2298
2095=end table 2299=end table
2096 2300
2097=item --enable-xim 2301=item --enable-xim (default: on)
2098 2302
2099Add support for XIM (X Input Method) protocol. This allows using 2303Add support for XIM (X Input Method) protocol. This allows using
2100alternative input methods (e.g. kinput2) and will also correctly 2304alternative input methods (e.g. kinput2) and will also correctly
2101set up the input for people using dead keys or compose keys. 2305set up the input for people using dead keys or compose keys.
2102 2306
2103=item --enable-unicode3 2307=item --enable-unicode3 (default: off)
2308
2309Recommended to stay off unless you really need non-BMP characters.
2104 2310
2105Enable direct support for displaying unicode codepoints above 2311Enable direct support for displaying unicode codepoints above
210665535 (the basic multilingual page). This increases storage 231265535 (the basic multilingual page). This increases storage
2107requirements per character from 2 to 4 bytes. X11 fonts do not yet 2313requirements per character from 2 to 4 bytes. X11 fonts do not yet
2108support these extra characters, but Xft does. 2314support these extra characters, but Xft does.
2109 2315
2110Please note that rxvt-unicode can store unicode code points >65535 2316Please note that rxvt-unicode can store unicode code points >65535
2111even without this flag, but the number of such characters is 2317even without this flag, but the number of such characters is
2112limited to a view thousand (shared with combining characters, 2318limited to a few thousand (shared with combining characters,
2113see next switch), and right now rxvt-unicode cannot display them 2319see next switch), and right now rxvt-unicode cannot display them
2114(input/output and cut&paste still work, though). 2320(input/output and cut&paste still work, though).
2115 2321
2116=item --enable-combining 2322=item --enable-combining (default: on)
2117 2323
2118Enable automatic composition of combining characters into 2324Enable automatic composition of combining characters into
2119composite characters. This is required for proper viewing of text 2325composite characters. This is required for proper viewing of text
2120where accents are encoded as seperate unicode characters. This is 2326where accents are encoded as seperate unicode characters. This is
2121done by using precomposited characters when available or creating 2327done by using precomposited characters when available or creating
2122new pseudo-characters when no precomposed form exists. 2328new pseudo-characters when no precomposed form exists.
2123 2329
2124Without --enable-unicode3, the number of additional precomposed 2330Without --enable-unicode3, the number of additional precomposed
2125characters is rather limited (2048, if this is full, rxvt will use the 2331characters is somewhat limited (the 6400 private use characters will be
2126private use area, extending the number of combinations to 8448). With 2332(ab-)used). With --enable-unicode3, no practical limit exists.
2127--enable-unicode3, no practical limit exists. This will also enable 2333
2128storage of characters >65535. 2334This option will also enable storage (but not display) of characters
2335beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2129 2336
2130The combining table also contains entries for arabic presentation forms, 2337The combining table also contains entries for arabic presentation forms,
2131but these are not currently used. Bug me if you want these to be used. 2338but these are not currently used. Bug me if you want these to be used (and
2339tell me how these are to be used...).
2132 2340
2133=item --enable-fallback(=CLASS) 2341=item --enable-fallback(=CLASS) (default: Rxvt)
2134 2342
2135When reading resource settings, also read settings for class CLASS 2343When reading resource settings, also read settings for class CLASS. To
2136(default: Rxvt). To disable resource fallback use --disable-fallback. 2344disable resource fallback use --disable-fallback.
2137 2345
2138=item --with-res-name=NAME 2346=item --with-res-name=NAME (default: urxvt)
2139 2347
2140Use the given name (default: urxvt) as default application name when 2348Use the given name as default application name when
2141reading resources. Specify --with-res-name=rxvt to replace rxvt. 2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2142 2350
2143=item --with-res-class=CLASS 2351=item --with-res-class=CLASS (default: URxvt)
2144 2352
2145Use the given class (default: URxvt) as default application class 2353Use the given class as default application class
2146when reading resources. Specify --with-res-class=Rxvt to replace 2354when reading resources. Specify --with-res-class=Rxvt to replace
2147rxvt. 2355rxvt.
2148 2356
2149=item --enable-utmp 2357=item --enable-utmp (default: on)
2150 2358
2151Write user and tty to utmp file (used by programs like F<w>) at 2359Write user and tty to utmp file (used by programs like F<w>) at
2152start of rxvt execution and delete information when rxvt exits. 2360start of rxvt execution and delete information when rxvt exits.
2153 2361
2154=item --enable-wtmp 2362=item --enable-wtmp (default: on)
2155 2363
2156Write user and tty to wtmp file (used by programs like F<last>) at 2364Write user and tty to wtmp file (used by programs like F<last>) at
2157start of rxvt execution and write logout when rxvt exits. This 2365start of rxvt execution and write logout when rxvt exits. This
2158option requires --enable-utmp to also be specified. 2366option requires --enable-utmp to also be specified.
2159 2367
2160=item --enable-lastlog 2368=item --enable-lastlog (default: on)
2161 2369
2162Write user and tty to lastlog file (used by programs like 2370Write user and tty to lastlog file (used by programs like
2163F<lastlogin>) at start of rxvt execution. This option requires 2371F<lastlogin>) at start of rxvt execution. This option requires
2164--enable-utmp to also be specified. 2372--enable-utmp to also be specified.
2165 2373
2166=item --enable-xpm-background 2374=item --enable-afterimage (default: on)
2167 2375
2168Add support for XPM background pixmaps. 2376Add support for libAfterImage to be used for transparency and background
2377images. It adds support for many file formats including JPG, PNG,
2378SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2379(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2169 2380
2381This option also adds such eye candy as blending an image over the root
2382background, as well as dynamic scaling and bluring of background images.
2383
2384Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2385increase by a few megabytes even if no extra features are used (mostly due
2386to third-party libraries used by libAI). Memory footprint may somewhat be
2387lowered if libAfterImage is configured without support for SVG.
2388
2170=item --enable-transparency 2389=item --enable-transparency (default: on)
2171 2390
2172Add support for inheriting parent backgrounds thus giving a fake 2391Add support for backgrounds, creating illusion of transparency in the term.
2173transparency to the term.
2174 2392
2175=item --enable-fading 2393=item --enable-fading (default: on)
2176 2394
2177Add support for fading the text when focus is lost. 2395Add support for fading the text when focus is lost.
2178 2396
2179=item --enable-tinting
2180
2181Add support for tinting of transparent backgrounds.
2182
2183=item --enable-menubar
2184
2185Add support for our menu bar system (this interacts badly with
2186dynamic locale switching currently).
2187
2188=item --enable-rxvt-scroll 2397=item --enable-rxvt-scroll (default: on)
2189 2398
2190Add support for the original rxvt scrollbar. 2399Add support for the original rxvt scrollbar.
2191 2400
2192=item --enable-next-scroll 2401=item --enable-next-scroll (default: on)
2193 2402
2194Add support for a NeXT-like scrollbar. 2403Add support for a NeXT-like scrollbar.
2195 2404
2196=item --enable-xterm-scroll 2405=item --enable-xterm-scroll (default: on)
2197 2406
2198Add support for an Xterm-like scrollbar. 2407Add support for an Xterm-like scrollbar.
2199 2408
2200=item --enable-plain-scroll
2201
2202Add support for a very unobtrusive, plain-looking scrollbar that
2203is the favourite of the rxvt-unicode author, having used it for
2204many years.
2205
2206=item --enable-half-shadow
2207
2208Make shadows on the scrollbar only half the normal width & height.
2209only applicable to rxvt scrollbars.
2210
2211=item --enable-ttygid
2212
2213Change tty device setting to group "tty" - only use this if
2214your system uses this type of security.
2215
2216=item --disable-backspace-key 2409=item --disable-backspace-key
2217 2410
2218Disable any handling of the backspace key by us - let the X server 2411Removes any handling of the backspace key by us - let the X server do it.
2412
2413=item --disable-delete-key
2414
2415Removes any handling of the delete key by us - let the X server
2219do it. 2416do it.
2220 2417
2221=item --disable-delete-key
2222
2223Disable any handling of the delete key by us - let the X server
2224do it.
2225
2226=item --disable-resources 2418=item --disable-resources
2227 2419
2228Remove all resources checking. 2420Removes any support for resource checking.
2229
2230=item --enable-xgetdefault
2231
2232Make resources checking via XGetDefault() instead of our small
2233version which only checks ~/.Xdefaults, or if that doesn't exist
2234then ~/.Xresources.
2235
2236=item --enable-strings
2237
2238Add support for our possibly faster memset() function and other
2239various routines, overriding your system's versions which may
2240have been hand-crafted in assembly or may require extra libraries
2241to link in. (this breaks ANSI-C rules and has problems on many
2242GNU/Linux systems).
2243 2421
2244=item --disable-swapscreen 2422=item --disable-swapscreen
2245 2423
2246Remove support for swap screen. 2424Remove support for secondary/swap screen.
2247 2425
2248=item --enable-frills 2426=item --enable-frills (default: on)
2249 2427
2250Add support for many small features that are not essential but nice to 2428Add support for many small features that are not essential but nice to
2251have. Normally you want this, but for very small binaries you may want to 2429have. Normally you want this, but for very small binaries you may want to
2252disable this. 2430disable this.
2253 2431
2432A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2433in combination with other switches) is:
2434
2435 MWM-hints
2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint
2438 seperate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth)
2441 settable extra linespacing /-lsp)
2442 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure)
2445 keysym remapping support
2446 cursor blinking and underline cursor (-bc, -uc)
2447 XEmbed support (-embed)
2448 user-pty (-pty-fd)
2449 hold on exit (-hold)
2450 compile in built-in block graphics
2451 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc)
2453
2454It also enables some non-essential features otherwise disabled, such as:
2455
2456 some round-trip time optimisations
2457 nearest color allocation on pseudocolor screens
2458 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences
2462 locale switching escape sequence
2463 window op and some xterm/OSC escape sequences
2464 rectangular selections
2465 trailing space removal for selections
2466 verbose X error handling
2467
2254=item --enable-iso14755 2468=item --enable-iso14755 (default: on)
2255 2469
2256Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2257F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2258C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2472support for 5.2, 5.3 and 5.4 is enabled with this switch.
2259this switch.
2260 2473
2261=item --enable-linespace
2262
2263Add support to provide user specified line spacing between text rows.
2264
2265=item --enable-keepscrolling 2474=item --enable-keepscrolling (default: on)
2266 2475
2267Add support for continual scrolling of the display when you hold 2476Add support for continual scrolling of the display when you hold
2268the mouse button down on a scrollbar arrow. 2477the mouse button down on a scrollbar arrow.
2269 2478
2479=item --enable-selectionscrolling (default: on)
2480
2481Add support for scrolling when the selection moves to the top or
2482bottom of the screen.
2483
2270=item --enable-mousewheel 2484=item --enable-mousewheel (default: on)
2271 2485
2272Add support for scrolling via mouse wheel or buttons 4 & 5. 2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2273 2487
2274=item --enable-slipwheeling 2488=item --enable-slipwheeling (default: on)
2275 2489
2276Add support for continual scrolling (using the mouse wheel as an 2490Add support for continual scrolling (using the mouse wheel as an
2277accelerator) while the control key is held down. This option 2491accelerator) while the control key is held down. This option
2278requires --enable-mousewheel to also be specified. 2492requires --enable-mousewheel to also be specified.
2279 2493
2280=item --disable-new-selection
2281
2282Remove support for mouse selection style like that of xterm.
2283
2284=item --enable-dmalloc
2285
2286Use Gray Watson's malloc - which is good for debugging See
2287http://www.letters.com/dmalloc/ for details If you use either this or the
2288next option, you may need to edit src/Makefile after compiling to point
2289DINCLUDE and DLIB to the right places.
2290
2291You can only use either this option and the following (should
2292you use either) .
2293
2294=item --enable-dlmalloc
2295
2296Use Doug Lea's malloc - which is good for a production version
2297See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2298
2299=item --enable-smart-resize 2494=item --enable-smart-resize (default: off)
2300 2495
2301Add smart growth/shrink behaviour when changing font size via from hot 2496Add smart growth/shrink behaviour when resizing.
2302keys. This should keep in a fixed position the rxvt corner which is 2497This should keep the window corner which is closest to a corner of
2303closest to a corner of the screen. 2498the screen in a fixed position.
2304 2499
2305=item --enable-cursor-blink 2500=item --enable-text-blink (default: on)
2306 2501
2307Add support for a blinking cursor. 2502Add support for blinking text.
2308 2503
2309=item --enable-pointer-blank 2504=item --enable-pointer-blank (default: on)
2310 2505
2311Add support to have the pointer disappear when typing or inactive. 2506Add support to have the pointer disappear when typing or inactive.
2312 2507
2313=item --with-name=NAME 2508=item --enable-perl (default: on)
2314 2509
2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2511manpage for more info on this feature, or the files in F<src/perl/>
2512for the extensions that are installed by default.
2513The perl interpreter that is used can be specified via the C<PERL>
2514environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled
2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint.
2518
2519=item --with-afterimage-config=DIR
2520
2521Look for the libAfterImage config script in DIR.
2522
2523=item --with-name=NAME (default: urxvt)
2524
2315Set the basename for the installed binaries (default: urxvt, resulting in 2525Set the basename for the installed binaries, resulting
2316urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2526in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2527C<rxvt>.
2317 2528
2318=item --with-term=NAME 2529=item --with-term=NAME (default: rxvt-unicode)
2319 2530
2320Change the environmental variable for the terminal to NAME (default 2531Change the environmental variable for the terminal to NAME.
2321"rxvt")
2322 2532
2323=item --with-terminfo=PATH 2533=item --with-terminfo=PATH
2324 2534
2325Change the environmental variable for the path to the terminfo tree to 2535Change the environmental variable for the path to the terminfo tree to
2326PATH. 2536PATH.
2327 2537
2328=item --with-x 2538=item --with-x
2329 2539
2330Use the X Window System (pretty much default, eh?). 2540Use the X Window System (pretty much default, eh?).
2331
2332=item --with-xpm-includes=DIR
2333
2334Look for the XPM includes in DIR.
2335
2336=item --with-xpm-library=DIR
2337
2338Look for the XPM library in DIR.
2339
2340=item --with-xpm
2341
2342Not needed - define via --enable-xpm-background.
2343 2541
2344=back 2542=back
2345 2543
2346=head1 AUTHORS 2544=head1 AUTHORS
2347 2545

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines