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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.48 by root, Thu Feb 17 12:00:33 2005 UTC vs.
Revision 1.73 by root, Mon Jan 9 01:54: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 aminute 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
310 450
311As you might have guessed, FreeBSD does neither define this symobl nor 451As you might have guessed, FreeBSD does neither define this symobl nor
312does it support it. Instead, it uses it's own internal representation of 452does it support it. Instead, it uses it's own internal representation of
313B<wchar_t>. This is, of course, completely fine with respect to standards. 453B<wchar_t>. This is, of course, completely fine with respect to standards.
314 454
455However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
456C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
457
315However, C<__STDC_ISO_10646__> is the only sane way to support 458C<__STDC_ISO_10646__> is the only sane way to support multi-language
316multi-language apps in an OS, as using a locale-dependent (and 459apps in an OS, as using a locale-dependent (and non-standardized)
317non-standardized) representation of B<wchar_t> makes it impossible to 460representation of B<wchar_t> makes it impossible to convert between
318convert between B<wchar_t> (as used by X11 and your applications) and any 461B<wchar_t> (as used by X11 and your applications) and any other encoding
319other encoding without implementing OS-specific-wrappers for each and 462without implementing OS-specific-wrappers for each and every locale. There
320every locale. There simply are no APIs to convert B<wchar_t> into anything 463simply are no APIs to convert B<wchar_t> into anything except the current
321except the current locale encoding. 464locale encoding.
322 465
323Some applications (such as the formidable B<mlterm>) work around this 466Some applications (such as the formidable B<mlterm>) work around this
324by carrying their own replacement functions for character set handling 467by carrying their own replacement functions for character set handling
325with them, and either implementing OS-dependent hacks or doing multiple 468with them, and either implementing OS-dependent hacks or doing multiple
326conversions (which is slow and unreliable in case the OS implements 469conversions (which is slow and unreliable in case the OS implements
327encodings slightly different than the terminal emulator). 470encodings slightly different than the terminal emulator).
328 471
329The 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
330system 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
331complete replacements for them :) 474complete replacements for them :)
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.
332 493
333=item How does rxvt-unicode determine the encoding to use? 494=item How does rxvt-unicode determine the encoding to use?
334 495
335=item Is there an option to switch encodings? 496=item Is there an option to switch encodings?
336 497
452 613
453=item Can I speed up Xft rendering somehow? 614=item Can I speed up Xft rendering somehow?
454 615
455Yes, 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
456it 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
457antialiasing (by appending C<:antialiasing=false>), which saves lots of 618antialiasing (by appending C<:antialias=false>), which saves lots of
458memory and also speeds up rendering considerably. 619memory and also speeds up rendering considerably.
459 620
460=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?
461 622
462Rxvt-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
540 URxvt.color7: #e1dddd 701 URxvt.color7: #e1dddd
541 URxvt.color15: #e1dddd 702 URxvt.color15: #e1dddd
542 703
543=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?
544 705
545Despite 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
546server that answers @@RXVT_NAME@@c's requests, so it doesn't background 707display, create the listening socket and then fork.
547itself.
548
549To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
550following method to wait for the startup message before continuing:
551
552 { @@RXVT_NAME@@d & } | read
553 708
554=item What's with the strange Backspace/Delete key behaviour? 709=item What's with the strange Backspace/Delete key behaviour?
555 710
556Assuming that the physical Backspace key corresponds to the 711Assuming that the physical Backspace key corresponds to the
557BackSpace keysym (not likely for Linux ... see the following 712BackSpace keysym (not likely for Linux ... see the following
1417 B<< C<h> >> Scroll to bottom when a key is pressed 1572 B<< C<h> >> Scroll to bottom when a key is pressed
1418 B<< C<l> >> Don't scroll to bottom when a key is pressed 1573 B<< C<l> >> Don't scroll to bottom when a key is pressed
1419 1574
1420=end table 1575=end table
1421 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)
1583
1584=end table
1585
1422=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
1423 1587
1424=begin table 1588=begin table
1425 1589
1426 B<< C<h> >> Use Alternate Screen Buffer 1590 B<< C<h> >> Use Alternate Screen Buffer
1475 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1476 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1477 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1478 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1479 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1480 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1481 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1482 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1483 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1647 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1484 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1485 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1649 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1486 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1487 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1488 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1489 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1653 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1490 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1654 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1655 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1492 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1656 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1657 B<< C<Ps = 720> >> Move viewing window up 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).
1493 1660
1494=end table 1661=end table
1495 1662
1496=back 1663=back
1497 1664
2154=end table 2321=end table
2155 2322
2156=head1 CONFIGURE OPTIONS 2323=head1 CONFIGURE OPTIONS
2157 2324
2158General hint: if you get compile errors, then likely your configuration 2325General hint: if you get compile errors, then likely your configuration
2159hasn'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
2160./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
2161so 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
2162report 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
2163<rxvt@schmorp.de>. 2330Lehmann <rxvt@schmorp.de>.
2331
2332All
2164 2333
2165=over 4 2334=over 4
2166 2335
2167=item --enable-everything 2336=item --enable-everything
2168 2337
2169Add support for all non-multichoice options listed in "./configure 2338Add (or remove) support for all non-multichoice options listed in "./configure
2170--help". Note that unlike other enable options this is order dependant. 2339--help".
2340
2171You can specify this and then disable options which this enables by 2341You can specify this and then disable options you do not like by
2172I<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.
2173 2346
2174=item --enable-xft 2347=item --enable-xft (default: enabled)
2175 2348
2176Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2349Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2177slower and require lots of memory, but as long as you don't use them, you 2350slower and require lots of memory, but as long as you don't use them, you
2178don't pay for them. 2351don't pay for them.
2179 2352
2180=item --enable-font-styles 2353=item --enable-font-styles (default: on)
2181 2354
2182Add 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
2183styles. The fonts can be set manually or automatically. 2356styles. The fonts can be set manually or automatically.
2184 2357
2185=item --with-codesets=NAME,... 2358=item --with-codesets=NAME,... (default: all)
2186 2359
2187Compile in support for additional codeset (encoding) groups (eu, vn are 2360Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2188always compiled in, which includes most 8-bit character sets). These 2361are always compiled in, which includes most 8-bit character sets). These
2189codeset tables are currently only used for driving X11 core fonts, they 2362codeset tables are used for driving X11 core fonts, they are not required
2190are not required for Xft fonts. Compiling them in will make your binary 2363for Xft fonts, although having them compiled in lets rxvt-unicode choose
2191bigger (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
2192you use an X11 font requiring one of these encodings. 2366memory usage unless you use a font requiring one of these encodings.
2193 2367
2194=begin table 2368=begin table
2195 2369
2196 all all available codeset groups 2370 all all available codeset groups
2197 zh common chinese encodings 2371 zh common chinese encodings
2200 jp_ext rarely used but big japanese encodings 2374 jp_ext rarely used but big japanese encodings
2201 kr korean encodings 2375 kr korean encodings
2202 2376
2203=end table 2377=end table
2204 2378
2205=item --enable-xim 2379=item --enable-xim (default: on)
2206 2380
2207Add support for XIM (X Input Method) protocol. This allows using 2381Add support for XIM (X Input Method) protocol. This allows using
2208alternative input methods (e.g. kinput2) and will also correctly 2382alternative input methods (e.g. kinput2) and will also correctly
2209set up the input for people using dead keys or compose keys. 2383set up the input for people using dead keys or compose keys.
2210 2384
2211=item --enable-unicode3 2385=item --enable-unicode3 (default: off)
2212 2386
2213Enable direct support for displaying unicode codepoints above 2387Enable direct support for displaying unicode codepoints above
221465535 (the basic multilingual page). This increases storage 238865535 (the basic multilingual page). This increases storage
2215requirements 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
2216support these extra characters, but Xft does. 2390support these extra characters, but Xft does.
2219even without this flag, but the number of such characters is 2393even without this flag, but the number of such characters is
2220limited to a view thousand (shared with combining characters, 2394limited to a view thousand (shared with combining characters,
2221see next switch), and right now rxvt-unicode cannot display them 2395see next switch), and right now rxvt-unicode cannot display them
2222(input/output and cut&paste still work, though). 2396(input/output and cut&paste still work, though).
2223 2397
2224=item --enable-combining 2398=item --enable-combining (default: on)
2225 2399
2226Enable automatic composition of combining characters into 2400Enable automatic composition of combining characters into
2227composite characters. This is required for proper viewing of text 2401composite characters. This is required for proper viewing of text
2228where accents are encoded as seperate unicode characters. This is 2402where accents are encoded as seperate unicode characters. This is
2229done by using precomposited characters when available or creating 2403done by using precomposited characters when available or creating
2239 2413
2240The combining table also contains entries for arabic presentation forms, 2414The combining table also contains entries for arabic presentation forms,
2241but these are not currently used. Bug me if you want these to be used (and 2415but these are not currently used. Bug me if you want these to be used (and
2242tell me how these are to be used...). 2416tell me how these are to be used...).
2243 2417
2244=item --enable-fallback(=CLASS) 2418=item --enable-fallback(=CLASS) (default: Rxvt)
2245 2419
2246When 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.
2247(default: Rxvt). To disable resource fallback use --disable-fallback.
2248 2421
2249=item --with-res-name=NAME 2422=item --with-res-name=NAME (default: urxvt)
2250 2423
2251Use the given name (default: urxvt) as default application name when 2424Use the given name as default application name when
2252reading resources. Specify --with-res-name=rxvt to replace rxvt. 2425reading resources. Specify --with-res-name=rxvt to replace rxvt.
2253 2426
2254=item --with-res-class=CLASS 2427=item --with-res-class=CLASS /default: URxvt)
2255 2428
2256Use the given class (default: URxvt) as default application class 2429Use the given class as default application class
2257when reading resources. Specify --with-res-class=Rxvt to replace 2430when reading resources. Specify --with-res-class=Rxvt to replace
2258rxvt. 2431rxvt.
2259 2432
2260=item --enable-utmp 2433=item --enable-utmp (default: on)
2261 2434
2262Write 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
2263start of rxvt execution and delete information when rxvt exits. 2436start of rxvt execution and delete information when rxvt exits.
2264 2437
2265=item --enable-wtmp 2438=item --enable-wtmp (default: on)
2266 2439
2267Write 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
2268start of rxvt execution and write logout when rxvt exits. This 2441start of rxvt execution and write logout when rxvt exits. This
2269option requires --enable-utmp to also be specified. 2442option requires --enable-utmp to also be specified.
2270 2443
2271=item --enable-lastlog 2444=item --enable-lastlog (default: on)
2272 2445
2273Write user and tty to lastlog file (used by programs like 2446Write user and tty to lastlog file (used by programs like
2274F<lastlogin>) at start of rxvt execution. This option requires 2447F<lastlogin>) at start of rxvt execution. This option requires
2275--enable-utmp to also be specified. 2448--enable-utmp to also be specified.
2276 2449
2277=item --enable-xpm-background 2450=item --enable-xpm-background (default: on)
2278 2451
2279Add support for XPM background pixmaps. 2452Add support for XPM background pixmaps.
2280 2453
2281=item --enable-transparency 2454=item --enable-transparency (default: on)
2282 2455
2283Add support for inheriting parent backgrounds thus giving a fake 2456Add support for inheriting parent backgrounds thus giving a fake
2284transparency to the term. 2457transparency to the term.
2285 2458
2286=item --enable-fading 2459=item --enable-fading (default: on)
2287 2460
2288Add support for fading the text when focus is lost. 2461Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2289 2462
2290=item --enable-tinting 2463=item --enable-tinting (default: on)
2291 2464
2292Add support for tinting of transparent backgrounds. 2465Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2293 2466
2294=item --enable-menubar 2467=item --enable-menubar (default: off) [DEPRECATED]
2295 2468
2296Add support for our menu bar system (this interacts badly with 2469Add support for our menu bar system (this interacts badly with dynamic
2297dynamic locale switching currently). 2470locale switching currently). This option is DEPRECATED and will be removed
2471in the future.
2298 2472
2299=item --enable-rxvt-scroll 2473=item --enable-rxvt-scroll (default: on)
2300 2474
2301Add support for the original rxvt scrollbar. 2475Add support for the original rxvt scrollbar.
2302 2476
2303=item --enable-next-scroll 2477=item --enable-next-scroll (default: on)
2304 2478
2305Add support for a NeXT-like scrollbar. 2479Add support for a NeXT-like scrollbar.
2306 2480
2307=item --enable-xterm-scroll 2481=item --enable-xterm-scroll (default: on)
2308 2482
2309Add support for an Xterm-like scrollbar. 2483Add support for an Xterm-like scrollbar.
2310 2484
2311=item --enable-plain-scroll 2485=item --enable-plain-scroll (default: on)
2312 2486
2313Add support for a very unobtrusive, plain-looking scrollbar that 2487Add support for a very unobtrusive, plain-looking scrollbar that
2314is the favourite of the rxvt-unicode author, having used it for 2488is the favourite of the rxvt-unicode author, having used it for
2315many years. 2489many years.
2316 2490
2317=item --enable-half-shadow 2491=item --enable-half-shadow (default: off)
2318 2492
2319Make shadows on the scrollbar only half the normal width & height. 2493Make shadows on the scrollbar only half the normal width & height.
2320only applicable to rxvt scrollbars. 2494only applicable to rxvt scrollbars.
2321 2495
2322=item --enable-ttygid 2496=item --enable-ttygid (default: off)
2323 2497
2324Change tty device setting to group "tty" - only use this if 2498Change tty device setting to group "tty" - only use this if
2325your system uses this type of security. 2499your system uses this type of security.
2326 2500
2327=item --disable-backspace-key 2501=item --disable-backspace-key
2328 2502
2329Disable 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
2330do it. 2508do it.
2331 2509
2332=item --disable-delete-key
2333
2334Disable any handling of the delete key by us - let the X server
2335do it.
2336
2337=item --disable-resources 2510=item --disable-resources
2338 2511
2339Remove all resources checking. 2512Removes any support for resource checking.
2340 2513
2341=item --enable-xgetdefault 2514=item --enable-xgetdefault
2342 2515
2343Make resources checking via XGetDefault() instead of our small 2516Make resources checking via XGetDefault() instead of our small
2344version which only checks ~/.Xdefaults, or if that doesn't exist then 2517version which only checks ~/.Xdefaults, or if that doesn't exist then
2346 2519
2347Please note that nowadays, things like XIM will automatically pull in and 2520Please note that nowadays, things like XIM will automatically pull in and
2348use the full X resource manager, so the overhead of using it might be very 2521use the full X resource manager, so the overhead of using it might be very
2349small, if nonexistant. 2522small, if nonexistant.
2350 2523
2351=item --enable-strings 2524=item --enable-strings (default: off)
2352 2525
2353Add support for our possibly faster memset() function and other 2526Add support for our possibly faster memset() function and other
2354various routines, overriding your system's versions which may 2527various routines, overriding your system's versions which may
2355have been hand-crafted in assembly or may require extra libraries 2528have been hand-crafted in assembly or may require extra libraries
2356to 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
2357GNU/Linux systems). 2530GNU/Linux systems).
2358 2531
2359=item --disable-swapscreen 2532=item --disable-swapscreen
2360 2533
2361Remove support for swap screen. 2534Remove support for secondary/swap screen.
2362 2535
2363=item --enable-frills 2536=item --enable-frills (default: on)
2364 2537
2365Add 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
2366have. 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
2367disable this. 2540disable this.
2368 2541
2369A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2542A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2370in combination with other switches) is: 2543in combination with other switches) is:
2371 2544
2372 MWM-hints 2545 MWM-hints
2546 EWMH-hints (pid, utf8 names) and protocols (ping)
2373 seperate underline colour 2547 seperate underline colour (-underlineColor)
2374 settable border widths and borderless switch 2548 settable border widths and borderless switch (-w, -b, -bl)
2375 settable extra linespacing 2549 settable extra linespacing /-lsp)
2376 extra window properties (e.g. UTF-8 window names and PID)
2377 iso-14755-2 and -3, and visual feedback 2550 iso-14755-2 and -3, and visual feedback
2378 backindex and forwardindex escape sequence 2551 backindex and forwardindex escape sequence
2379 window op and locale change escape sequences 2552 window op and some xterm/OSC escape sequences
2380 tripleclickwords 2553 tripleclickwords (-tcw)
2381 settable insecure mode 2554 settable insecure mode (-insecure)
2382 keysym remapping support 2555 keysym remapping support
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
2383 2562
2384=item --enable-iso14755 2563=item --enable-iso14755 (default: on)
2385 2564
2386Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2565Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2387F<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
2388C<--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
2389this switch. 2568this switch.
2390 2569
2391=item --enable-keepscrolling 2570=item --enable-keepscrolling (default: on)
2392 2571
2393Add support for continual scrolling of the display when you hold 2572Add support for continual scrolling of the display when you hold
2394the mouse button down on a scrollbar arrow. 2573the mouse button down on a scrollbar arrow.
2395 2574
2396=item --enable-mousewheel 2575=item --enable-mousewheel (default: on)
2397 2576
2398Add support for scrolling via mouse wheel or buttons 4 & 5. 2577Add support for scrolling via mouse wheel or buttons 4 & 5.
2399 2578
2400=item --enable-slipwheeling 2579=item --enable-slipwheeling (default: on)
2401 2580
2402Add support for continual scrolling (using the mouse wheel as an 2581Add support for continual scrolling (using the mouse wheel as an
2403accelerator) while the control key is held down. This option 2582accelerator) while the control key is held down. This option
2404requires --enable-mousewheel to also be specified. 2583requires --enable-mousewheel to also be specified.
2405 2584
2406=item --disable-new-selection 2585=item --disable-new-selection
2407 2586
2408Remove support for mouse selection style like that of xterm. 2587Remove support for mouse selection style like that of xterm.
2409 2588
2410=item --enable-dmalloc 2589=item --enable-dmalloc (default: off)
2411 2590
2412Use Gray Watson's malloc - which is good for debugging See 2591Use Gray Watson's malloc - which is good for debugging See
2413http://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
2414next 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
2415DINCLUDE and DLIB to the right places. 2594DINCLUDE and DLIB to the right places.
2416 2595
2417You can only use either this option and the following (should 2596You can only use either this option and the following (should
2418you use either) . 2597you use either) .
2419 2598
2420=item --enable-dlmalloc 2599=item --enable-dlmalloc (default: off)
2421 2600
2422Use Doug Lea's malloc - which is good for a production version 2601Use Doug Lea's malloc - which is good for a production version
2423See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2602See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2424 2603
2425=item --enable-smart-resize 2604=item --enable-smart-resize (default: on)
2426 2605
2427Add smart growth/shrink behaviour when changing font size via from hot 2606Add smart growth/shrink behaviour when changing font size via hot
2428keys. 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
2429closest to a corner of the screen. 2608the screen in a fixed position.
2430 2609
2431=item --enable-cursor-blink
2432
2433Add support for a blinking cursor.
2434
2435=item --enable-pointer-blank 2610=item --enable-pointer-blank (default: on)
2436 2611
2437Add support to have the pointer disappear when typing or inactive. 2612Add support to have the pointer disappear when typing or inactive.
2438 2613
2439=item --with-name=NAME 2614=item --enable-perl (default: off)
2440 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
2441Set the basename for the installed binaries (default: C<urxvt>, resulting 2624Set the basename for the installed binaries, resulting
2442in 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
2443C<rxvt>. 2626C<rxvt>.
2444 2627
2445=item --with-term=NAME 2628=item --with-term=NAME (default: rxvt-unicode)
2446 2629
2447Change the environmental variable for the terminal to NAME (default 2630Change the environmental variable for the terminal to NAME.
2448C<rxvt-unicode>)
2449 2631
2450=item --with-terminfo=PATH 2632=item --with-terminfo=PATH
2451 2633
2452Change the environmental variable for the path to the terminfo tree to 2634Change the environmental variable for the path to the terminfo tree to
2453PATH. 2635PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines