ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.96 by root, Tue Jan 31 00:25:16 2006 UTC

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

Diff Legend

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