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.74 by root, Mon Jan 9 07:24:43 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 Isn't rxvt supposed to be small? Don't all those features bloat?
30
31I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even
35with C<--disable-everything>, this comparison is a bit unfair, as many
36features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
37already in use in this mode.
38
39 text data bss drs rss filename
40 98398 1664 24 15695 1824 rxvt --disable-everything
41 188985 9048 66616 18222 1788 urxvt --disable-everything
42
43When you C<--enable-everything> (which _is_ unfair, as this involves xft
44and full locale/XIM support which are quite bloaty inside libX11 and my
45libc), the two diverge, but not unreasnobaly so.
46
47 text data bss drs rss filename
48 163431 2152 24 20123 2060 rxvt --enable-everything
49 1035683 49680 66648 29096 3680 urxvt --enable-everything
50
51The very large size of the text section is explained by the east-asian
52encoding tables, which, if unused, take up disk space but nothing else
53and can be compiled out unless you rely on X11 core fonts that use those
54encodings. The BSS size comes from the 64k emergency buffer that my c++
55compiler allocates (but of course doesn't use unless you are out of
56memory). Also, using an xft font instead of a core font immediately adds a
57few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
58not used.
59
60Of course, due to every character using two or four bytes instead of one,
61a large scrollback buffer will ultimately make rxvt-unicode use more
62memory.
63
64Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65still fares rather well. And compared to some monsters like gnome-terminal
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*.
70
71=item Why C++, isn't that unportable/bloated/uncool?
72
73Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++.
77
78My personal stance on this is that C++ is less portable than C, but in
79the case of rxvt-unicode this hardly matters, as its portability limits
80are defined by things like X11, pseudo terminals, locale support and unix
81domain sockets, which are all less portable than C++ itself.
82
83Regarding the bloat, see the above question: It's easy to write programs
84in C that use gobs of memory, an certainly possible to write programs in
85C++ that don't. C++ also often comes with large libraries, but this is
86not necessarily the case with GCC. Here is what rxvt links against on my
87system with a minimal config:
88
89 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
90 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
91 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
92 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
93
94And here is rxvt-unicode:
95
96 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
97 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
98 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
99 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101
102No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :)
104
105=item Does it support tabs, can I have a tabbed rxvt-unicode?
106
107rxvt-unicode does not directly support tabs. It will work fine with
108tabbing functionality of many window managers or similar tabbing programs,
109and its embedding-features allow it to be embedded into other programs,
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113
29=item How do I know which rxvt-unicode version I'm using? 114=item How do I know which rxvt-unicode version I'm using?
30 115
31The version number is displayed with the usage (-h). Also the escape 116The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 117sequence C<ESC [ 8 n> sets the window title to the version number. When
118using the @@RXVT_NAME@@c client, the version displayed is that of the
119daemon.
33 120
34=item I am using Debian GNU/Linux and have a problem... 121=item I am using Debian GNU/Linux and have a problem...
35 122
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 123The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 124patches that considerably change the behaviour of rxvt-unicode. Before
38bug to the original rxvt-unicode author please download and install the 125reporting a bug to the original rxvt-unicode author please download and
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40reproduce the problem. If you cannot, chances are that the problems are 127and 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 128problems are specific to Debian GNU/Linux, in which case it should be
42Debian Bug Tracking System (use C<reportbug> to report the bug). 129reported via the Debian Bug Tracking System (use C<reportbug> to report
130the bug).
43 131
44For other problems that also affect the Debian package, you can and 132For 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 133probably 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 134bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 135might encounter the same issue.
136
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
138
139You should build one binary with the default options. F<configure>
140now enables most useful options, and the trend goes to making them
141runtime-switchable, too, so there is usually no drawback to enbaling them,
142except higher disk and possibly memory usage. The perl interpreter should
143be enabled, as important functionality (menus, selection, likely more in
144the future) depends on it.
145
146You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
147system-wide (except maybe with C<defaults>). This will result in useful
148behaviour. If your distribution aims at low memory, add an empty
149C<perl-ext-common> resource to the app-defaults file. This will keep the
150perl interpreter disabled until the user enables it.
151
152If you can/want build more binaries, I recommend building a minimal
153one with C<--disable-everything> (very useful) and a maximal one with
154C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used).
156
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158
159Likely not. While I honestly try to make it secure, and am probably
160not bad at it, I think it is simply unreasonable to expect all of
161freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice.
164
165Elevated privileges are only required for utmp and pty operations on some
166systems (for example, GNU/Linux doesn't need any extra privileges for
167ptys, but some need it for utmp support). If rxvt-unicode doesn't support
168the library/setuid helper that your OS needs I'll be happy to assist you
169in implementing support for it.
170
171So, while setuid/setgid operation is supported and not a problem on your
172typical single-user-no-other-logins unix desktop, always remember that
173its an awful lot of code, most of which isn't checked for security issues
174regularly.
48 175
49=item When I log-in to another system it tells me about missing terminfo data? 176=item When I log-in to another system it tells me about missing terminfo data?
50 177
51The terminal description used by rxvt-unicode is not as widely available 178The 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). 179as that for xterm, or even rxvt (for which the same problem often arises).
… …
71 198
72 URxvt.termName: rxvt 199 URxvt.termName: rxvt
73 200
74If you don't plan to use B<rxvt> (quite common...) you could also replace 201If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 202the rxvt terminfo file with the rxvt-unicode one.
203
204=item C<tic> outputs some error when compiling the terminfo entry.
205
206Most likely it's the empty definition for C<enacs=>. Just replace it by
207C<enacs=\E[0@> and try again.
76 208
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 209=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 210
79=item I need a termcap file entry. 211=item I need a termcap file entry.
80 212
… …
258might be forced to use a different font. 390might be forced to use a different font.
259 391
260All of this is not a problem when using X11 core fonts, as their bounding 392All of this is not a problem when using X11 core fonts, as their bounding
261box data is correct. 393box data is correct.
262 394
395=item On Solaris 9, many line-drawing characters are too wide.
396
397Seems to be a known bug, read
398L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
399following ugly workaround to get non-double-wide-characters working:
400
401 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
402
263=item My Compose (Multi_key) key is no longer working. 403=item My Compose (Multi_key) key is no longer working.
264 404
265The most common causes for this are that either your locale is not set 405The 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 406correctly, or you specified a B<preeditStyle> that is not supported by
267your input method. For example, if you specified B<OverTheSpot> and 407your input method. For example, if you specified B<OverTheSpot> and
… …
331 471
332The rxvt-unicode author insists that the right way to fix this is in the 472The 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 473system libraries once and for all, instead of forcing every app to carry
334complete replacements for them :) 474complete replacements for them :)
335 475
476=item I use Solaris 9 and it doesn't compile/work/etc.
477
478Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
479problems with C<wcwidth> and a compile problem.
480
481=item How can I use rxvt-unicode under cygwin?
482
483rxvt-unicode should compile and run out of the box on cygwin, using
484the X11 libraries that come with cygwin. libW11 emulation is no
485longer supported (and makes no sense, either, as it only supported a
486single font). I recommend starting the X-server in C<-multiwindow> or
487C<-rootless> mode instead, which will result in similar look&feel as the
488old libW11 emulation.
489
490At the time of this writing, cygwin didn't seem to support any multi-byte
491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings.
493
336=item How does rxvt-unicode determine the encoding to use? 494=item How does rxvt-unicode determine the encoding to use?
337 495
338=item Is there an option to switch encodings? 496=item Is there an option to switch encodings?
339 497
340Unlike some other terminals, rxvt-unicode has no encoding switch, and no 498Unlike some other terminals, rxvt-unicode has no encoding switch, and no
… …
455 613
456=item Can I speed up Xft rendering somehow? 614=item Can I speed up Xft rendering somehow?
457 615
458Yes, the most obvious way to speed it up is to avoid Xft entirely, as 616Yes, 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 617it is simply slow. If you still want Xft fonts you might try to disable
460antialiasing (by appending C<:antialiasing=false>), which saves lots of 618antialiasing (by appending C<:antialias=false>), which saves lots of
461memory and also speeds up rendering considerably. 619memory and also speeds up rendering considerably.
462 620
463=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 621=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
464 622
465Rxvt-unicode will use whatever you specify as a font. If it needs to 623Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
543 URxvt.color7: #e1dddd 701 URxvt.color7: #e1dddd
544 URxvt.color15: #e1dddd 702 URxvt.color15: #e1dddd
545 703
546=item How can I start @@RXVT_NAME@@d in a race-free way? 704=item How can I start @@RXVT_NAME@@d in a race-free way?
547 705
548Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 706Try 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 707display, 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 708
557=item What's with the strange Backspace/Delete key behaviour? 709=item What's with the strange Backspace/Delete key behaviour?
558 710
559Assuming that the physical Backspace key corresponds to the 711Assuming that the physical Backspace key corresponds to the
560BackSpace keysym (not likely for Linux ... see the following 712BackSpace keysym (not likely for Linux ... see the following
… …
1417 1569
1418=begin table 1570=begin table
1419 1571
1420 B<< C<h> >> Scroll to bottom when a key is pressed 1572 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 1573 B<< C<l> >> Don't scroll to bottom when a key is pressed
1574
1575=end table
1576
1577=item B<< C<Ps = 1021> >> (B<rxvt>)
1578
1579=begin table
1580
1581 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1582 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1422 1583
1423=end table 1584=end table
1424 1585
1425=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
1426 1587
… …
1493 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 1654 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). 1655 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). 1656 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). 1657 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). 1658 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1659 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1498 1660
1499=end table 1661=end table
1500 1662
1501=back 1663=back
1502 1664
… …
2159=end table 2321=end table
2160 2322
2161=head1 CONFIGURE OPTIONS 2323=head1 CONFIGURE OPTIONS
2162 2324
2163General hint: if you get compile errors, then likely your configuration 2325General hint: if you get compile errors, then likely your configuration
2164hasn't been tested well. Either try with --enable-everything or use the 2326hasn'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, 2327the 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 2328myself, 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 2329always report when a combination doesn't work, so it can be fixed. Marc
2168<rxvt@schmorp.de>. 2330Lehmann <rxvt@schmorp.de>.
2331
2332All
2169 2333
2170=over 4 2334=over 4
2171 2335
2172=item --enable-everything 2336=item --enable-everything
2173 2337
2174Add support for all non-multichoice options listed in "./configure 2338Add (or remove) support for all non-multichoice options listed in "./configure
2175--help". Note that unlike other enable options this is order dependant. 2339--help".
2340
2176You can specify this and then disable options which this enables by 2341You can specify this and then disable options you do not like by
2177I<following> this with the appropriate commands. 2342I<following> this with the appropriate C<--disable-...> arguments,
2343or you can start with a minimal configuration by specifying
2344C<--disable-everything> and than adding just the C<--enable-...> arguments
2345you want.
2178 2346
2179=item --enable-xft 2347=item --enable-xft (default: enabled)
2180 2348
2181Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2349Add 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 2350slower and require lots of memory, but as long as you don't use them, you
2183don't pay for them. 2351don't pay for them.
2184 2352
2185=item --enable-font-styles 2353=item --enable-font-styles (default: on)
2186 2354
2187Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2355Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2188styles. The fonts can be set manually or automatically. 2356styles. The fonts can be set manually or automatically.
2189 2357
2190=item --with-codesets=NAME,... 2358=item --with-codesets=NAME,... (default: all)
2191 2359
2192Compile in support for additional codeset (encoding) groups (eu, vn are 2360Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2193always compiled in, which includes most 8-bit character sets). These 2361are always compiled in, which includes most 8-bit character sets). These
2194codeset tables are currently only used for driving X11 core fonts, they 2362codeset 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 2363for Xft fonts, although having them compiled in lets rxvt-unicode choose
2196bigger (together about 700kB), but it doesn't increase memory usage unless 2364replacement fonts more intelligently. Compiling them in will make your
2365binary bigger (all of together cost about 700kB), but it doesn't increase
2197you use an X11 font requiring one of these encodings. 2366memory usage unless you use a font requiring one of these encodings.
2198 2367
2199=begin table 2368=begin table
2200 2369
2201 all all available codeset groups 2370 all all available codeset groups
2202 zh common chinese encodings 2371 zh common chinese encodings
… …
2205 jp_ext rarely used but big japanese encodings 2374 jp_ext rarely used but big japanese encodings
2206 kr korean encodings 2375 kr korean encodings
2207 2376
2208=end table 2377=end table
2209 2378
2210=item --enable-xim 2379=item --enable-xim (default: on)
2211 2380
2212Add support for XIM (X Input Method) protocol. This allows using 2381Add support for XIM (X Input Method) protocol. This allows using
2213alternative input methods (e.g. kinput2) and will also correctly 2382alternative input methods (e.g. kinput2) and will also correctly
2214set up the input for people using dead keys or compose keys. 2383set up the input for people using dead keys or compose keys.
2215 2384
2216=item --enable-unicode3 2385=item --enable-unicode3 (default: off)
2217 2386
2218Enable direct support for displaying unicode codepoints above 2387Enable direct support for displaying unicode codepoints above
221965535 (the basic multilingual page). This increases storage 238865535 (the basic multilingual page). This increases storage
2220requirements per character from 2 to 4 bytes. X11 fonts do not yet 2389requirements per character from 2 to 4 bytes. X11 fonts do not yet
2221support these extra characters, but Xft does. 2390support these extra characters, but Xft does.
… …
2224even without this flag, but the number of such characters is 2393even without this flag, but the number of such characters is
2225limited to a view thousand (shared with combining characters, 2394limited to a view thousand (shared with combining characters,
2226see next switch), and right now rxvt-unicode cannot display them 2395see next switch), and right now rxvt-unicode cannot display them
2227(input/output and cut&paste still work, though). 2396(input/output and cut&paste still work, though).
2228 2397
2229=item --enable-combining 2398=item --enable-combining (default: on)
2230 2399
2231Enable automatic composition of combining characters into 2400Enable automatic composition of combining characters into
2232composite characters. This is required for proper viewing of text 2401composite characters. This is required for proper viewing of text
2233where accents are encoded as seperate unicode characters. This is 2402where accents are encoded as seperate unicode characters. This is
2234done by using precomposited characters when available or creating 2403done by using precomposited characters when available or creating
… …
2244 2413
2245The combining table also contains entries for arabic presentation forms, 2414The 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 2415but these are not currently used. Bug me if you want these to be used (and
2247tell me how these are to be used...). 2416tell me how these are to be used...).
2248 2417
2249=item --enable-fallback(=CLASS) 2418=item --enable-fallback(=CLASS) (default: Rxvt)
2250 2419
2251When reading resource settings, also read settings for class CLASS 2420When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2252(default: Rxvt). To disable resource fallback use --disable-fallback.
2253 2421
2254=item --with-res-name=NAME 2422=item --with-res-name=NAME (default: urxvt)
2255 2423
2256Use the given name (default: urxvt) as default application name when 2424Use the given name as default application name when
2257reading resources. Specify --with-res-name=rxvt to replace rxvt. 2425reading resources. Specify --with-res-name=rxvt to replace rxvt.
2258 2426
2259=item --with-res-class=CLASS 2427=item --with-res-class=CLASS /default: URxvt)
2260 2428
2261Use the given class (default: URxvt) as default application class 2429Use the given class as default application class
2262when reading resources. Specify --with-res-class=Rxvt to replace 2430when reading resources. Specify --with-res-class=Rxvt to replace
2263rxvt. 2431rxvt.
2264 2432
2265=item --enable-utmp 2433=item --enable-utmp (default: on)
2266 2434
2267Write user and tty to utmp file (used by programs like F<w>) at 2435Write user and tty to utmp file (used by programs like F<w>) at
2268start of rxvt execution and delete information when rxvt exits. 2436start of rxvt execution and delete information when rxvt exits.
2269 2437
2270=item --enable-wtmp 2438=item --enable-wtmp (default: on)
2271 2439
2272Write user and tty to wtmp file (used by programs like F<last>) at 2440Write user and tty to wtmp file (used by programs like F<last>) at
2273start of rxvt execution and write logout when rxvt exits. This 2441start of rxvt execution and write logout when rxvt exits. This
2274option requires --enable-utmp to also be specified. 2442option requires --enable-utmp to also be specified.
2275 2443
2276=item --enable-lastlog 2444=item --enable-lastlog (default: on)
2277 2445
2278Write user and tty to lastlog file (used by programs like 2446Write user and tty to lastlog file (used by programs like
2279F<lastlogin>) at start of rxvt execution. This option requires 2447F<lastlogin>) at start of rxvt execution. This option requires
2280--enable-utmp to also be specified. 2448--enable-utmp to also be specified.
2281 2449
2282=item --enable-xpm-background 2450=item --enable-xpm-background (default: on)
2283 2451
2284Add support for XPM background pixmaps. 2452Add support for XPM background pixmaps.
2285 2453
2286=item --enable-transparency 2454=item --enable-transparency (default: on)
2287 2455
2288Add support for inheriting parent backgrounds thus giving a fake 2456Add support for inheriting parent backgrounds thus giving a fake
2289transparency to the term. 2457transparency to the term.
2290 2458
2291=item --enable-fading 2459=item --enable-fading (default: on)
2292 2460
2293Add support for fading the text when focus is lost. 2461Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2294 2462
2295=item --enable-tinting 2463=item --enable-tinting (default: on)
2296 2464
2297Add support for tinting of transparent backgrounds. 2465Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2298 2466
2299=item --enable-menubar 2467=item --enable-menubar (default: off) [DEPRECATED]
2300 2468
2301Add support for our menu bar system (this interacts badly with 2469Add support for our menu bar system (this interacts badly with dynamic
2302dynamic locale switching currently). 2470locale switching currently). This option is DEPRECATED and will be removed
2471in the future.
2303 2472
2304=item --enable-rxvt-scroll 2473=item --enable-rxvt-scroll (default: on)
2305 2474
2306Add support for the original rxvt scrollbar. 2475Add support for the original rxvt scrollbar.
2307 2476
2308=item --enable-next-scroll 2477=item --enable-next-scroll (default: on)
2309 2478
2310Add support for a NeXT-like scrollbar. 2479Add support for a NeXT-like scrollbar.
2311 2480
2312=item --enable-xterm-scroll 2481=item --enable-xterm-scroll (default: on)
2313 2482
2314Add support for an Xterm-like scrollbar. 2483Add support for an Xterm-like scrollbar.
2315 2484
2316=item --enable-plain-scroll 2485=item --enable-plain-scroll (default: on)
2317 2486
2318Add support for a very unobtrusive, plain-looking scrollbar that 2487Add support for a very unobtrusive, plain-looking scrollbar that
2319is the favourite of the rxvt-unicode author, having used it for 2488is the favourite of the rxvt-unicode author, having used it for
2320many years. 2489many years.
2321 2490
2322=item --enable-half-shadow 2491=item --enable-half-shadow (default: off)
2323 2492
2324Make shadows on the scrollbar only half the normal width & height. 2493Make shadows on the scrollbar only half the normal width & height.
2325only applicable to rxvt scrollbars. 2494only applicable to rxvt scrollbars.
2326 2495
2327=item --enable-ttygid 2496=item --enable-ttygid (default: off)
2328 2497
2329Change tty device setting to group "tty" - only use this if 2498Change tty device setting to group "tty" - only use this if
2330your system uses this type of security. 2499your system uses this type of security.
2331 2500
2332=item --disable-backspace-key 2501=item --disable-backspace-key
2333 2502
2334Disable any handling of the backspace key by us - let the X server 2503Removes any handling of the backspace key by us - let the X server do it.
2504
2505=item --disable-delete-key
2506
2507Removes any handling of the delete key by us - let the X server
2335do it. 2508do it.
2336 2509
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 2510=item --disable-resources
2343 2511
2344Remove all resources checking. 2512Removes any support for resource checking.
2345 2513
2346=item --enable-xgetdefault 2514=item --enable-xgetdefault
2347 2515
2348Make resources checking via XGetDefault() instead of our small 2516Make resources checking via XGetDefault() instead of our small
2349version which only checks ~/.Xdefaults, or if that doesn't exist then 2517version which only checks ~/.Xdefaults, or if that doesn't exist then
… …
2351 2519
2352Please note that nowadays, things like XIM will automatically pull in and 2520Please 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 2521use the full X resource manager, so the overhead of using it might be very
2354small, if nonexistant. 2522small, if nonexistant.
2355 2523
2356=item --enable-strings 2524=item --enable-strings (default: off)
2357 2525
2358Add support for our possibly faster memset() function and other 2526Add support for our possibly faster memset() function and other
2359various routines, overriding your system's versions which may 2527various routines, overriding your system's versions which may
2360have been hand-crafted in assembly or may require extra libraries 2528have been hand-crafted in assembly or may require extra libraries
2361to link in. (this breaks ANSI-C rules and has problems on many 2529to link in. (this breaks ANSI-C rules and has problems on many
2362GNU/Linux systems). 2530GNU/Linux systems).
2363 2531
2364=item --disable-swapscreen 2532=item --disable-swapscreen
2365 2533
2366Remove support for swap screen. 2534Remove support for secondary/swap screen.
2367 2535
2368=item --enable-frills 2536=item --enable-frills (default: on)
2369 2537
2370Add support for many small features that are not essential but nice to 2538Add 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 2539have. Normally you want this, but for very small binaries you may want to
2372disable this. 2540disable this.
2373 2541
2374A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2542A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2375in combination with other switches) is: 2543in combination with other switches) is:
2376 2544
2377 MWM-hints 2545 MWM-hints
2378 EWMH-hints (pid, utf8 names) and protocols (ping) 2546 EWMH-hints (pid, utf8 names) and protocols (ping)
2379 seperate underline colour 2547 seperate underline colour (-underlineColor)
2380 settable border widths and borderless switch 2548 settable border widths and borderless switch (-w, -b, -bl)
2381 settable extra linespacing 2549 settable extra linespacing /-lsp)
2382 iso-14755-2 and -3, and visual feedback 2550 iso-14755-2 and -3, and visual feedback
2383 backindex and forwardindex escape sequence 2551 backindex and forwardindex escape sequence
2384 window op and some xterm/OSC escape sequences 2552 window op and some xterm/OSC escape sequences
2385 tripleclickwords 2553 tripleclickwords (-tcw)
2386 settable insecure mode 2554 settable insecure mode (-insecure)
2387 keysym remapping support 2555 keysym remapping support
2388 -embed and -pty-fd options 2556 cursor blinking and underline cursor (-cb, -uc)
2557 XEmbed support (-embed)
2558 user-pty (-pty-fd)
2559 hold on exit (-hold)
2560 skip builtin block graphics (-sbg)
2561 sgr modes 90..97 and 100..107
2389 2562
2390=item --enable-iso14755 2563=item --enable-iso14755 (default: on)
2391 2564
2392Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2565Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2393F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2566F<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 2567C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2395this switch. 2568this switch.
2396 2569
2397=item --enable-keepscrolling 2570=item --enable-keepscrolling (default: on)
2398 2571
2399Add support for continual scrolling of the display when you hold 2572Add support for continual scrolling of the display when you hold
2400the mouse button down on a scrollbar arrow. 2573the mouse button down on a scrollbar arrow.
2401 2574
2402=item --enable-mousewheel 2575=item --enable-mousewheel (default: on)
2403 2576
2404Add support for scrolling via mouse wheel or buttons 4 & 5. 2577Add support for scrolling via mouse wheel or buttons 4 & 5.
2405 2578
2406=item --enable-slipwheeling 2579=item --enable-slipwheeling (default: on)
2407 2580
2408Add support for continual scrolling (using the mouse wheel as an 2581Add support for continual scrolling (using the mouse wheel as an
2409accelerator) while the control key is held down. This option 2582accelerator) while the control key is held down. This option
2410requires --enable-mousewheel to also be specified. 2583requires --enable-mousewheel to also be specified.
2411 2584
2412=item --disable-new-selection 2585=item --disable-new-selection
2413 2586
2414Remove support for mouse selection style like that of xterm. 2587Remove support for mouse selection style like that of xterm.
2415 2588
2416=item --enable-dmalloc 2589=item --enable-dmalloc (default: off)
2417 2590
2418Use Gray Watson's malloc - which is good for debugging See 2591Use Gray Watson's malloc - which is good for debugging See
2419http://www.letters.com/dmalloc/ for details If you use either this or the 2592http://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 2593next option, you may need to edit src/Makefile after compiling to point
2421DINCLUDE and DLIB to the right places. 2594DINCLUDE and DLIB to the right places.
2422 2595
2423You can only use either this option and the following (should 2596You can only use either this option and the following (should
2424you use either) . 2597you use either) .
2425 2598
2426=item --enable-dlmalloc 2599=item --enable-dlmalloc (default: off)
2427 2600
2428Use Doug Lea's malloc - which is good for a production version 2601Use Doug Lea's malloc - which is good for a production version
2429See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2602See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2430 2603
2431=item --enable-smart-resize 2604=item --enable-smart-resize (default: on)
2432 2605
2433Add smart growth/shrink behaviour when changing font size via from hot 2606Add smart growth/shrink behaviour when changing font size via hot
2434keys. This should keep in a fixed position the rxvt corner which is 2607keys. This should keep the window corner which is closest to a corner of
2435closest to a corner of the screen. 2608the screen in a fixed position.
2436 2609
2437=item --enable-cursor-blink
2438
2439Add support for a blinking cursor.
2440
2441=item --enable-pointer-blank 2610=item --enable-pointer-blank (default: on)
2442 2611
2443Add support to have the pointer disappear when typing or inactive. 2612Add support to have the pointer disappear when typing or inactive.
2444 2613
2445=item --with-name=NAME 2614=item --enable-perl (default: off)
2446 2615
2616Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2617manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2618in F<src/perl-ext/> for the extensions that are installed by default. The
2619perl interpreter that is used can be specified via the C<PERL> environment
2620variable when running configure.
2621
2622=item --with-name=NAME (default: urxvt)
2623
2447Set the basename for the installed binaries (default: C<urxvt>, resulting 2624Set the basename for the installed binaries, resulting
2448in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2625in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2449C<rxvt>. 2626C<rxvt>.
2450 2627
2451=item --with-term=NAME 2628=item --with-term=NAME (default: rxvt-unicode)
2452 2629
2453Change the environmental variable for the terminal to NAME (default 2630Change the environmental variable for the terminal to NAME.
2454C<rxvt-unicode>)
2455 2631
2456=item --with-terminfo=PATH 2632=item --with-terminfo=PATH
2457 2633
2458Change the environmental variable for the path to the terminfo tree to 2634Change the environmental variable for the path to the terminfo tree to
2459PATH. 2635PATH.

Diff Legend

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