ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.29 by root, Wed Dec 29 19:17:18 2004 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

1=head1 NAME 1=head1 NAME
2 2
3RXVT REFERENCE - FAQ, command sequences and other background information 3RXVT REFERENCE - FAQ, command sequences and other background information
4 4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
5=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
6 26
7=over 4 27=over 4
8 28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
68
69=item Isn't rxvt supposed to be small? Don't all those features bloat?
70
71I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73that the urxvt binary is larger (due to some encoding tables always being
74compiled in), but it actually uses less memory (RSS) after startup. Even
75with C<--disable-everything>, this comparison is a bit unfair, as many
76features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
77already in use in this mode.
78
79 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything
82
83When you C<--enable-everything> (which _is_ unfair, as this involves xft
84and full locale/XIM support which are quite bloaty inside libX11 and my
85libc), the two diverge, but not unreasnobaly so.
86
87 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything
90
91The very large size of the text section is explained by the east-asian
92encoding tables, which, if unused, take up disk space but nothing else
93and can be compiled out unless you rely on X11 core fonts that use those
94encodings. The BSS size comes from the 64k emergency buffer that my c++
95compiler allocates (but of course doesn't use unless you are out of
96memory). Also, using an xft font instead of a core font immediately adds a
97few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
98not used.
99
100Of course, due to every character using two or four bytes instead of one,
101a large scrollback buffer will ultimately make rxvt-unicode use more
102memory.
103
104Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
105still fares rather well. And compared to some monsters like gnome-terminal
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k in daemons that stay around after exit, plus half a minute of
108startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*.
110
111=item Why C++, isn't that unportable/bloated/uncool?
112
113Is this a question? :) It comes up very often. The simple answer is: I had
114to write it, and C++ allowed me to write and maintain it in a fraction
115of the time and effort (which is a scarce resource for me). Put even
116shorter: It simply wouldn't exist without C++.
117
118My personal stance on this is that C++ is less portable than C, but in
119the case of rxvt-unicode this hardly matters, as its portability limits
120are defined by things like X11, pseudo terminals, locale support and unix
121domain sockets, which are all less portable than C++ itself.
122
123Regarding the bloat, see the above question: It's easy to write programs
124in C that use gobs of memory, an certainly possible to write programs in
125C++ that don't. C++ also often comes with large libraries, but this is
126not necessarily the case with GCC. Here is what rxvt links against on my
127system with a minimal config:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
131 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
132 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
133
134And here is rxvt-unicode:
135
136 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
139 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141
142No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :)
144
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146
147rxvt-unicode does not directly support tabs. It will work fine with
148tabbing functionality of many window managers or similar tabbing programs,
149and its embedding-features allow it to be embedded into other programs,
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
151module, which features a tabbed urxvt (murxvt) terminal as an example
152embedding application.
153
9=item How do I know which rxvt-unicode version I'm using? 154=item How do I know which rxvt-unicode version I'm using?
10 155
11The version number is displayed with the usage (-h). Also the escape 156The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 157sequence C<ESC [ 8 n> sets the window title to the version number. When
158using the @@RXVT_NAME@@c client, the version displayed is that of the
159daemon.
160
161=item I am using Debian GNU/Linux and have a problem...
162
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164patches that considerably change the behaviour of rxvt-unicode. Before
165reporting a bug to the original rxvt-unicode author please download and
166install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
167and try to reproduce the problem. If you cannot, chances are that the
168problems are specific to Debian GNU/Linux, in which case it should be
169reported via the Debian Bug Tracking System (use C<reportbug> to report
170the bug).
171
172For other problems that also affect the Debian package, you can and
173probably should use the Debian BTS, too, because, after all, it's also a
174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue.
176
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
178
179You should build one binary with the default options. F<configure>
180now enables most useful options, and the trend goes to making them
181runtime-switchable, too, so there is usually no drawback to enbaling them,
182except higher disk and possibly memory usage. The perl interpreter should
183be enabled, as important functionality (menus, selection, likely more in
184the future) depends on it.
185
186You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
187system-wide (except maybe with C<defaults>). This will result in useful
188behaviour. If your distribution aims at low memory, add an empty
189C<perl-ext-common> resource to the app-defaults file. This will keep the
190perl interpreter disabled until the user enables it.
191
192If you can/want build more binaries, I recommend building a minimal
193one with C<--disable-everything> (very useful) and a maximal one with
194C<--enable-everything> (less useful, it will be very big due to a lot of
195encodings built-in that increase download times and are rarely used).
196
197=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
198
199Likely not. While I honestly try to make it secure, and am probably not
200bad at it, I think it is simply unreasonable to expect all of freetype
201+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
202secure. Also, rxvt-unicode disables some options when it detects that it
203runs setuid or setgid, which is not nice. Besides, with the embedded perl
204interpreter the possibility for security problems easily multiplies.
205
206Elevated privileges are only required for utmp and pty operations on some
207systems (for example, GNU/Linux doesn't need any extra privileges for
208ptys, but some need it for utmp support). It is planned to mvoe this into
209a forked handler process, but this is not yet done.
210
211So, while setuid/setgid operation is supported and not a problem on your
212typical single-user-no-other-logins unix desktop, always remember that
213its an awful lot of code, most of which isn't checked for security issues
214regularly.
13 215
14=item When I log-in to another system it tells me about missing terminfo data? 216=item When I log-in to another system it tells me about missing terminfo data?
15 217
16The terminal description used by rxvt-unicode is not as widely available 218The 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). 219as that for xterm, or even rxvt (for which the same problem often arises).
28C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 230C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different 231problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice 232colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though. 233quick-and-dirty workaround for rare cases, though.
32 234
33If you always want to do this you can either recompile rxvt-unicode with 235If you always want to do this (and are fine with the consequences) you
34the desired TERM value or use a resource to set it: 236can either recompile rxvt-unicode with the desired TERM value or use a
237resource to set it:
35 238
36 URxvt.termName: rxvt 239 URxvt.termName: rxvt
37 240
38If you don't plan to use B<rxvt> (quite common...) you could also replace 241If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one. 242the rxvt terminfo file with the rxvt-unicode one.
40 243
244=item C<tic> outputs some error when compiling the terminfo entry.
245
246Most likely it's the empty definition for C<enacs=>. Just replace it by
247C<enacs=\E[0@> and try again.
248
249=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
250
41=item I need a termcap file entry. 251=item I need a termcap file entry.
252
253One reason you might want this is that some distributions or operating
254systems still compile some programs using the long-obsoleted termcap
255library (Fedora Core's bash is one example) and rely on a termcap entry
256for C<rxvt-unicode>.
42 257
43You could use rxvt's termcap entry with resonable results in many cases. 258You 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 259You can also create a termcap entry by using terminfo's infocmp program
45like this: 260like this:
46 261
47 infocmp -C rxvt-unicode 262 infocmp -C rxvt-unicode
48 263
49OR you could this termcap entry: 264Or you could use this termcap entry, generated by the command above:
50 265
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 266 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\ 267 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\ 268 :co#80:it#8:li#24:lm#0:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 269 :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:\ 270 :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:\ 271 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 272 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 273 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 274 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
275 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 276 :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~:\ 277 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ 278 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ 279 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ 280 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ 281 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ 282 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ 283 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 284 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h: 285 :vs=\E[?25h:
70 286
71=item How can I configure rxvt-unicode so that it looks similar to the original rxvt? 287=item Why does C<ls> no longer have coloured output?
72 288
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode 289The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
74behave similar to the original rxvt: 290decide wether a terminal has colour, but uses it's own configuration
291file. Needless to say, C<rxvt-unicode> is not in it's default file (among
292with most other terminals supporting colour). Either add:
75 293
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 294 TERM rxvt-unicode
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1 295
296to C</etc/DIR_COLORS> or simply add:
297
298 alias ls='ls --color=auto'
299
300to your C<.profile> or C<.bashrc>.
301
302=item Why doesn't vim/emacs etc. use the 88 colour mode?
303
304=item Why doesn't vim/emacs etc. make use of italic?
305
306=item Why are the secondary screen-related options not working properly?
307
308Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
309distributions (most notably Debian GNU/Linux) break rxvt-unicode
310by setting C<TERM> to C<rxvt>, which doesn't have these extra
311features. Unfortunately, some of these (most notably, again, Debian
312GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
313file, so you will need to install it on your own (See the question B<When
314I log-in to another system it tells me about missing terminfo data?> on
315how to do this).
316
317=item My numerical keypad acts weird and generates differing output?
318
319Some Debian GNUL/Linux users seem to have this problem, although no
320specific details were reported so far. It is possible that this is caused
321by the wrong C<TERM> setting, although the details of wether and how
322this can happen are unknown, as C<TERM=rxvt> should offer a compatible
323keymap. See the answer to the previous question, and please report if that
324helped.
78 325
79=item Rxvt-unicode does not seem to understand the selected encoding? 326=item Rxvt-unicode does not seem to understand the selected encoding?
80 327
81=item Unicode does not seem to work? 328=item Unicode does not seem to work?
82 329
85subtly garbled, then you should check your locale settings. 332subtly garbled, then you should check your locale settings.
86 333
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 334Rxvt-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 335programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to 336login 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. 337something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91 338
92The best thing is to fix your startup environment, as you will likely run 339The 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. 340into other problems. If nothing works you can try this in your .profile.
94 341
95 printf '\e]701;%s\007' "$LC_CTYPE" 342 printf '\e]701;%s\007' "$LC_CTYPE"
96 343
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 344If 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 345supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like: 346displays this (also, C<perl -e0> can be used to check locale settings, as
347it will complain loudly if it cannot set the locale). If it displays something
348like:
100 349
101 locale: Cannot set LC_CTYPE to default locale: ... 350 locale: Cannot set LC_CTYPE to default locale: ...
102 351
103Then the locale you specified is not supported on your system. 352Then the locale you specified is not supported on your system.
104 353
115your system/os) have specified does not cover all the characters you want 364your system/os) have specified does not cover all the characters you want
116to display. 365to display.
117 366
118B<rxvt-unicode> makes a best-effort try at finding a replacement 367B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks 368font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the 369bad/ugly/wrong. Some fonts have totally strange characters that don't
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence 370resemble the correct glyph at all, and rxvt-unicode lacks the artificial
122to detect that a specific glyph is wrong: it has to believe the font that 371intelligence to detect that a specific glyph is wrong: it has to believe
123the characters it contains indeed look correct. 372the font that the characters it claims to contain indeed look correct.
124 373
125In that case, select a font of your taste and add it to the font list, 374In that case, select a font of your taste and add it to the font list,
126e.g.: 375e.g.:
127 376
128 @@RXVT_NAME@@ -fn basefont,font2,font3... 377 @@RXVT_NAME@@ -fn basefont,font2,font3...
130When rxvt-unicode sees a character, it will first look at the base 379When 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 380font. 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 381next 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. 382search and use less resources within rxvt-unicode and the X-server.
134 383
135The only limitation is that all the fonts must not be larger than the base 384The only limitation is that none of the fonts may be larger than the base
136font, as the base font defines the principal cell size, which must be the 385font, as the base font defines the terminal character cell size, which
137same due to the way terminals work. 386must be the same due to the way terminals work.
138 387
139=item Why do some chinese characters look so different than others? 388=item Why do some chinese characters look so different than others?
140 389
141This is because there is a difference between script and language -- 390This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output 391rxvt-unicode does not know which language the text that is output is,
143is, as it only knows the unicode character codes. If rxvt-unicode 392as it only knows the unicode character codes. If rxvt-unicode first
144first sees a japanese character, it might choose a japanese font for 393sees a japanese/chinese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese 394display. Subsequent japanese characters will use that font. Now, many
146characters aren't represented in japanese fonts, so when the first 395chinese characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font 396non-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 397-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese. 398chinese characters that are also in the japanese font.
150 399
151The workaround is easy: just tag a chinese font at the end of your font 400The 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 401list (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 402a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first. 403first. If you expect more chinese, put a chinese font first.
155 404
156In the future it might be possible to switch preferences at runtime (the 405In the future it might be possible to switch language preferences at
157internal data structure has no problem with using different fonts for 406runtime (the internal data structure has no problem with using different
158the same character at the same time, but no interface for this has been 407fonts for the same character at the same time, but no interface for this
159designed yet). 408has been designed yet).
409
410Until then, you might get away with switching fonts at runtime (see L<Can
411I switch the fonts at runtime?> later in this document).
160 412
161=item Why does rxvt-unicode sometimes leave pixel droppings? 413=item Why does rxvt-unicode sometimes leave pixel droppings?
162 414
163Most fonts were not designed for terminal use, which means that character 415Most 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 416size varies a lot. A font that is otherwise fine for terminal use might
170however: Xft fonts often draw glyphs larger than their acclaimed bounding 422however: 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 423box, 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 424ask for the character bounding box, which unfortunately is wrong in these
173cases). 425cases).
174 426
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or 427It's not clear (to me at least), wether this is a bug in Xft, freetype,
176the respective font. If you encounter this problem there is no way to work 428or the respective font. If you encounter this problem you might try using
177around this except by using a different font. 429the C<-lsp> option to give the font more height. If that doesn't work, you
430might be forced to use a different font.
178 431
179All of this is not a problem when using X11 core fonts, as their bounding 432All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct. 433box data is correct.
434
435=item On Solaris 9, many line-drawing characters are too wide.
436
437Seems to be a known bug, read
438L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
439following ugly workaround to get non-double-wide-characters working:
440
441 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
181 442
182=item My Compose (Multi_key) key is no longer working. 443=item My Compose (Multi_key) key is no longer working.
183 444
184The most common causes for this are that either your locale is not set 445The 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 446correctly, or you specified a B<preeditStyle> that is not supported by
199codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 460codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
200character and so on. 461character and so on.
201 462
202=item How can I keep rxvt-unicode from using reverse video so much? 463=item How can I keep rxvt-unicode from using reverse video so much?
203 464
204First of all, make sure you are running with the right terminfo 465First of all, make sure you are running with the right terminal settings
205(C<urxvt>), which will get rid of most of these effects. Then make sure 466(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
206you have specified colours for italic and bold, as otherwise rxvt-unicode 467make sure you have specified colours for italic and bold, as otherwise
207might use reverse video to simulate the effect: 468rxvt-unicode might use reverse video to simulate the effect:
208 469
209 URxvt*colorBD: white 470 URxvt.colorBD: white
210 URxvt*colorIT: green 471 URxvt.colorIT: green
211 472
212=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 473=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
213 474
214For some unexplainable reason, some programs (i.e. irssi) assume a very 475For some unexplainable reason, some rare programs assume a very weird
215weird colour palette when confronted with a terminal with more than the 476colour palette when confronted with a terminal with more than the standard
216standard 8 colours (rxvt-unicode supports 88). The right fix is, of 4778 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
217course, to fix these programs not to assume non-ISO colours without very 478these programs not to assume non-ISO colours without very good reasons.
218good reasons.
219 479
220In the meantime, you can either edit your C<urxvt> terminfo definition to 480In the meantime, you can either edit your C<rxvt-unicode> terminfo
221only claim 8 colour support or use C<TERM=rxvt>, which will fix colours 481definition to only claim 8 colour support or use C<TERM=rxvt>, which will
222but keep you from using other rxvt-unicode features. 482fix colours but keep you from using other rxvt-unicode features.
223 483
224=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 484=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
225 485
226Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 486Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
227in your compile environment, or an implementation that implements it, 487in your compile environment, or an implementation that implements it,
228wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 488wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
229B<wchar_t> is represented as unicode. 489B<wchar_t> is represented as unicode.
230 490
231As you might have guessed, FreeBSD does neither define this symobl nor 491As you might have guessed, FreeBSD does neither define this symobl nor
232does it support it. Instead, it uses it's own internal representation of 492does it support it. Instead, it uses it's own internal representation of
233B<wchar_t>. This is, of course, completely legal. 493B<wchar_t>. This is, of course, completely fine with respect to standards.
234 494
495However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
496C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
497
235However, C<__STDC_ISO_10646__> is the only sane way to support 498C<__STDC_ISO_10646__> is the only sane way to support multi-language
236multi-language apps in an OS, as using a locale-dependent (and 499apps in an OS, as using a locale-dependent (and non-standardized)
237non-standardized) representation of B<wchar_t> makes it impossible to 500representation of B<wchar_t> makes it impossible to convert between
238convert between B<wchar_t> (as used by X11 and your applications) and any 501B<wchar_t> (as used by X11 and your applications) and any other encoding
239other encoding without implementing OS-specific-wrappers for each and 502without implementing OS-specific-wrappers for each and every locale. There
240every locale. There simply are no APIs to convert B<wchar_t> into anything 503simply are no APIs to convert B<wchar_t> into anything except the current
241except the current locale encoding. 504locale encoding.
242 505
243Some applications (such as the formidable B<mlterm>) work around this 506Some applications (such as the formidable B<mlterm>) work around this
244by carrying their own replacement functions for character set handling 507by carrying their own replacement functions for character set handling
245with them, and either implementing OS-dependent hacks or doing multiple 508with them, and either implementing OS-dependent hacks or doing multiple
246conversions (which is slow and unreliable in case the OS implements 509conversions (which is slow and unreliable in case the OS implements
247encodings slightly different than the terminal emulator). 510encodings slightly different than the terminal emulator).
248 511
249The rxvt-unicode author insists that the right way to fix this is in the 512The rxvt-unicode author insists that the right way to fix this is in the
250system libraries once and for all, instead of forcing every app to carry 513system libraries once and for all, instead of forcing every app to carry
251complete replacements. 514complete replacements for them :)
515
516=item I use Solaris 9 and it doesn't compile/work/etc.
517
518Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
519problems with C<wcwidth> and a compile problem.
520
521=item How can I use rxvt-unicode under cygwin?
522
523rxvt-unicode should compile and run out of the box on cygwin, using
524the X11 libraries that come with cygwin. libW11 emulation is no
525longer supported (and makes no sense, either, as it only supported a
526single font). I recommend starting the X-server in C<-multiwindow> or
527C<-rootless> mode instead, which will result in similar look&feel as the
528old libW11 emulation.
529
530At the time of this writing, cygwin didn't seem to support any multi-byte
531encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
532to 8-bit encodings.
252 533
253=item How does rxvt-unicode determine the encoding to use? 534=item How does rxvt-unicode determine the encoding to use?
254 535
255=item Is there an option to switch encodings? 536=item Is there an option to switch encodings?
256 537
258specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 539specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
259UTF-8 or any other encodings with respect to terminal I/O. 540UTF-8 or any other encodings with respect to terminal I/O.
260 541
261The reasons is that there exists a perfectly fine mechanism for selecting 542The reasons is that there exists a perfectly fine mechanism for selecting
262the encoding, doing I/O and (most important) communicating this to all 543the encoding, doing I/O and (most important) communicating this to all
263applications so everybody agrees on character properties such as width and 544applications so everybody agrees on character properties such as width
264code number. This mechanism is the I<locale>. 545and code number. This mechanism is the I<locale>. Applications not using
546that info will have problems (for example, C<xterm> gets the width of
547characters wrong as it uses it's own, locale-independent table under all
548locales).
265 549
266Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 550Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
267programs doing the same (that is, most) will automatically agree in the 551programs doing the same (that is, most) will automatically agree in the
268interpretation of characters. 552interpretation of characters.
269 553
276C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms 560C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
277(i.e. C<de> or C<german>) are also common. 561(i.e. C<de> or C<german>) are also common.
278 562
279Rxvt-unicode ignores all other locale categories, and except for 563Rxvt-unicode ignores all other locale categories, and except for
280the encoding, ignores country or language-specific settings, 564the encoding, ignores country or language-specific settings,
281i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode. 565i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
566rxvt-unicode.
282 567
283If you want to use a specific encoding you have to make sure you start 568If you want to use a specific encoding you have to make sure you start
284rxvt-unicode with the correct C<LC_CTYPE> category. 569rxvt-unicode with the correct C<LC_CTYPE> category.
285 570
286=item Can I switch locales at runtime? 571=item Can I switch locales at runtime?
287 572
288Yes, using an escape sequence. Try sth. like this, which sets 573Yes, using an escape sequence. Try something like this, which sets
289rxvt-unicode's idea of C<LC_CTYPE>. 574rxvt-unicode's idea of C<LC_CTYPE>.
290 575
291 printf '\e]701;%s\007' ja_JP.SJIS 576 printf '\e]701;%s\007' ja_JP.SJIS
292 577
293See also the previous question. 578See also the previous answer.
294 579
295Sometimes this capability is rather handy when you want to work in one 580Sometimes this capability is rather handy when you want to work in
296locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For 581one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
297example, I use this script to start C<xjdic>, which first switches to a 582(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
298locale supported by xjdic and back later: 583first switches to a locale supported by xjdic and back later:
299 584
300 printf '\e]701;%s\007' ja_JP.SJIS 585 printf '\e]701;%s\007' ja_JP.SJIS
301 xjdic -js 586 xjdic -js
302 printf '\e]701;%s\007' de_DE.UTF-8 587 printf '\e]701;%s\007' de_DE.UTF-8
303 588
589You can also use xterm's C<luit> program, which usually works fine, except
590for some locales where character width differs between program- and
591rxvt-unicode-locales.
592
304=item Can I switch the fonts at runtime? 593=item Can I switch the fonts at runtime?
305 594
306Yes, using an escape sequence. Try sth. like this, which has the same 595Yes, using an escape sequence. Try something like this, which has the same
307effect as using the C<-fn> switch, and takes effect immediately: 596effect as using the C<-fn> switch, and takes effect immediately:
308 597
309 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 598 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
310 599
311This is useful if you e.g. work primarily with japanese (and prefer a 600This is useful if you e.g. work primarily with japanese (and prefer a
316 605
317=item Why do italic characters look as if clipped? 606=item Why do italic characters look as if clipped?
318 607
319Many fonts have difficulties with italic characters and hinting. For 608Many fonts have difficulties with italic characters and hinting. For
320example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 609example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
321Mono> completely fails in it's italic face. A workaround is to enable 610Mono> completely fails in it's italic face. A workaround might be to
322freetype autohinting, i.e. like this: 611enable freetype autohinting, i.e. like this:
323 612
324 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 613 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
325 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 614 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
326 615
327=item My input method wants <some encoding> but I want UTF-8, what can I do? 616=item My input method wants <some encoding> but I want UTF-8, what can I do?
328 617
329You can specify separate locales for the input method and the rest of the 618You can specify separate locales for the input method and the rest of the
330terminal, using the resource C<imlocale>: 619terminal, using the resource C<imlocale>:
331 620
332 URxvt*imlocale: ja_JP.EUC-JP 621 URxvt.imlocale: ja_JP.EUC-JP
333 622
334Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 623Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
335use your input method. Please note, however, that you will not be able to 624use your input method. Please note, however, that you will not be able to
336input characters outside C<EUC-JP> in a normal way then, as your input 625input characters outside C<EUC-JP> in a normal way then, as your input
337method limits you. 626method limits you.
338 627
628=item Rxvt-unicode crashes when the X Input Method changes or exits.
629
630Unfortunately, this is unavoidable, as the XIM protocol is racy by
631design. Applications can avoid some crashes at the expense of memory
632leaks, and Input Methods can avoid some crashes by careful ordering at
633exit time. B<kinput2> (and derived input methods) generally succeeds,
634while B<SCIM> (or similar input methods) fails. In the end, however,
635crashes cannot be completely avoided even if both sides cooperate.
636
637So the only workaround is not to kill your Input Method Servers.
638
339=item Rxvt-unicode uses gobs of memory, how can I reduce that? 639=item Rxvt-unicode uses gobs of memory, how can I reduce that?
340 640
341Rxvt-unicode tries to obey the rule of not charging you for sth. you 641Rxvt-unicode tries to obey the rule of not charging you for something you
342don't use. One thing you should try is to configure out all settings that 642don't use. One thing you should try is to configure out all settings that
343you don't need, for example, Xft support is a resource hog by design, 643you don't need, for example, Xft support is a resource hog by design,
344when used. Compiling it out ensures that no Xft font will be loaded 644when used. Compiling it out ensures that no Xft font will be loaded
345accidentally when rxvt-unicode tries to find a font for your characters. 645accidentally when rxvt-unicode tries to find a font for your characters.
346 646
353 653
354=item Can I speed up Xft rendering somehow? 654=item Can I speed up Xft rendering somehow?
355 655
356Yes, the most obvious way to speed it up is to avoid Xft entirely, as 656Yes, the most obvious way to speed it up is to avoid Xft entirely, as
357it is simply slow. If you still want Xft fonts you might try to disable 657it is simply slow. If you still want Xft fonts you might try to disable
358antialiasing (by appending C<:antialiasing=false>), which saves lots of 658antialiasing (by appending C<:antialias=false>), which saves lots of
359memory and also speeds up rendering considerably. 659memory and also speeds up rendering considerably.
360 660
361=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 661=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
362 662
363Rxvt-unicode will use whatever you specify as a font. If it needs to 663Rxvt-unicode will use whatever you specify as a font. If it needs to
372 672
373Make sure that mouse reporting is actually turned off since killing 673Make sure that mouse reporting is actually turned off since killing
374some editors prematurely may leave the mouse in mouse report mode. I've 674some editors prematurely may leave the mouse in mouse report mode. I've
375heard that tcsh may use mouse reporting unless it otherwise specified. A 675heard that tcsh may use mouse reporting unless it otherwise specified. A
376quick check is to see if cut/paste works when the Alt or Shift keys are 676quick check is to see if cut/paste works when the Alt or Shift keys are
377depressed. See @@RXVT_NAME@@(7) 677depressed.
378 678
379=item What's with this bold/blink stuff? 679=item What's with this bold/blink stuff?
380 680
381If no bold colour is set via C<colorBD:>, bold will invert text using the 681If no bold colour is set via C<colorBD:>, bold will invert text using the
382standard foreground colour. 682standard foreground colour.
399resources (or as long-options). 699resources (or as long-options).
400 700
401Here are values that are supposed to resemble a VGA screen, 701Here are values that are supposed to resemble a VGA screen,
402including the murky brown that passes for low-intensity yellow: 702including the murky brown that passes for low-intensity yellow:
403 703
404 URxvt*color0: #000000 704 URxvt.color0: #000000
405 URxvt*color1: #A80000 705 URxvt.color1: #A80000
406 URxvt*color2: #00A800 706 URxvt.color2: #00A800
407 URxvt*color3: #A8A800 707 URxvt.color3: #A8A800
408 URxvt*color4: #0000A8 708 URxvt.color4: #0000A8
409 URxvt*color5: #A800A8 709 URxvt.color5: #A800A8
410 URxvt*color6: #00A8A8 710 URxvt.color6: #00A8A8
411 URxvt*color7: #A8A8A8 711 URxvt.color7: #A8A8A8
412 712
413 URxvt*color8: #000054 713 URxvt.color8: #000054
414 URxvt*color9: #FF0054 714 URxvt.color9: #FF0054
415 URxvt*color10: #00FF54 715 URxvt.color10: #00FF54
416 URxvt*color11: #FFFF54 716 URxvt.color11: #FFFF54
417 URxvt*color12: #0000FF 717 URxvt.color12: #0000FF
418 URxvt*color13: #FF00FF 718 URxvt.color13: #FF00FF
419 URxvt*color14: #00FFFF 719 URxvt.color14: #00FFFF
420 URxvt*color15: #FFFFFF 720 URxvt.color15: #FFFFFF
421 721
422And here is a more complete set of non-standard colors described as 722And here is a more complete set of non-standard colors described (not by
423"pretty girly": 723me) as "pretty girly".
424 724
425 URxvt.cursorColor: #dc74d1 725 URxvt.cursorColor: #dc74d1
426 URxvt.pointerColor: #dc74d1 726 URxvt.pointerColor: #dc74d1
427 URxvt.background: #0e0e0e 727 URxvt.background: #0e0e0e
428 URxvt.foreground: #4ad5e1 728 URxvt.foreground: #4ad5e1
439 URxvt.color6: #73f7ff 739 URxvt.color6: #73f7ff
440 URxvt.color14: #73f7ff 740 URxvt.color14: #73f7ff
441 URxvt.color7: #e1dddd 741 URxvt.color7: #e1dddd
442 URxvt.color15: #e1dddd 742 URxvt.color15: #e1dddd
443 743
744=item How can I start @@RXVT_NAME@@d in a race-free way?
745
746Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
747display, create the listening socket and then fork.
748
444=item What's with the strange Backspace/Delete key behaviour? 749=item What's with the strange Backspace/Delete key behaviour?
445 750
446Assuming that the physical Backspace key corresponds to the 751Assuming that the physical Backspace key corresponds to the
447BackSpace keysym (not likely for Linux ... see the following 752BackSpace keysym (not likely for Linux ... see the following
448question) there are two standard values that can be used for 753question) there are two standard values that can be used for
466 771
467 # use Backspace = ^? 772 # use Backspace = ^?
468 $ stty erase ^? 773 $ stty erase ^?
469 $ @@RXVT_NAME@@ 774 $ @@RXVT_NAME@@
470 775
471Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 776Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
472 777
473For an existing rxvt-unicode: 778For an existing rxvt-unicode:
474 779
475 # use Backspace = ^H 780 # use Backspace = ^H
476 $ stty erase ^H 781 $ stty erase ^H
485properly reflects that. 790properly reflects that.
486 791
487The Delete key is a another casualty of the ill-defined Backspace problem. 792The Delete key is a another casualty of the ill-defined Backspace problem.
488To avoid confusion between the Backspace and Delete keys, the Delete 793To avoid confusion between the Backspace and Delete keys, the Delete
489key has been assigned an escape sequence to match the vt100 for Execute 794key has been assigned an escape sequence to match the vt100 for Execute
490(ESC[3~) and is in the supplied termcap/terminfo. 795(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
491 796
492Some other Backspace problems: 797Some other Backspace problems:
493 798
494some editors use termcap/terminfo, 799some editors use termcap/terminfo,
495some editors (vim I'm told) expect Backspace = ^H, 800some editors (vim I'm told) expect Backspace = ^H,
499 804
500=item I don't like the key-bindings. How do I change them? 805=item I don't like the key-bindings. How do I change them?
501 806
502There are some compile-time selections available via configure. Unless 807There are some compile-time selections available via configure. Unless
503you have run "configure" with the C<--disable-resources> option you can 808you have run "configure" with the C<--disable-resources> option you can
504use the `keysym' resource to alter the keystrings associated with keysym 809use the `keysym' resource to alter the keystrings associated with keysyms.
5050xFF00 - 0xFFFF (function, cursor keys, etc).
506 810
507Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' 811Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
508 812
509 !# ----- special uses ------: 813 URxvt.keysym.Home: \033[1~
510 ! tn3270 login, remap function and arrow keys. 814 URxvt.keysym.End: \033[4~
511 tn3270*font: *clean-bold-*-*--15-* 815 URxvt.keysym.C-apostrophe: \033<C-'>
816 URxvt.keysym.C-slash: \033<C-/>
817 URxvt.keysym.C-semicolon: \033<C-;>
818 URxvt.keysym.C-grave: \033<C-`>
819 URxvt.keysym.C-comma: \033<C-,>
820 URxvt.keysym.C-period: \033<C-.>
821 URxvt.keysym.C-0x60: \033<C-`>
822 URxvt.keysym.C-Tab: \033<C-Tab>
823 URxvt.keysym.C-Return: \033<C-Return>
824 URxvt.keysym.S-Return: \033<S-Return>
825 URxvt.keysym.S-space: \033<S-Space>
826 URxvt.keysym.M-Up: \033<M-Up>
827 URxvt.keysym.M-Down: \033<M-Down>
828 URxvt.keysym.M-Left: \033<M-Left>
829 URxvt.keysym.M-Right: \033<M-Right>
830 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
831 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
832 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
512 833
513 ! keysym - used by rxvt only 834See some more examples in the documentation for the B<keysym> resource.
514 ! Delete - ^D
515 tn3270*keysym.0xFFFF: \004
516
517 ! Home - ^A
518 tn3270*keysym.0xFF50: \001
519 ! Left - ^B
520 tn3270*keysym.0xFF51: \002
521 ! Up - ^P
522 tn3270*keysym.0xFF52: \020
523 ! Right - ^F
524 tn3270*keysym.0xFF53: \006
525 ! Down - ^N
526 tn3270*keysym.0xFF54: \016
527 ! End - ^E
528 tn3270*keysym.0xFF57: \005
529
530 ! F1 - F12
531 tn3270*keysym.0xFFBE: \e1
532 tn3270*keysym.0xFFBF: \e2
533 tn3270*keysym.0xFFC0: \e3
534 tn3270*keysym.0xFFC1: \e4
535 tn3270*keysym.0xFFC2: \e5
536 tn3270*keysym.0xFFC3: \e6
537 tn3270*keysym.0xFFC4: \e7
538 tn3270*keysym.0xFFC5: \e8
539 tn3270*keysym.0xFFC6: \e9
540 tn3270*keysym.0xFFC7: \e0
541 tn3270*keysym.0xFFC8: \e-
542 tn3270*keysym.0xFFC9: \e=
543
544 ! map Prior/Next to F7/F8
545 tn3270*keysym.0xFF55: \e7
546 tn3270*keysym.0xFF56: \e8
547 835
548=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 836=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
549How do I make use of them? For example, the Sun Keyboard type 4 837How do I make use of them? For example, the Sun Keyboard type 4
550has the following mappings that rxvt-unicode doesn't recognize. 838has the following mappings that rxvt-unicode doesn't recognize.
551 839
554 F27 == Home 842 F27 == Home
555 F29 == Prior 843 F29 == Prior
556 F33 == End 844 F33 == End
557 F35 == Next 845 F35 == Next
558 846
559Rather than have rxvt-unicode try to accommodate all the various possible keyboard 847Rather than have rxvt-unicode try to accommodate all the various possible
560mappings, it is better to use `xmodmap' to remap the keys as required for 848keyboard mappings, it is better to use `xmodmap' to remap the keys as
561your particular machine. 849required for your particular machine.
562 850
563=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? 851=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
564I need this to decide about setting colors etc. 852I need this to decide about setting colors etc.
565 853
566rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 854rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
567check and see if that is set. Note that several programs, JED, slrn, 855check and see if that is set. Note that several programs, JED, slrn,
568Midnight Commander automatically check this variable to decide whether or 856Midnight Commander automatically check this variable to decide whether or
605channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 893channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
606interested in learning about new and exciting problems (but not FAQs :). 894interested in learning about new and exciting problems (but not FAQs :).
607 895
608=back 896=back
609 897
610=head1 SYNOPSIS 898=head1 RXVT TECHNICAL REFERENCE
611
612 # set a new font set
613 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
614
615 # change the locale and tell rxvt-unicode about it
616 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
617
618 # set window title
619 printf '\33]2;%s\007' "new window title"
620 899
621=head1 DESCRIPTION 900=head1 DESCRIPTION
622 901
623The rest of this document describes various technical aspects of 902The rest of this document describes various technical aspects of
624B<rxvt-unicode>. First the description of supported command sequences, 903B<rxvt-unicode>. First the description of supported command sequences,
625followed by menu and pixmap support and last by a description of all 904followed by pixmap support and last by a description of all features
626features selectable at C<configure> time. 905selectable at C<configure> time.
627
628=head1 RXVT TECHNICAL REFERENCE
629 906
630=head1 Definitions 907=head1 Definitions
631 908
632=over 4 909=over 4
633 910
762Single Shift Select of G3 Character Set (SS3): affects next character 1039Single Shift Select of G3 Character Set (SS3): affects next character
763only I<unimplemented> 1040only I<unimplemented>
764 1041
765=item B<< C<ESC Z> >> 1042=item B<< C<ESC Z> >>
766 1043
767Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1044Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
768 1045
769=item B<< C<ESC c> >> 1046=item B<< C<ESC c> >>
770 1047
771Full reset (RIS) 1048Full reset (RIS)
772 1049
776 1053
777=item B<< C<ESC o> >> 1054=item B<< C<ESC o> >>
778 1055
779Invoke the G3 Character Set (LS3) 1056Invoke the G3 Character Set (LS3)
780 1057
781=item B<< C<ESC> ( C> >> 1058=item B<< C<ESC ( C> >>
782 1059
783Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1060Designate G0 Character Set (ISO 2022), see below for values of C<C>.
784 1061
785=item B<< C<ESC> ) C> >> 1062=item B<< C<ESC ) C> >>
786 1063
787Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1064Designate G1 Character Set (ISO 2022), see below for values of C<C>.
788 1065
789=item B<< C<ESC * C> >> 1066=item B<< C<ESC * C> >>
790 1067
931 1208
932=item B<< C<ESC [ Ps c> >> 1209=item B<< C<ESC [ Ps c> >>
933 1210
934Send Device Attributes (DA) 1211Send Device Attributes (DA)
935B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1212B<< C<Ps = 0> >> (or omitted): request attributes from terminal
936returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1213returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
937Option'') 1214Option'')
938 1215
939=item B<< C<ESC [ Ps d> >> 1216=item B<< C<ESC [ Ps d> >>
940 1217
941Cursor to Line B<< C<Ps> >> (VPA) 1218Cursor to Line B<< C<Ps> >> (VPA)
1057 1334
1058=item B<< C<ESC [ s> >> 1335=item B<< C<ESC [ s> >>
1059 1336
1060Save Cursor (SC) 1337Save Cursor (SC)
1061 1338
1339=item B<< C<ESC [ Ps;Pt t> >>
1340
1341Window Operations
1342
1343=begin table
1344
1345 B<< C<Ps = 1> >> Deiconify (map) window
1346 B<< C<Ps = 2> >> Iconify window
1347 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1348 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1349 B<< C<Ps = 5> >> Raise window
1350 B<< C<Ps = 6> >> Lower window
1351 B<< C<Ps = 7> >> Refresh screen once
1352 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1353 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1354 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1355 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1356 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1357 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1358 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1359 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1360 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1361
1362=end table
1363
1364=item B<< C<ESC [ u> >>
1365
1366Restore Cursor
1367
1062=item B<< C<ESC [ Ps x> >> 1368=item B<< C<ESC [ Ps x> >>
1063 1369
1064Request Terminal Parameters (DECREQTPARM) 1370Request Terminal Parameters (DECREQTPARM)
1065
1066=item B<< C<ESC [ u> >>
1067
1068Restore Cursor
1069 1371
1070=back 1372=back
1071 1373
1072X<PrivateModes> 1374X<PrivateModes>
1073 1375
1176 B<< C<h> >> Send Mouse X & Y on button press. 1478 B<< C<h> >> Send Mouse X & Y on button press.
1177 B<< C<l> >> No mouse reporting. 1479 B<< C<l> >> No mouse reporting.
1178 1480
1179=end table 1481=end table
1180 1482
1181=item B<< C<Ps = 10> >> (B<rxvt>)
1182
1183=begin table
1184
1185 B<< C<h> >> menuBar visible
1186 B<< C<l> >> menuBar invisible
1187
1188=end table
1189
1190=item B<< C<Ps = 25> >> 1483=item B<< C<Ps = 25> >>
1191 1484
1192=begin table 1485=begin table
1193 1486
1194 B<< C<h> >> Visible cursor {cnorm/cvvis} 1487 B<< C<h> >> Visible cursor {cnorm/cvvis}
1307 1600
1308=begin table 1601=begin table
1309 1602
1310 B<< C<h> >> Scroll to bottom when a key is pressed 1603 B<< C<h> >> Scroll to bottom when a key is pressed
1311 B<< C<l> >> Don't scroll to bottom when a key is pressed 1604 B<< C<l> >> Don't scroll to bottom when a key is pressed
1605
1606=end table
1607
1608=item B<< C<Ps = 1021> >> (B<rxvt>)
1609
1610=begin table
1611
1612 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1613 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1312 1614
1313=end table 1615=end table
1314 1616
1315=item B<< C<Ps = 1047> >> 1617=item B<< C<Ps = 1047> >>
1316 1618
1365 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1667 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1366 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1668 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1367 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1669 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1368 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1670 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1369 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1671 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1370 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1672 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1371 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1673 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1372 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1674 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1373 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1675 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1374 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1676 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1375 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1677 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1376 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1678 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1377 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1679 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1378 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1680 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1379 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1380 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1681 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1381 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1682 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1683 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1684 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1382 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1685 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1383 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1686 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1384 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1687 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1385 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1688 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1689 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1690 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1691 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1386 1692
1387=end table 1693=end table
1388 1694
1389=back 1695=back
1390 1696
1391X<menuBar>
1392
1393=head1 menuBar
1394
1395B<< The exact syntax used is I<almost> solidified. >>
1396In the menus, B<DON'T> try to use menuBar commands that add or remove a
1397menuBar.
1398
1399Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1400omitted: use B<./> to specify a menu relative to the current menu.
1401
1402=head2 Overview of menuBar operation
1403
1404For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1405of C<Pt> can be used for a variety of tasks:
1406
1407At the top level is the current menuBar which is a member of a circular
1408linked-list of other such menuBars.
1409
1410The menuBar acts as a parent for the various drop-down menus, which in
1411turn, may have labels, separator lines, menuItems and subMenus.
1412
1413The menuItems are the useful bits: you can use them to mimic keyboard
1414input or even to send text or escape sequences back to rxvt.
1415
1416The menuBar syntax is intended to provide a simple yet robust method of
1417constructing and manipulating menus and navigating through the
1418menuBars.
1419
1420The first step is to use the tag B<< [menu:I<name>] >> which creates
1421the menuBar called I<name> and allows access. You may now or menus,
1422subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1423menuBar access as B<readonly> to prevent accidental corruption of the
1424menus. To re-access the current menuBar for alterations, use the tag
1425B<[menu]>, make the alterations and then use B<[done]>
1426
1427X<menuBarCommands>
1428
1429=head2 Commands
1430
1431=over 4
1432
1433=item B<< [menu:+I<name>] >>
1434
1435access the named menuBar for creation or alteration. If a new menuBar
1436is created, it is called I<name> (max of 15 chars) and the current
1437menuBar is pushed onto the stack
1438
1439=item B<[menu]>
1440
1441access the current menuBar for alteration
1442
1443=item B<< [title:+I<string>] >>
1444
1445set the current menuBar's title to I<string>, which may contain the
1446following format specifiers:
1447B<%%> : literal B<%> character
1448B<%n> : rxvt name (as per the B<-name> command-line option)
1449B<%v> : rxvt version
1450
1451=item B<[done]>
1452
1453set menuBar access as B<readonly>.
1454End-of-file tag for B<< [read:+I<file>] >> operations.
1455
1456=item B<< [read:+I<file>] >>
1457
1458read menu commands directly from I<file> (extension ".menu" will be
1459appended if required.) Start reading at a line with B<[menu]> or B<<
1460[menu:+I<name> >> and continuing until B<[done]> is encountered.
1461
1462Blank and comment lines (starting with B<#>) are ignored. Actually,
1463since any invalid menu commands are also ignored, almost anything could
1464be construed as a comment line, but this may be tightened up in the
1465future ... so don't count on it!.
1466
1467=item B<< [read:+I<file>;+I<name>] >>
1468
1469The same as B<< [read:+I<file>] >>, but start reading at a line with
1470B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1471B<[done]> is encountered.
1472
1473=item B<[dump]>
1474
1475dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1476later rereading.
1477
1478=item B<[rm:name]>
1479
1480remove the named menuBar
1481
1482=item B<[rm] [rm:]>
1483
1484remove the current menuBar
1485
1486=item B<[rm*] [rm:*]>
1487
1488remove all menuBars
1489
1490=item B<[swap]>
1491
1492swap the top two menuBars
1493
1494=item B<[prev]>
1495
1496access the previous menuBar
1497
1498=item B<[next]>
1499
1500access the next menuBar
1501
1502=item B<[show]>
1503
1504Enable display of the menuBar
1505
1506=item B<[hide]>
1507
1508Disable display of the menuBar
1509
1510=item B<< [pixmap:+I<name>] >>
1511
1512=item B<< [pixmap:+I<name>;I<scaling>] >>
1513
1514(set the background pixmap globally
1515
1516B<< A Future implementation I<may> make this local to the menubar >>)
1517
1518=item B<< [:+I<command>:] >>
1519
1520ignore the menu readonly status and issue a I<command> to or a menu or
1521menuitem or change the ; a useful shortcut for setting the quick arrows
1522from a menuBar.
1523
1524=back
1525
1526X<menuBarAdd>
1527
1528=head2 Adding and accessing menus
1529
1530The following commands may also be B<+> prefixed.
1531
1532=over 4
1533
1534=item B</+>
1535
1536access menuBar top level
1537
1538=item B<./+>
1539
1540access current menu level
1541
1542=item B<../+>
1543
1544access parent menu (1 level up)
1545
1546=item B<../../>
1547
1548access parent menu (multiple levels up)
1549
1550=item B<< I</path/>menu >>
1551
1552add/access menu
1553
1554=item B<< I</path/>menu/* >>
1555
1556add/access menu and clear it if it exists
1557
1558=item B<< I</path/>{-} >>
1559
1560add separator
1561
1562=item B<< I</path/>{item} >>
1563
1564add B<item> as a label
1565
1566=item B<< I</path/>{item} action >>
1567
1568add/alter I<menuitem> with an associated I<action>
1569
1570=item B<< I</path/>{item}{right-text} >>
1571
1572add/alter I<menuitem> with B<right-text> as the right-justified text
1573and as the associated I<action>
1574
1575=item B<< I</path/>{item}{rtext} action >>
1576
1577add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1578the right-justified text.
1579
1580=back
1581
1582=over 4
1583
1584=item Special characters in I<action> must be backslash-escaped:
1585
1586B<\a \b \E \e \n \r \t \octal>
1587
1588=item or in control-character notation:
1589
1590B<^@, ^A .. ^Z .. ^_, ^?>
1591
1592=back
1593
1594To send a string starting with a B<NUL> (B<^@>) character to the
1595program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1596the first of which will be stripped off and the balance directed to the
1597program. Otherwise if I<action> begins with B<NUL> followed by
1598non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1599balance is sent back to rxvt.
1600
1601As a convenience for the many Emacs-type editors, I<action> may start
1602with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1603appended if missed from B<M-x> commands.
1604
1605As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1606quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1607
1608=over 4
1609
1610=item For example,
1611
1612B<M-xapropos> is equivalent to B<\Exapropos\r>
1613
1614=item and
1615
1616B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1617
1618=back
1619
1620The option B<< {I<right-rtext>} >> will be right-justified. In the
1621absence of a specified action, this text will be used as the I<action>
1622as well.
1623
1624=over 4
1625
1626=item For example,
1627
1628B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1629
1630=back
1631
1632The left label I<is> necessary, since it's used for matching, but
1633implicitly hiding the left label (by using same name for both left and
1634right labels), or explicitly hiding the left label (by preceeding it
1635with a dot), makes it possible to have right-justified text only.
1636
1637=over 4
1638
1639=item For example,
1640
1641B</File/{Open}{Open} Open-File-Action>
1642
1643=item or hiding it
1644
1645B</File/{.anylabel}{Open} Open-File-Action>
1646
1647=back
1648
1649X<menuBarRemove>
1650
1651=head2 Removing menus
1652
1653=over 4
1654
1655=item B<< -/*+ >>
1656
1657remove all menus from the menuBar, the same as B<[clear]>
1658
1659=item B<< -+I</path>menu+ >>
1660
1661remove menu
1662
1663=item B<< -+I</path>{item}+ >>
1664
1665remove item
1666
1667=item B<< -+I</path>{-} >>
1668
1669remove separator)
1670
1671=item B<-/path/menu/*>
1672
1673remove all items, separators and submenus from menu
1674
1675=back
1676
1677X<menuBarArrows>
1678
1679=head2 Quick Arrows
1680
1681The menus also provide a hook for I<quick arrows> to provide easier
1682user access. If nothing has been explicitly set, the default is to
1683emulate the curror keys. The syntax permits each arrow to be altered
1684individually or all four at once without re-entering their common
1685beginning/end text. For example, to explicitly associate cursor actions
1686with the arrows, any of the following forms could be used:
1687
1688=over 4
1689
1690=item B<< <r>+I<Right> >>
1691
1692=item B<< <l>+I<Left> >>
1693
1694=item B<< <u>+I<Up> >>
1695
1696=item B<< <d>+I<Down> >>
1697
1698Define actions for the respective arrow buttons
1699
1700=item B<< <b>+I<Begin> >>
1701
1702=item B<< <e>+I<End> >>
1703
1704Define common beginning/end parts for I<quick arrows> which used in
1705conjunction with the above <r> <l> <u> <d> constructs
1706
1707=back
1708
1709=over 4
1710
1711=item For example, define arrows individually,
1712
1713 <u>\E[A
1714
1715 <d>\E[B
1716
1717 <r>\E[C
1718
1719 <l>\E[D
1720
1721=item or all at once
1722
1723 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1724
1725=item or more compactly (factoring out common parts)
1726
1727 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1728
1729=back
1730
1731X<menuBarSummary>
1732
1733=head2 Command Summary
1734
1735A short summary of the most I<common> commands:
1736
1737=over 4
1738
1739=item [menu:name]
1740
1741use an existing named menuBar or start a new one
1742
1743=item [menu]
1744
1745use the current menuBar
1746
1747=item [title:string]
1748
1749set menuBar title
1750
1751=item [done]
1752
1753set menu access to readonly and, if reading from a file, signal EOF
1754
1755=item [done:name]
1756
1757if reading from a file using [read:file;name] signal EOF
1758
1759=item [rm:name]
1760
1761remove named menuBar(s)
1762
1763=item [rm] [rm:]
1764
1765remove current menuBar
1766
1767=item [rm*] [rm:*]
1768
1769remove all menuBar(s)
1770
1771=item [swap]
1772
1773swap top two menuBars
1774
1775=item [prev]
1776
1777access the previous menuBar
1778
1779=item [next]
1780
1781access the next menuBar
1782
1783=item [show]
1784
1785map menuBar
1786
1787=item [hide]
1788
1789unmap menuBar
1790
1791=item [pixmap;file]
1792
1793=item [pixmap;file;scaling]
1794
1795set a background pixmap
1796
1797=item [read:file]
1798
1799=item [read:file;name]
1800
1801read in a menu from a file
1802
1803=item [dump]
1804
1805dump out all menuBars to /tmp/rxvt-PID
1806
1807=item /
1808
1809access menuBar top level
1810
1811=item ./
1812
1813=item ../
1814
1815=item ../../
1816
1817access current or parent menu level
1818
1819=item /path/menu
1820
1821add/access menu
1822
1823=item /path/{-}
1824
1825add separator
1826
1827=item /path/{item}{rtext} action
1828
1829add/alter menu item
1830
1831=item -/*
1832
1833remove all menus from the menuBar
1834
1835=item -/path/menu
1836
1837remove menu items, separators and submenus from menu
1838
1839=item -/path/menu
1840
1841remove menu
1842
1843=item -/path/{item}
1844
1845remove item
1846
1847=item -/path/{-}
1848
1849remove separator
1850
1851=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1852
1853menu quick arrows
1854
1855=back
1856X<XPM> 1697X<XPM>
1857 1698
1858=head1 XPM 1699=head1 XPM
1859 1700
1860For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1701For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2046=end table 1887=end table
2047 1888
2048=head1 CONFIGURE OPTIONS 1889=head1 CONFIGURE OPTIONS
2049 1890
2050General hint: if you get compile errors, then likely your configuration 1891General hint: if you get compile errors, then likely your configuration
2051hasn't been tested well. Either try with --enable-everything or use the 1892hasn't been tested well. Either try with C<--enable-everything> or use
2052./reconf script as a base for experiments. ./reconf is used by myself, 1893the F<./reconf> script as a base for experiments. F<./reconf> is used by
2053so it should generally be a working config. Of course, you should always 1894myself, so it should generally be a working config. Of course, you should
2054report when a combination doesn't work, so it can be fixed. Marc Lehmann 1895always report when a combination doesn't work, so it can be fixed. Marc
2055<rxvt@schmorp.de>. 1896Lehmann <rxvt@schmorp.de>.
1897
1898All
2056 1899
2057=over 4 1900=over 4
2058 1901
2059=item --enable-everything 1902=item --enable-everything
2060 1903
2061Add support for all non-multichoice options listed in "./configure 1904Add (or remove) support for all non-multichoice options listed in "./configure
2062--help". Note that unlike other enable options this is order dependant. 1905--help".
1906
2063You can specify this and then disable options which this enables by 1907You can specify this and then disable options you do not like by
2064I<following> this with the appropriate commands. 1908I<following> this with the appropriate C<--disable-...> arguments,
1909or you can start with a minimal configuration by specifying
1910C<--disable-everything> and than adding just the C<--enable-...> arguments
1911you want.
2065 1912
2066=item --enable-xft 1913=item --enable-xft (default: enabled)
2067 1914
2068Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1915Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2069slower and require lots of memory, but as long as you don't use them, you 1916slower and require lots of memory, but as long as you don't use them, you
2070don't pay for them. 1917don't pay for them.
2071 1918
2072=item --enable-font-styles 1919=item --enable-font-styles (default: on)
2073 1920
2074Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 1921Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2075styles. The fonts can be set manually or automatically. 1922styles. The fonts can be set manually or automatically.
2076 1923
2077=item --with-codesets=NAME,... 1924=item --with-codesets=NAME,... (default: all)
2078 1925
2079Compile in support for additional codeset (encoding) groups (eu, vn are 1926Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2080always compiled in, which includes most 8-bit character sets). These 1927are always compiled in, which includes most 8-bit character sets). These
2081codeset tables are currently only used for driving X11 core fonts, they 1928codeset tables are used for driving X11 core fonts, they are not required
2082are not required for Xft fonts. Compiling them in will make your binary 1929for Xft fonts, although having them compiled in lets rxvt-unicode choose
2083bigger (together about 700kB), but it doesn't increase memory usage unless 1930replacement fonts more intelligently. Compiling them in will make your
1931binary bigger (all of together cost about 700kB), but it doesn't increase
2084you use an X11 font requiring one of these encodings. 1932memory usage unless you use a font requiring one of these encodings.
2085 1933
2086=begin table 1934=begin table
2087 1935
2088 all all available codeset groups 1936 all all available codeset groups
2089 zh common chinese encodings 1937 zh common chinese encodings
2092 jp_ext rarely used but big japanese encodings 1940 jp_ext rarely used but big japanese encodings
2093 kr korean encodings 1941 kr korean encodings
2094 1942
2095=end table 1943=end table
2096 1944
2097=item --enable-xim 1945=item --enable-xim (default: on)
2098 1946
2099Add support for XIM (X Input Method) protocol. This allows using 1947Add support for XIM (X Input Method) protocol. This allows using
2100alternative input methods (e.g. kinput2) and will also correctly 1948alternative input methods (e.g. kinput2) and will also correctly
2101set up the input for people using dead keys or compose keys. 1949set up the input for people using dead keys or compose keys.
2102 1950
2103=item --enable-unicode3 1951=item --enable-unicode3 (default: off)
2104 1952
2105Enable direct support for displaying unicode codepoints above 1953Enable direct support for displaying unicode codepoints above
210665535 (the basic multilingual page). This increases storage 195465535 (the basic multilingual page). This increases storage
2107requirements per character from 2 to 4 bytes. X11 fonts do not yet 1955requirements per character from 2 to 4 bytes. X11 fonts do not yet
2108support these extra characters, but Xft does. 1956support these extra characters, but Xft does.
2111even without this flag, but the number of such characters is 1959even without this flag, but the number of such characters is
2112limited to a view thousand (shared with combining characters, 1960limited to a view thousand (shared with combining characters,
2113see next switch), and right now rxvt-unicode cannot display them 1961see next switch), and right now rxvt-unicode cannot display them
2114(input/output and cut&paste still work, though). 1962(input/output and cut&paste still work, though).
2115 1963
2116=item --enable-combining 1964=item --enable-combining (default: on)
2117 1965
2118Enable automatic composition of combining characters into 1966Enable automatic composition of combining characters into
2119composite characters. This is required for proper viewing of text 1967composite characters. This is required for proper viewing of text
2120where accents are encoded as seperate unicode characters. This is 1968where accents are encoded as seperate unicode characters. This is
2121done by using precomposited characters when available or creating 1969done by using precomposited characters when available or creating
2122new pseudo-characters when no precomposed form exists. 1970new pseudo-characters when no precomposed form exists.
2123 1971
2124Without --enable-unicode3, the number of additional precomposed 1972Without --enable-unicode3, the number of additional precomposed characters
2125characters is rather limited (2048, if this is full, rxvt will use the 1973is rather limited (2048, if this is full, rxvt-unicode will use the
2126private use area, extending the number of combinations to 8448). With 1974private use area, extending the number of combinations to 8448). With
2127--enable-unicode3, no practical limit exists. This will also enable 1975--enable-unicode3, no practical limit exists.
2128storage of characters >65535. 1976
1977This option will also enable storage (but not display) of characters
1978beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2129 1979
2130The combining table also contains entries for arabic presentation forms, 1980The combining table also contains entries for arabic presentation forms,
2131but these are not currently used. Bug me if you want these to be used. 1981but these are not currently used. Bug me if you want these to be used (and
1982tell me how these are to be used...).
2132 1983
2133=item --enable-fallback(=CLASS) 1984=item --enable-fallback(=CLASS) (default: Rxvt)
2134 1985
2135When reading resource settings, also read settings for class CLASS 1986When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2136(default: Rxvt). To disable resource fallback use --disable-fallback.
2137 1987
2138=item --with-res-name=NAME 1988=item --with-res-name=NAME (default: urxvt)
2139 1989
2140Use the given name (default: urxvt) as default application name when 1990Use the given name as default application name when
2141reading resources. Specify --with-res-name=rxvt to replace rxvt. 1991reading resources. Specify --with-res-name=rxvt to replace rxvt.
2142 1992
2143=item --with-res-class=CLASS 1993=item --with-res-class=CLASS /default: URxvt)
2144 1994
2145Use the given class (default: URxvt) as default application class 1995Use the given class as default application class
2146when reading resources. Specify --with-res-class=Rxvt to replace 1996when reading resources. Specify --with-res-class=Rxvt to replace
2147rxvt. 1997rxvt.
2148 1998
2149=item --enable-utmp 1999=item --enable-utmp (default: on)
2150 2000
2151Write user and tty to utmp file (used by programs like F<w>) at 2001Write user and tty to utmp file (used by programs like F<w>) at
2152start of rxvt execution and delete information when rxvt exits. 2002start of rxvt execution and delete information when rxvt exits.
2153 2003
2154=item --enable-wtmp 2004=item --enable-wtmp (default: on)
2155 2005
2156Write user and tty to wtmp file (used by programs like F<last>) at 2006Write user and tty to wtmp file (used by programs like F<last>) at
2157start of rxvt execution and write logout when rxvt exits. This 2007start of rxvt execution and write logout when rxvt exits. This
2158option requires --enable-utmp to also be specified. 2008option requires --enable-utmp to also be specified.
2159 2009
2160=item --enable-lastlog 2010=item --enable-lastlog (default: on)
2161 2011
2162Write user and tty to lastlog file (used by programs like 2012Write user and tty to lastlog file (used by programs like
2163F<lastlogin>) at start of rxvt execution. This option requires 2013F<lastlogin>) at start of rxvt execution. This option requires
2164--enable-utmp to also be specified. 2014--enable-utmp to also be specified.
2165 2015
2166=item --enable-xpm-background 2016=item --enable-xpm-background (default: on)
2167 2017
2168Add support for XPM background pixmaps. 2018Add support for XPM background pixmaps.
2169 2019
2170=item --enable-transparency 2020=item --enable-transparency (default: on)
2171 2021
2172Add support for inheriting parent backgrounds thus giving a fake 2022Add support for inheriting parent backgrounds thus giving a fake
2173transparency to the term. 2023transparency to the term.
2174 2024
2175=item --enable-fading 2025=item --enable-fading (default: on)
2176 2026
2177Add support for fading the text when focus is lost. 2027Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2178 2028
2179=item --enable-tinting 2029=item --enable-tinting (default: on)
2180 2030
2181Add support for tinting of transparent backgrounds. 2031Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2182 2032
2183=item --enable-menubar
2184
2185Add support for our menu bar system (this interacts badly with
2186dynamic locale switching currently).
2187
2188=item --enable-rxvt-scroll 2033=item --enable-rxvt-scroll (default: on)
2189 2034
2190Add support for the original rxvt scrollbar. 2035Add support for the original rxvt scrollbar.
2191 2036
2192=item --enable-next-scroll 2037=item --enable-next-scroll (default: on)
2193 2038
2194Add support for a NeXT-like scrollbar. 2039Add support for a NeXT-like scrollbar.
2195 2040
2196=item --enable-xterm-scroll 2041=item --enable-xterm-scroll (default: on)
2197 2042
2198Add support for an Xterm-like scrollbar. 2043Add support for an Xterm-like scrollbar.
2199 2044
2200=item --enable-plain-scroll 2045=item --enable-plain-scroll (default: on)
2201 2046
2202Add support for a very unobtrusive, plain-looking scrollbar that 2047Add support for a very unobtrusive, plain-looking scrollbar that
2203is the favourite of the rxvt-unicode author, having used it for 2048is the favourite of the rxvt-unicode author, having used it for
2204many years. 2049many years.
2205 2050
2206=item --enable-half-shadow 2051=item --enable-half-shadow (default: off)
2207 2052
2208Make shadows on the scrollbar only half the normal width & height. 2053Make shadows on the scrollbar only half the normal width & height.
2209only applicable to rxvt scrollbars. 2054only applicable to rxvt scrollbars.
2210 2055
2211=item --enable-ttygid 2056=item --enable-ttygid (default: off)
2212 2057
2213Change tty device setting to group "tty" - only use this if 2058Change tty device setting to group "tty" - only use this if
2214your system uses this type of security. 2059your system uses this type of security.
2215 2060
2216=item --disable-backspace-key 2061=item --disable-backspace-key
2217 2062
2218Disable any handling of the backspace key by us - let the X server 2063Removes any handling of the backspace key by us - let the X server do it.
2064
2065=item --disable-delete-key
2066
2067Removes any handling of the delete key by us - let the X server
2219do it. 2068do it.
2220 2069
2221=item --disable-delete-key
2222
2223Disable any handling of the delete key by us - let the X server
2224do it.
2225
2226=item --disable-resources 2070=item --disable-resources
2227 2071
2228Remove all resources checking. 2072Removes any support for resource checking.
2229
2230=item --enable-xgetdefault
2231
2232Make resources checking via XGetDefault() instead of our small
2233version which only checks ~/.Xdefaults, or if that doesn't exist
2234then ~/.Xresources.
2235
2236=item --enable-strings
2237
2238Add support for our possibly faster memset() function and other
2239various routines, overriding your system's versions which may
2240have been hand-crafted in assembly or may require extra libraries
2241to link in. (this breaks ANSI-C rules and has problems on many
2242GNU/Linux systems).
2243 2073
2244=item --disable-swapscreen 2074=item --disable-swapscreen
2245 2075
2246Remove support for swap screen. 2076Remove support for secondary/swap screen.
2247 2077
2248=item --enable-frills 2078=item --enable-frills (default: on)
2249 2079
2250Add support for many small features that are not essential but nice to 2080Add support for many small features that are not essential but nice to
2251have. Normally you want this, but for very small binaries you may want to 2081have. Normally you want this, but for very small binaries you may want to
2252disable this. 2082disable this.
2253 2083
2084A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2085in combination with other switches) is:
2086
2087 MWM-hints
2088 EWMH-hints (pid, utf8 names) and protocols (ping)
2089 seperate underline colour (-underlineColor)
2090 settable border widths and borderless switch (-w, -b, -bl)
2091 settable extra linespacing /-lsp)
2092 iso-14755-2 and -3, and visual feedback
2093 backindex and forwardindex escape sequence
2094 window op and some xterm/OSC escape sequences
2095 tripleclickwords (-tcw)
2096 settable insecure mode (-insecure)
2097 keysym remapping support
2098 cursor blinking and underline cursor (-cb, -uc)
2099 XEmbed support (-embed)
2100 user-pty (-pty-fd)
2101 hold on exit (-hold)
2102 skip builtin block graphics (-sbg)
2103 sgr modes 90..97 and 100..107
2104
2254=item --enable-iso14755 2105=item --enable-iso14755 (default: on)
2255 2106
2256Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2107Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2257F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2108F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2258C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2109C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2259this switch. 2110this switch.
2260 2111
2261=item --enable-linespace
2262
2263Add support to provide user specified line spacing between text rows.
2264
2265=item --enable-keepscrolling 2112=item --enable-keepscrolling (default: on)
2266 2113
2267Add support for continual scrolling of the display when you hold 2114Add support for continual scrolling of the display when you hold
2268the mouse button down on a scrollbar arrow. 2115the mouse button down on a scrollbar arrow.
2269 2116
2270=item --enable-mousewheel 2117=item --enable-mousewheel (default: on)
2271 2118
2272Add support for scrolling via mouse wheel or buttons 4 & 5. 2119Add support for scrolling via mouse wheel or buttons 4 & 5.
2273 2120
2274=item --enable-slipwheeling 2121=item --enable-slipwheeling (default: on)
2275 2122
2276Add support for continual scrolling (using the mouse wheel as an 2123Add support for continual scrolling (using the mouse wheel as an
2277accelerator) while the control key is held down. This option 2124accelerator) while the control key is held down. This option
2278requires --enable-mousewheel to also be specified. 2125requires --enable-mousewheel to also be specified.
2279 2126
2280=item --disable-new-selection 2127=item --disable-new-selection
2281 2128
2282Remove support for mouse selection style like that of xterm. 2129Remove support for mouse selection style like that of xterm.
2283 2130
2284=item --enable-dmalloc 2131=item --enable-dmalloc (default: off)
2285 2132
2286Use Gray Watson's malloc - which is good for debugging See 2133Use Gray Watson's malloc - which is good for debugging See
2287http://www.letters.com/dmalloc/ for details If you use either this or the 2134http://www.letters.com/dmalloc/ for details If you use either this or the
2288next option, you may need to edit src/Makefile after compiling to point 2135next option, you may need to edit src/Makefile after compiling to point
2289DINCLUDE and DLIB to the right places. 2136DINCLUDE and DLIB to the right places.
2290 2137
2291You can only use either this option and the following (should 2138You can only use either this option and the following (should
2292you use either) . 2139you use either) .
2293 2140
2294=item --enable-dlmalloc 2141=item --enable-dlmalloc (default: off)
2295 2142
2296Use Doug Lea's malloc - which is good for a production version 2143Use Doug Lea's malloc - which is good for a production version
2297See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2144See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2298 2145
2299=item --enable-smart-resize 2146=item --enable-smart-resize (default: on)
2300 2147
2301Add smart growth/shrink behaviour when changing font size via from hot 2148Add smart growth/shrink behaviour when changing font size via hot
2302keys. This should keep in a fixed position the rxvt corner which is 2149keys. This should keep the window corner which is closest to a corner of
2303closest to a corner of the screen. 2150the screen in a fixed position.
2304 2151
2305=item --enable-cursor-blink
2306
2307Add support for a blinking cursor.
2308
2309=item --enable-pointer-blank 2152=item --enable-pointer-blank (default: on)
2310 2153
2311Add support to have the pointer disappear when typing or inactive. 2154Add support to have the pointer disappear when typing or inactive.
2312 2155
2313=item --with-name=NAME 2156=item --enable-perl (default: off)
2314 2157
2158Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2159manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2160in F<src/perl-ext/> for the extensions that are installed by default. The
2161perl interpreter that is used can be specified via the C<PERL> environment
2162variable when running configure.
2163
2164=item --with-name=NAME (default: urxvt)
2165
2315Set the basename for the installed binaries (default: urxvt, resulting in 2166Set the basename for the installed binaries, resulting
2316urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2167in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2168C<rxvt>.
2317 2169
2318=item --with-term=NAME 2170=item --with-term=NAME (default: rxvt-unicode)
2319 2171
2320Change the environmental variable for the terminal to NAME (default 2172Change the environmental variable for the terminal to NAME.
2321"rxvt")
2322 2173
2323=item --with-terminfo=PATH 2174=item --with-terminfo=PATH
2324 2175
2325Change the environmental variable for the path to the terminfo tree to 2176Change the environmental variable for the path to the terminfo tree to
2326PATH. 2177PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines