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.50 by root, Sun Feb 20 19:45:30 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).
… …
71 310
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.
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.
76 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
… …
258might be forced to use a different font. 502might be forced to use a different font.
259 503
260All 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
261box data is correct. 505box data is correct.
262 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
263=item My Compose (Multi_key) key is no longer working. 515=item My Compose (Multi_key) key is no longer working.
264 516
265The 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
266correctly, or you specified a B<preeditStyle> that is not supported by 518correctly, or you specified a B<preeditStyle> that is not supported by
267your input method. For example, if you specified B<OverTheSpot> and 519your input method. For example, if you specified B<OverTheSpot> and
… …
310 562
311As you might have guessed, FreeBSD does neither define this symobl nor 563As you might have guessed, FreeBSD does neither define this symobl nor
312does 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
313B<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.
314 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
315However, C<__STDC_ISO_10646__> is the only sane way to support 570C<__STDC_ISO_10646__> is the only sane way to support multi-language
316multi-language apps in an OS, as using a locale-dependent (and 571apps in an OS, as using a locale-dependent (and non-standardized)
317non-standardized) representation of B<wchar_t> makes it impossible to 572representation of B<wchar_t> makes it impossible to convert between
318convert 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
319other encoding without implementing OS-specific-wrappers for each and 574without implementing OS-specific-wrappers for each and every locale. There
320every 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
321except the current locale encoding. 576locale encoding.
322 577
323Some applications (such as the formidable B<mlterm>) work around this 578Some applications (such as the formidable B<mlterm>) work around this
324by carrying their own replacement functions for character set handling 579by carrying their own replacement functions for character set handling
325with them, and either implementing OS-dependent hacks or doing multiple 580with them, and either implementing OS-dependent hacks or doing multiple
326conversions (which is slow and unreliable in case the OS implements 581conversions (which is slow and unreliable in case the OS implements
327encodings slightly different than the terminal emulator). 582encodings slightly different than the terminal emulator).
328 583
329The 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
330system 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
331complete 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.
332 605
333=item How does rxvt-unicode determine the encoding to use? 606=item How does rxvt-unicode determine the encoding to use?
334 607
335=item Is there an option to switch encodings? 608=item Is there an option to switch encodings?
336 609
… …
415=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?
416 689
417You 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
418terminal, using the resource C<imlocale>: 691terminal, using the resource C<imlocale>:
419 692
420 URxvt*imlocale: ja_JP.EUC-JP 693 URxvt.imlocale: ja_JP.EUC-JP
421 694
422Now 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
423use 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
424input 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
425method limits you. 698method limits you.
… …
452 725
453=item Can I speed up Xft rendering somehow? 726=item Can I speed up Xft rendering somehow?
454 727
455Yes, 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
456it 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
457antialiasing (by appending C<:antialiasing=false>), which saves lots of 730antialiasing (by appending C<:antialias=false>), which saves lots of
458memory and also speeds up rendering considerably. 731memory and also speeds up rendering considerably.
459 732
460=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?
461 734
462Rxvt-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
… …
471 744
472Make sure that mouse reporting is actually turned off since killing 745Make sure that mouse reporting is actually turned off since killing
473some 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
474heard that tcsh may use mouse reporting unless it otherwise specified. A 747heard that tcsh may use mouse reporting unless it otherwise specified. A
475quick 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
476depressed. See @@RXVT_NAME@@(7) 749depressed.
477 750
478=item What's with this bold/blink stuff? 751=item What's with this bold/blink stuff?
479 752
480If 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
481standard foreground colour. 754standard foreground colour.
… …
540 URxvt.color7: #e1dddd 813 URxvt.color7: #e1dddd
541 URxvt.color15: #e1dddd 814 URxvt.color15: #e1dddd
542 815
543=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?
544 817
545Despite 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
546server that answers @@RXVT_NAME@@c's requests, so it doesn't background 819display, create the listening socket and then fork.
547itself.
548
549To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
550following method to wait for the startup message before continuing:
551
552 { @@RXVT_NAME@@d & } | read
553 820
554=item What's with the strange Backspace/Delete key behaviour? 821=item What's with the strange Backspace/Delete key behaviour?
555 822
556Assuming that the physical Backspace key corresponds to the 823Assuming that the physical Backspace key corresponds to the
557BackSpace keysym (not likely for Linux ... see the following 824BackSpace keysym (not likely for Linux ... see the following
… …
576 843
577 # use Backspace = ^? 844 # use Backspace = ^?
578 $ stty erase ^? 845 $ stty erase ^?
579 $ @@RXVT_NAME@@ 846 $ @@RXVT_NAME@@
580 847
581Toggle 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>.
582 849
583For an existing rxvt-unicode: 850For an existing rxvt-unicode:
584 851
585 # use Backspace = ^H 852 # use Backspace = ^H
586 $ stty erase ^H 853 $ stty erase ^H
… …
704 971
705=head1 DESCRIPTION 972=head1 DESCRIPTION
706 973
707The rest of this document describes various technical aspects of 974The rest of this document describes various technical aspects of
708B<rxvt-unicode>. First the description of supported command sequences, 975B<rxvt-unicode>. First the description of supported command sequences,
709followed by menu and pixmap support and last by a description of all 976followed by pixmap support and last by a description of all features
710features selectable at C<configure> time. 977selectable at C<configure> time.
711 978
712=head1 Definitions 979=head1 Definitions
713 980
714=over 4 981=over 4
715 982
… …
1283 B<< C<h> >> Send Mouse X & Y on button press. 1550 B<< C<h> >> Send Mouse X & Y on button press.
1284 B<< C<l> >> No mouse reporting. 1551 B<< C<l> >> No mouse reporting.
1285 1552
1286=end table 1553=end table
1287 1554
1288=item B<< C<Ps = 10> >> (B<rxvt>)
1289
1290=begin table
1291
1292 B<< C<h> >> menuBar visible
1293 B<< C<l> >> menuBar invisible
1294
1295=end table
1296
1297=item B<< C<Ps = 25> >> 1555=item B<< C<Ps = 25> >>
1298 1556
1299=begin table 1557=begin table
1300 1558
1301 B<< C<h> >> Visible cursor {cnorm/cvvis} 1559 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1414 1672
1415=begin table 1673=begin table
1416 1674
1417 B<< C<h> >> Scroll to bottom when a key is pressed 1675 B<< C<h> >> Scroll to bottom when a key is pressed
1418 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)
1419 1686
1420=end table 1687=end table
1421 1688
1422=item B<< C<Ps = 1047> >> 1689=item B<< C<Ps = 1047> >>
1423 1690
… …
1472 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)>
1473 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)>
1474 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> >>
1475 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> >>
1476 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> >>
1477 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]
1478 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).
1479 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1747 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1480 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1481 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>
1482 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> >>.
1483 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> >>
1484 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> >>
1485 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).
1486 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>.
1487 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> >>
1488 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> >>
1489 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>.
1490 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).
1491 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).
1492 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).
1493 1765
1494=end table 1766=end table
1495 1767
1496=back 1768=back
1497 1769
1498X<menuBar>
1499
1500=head1 menuBar
1501
1502B<< The exact syntax used is I<almost> solidified. >>
1503In the menus, B<DON'T> try to use menuBar commands that add or remove a
1504menuBar.
1505
1506Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1507omitted: use B<./> to specify a menu relative to the current menu.
1508
1509=head2 Overview of menuBar operation
1510
1511For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1512of C<Pt> can be used for a variety of tasks:
1513
1514At the top level is the current menuBar which is a member of a circular
1515linked-list of other such menuBars.
1516
1517The menuBar acts as a parent for the various drop-down menus, which in
1518turn, may have labels, separator lines, menuItems and subMenus.
1519
1520The menuItems are the useful bits: you can use them to mimic keyboard
1521input or even to send text or escape sequences back to rxvt.
1522
1523The menuBar syntax is intended to provide a simple yet robust method of
1524constructing and manipulating menus and navigating through the
1525menuBars.
1526
1527The first step is to use the tag B<< [menu:I<name>] >> which creates
1528the menuBar called I<name> and allows access. You may now or menus,
1529subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1530menuBar access as B<readonly> to prevent accidental corruption of the
1531menus. To re-access the current menuBar for alterations, use the tag
1532B<[menu]>, make the alterations and then use B<[done]>
1533
1534X<menuBarCommands>
1535
1536=head2 Commands
1537
1538=over 4
1539
1540=item B<< [menu:+I<name>] >>
1541
1542access the named menuBar for creation or alteration. If a new menuBar
1543is created, it is called I<name> (max of 15 chars) and the current
1544menuBar is pushed onto the stack
1545
1546=item B<[menu]>
1547
1548access the current menuBar for alteration
1549
1550=item B<< [title:+I<string>] >>
1551
1552set the current menuBar's title to I<string>, which may contain the
1553following format specifiers:
1554
1555 B<%n> rxvt name (as per the B<-name> command-line option)
1556 B<%v> rxvt version
1557 B<%%> literal B<%> character
1558
1559=item B<[done]>
1560
1561set menuBar access as B<readonly>.
1562End-of-file tag for B<< [read:+I<file>] >> operations.
1563
1564=item B<< [read:+I<file>] >>
1565
1566read menu commands directly from I<file> (extension ".menu" will be
1567appended if required.) Start reading at a line with B<[menu]> or B<<
1568[menu:+I<name> >> and continuing until B<[done]> is encountered.
1569
1570Blank and comment lines (starting with B<#>) are ignored. Actually,
1571since any invalid menu commands are also ignored, almost anything could
1572be construed as a comment line, but this may be tightened up in the
1573future ... so don't count on it!.
1574
1575=item B<< [read:+I<file>;+I<name>] >>
1576
1577The same as B<< [read:+I<file>] >>, but start reading at a line with
1578B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1579B<[done]> is encountered.
1580
1581=item B<[dump]>
1582
1583dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1584later rereading.
1585
1586=item B<[rm:name]>
1587
1588remove the named menuBar
1589
1590=item B<[rm] [rm:]>
1591
1592remove the current menuBar
1593
1594=item B<[rm*] [rm:*]>
1595
1596remove all menuBars
1597
1598=item B<[swap]>
1599
1600swap the top two menuBars
1601
1602=item B<[prev]>
1603
1604access the previous menuBar
1605
1606=item B<[next]>
1607
1608access the next menuBar
1609
1610=item B<[show]>
1611
1612Enable display of the menuBar
1613
1614=item B<[hide]>
1615
1616Disable display of the menuBar
1617
1618=item B<< [pixmap:+I<name>] >>
1619
1620=item B<< [pixmap:+I<name>;I<scaling>] >>
1621
1622(set the background pixmap globally
1623
1624B<< A Future implementation I<may> make this local to the menubar >>)
1625
1626=item B<< [:+I<command>:] >>
1627
1628ignore the menu readonly status and issue a I<command> to or a menu or
1629menuitem or change the ; a useful shortcut for setting the quick arrows
1630from a menuBar.
1631
1632=back
1633
1634X<menuBarAdd>
1635
1636=head2 Adding and accessing menus
1637
1638The following commands may also be B<+> prefixed.
1639
1640=over 4
1641
1642=item B</+>
1643
1644access menuBar top level
1645
1646=item B<./+>
1647
1648access current menu level
1649
1650=item B<../+>
1651
1652access parent menu (1 level up)
1653
1654=item B<../../>
1655
1656access parent menu (multiple levels up)
1657
1658=item B<< I</path/>menu >>
1659
1660add/access menu
1661
1662=item B<< I</path/>menu/* >>
1663
1664add/access menu and clear it if it exists
1665
1666=item B<< I</path/>{-} >>
1667
1668add separator
1669
1670=item B<< I</path/>{item} >>
1671
1672add B<item> as a label
1673
1674=item B<< I</path/>{item} action >>
1675
1676add/alter I<menuitem> with an associated I<action>
1677
1678=item B<< I</path/>{item}{right-text} >>
1679
1680add/alter I<menuitem> with B<right-text> as the right-justified text
1681and as the associated I<action>
1682
1683=item B<< I</path/>{item}{rtext} action >>
1684
1685add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1686the right-justified text.
1687
1688=back
1689
1690=over 4
1691
1692=item Special characters in I<action> must be backslash-escaped:
1693
1694B<\a \b \E \e \n \r \t \octal>
1695
1696=item or in control-character notation:
1697
1698B<^@, ^A .. ^Z .. ^_, ^?>
1699
1700=back
1701
1702To send a string starting with a B<NUL> (B<^@>) character to the
1703program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1704the first of which will be stripped off and the balance directed to the
1705program. Otherwise if I<action> begins with B<NUL> followed by
1706non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1707balance is sent back to rxvt.
1708
1709As a convenience for the many Emacs-type editors, I<action> may start
1710with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1711appended if missed from B<M-x> commands.
1712
1713As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1714quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1715
1716=over 4
1717
1718=item For example,
1719
1720B<M-xapropos> is equivalent to B<\Exapropos\r>
1721
1722=item and
1723
1724B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1725
1726=back
1727
1728The option B<< {I<right-rtext>} >> will be right-justified. In the
1729absence of a specified action, this text will be used as the I<action>
1730as well.
1731
1732=over 4
1733
1734=item For example,
1735
1736B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1737
1738=back
1739
1740The left label I<is> necessary, since it's used for matching, but
1741implicitly hiding the left label (by using same name for both left and
1742right labels), or explicitly hiding the left label (by preceeding it
1743with a dot), makes it possible to have right-justified text only.
1744
1745=over 4
1746
1747=item For example,
1748
1749B</File/{Open}{Open} Open-File-Action>
1750
1751=item or hiding it
1752
1753B</File/{.anylabel}{Open} Open-File-Action>
1754
1755=back
1756
1757X<menuBarRemove>
1758
1759=head2 Removing menus
1760
1761=over 4
1762
1763=item B<< -/*+ >>
1764
1765remove all menus from the menuBar, the same as B<[clear]>
1766
1767=item B<< -+I</path>menu+ >>
1768
1769remove menu
1770
1771=item B<< -+I</path>{item}+ >>
1772
1773remove item
1774
1775=item B<< -+I</path>{-} >>
1776
1777remove separator)
1778
1779=item B<-/path/menu/*>
1780
1781remove all items, separators and submenus from menu
1782
1783=back
1784
1785X<menuBarArrows>
1786
1787=head2 Quick Arrows
1788
1789The menus also provide a hook for I<quick arrows> to provide easier
1790user access. If nothing has been explicitly set, the default is to
1791emulate the curror keys. The syntax permits each arrow to be altered
1792individually or all four at once without re-entering their common
1793beginning/end text. For example, to explicitly associate cursor actions
1794with the arrows, any of the following forms could be used:
1795
1796=over 4
1797
1798=item B<< <r>+I<Right> >>
1799
1800=item B<< <l>+I<Left> >>
1801
1802=item B<< <u>+I<Up> >>
1803
1804=item B<< <d>+I<Down> >>
1805
1806Define actions for the respective arrow buttons
1807
1808=item B<< <b>+I<Begin> >>
1809
1810=item B<< <e>+I<End> >>
1811
1812Define common beginning/end parts for I<quick arrows> which used in
1813conjunction with the above <r> <l> <u> <d> constructs
1814
1815=back
1816
1817=over 4
1818
1819=item For example, define arrows individually,
1820
1821 <u>\E[A
1822
1823 <d>\E[B
1824
1825 <r>\E[C
1826
1827 <l>\E[D
1828
1829=item or all at once
1830
1831 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1832
1833=item or more compactly (factoring out common parts)
1834
1835 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1836
1837=back
1838
1839X<menuBarSummary>
1840
1841=head2 Command Summary
1842
1843A short summary of the most I<common> commands:
1844
1845=over 4
1846
1847=item [menu:name]
1848
1849use an existing named menuBar or start a new one
1850
1851=item [menu]
1852
1853use the current menuBar
1854
1855=item [title:string]
1856
1857set menuBar title
1858
1859=item [done]
1860
1861set menu access to readonly and, if reading from a file, signal EOF
1862
1863=item [done:name]
1864
1865if reading from a file using [read:file;name] signal EOF
1866
1867=item [rm:name]
1868
1869remove named menuBar(s)
1870
1871=item [rm] [rm:]
1872
1873remove current menuBar
1874
1875=item [rm*] [rm:*]
1876
1877remove all menuBar(s)
1878
1879=item [swap]
1880
1881swap top two menuBars
1882
1883=item [prev]
1884
1885access the previous menuBar
1886
1887=item [next]
1888
1889access the next menuBar
1890
1891=item [show]
1892
1893map menuBar
1894
1895=item [hide]
1896
1897unmap menuBar
1898
1899=item [pixmap;file]
1900
1901=item [pixmap;file;scaling]
1902
1903set a background pixmap
1904
1905=item [read:file]
1906
1907=item [read:file;name]
1908
1909read in a menu from a file
1910
1911=item [dump]
1912
1913dump out all menuBars to /tmp/rxvt-PID
1914
1915=item /
1916
1917access menuBar top level
1918
1919=item ./
1920
1921=item ../
1922
1923=item ../../
1924
1925access current or parent menu level
1926
1927=item /path/menu
1928
1929add/access menu
1930
1931=item /path/{-}
1932
1933add separator
1934
1935=item /path/{item}{rtext} action
1936
1937add/alter menu item
1938
1939=item -/*
1940
1941remove all menus from the menuBar
1942
1943=item -/path/menu
1944
1945remove menu items, separators and submenus from menu
1946
1947=item -/path/menu
1948
1949remove menu
1950
1951=item -/path/{item}
1952
1953remove item
1954
1955=item -/path/{-}
1956
1957remove separator
1958
1959=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1960
1961menu quick arrows
1962
1963=back
1964X<XPM> 1770X<XPM>
1965 1771
1966=head1 XPM 1772=head1 XPM
1967 1773
1968For 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
… …
2154=end table 1960=end table
2155 1961
2156=head1 CONFIGURE OPTIONS 1962=head1 CONFIGURE OPTIONS
2157 1963
2158General hint: if you get compile errors, then likely your configuration 1964General hint: if you get compile errors, then likely your configuration
2159hasn'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
2160./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
2161so 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
2162report 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
2163<rxvt@schmorp.de>. 1969Lehmann <rxvt@schmorp.de>.
1970
1971All
2164 1972
2165=over 4 1973=over 4
2166 1974
2167=item --enable-everything 1975=item --enable-everything
2168 1976
2169Add support for all non-multichoice options listed in "./configure 1977Add (or remove) support for all non-multichoice options listed in "./configure
2170--help". Note that unlike other enable options this is order dependant. 1978--help".
1979
2171You can specify this and then disable options which this enables by 1980You can specify this and then disable options you do not like by
2172I<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.
2173 1985
2174=item --enable-xft 1986=item --enable-xft (default: enabled)
2175 1987
2176Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1988Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2177slower 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
2178don't pay for them. 1990don't pay for them.
2179 1991
2180=item --enable-font-styles 1992=item --enable-font-styles (default: on)
2181 1993
2182Add 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
2183styles. The fonts can be set manually or automatically. 1995styles. The fonts can be set manually or automatically.
2184 1996
2185=item --with-codesets=NAME,... 1997=item --with-codesets=NAME,... (default: all)
2186 1998
2187Compile in support for additional codeset (encoding) groups (eu, vn are 1999Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2188always compiled in, which includes most 8-bit character sets). These 2000are always compiled in, which includes most 8-bit character sets). These
2189codeset tables are currently only used for driving X11 core fonts, they 2001codeset tables are used for driving X11 core fonts, they are not required
2190are not required for Xft fonts. Compiling them in will make your binary 2002for Xft fonts, although having them compiled in lets rxvt-unicode choose
2191bigger (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
2192you use an X11 font requiring one of these encodings. 2005memory usage unless you use a font requiring one of these encodings.
2193 2006
2194=begin table 2007=begin table
2195 2008
2196 all all available codeset groups 2009 all all available codeset groups
2197 zh common chinese encodings 2010 zh common chinese encodings
… …
2200 jp_ext rarely used but big japanese encodings 2013 jp_ext rarely used but big japanese encodings
2201 kr korean encodings 2014 kr korean encodings
2202 2015
2203=end table 2016=end table
2204 2017
2205=item --enable-xim 2018=item --enable-xim (default: on)
2206 2019
2207Add support for XIM (X Input Method) protocol. This allows using 2020Add support for XIM (X Input Method) protocol. This allows using
2208alternative input methods (e.g. kinput2) and will also correctly 2021alternative input methods (e.g. kinput2) and will also correctly
2209set up the input for people using dead keys or compose keys. 2022set up the input for people using dead keys or compose keys.
2210 2023
2211=item --enable-unicode3 2024=item --enable-unicode3 (default: off)
2025
2026Recommended to stay off unless you really need non-BMP characters.
2212 2027
2213Enable direct support for displaying unicode codepoints above 2028Enable direct support for displaying unicode codepoints above
221465535 (the basic multilingual page). This increases storage 202965535 (the basic multilingual page). This increases storage
2215requirements 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
2216support these extra characters, but Xft does. 2031support these extra characters, but Xft does.
… …
2219even without this flag, but the number of such characters is 2034even without this flag, but the number of such characters is
2220limited to a view thousand (shared with combining characters, 2035limited to a view thousand (shared with combining characters,
2221see next switch), and right now rxvt-unicode cannot display them 2036see next switch), and right now rxvt-unicode cannot display them
2222(input/output and cut&paste still work, though). 2037(input/output and cut&paste still work, though).
2223 2038
2224=item --enable-combining 2039=item --enable-combining (default: on)
2225 2040
2226Enable automatic composition of combining characters into 2041Enable automatic composition of combining characters into
2227composite characters. This is required for proper viewing of text 2042composite characters. This is required for proper viewing of text
2228where accents are encoded as seperate unicode characters. This is 2043where accents are encoded as seperate unicode characters. This is
2229done by using precomposited characters when available or creating 2044done by using precomposited characters when available or creating
2230new pseudo-characters when no precomposed form exists. 2045new pseudo-characters when no precomposed form exists.
2231 2046
2232Without --enable-unicode3, the number of additional precomposed characters 2047Without --enable-unicode3, the number of additional precomposed
2233is rather limited (2048, if this is full, rxvt-unicode will use the 2048characters is somewhat limited (the 6400 private use characters will be
2234private use area, extending the number of combinations to 8448). With
2235--enable-unicode3, no practical limit exists. 2049(ab-)used). With --enable-unicode3, no practical limit exists.
2236 2050
2237This option will also enable storage (but not display) of characters 2051This option will also enable storage (but not display) of characters
2238beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2052beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2239 2053
2240The combining table also contains entries for arabic presentation forms, 2054The combining table also contains entries for arabic presentation forms,
2241but 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
2242tell me how these are to be used...). 2056tell me how these are to be used...).
2243 2057
2244=item --enable-fallback(=CLASS) 2058=item --enable-fallback(=CLASS) (default: Rxvt)
2245 2059
2246When reading resource settings, also read settings for class CLASS 2060When reading resource settings, also read settings for class CLASS. To
2247(default: Rxvt). To disable resource fallback use --disable-fallback. 2061disable resource fallback use --disable-fallback.
2248 2062
2249=item --with-res-name=NAME 2063=item --with-res-name=NAME (default: urxvt)
2250 2064
2251Use the given name (default: urxvt) as default application name when 2065Use the given name as default application name when
2252reading resources. Specify --with-res-name=rxvt to replace rxvt. 2066reading resources. Specify --with-res-name=rxvt to replace rxvt.
2253 2067
2254=item --with-res-class=CLASS 2068=item --with-res-class=CLASS /default: URxvt)
2255 2069
2256Use the given class (default: URxvt) as default application class 2070Use the given class as default application class
2257when reading resources. Specify --with-res-class=Rxvt to replace 2071when reading resources. Specify --with-res-class=Rxvt to replace
2258rxvt. 2072rxvt.
2259 2073
2260=item --enable-utmp 2074=item --enable-utmp (default: on)
2261 2075
2262Write 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
2263start of rxvt execution and delete information when rxvt exits. 2077start of rxvt execution and delete information when rxvt exits.
2264 2078
2265=item --enable-wtmp 2079=item --enable-wtmp (default: on)
2266 2080
2267Write 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
2268start of rxvt execution and write logout when rxvt exits. This 2082start of rxvt execution and write logout when rxvt exits. This
2269option requires --enable-utmp to also be specified. 2083option requires --enable-utmp to also be specified.
2270 2084
2271=item --enable-lastlog 2085=item --enable-lastlog (default: on)
2272 2086
2273Write user and tty to lastlog file (used by programs like 2087Write user and tty to lastlog file (used by programs like
2274F<lastlogin>) at start of rxvt execution. This option requires 2088F<lastlogin>) at start of rxvt execution. This option requires
2275--enable-utmp to also be specified. 2089--enable-utmp to also be specified.
2276 2090
2277=item --enable-xpm-background 2091=item --enable-xpm-background (default: on)
2278 2092
2279Add support for XPM background pixmaps. 2093Add support for XPM background pixmaps.
2280 2094
2281=item --enable-transparency 2095=item --enable-transparency (default: on)
2282 2096
2283Add support for inheriting parent backgrounds thus giving a fake 2097Add support for inheriting parent backgrounds thus giving a fake
2284transparency to the term. 2098transparency to the term.
2285 2099
2286=item --enable-fading 2100=item --enable-fading (default: on)
2287 2101
2288Add support for fading the text when focus is lost. 2102Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2289 2103
2290=item --enable-tinting 2104=item --enable-tinting (default: on)
2291 2105
2292Add support for tinting of transparent backgrounds. 2106Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2293 2107
2294=item --enable-menubar
2295
2296Add support for our menu bar system (this interacts badly with
2297dynamic locale switching currently).
2298
2299=item --enable-rxvt-scroll 2108=item --enable-rxvt-scroll (default: on)
2300 2109
2301Add support for the original rxvt scrollbar. 2110Add support for the original rxvt scrollbar.
2302 2111
2303=item --enable-next-scroll 2112=item --enable-next-scroll (default: on)
2304 2113
2305Add support for a NeXT-like scrollbar. 2114Add support for a NeXT-like scrollbar.
2306 2115
2307=item --enable-xterm-scroll 2116=item --enable-xterm-scroll (default: on)
2308 2117
2309Add support for an Xterm-like scrollbar. 2118Add support for an Xterm-like scrollbar.
2310 2119
2311=item --enable-plain-scroll 2120=item --enable-plain-scroll (default: on)
2312 2121
2313Add support for a very unobtrusive, plain-looking scrollbar that 2122Add support for a very unobtrusive, plain-looking scrollbar that
2314is the favourite of the rxvt-unicode author, having used it for 2123is the favourite of the rxvt-unicode author, having used it for
2315many years. 2124many years.
2316 2125
2317=item --enable-half-shadow 2126=item --enable-ttygid (default: off)
2318
2319Make shadows on the scrollbar only half the normal width & height.
2320only applicable to rxvt scrollbars.
2321
2322=item --enable-ttygid
2323 2127
2324Change tty device setting to group "tty" - only use this if 2128Change tty device setting to group "tty" - only use this if
2325your system uses this type of security. 2129your system uses this type of security.
2326 2130
2327=item --disable-backspace-key 2131=item --disable-backspace-key
2328 2132
2329Disable 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
2330do it. 2138do it.
2331 2139
2332=item --disable-delete-key
2333
2334Disable any handling of the delete key by us - let the X server
2335do it.
2336
2337=item --disable-resources 2140=item --disable-resources
2338 2141
2339Remove all resources checking. 2142Removes any support for resource checking.
2340
2341=item --enable-xgetdefault
2342
2343Make resources checking via XGetDefault() instead of our small
2344version which only checks ~/.Xdefaults, or if that doesn't exist then
2345~/.Xresources.
2346
2347Please note that nowadays, things like XIM will automatically pull in and
2348use the full X resource manager, so the overhead of using it might be very
2349small, if nonexistant.
2350
2351=item --enable-strings
2352
2353Add support for our possibly faster memset() function and other
2354various routines, overriding your system's versions which may
2355have been hand-crafted in assembly or may require extra libraries
2356to link in. (this breaks ANSI-C rules and has problems on many
2357GNU/Linux systems).
2358 2143
2359=item --disable-swapscreen 2144=item --disable-swapscreen
2360 2145
2361Remove support for swap screen. 2146Remove support for secondary/swap screen.
2362 2147
2363=item --enable-frills 2148=item --enable-frills (default: on)
2364 2149
2365Add 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
2366have. 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
2367disable this. 2152disable this.
2368 2153
2369A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2154A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2370in combination with other switches) is: 2155in combination with other switches) is:
2371 2156
2372 MWM-hints 2157 MWM-hints
2373 EWMH-hints (pid, utf8 names) and protocols (ping) 2158 EWMH-hints (pid, utf8 names) and protocols (ping)
2374 seperate underline colour 2159 seperate underline colour (-underlineColor)
2375 settable border widths and borderless switch 2160 settable border widths and borderless switch (-w, -b, -bl)
2161 visual depth selection (-depth)
2376 settable extra linespacing 2162 settable extra linespacing /-lsp)
2377 iso-14755-2 and -3, and visual feedback 2163 iso-14755-2 and -3, and visual feedback
2378 backindex and forwardindex escape sequence
2379 window op and locale change escape sequences
2380 tripleclickwords 2164 tripleclickwords (-tcw)
2381 settable insecure mode 2165 settable insecure mode (-insecure)
2382 keysym remapping support 2166 keysym remapping support
2383 -embed and -pty-fd options 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)
2384 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
2385=item --enable-iso14755 2187=item --enable-iso14755 (default: on)
2386 2188
2387Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2189Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2388F<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
2389C<--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
2390this switch. 2192this switch.
2391 2193
2392=item --enable-keepscrolling 2194=item --enable-keepscrolling (default: on)
2393 2195
2394Add support for continual scrolling of the display when you hold 2196Add support for continual scrolling of the display when you hold
2395the mouse button down on a scrollbar arrow. 2197the mouse button down on a scrollbar arrow.
2396 2198
2397=item --enable-mousewheel 2199=item --enable-mousewheel (default: on)
2398 2200
2399Add support for scrolling via mouse wheel or buttons 4 & 5. 2201Add support for scrolling via mouse wheel or buttons 4 & 5.
2400 2202
2401=item --enable-slipwheeling 2203=item --enable-slipwheeling (default: on)
2402 2204
2403Add support for continual scrolling (using the mouse wheel as an 2205Add support for continual scrolling (using the mouse wheel as an
2404accelerator) while the control key is held down. This option 2206accelerator) while the control key is held down. This option
2405requires --enable-mousewheel to also be specified. 2207requires --enable-mousewheel to also be specified.
2406 2208
2407=item --disable-new-selection 2209=item --disable-new-selection
2408 2210
2409Remove support for mouse selection style like that of xterm. 2211Remove support for mouse selection style like that of xterm.
2410 2212
2411=item --enable-dmalloc 2213=item --enable-dmalloc (default: off)
2412 2214
2413Use Gray Watson's malloc - which is good for debugging See 2215Use Gray Watson's malloc - which is good for debugging See
2414http://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
2415next 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
2416DINCLUDE and DLIB to the right places. 2218DINCLUDE and DLIB to the right places.
2417 2219
2418You can only use either this option and the following (should 2220You can only use either this option and the following (should
2419you use either) . 2221you use either) .
2420 2222
2421=item --enable-dlmalloc 2223=item --enable-dlmalloc (default: off)
2422 2224
2423Use Doug Lea's malloc - which is good for a production version 2225Use Doug Lea's malloc - which is good for a production version
2424See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2226See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2425 2227
2426=item --enable-smart-resize 2228=item --enable-smart-resize (default: on)
2427 2229
2428Add smart growth/shrink behaviour when changing font size via from hot 2230Add smart growth/shrink behaviour when changing font size via hot
2429keys. 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
2430closest to a corner of the screen. 2232the screen in a fixed position.
2431 2233
2432=item --enable-cursor-blink
2433
2434Add support for a blinking cursor.
2435
2436=item --enable-pointer-blank 2234=item --enable-pointer-blank (default: on)
2437 2235
2438Add support to have the pointer disappear when typing or inactive. 2236Add support to have the pointer disappear when typing or inactive.
2439 2237
2440=item --with-name=NAME 2238=item --enable-perl (default: on)
2441 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
2442Set the basename for the installed binaries (default: C<urxvt>, resulting 2248Set the basename for the installed binaries, resulting
2443in 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
2444C<rxvt>. 2250C<rxvt>.
2445 2251
2446=item --with-term=NAME 2252=item --with-term=NAME (default: rxvt-unicode)
2447 2253
2448Change the environmental variable for the terminal to NAME (default 2254Change the environmental variable for the terminal to NAME.
2449C<rxvt-unicode>)
2450 2255
2451=item --with-terminfo=PATH 2256=item --with-terminfo=PATH
2452 2257
2453Change the environmental variable for the path to the terminfo tree to 2258Change the environmental variable for the path to the terminfo tree to
2454PATH. 2259PATH.

Diff Legend

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