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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines