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.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.95 by root, Mon Jan 30 22:49:30 2006 UTC

… …
24 24
25=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
26 26
27=over 4 27=over 4
28 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 Why doesn't rxvt-unicode read my resources?
70
71Well, why, indeed? It does, in a way very similar to other X
72applications. Most importantly, this means that if you or your OS loads
73resources into the X display (the right way to do it), rxvt-unicode will
74ignore any resource files in your home directory. It will only read
75F<$HOME/.Xdefaults> when no resources are attached to the display.
76
77If you have or use an F<$HOME/.Xresources> file, chances are that
78resources are loaded into your X-server. In this case, you have to
79re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
80
81Also consider the form resources have to use:
82
83 URxvt.resource: value
84
85If you want to use another form (there are lots of different ways of
86specifying resources), make sure you understand wether and why it
87works. If unsure, use the form above.
88
89=item I can't get transparency working, what am I doing wrong?
90
91First of all, transparency isn't officially supported in rxvt-unicode, so
92you are mostly on your own. Do not bug the author about it (but you may
93bug everybody else). Also, if you can't get it working consider it a rite
94of passage, and you failed.
95
96Here are three ways to get transparency. B<Do> read the manpage and option
97descriptions for the programs mentioned and rxvt-unicode. Really, do it!
98
991. Use inheritPixmap:
100
101 Esetroot wallpaper.jpg
102 @@RXVT_NAME@@ -ip -tint red -sh 40
103
104That works. If you think it doesn't, you lack transparency and tinting
105support, or you are unable to read.
106
1072. Use a simple pixmap and emulate pseudo-transparency. This enables you
108to use effects other than tinting and shading: Just shade/tint/whatever
109your picture with gimp:
110
111 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
112 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
113
114That works. If you think it doesn't, you lack XPM and Perl support, or you
115are unable to read.
116
1173. Use an ARGB visual:
118
119 @@RXVT_NAME@@ -depth 432 -fg grey90 -bg rgba:0000/0000/0000/c000
120
121This requires XFT support, and support form your X-server. If that doesn't
122work for you, blame Xorg and Keith Packard. ARGB visuals aren't there yet,
123no matter what they claim. Rxvt-Unicode contains the neccessary bugfixes
124and workarounds for Xft and Xlib to make it work.
125
126=item Isn't rxvt supposed to be small? Don't all those features bloat?
127
128I often get asked about this, and I think, no, they didn't cause extra
129bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
130that the urxvt binary is larger (due to some encoding tables always being
131compiled in), but it actually uses less memory (RSS) after startup. Even
132with C<--disable-everything>, this comparison is a bit unfair, as many
133features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
134already in use in this mode.
135
136 text data bss drs rss filename
137 98398 1664 24 15695 1824 rxvt --disable-everything
138 188985 9048 66616 18222 1788 urxvt --disable-everything
139
140When you C<--enable-everything> (which _is_ unfair, as this involves xft
141and full locale/XIM support which are quite bloaty inside libX11 and my
142libc), the two diverge, but not unreasnobaly so.
143
144 text data bss drs rss filename
145 163431 2152 24 20123 2060 rxvt --enable-everything
146 1035683 49680 66648 29096 3680 urxvt --enable-everything
147
148The very large size of the text section is explained by the east-asian
149encoding tables, which, if unused, take up disk space but nothing else
150and can be compiled out unless you rely on X11 core fonts that use those
151encodings. The BSS size comes from the 64k emergency buffer that my c++
152compiler allocates (but of course doesn't use unless you are out of
153memory). Also, using an xft font instead of a core font immediately adds a
154few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
155not used.
156
157Of course, due to every character using two or four bytes instead of one,
158a large scrollback buffer will ultimately make rxvt-unicode use more
159memory.
160
161Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
162still fares rather well. And compared to some monsters like gnome-terminal
163(21152k + extra 4204k in separate processes) or konsole (22200k + extra
16443180k in daemons that stay around after exit, plus half a minute of
165startup time, including the hundreds of warnings it spits out), it fares
166extremely well *g*.
167
168=item Why C++, isn't that unportable/bloated/uncool?
169
170Is this a question? :) It comes up very often. The simple answer is: I had
171to write it, and C++ allowed me to write and maintain it in a fraction
172of the time and effort (which is a scarce resource for me). Put even
173shorter: It simply wouldn't exist without C++.
174
175My personal stance on this is that C++ is less portable than C, but in
176the case of rxvt-unicode this hardly matters, as its portability limits
177are defined by things like X11, pseudo terminals, locale support and unix
178domain sockets, which are all less portable than C++ itself.
179
180Regarding the bloat, see the above question: It's easy to write programs
181in C that use gobs of memory, an certainly possible to write programs in
182C++ that don't. C++ also often comes with large libraries, but this is
183not necessarily the case with GCC. Here is what rxvt links against on my
184system with a minimal config:
185
186 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
187 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
188 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
189 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
190
191And here is rxvt-unicode:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
195 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
196 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
197 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
198
199No large bloated libraries (of course, none were linked in statically),
200except maybe libX11 :)
201
202=item Does it support tabs, can I have a tabbed rxvt-unicode?
203
204Beginning with version 7.3, there is a perl extension that implements a
205simple tabbed terminal. It is installed by default, so any of these should
206give you tabs:
207
208 @@RXVT_NAME@@ -pe tabbed
209
210 URxvt.perl-ext-common: default,tabbed
211
212It will also work fine with tabbing functionality of many window managers
213or similar tabbing programs, and its embedding-features allow it to be
214embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
215the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
216(murxvt) terminal as an example embedding application.
217
29=item How do I know which rxvt-unicode version I'm using? 218=item How do I know which rxvt-unicode version I'm using?
30 219
31The version number is displayed with the usage (-h). Also the escape 220The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 221sequence C<ESC [ 8 n> sets the window title to the version number. When
222using the @@RXVT_NAME@@c client, the version displayed is that of the
223daemon.
33 224
34=item I am using Debian GNU/Linux and have a problem... 225=item I am using Debian GNU/Linux and have a problem...
35 226
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 227The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 228patches that considerably change the behaviour of rxvt-unicode (but
229unfortunately this notice has been removed). Before reporting a bug to
38bug to the original rxvt-unicode author please download and install the 230the original rxvt-unicode author please download and install the genuine
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 231version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
40reproduce the problem. If you cannot, chances are that the problems are 232the problem. If you cannot, chances are that the problems are specific to
41specific to Debian GNU/Linux, in which case it should be reported via the 233Debian GNU/Linux, in which case it should be reported via the Debian Bug
42Debian Bug Tracking System (use C<reportbug> to report the bug). 234Tracking System (use C<reportbug> to report the bug).
43 235
44For other problems that also affect the Debian package, you can and 236For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a 237probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that 238bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 239might encounter the same issue.
240
241=item I am maintaining rxvt-unicode for distribution/OS XXX, any
242recommendation?
243
244You should build one binary with the default options. F<configure>
245now enables most useful options, and the trend goes to making them
246runtime-switchable, too, so there is usually no drawback to enbaling them,
247except higher disk and possibly memory usage. The perl interpreter should
248be enabled, as important functionality (menus, selection, likely more in
249the future) depends on it.
250
251You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
252system-wide (except maybe with C<defaults>). This will result in useful
253behaviour. If your distribution aims at low memory, add an empty
254C<perl-ext-common> resource to the app-defaults file. This will keep the
255perl interpreter disabled until the user enables it.
256
257If you can/want build more binaries, I recommend building a minimal
258one with C<--disable-everything> (very useful) and a maximal one with
259C<--enable-everything> (less useful, it will be very big due to a lot of
260encodings built-in that increase download times and are rarely used).
261
262=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
263
264It should be, starting with release 7.1. You are encouraged to properly
265install urxvt with privileges necessary for your OS now.
266
267When rxvt-unicode detects that it runs setuid or setgid, it will fork
268into a helper process for privileged operations (pty handling on some
269systems, utmp/wtmp/lastlog handling on others) and drop privileges
270immediately. This is much safer than most other terminals that keep
271privileges while running (but is more relevant to urxvt, as it contains
272things as perl interpreters, which might be "helpful" to attackers).
273
274This forking is done as the very first within main(), which is very early
275and reduces possible bugs to initialisation code run before main(), or
276things like the dynamic loader of your system, which should result in very
277little risk.
48 278
49=item When I log-in to another system it tells me about missing terminfo data? 279=item When I log-in to another system it tells me about missing terminfo data?
50 280
51The terminal description used by rxvt-unicode is not as widely available 281The terminal description used by rxvt-unicode is not as widely available
52as that for xterm, or even rxvt (for which the same problem often arises). 282as that for xterm, or even rxvt (for which the same problem often arises).
… …
72 URxvt.termName: rxvt 302 URxvt.termName: rxvt
73 303
74If you don't plan to use B<rxvt> (quite common...) you could also replace 304If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 305the rxvt terminfo file with the rxvt-unicode one.
76 306
307=item C<tic> outputs some error when compiling the terminfo entry.
308
309Most likely it's the empty definition for C<enacs=>. Just replace it by
310C<enacs=\E[0@> and try again.
311
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 312=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 313
79=item I need a termcap file entry. 314=item I need a termcap file entry.
80 315
81One reason you might want this is that some distributions or operating 316One reason you might want this is that some distributions or operating
… …
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 329 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\ 330 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:lm#0:\ 331 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 332 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 333 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 334 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 335 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 336 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 337 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
338 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
103 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 339 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ 340 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ 341 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ 342 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ 343 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ 344 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
… …
257might be forced to use a different font. 493might be forced to use a different font.
258 494
259All of this is not a problem when using X11 core fonts, as their bounding 495All of this is not a problem when using X11 core fonts, as their bounding
260box data is correct. 496box data is correct.
261 497
498=item On Solaris 9, many line-drawing characters are too wide.
499
500Seems to be a known bug, read
501L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
502following ugly workaround to get non-double-wide-characters working:
503
504 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
505
262=item My Compose (Multi_key) key is no longer working. 506=item My Compose (Multi_key) key is no longer working.
263 507
264The most common causes for this are that either your locale is not set 508The most common causes for this are that either your locale is not set
265correctly, or you specified a B<preeditStyle> that is not supported by 509correctly, or you specified a B<preeditStyle> that is not supported by
266your input method. For example, if you specified B<OverTheSpot> and 510your input method. For example, if you specified B<OverTheSpot> and
… …
309 553
310As you might have guessed, FreeBSD does neither define this symobl nor 554As you might have guessed, FreeBSD does neither define this symobl nor
311does it support it. Instead, it uses it's own internal representation of 555does it support it. Instead, it uses it's own internal representation of
312B<wchar_t>. This is, of course, completely fine with respect to standards. 556B<wchar_t>. This is, of course, completely fine with respect to standards.
313 557
558However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
559C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
560
314However, C<__STDC_ISO_10646__> is the only sane way to support 561C<__STDC_ISO_10646__> is the only sane way to support multi-language
315multi-language apps in an OS, as using a locale-dependent (and 562apps in an OS, as using a locale-dependent (and non-standardized)
316non-standardized) representation of B<wchar_t> makes it impossible to 563representation of B<wchar_t> makes it impossible to convert between
317convert between B<wchar_t> (as used by X11 and your applications) and any 564B<wchar_t> (as used by X11 and your applications) and any other encoding
318other encoding without implementing OS-specific-wrappers for each and 565without implementing OS-specific-wrappers for each and every locale. There
319every locale. There simply are no APIs to convert B<wchar_t> into anything 566simply are no APIs to convert B<wchar_t> into anything except the current
320except the current locale encoding. 567locale encoding.
321 568
322Some applications (such as the formidable B<mlterm>) work around this 569Some applications (such as the formidable B<mlterm>) work around this
323by carrying their own replacement functions for character set handling 570by carrying their own replacement functions for character set handling
324with them, and either implementing OS-dependent hacks or doing multiple 571with them, and either implementing OS-dependent hacks or doing multiple
325conversions (which is slow and unreliable in case the OS implements 572conversions (which is slow and unreliable in case the OS implements
326encodings slightly different than the terminal emulator). 573encodings slightly different than the terminal emulator).
327 574
328The rxvt-unicode author insists that the right way to fix this is in the 575The rxvt-unicode author insists that the right way to fix this is in the
329system libraries once and for all, instead of forcing every app to carry 576system libraries once and for all, instead of forcing every app to carry
330complete replacements for them :) 577complete replacements for them :)
578
579=item I use Solaris 9 and it doesn't compile/work/etc.
580
581Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
582problems with C<wcwidth> and a compile problem.
583
584=item How can I use rxvt-unicode under cygwin?
585
586rxvt-unicode should compile and run out of the box on cygwin, using
587the X11 libraries that come with cygwin. libW11 emulation is no
588longer supported (and makes no sense, either, as it only supported a
589single font). I recommend starting the X-server in C<-multiwindow> or
590C<-rootless> mode instead, which will result in similar look&feel as the
591old libW11 emulation.
592
593At the time of this writing, cygwin didn't seem to support any multi-byte
594encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
595to 8-bit encodings.
331 596
332=item How does rxvt-unicode determine the encoding to use? 597=item How does rxvt-unicode determine the encoding to use?
333 598
334=item Is there an option to switch encodings? 599=item Is there an option to switch encodings?
335 600
… …
414=item My input method wants <some encoding> but I want UTF-8, what can I do? 679=item My input method wants <some encoding> but I want UTF-8, what can I do?
415 680
416You can specify separate locales for the input method and the rest of the 681You can specify separate locales for the input method and the rest of the
417terminal, using the resource C<imlocale>: 682terminal, using the resource C<imlocale>:
418 683
419 URxvt*imlocale: ja_JP.EUC-JP 684 URxvt.imlocale: ja_JP.EUC-JP
420 685
421Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 686Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
422use your input method. Please note, however, that you will not be able to 687use your input method. Please note, however, that you will not be able to
423input characters outside C<EUC-JP> in a normal way then, as your input 688input characters outside C<EUC-JP> in a normal way then, as your input
424method limits you. 689method limits you.
… …
451 716
452=item Can I speed up Xft rendering somehow? 717=item Can I speed up Xft rendering somehow?
453 718
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as 719Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455it is simply slow. If you still want Xft fonts you might try to disable 720it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of 721antialiasing (by appending C<:antialias=false>), which saves lots of
457memory and also speeds up rendering considerably. 722memory and also speeds up rendering considerably.
458 723
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 724=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460 725
461Rxvt-unicode will use whatever you specify as a font. If it needs to 726Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
470 735
471Make sure that mouse reporting is actually turned off since killing 736Make sure that mouse reporting is actually turned off since killing
472some editors prematurely may leave the mouse in mouse report mode. I've 737some editors prematurely may leave the mouse in mouse report mode. I've
473heard that tcsh may use mouse reporting unless it otherwise specified. A 738heard that tcsh may use mouse reporting unless it otherwise specified. A
474quick check is to see if cut/paste works when the Alt or Shift keys are 739quick check is to see if cut/paste works when the Alt or Shift keys are
475depressed. See @@RXVT_NAME@@(7) 740depressed.
476 741
477=item What's with this bold/blink stuff? 742=item What's with this bold/blink stuff?
478 743
479If no bold colour is set via C<colorBD:>, bold will invert text using the 744If no bold colour is set via C<colorBD:>, bold will invert text using the
480standard foreground colour. 745standard foreground colour.
… …
539 URxvt.color7: #e1dddd 804 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd 805 URxvt.color15: #e1dddd
541 806
542=item How can I start @@RXVT_NAME@@d in a race-free way? 807=item How can I start @@RXVT_NAME@@d in a race-free way?
543 808
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 809Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
545server that answers @@RXVT_NAME@@c's requests, so it doesn't background 810display, create the listening socket and then fork.
546itself.
547
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549following method to wait for the startup message before continuing:
550
551 { @@RXVT_NAME@@d & } | read
552 811
553=item What's with the strange Backspace/Delete key behaviour? 812=item What's with the strange Backspace/Delete key behaviour?
554 813
555Assuming that the physical Backspace key corresponds to the 814Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following 815BackSpace keysym (not likely for Linux ... see the following
… …
575 834
576 # use Backspace = ^? 835 # use Backspace = ^?
577 $ stty erase ^? 836 $ stty erase ^?
578 $ @@RXVT_NAME@@ 837 $ @@RXVT_NAME@@
579 838
580Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 839Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
581 840
582For an existing rxvt-unicode: 841For an existing rxvt-unicode:
583 842
584 # use Backspace = ^H 843 # use Backspace = ^H
585 $ stty erase ^H 844 $ stty erase ^H
… …
703 962
704=head1 DESCRIPTION 963=head1 DESCRIPTION
705 964
706The rest of this document describes various technical aspects of 965The rest of this document describes various technical aspects of
707B<rxvt-unicode>. First the description of supported command sequences, 966B<rxvt-unicode>. First the description of supported command sequences,
708followed by menu and pixmap support and last by a description of all 967followed by pixmap support and last by a description of all features
709features selectable at C<configure> time. 968selectable at C<configure> time.
710 969
711=head1 Definitions 970=head1 Definitions
712 971
713=over 4 972=over 4
714 973
… …
1282 B<< C<h> >> Send Mouse X & Y on button press. 1541 B<< C<h> >> Send Mouse X & Y on button press.
1283 B<< C<l> >> No mouse reporting. 1542 B<< C<l> >> No mouse reporting.
1284 1543
1285=end table 1544=end table
1286 1545
1287=item B<< C<Ps = 10> >> (B<rxvt>)
1288
1289=begin table
1290
1291 B<< C<h> >> menuBar visible
1292 B<< C<l> >> menuBar invisible
1293
1294=end table
1295
1296=item B<< C<Ps = 25> >> 1546=item B<< C<Ps = 25> >>
1297 1547
1298=begin table 1548=begin table
1299 1549
1300 B<< C<h> >> Visible cursor {cnorm/cvvis} 1550 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1413 1663
1414=begin table 1664=begin table
1415 1665
1416 B<< C<h> >> Scroll to bottom when a key is pressed 1666 B<< C<h> >> Scroll to bottom when a key is pressed
1417 B<< C<l> >> Don't scroll to bottom when a key is pressed 1667 B<< C<l> >> Don't scroll to bottom when a key is pressed
1668
1669=end table
1670
1671=item B<< C<Ps = 1021> >> (B<rxvt>)
1672
1673=begin table
1674
1675 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1676 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1418 1677
1419=end table 1678=end table
1420 1679
1421=item B<< C<Ps = 1047> >> 1680=item B<< C<Ps = 1047> >>
1422 1681
… …
1471 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1730 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1472 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1731 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1473 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1732 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1474 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1733 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1734 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1735 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1477 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1736 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1737 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1478 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1738 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1479 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1480 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1739 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1740 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482 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> >> 1741 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> >>
1483 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1742 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484 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) 1743 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).
1485 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1744 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>.
1486 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1745 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1746 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1747 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1748 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1488 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1749 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1750 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1751 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1752 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1753 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1754 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1755 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1492 1756
1493=end table 1757=end table
1494 1758
1495=back 1759=back
1496 1760
1497X<menuBar>
1498
1499=head1 menuBar
1500
1501B<< The exact syntax used is I<almost> solidified. >>
1502In the menus, B<DON'T> try to use menuBar commands that add or remove a
1503menuBar.
1504
1505Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1506omitted: use B<./> to specify a menu relative to the current menu.
1507
1508=head2 Overview of menuBar operation
1509
1510For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1511of C<Pt> can be used for a variety of tasks:
1512
1513At the top level is the current menuBar which is a member of a circular
1514linked-list of other such menuBars.
1515
1516The menuBar acts as a parent for the various drop-down menus, which in
1517turn, may have labels, separator lines, menuItems and subMenus.
1518
1519The menuItems are the useful bits: you can use them to mimic keyboard
1520input or even to send text or escape sequences back to rxvt.
1521
1522The menuBar syntax is intended to provide a simple yet robust method of
1523constructing and manipulating menus and navigating through the
1524menuBars.
1525
1526The first step is to use the tag B<< [menu:I<name>] >> which creates
1527the menuBar called I<name> and allows access. You may now or menus,
1528subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1529menuBar access as B<readonly> to prevent accidental corruption of the
1530menus. To re-access the current menuBar for alterations, use the tag
1531B<[menu]>, make the alterations and then use B<[done]>
1532
1533X<menuBarCommands>
1534
1535=head2 Commands
1536
1537=over 4
1538
1539=item B<< [menu:+I<name>] >>
1540
1541access the named menuBar for creation or alteration. If a new menuBar
1542is created, it is called I<name> (max of 15 chars) and the current
1543menuBar is pushed onto the stack
1544
1545=item B<[menu]>
1546
1547access the current menuBar for alteration
1548
1549=item B<< [title:+I<string>] >>
1550
1551set the current menuBar's title to I<string>, which may contain the
1552following format specifiers:
1553
1554 B<%n> rxvt name (as per the B<-name> command-line option)
1555 B<%v> rxvt version
1556 B<%%> literal B<%> character
1557
1558=item B<[done]>
1559
1560set menuBar access as B<readonly>.
1561End-of-file tag for B<< [read:+I<file>] >> operations.
1562
1563=item B<< [read:+I<file>] >>
1564
1565read menu commands directly from I<file> (extension ".menu" will be
1566appended if required.) Start reading at a line with B<[menu]> or B<<
1567[menu:+I<name> >> and continuing until B<[done]> is encountered.
1568
1569Blank and comment lines (starting with B<#>) are ignored. Actually,
1570since any invalid menu commands are also ignored, almost anything could
1571be construed as a comment line, but this may be tightened up in the
1572future ... so don't count on it!.
1573
1574=item B<< [read:+I<file>;+I<name>] >>
1575
1576The same as B<< [read:+I<file>] >>, but start reading at a line with
1577B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1578B<[done]> is encountered.
1579
1580=item B<[dump]>
1581
1582dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1583later rereading.
1584
1585=item B<[rm:name]>
1586
1587remove the named menuBar
1588
1589=item B<[rm] [rm:]>
1590
1591remove the current menuBar
1592
1593=item B<[rm*] [rm:*]>
1594
1595remove all menuBars
1596
1597=item B<[swap]>
1598
1599swap the top two menuBars
1600
1601=item B<[prev]>
1602
1603access the previous menuBar
1604
1605=item B<[next]>
1606
1607access the next menuBar
1608
1609=item B<[show]>
1610
1611Enable display of the menuBar
1612
1613=item B<[hide]>
1614
1615Disable display of the menuBar
1616
1617=item B<< [pixmap:+I<name>] >>
1618
1619=item B<< [pixmap:+I<name>;I<scaling>] >>
1620
1621(set the background pixmap globally
1622
1623B<< A Future implementation I<may> make this local to the menubar >>)
1624
1625=item B<< [:+I<command>:] >>
1626
1627ignore the menu readonly status and issue a I<command> to or a menu or
1628menuitem or change the ; a useful shortcut for setting the quick arrows
1629from a menuBar.
1630
1631=back
1632
1633X<menuBarAdd>
1634
1635=head2 Adding and accessing menus
1636
1637The following commands may also be B<+> prefixed.
1638
1639=over 4
1640
1641=item B</+>
1642
1643access menuBar top level
1644
1645=item B<./+>
1646
1647access current menu level
1648
1649=item B<../+>
1650
1651access parent menu (1 level up)
1652
1653=item B<../../>
1654
1655access parent menu (multiple levels up)
1656
1657=item B<< I</path/>menu >>
1658
1659add/access menu
1660
1661=item B<< I</path/>menu/* >>
1662
1663add/access menu and clear it if it exists
1664
1665=item B<< I</path/>{-} >>
1666
1667add separator
1668
1669=item B<< I</path/>{item} >>
1670
1671add B<item> as a label
1672
1673=item B<< I</path/>{item} action >>
1674
1675add/alter I<menuitem> with an associated I<action>
1676
1677=item B<< I</path/>{item}{right-text} >>
1678
1679add/alter I<menuitem> with B<right-text> as the right-justified text
1680and as the associated I<action>
1681
1682=item B<< I</path/>{item}{rtext} action >>
1683
1684add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1685the right-justified text.
1686
1687=back
1688
1689=over 4
1690
1691=item Special characters in I<action> must be backslash-escaped:
1692
1693B<\a \b \E \e \n \r \t \octal>
1694
1695=item or in control-character notation:
1696
1697B<^@, ^A .. ^Z .. ^_, ^?>
1698
1699=back
1700
1701To send a string starting with a B<NUL> (B<^@>) character to the
1702program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1703the first of which will be stripped off and the balance directed to the
1704program. Otherwise if I<action> begins with B<NUL> followed by
1705non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1706balance is sent back to rxvt.
1707
1708As a convenience for the many Emacs-type editors, I<action> may start
1709with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1710appended if missed from B<M-x> commands.
1711
1712As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1713quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1714
1715=over 4
1716
1717=item For example,
1718
1719B<M-xapropos> is equivalent to B<\Exapropos\r>
1720
1721=item and
1722
1723B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1724
1725=back
1726
1727The option B<< {I<right-rtext>} >> will be right-justified. In the
1728absence of a specified action, this text will be used as the I<action>
1729as well.
1730
1731=over 4
1732
1733=item For example,
1734
1735B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1736
1737=back
1738
1739The left label I<is> necessary, since it's used for matching, but
1740implicitly hiding the left label (by using same name for both left and
1741right labels), or explicitly hiding the left label (by preceeding it
1742with a dot), makes it possible to have right-justified text only.
1743
1744=over 4
1745
1746=item For example,
1747
1748B</File/{Open}{Open} Open-File-Action>
1749
1750=item or hiding it
1751
1752B</File/{.anylabel}{Open} Open-File-Action>
1753
1754=back
1755
1756X<menuBarRemove>
1757
1758=head2 Removing menus
1759
1760=over 4
1761
1762=item B<< -/*+ >>
1763
1764remove all menus from the menuBar, the same as B<[clear]>
1765
1766=item B<< -+I</path>menu+ >>
1767
1768remove menu
1769
1770=item B<< -+I</path>{item}+ >>
1771
1772remove item
1773
1774=item B<< -+I</path>{-} >>
1775
1776remove separator)
1777
1778=item B<-/path/menu/*>
1779
1780remove all items, separators and submenus from menu
1781
1782=back
1783
1784X<menuBarArrows>
1785
1786=head2 Quick Arrows
1787
1788The menus also provide a hook for I<quick arrows> to provide easier
1789user access. If nothing has been explicitly set, the default is to
1790emulate the curror keys. The syntax permits each arrow to be altered
1791individually or all four at once without re-entering their common
1792beginning/end text. For example, to explicitly associate cursor actions
1793with the arrows, any of the following forms could be used:
1794
1795=over 4
1796
1797=item B<< <r>+I<Right> >>
1798
1799=item B<< <l>+I<Left> >>
1800
1801=item B<< <u>+I<Up> >>
1802
1803=item B<< <d>+I<Down> >>
1804
1805Define actions for the respective arrow buttons
1806
1807=item B<< <b>+I<Begin> >>
1808
1809=item B<< <e>+I<End> >>
1810
1811Define common beginning/end parts for I<quick arrows> which used in
1812conjunction with the above <r> <l> <u> <d> constructs
1813
1814=back
1815
1816=over 4
1817
1818=item For example, define arrows individually,
1819
1820 <u>\E[A
1821
1822 <d>\E[B
1823
1824 <r>\E[C
1825
1826 <l>\E[D
1827
1828=item or all at once
1829
1830 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1831
1832=item or more compactly (factoring out common parts)
1833
1834 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1835
1836=back
1837
1838X<menuBarSummary>
1839
1840=head2 Command Summary
1841
1842A short summary of the most I<common> commands:
1843
1844=over 4
1845
1846=item [menu:name]
1847
1848use an existing named menuBar or start a new one
1849
1850=item [menu]
1851
1852use the current menuBar
1853
1854=item [title:string]
1855
1856set menuBar title
1857
1858=item [done]
1859
1860set menu access to readonly and, if reading from a file, signal EOF
1861
1862=item [done:name]
1863
1864if reading from a file using [read:file;name] signal EOF
1865
1866=item [rm:name]
1867
1868remove named menuBar(s)
1869
1870=item [rm] [rm:]
1871
1872remove current menuBar
1873
1874=item [rm*] [rm:*]
1875
1876remove all menuBar(s)
1877
1878=item [swap]
1879
1880swap top two menuBars
1881
1882=item [prev]
1883
1884access the previous menuBar
1885
1886=item [next]
1887
1888access the next menuBar
1889
1890=item [show]
1891
1892map menuBar
1893
1894=item [hide]
1895
1896unmap menuBar
1897
1898=item [pixmap;file]
1899
1900=item [pixmap;file;scaling]
1901
1902set a background pixmap
1903
1904=item [read:file]
1905
1906=item [read:file;name]
1907
1908read in a menu from a file
1909
1910=item [dump]
1911
1912dump out all menuBars to /tmp/rxvt-PID
1913
1914=item /
1915
1916access menuBar top level
1917
1918=item ./
1919
1920=item ../
1921
1922=item ../../
1923
1924access current or parent menu level
1925
1926=item /path/menu
1927
1928add/access menu
1929
1930=item /path/{-}
1931
1932add separator
1933
1934=item /path/{item}{rtext} action
1935
1936add/alter menu item
1937
1938=item -/*
1939
1940remove all menus from the menuBar
1941
1942=item -/path/menu
1943
1944remove menu items, separators and submenus from menu
1945
1946=item -/path/menu
1947
1948remove menu
1949
1950=item -/path/{item}
1951
1952remove item
1953
1954=item -/path/{-}
1955
1956remove separator
1957
1958=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1959
1960menu quick arrows
1961
1962=back
1963X<XPM> 1761X<XPM>
1964 1762
1965=head1 XPM 1763=head1 XPM
1966 1764
1967For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1765For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
2153=end table 1951=end table
2154 1952
2155=head1 CONFIGURE OPTIONS 1953=head1 CONFIGURE OPTIONS
2156 1954
2157General hint: if you get compile errors, then likely your configuration 1955General hint: if you get compile errors, then likely your configuration
2158hasn't been tested well. Either try with --enable-everything or use the 1956hasn't been tested well. Either try with C<--enable-everything> or use
2159./reconf script as a base for experiments. ./reconf is used by myself, 1957the F<./reconf> script as a base for experiments. F<./reconf> is used by
2160so it should generally be a working config. Of course, you should always 1958myself, so it should generally be a working config. Of course, you should
2161report when a combination doesn't work, so it can be fixed. Marc Lehmann 1959always report when a combination doesn't work, so it can be fixed. Marc
2162<rxvt@schmorp.de>. 1960Lehmann <rxvt@schmorp.de>.
1961
1962All
2163 1963
2164=over 4 1964=over 4
2165 1965
2166=item --enable-everything 1966=item --enable-everything
2167 1967
2168Add support for all non-multichoice options listed in "./configure 1968Add (or remove) support for all non-multichoice options listed in "./configure
2169--help". Note that unlike other enable options this is order dependant. 1969--help".
1970
2170You can specify this and then disable options which this enables by 1971You can specify this and then disable options you do not like by
2171I<following> this with the appropriate commands. 1972I<following> this with the appropriate C<--disable-...> arguments,
1973or you can start with a minimal configuration by specifying
1974C<--disable-everything> and than adding just the C<--enable-...> arguments
1975you want.
2172 1976
2173=item --enable-xft 1977=item --enable-xft (default: enabled)
2174 1978
2175Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1979Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2176slower and require lots of memory, but as long as you don't use them, you 1980slower and require lots of memory, but as long as you don't use them, you
2177don't pay for them. 1981don't pay for them.
2178 1982
2179=item --enable-font-styles 1983=item --enable-font-styles (default: on)
2180 1984
2181Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 1985Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182styles. The fonts can be set manually or automatically. 1986styles. The fonts can be set manually or automatically.
2183 1987
2184=item --with-codesets=NAME,... 1988=item --with-codesets=NAME,... (default: all)
2185 1989
2186Compile in support for additional codeset (encoding) groups (eu, vn are 1990Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187always compiled in, which includes most 8-bit character sets). These 1991are always compiled in, which includes most 8-bit character sets). These
2188codeset tables are currently only used for driving X11 core fonts, they 1992codeset tables are used for driving X11 core fonts, they are not required
2189are not required for Xft fonts. Compiling them in will make your binary 1993for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190bigger (together about 700kB), but it doesn't increase memory usage unless 1994replacement fonts more intelligently. Compiling them in will make your
1995binary bigger (all of together cost about 700kB), but it doesn't increase
2191you use an X11 font requiring one of these encodings. 1996memory usage unless you use a font requiring one of these encodings.
2192 1997
2193=begin table 1998=begin table
2194 1999
2195 all all available codeset groups 2000 all all available codeset groups
2196 zh common chinese encodings 2001 zh common chinese encodings
… …
2199 jp_ext rarely used but big japanese encodings 2004 jp_ext rarely used but big japanese encodings
2200 kr korean encodings 2005 kr korean encodings
2201 2006
2202=end table 2007=end table
2203 2008
2204=item --enable-xim 2009=item --enable-xim (default: on)
2205 2010
2206Add support for XIM (X Input Method) protocol. This allows using 2011Add support for XIM (X Input Method) protocol. This allows using
2207alternative input methods (e.g. kinput2) and will also correctly 2012alternative input methods (e.g. kinput2) and will also correctly
2208set up the input for people using dead keys or compose keys. 2013set up the input for people using dead keys or compose keys.
2209 2014
2210=item --enable-unicode3 2015=item --enable-unicode3 (default: off)
2016
2017Recommended to stay off unless you really need non-BMP characters.
2211 2018
2212Enable direct support for displaying unicode codepoints above 2019Enable direct support for displaying unicode codepoints above
221365535 (the basic multilingual page). This increases storage 202065535 (the basic multilingual page). This increases storage
2214requirements per character from 2 to 4 bytes. X11 fonts do not yet 2021requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215support these extra characters, but Xft does. 2022support these extra characters, but Xft does.
… …
2218even without this flag, but the number of such characters is 2025even without this flag, but the number of such characters is
2219limited to a view thousand (shared with combining characters, 2026limited to a view thousand (shared with combining characters,
2220see next switch), and right now rxvt-unicode cannot display them 2027see next switch), and right now rxvt-unicode cannot display them
2221(input/output and cut&paste still work, though). 2028(input/output and cut&paste still work, though).
2222 2029
2223=item --enable-combining 2030=item --enable-combining (default: on)
2224 2031
2225Enable automatic composition of combining characters into 2032Enable automatic composition of combining characters into
2226composite characters. This is required for proper viewing of text 2033composite characters. This is required for proper viewing of text
2227where accents are encoded as seperate unicode characters. This is 2034where accents are encoded as seperate unicode characters. This is
2228done by using precomposited characters when available or creating 2035done by using precomposited characters when available or creating
2229new pseudo-characters when no precomposed form exists. 2036new pseudo-characters when no precomposed form exists.
2230 2037
2231Without --enable-unicode3, the number of additional precomposed characters 2038Without --enable-unicode3, the number of additional precomposed
2232is rather limited (2048, if this is full, rxvt-unicode will use the 2039characters is somewhat limited (the 6400 private use characters will be
2233private use area, extending the number of combinations to 8448). With
2234--enable-unicode3, no practical limit exists. 2040(ab-)used). With --enable-unicode3, no practical limit exists.
2235 2041
2236This option will also enable storage (but not display) of characters 2042This option will also enable storage (but not display) of characters
2237beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2043beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2238 2044
2239The combining table also contains entries for arabic presentation forms, 2045The combining table also contains entries for arabic presentation forms,
2240but these are not currently used. Bug me if you want these to be used (and 2046but these are not currently used. Bug me if you want these to be used (and
2241tell me how these are to be used...). 2047tell me how these are to be used...).
2242 2048
2243=item --enable-fallback(=CLASS) 2049=item --enable-fallback(=CLASS) (default: Rxvt)
2244 2050
2245When reading resource settings, also read settings for class CLASS 2051When reading resource settings, also read settings for class CLASS. To
2246(default: Rxvt). To disable resource fallback use --disable-fallback. 2052disable resource fallback use --disable-fallback.
2247 2053
2248=item --with-res-name=NAME 2054=item --with-res-name=NAME (default: urxvt)
2249 2055
2250Use the given name (default: urxvt) as default application name when 2056Use the given name as default application name when
2251reading resources. Specify --with-res-name=rxvt to replace rxvt. 2057reading resources. Specify --with-res-name=rxvt to replace rxvt.
2252 2058
2253=item --with-res-class=CLASS 2059=item --with-res-class=CLASS /default: URxvt)
2254 2060
2255Use the given class (default: URxvt) as default application class 2061Use the given class as default application class
2256when reading resources. Specify --with-res-class=Rxvt to replace 2062when reading resources. Specify --with-res-class=Rxvt to replace
2257rxvt. 2063rxvt.
2258 2064
2259=item --enable-utmp 2065=item --enable-utmp (default: on)
2260 2066
2261Write user and tty to utmp file (used by programs like F<w>) at 2067Write user and tty to utmp file (used by programs like F<w>) at
2262start of rxvt execution and delete information when rxvt exits. 2068start of rxvt execution and delete information when rxvt exits.
2263 2069
2264=item --enable-wtmp 2070=item --enable-wtmp (default: on)
2265 2071
2266Write user and tty to wtmp file (used by programs like F<last>) at 2072Write user and tty to wtmp file (used by programs like F<last>) at
2267start of rxvt execution and write logout when rxvt exits. This 2073start of rxvt execution and write logout when rxvt exits. This
2268option requires --enable-utmp to also be specified. 2074option requires --enable-utmp to also be specified.
2269 2075
2270=item --enable-lastlog 2076=item --enable-lastlog (default: on)
2271 2077
2272Write user and tty to lastlog file (used by programs like 2078Write user and tty to lastlog file (used by programs like
2273F<lastlogin>) at start of rxvt execution. This option requires 2079F<lastlogin>) at start of rxvt execution. This option requires
2274--enable-utmp to also be specified. 2080--enable-utmp to also be specified.
2275 2081
2276=item --enable-xpm-background 2082=item --enable-xpm-background (default: on)
2277 2083
2278Add support for XPM background pixmaps. 2084Add support for XPM background pixmaps.
2279 2085
2280=item --enable-transparency 2086=item --enable-transparency (default: on)
2281 2087
2282Add support for inheriting parent backgrounds thus giving a fake 2088Add support for inheriting parent backgrounds thus giving a fake
2283transparency to the term. 2089transparency to the term.
2284 2090
2285=item --enable-fading 2091=item --enable-fading (default: on)
2286 2092
2287Add support for fading the text when focus is lost. 2093Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2288 2094
2289=item --enable-tinting 2095=item --enable-tinting (default: on)
2290 2096
2291Add support for tinting of transparent backgrounds. 2097Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2292 2098
2293=item --enable-menubar
2294
2295Add support for our menu bar system (this interacts badly with
2296dynamic locale switching currently).
2297
2298=item --enable-rxvt-scroll 2099=item --enable-rxvt-scroll (default: on)
2299 2100
2300Add support for the original rxvt scrollbar. 2101Add support for the original rxvt scrollbar.
2301 2102
2302=item --enable-next-scroll 2103=item --enable-next-scroll (default: on)
2303 2104
2304Add support for a NeXT-like scrollbar. 2105Add support for a NeXT-like scrollbar.
2305 2106
2306=item --enable-xterm-scroll 2107=item --enable-xterm-scroll (default: on)
2307 2108
2308Add support for an Xterm-like scrollbar. 2109Add support for an Xterm-like scrollbar.
2309 2110
2310=item --enable-plain-scroll 2111=item --enable-plain-scroll (default: on)
2311 2112
2312Add support for a very unobtrusive, plain-looking scrollbar that 2113Add support for a very unobtrusive, plain-looking scrollbar that
2313is the favourite of the rxvt-unicode author, having used it for 2114is the favourite of the rxvt-unicode author, having used it for
2314many years. 2115many years.
2315 2116
2316=item --enable-half-shadow 2117=item --enable-ttygid (default: off)
2317
2318Make shadows on the scrollbar only half the normal width & height.
2319only applicable to rxvt scrollbars.
2320
2321=item --enable-ttygid
2322 2118
2323Change tty device setting to group "tty" - only use this if 2119Change tty device setting to group "tty" - only use this if
2324your system uses this type of security. 2120your system uses this type of security.
2325 2121
2326=item --disable-backspace-key 2122=item --disable-backspace-key
2327 2123
2328Disable any handling of the backspace key by us - let the X server 2124Removes any handling of the backspace key by us - let the X server do it.
2125
2126=item --disable-delete-key
2127
2128Removes any handling of the delete key by us - let the X server
2329do it. 2129do it.
2330 2130
2331=item --disable-delete-key
2332
2333Disable any handling of the delete key by us - let the X server
2334do it.
2335
2336=item --disable-resources 2131=item --disable-resources
2337 2132
2338Remove all resources checking. 2133Removes any support for resource checking.
2339
2340=item --enable-xgetdefault
2341
2342Make resources checking via XGetDefault() instead of our small
2343version which only checks ~/.Xdefaults, or if that doesn't exist then
2344~/.Xresources.
2345
2346Please note that nowadays, things like XIM will automatically pull in and
2347use the full X resource manager, so the overhead of using it might be very
2348small, if nonexistant.
2349
2350=item --enable-strings
2351
2352Add support for our possibly faster memset() function and other
2353various routines, overriding your system's versions which may
2354have been hand-crafted in assembly or may require extra libraries
2355to link in. (this breaks ANSI-C rules and has problems on many
2356GNU/Linux systems).
2357 2134
2358=item --disable-swapscreen 2135=item --disable-swapscreen
2359 2136
2360Remove support for swap screen. 2137Remove support for secondary/swap screen.
2361 2138
2362=item --enable-frills 2139=item --enable-frills (default: on)
2363 2140
2364Add support for many small features that are not essential but nice to 2141Add support for many small features that are not essential but nice to
2365have. Normally you want this, but for very small binaries you may want to 2142have. Normally you want this, but for very small binaries you may want to
2366disable this. 2143disable this.
2367 2144
2368A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2145A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369in combination with other switches) is: 2146in combination with other switches) is:
2370 2147
2371 MWM-hints 2148 MWM-hints
2149 EWMH-hints (pid, utf8 names) and protocols (ping)
2372 seperate underline colour 2150 seperate underline colour (-underlineColor)
2373 settable border widths and borderless switch 2151 settable border widths and borderless switch (-w, -b, -bl)
2152 visual depth selection (-depth)
2374 settable extra linespacing 2153 settable extra linespacing /-lsp)
2375 extra window properties (e.g. UTF-8 window names and PID)
2376 iso-14755-2 and -3, and visual feedback 2154 iso-14755-2 and -3, and visual feedback
2377 backindex and forwardindex escape sequence
2378 window op and locale change escape sequences
2379 tripleclickwords 2155 tripleclickwords (-tcw)
2380 settable insecure mode 2156 settable insecure mode (-insecure)
2381 keysym remapping support 2157 keysym remapping support
2158 cursor blinking and underline cursor (-cb, -uc)
2159 XEmbed support (-embed)
2160 user-pty (-pty-fd)
2161 hold on exit (-hold)
2162 skip builtin block graphics (-sbg)
2382 2163
2164It also enabled some non-essential features otherwise disabled, such as:
2165
2166 some round-trip time optimisations
2167 nearest color allocation on pseudocolor screens
2168 UTF8_STRING supporr for selection
2169 sgr modes 90..97 and 100..107
2170 backindex and forwardindex escape sequences
2171 view change/zero scorllback esacpe sequences
2172 locale switching escape sequence
2173 window op and some xterm/OSC escape sequences
2174 rectangular selections
2175 trailing space removal for selections
2176 verbose X error handling
2177
2383=item --enable-iso14755 2178=item --enable-iso14755 (default: on)
2384 2179
2385Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2180Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2181F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2387C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2182C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2388this switch. 2183this switch.
2389 2184
2390=item --enable-keepscrolling 2185=item --enable-keepscrolling (default: on)
2391 2186
2392Add support for continual scrolling of the display when you hold 2187Add support for continual scrolling of the display when you hold
2393the mouse button down on a scrollbar arrow. 2188the mouse button down on a scrollbar arrow.
2394 2189
2395=item --enable-mousewheel 2190=item --enable-mousewheel (default: on)
2396 2191
2397Add support for scrolling via mouse wheel or buttons 4 & 5. 2192Add support for scrolling via mouse wheel or buttons 4 & 5.
2398 2193
2399=item --enable-slipwheeling 2194=item --enable-slipwheeling (default: on)
2400 2195
2401Add support for continual scrolling (using the mouse wheel as an 2196Add support for continual scrolling (using the mouse wheel as an
2402accelerator) while the control key is held down. This option 2197accelerator) while the control key is held down. This option
2403requires --enable-mousewheel to also be specified. 2198requires --enable-mousewheel to also be specified.
2404 2199
2405=item --disable-new-selection 2200=item --disable-new-selection
2406 2201
2407Remove support for mouse selection style like that of xterm. 2202Remove support for mouse selection style like that of xterm.
2408 2203
2409=item --enable-dmalloc 2204=item --enable-dmalloc (default: off)
2410 2205
2411Use Gray Watson's malloc - which is good for debugging See 2206Use Gray Watson's malloc - which is good for debugging See
2412http://www.letters.com/dmalloc/ for details If you use either this or the 2207http://www.letters.com/dmalloc/ for details If you use either this or the
2413next option, you may need to edit src/Makefile after compiling to point 2208next option, you may need to edit src/Makefile after compiling to point
2414DINCLUDE and DLIB to the right places. 2209DINCLUDE and DLIB to the right places.
2415 2210
2416You can only use either this option and the following (should 2211You can only use either this option and the following (should
2417you use either) . 2212you use either) .
2418 2213
2419=item --enable-dlmalloc 2214=item --enable-dlmalloc (default: off)
2420 2215
2421Use Doug Lea's malloc - which is good for a production version 2216Use Doug Lea's malloc - which is good for a production version
2422See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2217See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2423 2218
2424=item --enable-smart-resize 2219=item --enable-smart-resize (default: on)
2425 2220
2426Add smart growth/shrink behaviour when changing font size via from hot 2221Add smart growth/shrink behaviour when changing font size via hot
2427keys. This should keep in a fixed position the rxvt corner which is 2222keys. This should keep the window corner which is closest to a corner of
2428closest to a corner of the screen. 2223the screen in a fixed position.
2429 2224
2430=item --enable-cursor-blink
2431
2432Add support for a blinking cursor.
2433
2434=item --enable-pointer-blank 2225=item --enable-pointer-blank (default: on)
2435 2226
2436Add support to have the pointer disappear when typing or inactive. 2227Add support to have the pointer disappear when typing or inactive.
2437 2228
2438=item --with-name=NAME 2229=item --enable-perl (default: on)
2439 2230
2231Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2232manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2233in F<src/perl-ext/> for the extensions that are installed by default. The
2234perl interpreter that is used can be specified via the C<PERL> environment
2235variable when running configure.
2236
2237=item --with-name=NAME (default: urxvt)
2238
2440Set the basename for the installed binaries (default: C<urxvt>, resulting 2239Set the basename for the installed binaries, resulting
2441in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2240in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2442C<rxvt>. 2241C<rxvt>.
2443 2242
2444=item --with-term=NAME 2243=item --with-term=NAME (default: rxvt-unicode)
2445 2244
2446Change the environmental variable for the terminal to NAME (default 2245Change the environmental variable for the terminal to NAME.
2447C<rxvt-unicode>)
2448 2246
2449=item --with-terminfo=PATH 2247=item --with-terminfo=PATH
2450 2248
2451Change the environmental variable for the path to the terminfo tree to 2249Change the environmental variable for the path to the terminfo tree to
2452PATH. 2250PATH.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines