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.78 by root, Thu Jan 12 05:37: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 I don't like the new selection/popups/hotkeys/perl, how do I
30change/disable it?
31
32You can disable the perl extension completely by setting the
33B<perl-ext-common> resource to the empty string, which also keeps
34rxvt-unicode from initialising perl, saving memory.
35
36If you only want to disable specific features, you first have to
37identify which perl extension is responsible. For this, read the section
38B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
39example, to disable the B<selection-popup> and B<option-popup>, specify
40this B<perl-ext-common> resource:
41
42 URxvt.perl-ext-common: default,-selection-popup,-option-popup
43
44This will keep the default extensions, but disable the two popup
45extensions. Some extensions can also be configured, for example,
46scrollback search mode is triggered by B<M-s>. You can move it to any
47other combination either by setting the B<searchable-scrollback> resource:
48
49 URxvt.searchable-scrollback: CM-s
50
51=item Isn't rxvt supposed to be small? Don't all those features bloat?
52
53I often get asked about this, and I think, no, they didn't cause extra
54bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
55that the urxvt binary is larger (due to some encoding tables always being
56compiled in), but it actually uses less memory (RSS) after startup. Even
57with C<--disable-everything>, this comparison is a bit unfair, as many
58features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
59already in use in this mode.
60
61 text data bss drs rss filename
62 98398 1664 24 15695 1824 rxvt --disable-everything
63 188985 9048 66616 18222 1788 urxvt --disable-everything
64
65When you C<--enable-everything> (which _is_ unfair, as this involves xft
66and full locale/XIM support which are quite bloaty inside libX11 and my
67libc), the two diverge, but not unreasnobaly so.
68
69 text data bss drs rss filename
70 163431 2152 24 20123 2060 rxvt --enable-everything
71 1035683 49680 66648 29096 3680 urxvt --enable-everything
72
73The very large size of the text section is explained by the east-asian
74encoding tables, which, if unused, take up disk space but nothing else
75and can be compiled out unless you rely on X11 core fonts that use those
76encodings. The BSS size comes from the 64k emergency buffer that my c++
77compiler allocates (but of course doesn't use unless you are out of
78memory). Also, using an xft font instead of a core font immediately adds a
79few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
80not used.
81
82Of course, due to every character using two or four bytes instead of one,
83a large scrollback buffer will ultimately make rxvt-unicode use more
84memory.
85
86Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
87still fares rather well. And compared to some monsters like gnome-terminal
88(21152k + extra 4204k in separate processes) or konsole (22200k + extra
8943180k in daemons that stay around after exit, plus half a minute of
90startup time, including the hundreds of warnings it spits out), it fares
91extremely well *g*.
92
93=item Why C++, isn't that unportable/bloated/uncool?
94
95Is this a question? :) It comes up very often. The simple answer is: I had
96to write it, and C++ allowed me to write and maintain it in a fraction
97of the time and effort (which is a scarce resource for me). Put even
98shorter: It simply wouldn't exist without C++.
99
100My personal stance on this is that C++ is less portable than C, but in
101the case of rxvt-unicode this hardly matters, as its portability limits
102are defined by things like X11, pseudo terminals, locale support and unix
103domain sockets, which are all less portable than C++ itself.
104
105Regarding the bloat, see the above question: It's easy to write programs
106in C that use gobs of memory, an certainly possible to write programs in
107C++ that don't. C++ also often comes with large libraries, but this is
108not necessarily the case with GCC. Here is what rxvt links against on my
109system with a minimal config:
110
111 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
112 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
113 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
114 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
115
116And here is rxvt-unicode:
117
118 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
119 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
120 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
121 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
122 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
123
124No large bloated libraries (of course, none were linked in statically),
125except maybe libX11 :)
126
127=item Does it support tabs, can I have a tabbed rxvt-unicode?
128
129rxvt-unicode does not directly support tabs. It will work fine with
130tabbing functionality of many window managers or similar tabbing programs,
131and its embedding-features allow it to be embedded into other programs,
132as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
133module, which features a tabbed urxvt (murxvt) terminal as an example
134embedding application.
135
29=item How do I know which rxvt-unicode version I'm using? 136=item How do I know which rxvt-unicode version I'm using?
30 137
31The version number is displayed with the usage (-h). Also the escape 138The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 139sequence C<ESC [ 8 n> sets the window title to the version number. When
140using the @@RXVT_NAME@@c client, the version displayed is that of the
141daemon.
33 142
34=item I am using Debian GNU/Linux and have a problem... 143=item I am using Debian GNU/Linux and have a problem...
35 144
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 145The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 146patches that considerably change the behaviour of rxvt-unicode. Before
38bug to the original rxvt-unicode author please download and install the 147reporting a bug to the original rxvt-unicode author please download and
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 148install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40reproduce the problem. If you cannot, chances are that the problems are 149and 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 150problems are specific to Debian GNU/Linux, in which case it should be
42Debian Bug Tracking System (use C<reportbug> to report the bug). 151reported via the Debian Bug Tracking System (use C<reportbug> to report
152the bug).
43 153
44For other problems that also affect the Debian package, you can and 154For 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 155probably 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 156bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 157might encounter the same issue.
158
159=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
160
161You should build one binary with the default options. F<configure>
162now enables most useful options, and the trend goes to making them
163runtime-switchable, too, so there is usually no drawback to enbaling them,
164except higher disk and possibly memory usage. The perl interpreter should
165be enabled, as important functionality (menus, selection, likely more in
166the future) depends on it.
167
168You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
169system-wide (except maybe with C<defaults>). This will result in useful
170behaviour. If your distribution aims at low memory, add an empty
171C<perl-ext-common> resource to the app-defaults file. This will keep the
172perl interpreter disabled until the user enables it.
173
174If you can/want build more binaries, I recommend building a minimal
175one with C<--disable-everything> (very useful) and a maximal one with
176C<--enable-everything> (less useful, it will be very big due to a lot of
177encodings built-in that increase download times and are rarely used).
178
179=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
180
181Likely not. While I honestly try to make it secure, and am probably not
182bad at it, I think it is simply unreasonable to expect all of freetype
183+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
184secure. Also, rxvt-unicode disables some options when it detects that it
185runs setuid or setgid, which is not nice. Besides, with the embedded perl
186interpreter the possibility for security problems easily multiplies.
187
188Elevated privileges are only required for utmp and pty operations on some
189systems (for example, GNU/Linux doesn't need any extra privileges for
190ptys, but some need it for utmp support). It is planned to mvoe this into
191a forked handler process, but this is not yet done.
192
193So, while setuid/setgid operation is supported and not a problem on your
194typical single-user-no-other-logins unix desktop, always remember that
195its an awful lot of code, most of which isn't checked for security issues
196regularly.
48 197
49=item When I log-in to another system it tells me about missing terminfo data? 198=item When I log-in to another system it tells me about missing terminfo data?
50 199
51The terminal description used by rxvt-unicode is not as widely available 200The 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). 201as that for xterm, or even rxvt (for which the same problem often arises).
… …
71 220
72 URxvt.termName: rxvt 221 URxvt.termName: rxvt
73 222
74If you don't plan to use B<rxvt> (quite common...) you could also replace 223If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 224the rxvt terminfo file with the rxvt-unicode one.
225
226=item C<tic> outputs some error when compiling the terminfo entry.
227
228Most likely it's the empty definition for C<enacs=>. Just replace it by
229C<enacs=\E[0@> and try again.
76 230
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 231=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 232
79=item I need a termcap file entry. 233=item I need a termcap file entry.
80 234
… …
258might be forced to use a different font. 412might be forced to use a different font.
259 413
260All of this is not a problem when using X11 core fonts, as their bounding 414All of this is not a problem when using X11 core fonts, as their bounding
261box data is correct. 415box data is correct.
262 416
417=item On Solaris 9, many line-drawing characters are too wide.
418
419Seems to be a known bug, read
420L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
421following ugly workaround to get non-double-wide-characters working:
422
423 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
424
263=item My Compose (Multi_key) key is no longer working. 425=item My Compose (Multi_key) key is no longer working.
264 426
265The most common causes for this are that either your locale is not set 427The 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 428correctly, or you specified a B<preeditStyle> that is not supported by
267your input method. For example, if you specified B<OverTheSpot> and 429your input method. For example, if you specified B<OverTheSpot> and
… …
310 472
311As you might have guessed, FreeBSD does neither define this symobl nor 473As you might have guessed, FreeBSD does neither define this symobl nor
312does it support it. Instead, it uses it's own internal representation of 474does 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. 475B<wchar_t>. This is, of course, completely fine with respect to standards.
314 476
477However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
478C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
479
315However, C<__STDC_ISO_10646__> is the only sane way to support 480C<__STDC_ISO_10646__> is the only sane way to support multi-language
316multi-language apps in an OS, as using a locale-dependent (and 481apps in an OS, as using a locale-dependent (and non-standardized)
317non-standardized) representation of B<wchar_t> makes it impossible to 482representation of B<wchar_t> makes it impossible to convert between
318convert between B<wchar_t> (as used by X11 and your applications) and any 483B<wchar_t> (as used by X11 and your applications) and any other encoding
319other encoding without implementing OS-specific-wrappers for each and 484without implementing OS-specific-wrappers for each and every locale. There
320every locale. There simply are no APIs to convert B<wchar_t> into anything 485simply are no APIs to convert B<wchar_t> into anything except the current
321except the current locale encoding. 486locale encoding.
322 487
323Some applications (such as the formidable B<mlterm>) work around this 488Some applications (such as the formidable B<mlterm>) work around this
324by carrying their own replacement functions for character set handling 489by carrying their own replacement functions for character set handling
325with them, and either implementing OS-dependent hacks or doing multiple 490with them, and either implementing OS-dependent hacks or doing multiple
326conversions (which is slow and unreliable in case the OS implements 491conversions (which is slow and unreliable in case the OS implements
327encodings slightly different than the terminal emulator). 492encodings slightly different than the terminal emulator).
328 493
329The rxvt-unicode author insists that the right way to fix this is in the 494The 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 495system libraries once and for all, instead of forcing every app to carry
331complete replacements for them :) 496complete replacements for them :)
497
498=item I use Solaris 9 and it doesn't compile/work/etc.
499
500Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
501problems with C<wcwidth> and a compile problem.
502
503=item How can I use rxvt-unicode under cygwin?
504
505rxvt-unicode should compile and run out of the box on cygwin, using
506the X11 libraries that come with cygwin. libW11 emulation is no
507longer supported (and makes no sense, either, as it only supported a
508single font). I recommend starting the X-server in C<-multiwindow> or
509C<-rootless> mode instead, which will result in similar look&feel as the
510old libW11 emulation.
511
512At the time of this writing, cygwin didn't seem to support any multi-byte
513encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
514to 8-bit encodings.
332 515
333=item How does rxvt-unicode determine the encoding to use? 516=item How does rxvt-unicode determine the encoding to use?
334 517
335=item Is there an option to switch encodings? 518=item Is there an option to switch encodings?
336 519
… …
452 635
453=item Can I speed up Xft rendering somehow? 636=item Can I speed up Xft rendering somehow?
454 637
455Yes, the most obvious way to speed it up is to avoid Xft entirely, as 638Yes, 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 639it is simply slow. If you still want Xft fonts you might try to disable
457antialiasing (by appending C<:antialiasing=false>), which saves lots of 640antialiasing (by appending C<:antialias=false>), which saves lots of
458memory and also speeds up rendering considerably. 641memory and also speeds up rendering considerably.
459 642
460=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 643=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
461 644
462Rxvt-unicode will use whatever you specify as a font. If it needs to 645Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
540 URxvt.color7: #e1dddd 723 URxvt.color7: #e1dddd
541 URxvt.color15: #e1dddd 724 URxvt.color15: #e1dddd
542 725
543=item How can I start @@RXVT_NAME@@d in a race-free way? 726=item How can I start @@RXVT_NAME@@d in a race-free way?
544 727
545Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 728Try 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 729display, 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 730
554=item What's with the strange Backspace/Delete key behaviour? 731=item What's with the strange Backspace/Delete key behaviour?
555 732
556Assuming that the physical Backspace key corresponds to the 733Assuming that the physical Backspace key corresponds to the
557BackSpace keysym (not likely for Linux ... see the following 734BackSpace keysym (not likely for Linux ... see the following
… …
1417 B<< C<h> >> Scroll to bottom when a key is pressed 1594 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 1595 B<< C<l> >> Don't scroll to bottom when a key is pressed
1419 1596
1420=end table 1597=end table
1421 1598
1599=item B<< C<Ps = 1021> >> (B<rxvt>)
1600
1601=begin table
1602
1603 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1604 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1605
1606=end table
1607
1422=item B<< C<Ps = 1047> >> 1608=item B<< C<Ps = 1047> >>
1423 1609
1424=begin table 1610=begin table
1425 1611
1426 B<< C<h> >> Use Alternate Screen Buffer 1612 B<< C<h> >> Use Alternate Screen Buffer
… …
1472 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1658 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1473 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1659 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1474 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1660 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1475 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1661 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> >> 1662 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> >> 1663 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1478 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1664 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1479 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1665 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> 1666 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> 1667 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> 1668 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> >> 1669 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> >> 1670 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) 1671 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) 1672 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> >> 1673 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> >> 1674 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1675 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1676 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1489 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1677 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>. 1678 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>. 1679 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>. 1680 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1681 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1682 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1683 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1493 1684
1494=end table 1685=end table
1495 1686
1496=back 1687=back
1497 1688
… …
2154=end table 2345=end table
2155 2346
2156=head1 CONFIGURE OPTIONS 2347=head1 CONFIGURE OPTIONS
2157 2348
2158General hint: if you get compile errors, then likely your configuration 2349General hint: if you get compile errors, then likely your configuration
2159hasn't been tested well. Either try with --enable-everything or use the 2350hasn'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, 2351the 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 2352myself, 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 2353always report when a combination doesn't work, so it can be fixed. Marc
2163<rxvt@schmorp.de>. 2354Lehmann <rxvt@schmorp.de>.
2355
2356All
2164 2357
2165=over 4 2358=over 4
2166 2359
2167=item --enable-everything 2360=item --enable-everything
2168 2361
2169Add support for all non-multichoice options listed in "./configure 2362Add (or remove) support for all non-multichoice options listed in "./configure
2170--help". Note that unlike other enable options this is order dependant. 2363--help".
2364
2171You can specify this and then disable options which this enables by 2365You can specify this and then disable options you do not like by
2172I<following> this with the appropriate commands. 2366I<following> this with the appropriate C<--disable-...> arguments,
2367or you can start with a minimal configuration by specifying
2368C<--disable-everything> and than adding just the C<--enable-...> arguments
2369you want.
2173 2370
2174=item --enable-xft 2371=item --enable-xft (default: enabled)
2175 2372
2176Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2373Add 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 2374slower and require lots of memory, but as long as you don't use them, you
2178don't pay for them. 2375don't pay for them.
2179 2376
2180=item --enable-font-styles 2377=item --enable-font-styles (default: on)
2181 2378
2182Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2379Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2183styles. The fonts can be set manually or automatically. 2380styles. The fonts can be set manually or automatically.
2184 2381
2185=item --with-codesets=NAME,... 2382=item --with-codesets=NAME,... (default: all)
2186 2383
2187Compile in support for additional codeset (encoding) groups (eu, vn are 2384Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2188always compiled in, which includes most 8-bit character sets). These 2385are always compiled in, which includes most 8-bit character sets). These
2189codeset tables are currently only used for driving X11 core fonts, they 2386codeset 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 2387for Xft fonts, although having them compiled in lets rxvt-unicode choose
2191bigger (together about 700kB), but it doesn't increase memory usage unless 2388replacement fonts more intelligently. Compiling them in will make your
2389binary bigger (all of together cost about 700kB), but it doesn't increase
2192you use an X11 font requiring one of these encodings. 2390memory usage unless you use a font requiring one of these encodings.
2193 2391
2194=begin table 2392=begin table
2195 2393
2196 all all available codeset groups 2394 all all available codeset groups
2197 zh common chinese encodings 2395 zh common chinese encodings
… …
2200 jp_ext rarely used but big japanese encodings 2398 jp_ext rarely used but big japanese encodings
2201 kr korean encodings 2399 kr korean encodings
2202 2400
2203=end table 2401=end table
2204 2402
2205=item --enable-xim 2403=item --enable-xim (default: on)
2206 2404
2207Add support for XIM (X Input Method) protocol. This allows using 2405Add support for XIM (X Input Method) protocol. This allows using
2208alternative input methods (e.g. kinput2) and will also correctly 2406alternative input methods (e.g. kinput2) and will also correctly
2209set up the input for people using dead keys or compose keys. 2407set up the input for people using dead keys or compose keys.
2210 2408
2211=item --enable-unicode3 2409=item --enable-unicode3 (default: off)
2212 2410
2213Enable direct support for displaying unicode codepoints above 2411Enable direct support for displaying unicode codepoints above
221465535 (the basic multilingual page). This increases storage 241265535 (the basic multilingual page). This increases storage
2215requirements per character from 2 to 4 bytes. X11 fonts do not yet 2413requirements per character from 2 to 4 bytes. X11 fonts do not yet
2216support these extra characters, but Xft does. 2414support these extra characters, but Xft does.
… …
2219even without this flag, but the number of such characters is 2417even without this flag, but the number of such characters is
2220limited to a view thousand (shared with combining characters, 2418limited to a view thousand (shared with combining characters,
2221see next switch), and right now rxvt-unicode cannot display them 2419see next switch), and right now rxvt-unicode cannot display them
2222(input/output and cut&paste still work, though). 2420(input/output and cut&paste still work, though).
2223 2421
2224=item --enable-combining 2422=item --enable-combining (default: on)
2225 2423
2226Enable automatic composition of combining characters into 2424Enable automatic composition of combining characters into
2227composite characters. This is required for proper viewing of text 2425composite characters. This is required for proper viewing of text
2228where accents are encoded as seperate unicode characters. This is 2426where accents are encoded as seperate unicode characters. This is
2229done by using precomposited characters when available or creating 2427done by using precomposited characters when available or creating
… …
2239 2437
2240The combining table also contains entries for arabic presentation forms, 2438The 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 2439but these are not currently used. Bug me if you want these to be used (and
2242tell me how these are to be used...). 2440tell me how these are to be used...).
2243 2441
2244=item --enable-fallback(=CLASS) 2442=item --enable-fallback(=CLASS) (default: Rxvt)
2245 2443
2246When reading resource settings, also read settings for class CLASS 2444When 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 2445
2249=item --with-res-name=NAME 2446=item --with-res-name=NAME (default: urxvt)
2250 2447
2251Use the given name (default: urxvt) as default application name when 2448Use the given name as default application name when
2252reading resources. Specify --with-res-name=rxvt to replace rxvt. 2449reading resources. Specify --with-res-name=rxvt to replace rxvt.
2253 2450
2254=item --with-res-class=CLASS 2451=item --with-res-class=CLASS /default: URxvt)
2255 2452
2256Use the given class (default: URxvt) as default application class 2453Use the given class as default application class
2257when reading resources. Specify --with-res-class=Rxvt to replace 2454when reading resources. Specify --with-res-class=Rxvt to replace
2258rxvt. 2455rxvt.
2259 2456
2260=item --enable-utmp 2457=item --enable-utmp (default: on)
2261 2458
2262Write user and tty to utmp file (used by programs like F<w>) at 2459Write user and tty to utmp file (used by programs like F<w>) at
2263start of rxvt execution and delete information when rxvt exits. 2460start of rxvt execution and delete information when rxvt exits.
2264 2461
2265=item --enable-wtmp 2462=item --enable-wtmp (default: on)
2266 2463
2267Write user and tty to wtmp file (used by programs like F<last>) at 2464Write user and tty to wtmp file (used by programs like F<last>) at
2268start of rxvt execution and write logout when rxvt exits. This 2465start of rxvt execution and write logout when rxvt exits. This
2269option requires --enable-utmp to also be specified. 2466option requires --enable-utmp to also be specified.
2270 2467
2271=item --enable-lastlog 2468=item --enable-lastlog (default: on)
2272 2469
2273Write user and tty to lastlog file (used by programs like 2470Write user and tty to lastlog file (used by programs like
2274F<lastlogin>) at start of rxvt execution. This option requires 2471F<lastlogin>) at start of rxvt execution. This option requires
2275--enable-utmp to also be specified. 2472--enable-utmp to also be specified.
2276 2473
2277=item --enable-xpm-background 2474=item --enable-xpm-background (default: on)
2278 2475
2279Add support for XPM background pixmaps. 2476Add support for XPM background pixmaps.
2280 2477
2281=item --enable-transparency 2478=item --enable-transparency (default: on)
2282 2479
2283Add support for inheriting parent backgrounds thus giving a fake 2480Add support for inheriting parent backgrounds thus giving a fake
2284transparency to the term. 2481transparency to the term.
2285 2482
2286=item --enable-fading 2483=item --enable-fading (default: on)
2287 2484
2288Add support for fading the text when focus is lost. 2485Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2289 2486
2290=item --enable-tinting 2487=item --enable-tinting (default: on)
2291 2488
2292Add support for tinting of transparent backgrounds. 2489Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2293 2490
2294=item --enable-menubar 2491=item --enable-menubar (default: off) [DEPRECATED]
2295 2492
2296Add support for our menu bar system (this interacts badly with 2493Add support for our menu bar system (this interacts badly with dynamic
2297dynamic locale switching currently). 2494locale switching currently). This option is DEPRECATED and will be removed
2495in the future.
2298 2496
2299=item --enable-rxvt-scroll 2497=item --enable-rxvt-scroll (default: on)
2300 2498
2301Add support for the original rxvt scrollbar. 2499Add support for the original rxvt scrollbar.
2302 2500
2303=item --enable-next-scroll 2501=item --enable-next-scroll (default: on)
2304 2502
2305Add support for a NeXT-like scrollbar. 2503Add support for a NeXT-like scrollbar.
2306 2504
2307=item --enable-xterm-scroll 2505=item --enable-xterm-scroll (default: on)
2308 2506
2309Add support for an Xterm-like scrollbar. 2507Add support for an Xterm-like scrollbar.
2310 2508
2311=item --enable-plain-scroll 2509=item --enable-plain-scroll (default: on)
2312 2510
2313Add support for a very unobtrusive, plain-looking scrollbar that 2511Add support for a very unobtrusive, plain-looking scrollbar that
2314is the favourite of the rxvt-unicode author, having used it for 2512is the favourite of the rxvt-unicode author, having used it for
2315many years. 2513many years.
2316 2514
2317=item --enable-half-shadow 2515=item --enable-half-shadow (default: off)
2318 2516
2319Make shadows on the scrollbar only half the normal width & height. 2517Make shadows on the scrollbar only half the normal width & height.
2320only applicable to rxvt scrollbars. 2518only applicable to rxvt scrollbars.
2321 2519
2322=item --enable-ttygid 2520=item --enable-ttygid (default: off)
2323 2521
2324Change tty device setting to group "tty" - only use this if 2522Change tty device setting to group "tty" - only use this if
2325your system uses this type of security. 2523your system uses this type of security.
2326 2524
2327=item --disable-backspace-key 2525=item --disable-backspace-key
2328 2526
2329Disable any handling of the backspace key by us - let the X server 2527Removes any handling of the backspace key by us - let the X server do it.
2528
2529=item --disable-delete-key
2530
2531Removes any handling of the delete key by us - let the X server
2330do it. 2532do it.
2331 2533
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 2534=item --disable-resources
2338 2535
2339Remove all resources checking. 2536Removes any support for resource checking.
2340 2537
2341=item --enable-xgetdefault 2538=item --enable-strings (default: off)
2342
2343Make resources checking via XGetDefault() instead of our small
2344version which only checks ~/.Xdefaults, or if that doesn't exist then
2345~/.Xresources.
2346
2347Please 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
2349small, if nonexistant.
2350
2351=item --enable-strings
2352 2539
2353Add support for our possibly faster memset() function and other 2540Add support for our possibly faster memset() function and other
2354various routines, overriding your system's versions which may 2541various routines, overriding your system's versions which may
2355have been hand-crafted in assembly or may require extra libraries 2542have been hand-crafted in assembly or may require extra libraries
2356to link in. (this breaks ANSI-C rules and has problems on many 2543to link in. (this breaks ANSI-C rules and has problems on many
2357GNU/Linux systems). 2544GNU/Linux systems).
2358 2545
2359=item --disable-swapscreen 2546=item --disable-swapscreen
2360 2547
2361Remove support for swap screen. 2548Remove support for secondary/swap screen.
2362 2549
2363=item --enable-frills 2550=item --enable-frills (default: on)
2364 2551
2365Add support for many small features that are not essential but nice to 2552Add 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 2553have. Normally you want this, but for very small binaries you may want to
2367disable this. 2554disable this.
2368 2555
2369A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2556A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2370in combination with other switches) is: 2557in combination with other switches) is:
2371 2558
2372 MWM-hints 2559 MWM-hints
2560 EWMH-hints (pid, utf8 names) and protocols (ping)
2373 seperate underline colour 2561 seperate underline colour (-underlineColor)
2374 settable border widths and borderless switch 2562 settable border widths and borderless switch (-w, -b, -bl)
2375 settable extra linespacing 2563 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 2564 iso-14755-2 and -3, and visual feedback
2378 backindex and forwardindex escape sequence 2565 backindex and forwardindex escape sequence
2379 window op and locale change escape sequences 2566 window op and some xterm/OSC escape sequences
2380 tripleclickwords 2567 tripleclickwords (-tcw)
2381 settable insecure mode 2568 settable insecure mode (-insecure)
2382 keysym remapping support 2569 keysym remapping support
2570 cursor blinking and underline cursor (-cb, -uc)
2571 XEmbed support (-embed)
2572 user-pty (-pty-fd)
2573 hold on exit (-hold)
2574 skip builtin block graphics (-sbg)
2575 sgr modes 90..97 and 100..107
2383 2576
2384=item --enable-iso14755 2577=item --enable-iso14755 (default: on)
2385 2578
2386Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2579Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2387F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2580F<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 2581C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2389this switch. 2582this switch.
2390 2583
2391=item --enable-keepscrolling 2584=item --enable-keepscrolling (default: on)
2392 2585
2393Add support for continual scrolling of the display when you hold 2586Add support for continual scrolling of the display when you hold
2394the mouse button down on a scrollbar arrow. 2587the mouse button down on a scrollbar arrow.
2395 2588
2396=item --enable-mousewheel 2589=item --enable-mousewheel (default: on)
2397 2590
2398Add support for scrolling via mouse wheel or buttons 4 & 5. 2591Add support for scrolling via mouse wheel or buttons 4 & 5.
2399 2592
2400=item --enable-slipwheeling 2593=item --enable-slipwheeling (default: on)
2401 2594
2402Add support for continual scrolling (using the mouse wheel as an 2595Add support for continual scrolling (using the mouse wheel as an
2403accelerator) while the control key is held down. This option 2596accelerator) while the control key is held down. This option
2404requires --enable-mousewheel to also be specified. 2597requires --enable-mousewheel to also be specified.
2405 2598
2406=item --disable-new-selection 2599=item --disable-new-selection
2407 2600
2408Remove support for mouse selection style like that of xterm. 2601Remove support for mouse selection style like that of xterm.
2409 2602
2410=item --enable-dmalloc 2603=item --enable-dmalloc (default: off)
2411 2604
2412Use Gray Watson's malloc - which is good for debugging See 2605Use Gray Watson's malloc - which is good for debugging See
2413http://www.letters.com/dmalloc/ for details If you use either this or the 2606http://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 2607next option, you may need to edit src/Makefile after compiling to point
2415DINCLUDE and DLIB to the right places. 2608DINCLUDE and DLIB to the right places.
2416 2609
2417You can only use either this option and the following (should 2610You can only use either this option and the following (should
2418you use either) . 2611you use either) .
2419 2612
2420=item --enable-dlmalloc 2613=item --enable-dlmalloc (default: off)
2421 2614
2422Use Doug Lea's malloc - which is good for a production version 2615Use Doug Lea's malloc - which is good for a production version
2423See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2616See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2424 2617
2425=item --enable-smart-resize 2618=item --enable-smart-resize (default: on)
2426 2619
2427Add smart growth/shrink behaviour when changing font size via from hot 2620Add smart growth/shrink behaviour when changing font size via hot
2428keys. This should keep in a fixed position the rxvt corner which is 2621keys. This should keep the window corner which is closest to a corner of
2429closest to a corner of the screen. 2622the screen in a fixed position.
2430 2623
2431=item --enable-cursor-blink
2432
2433Add support for a blinking cursor.
2434
2435=item --enable-pointer-blank 2624=item --enable-pointer-blank (default: on)
2436 2625
2437Add support to have the pointer disappear when typing or inactive. 2626Add support to have the pointer disappear when typing or inactive.
2438 2627
2439=item --with-name=NAME 2628=item --enable-perl (default: off)
2440 2629
2630Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2631manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2632in F<src/perl-ext/> for the extensions that are installed by default. The
2633perl interpreter that is used can be specified via the C<PERL> environment
2634variable when running configure.
2635
2636=item --with-name=NAME (default: urxvt)
2637
2441Set the basename for the installed binaries (default: C<urxvt>, resulting 2638Set the basename for the installed binaries, resulting
2442in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2639in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2443C<rxvt>. 2640C<rxvt>.
2444 2641
2445=item --with-term=NAME 2642=item --with-term=NAME (default: rxvt-unicode)
2446 2643
2447Change the environmental variable for the terminal to NAME (default 2644Change the environmental variable for the terminal to NAME.
2448C<rxvt-unicode>)
2449 2645
2450=item --with-terminfo=PATH 2646=item --with-terminfo=PATH
2451 2647
2452Change the environmental variable for the path to the terminfo tree to 2648Change the environmental variable for the path to the terminfo tree to
2453PATH. 2649PATH.

Diff Legend

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