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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines