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.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.65 by root, Sat Dec 31 17:16:17 2005 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.
… …
72 URxvt.termName: rxvt 160 URxvt.termName: rxvt
73 161
74If you don't plan to use B<rxvt> (quite common...) you could also replace 162If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 163the rxvt terminfo file with the rxvt-unicode one.
76 164
165=item C<tic> outputs some error when compiling the terminfo entry.
166
167Most likely it's the empty definition for C<enacs=>. Just replace it by
168C<enacs=\E[0@> and try again.
169
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 170=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 171
79=item I need a termcap file entry. 172=item I need a termcap file entry.
80 173
81One reason you might want this is that some distributions or operating 174One reason you might want this is that some distributions or operating
… …
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 187 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\ 188 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:lm#0:\ 189 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 190 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 191 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 192 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 193 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 194 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 195 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
196 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
103 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 197 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ 198 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ 199 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ 200 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ 201 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ 202 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
… …
257might be forced to use a different font. 351might be forced to use a different font.
258 352
259All of this is not a problem when using X11 core fonts, as their bounding 353All of this is not a problem when using X11 core fonts, as their bounding
260box data is correct. 354box data is correct.
261 355
356=item On Solaris 9, many line-drawing characters are too wide.
357
358Seems to be a known bug, read
359L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
360following ugly workaround to get non-double-wide-characters working:
361
362 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
363
262=item My Compose (Multi_key) key is no longer working. 364=item My Compose (Multi_key) key is no longer working.
263 365
264The most common causes for this are that either your locale is not set 366The most common causes for this are that either your locale is not set
265correctly, or you specified a B<preeditStyle> that is not supported by 367correctly, or you specified a B<preeditStyle> that is not supported by
266your input method. For example, if you specified B<OverTheSpot> and 368your input method. For example, if you specified B<OverTheSpot> and
… …
309 411
310As you might have guessed, FreeBSD does neither define this symobl nor 412As you might have guessed, FreeBSD does neither define this symobl nor
311does it support it. Instead, it uses it's own internal representation of 413does it support it. Instead, it uses it's own internal representation of
312B<wchar_t>. This is, of course, completely fine with respect to standards. 414B<wchar_t>. This is, of course, completely fine with respect to standards.
313 415
416However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
417C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
418
314However, C<__STDC_ISO_10646__> is the only sane way to support 419C<__STDC_ISO_10646__> is the only sane way to support multi-language
315multi-language apps in an OS, as using a locale-dependent (and 420apps in an OS, as using a locale-dependent (and non-standardized)
316non-standardized) representation of B<wchar_t> makes it impossible to 421representation of B<wchar_t> makes it impossible to convert between
317convert between B<wchar_t> (as used by X11 and your applications) and any 422B<wchar_t> (as used by X11 and your applications) and any other encoding
318other encoding without implementing OS-specific-wrappers for each and 423without implementing OS-specific-wrappers for each and every locale. There
319every locale. There simply are no APIs to convert B<wchar_t> into anything 424simply are no APIs to convert B<wchar_t> into anything except the current
320except the current locale encoding. 425locale encoding.
321 426
322Some applications (such as the formidable B<mlterm>) work around this 427Some applications (such as the formidable B<mlterm>) work around this
323by carrying their own replacement functions for character set handling 428by carrying their own replacement functions for character set handling
324with them, and either implementing OS-dependent hacks or doing multiple 429with them, and either implementing OS-dependent hacks or doing multiple
325conversions (which is slow and unreliable in case the OS implements 430conversions (which is slow and unreliable in case the OS implements
326encodings slightly different than the terminal emulator). 431encodings slightly different than the terminal emulator).
327 432
328The rxvt-unicode author insists that the right way to fix this is in the 433The rxvt-unicode author insists that the right way to fix this is in the
329system libraries once and for all, instead of forcing every app to carry 434system libraries once and for all, instead of forcing every app to carry
330complete replacements for them :) 435complete replacements for them :)
436
437=item I use Solaris 9 and it doesn't compile/work/etc.
438
439Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
440problems with C<wcwidth> and a compile problem.
441
442=item How can I use rxvt-unicode under cygwin?
443
444rxvt-unicode should compile and run out of the box on cygwin, using
445the X11 libraries that come with cygwin. libW11 emulation is no
446longer supported (and makes no sense, either, as it only supported a
447single font). I recommend starting the X-server in C<-multiwindow> or
448C<-rootless> mode instead, which will result in similar look&feel as the
449old libW11 emulation.
450
451At the time of this writing, cygwin didn't seem to support any multi-byte
452encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
453to 8-bit encodings.
331 454
332=item How does rxvt-unicode determine the encoding to use? 455=item How does rxvt-unicode determine the encoding to use?
333 456
334=item Is there an option to switch encodings? 457=item Is there an option to switch encodings?
335 458
… …
451 574
452=item Can I speed up Xft rendering somehow? 575=item Can I speed up Xft rendering somehow?
453 576
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as 577Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455it is simply slow. If you still want Xft fonts you might try to disable 578it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of 579antialiasing (by appending C<:antialias=false>), which saves lots of
457memory and also speeds up rendering considerably. 580memory and also speeds up rendering considerably.
458 581
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 582=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460 583
461Rxvt-unicode will use whatever you specify as a font. If it needs to 584Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
539 URxvt.color7: #e1dddd 662 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd 663 URxvt.color15: #e1dddd
541 664
542=item How can I start @@RXVT_NAME@@d in a race-free way? 665=item How can I start @@RXVT_NAME@@d in a race-free way?
543 666
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 667Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
545server that answers @@RXVT_NAME@@c's requests, so it doesn't background 668display, create the listening socket and then fork.
546itself.
547
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549following method to wait for the startup message before continuing:
550
551 { @@RXVT_NAME@@d & } | read
552 669
553=item What's with the strange Backspace/Delete key behaviour? 670=item What's with the strange Backspace/Delete key behaviour?
554 671
555Assuming that the physical Backspace key corresponds to the 672Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following 673BackSpace keysym (not likely for Linux ... see the following
… …
1416 B<< C<h> >> Scroll to bottom when a key is pressed 1533 B<< C<h> >> Scroll to bottom when a key is pressed
1417 B<< C<l> >> Don't scroll to bottom when a key is pressed 1534 B<< C<l> >> Don't scroll to bottom when a key is pressed
1418 1535
1419=end table 1536=end table
1420 1537
1538=item B<< C<Ps = 1021> >> (B<rxvt>)
1539
1540=begin table
1541
1542 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1543 B<< C<l> >> Font styles have no effect on intensity.
1544
1545=end table
1546
1421=item B<< C<Ps = 1047> >> 1547=item B<< C<Ps = 1047> >>
1422 1548
1423=begin table 1549=begin table
1424 1550
1425 B<< C<h> >> Use Alternate Screen Buffer 1551 B<< C<h> >> Use Alternate Screen Buffer
… …
1474 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1600 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1601 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1602 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1477 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1603 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1478 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1604 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1479 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1605 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1480 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1606 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1607 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482 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> >> 1608 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> >>
1483 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1609 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484 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) 1610 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).
1485 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1611 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1486 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1612 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1613 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1488 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1614 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1615 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1616 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1617 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1618 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1619 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1492 1620
1493=end table 1621=end table
1494 1622
1495=back 1623=back
1496 1624
… …
2153=end table 2281=end table
2154 2282
2155=head1 CONFIGURE OPTIONS 2283=head1 CONFIGURE OPTIONS
2156 2284
2157General hint: if you get compile errors, then likely your configuration 2285General hint: if you get compile errors, then likely your configuration
2158hasn't been tested well. Either try with --enable-everything or use the 2286hasn't been tested well. Either try with C<--enable-everything> or use
2159./reconf script as a base for experiments. ./reconf is used by myself, 2287the F<./reconf> script as a base for experiments. F<./reconf> is used by
2160so it should generally be a working config. Of course, you should always 2288myself, so it should generally be a working config. Of course, you should
2161report when a combination doesn't work, so it can be fixed. Marc Lehmann 2289always report when a combination doesn't work, so it can be fixed. Marc
2162<rxvt@schmorp.de>. 2290Lehmann <rxvt@schmorp.de>.
2291
2292All
2163 2293
2164=over 4 2294=over 4
2165 2295
2166=item --enable-everything 2296=item --enable-everything
2167 2297
2168Add support for all non-multichoice options listed in "./configure 2298Add (or remove) support for all non-multichoice options listed in "./configure
2169--help". Note that unlike other enable options this is order dependant. 2299--help".
2300
2170You can specify this and then disable options which this enables by 2301You can specify this and then disable options you do not like by
2171I<following> this with the appropriate commands. 2302I<following> this with the appropriate C<--disable-...> arguments,
2303or you can start with a minimal configuration by specifying
2304C<--disable-everything> and than adding just the C<--enable-...> arguments
2305you want.
2172 2306
2173=item --enable-xft 2307=item --enable-xft (default: enabled)
2174 2308
2175Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2309Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2176slower and require lots of memory, but as long as you don't use them, you 2310slower and require lots of memory, but as long as you don't use them, you
2177don't pay for them. 2311don't pay for them.
2178 2312
2179=item --enable-font-styles 2313=item --enable-font-styles (default: on)
2180 2314
2181Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2315Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182styles. The fonts can be set manually or automatically. 2316styles. The fonts can be set manually or automatically.
2183 2317
2184=item --with-codesets=NAME,... 2318=item --with-codesets=NAME,... (default: all)
2185 2319
2186Compile in support for additional codeset (encoding) groups (eu, vn are 2320Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187always compiled in, which includes most 8-bit character sets). These 2321are always compiled in, which includes most 8-bit character sets). These
2188codeset tables are currently only used for driving X11 core fonts, they 2322codeset tables are used for driving X11 core fonts, they are not required
2189are not required for Xft fonts. Compiling them in will make your binary 2323for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190bigger (together about 700kB), but it doesn't increase memory usage unless 2324replacement fonts more intelligently. Compiling them in will make your
2325binary bigger (all of together cost about 700kB), but it doesn't increase
2191you use an X11 font requiring one of these encodings. 2326memory usage unless you use a font requiring one of these encodings.
2192 2327
2193=begin table 2328=begin table
2194 2329
2195 all all available codeset groups 2330 all all available codeset groups
2196 zh common chinese encodings 2331 zh common chinese encodings
… …
2199 jp_ext rarely used but big japanese encodings 2334 jp_ext rarely used but big japanese encodings
2200 kr korean encodings 2335 kr korean encodings
2201 2336
2202=end table 2337=end table
2203 2338
2204=item --enable-xim 2339=item --enable-xim (default: on)
2205 2340
2206Add support for XIM (X Input Method) protocol. This allows using 2341Add support for XIM (X Input Method) protocol. This allows using
2207alternative input methods (e.g. kinput2) and will also correctly 2342alternative input methods (e.g. kinput2) and will also correctly
2208set up the input for people using dead keys or compose keys. 2343set up the input for people using dead keys or compose keys.
2209 2344
2210=item --enable-unicode3 2345=item --enable-unicode3 (default: off)
2211 2346
2212Enable direct support for displaying unicode codepoints above 2347Enable direct support for displaying unicode codepoints above
221365535 (the basic multilingual page). This increases storage 234865535 (the basic multilingual page). This increases storage
2214requirements per character from 2 to 4 bytes. X11 fonts do not yet 2349requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215support these extra characters, but Xft does. 2350support these extra characters, but Xft does.
… …
2218even without this flag, but the number of such characters is 2353even without this flag, but the number of such characters is
2219limited to a view thousand (shared with combining characters, 2354limited to a view thousand (shared with combining characters,
2220see next switch), and right now rxvt-unicode cannot display them 2355see next switch), and right now rxvt-unicode cannot display them
2221(input/output and cut&paste still work, though). 2356(input/output and cut&paste still work, though).
2222 2357
2223=item --enable-combining 2358=item --enable-combining (default: on)
2224 2359
2225Enable automatic composition of combining characters into 2360Enable automatic composition of combining characters into
2226composite characters. This is required for proper viewing of text 2361composite characters. This is required for proper viewing of text
2227where accents are encoded as seperate unicode characters. This is 2362where accents are encoded as seperate unicode characters. This is
2228done by using precomposited characters when available or creating 2363done by using precomposited characters when available or creating
… …
2238 2373
2239The combining table also contains entries for arabic presentation forms, 2374The combining table also contains entries for arabic presentation forms,
2240but these are not currently used. Bug me if you want these to be used (and 2375but these are not currently used. Bug me if you want these to be used (and
2241tell me how these are to be used...). 2376tell me how these are to be used...).
2242 2377
2243=item --enable-fallback(=CLASS) 2378=item --enable-fallback(=CLASS) (default: Rxvt)
2244 2379
2245When reading resource settings, also read settings for class CLASS 2380When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2246(default: Rxvt). To disable resource fallback use --disable-fallback.
2247 2381
2248=item --with-res-name=NAME 2382=item --with-res-name=NAME (default: urxvt)
2249 2383
2250Use the given name (default: urxvt) as default application name when 2384Use the given name as default application name when
2251reading resources. Specify --with-res-name=rxvt to replace rxvt. 2385reading resources. Specify --with-res-name=rxvt to replace rxvt.
2252 2386
2253=item --with-res-class=CLASS 2387=item --with-res-class=CLASS /default: URxvt)
2254 2388
2255Use the given class (default: URxvt) as default application class 2389Use the given class as default application class
2256when reading resources. Specify --with-res-class=Rxvt to replace 2390when reading resources. Specify --with-res-class=Rxvt to replace
2257rxvt. 2391rxvt.
2258 2392
2259=item --enable-utmp 2393=item --enable-utmp (default: on)
2260 2394
2261Write user and tty to utmp file (used by programs like F<w>) at 2395Write user and tty to utmp file (used by programs like F<w>) at
2262start of rxvt execution and delete information when rxvt exits. 2396start of rxvt execution and delete information when rxvt exits.
2263 2397
2264=item --enable-wtmp 2398=item --enable-wtmp (default: on)
2265 2399
2266Write user and tty to wtmp file (used by programs like F<last>) at 2400Write user and tty to wtmp file (used by programs like F<last>) at
2267start of rxvt execution and write logout when rxvt exits. This 2401start of rxvt execution and write logout when rxvt exits. This
2268option requires --enable-utmp to also be specified. 2402option requires --enable-utmp to also be specified.
2269 2403
2270=item --enable-lastlog 2404=item --enable-lastlog (default: on)
2271 2405
2272Write user and tty to lastlog file (used by programs like 2406Write user and tty to lastlog file (used by programs like
2273F<lastlogin>) at start of rxvt execution. This option requires 2407F<lastlogin>) at start of rxvt execution. This option requires
2274--enable-utmp to also be specified. 2408--enable-utmp to also be specified.
2275 2409
2276=item --enable-xpm-background 2410=item --enable-xpm-background (default: off)
2277 2411
2278Add support for XPM background pixmaps. 2412Add support for XPM background pixmaps.
2279 2413
2280=item --enable-transparency 2414=item --enable-transparency (default: off)
2281 2415
2282Add support for inheriting parent backgrounds thus giving a fake 2416Add support for inheriting parent backgrounds thus giving a fake
2283transparency to the term. 2417transparency to the term.
2284 2418
2285=item --enable-fading 2419=item --enable-fading (default: on)
2286 2420
2287Add support for fading the text when focus is lost. 2421Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2288 2422
2289=item --enable-tinting 2423=item --enable-tinting (default: on)
2290 2424
2291Add support for tinting of transparent backgrounds. 2425Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2292 2426
2293=item --enable-menubar 2427=item --enable-menubar (default: off)
2294 2428
2295Add support for our menu bar system (this interacts badly with 2429Add support for our menu bar system (this interacts badly with
2296dynamic locale switching currently). 2430dynamic locale switching currently).
2297 2431
2298=item --enable-rxvt-scroll 2432=item --enable-rxvt-scroll (default: on)
2299 2433
2300Add support for the original rxvt scrollbar. 2434Add support for the original rxvt scrollbar.
2301 2435
2302=item --enable-next-scroll 2436=item --enable-next-scroll (default: on)
2303 2437
2304Add support for a NeXT-like scrollbar. 2438Add support for a NeXT-like scrollbar.
2305 2439
2306=item --enable-xterm-scroll 2440=item --enable-xterm-scroll (default: on)
2307 2441
2308Add support for an Xterm-like scrollbar. 2442Add support for an Xterm-like scrollbar.
2309 2443
2310=item --enable-plain-scroll 2444=item --enable-plain-scroll (default: on)
2311 2445
2312Add support for a very unobtrusive, plain-looking scrollbar that 2446Add support for a very unobtrusive, plain-looking scrollbar that
2313is the favourite of the rxvt-unicode author, having used it for 2447is the favourite of the rxvt-unicode author, having used it for
2314many years. 2448many years.
2315 2449
2316=item --enable-half-shadow 2450=item --enable-half-shadow (default: off)
2317 2451
2318Make shadows on the scrollbar only half the normal width & height. 2452Make shadows on the scrollbar only half the normal width & height.
2319only applicable to rxvt scrollbars. 2453only applicable to rxvt scrollbars.
2320 2454
2321=item --enable-ttygid 2455=item --enable-ttygid (default: off)
2322 2456
2323Change tty device setting to group "tty" - only use this if 2457Change tty device setting to group "tty" - only use this if
2324your system uses this type of security. 2458your system uses this type of security.
2325 2459
2326=item --disable-backspace-key 2460=item --disable-backspace-key
2327 2461
2328Disable any handling of the backspace key by us - let the X server 2462Removes any handling of the backspace key by us - let the X server do it.
2463
2464=item --disable-delete-key
2465
2466Removes any handling of the delete key by us - let the X server
2329do it. 2467do it.
2330 2468
2331=item --disable-delete-key
2332
2333Disable any handling of the delete key by us - let the X server
2334do it.
2335
2336=item --disable-resources 2469=item --disable-resources
2337 2470
2338Remove all resources checking. 2471Removes any support for resource checking.
2339 2472
2340=item --enable-xgetdefault 2473=item --enable-xgetdefault
2341 2474
2342Make resources checking via XGetDefault() instead of our small 2475Make resources checking via XGetDefault() instead of our small
2343version which only checks ~/.Xdefaults, or if that doesn't exist then 2476version which only checks ~/.Xdefaults, or if that doesn't exist then
… …
2345 2478
2346Please note that nowadays, things like XIM will automatically pull in and 2479Please note that nowadays, things like XIM will automatically pull in and
2347use the full X resource manager, so the overhead of using it might be very 2480use the full X resource manager, so the overhead of using it might be very
2348small, if nonexistant. 2481small, if nonexistant.
2349 2482
2350=item --enable-strings 2483=item --enable-strings (default: off)
2351 2484
2352Add support for our possibly faster memset() function and other 2485Add support for our possibly faster memset() function and other
2353various routines, overriding your system's versions which may 2486various routines, overriding your system's versions which may
2354have been hand-crafted in assembly or may require extra libraries 2487have been hand-crafted in assembly or may require extra libraries
2355to link in. (this breaks ANSI-C rules and has problems on many 2488to link in. (this breaks ANSI-C rules and has problems on many
2356GNU/Linux systems). 2489GNU/Linux systems).
2357 2490
2358=item --disable-swapscreen 2491=item --disable-swapscreen
2359 2492
2360Remove support for swap screen. 2493Remove support for secondary/swap screen.
2361 2494
2362=item --enable-frills 2495=item --enable-frills (default: on)
2363 2496
2364Add support for many small features that are not essential but nice to 2497Add support for many small features that are not essential but nice to
2365have. Normally you want this, but for very small binaries you may want to 2498have. Normally you want this, but for very small binaries you may want to
2366disable this. 2499disable this.
2367 2500
2368A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2501A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369in combination with other switches) is: 2502in combination with other switches) is:
2370 2503
2371 MWM-hints 2504 MWM-hints
2505 EWMH-hints (pid, utf8 names) and protocols (ping)
2372 seperate underline colour 2506 seperate underline colour
2373 settable border widths and borderless switch 2507 settable border widths and borderless switch
2374 settable extra linespacing 2508 settable extra linespacing
2375 extra window properties (e.g. UTF-8 window names and PID)
2376 iso-14755-2 and -3, and visual feedback 2509 iso-14755-2 and -3, and visual feedback
2377 backindex and forwardindex escape sequence 2510 backindex and forwardindex escape sequence
2378 window op and locale change escape sequences 2511 window op and some xterm/OSC escape sequences
2379 tripleclickwords 2512 tripleclickwords
2380 settable insecure mode 2513 settable insecure mode
2381 keysym remapping support 2514 keysym remapping support
2515 cursor blinking and underline cursor
2516 -embed, -pty-fd and -hold options
2382 2517
2383=item --enable-iso14755 2518=item --enable-iso14755 (default: on)
2384 2519
2385Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2520Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2521F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2387C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2522C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2388this switch. 2523this switch.
2389 2524
2390=item --enable-keepscrolling 2525=item --enable-keepscrolling (default: on)
2391 2526
2392Add support for continual scrolling of the display when you hold 2527Add support for continual scrolling of the display when you hold
2393the mouse button down on a scrollbar arrow. 2528the mouse button down on a scrollbar arrow.
2394 2529
2395=item --enable-mousewheel 2530=item --enable-mousewheel (default: on)
2396 2531
2397Add support for scrolling via mouse wheel or buttons 4 & 5. 2532Add support for scrolling via mouse wheel or buttons 4 & 5.
2398 2533
2399=item --enable-slipwheeling 2534=item --enable-slipwheeling (default: on)
2400 2535
2401Add support for continual scrolling (using the mouse wheel as an 2536Add support for continual scrolling (using the mouse wheel as an
2402accelerator) while the control key is held down. This option 2537accelerator) while the control key is held down. This option
2403requires --enable-mousewheel to also be specified. 2538requires --enable-mousewheel to also be specified.
2404 2539
2405=item --disable-new-selection 2540=item --disable-new-selection
2406 2541
2407Remove support for mouse selection style like that of xterm. 2542Remove support for mouse selection style like that of xterm.
2408 2543
2409=item --enable-dmalloc 2544=item --enable-dmalloc (default: off)
2410 2545
2411Use Gray Watson's malloc - which is good for debugging See 2546Use Gray Watson's malloc - which is good for debugging See
2412http://www.letters.com/dmalloc/ for details If you use either this or the 2547http://www.letters.com/dmalloc/ for details If you use either this or the
2413next option, you may need to edit src/Makefile after compiling to point 2548next option, you may need to edit src/Makefile after compiling to point
2414DINCLUDE and DLIB to the right places. 2549DINCLUDE and DLIB to the right places.
2415 2550
2416You can only use either this option and the following (should 2551You can only use either this option and the following (should
2417you use either) . 2552you use either) .
2418 2553
2419=item --enable-dlmalloc 2554=item --enable-dlmalloc (default: off)
2420 2555
2421Use Doug Lea's malloc - which is good for a production version 2556Use Doug Lea's malloc - which is good for a production version
2422See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2557See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2423 2558
2424=item --enable-smart-resize 2559=item --enable-smart-resize (default: on)
2425 2560
2426Add smart growth/shrink behaviour when changing font size via from hot 2561Add smart growth/shrink behaviour when changing font size via hot
2427keys. This should keep in a fixed position the rxvt corner which is 2562keys. This should keep the window corner which is closest to a corner of
2428closest to a corner of the screen. 2563the screen in a fixed position.
2429 2564
2430=item --enable-cursor-blink
2431
2432Add support for a blinking cursor.
2433
2434=item --enable-pointer-blank 2565=item --enable-pointer-blank (default: on)
2435 2566
2436Add support to have the pointer disappear when typing or inactive. 2567Add support to have the pointer disappear when typing or inactive.
2437 2568
2438=item --with-name=NAME 2569=item --with-name=NAME (default: urxvt)
2439 2570
2440Set the basename for the installed binaries (default: C<urxvt>, resulting 2571Set the basename for the installed binaries, resulting
2441in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2572in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2442C<rxvt>. 2573C<rxvt>.
2443 2574
2444=item --with-term=NAME 2575=item --with-term=NAME (default: rxvt-unicode)
2445 2576
2446Change the environmental variable for the terminal to NAME (default 2577Change the environmental variable for the terminal to NAME.
2447C<rxvt-unicode>)
2448 2578
2449=item --with-terminfo=PATH 2579=item --with-terminfo=PATH
2450 2580
2451Change the environmental variable for the path to the terminfo tree to 2581Change the environmental variable for the path to the terminfo tree to
2452PATH. 2582PATH.

Diff Legend

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