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.58 by root, Wed Jul 13 02:24:02 2005 UTC vs.
Revision 1.97 by root, Tue Jan 31 00:53:49 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 The cursor moves when selecting text in the current input line, how
69do I switch this off?
70
71=item During rlogin/ssh/telnet/etc. sessions, clicking near the cursor
72outputs strange escape sequences, how do I fix this?
73
74These are caused by the C<readline> perl extension. Under normal
75circumstances, it will move your cursor around when you click into the
76line that contains it. It tries hard not to do this at the wrong moment,
77but when running a program that doesn't parse cursor movements or in some
78cases during rlogin sessions, it fails to detect this properly.
79
80You can permamently switch this feature off by disabling the C<readline>
81extension:
82
83 URxvt.perl-ext-common: default,-readline
84
85=item Why doesn't rxvt-unicode read my resources?
86
87Well, why, indeed? It does, in a way very similar to other X
88applications. Most importantly, this means that if you or your OS loads
89resources into the X display (the right way to do it), rxvt-unicode will
90ignore any resource files in your home directory. It will only read
91F<$HOME/.Xdefaults> when no resources are attached to the display.
92
93If you have or use an F<$HOME/.Xresources> file, chances are that
94resources are loaded into your X-server. In this case, you have to
95re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
96
97Also consider the form resources have to use:
98
99 URxvt.resource: value
100
101If you want to use another form (there are lots of different ways of
102specifying resources), make sure you understand wether and why it
103works. If unsure, use the form above.
104
105=item I can't get transparency working, what am I doing wrong?
106
107First of all, transparency isn't officially supported in rxvt-unicode, so
108you are mostly on your own. Do not bug the author about it (but you may
109bug everybody else). Also, if you can't get it working consider it a rite
110of passage: ... and you failed.
111
112Here are four ways to get transparency. B<Do> read the manpage and option
113descriptions for the programs mentioned and rxvt-unicode. Really, do it!
114
1151. Use inheritPixmap:
116
117 Esetroot wallpaper.jpg
118 @@RXVT_NAME@@ -ip -tint red -sh 40
119
120That works. If you think it doesn't, you lack transparency and tinting
121support, or you are unable to read.
122
1232. Use a simple pixmap and emulate pseudo-transparency. This enables you
124to use effects other than tinting and shading: Just shade/tint/whatever
125your picture with gimp:
126
127 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
128 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
129
130That works. If you think it doesn't, you lack XPM and Perl support, or you
131are unable to read.
132
1333. Use an ARGB visual:
134
135 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
136
137This requires XFT support, and the support of your X-server. If that
138doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
139there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
140bugfixes and workarounds for Xft and Xlib to make it work, but that
141doesn't mean that your WM has the required kludges in place.
142
1434. Use xcompmgr and let it do the job:
144
145 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
146 -set _NET_WM_WINDOW_OPACITY 0xc0000000
147
148Then click on a window you want to make transparent. Replace C<0xc0000000>
149by other values to change the degree of opacity. If it doesn't work and
150your server crashes, you got to keep the pieces.
151
152=item Isn't rxvt supposed to be small? Don't all those features bloat?
153
154I often get asked about this, and I think, no, they didn't cause extra
155bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
156that the urxvt binary is larger (due to some encoding tables always being
157compiled in), but it actually uses less memory (RSS) after startup. Even
158with C<--disable-everything>, this comparison is a bit unfair, as many
159features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
160already in use in this mode.
161
162 text data bss drs rss filename
163 98398 1664 24 15695 1824 rxvt --disable-everything
164 188985 9048 66616 18222 1788 urxvt --disable-everything
165
166When you C<--enable-everything> (which _is_ unfair, as this involves xft
167and full locale/XIM support which are quite bloaty inside libX11 and my
168libc), the two diverge, but not unreasnobaly so.
169
170 text data bss drs rss filename
171 163431 2152 24 20123 2060 rxvt --enable-everything
172 1035683 49680 66648 29096 3680 urxvt --enable-everything
173
174The very large size of the text section is explained by the east-asian
175encoding tables, which, if unused, take up disk space but nothing else
176and can be compiled out unless you rely on X11 core fonts that use those
177encodings. The BSS size comes from the 64k emergency buffer that my c++
178compiler allocates (but of course doesn't use unless you are out of
179memory). Also, using an xft font instead of a core font immediately adds a
180few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
181not used.
182
183Of course, due to every character using two or four bytes instead of one,
184a large scrollback buffer will ultimately make rxvt-unicode use more
185memory.
186
187Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
188still fares rather well. And compared to some monsters like gnome-terminal
189(21152k + extra 4204k in separate processes) or konsole (22200k + extra
19043180k in daemons that stay around after exit, plus half a minute of
191startup time, including the hundreds of warnings it spits out), it fares
192extremely well *g*.
193
194=item Why C++, isn't that unportable/bloated/uncool?
195
196Is this a question? :) It comes up very often. The simple answer is: I had
197to write it, and C++ allowed me to write and maintain it in a fraction
198of the time and effort (which is a scarce resource for me). Put even
199shorter: It simply wouldn't exist without C++.
200
201My personal stance on this is that C++ is less portable than C, but in
202the case of rxvt-unicode this hardly matters, as its portability limits
203are defined by things like X11, pseudo terminals, locale support and unix
204domain sockets, which are all less portable than C++ itself.
205
206Regarding the bloat, see the above question: It's easy to write programs
207in C that use gobs of memory, an certainly possible to write programs in
208C++ that don't. C++ also often comes with large libraries, but this is
209not necessarily the case with GCC. Here is what rxvt links against on my
210system with a minimal config:
211
212 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
213 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
214 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
215 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
216
217And here is rxvt-unicode:
218
219 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
220 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
221 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
222 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
223 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
224
225No large bloated libraries (of course, none were linked in statically),
226except maybe libX11 :)
227
228=item Does it support tabs, can I have a tabbed rxvt-unicode?
229
230Beginning with version 7.3, there is a perl extension that implements a
231simple tabbed terminal. It is installed by default, so any of these should
232give you tabs:
233
234 @@RXVT_NAME@@ -pe tabbed
235
236 URxvt.perl-ext-common: default,tabbed
237
238It will also work fine with tabbing functionality of many window managers
239or similar tabbing programs, and its embedding-features allow it to be
240embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
241the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
242(murxvt) terminal as an example embedding application.
243
29=item How do I know which rxvt-unicode version I'm using? 244=item How do I know which rxvt-unicode version I'm using?
30 245
31The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 247sequence C<ESC [ 8 n> sets the window title to the version number. When
248using the @@RXVT_NAME@@c client, the version displayed is that of the
249daemon.
33 250
34=item I am using Debian GNU/Linux and have a problem... 251=item I am using Debian GNU/Linux and have a problem...
35 252
36The Debian GNU/Linux package of rxvt-unicode in sarge contains large 253The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37patches that considerably change the behaviour of rxvt-unicode. Before 254patches that considerably change the behaviour of rxvt-unicode (but
38reporting a bug to the original rxvt-unicode author please download and 255unfortunately this notice has been removed). Before reporting a bug to
39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 256the original rxvt-unicode author please download and install the genuine
40and try to reproduce the problem. If you cannot, chances are that the 257version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
41problems are specific to Debian GNU/Linux, in which case it should be 258the problem. If you cannot, chances are that the problems are specific to
42reported via the Debian Bug Tracking System (use C<reportbug> to report 259Debian GNU/Linux, in which case it should be reported via the Debian Bug
43the bug). 260Tracking System (use C<reportbug> to report the bug).
44 261
45For other problems that also affect the Debian package, you can and 262For other problems that also affect the Debian package, you can and
46probably should use the Debian BTS, too, because, after all, it's also a 263probably should use the Debian BTS, too, because, after all, it's also a
47bug in the Debian version and it serves as a reminder for other users that 264bug in the Debian version and it serves as a reminder for other users that
48might encounter the same issue. 265might encounter the same issue.
266
267=item I am maintaining rxvt-unicode for distribution/OS XXX, any
268recommendation?
269
270You should build one binary with the default options. F<configure>
271now enables most useful options, and the trend goes to making them
272runtime-switchable, too, so there is usually no drawback to enbaling them,
273except higher disk and possibly memory usage. The perl interpreter should
274be enabled, as important functionality (menus, selection, likely more in
275the future) depends on it.
276
277You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
278system-wide (except maybe with C<defaults>). This will result in useful
279behaviour. If your distribution aims at low memory, add an empty
280C<perl-ext-common> resource to the app-defaults file. This will keep the
281perl interpreter disabled until the user enables it.
282
283If you can/want build more binaries, I recommend building a minimal
284one with C<--disable-everything> (very useful) and a maximal one with
285C<--enable-everything> (less useful, it will be very big due to a lot of
286encodings built-in that increase download times and are rarely used).
287
288=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
289
290It should be, starting with release 7.1. You are encouraged to properly
291install urxvt with privileges necessary for your OS now.
292
293When rxvt-unicode detects that it runs setuid or setgid, it will fork
294into a helper process for privileged operations (pty handling on some
295systems, utmp/wtmp/lastlog handling on others) and drop privileges
296immediately. This is much safer than most other terminals that keep
297privileges while running (but is more relevant to urxvt, as it contains
298things as perl interpreters, which might be "helpful" to attackers).
299
300This forking is done as the very first within main(), which is very early
301and reduces possible bugs to initialisation code run before main(), or
302things like the dynamic loader of your system, which should result in very
303little risk.
49 304
50=item When I log-in to another system it tells me about missing terminfo data? 305=item When I log-in to another system it tells me about missing terminfo data?
51 306
52The terminal description used by rxvt-unicode is not as widely available 307The terminal description used by rxvt-unicode is not as widely available
53as that for xterm, or even rxvt (for which the same problem often arises). 308as that for xterm, or even rxvt (for which the same problem often arises).
… …
450=item My input method wants <some encoding> but I want UTF-8, what can I do? 705=item My input method wants <some encoding> but I want UTF-8, what can I do?
451 706
452You can specify separate locales for the input method and the rest of the 707You can specify separate locales for the input method and the rest of the
453terminal, using the resource C<imlocale>: 708terminal, using the resource C<imlocale>:
454 709
455 URxvt*imlocale: ja_JP.EUC-JP 710 URxvt.imlocale: ja_JP.EUC-JP
456 711
457Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 712Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
458use your input method. Please note, however, that you will not be able to 713use your input method. Please note, however, that you will not be able to
459input characters outside C<EUC-JP> in a normal way then, as your input 714input characters outside C<EUC-JP> in a normal way then, as your input
460method limits you. 715method limits you.
… …
487 742
488=item Can I speed up Xft rendering somehow? 743=item Can I speed up Xft rendering somehow?
489 744
490Yes, the most obvious way to speed it up is to avoid Xft entirely, as 745Yes, the most obvious way to speed it up is to avoid Xft entirely, as
491it is simply slow. If you still want Xft fonts you might try to disable 746it is simply slow. If you still want Xft fonts you might try to disable
492antialiasing (by appending C<:antialiasing=false>), which saves lots of 747antialiasing (by appending C<:antialias=false>), which saves lots of
493memory and also speeds up rendering considerably. 748memory and also speeds up rendering considerably.
494 749
495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 750=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
496 751
497Rxvt-unicode will use whatever you specify as a font. If it needs to 752Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
506 761
507Make sure that mouse reporting is actually turned off since killing 762Make sure that mouse reporting is actually turned off since killing
508some editors prematurely may leave the mouse in mouse report mode. I've 763some editors prematurely may leave the mouse in mouse report mode. I've
509heard that tcsh may use mouse reporting unless it otherwise specified. A 764heard that tcsh may use mouse reporting unless it otherwise specified. A
510quick check is to see if cut/paste works when the Alt or Shift keys are 765quick check is to see if cut/paste works when the Alt or Shift keys are
511depressed. See @@RXVT_NAME@@(7) 766depressed.
512 767
513=item What's with this bold/blink stuff? 768=item What's with this bold/blink stuff?
514 769
515If no bold colour is set via C<colorBD:>, bold will invert text using the 770If no bold colour is set via C<colorBD:>, bold will invert text using the
516standard foreground colour. 771standard foreground colour.
… …
575 URxvt.color7: #e1dddd 830 URxvt.color7: #e1dddd
576 URxvt.color15: #e1dddd 831 URxvt.color15: #e1dddd
577 832
578=item How can I start @@RXVT_NAME@@d in a race-free way? 833=item How can I start @@RXVT_NAME@@d in a race-free way?
579 834
580Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 835Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
581server that answers @@RXVT_NAME@@c's requests, so it doesn't background 836display, create the listening socket and then fork.
582itself.
583
584To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
585following method to wait for the startup message before continuing:
586
587 { @@RXVT_NAME@@d & } | read
588 837
589=item What's with the strange Backspace/Delete key behaviour? 838=item What's with the strange Backspace/Delete key behaviour?
590 839
591Assuming that the physical Backspace key corresponds to the 840Assuming that the physical Backspace key corresponds to the
592BackSpace keysym (not likely for Linux ... see the following 841BackSpace keysym (not likely for Linux ... see the following
… …
611 860
612 # use Backspace = ^? 861 # use Backspace = ^?
613 $ stty erase ^? 862 $ stty erase ^?
614 $ @@RXVT_NAME@@ 863 $ @@RXVT_NAME@@
615 864
616Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 865Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
617 866
618For an existing rxvt-unicode: 867For an existing rxvt-unicode:
619 868
620 # use Backspace = ^H 869 # use Backspace = ^H
621 $ stty erase ^H 870 $ stty erase ^H
… …
739 988
740=head1 DESCRIPTION 989=head1 DESCRIPTION
741 990
742The rest of this document describes various technical aspects of 991The rest of this document describes various technical aspects of
743B<rxvt-unicode>. First the description of supported command sequences, 992B<rxvt-unicode>. First the description of supported command sequences,
744followed by menu and pixmap support and last by a description of all 993followed by pixmap support and last by a description of all features
745features selectable at C<configure> time. 994selectable at C<configure> time.
746 995
747=head1 Definitions 996=head1 Definitions
748 997
749=over 4 998=over 4
750 999
… …
1318 B<< C<h> >> Send Mouse X & Y on button press. 1567 B<< C<h> >> Send Mouse X & Y on button press.
1319 B<< C<l> >> No mouse reporting. 1568 B<< C<l> >> No mouse reporting.
1320 1569
1321=end table 1570=end table
1322 1571
1323=item B<< C<Ps = 10> >> (B<rxvt>)
1324
1325=begin table
1326
1327 B<< C<h> >> menuBar visible
1328 B<< C<l> >> menuBar invisible
1329
1330=end table
1331
1332=item B<< C<Ps = 25> >> 1572=item B<< C<Ps = 25> >>
1333 1573
1334=begin table 1574=begin table
1335 1575
1336 B<< C<h> >> Visible cursor {cnorm/cvvis} 1576 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1449 1689
1450=begin table 1690=begin table
1451 1691
1452 B<< C<h> >> Scroll to bottom when a key is pressed 1692 B<< C<h> >> Scroll to bottom when a key is pressed
1453 B<< C<l> >> Don't scroll to bottom when a key is pressed 1693 B<< C<l> >> Don't scroll to bottom when a key is pressed
1694
1695=end table
1696
1697=item B<< C<Ps = 1021> >> (B<rxvt>)
1698
1699=begin table
1700
1701 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1702 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1454 1703
1455=end table 1704=end table
1456 1705
1457=item B<< C<Ps = 1047> >> 1706=item B<< C<Ps = 1047> >>
1458 1707
… …
1507 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1756 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1508 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1757 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1509 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1758 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1510 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1759 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1511 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1760 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1512 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1761 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1513 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1762 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1514 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1763 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1515 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1764 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1516 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1765 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1517 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1766 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1518 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> >> 1767 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> >>
1519 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1768 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1520 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). 1769 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).
1521 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1770 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>.
1522 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1771 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1523 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1772 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1773 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1774 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1524 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1775 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1525 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1776 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1526 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1777 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1527 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1778 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1528 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1779 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1529 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1780 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1781 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1530 1782
1531=end table 1783=end table
1532 1784
1533=back 1785=back
1534 1786
1535X<menuBar>
1536
1537=head1 menuBar
1538
1539B<< The exact syntax used is I<almost> solidified. >>
1540In the menus, B<DON'T> try to use menuBar commands that add or remove a
1541menuBar.
1542
1543Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1544omitted: use B<./> to specify a menu relative to the current menu.
1545
1546=head2 Overview of menuBar operation
1547
1548For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1549of C<Pt> can be used for a variety of tasks:
1550
1551At the top level is the current menuBar which is a member of a circular
1552linked-list of other such menuBars.
1553
1554The menuBar acts as a parent for the various drop-down menus, which in
1555turn, may have labels, separator lines, menuItems and subMenus.
1556
1557The menuItems are the useful bits: you can use them to mimic keyboard
1558input or even to send text or escape sequences back to rxvt.
1559
1560The menuBar syntax is intended to provide a simple yet robust method of
1561constructing and manipulating menus and navigating through the
1562menuBars.
1563
1564The first step is to use the tag B<< [menu:I<name>] >> which creates
1565the menuBar called I<name> and allows access. You may now or menus,
1566subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1567menuBar access as B<readonly> to prevent accidental corruption of the
1568menus. To re-access the current menuBar for alterations, use the tag
1569B<[menu]>, make the alterations and then use B<[done]>
1570
1571X<menuBarCommands>
1572
1573=head2 Commands
1574
1575=over 4
1576
1577=item B<< [menu:+I<name>] >>
1578
1579access the named menuBar for creation or alteration. If a new menuBar
1580is created, it is called I<name> (max of 15 chars) and the current
1581menuBar is pushed onto the stack
1582
1583=item B<[menu]>
1584
1585access the current menuBar for alteration
1586
1587=item B<< [title:+I<string>] >>
1588
1589set the current menuBar's title to I<string>, which may contain the
1590following format specifiers:
1591
1592 B<%n> rxvt name (as per the B<-name> command-line option)
1593 B<%v> rxvt version
1594 B<%%> literal B<%> character
1595
1596=item B<[done]>
1597
1598set menuBar access as B<readonly>.
1599End-of-file tag for B<< [read:+I<file>] >> operations.
1600
1601=item B<< [read:+I<file>] >>
1602
1603read menu commands directly from I<file> (extension ".menu" will be
1604appended if required.) Start reading at a line with B<[menu]> or B<<
1605[menu:+I<name> >> and continuing until B<[done]> is encountered.
1606
1607Blank and comment lines (starting with B<#>) are ignored. Actually,
1608since any invalid menu commands are also ignored, almost anything could
1609be construed as a comment line, but this may be tightened up in the
1610future ... so don't count on it!.
1611
1612=item B<< [read:+I<file>;+I<name>] >>
1613
1614The same as B<< [read:+I<file>] >>, but start reading at a line with
1615B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1616B<[done]> is encountered.
1617
1618=item B<[dump]>
1619
1620dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1621later rereading.
1622
1623=item B<[rm:name]>
1624
1625remove the named menuBar
1626
1627=item B<[rm] [rm:]>
1628
1629remove the current menuBar
1630
1631=item B<[rm*] [rm:*]>
1632
1633remove all menuBars
1634
1635=item B<[swap]>
1636
1637swap the top two menuBars
1638
1639=item B<[prev]>
1640
1641access the previous menuBar
1642
1643=item B<[next]>
1644
1645access the next menuBar
1646
1647=item B<[show]>
1648
1649Enable display of the menuBar
1650
1651=item B<[hide]>
1652
1653Disable display of the menuBar
1654
1655=item B<< [pixmap:+I<name>] >>
1656
1657=item B<< [pixmap:+I<name>;I<scaling>] >>
1658
1659(set the background pixmap globally
1660
1661B<< A Future implementation I<may> make this local to the menubar >>)
1662
1663=item B<< [:+I<command>:] >>
1664
1665ignore the menu readonly status and issue a I<command> to or a menu or
1666menuitem or change the ; a useful shortcut for setting the quick arrows
1667from a menuBar.
1668
1669=back
1670
1671X<menuBarAdd>
1672
1673=head2 Adding and accessing menus
1674
1675The following commands may also be B<+> prefixed.
1676
1677=over 4
1678
1679=item B</+>
1680
1681access menuBar top level
1682
1683=item B<./+>
1684
1685access current menu level
1686
1687=item B<../+>
1688
1689access parent menu (1 level up)
1690
1691=item B<../../>
1692
1693access parent menu (multiple levels up)
1694
1695=item B<< I</path/>menu >>
1696
1697add/access menu
1698
1699=item B<< I</path/>menu/* >>
1700
1701add/access menu and clear it if it exists
1702
1703=item B<< I</path/>{-} >>
1704
1705add separator
1706
1707=item B<< I</path/>{item} >>
1708
1709add B<item> as a label
1710
1711=item B<< I</path/>{item} action >>
1712
1713add/alter I<menuitem> with an associated I<action>
1714
1715=item B<< I</path/>{item}{right-text} >>
1716
1717add/alter I<menuitem> with B<right-text> as the right-justified text
1718and as the associated I<action>
1719
1720=item B<< I</path/>{item}{rtext} action >>
1721
1722add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1723the right-justified text.
1724
1725=back
1726
1727=over 4
1728
1729=item Special characters in I<action> must be backslash-escaped:
1730
1731B<\a \b \E \e \n \r \t \octal>
1732
1733=item or in control-character notation:
1734
1735B<^@, ^A .. ^Z .. ^_, ^?>
1736
1737=back
1738
1739To send a string starting with a B<NUL> (B<^@>) character to the
1740program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1741the first of which will be stripped off and the balance directed to the
1742program. Otherwise if I<action> begins with B<NUL> followed by
1743non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1744balance is sent back to rxvt.
1745
1746As a convenience for the many Emacs-type editors, I<action> may start
1747with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1748appended if missed from B<M-x> commands.
1749
1750As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1751quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1752
1753=over 4
1754
1755=item For example,
1756
1757B<M-xapropos> is equivalent to B<\Exapropos\r>
1758
1759=item and
1760
1761B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1762
1763=back
1764
1765The option B<< {I<right-rtext>} >> will be right-justified. In the
1766absence of a specified action, this text will be used as the I<action>
1767as well.
1768
1769=over 4
1770
1771=item For example,
1772
1773B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1774
1775=back
1776
1777The left label I<is> necessary, since it's used for matching, but
1778implicitly hiding the left label (by using same name for both left and
1779right labels), or explicitly hiding the left label (by preceeding it
1780with a dot), makes it possible to have right-justified text only.
1781
1782=over 4
1783
1784=item For example,
1785
1786B</File/{Open}{Open} Open-File-Action>
1787
1788=item or hiding it
1789
1790B</File/{.anylabel}{Open} Open-File-Action>
1791
1792=back
1793
1794X<menuBarRemove>
1795
1796=head2 Removing menus
1797
1798=over 4
1799
1800=item B<< -/*+ >>
1801
1802remove all menus from the menuBar, the same as B<[clear]>
1803
1804=item B<< -+I</path>menu+ >>
1805
1806remove menu
1807
1808=item B<< -+I</path>{item}+ >>
1809
1810remove item
1811
1812=item B<< -+I</path>{-} >>
1813
1814remove separator)
1815
1816=item B<-/path/menu/*>
1817
1818remove all items, separators and submenus from menu
1819
1820=back
1821
1822X<menuBarArrows>
1823
1824=head2 Quick Arrows
1825
1826The menus also provide a hook for I<quick arrows> to provide easier
1827user access. If nothing has been explicitly set, the default is to
1828emulate the curror keys. The syntax permits each arrow to be altered
1829individually or all four at once without re-entering their common
1830beginning/end text. For example, to explicitly associate cursor actions
1831with the arrows, any of the following forms could be used:
1832
1833=over 4
1834
1835=item B<< <r>+I<Right> >>
1836
1837=item B<< <l>+I<Left> >>
1838
1839=item B<< <u>+I<Up> >>
1840
1841=item B<< <d>+I<Down> >>
1842
1843Define actions for the respective arrow buttons
1844
1845=item B<< <b>+I<Begin> >>
1846
1847=item B<< <e>+I<End> >>
1848
1849Define common beginning/end parts for I<quick arrows> which used in
1850conjunction with the above <r> <l> <u> <d> constructs
1851
1852=back
1853
1854=over 4
1855
1856=item For example, define arrows individually,
1857
1858 <u>\E[A
1859
1860 <d>\E[B
1861
1862 <r>\E[C
1863
1864 <l>\E[D
1865
1866=item or all at once
1867
1868 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1869
1870=item or more compactly (factoring out common parts)
1871
1872 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1873
1874=back
1875
1876X<menuBarSummary>
1877
1878=head2 Command Summary
1879
1880A short summary of the most I<common> commands:
1881
1882=over 4
1883
1884=item [menu:name]
1885
1886use an existing named menuBar or start a new one
1887
1888=item [menu]
1889
1890use the current menuBar
1891
1892=item [title:string]
1893
1894set menuBar title
1895
1896=item [done]
1897
1898set menu access to readonly and, if reading from a file, signal EOF
1899
1900=item [done:name]
1901
1902if reading from a file using [read:file;name] signal EOF
1903
1904=item [rm:name]
1905
1906remove named menuBar(s)
1907
1908=item [rm] [rm:]
1909
1910remove current menuBar
1911
1912=item [rm*] [rm:*]
1913
1914remove all menuBar(s)
1915
1916=item [swap]
1917
1918swap top two menuBars
1919
1920=item [prev]
1921
1922access the previous menuBar
1923
1924=item [next]
1925
1926access the next menuBar
1927
1928=item [show]
1929
1930map menuBar
1931
1932=item [hide]
1933
1934unmap menuBar
1935
1936=item [pixmap;file]
1937
1938=item [pixmap;file;scaling]
1939
1940set a background pixmap
1941
1942=item [read:file]
1943
1944=item [read:file;name]
1945
1946read in a menu from a file
1947
1948=item [dump]
1949
1950dump out all menuBars to /tmp/rxvt-PID
1951
1952=item /
1953
1954access menuBar top level
1955
1956=item ./
1957
1958=item ../
1959
1960=item ../../
1961
1962access current or parent menu level
1963
1964=item /path/menu
1965
1966add/access menu
1967
1968=item /path/{-}
1969
1970add separator
1971
1972=item /path/{item}{rtext} action
1973
1974add/alter menu item
1975
1976=item -/*
1977
1978remove all menus from the menuBar
1979
1980=item -/path/menu
1981
1982remove menu items, separators and submenus from menu
1983
1984=item -/path/menu
1985
1986remove menu
1987
1988=item -/path/{item}
1989
1990remove item
1991
1992=item -/path/{-}
1993
1994remove separator
1995
1996=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1997
1998menu quick arrows
1999
2000=back
2001X<XPM> 1787X<XPM>
2002 1788
2003=head1 XPM 1789=head1 XPM
2004 1790
2005For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1791For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
2191=end table 1977=end table
2192 1978
2193=head1 CONFIGURE OPTIONS 1979=head1 CONFIGURE OPTIONS
2194 1980
2195General hint: if you get compile errors, then likely your configuration 1981General hint: if you get compile errors, then likely your configuration
2196hasn't been tested well. Either try with --enable-everything or use the 1982hasn't been tested well. Either try with C<--enable-everything> or use
2197./reconf script as a base for experiments. ./reconf is used by myself, 1983the F<./reconf> script as a base for experiments. F<./reconf> is used by
2198so it should generally be a working config. Of course, you should always 1984myself, so it should generally be a working config. Of course, you should
2199report when a combination doesn't work, so it can be fixed. Marc Lehmann 1985always report when a combination doesn't work, so it can be fixed. Marc
2200<rxvt@schmorp.de>. 1986Lehmann <rxvt@schmorp.de>.
1987
1988All
2201 1989
2202=over 4 1990=over 4
2203 1991
2204=item --enable-everything 1992=item --enable-everything
2205 1993
2206Add support for all non-multichoice options listed in "./configure 1994Add (or remove) support for all non-multichoice options listed in "./configure
2207--help". Note that unlike other enable options this is order dependant. 1995--help".
1996
2208You can specify this and then disable options which this enables by 1997You can specify this and then disable options you do not like by
2209I<following> this with the appropriate commands. 1998I<following> this with the appropriate C<--disable-...> arguments,
1999or you can start with a minimal configuration by specifying
2000C<--disable-everything> and than adding just the C<--enable-...> arguments
2001you want.
2210 2002
2211=item --enable-xft 2003=item --enable-xft (default: enabled)
2212 2004
2213Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2005Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2214slower and require lots of memory, but as long as you don't use them, you 2006slower and require lots of memory, but as long as you don't use them, you
2215don't pay for them. 2007don't pay for them.
2216 2008
2217=item --enable-font-styles 2009=item --enable-font-styles (default: on)
2218 2010
2219Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2011Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2220styles. The fonts can be set manually or automatically. 2012styles. The fonts can be set manually or automatically.
2221 2013
2222=item --with-codesets=NAME,... 2014=item --with-codesets=NAME,... (default: all)
2223 2015
2224Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2016Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2225are always compiled in, which includes most 8-bit character sets). These 2017are always compiled in, which includes most 8-bit character sets). These
2226codeset tables are used for driving X11 core fonts, they are not required 2018codeset tables are used for driving X11 core fonts, they are not required
2227for Xft fonts, although having them compiled in lets rxvt-unicode choose 2019for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2238 jp_ext rarely used but big japanese encodings 2030 jp_ext rarely used but big japanese encodings
2239 kr korean encodings 2031 kr korean encodings
2240 2032
2241=end table 2033=end table
2242 2034
2243=item --enable-xim 2035=item --enable-xim (default: on)
2244 2036
2245Add support for XIM (X Input Method) protocol. This allows using 2037Add support for XIM (X Input Method) protocol. This allows using
2246alternative input methods (e.g. kinput2) and will also correctly 2038alternative input methods (e.g. kinput2) and will also correctly
2247set up the input for people using dead keys or compose keys. 2039set up the input for people using dead keys or compose keys.
2248 2040
2249=item --enable-unicode3 2041=item --enable-unicode3 (default: off)
2042
2043Recommended to stay off unless you really need non-BMP characters.
2250 2044
2251Enable direct support for displaying unicode codepoints above 2045Enable direct support for displaying unicode codepoints above
225265535 (the basic multilingual page). This increases storage 204665535 (the basic multilingual page). This increases storage
2253requirements per character from 2 to 4 bytes. X11 fonts do not yet 2047requirements per character from 2 to 4 bytes. X11 fonts do not yet
2254support these extra characters, but Xft does. 2048support these extra characters, but Xft does.
… …
2257even without this flag, but the number of such characters is 2051even without this flag, but the number of such characters is
2258limited to a view thousand (shared with combining characters, 2052limited to a view thousand (shared with combining characters,
2259see next switch), and right now rxvt-unicode cannot display them 2053see next switch), and right now rxvt-unicode cannot display them
2260(input/output and cut&paste still work, though). 2054(input/output and cut&paste still work, though).
2261 2055
2262=item --enable-combining 2056=item --enable-combining (default: on)
2263 2057
2264Enable automatic composition of combining characters into 2058Enable automatic composition of combining characters into
2265composite characters. This is required for proper viewing of text 2059composite characters. This is required for proper viewing of text
2266where accents are encoded as seperate unicode characters. This is 2060where accents are encoded as seperate unicode characters. This is
2267done by using precomposited characters when available or creating 2061done by using precomposited characters when available or creating
2268new pseudo-characters when no precomposed form exists. 2062new pseudo-characters when no precomposed form exists.
2269 2063
2270Without --enable-unicode3, the number of additional precomposed characters 2064Without --enable-unicode3, the number of additional precomposed
2271is rather limited (2048, if this is full, rxvt-unicode will use the 2065characters is somewhat limited (the 6400 private use characters will be
2272private use area, extending the number of combinations to 8448). With
2273--enable-unicode3, no practical limit exists. 2066(ab-)used). With --enable-unicode3, no practical limit exists.
2274 2067
2275This option will also enable storage (but not display) of characters 2068This option will also enable storage (but not display) of characters
2276beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2069beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2277 2070
2278The combining table also contains entries for arabic presentation forms, 2071The combining table also contains entries for arabic presentation forms,
2279but these are not currently used. Bug me if you want these to be used (and 2072but these are not currently used. Bug me if you want these to be used (and
2280tell me how these are to be used...). 2073tell me how these are to be used...).
2281 2074
2282=item --enable-fallback(=CLASS) 2075=item --enable-fallback(=CLASS) (default: Rxvt)
2283 2076
2284When reading resource settings, also read settings for class CLASS 2077When reading resource settings, also read settings for class CLASS. To
2285(default: Rxvt). To disable resource fallback use --disable-fallback. 2078disable resource fallback use --disable-fallback.
2286 2079
2287=item --with-res-name=NAME 2080=item --with-res-name=NAME (default: urxvt)
2288 2081
2289Use the given name (default: urxvt) as default application name when 2082Use the given name as default application name when
2290reading resources. Specify --with-res-name=rxvt to replace rxvt. 2083reading resources. Specify --with-res-name=rxvt to replace rxvt.
2291 2084
2292=item --with-res-class=CLASS 2085=item --with-res-class=CLASS /default: URxvt)
2293 2086
2294Use the given class (default: URxvt) as default application class 2087Use the given class as default application class
2295when reading resources. Specify --with-res-class=Rxvt to replace 2088when reading resources. Specify --with-res-class=Rxvt to replace
2296rxvt. 2089rxvt.
2297 2090
2298=item --enable-utmp 2091=item --enable-utmp (default: on)
2299 2092
2300Write user and tty to utmp file (used by programs like F<w>) at 2093Write user and tty to utmp file (used by programs like F<w>) at
2301start of rxvt execution and delete information when rxvt exits. 2094start of rxvt execution and delete information when rxvt exits.
2302 2095
2303=item --enable-wtmp 2096=item --enable-wtmp (default: on)
2304 2097
2305Write user and tty to wtmp file (used by programs like F<last>) at 2098Write user and tty to wtmp file (used by programs like F<last>) at
2306start of rxvt execution and write logout when rxvt exits. This 2099start of rxvt execution and write logout when rxvt exits. This
2307option requires --enable-utmp to also be specified. 2100option requires --enable-utmp to also be specified.
2308 2101
2309=item --enable-lastlog 2102=item --enable-lastlog (default: on)
2310 2103
2311Write user and tty to lastlog file (used by programs like 2104Write user and tty to lastlog file (used by programs like
2312F<lastlogin>) at start of rxvt execution. This option requires 2105F<lastlogin>) at start of rxvt execution. This option requires
2313--enable-utmp to also be specified. 2106--enable-utmp to also be specified.
2314 2107
2315=item --enable-xpm-background 2108=item --enable-xpm-background (default: on)
2316 2109
2317Add support for XPM background pixmaps. 2110Add support for XPM background pixmaps.
2318 2111
2319=item --enable-transparency 2112=item --enable-transparency (default: on)
2320 2113
2321Add support for inheriting parent backgrounds thus giving a fake 2114Add support for inheriting parent backgrounds thus giving a fake
2322transparency to the term. 2115transparency to the term.
2323 2116
2324=item --enable-fading 2117=item --enable-fading (default: on)
2325 2118
2326Add support for fading the text when focus is lost. 2119Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2327 2120
2328=item --enable-tinting 2121=item --enable-tinting (default: on)
2329 2122
2330Add support for tinting of transparent backgrounds. 2123Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2331 2124
2332=item --enable-menubar
2333
2334Add support for our menu bar system (this interacts badly with
2335dynamic locale switching currently).
2336
2337=item --enable-rxvt-scroll 2125=item --enable-rxvt-scroll (default: on)
2338 2126
2339Add support for the original rxvt scrollbar. 2127Add support for the original rxvt scrollbar.
2340 2128
2341=item --enable-next-scroll 2129=item --enable-next-scroll (default: on)
2342 2130
2343Add support for a NeXT-like scrollbar. 2131Add support for a NeXT-like scrollbar.
2344 2132
2345=item --enable-xterm-scroll 2133=item --enable-xterm-scroll (default: on)
2346 2134
2347Add support for an Xterm-like scrollbar. 2135Add support for an Xterm-like scrollbar.
2348 2136
2349=item --enable-plain-scroll 2137=item --enable-plain-scroll (default: on)
2350 2138
2351Add support for a very unobtrusive, plain-looking scrollbar that 2139Add support for a very unobtrusive, plain-looking scrollbar that
2352is the favourite of the rxvt-unicode author, having used it for 2140is the favourite of the rxvt-unicode author, having used it for
2353many years. 2141many years.
2354 2142
2355=item --enable-half-shadow 2143=item --enable-ttygid (default: off)
2356
2357Make shadows on the scrollbar only half the normal width & height.
2358only applicable to rxvt scrollbars.
2359
2360=item --enable-ttygid
2361 2144
2362Change tty device setting to group "tty" - only use this if 2145Change tty device setting to group "tty" - only use this if
2363your system uses this type of security. 2146your system uses this type of security.
2364 2147
2365=item --disable-backspace-key 2148=item --disable-backspace-key
2366 2149
2367Disable any handling of the backspace key by us - let the X server 2150Removes any handling of the backspace key by us - let the X server do it.
2151
2152=item --disable-delete-key
2153
2154Removes any handling of the delete key by us - let the X server
2368do it. 2155do it.
2369 2156
2370=item --disable-delete-key
2371
2372Disable any handling of the delete key by us - let the X server
2373do it.
2374
2375=item --disable-resources 2157=item --disable-resources
2376 2158
2377Remove all resources checking. 2159Removes any support for resource checking.
2378
2379=item --enable-xgetdefault
2380
2381Make resources checking via XGetDefault() instead of our small
2382version which only checks ~/.Xdefaults, or if that doesn't exist then
2383~/.Xresources.
2384
2385Please note that nowadays, things like XIM will automatically pull in and
2386use the full X resource manager, so the overhead of using it might be very
2387small, if nonexistant.
2388
2389=item --enable-strings
2390
2391Add support for our possibly faster memset() function and other
2392various routines, overriding your system's versions which may
2393have been hand-crafted in assembly or may require extra libraries
2394to link in. (this breaks ANSI-C rules and has problems on many
2395GNU/Linux systems).
2396 2160
2397=item --disable-swapscreen 2161=item --disable-swapscreen
2398 2162
2399Remove support for swap screen. 2163Remove support for secondary/swap screen.
2400 2164
2401=item --enable-frills 2165=item --enable-frills (default: on)
2402 2166
2403Add support for many small features that are not essential but nice to 2167Add support for many small features that are not essential but nice to
2404have. Normally you want this, but for very small binaries you may want to 2168have. Normally you want this, but for very small binaries you may want to
2405disable this. 2169disable this.
2406 2170
2407A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2171A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2408in combination with other switches) is: 2172in combination with other switches) is:
2409 2173
2410 MWM-hints 2174 MWM-hints
2411 EWMH-hints (pid, utf8 names) and protocols (ping) 2175 EWMH-hints (pid, utf8 names) and protocols (ping)
2412 seperate underline colour 2176 seperate underline colour (-underlineColor)
2413 settable border widths and borderless switch 2177 settable border widths and borderless switch (-w, -b, -bl)
2178 visual depth selection (-depth)
2414 settable extra linespacing 2179 settable extra linespacing /-lsp)
2415 iso-14755-2 and -3, and visual feedback 2180 iso-14755-2 and -3, and visual feedback
2181 tripleclickwords (-tcw)
2182 settable insecure mode (-insecure)
2183 keysym remapping support
2184 cursor blinking and underline cursor (-cb, -uc)
2185 XEmbed support (-embed)
2186 user-pty (-pty-fd)
2187 hold on exit (-hold)
2188 skip builtin block graphics (-sbg)
2189
2190It also enabled some non-essential features otherwise disabled, such as:
2191
2192 some round-trip time optimisations
2193 nearest color allocation on pseudocolor screens
2194 UTF8_STRING supporr for selection
2195 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequence 2196 backindex and forwardindex escape sequences
2197 view change/zero scorllback esacpe sequences
2198 locale switching escape sequence
2417 window op and some xterm/OSC escape sequences 2199 window op and some xterm/OSC escape sequences
2418 tripleclickwords 2200 rectangular selections
2419 settable insecure mode 2201 trailing space removal for selections
2420 keysym remapping support 2202 verbose X error handling
2421 cursor blinking and underline cursor
2422 -embed and -pty-fd options
2423 2203
2424=item --enable-iso14755 2204=item --enable-iso14755 (default: on)
2425 2205
2426Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2206Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2427F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2207F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2428C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2208C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2429this switch. 2209this switch.
2430 2210
2431=item --enable-keepscrolling 2211=item --enable-keepscrolling (default: on)
2432 2212
2433Add support for continual scrolling of the display when you hold 2213Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2214the mouse button down on a scrollbar arrow.
2435 2215
2436=item --enable-mousewheel 2216=item --enable-mousewheel (default: on)
2437 2217
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2218Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2219
2440=item --enable-slipwheeling 2220=item --enable-slipwheeling (default: on)
2441 2221
2442Add support for continual scrolling (using the mouse wheel as an 2222Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2223accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2224requires --enable-mousewheel to also be specified.
2445 2225
2446=item --disable-new-selection 2226=item --disable-new-selection
2447 2227
2448Remove support for mouse selection style like that of xterm. 2228Remove support for mouse selection style like that of xterm.
2449 2229
2450=item --enable-dmalloc 2230=item --enable-dmalloc (default: off)
2451 2231
2452Use Gray Watson's malloc - which is good for debugging See 2232Use Gray Watson's malloc - which is good for debugging See
2453http://www.letters.com/dmalloc/ for details If you use either this or the 2233http://www.letters.com/dmalloc/ for details If you use either this or the
2454next option, you may need to edit src/Makefile after compiling to point 2234next option, you may need to edit src/Makefile after compiling to point
2455DINCLUDE and DLIB to the right places. 2235DINCLUDE and DLIB to the right places.
2456 2236
2457You can only use either this option and the following (should 2237You can only use either this option and the following (should
2458you use either) . 2238you use either) .
2459 2239
2460=item --enable-dlmalloc 2240=item --enable-dlmalloc (default: off)
2461 2241
2462Use Doug Lea's malloc - which is good for a production version 2242Use Doug Lea's malloc - which is good for a production version
2463See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2243See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2464 2244
2465=item --enable-smart-resize 2245=item --enable-smart-resize (default: on)
2466 2246
2467Add smart growth/shrink behaviour when changing font size via from hot 2247Add smart growth/shrink behaviour when changing font size via hot
2468keys. This should keep in a fixed position the rxvt corner which is 2248keys. This should keep the window corner which is closest to a corner of
2469closest to a corner of the screen. 2249the screen in a fixed position.
2470 2250
2471=item --enable-pointer-blank 2251=item --enable-pointer-blank (default: on)
2472 2252
2473Add support to have the pointer disappear when typing or inactive. 2253Add support to have the pointer disappear when typing or inactive.
2474 2254
2475=item --with-name=NAME 2255=item --enable-perl (default: on)
2476 2256
2257Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2258manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2259in F<src/perl-ext/> for the extensions that are installed by default. The
2260perl interpreter that is used can be specified via the C<PERL> environment
2261variable when running configure.
2262
2263=item --with-name=NAME (default: urxvt)
2264
2477Set the basename for the installed binaries (default: C<urxvt>, resulting 2265Set the basename for the installed binaries, resulting
2478in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2266in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2479C<rxvt>. 2267C<rxvt>.
2480 2268
2481=item --with-term=NAME 2269=item --with-term=NAME (default: rxvt-unicode)
2482 2270
2483Change the environmental variable for the terminal to NAME (default 2271Change the environmental variable for the terminal to NAME.
2484C<rxvt-unicode>)
2485 2272
2486=item --with-terminfo=PATH 2273=item --with-terminfo=PATH
2487 2274
2488Change the environmental variable for the path to the terminfo tree to 2275Change the environmental variable for the path to the terminfo tree to
2489PATH. 2276PATH.

Diff Legend

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