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.60 by root, Fri Jul 29 03:12:10 2005 UTC vs.
Revision 1.100 by root, Tue Jan 31 01:00:49 2006 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 FREQUENTLY ASKED QUESTIONS
26 25
27=over 4 26=head2 The new selection selects pieces that are too big, how can I select
27single words?
28 28
29If you want to select e.g. alphanumeric words, you can use the following
30setting:
31
32 URxvt.selection.pattern-0: ([[:word:]]+)
33
34If you click more than twice, the selection will be extended
35more and more.
36
37To get a selection that is very similar to the old code, try this pattern:
38
39 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
40
41Please also note that the I<LeftClick Shift-LeftClik> combination also
42selects words like the old code.
43
44=head2 I don't like the new selection/popups/hotkeys/perl, how do I
45change/disable it?
46
47You can disable the perl extension completely by setting the
48B<perl-ext-common> resource to the empty string, which also keeps
49rxvt-unicode from initialising perl, saving memory.
50
51If you only want to disable specific features, you first have to
52identify which perl extension is responsible. For this, read the section
53B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
54example, to disable the B<selection-popup> and B<option-popup>, specify
55this B<perl-ext-common> resource:
56
57 URxvt.perl-ext-common: default,-selection-popup,-option-popup
58
59This will keep the default extensions, but disable the two popup
60extensions. Some extensions can also be configured, for example,
61scrollback search mode is triggered by B<M-s>. You can move it to any
62other combination either by setting the B<searchable-scrollback> resource:
63
64 URxvt.searchable-scrollback: CM-s
65
66=head3 The cursor moves when selecting text in the current input line, how
67do I switch this off?
68
69See next entry.
70
71=head2 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor
72outputs strange escape sequences, how do I fix this?
73
74These are caused by the C<readline> perl extension. Under normal
75circumstances, it will move your cursor around when you click into the
76line that contains it. It tries hard not to do this at the wrong moment,
77but when running a program that doesn't parse cursor movements or in some
78cases during rlogin sessions, it fails to detect this properly.
79
80You can permamently switch this feature off by disabling the C<readline>
81extension:
82
83 URxvt.perl-ext-common: default,-readline
84
85=head2 Why doesn't rxvt-unicode read my resources?
86
87Well, why, indeed? It does, in a way very similar to other X
88applications. Most importantly, this means that if you or your OS loads
89resources into the X display (the right way to do it), rxvt-unicode will
90ignore any resource files in your home directory. It will only read
91F<$HOME/.Xdefaults> when no resources are attached to the display.
92
93If you have or use an F<$HOME/.Xresources> file, chances are that
94resources are loaded into your X-server. In this case, you have to
95re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
96
97Also consider the form resources have to use:
98
99 URxvt.resource: value
100
101If you want to use another form (there are lots of different ways of
102specifying resources), make sure you understand wether and why it
103works. If unsure, use the form above.
104
105=head2 I can't get transparency working, what am I doing wrong?
106
107First of all, transparency isn't officially supported in rxvt-unicode, so
108you are mostly on your own. Do not bug the author about it (but you may
109bug everybody else). Also, if you can't get it working consider it a rite
110of passage: ... and you failed.
111
112Here are four ways to get transparency. B<Do> read the manpage and option
113descriptions for the programs mentioned and rxvt-unicode. Really, do it!
114
1151. Use inheritPixmap:
116
117 Esetroot wallpaper.jpg
118 @@RXVT_NAME@@ -ip -tint red -sh 40
119
120That works. If you think it doesn't, you lack transparency and tinting
121support, or you are unable to read.
122
1232. Use a simple pixmap and emulate pseudo-transparency. This enables you
124to use effects other than tinting and shading: Just shade/tint/whatever
125your picture with gimp:
126
127 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
128 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
129
130That works. If you think it doesn't, you lack XPM and Perl support, or you
131are unable to read.
132
1333. Use an ARGB visual:
134
135 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
136
137This requires XFT support, and the support of your X-server. If that
138doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
139there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
140bugfixes and workarounds for Xft and Xlib to make it work, but that
141doesn't mean that your WM has the required kludges in place.
142
1434. Use xcompmgr and let it do the job:
144
145 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
146 -set _NET_WM_WINDOW_OPACITY 0xc0000000
147
148Then click on a window you want to make transparent. Replace C<0xc0000000>
149by other values to change the degree of opacity. If it doesn't work and
150your server crashes, you got to keep the pieces.
151
152=head2 Isn't rxvt supposed to be small? Don't all those features bloat?
153
154I often get asked about this, and I think, no, they didn't cause extra
155bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
156that the urxvt binary is larger (due to some encoding tables always being
157compiled in), but it actually uses less memory (RSS) after startup. Even
158with C<--disable-everything>, this comparison is a bit unfair, as many
159features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
160already in use in this mode.
161
162 text data bss drs rss filename
163 98398 1664 24 15695 1824 rxvt --disable-everything
164 188985 9048 66616 18222 1788 urxvt --disable-everything
165
166When you C<--enable-everything> (which _is_ unfair, as this involves xft
167and full locale/XIM support which are quite bloaty inside libX11 and my
168libc), the two diverge, but not unreasnobaly so.
169
170 text data bss drs rss filename
171 163431 2152 24 20123 2060 rxvt --enable-everything
172 1035683 49680 66648 29096 3680 urxvt --enable-everything
173
174The very large size of the text section is explained by the east-asian
175encoding tables, which, if unused, take up disk space but nothing else
176and can be compiled out unless you rely on X11 core fonts that use those
177encodings. The BSS size comes from the 64k emergency buffer that my c++
178compiler allocates (but of course doesn't use unless you are out of
179memory). Also, using an xft font instead of a core font immediately adds a
180few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
181not used.
182
183Of course, due to every character using two or four bytes instead of one,
184a large scrollback buffer will ultimately make rxvt-unicode use more
185memory.
186
187Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
188still fares rather well. And compared to some monsters like gnome-terminal
189(21152k + extra 4204k in separate processes) or konsole (22200k + extra
19043180k in daemons that stay around after exit, plus half a minute of
191startup time, including the hundreds of warnings it spits out), it fares
192extremely well *g*.
193
194=head2 Why C++, isn't that unportable/bloated/uncool?
195
196Is this a question? :) It comes up very often. The simple answer is: I had
197to write it, and C++ allowed me to write and maintain it in a fraction
198of the time and effort (which is a scarce resource for me). Put even
199shorter: It simply wouldn't exist without C++.
200
201My personal stance on this is that C++ is less portable than C, but in
202the case of rxvt-unicode this hardly matters, as its portability limits
203are defined by things like X11, pseudo terminals, locale support and unix
204domain sockets, which are all less portable than C++ itself.
205
206Regarding the bloat, see the above question: It's easy to write programs
207in C that use gobs of memory, an certainly possible to write programs in
208C++ that don't. C++ also often comes with large libraries, but this is
209not necessarily the case with GCC. Here is what rxvt links against on my
210system with a minimal config:
211
212 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
213 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
214 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
215 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
216
217And here is rxvt-unicode:
218
219 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
220 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
221 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
222 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
223 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
224
225No large bloated libraries (of course, none were linked in statically),
226except maybe libX11 :)
227
228=head2 Does it support tabs, can I have a tabbed rxvt-unicode?
229
230Beginning with version 7.3, there is a perl extension that implements a
231simple tabbed terminal. It is installed by default, so any of these should
232give you tabs:
233
234 @@RXVT_NAME@@ -pe tabbed
235
236 URxvt.perl-ext-common: default,tabbed
237
238It will also work fine with tabbing functionality of many window managers
239or similar tabbing programs, and its embedding-features allow it to be
240embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
241the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
242(murxvt) terminal as an example embedding application.
243
29=item How do I know which rxvt-unicode version I'm using? 244=head2 How do I know which rxvt-unicode version I'm using?
30 245
31The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 247sequence C<ESC [ 8 n> sets the window title to the version number. When
248using the @@RXVT_NAME@@c client, the version displayed is that of the
249daemon.
33 250
34=item I am using Debian GNU/Linux and have a problem... 251=head2 I am using Debian GNU/Linux and have a problem...
35 252
36The Debian GNU/Linux package of rxvt-unicode in sarge contains large 253The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37patches that considerably change the behaviour of rxvt-unicode. Before 254patches that considerably change the behaviour of rxvt-unicode (but
38reporting a bug to the original rxvt-unicode author please download and 255unfortunately this notice has been removed). Before reporting a bug to
39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 256the original rxvt-unicode author please download and install the genuine
40and try to reproduce the problem. If you cannot, chances are that the 257version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
41problems are specific to Debian GNU/Linux, in which case it should be 258the problem. If you cannot, chances are that the problems are specific to
42reported via the Debian Bug Tracking System (use C<reportbug> to report 259Debian GNU/Linux, in which case it should be reported via the Debian Bug
43the bug). 260Tracking System (use C<reportbug> to report the bug).
44 261
45For other problems that also affect the Debian package, you can and 262For other problems that also affect the Debian package, you can and
46probably should use the Debian BTS, too, because, after all, it's also a 263probably should use the Debian BTS, too, because, after all, it's also a
47bug in the Debian version and it serves as a reminder for other users that 264bug in the Debian version and it serves as a reminder for other users that
48might encounter the same issue. 265might encounter the same issue.
49 266
267=head2 I am maintaining rxvt-unicode for distribution/OS XXX, any
268recommendation?
269
270You should build one binary with the default options. F<configure>
271now enables most useful options, and the trend goes to making them
272runtime-switchable, too, so there is usually no drawback to enbaling them,
273except higher disk and possibly memory usage. The perl interpreter should
274be enabled, as important functionality (menus, selection, likely more in
275the future) depends on it.
276
277You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
278system-wide (except maybe with C<defaults>). This will result in useful
279behaviour. If your distribution aims at low memory, add an empty
280C<perl-ext-common> resource to the app-defaults file. This will keep the
281perl interpreter disabled until the user enables it.
282
283If you can/want build more binaries, I recommend building a minimal
284one with C<--disable-everything> (very useful) and a maximal one with
285C<--enable-everything> (less useful, it will be very big due to a lot of
286encodings built-in that increase download times and are rarely used).
287
288=head2 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
289
290It should be, starting with release 7.1. You are encouraged to properly
291install urxvt with privileges necessary for your OS now.
292
293When rxvt-unicode detects that it runs setuid or setgid, it will fork
294into a helper process for privileged operations (pty handling on some
295systems, utmp/wtmp/lastlog handling on others) and drop privileges
296immediately. This is much safer than most other terminals that keep
297privileges while running (but is more relevant to urxvt, as it contains
298things as perl interpreters, which might be "helpful" to attackers).
299
300This forking is done as the very first within main(), which is very early
301and reduces possible bugs to initialisation code run before main(), or
302things like the dynamic loader of your system, which should result in very
303little risk.
304
50=item When I log-in to another system it tells me about missing terminfo data? 305=head2 When I log-in to another system it tells me about missing terminfo data?
51 306
52The terminal description used by rxvt-unicode is not as widely available 307The terminal description used by rxvt-unicode is not as widely available
53as that for xterm, or even rxvt (for which the same problem often arises). 308as that for xterm, or even rxvt (for which the same problem often arises).
54 309
55The correct solution for this problem is to install the terminfo, this can 310The correct solution for this problem is to install the terminfo, this can
73 URxvt.termName: rxvt 328 URxvt.termName: rxvt
74 329
75If you don't plan to use B<rxvt> (quite common...) you could also replace 330If you don't plan to use B<rxvt> (quite common...) you could also replace
76the rxvt terminfo file with the rxvt-unicode one. 331the rxvt terminfo file with the rxvt-unicode one.
77 332
78=item C<tic> outputs some error when compiling the terminfo entry. 333=head2 C<tic> outputs some error when compiling the terminfo entry.
79 334
80Most likely it's the empty definition for C<enacs=>. Just replace it by 335Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again. 336C<enacs=\E[0@> and try again.
82 337
83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 338=head2 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
84 339
340See next entry.
341
85=item I need a termcap file entry. 342=head2 I need a termcap file entry.
86 343
87One reason you might want this is that some distributions or operating 344One reason you might want this is that some distributions or operating
88systems still compile some programs using the long-obsoleted termcap 345systems still compile some programs using the long-obsoleted termcap
89library (Fedora Core's bash is one example) and rely on a termcap entry 346library (Fedora Core's bash is one example) and rely on a termcap entry
90for C<rxvt-unicode>. 347for C<rxvt-unicode>.
116 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 373 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
117 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 374 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
118 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 375 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
119 :vs=\E[?25h: 376 :vs=\E[?25h:
120 377
121=item Why does C<ls> no longer have coloured output? 378=head2 Why does C<ls> no longer have coloured output?
122 379
123The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 380The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
124decide wether a terminal has colour, but uses it's own configuration 381decide wether a terminal has colour, but uses it's own configuration
125file. Needless to say, C<rxvt-unicode> is not in it's default file (among 382file. Needless to say, C<rxvt-unicode> is not in it's default file (among
126with most other terminals supporting colour). Either add: 383with most other terminals supporting colour). Either add:
131 388
132 alias ls='ls --color=auto' 389 alias ls='ls --color=auto'
133 390
134to your C<.profile> or C<.bashrc>. 391to your C<.profile> or C<.bashrc>.
135 392
136=item Why doesn't vim/emacs etc. use the 88 colour mode? 393=head2 Why doesn't vim/emacs etc. use the 88 colour mode?
137 394
395See next entry.
396
138=item Why doesn't vim/emacs etc. make use of italic? 397=head2 Why doesn't vim/emacs etc. make use of italic?
139 398
399See next entry.
400
140=item Why are the secondary screen-related options not working properly? 401=head2 Why are the secondary screen-related options not working properly?
141 402
142Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 403Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
143distributions (most notably Debian GNU/Linux) break rxvt-unicode 404distributions (most notably Debian GNU/Linux) break rxvt-unicode
144by setting C<TERM> to C<rxvt>, which doesn't have these extra 405by setting C<TERM> to C<rxvt>, which doesn't have these extra
145features. Unfortunately, some of these (most notably, again, Debian 406features. Unfortunately, some of these (most notably, again, Debian
146GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 407GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
147file, so you will need to install it on your own (See the question B<When 408file, so you will need to install it on your own (See the question B<When
148I log-in to another system it tells me about missing terminfo data?> on 409I log-in to another system it tells me about missing terminfo data?> on
149how to do this). 410how to do this).
150 411
151=item My numerical keypad acts weird and generates differing output? 412=head2 My numerical keypad acts weird and generates differing output?
152 413
153Some Debian GNUL/Linux users seem to have this problem, although no 414Some Debian GNUL/Linux users seem to have this problem, although no
154specific details were reported so far. It is possible that this is caused 415specific details were reported so far. It is possible that this is caused
155by the wrong C<TERM> setting, although the details of wether and how 416by the wrong C<TERM> setting, although the details of wether and how
156this can happen are unknown, as C<TERM=rxvt> should offer a compatible 417this can happen are unknown, as C<TERM=rxvt> should offer a compatible
157keymap. See the answer to the previous question, and please report if that 418keymap. See the answer to the previous question, and please report if that
158helped. 419helped.
159 420
160=item Rxvt-unicode does not seem to understand the selected encoding? 421=head2 Rxvt-unicode does not seem to understand the selected encoding?
161 422
423See next entry.
424
162=item Unicode does not seem to work? 425=head2 Unicode does not seem to work?
163 426
164If you encounter strange problems like typing an accented character but 427If you encounter strange problems like typing an accented character but
165getting two unrelated other characters or similar, or if program output is 428getting two unrelated other characters or similar, or if program output is
166subtly garbled, then you should check your locale settings. 429subtly garbled, then you should check your locale settings.
167 430
187 450
188If nothing works and you are sure that everything is set correctly then 451If nothing works and you are sure that everything is set correctly then
189you will need to remember a little known fact: Some programs just don't 452you will need to remember a little known fact: Some programs just don't
190support locales :( 453support locales :(
191 454
192=item Why do some characters look so much different than others? 455=head2 Why do some characters look so much different than others?
193 456
457See next entry.
458
194=item How does rxvt-unicode choose fonts? 459=head2 How does rxvt-unicode choose fonts?
195 460
196Most fonts do not contain the full range of Unicode, which is 461Most fonts do not contain the full range of Unicode, which is
197fine. Chances are that the font you (or the admin/package maintainer of 462fine. Chances are that the font you (or the admin/package maintainer of
198your system/os) have specified does not cover all the characters you want 463your system/os) have specified does not cover all the characters you want
199to display. 464to display.
217 482
218The only limitation is that none of the fonts may be larger than the base 483The only limitation is that none of the fonts may be larger than the base
219font, as the base font defines the terminal character cell size, which 484font, as the base font defines the terminal character cell size, which
220must be the same due to the way terminals work. 485must be the same due to the way terminals work.
221 486
222=item Why do some chinese characters look so different than others? 487=head2 Why do some chinese characters look so different than others?
223 488
224This is because there is a difference between script and language -- 489This is because there is a difference between script and language --
225rxvt-unicode does not know which language the text that is output is, 490rxvt-unicode does not know which language the text that is output is,
226as it only knows the unicode character codes. If rxvt-unicode first 491as it only knows the unicode character codes. If rxvt-unicode first
227sees a japanese/chinese character, it might choose a japanese font for 492sees a japanese/chinese character, it might choose a japanese font for
242has been designed yet). 507has been designed yet).
243 508
244Until then, you might get away with switching fonts at runtime (see L<Can 509Until then, you might get away with switching fonts at runtime (see L<Can
245I switch the fonts at runtime?> later in this document). 510I switch the fonts at runtime?> later in this document).
246 511
247=item Why does rxvt-unicode sometimes leave pixel droppings? 512=head2 Why does rxvt-unicode sometimes leave pixel droppings?
248 513
249Most fonts were not designed for terminal use, which means that character 514Most fonts were not designed for terminal use, which means that character
250size varies a lot. A font that is otherwise fine for terminal use might 515size varies a lot. A font that is otherwise fine for terminal use might
251contain some characters that are simply too wide. Rxvt-unicode will avoid 516contain some characters that are simply too wide. Rxvt-unicode will avoid
252these characters. For characters that are just "a bit" too wide a special 517these characters. For characters that are just "a bit" too wide a special
264might be forced to use a different font. 529might be forced to use a different font.
265 530
266All of this is not a problem when using X11 core fonts, as their bounding 531All of this is not a problem when using X11 core fonts, as their bounding
267box data is correct. 532box data is correct.
268 533
269=item On Solaris 9, many line-drawing characters are too wide. 534=head2 On Solaris 9, many line-drawing characters are too wide.
270 535
271Seems to be a known bug, read 536Seems to be a known bug, read
272L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 537L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
273following ugly workaround to get non-double-wide-characters working: 538following ugly workaround to get non-double-wide-characters working:
274 539
275 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 540 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
276 541
277=item My Compose (Multi_key) key is no longer working. 542=head2 My Compose (Multi_key) key is no longer working.
278 543
279The most common causes for this are that either your locale is not set 544The most common causes for this are that either your locale is not set
280correctly, or you specified a B<preeditStyle> that is not supported by 545correctly, or you specified a B<preeditStyle> that is not supported by
281your input method. For example, if you specified B<OverTheSpot> and 546your input method. For example, if you specified B<OverTheSpot> and
282your input method (e.g. the default input method handling Compose keys) 547your input method (e.g. the default input method handling Compose keys)
284rxvt-unicode will continue without an input method. 549rxvt-unicode will continue without an input method.
285 550
286In this case either do not specify a B<preeditStyle> or specify more than 551In this case either do not specify a B<preeditStyle> or specify more than
287one pre-edit style, such as B<OverTheSpot,Root,None>. 552one pre-edit style, such as B<OverTheSpot,Root,None>.
288 553
289=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 554=head2 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
290 555
291Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 556Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
292international keyboards) or simply use ISO 14755 support to your 557international keyboards) or simply use ISO 14755 support to your
293advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 558advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
294codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 559codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
295character and so on. 560character and so on.
296 561
297=item How can I keep rxvt-unicode from using reverse video so much? 562=head2 How can I keep rxvt-unicode from using reverse video so much?
298 563
299First of all, make sure you are running with the right terminal settings 564First of all, make sure you are running with the right terminal settings
300(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 565(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
301make sure you have specified colours for italic and bold, as otherwise 566make sure you have specified colours for italic and bold, as otherwise
302rxvt-unicode might use reverse video to simulate the effect: 567rxvt-unicode might use reverse video to simulate the effect:
303 568
304 URxvt.colorBD: white 569 URxvt.colorBD: white
305 URxvt.colorIT: green 570 URxvt.colorIT: green
306 571
307=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 572=head2 Some programs assume totally weird colours (red instead of blue), how can I fix that?
308 573
309For some unexplainable reason, some rare programs assume a very weird 574For some unexplainable reason, some rare programs assume a very weird
310colour palette when confronted with a terminal with more than the standard 575colour palette when confronted with a terminal with more than the standard
3118 colours (rxvt-unicode supports 88). The right fix is, of course, to fix 5768 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
312these programs not to assume non-ISO colours without very good reasons. 577these programs not to assume non-ISO colours without very good reasons.
313 578
314In the meantime, you can either edit your C<rxvt-unicode> terminfo 579In the meantime, you can either edit your C<rxvt-unicode> terminfo
315definition to only claim 8 colour support or use C<TERM=rxvt>, which will 580definition to only claim 8 colour support or use C<TERM=rxvt>, which will
316fix colours but keep you from using other rxvt-unicode features. 581fix colours but keep you from using other rxvt-unicode features.
317 582
318=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 583=head2 I am on FreeBSD and rxvt-unicode does not seem to work at all.
319 584
320Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 585Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
321in your compile environment, or an implementation that implements it, 586in your compile environment, or an implementation that implements it,
322wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 587wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
323B<wchar_t> is represented as unicode. 588B<wchar_t> is represented as unicode.
345 610
346The rxvt-unicode author insists that the right way to fix this is in the 611The rxvt-unicode author insists that the right way to fix this is in the
347system libraries once and for all, instead of forcing every app to carry 612system libraries once and for all, instead of forcing every app to carry
348complete replacements for them :) 613complete replacements for them :)
349 614
350=item I use Solaris 9 and it doesn't compile/work/etc. 615=head2 I use Solaris 9 and it doesn't compile/work/etc.
351 616
352Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 617Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
353problems with C<wcwidth> and a compile problem. 618problems with C<wcwidth> and a compile problem.
354 619
355=item How can I use rxvt-unicode under cygwin? 620=head2 How can I use rxvt-unicode under cygwin?
356 621
357rxvt-unicode should compile and run out of the box on cygwin, using 622rxvt-unicode should compile and run out of the box on cygwin, using
358the X11 libraries that come with cygwin. libW11 emulation is no 623the X11 libraries that come with cygwin. libW11 emulation is no
359longer supported (and makes no sense, either, as it only supported a 624longer supported (and makes no sense, either, as it only supported a
360single font). I recommend starting the X-server in C<-multiwindow> or 625single font). I recommend starting the X-server in C<-multiwindow> or
363 628
364At the time of this writing, cygwin didn't seem to support any multi-byte 629At the time of this writing, cygwin didn't seem to support any multi-byte
365encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 630encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
366to 8-bit encodings. 631to 8-bit encodings.
367 632
368=item How does rxvt-unicode determine the encoding to use? 633=head2 How does rxvt-unicode determine the encoding to use?
369 634
635See next entry.
636
370=item Is there an option to switch encodings? 637=head2 Is there an option to switch encodings?
371 638
372Unlike some other terminals, rxvt-unicode has no encoding switch, and no 639Unlike some other terminals, rxvt-unicode has no encoding switch, and no
373specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 640specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
374UTF-8 or any other encodings with respect to terminal I/O. 641UTF-8 or any other encodings with respect to terminal I/O.
375 642
400rxvt-unicode. 667rxvt-unicode.
401 668
402If you want to use a specific encoding you have to make sure you start 669If you want to use a specific encoding you have to make sure you start
403rxvt-unicode with the correct C<LC_CTYPE> category. 670rxvt-unicode with the correct C<LC_CTYPE> category.
404 671
405=item Can I switch locales at runtime? 672=head2 Can I switch locales at runtime?
406 673
407Yes, using an escape sequence. Try something like this, which sets 674Yes, using an escape sequence. Try something like this, which sets
408rxvt-unicode's idea of C<LC_CTYPE>. 675rxvt-unicode's idea of C<LC_CTYPE>.
409 676
410 printf '\e]701;%s\007' ja_JP.SJIS 677 printf '\e]701;%s\007' ja_JP.SJIS
422 689
423You can also use xterm's C<luit> program, which usually works fine, except 690You can also use xterm's C<luit> program, which usually works fine, except
424for some locales where character width differs between program- and 691for some locales where character width differs between program- and
425rxvt-unicode-locales. 692rxvt-unicode-locales.
426 693
427=item Can I switch the fonts at runtime? 694=head2 Can I switch the fonts at runtime?
428 695
429Yes, using an escape sequence. Try something like this, which has the same 696Yes, using an escape sequence. Try something like this, which has the same
430effect as using the C<-fn> switch, and takes effect immediately: 697effect as using the C<-fn> switch, and takes effect immediately:
431 698
432 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 699 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
435japanese font), but you have to switch to chinese temporarily, where 702japanese font), but you have to switch to chinese temporarily, where
436japanese fonts would only be in your way. 703japanese fonts would only be in your way.
437 704
438You can think of this as a kind of manual ISO-2022 switching. 705You can think of this as a kind of manual ISO-2022 switching.
439 706
440=item Why do italic characters look as if clipped? 707=head2 Why do italic characters look as if clipped?
441 708
442Many fonts have difficulties with italic characters and hinting. For 709Many fonts have difficulties with italic characters and hinting. For
443example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 710example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
444Mono> completely fails in it's italic face. A workaround might be to 711Mono> completely fails in it's italic face. A workaround might be to
445enable freetype autohinting, i.e. like this: 712enable freetype autohinting, i.e. like this:
446 713
447 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 714 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
448 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 715 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
449 716
450=item My input method wants <some encoding> but I want UTF-8, what can I do? 717=head2 My input method wants <some encoding> but I want UTF-8, what can I do?
451 718
452You can specify separate locales for the input method and the rest of the 719You can specify separate locales for the input method and the rest of the
453terminal, using the resource C<imlocale>: 720terminal, using the resource C<imlocale>:
454 721
455 URxvt*imlocale: ja_JP.EUC-JP 722 URxvt.imlocale: ja_JP.EUC-JP
456 723
457Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 724Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458use your input method. Please note, however, that you will not be able to 725use your input method. Please note, however, that you will not be able to
459input characters outside C<EUC-JP> in a normal way then, as your input 726input characters outside C<EUC-JP> in a normal way then, as your input
460method limits you. 727method limits you.
461 728
462=item Rxvt-unicode crashes when the X Input Method changes or exits. 729=head2 Rxvt-unicode crashes when the X Input Method changes or exits.
463 730
464Unfortunately, this is unavoidable, as the XIM protocol is racy by 731Unfortunately, this is unavoidable, as the XIM protocol is racy by
465design. Applications can avoid some crashes at the expense of memory 732design. Applications can avoid some crashes at the expense of memory
466leaks, and Input Methods can avoid some crashes by careful ordering at 733leaks, and Input Methods can avoid some crashes by careful ordering at
467exit time. B<kinput2> (and derived input methods) generally succeeds, 734exit time. B<kinput2> (and derived input methods) generally succeeds,
468while B<SCIM> (or similar input methods) fails. In the end, however, 735while B<SCIM> (or similar input methods) fails. In the end, however,
469crashes cannot be completely avoided even if both sides cooperate. 736crashes cannot be completely avoided even if both sides cooperate.
470 737
471So the only workaround is not to kill your Input Method Servers. 738So the only workaround is not to kill your Input Method Servers.
472 739
473=item Rxvt-unicode uses gobs of memory, how can I reduce that? 740=head2 Rxvt-unicode uses gobs of memory, how can I reduce that?
474 741
475Rxvt-unicode tries to obey the rule of not charging you for something you 742Rxvt-unicode tries to obey the rule of not charging you for something you
476don't use. One thing you should try is to configure out all settings that 743don't use. One thing you should try is to configure out all settings that
477you don't need, for example, Xft support is a resource hog by design, 744you don't need, for example, Xft support is a resource hog by design,
478when used. Compiling it out ensures that no Xft font will be loaded 745when used. Compiling it out ensures that no Xft font will be loaded
4836 bytes per screen cell. For a 160x?? window this amounts to almost a 7506 bytes per screen cell. For a 160x?? window this amounts to almost a
484kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 751kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
485use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 752use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
486rxvt-unicode then uses 8 bytes per screen cell. 753rxvt-unicode then uses 8 bytes per screen cell.
487 754
488=item Can I speed up Xft rendering somehow? 755=head2 Can I speed up Xft rendering somehow?
489 756
490Yes, the most obvious way to speed it up is to avoid Xft entirely, as 757Yes, the most obvious way to speed it up is to avoid Xft entirely, as
491it is simply slow. If you still want Xft fonts you might try to disable 758it is simply slow. If you still want Xft fonts you might try to disable
492antialiasing (by appending C<:antialias=false>), which saves lots of 759antialiasing (by appending C<:antialias=false>), which saves lots of
493memory and also speeds up rendering considerably. 760memory and also speeds up rendering considerably.
494 761
495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 762=head2 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
496 763
497Rxvt-unicode will use whatever you specify as a font. If it needs to 764Rxvt-unicode will use whatever you specify as a font. If it needs to
498fall back to it's default font search list it will prefer X11 core 765fall back to it's default font search list it will prefer X11 core
499fonts, because they are small and fast, and then use Xft fonts. It has 766fonts, because they are small and fast, and then use Xft fonts. It has
500antialiasing disabled for most of them, because the author thinks they 767antialiasing disabled for most of them, because the author thinks they
501look best that way. 768look best that way.
502 769
503If you want antialiasing, you have to specify the fonts manually. 770If you want antialiasing, you have to specify the fonts manually.
504 771
505=item Mouse cut/paste suddenly no longer works. 772=head2 Mouse cut/paste suddenly no longer works.
506 773
507Make sure that mouse reporting is actually turned off since killing 774Make sure that mouse reporting is actually turned off since killing
508some editors prematurely may leave the mouse in mouse report mode. I've 775some editors prematurely may leave the mouse in mouse report mode. I've
509heard that tcsh may use mouse reporting unless it otherwise specified. A 776heard that tcsh may use mouse reporting unless it otherwise specified. A
510quick check is to see if cut/paste works when the Alt or Shift keys are 777quick check is to see if cut/paste works when the Alt or Shift keys are
511depressed. See @@RXVT_NAME@@(7) 778depressed.
512 779
513=item What's with this bold/blink stuff? 780=head2 What's with this bold/blink stuff?
514 781
515If no bold colour is set via C<colorBD:>, bold will invert text using the 782If no bold colour is set via C<colorBD:>, bold will invert text using the
516standard foreground colour. 783standard foreground colour.
517 784
518For the standard background colour, blinking will actually make the 785For the standard background colour, blinking will actually make the
525 792
526color0-7 are the low-intensity colors. 793color0-7 are the low-intensity colors.
527 794
528color8-15 are the corresponding high-intensity colors. 795color8-15 are the corresponding high-intensity colors.
529 796
530=item I don't like the screen colors. How do I change them? 797=head2 I don't like the screen colors. How do I change them?
531 798
532You can change the screen colors at run-time using F<~/.Xdefaults> 799You can change the screen colors at run-time using F<~/.Xdefaults>
533resources (or as long-options). 800resources (or as long-options).
534 801
535Here are values that are supposed to resemble a VGA screen, 802Here are values that are supposed to resemble a VGA screen,
573 URxvt.color6: #73f7ff 840 URxvt.color6: #73f7ff
574 URxvt.color14: #73f7ff 841 URxvt.color14: #73f7ff
575 URxvt.color7: #e1dddd 842 URxvt.color7: #e1dddd
576 URxvt.color15: #e1dddd 843 URxvt.color15: #e1dddd
577 844
578=item How can I start @@RXVT_NAME@@d in a race-free way? 845=head2 How can I start @@RXVT_NAME@@d in a race-free way?
579 846
580Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 847Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
581display, create the listening socket and then fork. 848display, create the listening socket and then fork.
582 849
583=item What's with the strange Backspace/Delete key behaviour? 850=head2 What's with the strange Backspace/Delete key behaviour?
584 851
585Assuming that the physical Backspace key corresponds to the 852Assuming that the physical Backspace key corresponds to the
586BackSpace keysym (not likely for Linux ... see the following 853BackSpace keysym (not likely for Linux ... see the following
587question) there are two standard values that can be used for 854question) there are two standard values that can be used for
588Backspace: C<^H> and C<^?>. 855Backspace: C<^H> and C<^?>.
605 872
606 # use Backspace = ^? 873 # use Backspace = ^?
607 $ stty erase ^? 874 $ stty erase ^?
608 $ @@RXVT_NAME@@ 875 $ @@RXVT_NAME@@
609 876
610Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 877Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
611 878
612For an existing rxvt-unicode: 879For an existing rxvt-unicode:
613 880
614 # use Backspace = ^H 881 # use Backspace = ^H
615 $ stty erase ^H 882 $ stty erase ^H
634some editors (vim I'm told) expect Backspace = ^H, 901some editors (vim I'm told) expect Backspace = ^H,
635GNU Emacs (and Emacs-like editors) use ^H for help. 902GNU Emacs (and Emacs-like editors) use ^H for help.
636 903
637Perhaps someday this will all be resolved in a consistent manner. 904Perhaps someday this will all be resolved in a consistent manner.
638 905
639=item I don't like the key-bindings. How do I change them? 906=head2 I don't like the key-bindings. How do I change them?
640 907
641There are some compile-time selections available via configure. Unless 908There are some compile-time selections available via configure. Unless
642you have run "configure" with the C<--disable-resources> option you can 909you have run "configure" with the C<--disable-resources> option you can
643use the `keysym' resource to alter the keystrings associated with keysyms. 910use the `keysym' resource to alter the keystrings associated with keysyms.
644 911
665 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 932 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
666 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 933 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
667 934
668See some more examples in the documentation for the B<keysym> resource. 935See some more examples in the documentation for the B<keysym> resource.
669 936
670=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 937=head2 I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
671How do I make use of them? For example, the Sun Keyboard type 4 938How do I make use of them? For example, the Sun Keyboard type 4
672has the following mappings that rxvt-unicode doesn't recognize. 939has the following mappings that rxvt-unicode doesn't recognize.
673 940
674 KP_Insert == Insert 941 KP_Insert == Insert
675 F22 == Print 942 F22 == Print
680 947
681Rather than have rxvt-unicode try to accommodate all the various possible 948Rather than have rxvt-unicode try to accommodate all the various possible
682keyboard mappings, it is better to use `xmodmap' to remap the keys as 949keyboard mappings, it is better to use `xmodmap' to remap the keys as
683required for your particular machine. 950required for your particular machine.
684 951
685=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm? 952=head2 How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
686I need this to decide about setting colors etc. 953I need this to decide about setting colors etc.
687 954
688rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 955rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
689check and see if that is set. Note that several programs, JED, slrn, 956check and see if that is set. Note that several programs, JED, slrn,
690Midnight Commander automatically check this variable to decide whether or 957Midnight Commander automatically check this variable to decide whether or
691not to use color. 958not to use color.
692 959
693=item How do I set the correct, full IP address for the DISPLAY variable? 960=head2 How do I set the correct, full IP address for the DISPLAY variable?
694 961
695If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 962If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
696insecure mode then it is possible to use the following shell script 963insecure mode then it is possible to use the following shell script
697snippets to correctly set the display. If your version of rxvt-unicode 964snippets to correctly set the display. If your version of rxvt-unicode
698wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then 965wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
713 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 980 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
714 read DISPLAY # set it in our local shell 981 read DISPLAY # set it in our local shell
715 fi 982 fi
716 fi 983 fi
717 984
718=item How do I compile the manual pages for myself? 985=head2 How do I compile the manual pages for myself?
719 986
720You need to have a recent version of perl installed as F</usr/bin/perl>, 987You need to have a recent version of perl installed as F</usr/bin/perl>,
721one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 988one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
722the doc subdirectory and enter C<make alldoc>. 989the doc subdirectory and enter C<make alldoc>.
723 990
724=item My question isn't answered here, can I ask a human? 991=head2 My question isn't answered here, can I ask a human?
725 992
726Before sending me mail, you could go to IRC: C<irc.freenode.net>, 993Before sending me mail, you could go to IRC: C<irc.freenode.net>,
727channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 994channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
728interested in learning about new and exciting problems (but not FAQs :). 995interested in learning about new and exciting problems (but not FAQs :).
729 996
730=back
731
732=head1 RXVT TECHNICAL REFERENCE 997=head1 RXVT TECHNICAL REFERENCE
733 998
734=head1 DESCRIPTION 999=head1 DESCRIPTION
735 1000
736The rest of this document describes various technical aspects of 1001The rest of this document describes various technical aspects of
737B<rxvt-unicode>. First the description of supported command sequences, 1002B<rxvt-unicode>. First the description of supported command sequences,
738followed by menu and pixmap support and last by a description of all 1003followed by pixmap support and last by a description of all features
739features selectable at C<configure> time. 1004selectable at C<configure> time.
740 1005
741=head1 Definitions 1006=head1 Definitions
742 1007
743=over 4 1008=over 4
744 1009
1312 B<< C<h> >> Send Mouse X & Y on button press. 1577 B<< C<h> >> Send Mouse X & Y on button press.
1313 B<< C<l> >> No mouse reporting. 1578 B<< C<l> >> No mouse reporting.
1314 1579
1315=end table 1580=end table
1316 1581
1317=item B<< C<Ps = 10> >> (B<rxvt>)
1318
1319=begin table
1320
1321 B<< C<h> >> menuBar visible
1322 B<< C<l> >> menuBar invisible
1323
1324=end table
1325
1326=item B<< C<Ps = 25> >> 1582=item B<< C<Ps = 25> >>
1327 1583
1328=begin table 1584=begin table
1329 1585
1330 B<< C<h> >> Visible cursor {cnorm/cvvis} 1586 B<< C<h> >> Visible cursor {cnorm/cvvis}
1443 1699
1444=begin table 1700=begin table
1445 1701
1446 B<< C<h> >> Scroll to bottom when a key is pressed 1702 B<< C<h> >> Scroll to bottom when a key is pressed
1447 B<< C<l> >> Don't scroll to bottom when a key is pressed 1703 B<< C<l> >> Don't scroll to bottom when a key is pressed
1704
1705=end table
1706
1707=item B<< C<Ps = 1021> >> (B<rxvt>)
1708
1709=begin table
1710
1711 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1712 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1448 1713
1449=end table 1714=end table
1450 1715
1451=item B<< C<Ps = 1047> >> 1716=item B<< C<Ps = 1047> >>
1452 1717
1501 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1766 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1502 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1767 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1503 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1768 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1504 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1769 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1505 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1770 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1506 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1771 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1507 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1772 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1508 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1773 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1509 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1774 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1510 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1775 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1511 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1776 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1512 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> >> 1777 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> >>
1513 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1778 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1514 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). 1779 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).
1515 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1780 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1516 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1781 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1517 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1782 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1783 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1784 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1518 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1785 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1786 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1787 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1788 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1789 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1790 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1791 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1524 1792
1525=end table 1793=end table
1526 1794
1527=back 1795=back
1528 1796
1529X<menuBar>
1530
1531=head1 menuBar
1532
1533B<< The exact syntax used is I<almost> solidified. >>
1534In the menus, B<DON'T> try to use menuBar commands that add or remove a
1535menuBar.
1536
1537Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1538omitted: use B<./> to specify a menu relative to the current menu.
1539
1540=head2 Overview of menuBar operation
1541
1542For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1543of C<Pt> can be used for a variety of tasks:
1544
1545At the top level is the current menuBar which is a member of a circular
1546linked-list of other such menuBars.
1547
1548The menuBar acts as a parent for the various drop-down menus, which in
1549turn, may have labels, separator lines, menuItems and subMenus.
1550
1551The menuItems are the useful bits: you can use them to mimic keyboard
1552input or even to send text or escape sequences back to rxvt.
1553
1554The menuBar syntax is intended to provide a simple yet robust method of
1555constructing and manipulating menus and navigating through the
1556menuBars.
1557
1558The first step is to use the tag B<< [menu:I<name>] >> which creates
1559the menuBar called I<name> and allows access. You may now or menus,
1560subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1561menuBar access as B<readonly> to prevent accidental corruption of the
1562menus. To re-access the current menuBar for alterations, use the tag
1563B<[menu]>, make the alterations and then use B<[done]>
1564
1565X<menuBarCommands>
1566
1567=head2 Commands
1568
1569=over 4
1570
1571=item B<< [menu:+I<name>] >>
1572
1573access the named menuBar for creation or alteration. If a new menuBar
1574is created, it is called I<name> (max of 15 chars) and the current
1575menuBar is pushed onto the stack
1576
1577=item B<[menu]>
1578
1579access the current menuBar for alteration
1580
1581=item B<< [title:+I<string>] >>
1582
1583set the current menuBar's title to I<string>, which may contain the
1584following format specifiers:
1585
1586 B<%n> rxvt name (as per the B<-name> command-line option)
1587 B<%v> rxvt version
1588 B<%%> literal B<%> character
1589
1590=item B<[done]>
1591
1592set menuBar access as B<readonly>.
1593End-of-file tag for B<< [read:+I<file>] >> operations.
1594
1595=item B<< [read:+I<file>] >>
1596
1597read menu commands directly from I<file> (extension ".menu" will be
1598appended if required.) Start reading at a line with B<[menu]> or B<<
1599[menu:+I<name> >> and continuing until B<[done]> is encountered.
1600
1601Blank and comment lines (starting with B<#>) are ignored. Actually,
1602since any invalid menu commands are also ignored, almost anything could
1603be construed as a comment line, but this may be tightened up in the
1604future ... so don't count on it!.
1605
1606=item B<< [read:+I<file>;+I<name>] >>
1607
1608The same as B<< [read:+I<file>] >>, but start reading at a line with
1609B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1610B<[done]> is encountered.
1611
1612=item B<[dump]>
1613
1614dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1615later rereading.
1616
1617=item B<[rm:name]>
1618
1619remove the named menuBar
1620
1621=item B<[rm] [rm:]>
1622
1623remove the current menuBar
1624
1625=item B<[rm*] [rm:*]>
1626
1627remove all menuBars
1628
1629=item B<[swap]>
1630
1631swap the top two menuBars
1632
1633=item B<[prev]>
1634
1635access the previous menuBar
1636
1637=item B<[next]>
1638
1639access the next menuBar
1640
1641=item B<[show]>
1642
1643Enable display of the menuBar
1644
1645=item B<[hide]>
1646
1647Disable display of the menuBar
1648
1649=item B<< [pixmap:+I<name>] >>
1650
1651=item B<< [pixmap:+I<name>;I<scaling>] >>
1652
1653(set the background pixmap globally
1654
1655B<< A Future implementation I<may> make this local to the menubar >>)
1656
1657=item B<< [:+I<command>:] >>
1658
1659ignore the menu readonly status and issue a I<command> to or a menu or
1660menuitem or change the ; a useful shortcut for setting the quick arrows
1661from a menuBar.
1662
1663=back
1664
1665X<menuBarAdd>
1666
1667=head2 Adding and accessing menus
1668
1669The following commands may also be B<+> prefixed.
1670
1671=over 4
1672
1673=item B</+>
1674
1675access menuBar top level
1676
1677=item B<./+>
1678
1679access current menu level
1680
1681=item B<../+>
1682
1683access parent menu (1 level up)
1684
1685=item B<../../>
1686
1687access parent menu (multiple levels up)
1688
1689=item B<< I</path/>menu >>
1690
1691add/access menu
1692
1693=item B<< I</path/>menu/* >>
1694
1695add/access menu and clear it if it exists
1696
1697=item B<< I</path/>{-} >>
1698
1699add separator
1700
1701=item B<< I</path/>{item} >>
1702
1703add B<item> as a label
1704
1705=item B<< I</path/>{item} action >>
1706
1707add/alter I<menuitem> with an associated I<action>
1708
1709=item B<< I</path/>{item}{right-text} >>
1710
1711add/alter I<menuitem> with B<right-text> as the right-justified text
1712and as the associated I<action>
1713
1714=item B<< I</path/>{item}{rtext} action >>
1715
1716add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1717the right-justified text.
1718
1719=back
1720
1721=over 4
1722
1723=item Special characters in I<action> must be backslash-escaped:
1724
1725B<\a \b \E \e \n \r \t \octal>
1726
1727=item or in control-character notation:
1728
1729B<^@, ^A .. ^Z .. ^_, ^?>
1730
1731=back
1732
1733To send a string starting with a B<NUL> (B<^@>) character to the
1734program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1735the first of which will be stripped off and the balance directed to the
1736program. Otherwise if I<action> begins with B<NUL> followed by
1737non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1738balance is sent back to rxvt.
1739
1740As a convenience for the many Emacs-type editors, I<action> may start
1741with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1742appended if missed from B<M-x> commands.
1743
1744As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1745quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1746
1747=over 4
1748
1749=item For example,
1750
1751B<M-xapropos> is equivalent to B<\Exapropos\r>
1752
1753=item and
1754
1755B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1756
1757=back
1758
1759The option B<< {I<right-rtext>} >> will be right-justified. In the
1760absence of a specified action, this text will be used as the I<action>
1761as well.
1762
1763=over 4
1764
1765=item For example,
1766
1767B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1768
1769=back
1770
1771The left label I<is> necessary, since it's used for matching, but
1772implicitly hiding the left label (by using same name for both left and
1773right labels), or explicitly hiding the left label (by preceeding it
1774with a dot), makes it possible to have right-justified text only.
1775
1776=over 4
1777
1778=item For example,
1779
1780B</File/{Open}{Open} Open-File-Action>
1781
1782=item or hiding it
1783
1784B</File/{.anylabel}{Open} Open-File-Action>
1785
1786=back
1787
1788X<menuBarRemove>
1789
1790=head2 Removing menus
1791
1792=over 4
1793
1794=item B<< -/*+ >>
1795
1796remove all menus from the menuBar, the same as B<[clear]>
1797
1798=item B<< -+I</path>menu+ >>
1799
1800remove menu
1801
1802=item B<< -+I</path>{item}+ >>
1803
1804remove item
1805
1806=item B<< -+I</path>{-} >>
1807
1808remove separator)
1809
1810=item B<-/path/menu/*>
1811
1812remove all items, separators and submenus from menu
1813
1814=back
1815
1816X<menuBarArrows>
1817
1818=head2 Quick Arrows
1819
1820The menus also provide a hook for I<quick arrows> to provide easier
1821user access. If nothing has been explicitly set, the default is to
1822emulate the curror keys. The syntax permits each arrow to be altered
1823individually or all four at once without re-entering their common
1824beginning/end text. For example, to explicitly associate cursor actions
1825with the arrows, any of the following forms could be used:
1826
1827=over 4
1828
1829=item B<< <r>+I<Right> >>
1830
1831=item B<< <l>+I<Left> >>
1832
1833=item B<< <u>+I<Up> >>
1834
1835=item B<< <d>+I<Down> >>
1836
1837Define actions for the respective arrow buttons
1838
1839=item B<< <b>+I<Begin> >>
1840
1841=item B<< <e>+I<End> >>
1842
1843Define common beginning/end parts for I<quick arrows> which used in
1844conjunction with the above <r> <l> <u> <d> constructs
1845
1846=back
1847
1848=over 4
1849
1850=item For example, define arrows individually,
1851
1852 <u>\E[A
1853
1854 <d>\E[B
1855
1856 <r>\E[C
1857
1858 <l>\E[D
1859
1860=item or all at once
1861
1862 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1863
1864=item or more compactly (factoring out common parts)
1865
1866 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1867
1868=back
1869
1870X<menuBarSummary>
1871
1872=head2 Command Summary
1873
1874A short summary of the most I<common> commands:
1875
1876=over 4
1877
1878=item [menu:name]
1879
1880use an existing named menuBar or start a new one
1881
1882=item [menu]
1883
1884use the current menuBar
1885
1886=item [title:string]
1887
1888set menuBar title
1889
1890=item [done]
1891
1892set menu access to readonly and, if reading from a file, signal EOF
1893
1894=item [done:name]
1895
1896if reading from a file using [read:file;name] signal EOF
1897
1898=item [rm:name]
1899
1900remove named menuBar(s)
1901
1902=item [rm] [rm:]
1903
1904remove current menuBar
1905
1906=item [rm*] [rm:*]
1907
1908remove all menuBar(s)
1909
1910=item [swap]
1911
1912swap top two menuBars
1913
1914=item [prev]
1915
1916access the previous menuBar
1917
1918=item [next]
1919
1920access the next menuBar
1921
1922=item [show]
1923
1924map menuBar
1925
1926=item [hide]
1927
1928unmap menuBar
1929
1930=item [pixmap;file]
1931
1932=item [pixmap;file;scaling]
1933
1934set a background pixmap
1935
1936=item [read:file]
1937
1938=item [read:file;name]
1939
1940read in a menu from a file
1941
1942=item [dump]
1943
1944dump out all menuBars to /tmp/rxvt-PID
1945
1946=item /
1947
1948access menuBar top level
1949
1950=item ./
1951
1952=item ../
1953
1954=item ../../
1955
1956access current or parent menu level
1957
1958=item /path/menu
1959
1960add/access menu
1961
1962=item /path/{-}
1963
1964add separator
1965
1966=item /path/{item}{rtext} action
1967
1968add/alter menu item
1969
1970=item -/*
1971
1972remove all menus from the menuBar
1973
1974=item -/path/menu
1975
1976remove menu items, separators and submenus from menu
1977
1978=item -/path/menu
1979
1980remove menu
1981
1982=item -/path/{item}
1983
1984remove item
1985
1986=item -/path/{-}
1987
1988remove separator
1989
1990=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1991
1992menu quick arrows
1993
1994=back
1995X<XPM> 1797X<XPM>
1996 1798
1997=head1 XPM 1799=head1 XPM
1998 1800
1999For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1801For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2185=end table 1987=end table
2186 1988
2187=head1 CONFIGURE OPTIONS 1989=head1 CONFIGURE OPTIONS
2188 1990
2189General hint: if you get compile errors, then likely your configuration 1991General hint: if you get compile errors, then likely your configuration
2190hasn't been tested well. Either try with --enable-everything or use the 1992hasn't been tested well. Either try with C<--enable-everything> or use
2191./reconf script as a base for experiments. ./reconf is used by myself, 1993the F<./reconf> script as a base for experiments. F<./reconf> is used by
2192so it should generally be a working config. Of course, you should always 1994myself, so it should generally be a working config. Of course, you should
2193report when a combination doesn't work, so it can be fixed. Marc Lehmann 1995always report when a combination doesn't work, so it can be fixed. Marc
2194<rxvt@schmorp.de>. 1996Lehmann <rxvt@schmorp.de>.
1997
1998All
2195 1999
2196=over 4 2000=over 4
2197 2001
2198=item --enable-everything 2002=item --enable-everything
2199 2003
2200Add support for all non-multichoice options listed in "./configure 2004Add (or remove) support for all non-multichoice options listed in "./configure
2201--help". Note that unlike other enable options this is order dependant. 2005--help".
2006
2202You can specify this and then disable options which this enables by 2007You can specify this and then disable options you do not like by
2203I<following> this with the appropriate commands. 2008I<following> this with the appropriate C<--disable-...> arguments,
2009or you can start with a minimal configuration by specifying
2010C<--disable-everything> and than adding just the C<--enable-...> arguments
2011you want.
2204 2012
2205=item --enable-xft 2013=item --enable-xft (default: enabled)
2206 2014
2207Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2015Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208slower and require lots of memory, but as long as you don't use them, you 2016slower and require lots of memory, but as long as you don't use them, you
2209don't pay for them. 2017don't pay for them.
2210 2018
2211=item --enable-font-styles 2019=item --enable-font-styles (default: on)
2212 2020
2213Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2021Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2214styles. The fonts can be set manually or automatically. 2022styles. The fonts can be set manually or automatically.
2215 2023
2216=item --with-codesets=NAME,... 2024=item --with-codesets=NAME,... (default: all)
2217 2025
2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2026Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219are always compiled in, which includes most 8-bit character sets). These 2027are always compiled in, which includes most 8-bit character sets). These
2220codeset tables are used for driving X11 core fonts, they are not required 2028codeset tables are used for driving X11 core fonts, they are not required
2221for Xft fonts, although having them compiled in lets rxvt-unicode choose 2029for Xft fonts, although having them compiled in lets rxvt-unicode choose
2232 jp_ext rarely used but big japanese encodings 2040 jp_ext rarely used but big japanese encodings
2233 kr korean encodings 2041 kr korean encodings
2234 2042
2235=end table 2043=end table
2236 2044
2237=item --enable-xim 2045=item --enable-xim (default: on)
2238 2046
2239Add support for XIM (X Input Method) protocol. This allows using 2047Add support for XIM (X Input Method) protocol. This allows using
2240alternative input methods (e.g. kinput2) and will also correctly 2048alternative input methods (e.g. kinput2) and will also correctly
2241set up the input for people using dead keys or compose keys. 2049set up the input for people using dead keys or compose keys.
2242 2050
2243=item --enable-unicode3 2051=item --enable-unicode3 (default: off)
2052
2053Recommended to stay off unless you really need non-BMP characters.
2244 2054
2245Enable direct support for displaying unicode codepoints above 2055Enable direct support for displaying unicode codepoints above
224665535 (the basic multilingual page). This increases storage 205665535 (the basic multilingual page). This increases storage
2247requirements per character from 2 to 4 bytes. X11 fonts do not yet 2057requirements per character from 2 to 4 bytes. X11 fonts do not yet
2248support these extra characters, but Xft does. 2058support these extra characters, but Xft does.
2251even without this flag, but the number of such characters is 2061even without this flag, but the number of such characters is
2252limited to a view thousand (shared with combining characters, 2062limited to a view thousand (shared with combining characters,
2253see next switch), and right now rxvt-unicode cannot display them 2063see next switch), and right now rxvt-unicode cannot display them
2254(input/output and cut&paste still work, though). 2064(input/output and cut&paste still work, though).
2255 2065
2256=item --enable-combining 2066=item --enable-combining (default: on)
2257 2067
2258Enable automatic composition of combining characters into 2068Enable automatic composition of combining characters into
2259composite characters. This is required for proper viewing of text 2069composite characters. This is required for proper viewing of text
2260where accents are encoded as seperate unicode characters. This is 2070where accents are encoded as seperate unicode characters. This is
2261done by using precomposited characters when available or creating 2071done by using precomposited characters when available or creating
2262new pseudo-characters when no precomposed form exists. 2072new pseudo-characters when no precomposed form exists.
2263 2073
2264Without --enable-unicode3, the number of additional precomposed characters 2074Without --enable-unicode3, the number of additional precomposed
2265is rather limited (2048, if this is full, rxvt-unicode will use the 2075characters is somewhat limited (the 6400 private use characters will be
2266private use area, extending the number of combinations to 8448). With
2267--enable-unicode3, no practical limit exists. 2076(ab-)used). With --enable-unicode3, no practical limit exists.
2268 2077
2269This option will also enable storage (but not display) of characters 2078This option will also enable storage (but not display) of characters
2270beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2079beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2271 2080
2272The combining table also contains entries for arabic presentation forms, 2081The combining table also contains entries for arabic presentation forms,
2273but these are not currently used. Bug me if you want these to be used (and 2082but these are not currently used. Bug me if you want these to be used (and
2274tell me how these are to be used...). 2083tell me how these are to be used...).
2275 2084
2276=item --enable-fallback(=CLASS) 2085=item --enable-fallback(=CLASS) (default: Rxvt)
2277 2086
2278When reading resource settings, also read settings for class CLASS 2087When reading resource settings, also read settings for class CLASS. To
2279(default: Rxvt). To disable resource fallback use --disable-fallback. 2088disable resource fallback use --disable-fallback.
2280 2089
2281=item --with-res-name=NAME 2090=item --with-res-name=NAME (default: urxvt)
2282 2091
2283Use the given name (default: urxvt) as default application name when 2092Use the given name as default application name when
2284reading resources. Specify --with-res-name=rxvt to replace rxvt. 2093reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285 2094
2286=item --with-res-class=CLASS 2095=item --with-res-class=CLASS /default: URxvt)
2287 2096
2288Use the given class (default: URxvt) as default application class 2097Use the given class as default application class
2289when reading resources. Specify --with-res-class=Rxvt to replace 2098when reading resources. Specify --with-res-class=Rxvt to replace
2290rxvt. 2099rxvt.
2291 2100
2292=item --enable-utmp 2101=item --enable-utmp (default: on)
2293 2102
2294Write user and tty to utmp file (used by programs like F<w>) at 2103Write user and tty to utmp file (used by programs like F<w>) at
2295start of rxvt execution and delete information when rxvt exits. 2104start of rxvt execution and delete information when rxvt exits.
2296 2105
2297=item --enable-wtmp 2106=item --enable-wtmp (default: on)
2298 2107
2299Write user and tty to wtmp file (used by programs like F<last>) at 2108Write user and tty to wtmp file (used by programs like F<last>) at
2300start of rxvt execution and write logout when rxvt exits. This 2109start of rxvt execution and write logout when rxvt exits. This
2301option requires --enable-utmp to also be specified. 2110option requires --enable-utmp to also be specified.
2302 2111
2303=item --enable-lastlog 2112=item --enable-lastlog (default: on)
2304 2113
2305Write user and tty to lastlog file (used by programs like 2114Write user and tty to lastlog file (used by programs like
2306F<lastlogin>) at start of rxvt execution. This option requires 2115F<lastlogin>) at start of rxvt execution. This option requires
2307--enable-utmp to also be specified. 2116--enable-utmp to also be specified.
2308 2117
2309=item --enable-xpm-background 2118=item --enable-xpm-background (default: on)
2310 2119
2311Add support for XPM background pixmaps. 2120Add support for XPM background pixmaps.
2312 2121
2313=item --enable-transparency 2122=item --enable-transparency (default: on)
2314 2123
2315Add support for inheriting parent backgrounds thus giving a fake 2124Add support for inheriting parent backgrounds thus giving a fake
2316transparency to the term. 2125transparency to the term.
2317 2126
2318=item --enable-fading 2127=item --enable-fading (default: on)
2319 2128
2320Add support for fading the text when focus is lost. 2129Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2321 2130
2322=item --enable-tinting 2131=item --enable-tinting (default: on)
2323 2132
2324Add support for tinting of transparent backgrounds. 2133Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2325 2134
2326=item --enable-menubar
2327
2328Add support for our menu bar system (this interacts badly with
2329dynamic locale switching currently).
2330
2331=item --enable-rxvt-scroll 2135=item --enable-rxvt-scroll (default: on)
2332 2136
2333Add support for the original rxvt scrollbar. 2137Add support for the original rxvt scrollbar.
2334 2138
2335=item --enable-next-scroll 2139=item --enable-next-scroll (default: on)
2336 2140
2337Add support for a NeXT-like scrollbar. 2141Add support for a NeXT-like scrollbar.
2338 2142
2339=item --enable-xterm-scroll 2143=item --enable-xterm-scroll (default: on)
2340 2144
2341Add support for an Xterm-like scrollbar. 2145Add support for an Xterm-like scrollbar.
2342 2146
2343=item --enable-plain-scroll 2147=item --enable-plain-scroll (default: on)
2344 2148
2345Add support for a very unobtrusive, plain-looking scrollbar that 2149Add support for a very unobtrusive, plain-looking scrollbar that
2346is the favourite of the rxvt-unicode author, having used it for 2150is the favourite of the rxvt-unicode author, having used it for
2347many years. 2151many years.
2348 2152
2349=item --enable-half-shadow 2153=item --enable-ttygid (default: off)
2350
2351Make shadows on the scrollbar only half the normal width & height.
2352only applicable to rxvt scrollbars.
2353
2354=item --enable-ttygid
2355 2154
2356Change tty device setting to group "tty" - only use this if 2155Change tty device setting to group "tty" - only use this if
2357your system uses this type of security. 2156your system uses this type of security.
2358 2157
2359=item --disable-backspace-key 2158=item --disable-backspace-key
2360 2159
2361Disable any handling of the backspace key by us - let the X server 2160Removes any handling of the backspace key by us - let the X server do it.
2161
2162=item --disable-delete-key
2163
2164Removes any handling of the delete key by us - let the X server
2362do it. 2165do it.
2363 2166
2364=item --disable-delete-key
2365
2366Disable any handling of the delete key by us - let the X server
2367do it.
2368
2369=item --disable-resources 2167=item --disable-resources
2370 2168
2371Remove all resources checking. 2169Removes any support for resource checking.
2372
2373=item --enable-xgetdefault
2374
2375Make resources checking via XGetDefault() instead of our small
2376version which only checks ~/.Xdefaults, or if that doesn't exist then
2377~/.Xresources.
2378
2379Please note that nowadays, things like XIM will automatically pull in and
2380use the full X resource manager, so the overhead of using it might be very
2381small, if nonexistant.
2382
2383=item --enable-strings
2384
2385Add support for our possibly faster memset() function and other
2386various routines, overriding your system's versions which may
2387have been hand-crafted in assembly or may require extra libraries
2388to link in. (this breaks ANSI-C rules and has problems on many
2389GNU/Linux systems).
2390 2170
2391=item --disable-swapscreen 2171=item --disable-swapscreen
2392 2172
2393Remove support for swap screen. 2173Remove support for secondary/swap screen.
2394 2174
2395=item --enable-frills 2175=item --enable-frills (default: on)
2396 2176
2397Add support for many small features that are not essential but nice to 2177Add support for many small features that are not essential but nice to
2398have. Normally you want this, but for very small binaries you may want to 2178have. Normally you want this, but for very small binaries you may want to
2399disable this. 2179disable this.
2400 2180
2401A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2181A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2402in combination with other switches) is: 2182in combination with other switches) is:
2403 2183
2404 MWM-hints 2184 MWM-hints
2405 EWMH-hints (pid, utf8 names) and protocols (ping) 2185 EWMH-hints (pid, utf8 names) and protocols (ping)
2406 seperate underline colour 2186 seperate underline colour (-underlineColor)
2407 settable border widths and borderless switch 2187 settable border widths and borderless switch (-w, -b, -bl)
2188 visual depth selection (-depth)
2408 settable extra linespacing 2189 settable extra linespacing /-lsp)
2409 iso-14755-2 and -3, and visual feedback 2190 iso-14755-2 and -3, and visual feedback
2191 tripleclickwords (-tcw)
2192 settable insecure mode (-insecure)
2193 keysym remapping support
2194 cursor blinking and underline cursor (-cb, -uc)
2195 XEmbed support (-embed)
2196 user-pty (-pty-fd)
2197 hold on exit (-hold)
2198 skip builtin block graphics (-sbg)
2199
2200It also enabled some non-essential features otherwise disabled, such as:
2201
2202 some round-trip time optimisations
2203 nearest color allocation on pseudocolor screens
2204 UTF8_STRING supporr for selection
2205 sgr modes 90..97 and 100..107
2410 backindex and forwardindex escape sequence 2206 backindex and forwardindex escape sequences
2207 view change/zero scorllback esacpe sequences
2208 locale switching escape sequence
2411 window op and some xterm/OSC escape sequences 2209 window op and some xterm/OSC escape sequences
2412 tripleclickwords 2210 rectangular selections
2413 settable insecure mode 2211 trailing space removal for selections
2414 keysym remapping support 2212 verbose X error handling
2415 cursor blinking and underline cursor
2416 -embed and -pty-fd options
2417 2213
2418=item --enable-iso14755 2214=item --enable-iso14755 (default: on)
2419 2215
2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2216Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2421F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2217F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2422C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2218C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2423this switch. 2219this switch.
2424 2220
2425=item --enable-keepscrolling 2221=item --enable-keepscrolling (default: on)
2426 2222
2427Add support for continual scrolling of the display when you hold 2223Add support for continual scrolling of the display when you hold
2428the mouse button down on a scrollbar arrow. 2224the mouse button down on a scrollbar arrow.
2429 2225
2430=item --enable-mousewheel 2226=item --enable-mousewheel (default: on)
2431 2227
2432Add support for scrolling via mouse wheel or buttons 4 & 5. 2228Add support for scrolling via mouse wheel or buttons 4 & 5.
2433 2229
2434=item --enable-slipwheeling 2230=item --enable-slipwheeling (default: on)
2435 2231
2436Add support for continual scrolling (using the mouse wheel as an 2232Add support for continual scrolling (using the mouse wheel as an
2437accelerator) while the control key is held down. This option 2233accelerator) while the control key is held down. This option
2438requires --enable-mousewheel to also be specified. 2234requires --enable-mousewheel to also be specified.
2439 2235
2440=item --disable-new-selection 2236=item --disable-new-selection
2441 2237
2442Remove support for mouse selection style like that of xterm. 2238Remove support for mouse selection style like that of xterm.
2443 2239
2444=item --enable-dmalloc 2240=item --enable-dmalloc (default: off)
2445 2241
2446Use Gray Watson's malloc - which is good for debugging See 2242Use Gray Watson's malloc - which is good for debugging See
2447http://www.letters.com/dmalloc/ for details If you use either this or the 2243http://www.letters.com/dmalloc/ for details If you use either this or the
2448next option, you may need to edit src/Makefile after compiling to point 2244next option, you may need to edit src/Makefile after compiling to point
2449DINCLUDE and DLIB to the right places. 2245DINCLUDE and DLIB to the right places.
2450 2246
2451You can only use either this option and the following (should 2247You can only use either this option and the following (should
2452you use either) . 2248you use either) .
2453 2249
2454=item --enable-dlmalloc 2250=item --enable-dlmalloc (default: off)
2455 2251
2456Use Doug Lea's malloc - which is good for a production version 2252Use Doug Lea's malloc - which is good for a production version
2457See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2253See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458 2254
2459=item --enable-smart-resize 2255=item --enable-smart-resize (default: on)
2460 2256
2461Add smart growth/shrink behaviour when changing font size via from hot 2257Add smart growth/shrink behaviour when changing font size via hot
2462keys. This should keep in a fixed position the rxvt corner which is 2258keys. This should keep the window corner which is closest to a corner of
2463closest to a corner of the screen. 2259the screen in a fixed position.
2464 2260
2465=item --enable-pointer-blank 2261=item --enable-pointer-blank (default: on)
2466 2262
2467Add support to have the pointer disappear when typing or inactive. 2263Add support to have the pointer disappear when typing or inactive.
2468 2264
2469=item --with-name=NAME 2265=item --enable-perl (default: on)
2470 2266
2267Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2268manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2269in F<src/perl-ext/> for the extensions that are installed by default. The
2270perl interpreter that is used can be specified via the C<PERL> environment
2271variable when running configure.
2272
2273=item --with-name=NAME (default: urxvt)
2274
2471Set the basename for the installed binaries (default: C<urxvt>, resulting 2275Set the basename for the installed binaries, resulting
2472in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2276in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2473C<rxvt>. 2277C<rxvt>.
2474 2278
2475=item --with-term=NAME 2279=item --with-term=NAME (default: rxvt-unicode)
2476 2280
2477Change the environmental variable for the terminal to NAME (default 2281Change the environmental variable for the terminal to NAME.
2478C<rxvt-unicode>)
2479 2282
2480=item --with-terminfo=PATH 2283=item --with-terminfo=PATH
2481 2284
2482Change the environmental variable for the path to the terminfo tree to 2285Change the environmental variable for the path to the terminfo tree to
2483PATH. 2286PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines