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.76 by root, Wed Jan 11 19:55:34 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 not
160bad at it, I think it is simply unreasonable to expect all of freetype
161+ fontconfig + xft + xlib + perl + ... + 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. Besides, with the embedded perl
164interpreter the possibility for security problems easily multiplies.
165
166Elevated privileges are only required for utmp and pty operations on some
167systems (for example, GNU/Linux doesn't need any extra privileges for
168ptys, but some need it for utmp support). It is planned to mvoe this into
169a forked handler process, but this is not yet done.
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
354single font). I recommend starting the X-server in C<-multiwindow> or 486single font). I recommend starting the X-server in C<-multiwindow> or
355C<-rootless> mode instead, which will result in similar look&feel as the 487C<-rootless> mode instead, which will result in similar look&feel as the
356old libW11 emulation. 488old libW11 emulation.
357 489
358At the time of this writing, cygwin didn't seem to support any multi-byte 490At the time of this writing, cygwin didn't seem to support any multi-byte
359encodings, so you are likely limited to 8-bit encodings. 491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings.
360 493
361=item How does rxvt-unicode determine the encoding to use? 494=item How does rxvt-unicode determine the encoding to use?
362 495
363=item Is there an option to switch encodings? 496=item Is there an option to switch encodings?
364 497
480 613
481=item Can I speed up Xft rendering somehow? 614=item Can I speed up Xft rendering somehow?
482 615
483Yes, 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
484it 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
485antialiasing (by appending C<:antialiasing=false>), which saves lots of 618antialiasing (by appending C<:antialias=false>), which saves lots of
486memory and also speeds up rendering considerably. 619memory and also speeds up rendering considerably.
487 620
488=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?
489 622
490Rxvt-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
568 URxvt.color7: #e1dddd 701 URxvt.color7: #e1dddd
569 URxvt.color15: #e1dddd 702 URxvt.color15: #e1dddd
570 703
571=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?
572 705
573Despite 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
574server that answers @@RXVT_NAME@@c's requests, so it doesn't background 707display, 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 708
582=item What's with the strange Backspace/Delete key behaviour? 709=item What's with the strange Backspace/Delete key behaviour?
583 710
584Assuming that the physical Backspace key corresponds to the 711Assuming that the physical Backspace key corresponds to the
585BackSpace keysym (not likely for Linux ... see the following 712BackSpace keysym (not likely for Linux ... see the following
1445 B<< C<h> >> Scroll to bottom when a key is pressed 1572 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 1573 B<< C<l> >> Don't scroll to bottom when a key is pressed
1447 1574
1448=end table 1575=end table
1449 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
1450=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
1451 1587
1452=begin table 1588=begin table
1453 1589
1454 B<< C<h> >> Use Alternate Screen Buffer 1590 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)> 1636 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)> 1637 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> >> 1638 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> >> 1639 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> >> 1640 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> >> 1641 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> >> 1642 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> >> 1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1508 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1644 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> 1645 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> >>. 1646 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> >> 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> >>
1512 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> >>
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). 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).
1514 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1650 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> >> 1651 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). 1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1654 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>. 1655 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). 1656 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). 1657 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). 1658 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). 1659 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). 1660 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1661 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1523 1662
1524=end table 1663=end table
1525 1664
1526=back 1665=back
1527 1666
2184=end table 2323=end table
2185 2324
2186=head1 CONFIGURE OPTIONS 2325=head1 CONFIGURE OPTIONS
2187 2326
2188General hint: if you get compile errors, then likely your configuration 2327General hint: if you get compile errors, then likely your configuration
2189hasn't been tested well. Either try with --enable-everything or use the 2328hasn'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, 2329the 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 2330myself, 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 2331always report when a combination doesn't work, so it can be fixed. Marc
2193<rxvt@schmorp.de>. 2332Lehmann <rxvt@schmorp.de>.
2333
2334All
2194 2335
2195=over 4 2336=over 4
2196 2337
2197=item --enable-everything 2338=item --enable-everything
2198 2339
2199Add support for all non-multichoice options listed in "./configure 2340Add (or remove) support for all non-multichoice options listed in "./configure
2200--help". Note that unlike other enable options this is order dependant. 2341--help".
2342
2201You can specify this and then disable options which this enables by 2343You can specify this and then disable options you do not like by
2202I<following> this with the appropriate commands. 2344I<following> this with the appropriate C<--disable-...> arguments,
2345or you can start with a minimal configuration by specifying
2346C<--disable-everything> and than adding just the C<--enable-...> arguments
2347you want.
2203 2348
2204=item --enable-xft 2349=item --enable-xft (default: enabled)
2205 2350
2206Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2351Add 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 2352slower and require lots of memory, but as long as you don't use them, you
2208don't pay for them. 2353don't pay for them.
2209 2354
2210=item --enable-font-styles 2355=item --enable-font-styles (default: on)
2211 2356
2212Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2357Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213styles. The fonts can be set manually or automatically. 2358styles. The fonts can be set manually or automatically.
2214 2359
2215=item --with-codesets=NAME,... 2360=item --with-codesets=NAME,... (default: all)
2216 2361
2217Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2362Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218are always compiled in, which includes most 8-bit character sets). These 2363are always compiled in, which includes most 8-bit character sets). These
2219codeset tables are used for driving X11 core fonts, they are not required 2364codeset tables are used for driving X11 core fonts, they are not required
2220for Xft fonts, although having them compiled in lets rxvt-unicode choose 2365for Xft fonts, although having them compiled in lets rxvt-unicode choose
2231 jp_ext rarely used but big japanese encodings 2376 jp_ext rarely used but big japanese encodings
2232 kr korean encodings 2377 kr korean encodings
2233 2378
2234=end table 2379=end table
2235 2380
2236=item --enable-xim 2381=item --enable-xim (default: on)
2237 2382
2238Add support for XIM (X Input Method) protocol. This allows using 2383Add support for XIM (X Input Method) protocol. This allows using
2239alternative input methods (e.g. kinput2) and will also correctly 2384alternative input methods (e.g. kinput2) and will also correctly
2240set up the input for people using dead keys or compose keys. 2385set up the input for people using dead keys or compose keys.
2241 2386
2242=item --enable-unicode3 2387=item --enable-unicode3 (default: off)
2243 2388
2244Enable direct support for displaying unicode codepoints above 2389Enable direct support for displaying unicode codepoints above
224565535 (the basic multilingual page). This increases storage 239065535 (the basic multilingual page). This increases storage
2246requirements per character from 2 to 4 bytes. X11 fonts do not yet 2391requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247support these extra characters, but Xft does. 2392support these extra characters, but Xft does.
2250even without this flag, but the number of such characters is 2395even without this flag, but the number of such characters is
2251limited to a view thousand (shared with combining characters, 2396limited to a view thousand (shared with combining characters,
2252see next switch), and right now rxvt-unicode cannot display them 2397see next switch), and right now rxvt-unicode cannot display them
2253(input/output and cut&paste still work, though). 2398(input/output and cut&paste still work, though).
2254 2399
2255=item --enable-combining 2400=item --enable-combining (default: on)
2256 2401
2257Enable automatic composition of combining characters into 2402Enable automatic composition of combining characters into
2258composite characters. This is required for proper viewing of text 2403composite characters. This is required for proper viewing of text
2259where accents are encoded as seperate unicode characters. This is 2404where accents are encoded as seperate unicode characters. This is
2260done by using precomposited characters when available or creating 2405done by using precomposited characters when available or creating
2270 2415
2271The combining table also contains entries for arabic presentation forms, 2416The 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 2417but these are not currently used. Bug me if you want these to be used (and
2273tell me how these are to be used...). 2418tell me how these are to be used...).
2274 2419
2275=item --enable-fallback(=CLASS) 2420=item --enable-fallback(=CLASS) (default: Rxvt)
2276 2421
2277When reading resource settings, also read settings for class CLASS 2422When 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 2423
2280=item --with-res-name=NAME 2424=item --with-res-name=NAME (default: urxvt)
2281 2425
2282Use the given name (default: urxvt) as default application name when 2426Use the given name as default application name when
2283reading resources. Specify --with-res-name=rxvt to replace rxvt. 2427reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284 2428
2285=item --with-res-class=CLASS 2429=item --with-res-class=CLASS /default: URxvt)
2286 2430
2287Use the given class (default: URxvt) as default application class 2431Use the given class as default application class
2288when reading resources. Specify --with-res-class=Rxvt to replace 2432when reading resources. Specify --with-res-class=Rxvt to replace
2289rxvt. 2433rxvt.
2290 2434
2291=item --enable-utmp 2435=item --enable-utmp (default: on)
2292 2436
2293Write user and tty to utmp file (used by programs like F<w>) at 2437Write user and tty to utmp file (used by programs like F<w>) at
2294start of rxvt execution and delete information when rxvt exits. 2438start of rxvt execution and delete information when rxvt exits.
2295 2439
2296=item --enable-wtmp 2440=item --enable-wtmp (default: on)
2297 2441
2298Write user and tty to wtmp file (used by programs like F<last>) at 2442Write user and tty to wtmp file (used by programs like F<last>) at
2299start of rxvt execution and write logout when rxvt exits. This 2443start of rxvt execution and write logout when rxvt exits. This
2300option requires --enable-utmp to also be specified. 2444option requires --enable-utmp to also be specified.
2301 2445
2302=item --enable-lastlog 2446=item --enable-lastlog (default: on)
2303 2447
2304Write user and tty to lastlog file (used by programs like 2448Write user and tty to lastlog file (used by programs like
2305F<lastlogin>) at start of rxvt execution. This option requires 2449F<lastlogin>) at start of rxvt execution. This option requires
2306--enable-utmp to also be specified. 2450--enable-utmp to also be specified.
2307 2451
2308=item --enable-xpm-background 2452=item --enable-xpm-background (default: on)
2309 2453
2310Add support for XPM background pixmaps. 2454Add support for XPM background pixmaps.
2311 2455
2312=item --enable-transparency 2456=item --enable-transparency (default: on)
2313 2457
2314Add support for inheriting parent backgrounds thus giving a fake 2458Add support for inheriting parent backgrounds thus giving a fake
2315transparency to the term. 2459transparency to the term.
2316 2460
2317=item --enable-fading 2461=item --enable-fading (default: on)
2318 2462
2319Add support for fading the text when focus is lost. 2463Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2320 2464
2321=item --enable-tinting 2465=item --enable-tinting (default: on)
2322 2466
2323Add support for tinting of transparent backgrounds. 2467Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2324 2468
2325=item --enable-menubar 2469=item --enable-menubar (default: off) [DEPRECATED]
2326 2470
2327Add support for our menu bar system (this interacts badly with 2471Add support for our menu bar system (this interacts badly with dynamic
2328dynamic locale switching currently). 2472locale switching currently). This option is DEPRECATED and will be removed
2473in the future.
2329 2474
2330=item --enable-rxvt-scroll 2475=item --enable-rxvt-scroll (default: on)
2331 2476
2332Add support for the original rxvt scrollbar. 2477Add support for the original rxvt scrollbar.
2333 2478
2334=item --enable-next-scroll 2479=item --enable-next-scroll (default: on)
2335 2480
2336Add support for a NeXT-like scrollbar. 2481Add support for a NeXT-like scrollbar.
2337 2482
2338=item --enable-xterm-scroll 2483=item --enable-xterm-scroll (default: on)
2339 2484
2340Add support for an Xterm-like scrollbar. 2485Add support for an Xterm-like scrollbar.
2341 2486
2342=item --enable-plain-scroll 2487=item --enable-plain-scroll (default: on)
2343 2488
2344Add support for a very unobtrusive, plain-looking scrollbar that 2489Add support for a very unobtrusive, plain-looking scrollbar that
2345is the favourite of the rxvt-unicode author, having used it for 2490is the favourite of the rxvt-unicode author, having used it for
2346many years. 2491many years.
2347 2492
2348=item --enable-half-shadow 2493=item --enable-half-shadow (default: off)
2349 2494
2350Make shadows on the scrollbar only half the normal width & height. 2495Make shadows on the scrollbar only half the normal width & height.
2351only applicable to rxvt scrollbars. 2496only applicable to rxvt scrollbars.
2352 2497
2353=item --enable-ttygid 2498=item --enable-ttygid (default: off)
2354 2499
2355Change tty device setting to group "tty" - only use this if 2500Change tty device setting to group "tty" - only use this if
2356your system uses this type of security. 2501your system uses this type of security.
2357 2502
2358=item --disable-backspace-key 2503=item --disable-backspace-key
2359 2504
2360Disable any handling of the backspace key by us - let the X server 2505Removes any handling of the backspace key by us - let the X server do it.
2506
2507=item --disable-delete-key
2508
2509Removes any handling of the delete key by us - let the X server
2361do it. 2510do it.
2362 2511
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 2512=item --disable-resources
2369 2513
2370Remove all resources checking. 2514Removes any support for resource checking.
2371 2515
2372=item --enable-xgetdefault 2516=item --enable-xgetdefault
2373 2517
2374Make resources checking via XGetDefault() instead of our small 2518Make resources checking via XGetDefault() instead of our small
2375version which only checks ~/.Xdefaults, or if that doesn't exist then 2519version which only checks ~/.Xdefaults, or if that doesn't exist then
2377 2521
2378Please note that nowadays, things like XIM will automatically pull in and 2522Please 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 2523use the full X resource manager, so the overhead of using it might be very
2380small, if nonexistant. 2524small, if nonexistant.
2381 2525
2382=item --enable-strings 2526=item --enable-strings (default: off)
2383 2527
2384Add support for our possibly faster memset() function and other 2528Add support for our possibly faster memset() function and other
2385various routines, overriding your system's versions which may 2529various routines, overriding your system's versions which may
2386have been hand-crafted in assembly or may require extra libraries 2530have been hand-crafted in assembly or may require extra libraries
2387to link in. (this breaks ANSI-C rules and has problems on many 2531to link in. (this breaks ANSI-C rules and has problems on many
2388GNU/Linux systems). 2532GNU/Linux systems).
2389 2533
2390=item --disable-swapscreen 2534=item --disable-swapscreen
2391 2535
2392Remove support for swap screen. 2536Remove support for secondary/swap screen.
2393 2537
2394=item --enable-frills 2538=item --enable-frills (default: on)
2395 2539
2396Add support for many small features that are not essential but nice to 2540Add 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 2541have. Normally you want this, but for very small binaries you may want to
2398disable this. 2542disable this.
2399 2543
2400A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2544A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2401in combination with other switches) is: 2545in combination with other switches) is:
2402 2546
2403 MWM-hints 2547 MWM-hints
2404 EWMH-hints (pid, utf8 names) and protocols (ping) 2548 EWMH-hints (pid, utf8 names) and protocols (ping)
2405 seperate underline colour 2549 seperate underline colour (-underlineColor)
2406 settable border widths and borderless switch 2550 settable border widths and borderless switch (-w, -b, -bl)
2407 settable extra linespacing 2551 settable extra linespacing /-lsp)
2408 iso-14755-2 and -3, and visual feedback 2552 iso-14755-2 and -3, and visual feedback
2409 backindex and forwardindex escape sequence 2553 backindex and forwardindex escape sequence
2410 window op and some xterm/OSC escape sequences 2554 window op and some xterm/OSC escape sequences
2411 tripleclickwords 2555 tripleclickwords (-tcw)
2412 settable insecure mode 2556 settable insecure mode (-insecure)
2413 keysym remapping support 2557 keysym remapping support
2414 cursor blinking and underline cursor 2558 cursor blinking and underline cursor (-cb, -uc)
2415 -embed and -pty-fd options 2559 XEmbed support (-embed)
2560 user-pty (-pty-fd)
2561 hold on exit (-hold)
2562 skip builtin block graphics (-sbg)
2563 sgr modes 90..97 and 100..107
2416 2564
2417=item --enable-iso14755 2565=item --enable-iso14755 (default: on)
2418 2566
2419Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2567Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2420F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2568F<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 2569C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2422this switch. 2570this switch.
2423 2571
2424=item --enable-keepscrolling 2572=item --enable-keepscrolling (default: on)
2425 2573
2426Add support for continual scrolling of the display when you hold 2574Add support for continual scrolling of the display when you hold
2427the mouse button down on a scrollbar arrow. 2575the mouse button down on a scrollbar arrow.
2428 2576
2429=item --enable-mousewheel 2577=item --enable-mousewheel (default: on)
2430 2578
2431Add support for scrolling via mouse wheel or buttons 4 & 5. 2579Add support for scrolling via mouse wheel or buttons 4 & 5.
2432 2580
2433=item --enable-slipwheeling 2581=item --enable-slipwheeling (default: on)
2434 2582
2435Add support for continual scrolling (using the mouse wheel as an 2583Add support for continual scrolling (using the mouse wheel as an
2436accelerator) while the control key is held down. This option 2584accelerator) while the control key is held down. This option
2437requires --enable-mousewheel to also be specified. 2585requires --enable-mousewheel to also be specified.
2438 2586
2439=item --disable-new-selection 2587=item --disable-new-selection
2440 2588
2441Remove support for mouse selection style like that of xterm. 2589Remove support for mouse selection style like that of xterm.
2442 2590
2443=item --enable-dmalloc 2591=item --enable-dmalloc (default: off)
2444 2592
2445Use Gray Watson's malloc - which is good for debugging See 2593Use Gray Watson's malloc - which is good for debugging See
2446http://www.letters.com/dmalloc/ for details If you use either this or the 2594http://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 2595next option, you may need to edit src/Makefile after compiling to point
2448DINCLUDE and DLIB to the right places. 2596DINCLUDE and DLIB to the right places.
2449 2597
2450You can only use either this option and the following (should 2598You can only use either this option and the following (should
2451you use either) . 2599you use either) .
2452 2600
2453=item --enable-dlmalloc 2601=item --enable-dlmalloc (default: off)
2454 2602
2455Use Doug Lea's malloc - which is good for a production version 2603Use Doug Lea's malloc - which is good for a production version
2456See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2604See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457 2605
2458=item --enable-smart-resize 2606=item --enable-smart-resize (default: on)
2459 2607
2460Add smart growth/shrink behaviour when changing font size via from hot 2608Add smart growth/shrink behaviour when changing font size via hot
2461keys. This should keep in a fixed position the rxvt corner which is 2609keys. This should keep the window corner which is closest to a corner of
2462closest to a corner of the screen. 2610the screen in a fixed position.
2463 2611
2464=item --enable-pointer-blank 2612=item --enable-pointer-blank (default: on)
2465 2613
2466Add support to have the pointer disappear when typing or inactive. 2614Add support to have the pointer disappear when typing or inactive.
2467 2615
2468=item --with-name=NAME 2616=item --enable-perl (default: off)
2469 2617
2618Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2619manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2620in F<src/perl-ext/> for the extensions that are installed by default. The
2621perl interpreter that is used can be specified via the C<PERL> environment
2622variable when running configure.
2623
2624=item --with-name=NAME (default: urxvt)
2625
2470Set the basename for the installed binaries (default: C<urxvt>, resulting 2626Set the basename for the installed binaries, resulting
2471in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2627in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472C<rxvt>. 2628C<rxvt>.
2473 2629
2474=item --with-term=NAME 2630=item --with-term=NAME (default: rxvt-unicode)
2475 2631
2476Change the environmental variable for the terminal to NAME (default 2632Change the environmental variable for the terminal to NAME.
2477C<rxvt-unicode>)
2478 2633
2479=item --with-terminfo=PATH 2634=item --with-terminfo=PATH
2480 2635
2481Change the environmental variable for the path to the terminfo tree to 2636Change the environmental variable for the path to the terminfo tree to
2482PATH. 2637PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines