ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.79 by root, Thu Jan 12 23:11:23 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/too small, can I
30change this?
31
32Yes. For example, if you want to select smaller pieces ("words") you can
33use the 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
44=item I don't like the new selection/popups/hotkeys/perl, how do I
45change/disable it?
46
47You can disable the perl extension completely by setting the
48B<perl-ext-common> resource to the empty string, which also keeps
49rxvt-unicode from initialising perl, saving memory.
50
51If you only want to disable specific features, you first have to
52identify which perl extension is responsible. For this, read the section
53B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
54example, to disable the B<selection-popup> and B<option-popup>, specify
55this B<perl-ext-common> resource:
56
57 URxvt.perl-ext-common: default,-selection-popup,-option-popup
58
59This will keep the default extensions, but disable the two popup
60extensions. Some extensions can also be configured, for example,
61scrollback search mode is triggered by B<M-s>. You can move it to any
62other combination either by setting the B<searchable-scrollback> resource:
63
64 URxvt.searchable-scrollback: CM-s
65
66=item Isn't rxvt supposed to be small? Don't all those features bloat?
67
68I often get asked about this, and I think, no, they didn't cause extra
69bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
70that the urxvt binary is larger (due to some encoding tables always being
71compiled in), but it actually uses less memory (RSS) after startup. Even
72with C<--disable-everything>, this comparison is a bit unfair, as many
73features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
74already in use in this mode.
75
76 text data bss drs rss filename
77 98398 1664 24 15695 1824 rxvt --disable-everything
78 188985 9048 66616 18222 1788 urxvt --disable-everything
79
80When you C<--enable-everything> (which _is_ unfair, as this involves xft
81and full locale/XIM support which are quite bloaty inside libX11 and my
82libc), the two diverge, but not unreasnobaly so.
83
84 text data bss drs rss filename
85 163431 2152 24 20123 2060 rxvt --enable-everything
86 1035683 49680 66648 29096 3680 urxvt --enable-everything
87
88The very large size of the text section is explained by the east-asian
89encoding tables, which, if unused, take up disk space but nothing else
90and can be compiled out unless you rely on X11 core fonts that use those
91encodings. The BSS size comes from the 64k emergency buffer that my c++
92compiler allocates (but of course doesn't use unless you are out of
93memory). Also, using an xft font instead of a core font immediately adds a
94few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
95not used.
96
97Of course, due to every character using two or four bytes instead of one,
98a large scrollback buffer will ultimately make rxvt-unicode use more
99memory.
100
101Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
102still fares rather well. And compared to some monsters like gnome-terminal
103(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10443180k in daemons that stay around after exit, plus half a minute of
105startup time, including the hundreds of warnings it spits out), it fares
106extremely well *g*.
107
108=item Why C++, isn't that unportable/bloated/uncool?
109
110Is this a question? :) It comes up very often. The simple answer is: I had
111to write it, and C++ allowed me to write and maintain it in a fraction
112of the time and effort (which is a scarce resource for me). Put even
113shorter: It simply wouldn't exist without C++.
114
115My personal stance on this is that C++ is less portable than C, but in
116the case of rxvt-unicode this hardly matters, as its portability limits
117are defined by things like X11, pseudo terminals, locale support and unix
118domain sockets, which are all less portable than C++ itself.
119
120Regarding the bloat, see the above question: It's easy to write programs
121in C that use gobs of memory, an certainly possible to write programs in
122C++ that don't. C++ also often comes with large libraries, but this is
123not necessarily the case with GCC. Here is what rxvt links against on my
124system with a minimal config:
125
126 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
127 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
128 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
129 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
130
131And here is rxvt-unicode:
132
133 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
134 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
135 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
136 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
137 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
138
139No large bloated libraries (of course, none were linked in statically),
140except maybe libX11 :)
141
142=item Does it support tabs, can I have a tabbed rxvt-unicode?
143
144rxvt-unicode does not directly support tabs. It will work fine with
145tabbing functionality of many window managers or similar tabbing programs,
146and its embedding-features allow it to be embedded into other programs,
147as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
148module, which features a tabbed urxvt (murxvt) terminal as an example
149embedding application.
150
29=item How do I know which rxvt-unicode version I'm using? 151=item How do I know which rxvt-unicode version I'm using?
30 152
31The version number is displayed with the usage (-h). Also the escape 153The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 154sequence C<ESC [ 8 n> sets the window title to the version number. When
155using the @@RXVT_NAME@@c client, the version displayed is that of the
156daemon.
33 157
34=item I am using Debian GNU/Linux and have a problem... 158=item I am using Debian GNU/Linux and have a problem...
35 159
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 160The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 161patches that considerably change the behaviour of rxvt-unicode. Before
38bug to the original rxvt-unicode author please download and install the 162reporting a bug to the original rxvt-unicode author please download and
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 163install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40reproduce the problem. If you cannot, chances are that the problems are 164and 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 165problems are specific to Debian GNU/Linux, in which case it should be
42Debian Bug Tracking System (use C<reportbug> to report the bug). 166reported via the Debian Bug Tracking System (use C<reportbug> to report
167the bug).
43 168
44For other problems that also affect the Debian package, you can and 169For 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 170probably 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 171bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 172might encounter the same issue.
173
174=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
175
176You should build one binary with the default options. F<configure>
177now enables most useful options, and the trend goes to making them
178runtime-switchable, too, so there is usually no drawback to enbaling them,
179except higher disk and possibly memory usage. The perl interpreter should
180be enabled, as important functionality (menus, selection, likely more in
181the future) depends on it.
182
183You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
184system-wide (except maybe with C<defaults>). This will result in useful
185behaviour. If your distribution aims at low memory, add an empty
186C<perl-ext-common> resource to the app-defaults file. This will keep the
187perl interpreter disabled until the user enables it.
188
189If you can/want build more binaries, I recommend building a minimal
190one with C<--disable-everything> (very useful) and a maximal one with
191C<--enable-everything> (less useful, it will be very big due to a lot of
192encodings built-in that increase download times and are rarely used).
193
194=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
195
196Likely not. While I honestly try to make it secure, and am probably not
197bad at it, I think it is simply unreasonable to expect all of freetype
198+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
199secure. Also, rxvt-unicode disables some options when it detects that it
200runs setuid or setgid, which is not nice. Besides, with the embedded perl
201interpreter the possibility for security problems easily multiplies.
202
203Elevated privileges are only required for utmp and pty operations on some
204systems (for example, GNU/Linux doesn't need any extra privileges for
205ptys, but some need it for utmp support). It is planned to mvoe this into
206a forked handler process, but this is not yet done.
207
208So, while setuid/setgid operation is supported and not a problem on your
209typical single-user-no-other-logins unix desktop, always remember that
210its an awful lot of code, most of which isn't checked for security issues
211regularly.
48 212
49=item When I log-in to another system it tells me about missing terminfo data? 213=item When I log-in to another system it tells me about missing terminfo data?
50 214
51The terminal description used by rxvt-unicode is not as widely available 215The 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). 216as that for xterm, or even rxvt (for which the same problem often arises).
… …
71 235
72 URxvt.termName: rxvt 236 URxvt.termName: rxvt
73 237
74If you don't plan to use B<rxvt> (quite common...) you could also replace 238If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 239the rxvt terminfo file with the rxvt-unicode one.
240
241=item C<tic> outputs some error when compiling the terminfo entry.
242
243Most likely it's the empty definition for C<enacs=>. Just replace it by
244C<enacs=\E[0@> and try again.
76 245
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 246=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 247
79=item I need a termcap file entry. 248=item I need a termcap file entry.
80 249
… …
354single font). I recommend starting the X-server in C<-multiwindow> or 523single font). I recommend starting the X-server in C<-multiwindow> or
355C<-rootless> mode instead, which will result in similar look&feel as the 524C<-rootless> mode instead, which will result in similar look&feel as the
356old libW11 emulation. 525old libW11 emulation.
357 526
358At the time of this writing, cygwin didn't seem to support any multi-byte 527At the time of this writing, cygwin didn't seem to support any multi-byte
359encodings, so you are likely limited to 8-bit encodings. 528encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
529to 8-bit encodings.
360 530
361=item How does rxvt-unicode determine the encoding to use? 531=item How does rxvt-unicode determine the encoding to use?
362 532
363=item Is there an option to switch encodings? 533=item Is there an option to switch encodings?
364 534
… …
480 650
481=item Can I speed up Xft rendering somehow? 651=item Can I speed up Xft rendering somehow?
482 652
483Yes, the most obvious way to speed it up is to avoid Xft entirely, as 653Yes, the most obvious way to speed it up is to avoid Xft entirely, as
484it is simply slow. If you still want Xft fonts you might try to disable 654it is simply slow. If you still want Xft fonts you might try to disable
485antialiasing (by appending C<:antialiasing=false>), which saves lots of 655antialiasing (by appending C<:antialias=false>), which saves lots of
486memory and also speeds up rendering considerably. 656memory and also speeds up rendering considerably.
487 657
488=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 658=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
489 659
490Rxvt-unicode will use whatever you specify as a font. If it needs to 660Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
568 URxvt.color7: #e1dddd 738 URxvt.color7: #e1dddd
569 URxvt.color15: #e1dddd 739 URxvt.color15: #e1dddd
570 740
571=item How can I start @@RXVT_NAME@@d in a race-free way? 741=item How can I start @@RXVT_NAME@@d in a race-free way?
572 742
573Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 743Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
574server that answers @@RXVT_NAME@@c's requests, so it doesn't background 744display, create the listening socket and then fork.
575itself.
576
577To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
578following method to wait for the startup message before continuing:
579
580 { @@RXVT_NAME@@d & } | read
581 745
582=item What's with the strange Backspace/Delete key behaviour? 746=item What's with the strange Backspace/Delete key behaviour?
583 747
584Assuming that the physical Backspace key corresponds to the 748Assuming that the physical Backspace key corresponds to the
585BackSpace keysym (not likely for Linux ... see the following 749BackSpace keysym (not likely for Linux ... see the following
… …
1445 B<< C<h> >> Scroll to bottom when a key is pressed 1609 B<< C<h> >> Scroll to bottom when a key is pressed
1446 B<< C<l> >> Don't scroll to bottom when a key is pressed 1610 B<< C<l> >> Don't scroll to bottom when a key is pressed
1447 1611
1448=end table 1612=end table
1449 1613
1614=item B<< C<Ps = 1021> >> (B<rxvt>)
1615
1616=begin table
1617
1618 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1619 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1620
1621=end table
1622
1450=item B<< C<Ps = 1047> >> 1623=item B<< C<Ps = 1047> >>
1451 1624
1452=begin table 1625=begin table
1453 1626
1454 B<< C<h> >> Use Alternate Screen Buffer 1627 B<< C<h> >> Use Alternate Screen Buffer
… …
1500 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1673 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1501 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1674 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1502 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1675 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1503 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1676 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1504 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1677 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1505 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1678 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1506 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1679 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1507 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1680 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1508 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1681 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1509 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1682 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1510 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1683 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1511 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1684 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1512 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1685 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1513 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1686 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1514 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1687 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1515 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1688 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1516 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1689 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1690 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1691 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1517 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1692 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1518 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1693 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1519 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1694 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1695 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1696 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1522 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 1697 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1698 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1523 1699
1524=end table 1700=end table
1525 1701
1526=back 1702=back
1527 1703
… …
2184=end table 2360=end table
2185 2361
2186=head1 CONFIGURE OPTIONS 2362=head1 CONFIGURE OPTIONS
2187 2363
2188General hint: if you get compile errors, then likely your configuration 2364General hint: if you get compile errors, then likely your configuration
2189hasn't been tested well. Either try with --enable-everything or use the 2365hasn't been tested well. Either try with C<--enable-everything> or use
2190./reconf script as a base for experiments. ./reconf is used by myself, 2366the F<./reconf> script as a base for experiments. F<./reconf> is used by
2191so it should generally be a working config. Of course, you should always 2367myself, so it should generally be a working config. Of course, you should
2192report when a combination doesn't work, so it can be fixed. Marc Lehmann 2368always report when a combination doesn't work, so it can be fixed. Marc
2193<rxvt@schmorp.de>. 2369Lehmann <rxvt@schmorp.de>.
2370
2371All
2194 2372
2195=over 4 2373=over 4
2196 2374
2197=item --enable-everything 2375=item --enable-everything
2198 2376
2199Add support for all non-multichoice options listed in "./configure 2377Add (or remove) support for all non-multichoice options listed in "./configure
2200--help". Note that unlike other enable options this is order dependant. 2378--help".
2379
2201You can specify this and then disable options which this enables by 2380You can specify this and then disable options you do not like by
2202I<following> this with the appropriate commands. 2381I<following> this with the appropriate C<--disable-...> arguments,
2382or you can start with a minimal configuration by specifying
2383C<--disable-everything> and than adding just the C<--enable-...> arguments
2384you want.
2203 2385
2204=item --enable-xft 2386=item --enable-xft (default: enabled)
2205 2387
2206Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2388Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2207slower and require lots of memory, but as long as you don't use them, you 2389slower and require lots of memory, but as long as you don't use them, you
2208don't pay for them. 2390don't pay for them.
2209 2391
2210=item --enable-font-styles 2392=item --enable-font-styles (default: on)
2211 2393
2212Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2394Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213styles. The fonts can be set manually or automatically. 2395styles. The fonts can be set manually or automatically.
2214 2396
2215=item --with-codesets=NAME,... 2397=item --with-codesets=NAME,... (default: all)
2216 2398
2217Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2399Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218are always compiled in, which includes most 8-bit character sets). These 2400are always compiled in, which includes most 8-bit character sets). These
2219codeset tables are used for driving X11 core fonts, they are not required 2401codeset tables are used for driving X11 core fonts, they are not required
2220for Xft fonts, although having them compiled in lets rxvt-unicode choose 2402for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2231 jp_ext rarely used but big japanese encodings 2413 jp_ext rarely used but big japanese encodings
2232 kr korean encodings 2414 kr korean encodings
2233 2415
2234=end table 2416=end table
2235 2417
2236=item --enable-xim 2418=item --enable-xim (default: on)
2237 2419
2238Add support for XIM (X Input Method) protocol. This allows using 2420Add support for XIM (X Input Method) protocol. This allows using
2239alternative input methods (e.g. kinput2) and will also correctly 2421alternative input methods (e.g. kinput2) and will also correctly
2240set up the input for people using dead keys or compose keys. 2422set up the input for people using dead keys or compose keys.
2241 2423
2242=item --enable-unicode3 2424=item --enable-unicode3 (default: off)
2243 2425
2244Enable direct support for displaying unicode codepoints above 2426Enable direct support for displaying unicode codepoints above
224565535 (the basic multilingual page). This increases storage 242765535 (the basic multilingual page). This increases storage
2246requirements per character from 2 to 4 bytes. X11 fonts do not yet 2428requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247support these extra characters, but Xft does. 2429support these extra characters, but Xft does.
… …
2250even without this flag, but the number of such characters is 2432even without this flag, but the number of such characters is
2251limited to a view thousand (shared with combining characters, 2433limited to a view thousand (shared with combining characters,
2252see next switch), and right now rxvt-unicode cannot display them 2434see next switch), and right now rxvt-unicode cannot display them
2253(input/output and cut&paste still work, though). 2435(input/output and cut&paste still work, though).
2254 2436
2255=item --enable-combining 2437=item --enable-combining (default: on)
2256 2438
2257Enable automatic composition of combining characters into 2439Enable automatic composition of combining characters into
2258composite characters. This is required for proper viewing of text 2440composite characters. This is required for proper viewing of text
2259where accents are encoded as seperate unicode characters. This is 2441where accents are encoded as seperate unicode characters. This is
2260done by using precomposited characters when available or creating 2442done by using precomposited characters when available or creating
… …
2270 2452
2271The combining table also contains entries for arabic presentation forms, 2453The combining table also contains entries for arabic presentation forms,
2272but these are not currently used. Bug me if you want these to be used (and 2454but these are not currently used. Bug me if you want these to be used (and
2273tell me how these are to be used...). 2455tell me how these are to be used...).
2274 2456
2275=item --enable-fallback(=CLASS) 2457=item --enable-fallback(=CLASS) (default: Rxvt)
2276 2458
2277When reading resource settings, also read settings for class CLASS 2459When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2278(default: Rxvt). To disable resource fallback use --disable-fallback.
2279 2460
2280=item --with-res-name=NAME 2461=item --with-res-name=NAME (default: urxvt)
2281 2462
2282Use the given name (default: urxvt) as default application name when 2463Use the given name as default application name when
2283reading resources. Specify --with-res-name=rxvt to replace rxvt. 2464reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284 2465
2285=item --with-res-class=CLASS 2466=item --with-res-class=CLASS /default: URxvt)
2286 2467
2287Use the given class (default: URxvt) as default application class 2468Use the given class as default application class
2288when reading resources. Specify --with-res-class=Rxvt to replace 2469when reading resources. Specify --with-res-class=Rxvt to replace
2289rxvt. 2470rxvt.
2290 2471
2291=item --enable-utmp 2472=item --enable-utmp (default: on)
2292 2473
2293Write user and tty to utmp file (used by programs like F<w>) at 2474Write user and tty to utmp file (used by programs like F<w>) at
2294start of rxvt execution and delete information when rxvt exits. 2475start of rxvt execution and delete information when rxvt exits.
2295 2476
2296=item --enable-wtmp 2477=item --enable-wtmp (default: on)
2297 2478
2298Write user and tty to wtmp file (used by programs like F<last>) at 2479Write user and tty to wtmp file (used by programs like F<last>) at
2299start of rxvt execution and write logout when rxvt exits. This 2480start of rxvt execution and write logout when rxvt exits. This
2300option requires --enable-utmp to also be specified. 2481option requires --enable-utmp to also be specified.
2301 2482
2302=item --enable-lastlog 2483=item --enable-lastlog (default: on)
2303 2484
2304Write user and tty to lastlog file (used by programs like 2485Write user and tty to lastlog file (used by programs like
2305F<lastlogin>) at start of rxvt execution. This option requires 2486F<lastlogin>) at start of rxvt execution. This option requires
2306--enable-utmp to also be specified. 2487--enable-utmp to also be specified.
2307 2488
2308=item --enable-xpm-background 2489=item --enable-xpm-background (default: on)
2309 2490
2310Add support for XPM background pixmaps. 2491Add support for XPM background pixmaps.
2311 2492
2312=item --enable-transparency 2493=item --enable-transparency (default: on)
2313 2494
2314Add support for inheriting parent backgrounds thus giving a fake 2495Add support for inheriting parent backgrounds thus giving a fake
2315transparency to the term. 2496transparency to the term.
2316 2497
2317=item --enable-fading 2498=item --enable-fading (default: on)
2318 2499
2319Add support for fading the text when focus is lost. 2500Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2320 2501
2321=item --enable-tinting 2502=item --enable-tinting (default: on)
2322 2503
2323Add support for tinting of transparent backgrounds. 2504Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2324 2505
2325=item --enable-menubar 2506=item --enable-menubar (default: off) [DEPRECATED]
2326 2507
2327Add support for our menu bar system (this interacts badly with 2508Add support for our menu bar system (this interacts badly with dynamic
2328dynamic locale switching currently). 2509locale switching currently). This option is DEPRECATED and will be removed
2510in the future.
2329 2511
2330=item --enable-rxvt-scroll 2512=item --enable-rxvt-scroll (default: on)
2331 2513
2332Add support for the original rxvt scrollbar. 2514Add support for the original rxvt scrollbar.
2333 2515
2334=item --enable-next-scroll 2516=item --enable-next-scroll (default: on)
2335 2517
2336Add support for a NeXT-like scrollbar. 2518Add support for a NeXT-like scrollbar.
2337 2519
2338=item --enable-xterm-scroll 2520=item --enable-xterm-scroll (default: on)
2339 2521
2340Add support for an Xterm-like scrollbar. 2522Add support for an Xterm-like scrollbar.
2341 2523
2342=item --enable-plain-scroll 2524=item --enable-plain-scroll (default: on)
2343 2525
2344Add support for a very unobtrusive, plain-looking scrollbar that 2526Add support for a very unobtrusive, plain-looking scrollbar that
2345is the favourite of the rxvt-unicode author, having used it for 2527is the favourite of the rxvt-unicode author, having used it for
2346many years. 2528many years.
2347 2529
2348=item --enable-half-shadow 2530=item --enable-half-shadow (default: off)
2349 2531
2350Make shadows on the scrollbar only half the normal width & height. 2532Make shadows on the scrollbar only half the normal width & height.
2351only applicable to rxvt scrollbars. 2533only applicable to rxvt scrollbars.
2352 2534
2353=item --enable-ttygid 2535=item --enable-ttygid (default: off)
2354 2536
2355Change tty device setting to group "tty" - only use this if 2537Change tty device setting to group "tty" - only use this if
2356your system uses this type of security. 2538your system uses this type of security.
2357 2539
2358=item --disable-backspace-key 2540=item --disable-backspace-key
2359 2541
2360Disable any handling of the backspace key by us - let the X server 2542Removes any handling of the backspace key by us - let the X server do it.
2543
2544=item --disable-delete-key
2545
2546Removes any handling of the delete key by us - let the X server
2361do it. 2547do it.
2362 2548
2363=item --disable-delete-key
2364
2365Disable any handling of the delete key by us - let the X server
2366do it.
2367
2368=item --disable-resources 2549=item --disable-resources
2369 2550
2370Remove all resources checking. 2551Removes any support for resource checking.
2371 2552
2372=item --enable-xgetdefault 2553=item --enable-strings (default: off)
2373
2374Make resources checking via XGetDefault() instead of our small
2375version which only checks ~/.Xdefaults, or if that doesn't exist then
2376~/.Xresources.
2377
2378Please note that nowadays, things like XIM will automatically pull in and
2379use the full X resource manager, so the overhead of using it might be very
2380small, if nonexistant.
2381
2382=item --enable-strings
2383 2554
2384Add support for our possibly faster memset() function and other 2555Add support for our possibly faster memset() function and other
2385various routines, overriding your system's versions which may 2556various routines, overriding your system's versions which may
2386have been hand-crafted in assembly or may require extra libraries 2557have been hand-crafted in assembly or may require extra libraries
2387to link in. (this breaks ANSI-C rules and has problems on many 2558to link in. (this breaks ANSI-C rules and has problems on many
2388GNU/Linux systems). 2559GNU/Linux systems).
2389 2560
2390=item --disable-swapscreen 2561=item --disable-swapscreen
2391 2562
2392Remove support for swap screen. 2563Remove support for secondary/swap screen.
2393 2564
2394=item --enable-frills 2565=item --enable-frills (default: on)
2395 2566
2396Add support for many small features that are not essential but nice to 2567Add support for many small features that are not essential but nice to
2397have. Normally you want this, but for very small binaries you may want to 2568have. Normally you want this, but for very small binaries you may want to
2398disable this. 2569disable this.
2399 2570
2400A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2571A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2401in combination with other switches) is: 2572in combination with other switches) is:
2402 2573
2403 MWM-hints 2574 MWM-hints
2404 EWMH-hints (pid, utf8 names) and protocols (ping) 2575 EWMH-hints (pid, utf8 names) and protocols (ping)
2405 seperate underline colour 2576 seperate underline colour (-underlineColor)
2406 settable border widths and borderless switch 2577 settable border widths and borderless switch (-w, -b, -bl)
2407 settable extra linespacing 2578 settable extra linespacing /-lsp)
2408 iso-14755-2 and -3, and visual feedback 2579 iso-14755-2 and -3, and visual feedback
2409 backindex and forwardindex escape sequence 2580 backindex and forwardindex escape sequence
2410 window op and some xterm/OSC escape sequences 2581 window op and some xterm/OSC escape sequences
2411 tripleclickwords 2582 tripleclickwords (-tcw)
2412 settable insecure mode 2583 settable insecure mode (-insecure)
2413 keysym remapping support 2584 keysym remapping support
2414 cursor blinking and underline cursor 2585 cursor blinking and underline cursor (-cb, -uc)
2415 -embed and -pty-fd options 2586 XEmbed support (-embed)
2587 user-pty (-pty-fd)
2588 hold on exit (-hold)
2589 skip builtin block graphics (-sbg)
2590 sgr modes 90..97 and 100..107
2416 2591
2417=item --enable-iso14755 2592=item --enable-iso14755 (default: on)
2418 2593
2419Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2594Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2420F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2595F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2421C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2596C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2422this switch. 2597this switch.
2423 2598
2424=item --enable-keepscrolling 2599=item --enable-keepscrolling (default: on)
2425 2600
2426Add support for continual scrolling of the display when you hold 2601Add support for continual scrolling of the display when you hold
2427the mouse button down on a scrollbar arrow. 2602the mouse button down on a scrollbar arrow.
2428 2603
2429=item --enable-mousewheel 2604=item --enable-mousewheel (default: on)
2430 2605
2431Add support for scrolling via mouse wheel or buttons 4 & 5. 2606Add support for scrolling via mouse wheel or buttons 4 & 5.
2432 2607
2433=item --enable-slipwheeling 2608=item --enable-slipwheeling (default: on)
2434 2609
2435Add support for continual scrolling (using the mouse wheel as an 2610Add support for continual scrolling (using the mouse wheel as an
2436accelerator) while the control key is held down. This option 2611accelerator) while the control key is held down. This option
2437requires --enable-mousewheel to also be specified. 2612requires --enable-mousewheel to also be specified.
2438 2613
2439=item --disable-new-selection 2614=item --disable-new-selection
2440 2615
2441Remove support for mouse selection style like that of xterm. 2616Remove support for mouse selection style like that of xterm.
2442 2617
2443=item --enable-dmalloc 2618=item --enable-dmalloc (default: off)
2444 2619
2445Use Gray Watson's malloc - which is good for debugging See 2620Use Gray Watson's malloc - which is good for debugging See
2446http://www.letters.com/dmalloc/ for details If you use either this or the 2621http://www.letters.com/dmalloc/ for details If you use either this or the
2447next option, you may need to edit src/Makefile after compiling to point 2622next option, you may need to edit src/Makefile after compiling to point
2448DINCLUDE and DLIB to the right places. 2623DINCLUDE and DLIB to the right places.
2449 2624
2450You can only use either this option and the following (should 2625You can only use either this option and the following (should
2451you use either) . 2626you use either) .
2452 2627
2453=item --enable-dlmalloc 2628=item --enable-dlmalloc (default: off)
2454 2629
2455Use Doug Lea's malloc - which is good for a production version 2630Use Doug Lea's malloc - which is good for a production version
2456See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2631See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457 2632
2458=item --enable-smart-resize 2633=item --enable-smart-resize (default: on)
2459 2634
2460Add smart growth/shrink behaviour when changing font size via from hot 2635Add smart growth/shrink behaviour when changing font size via hot
2461keys. This should keep in a fixed position the rxvt corner which is 2636keys. This should keep the window corner which is closest to a corner of
2462closest to a corner of the screen. 2637the screen in a fixed position.
2463 2638
2464=item --enable-pointer-blank 2639=item --enable-pointer-blank (default: on)
2465 2640
2466Add support to have the pointer disappear when typing or inactive. 2641Add support to have the pointer disappear when typing or inactive.
2467 2642
2468=item --with-name=NAME 2643=item --enable-perl (default: off)
2469 2644
2645Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2646manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2647in F<src/perl-ext/> for the extensions that are installed by default. The
2648perl interpreter that is used can be specified via the C<PERL> environment
2649variable when running configure.
2650
2651=item --with-name=NAME (default: urxvt)
2652
2470Set the basename for the installed binaries (default: C<urxvt>, resulting 2653Set the basename for the installed binaries, resulting
2471in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2654in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472C<rxvt>. 2655C<rxvt>.
2473 2656
2474=item --with-term=NAME 2657=item --with-term=NAME (default: rxvt-unicode)
2475 2658
2476Change the environmental variable for the terminal to NAME (default 2659Change the environmental variable for the terminal to NAME.
2477C<rxvt-unicode>)
2478 2660
2479=item --with-terminfo=PATH 2661=item --with-terminfo=PATH
2480 2662
2481Change the environmental variable for the path to the terminfo tree to 2663Change the environmental variable for the path to the terminfo tree to
2482PATH. 2664PATH.

Diff Legend

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