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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines