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

Diff Legend

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