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

Diff Legend

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