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.48 by root, Thu Feb 17 12:00:33 2005 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

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

Diff Legend

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