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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines