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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines