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

Comparing rxvt-unicode/doc/rxvt.7.txt (file contents):
Revision 1.24 by root, Tue Oct 25 20:04:59 2005 UTC vs.
Revision 1.42 by root, Thu Jan 12 23:16:31 2006 UTC

… …
18 The newest version of this document is also available on the World Wide 18 The newest version of this document is also available on the World Wide
19 Web at 19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 21
22FREQUENTLY ASKED QUESTIONS 22FREQUENTLY ASKED QUESTIONS
23 The new selection selects pieces that are too big, how can I select
24 single words?
25 Yes. For example, if you want to select alphanumeric words, you can
26 use the following resource:
27
28 URxvt.selection.pattern-0: ([[:word:]]+)
29
30 If you click more than twice, the selection will be extended more
31 and more.
32
33 To get a selection that is very similar to the old code, try this
34 pattern:
35
36 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
37
38 Please also note that the *LeftClick Shift-LeftClik* combination
39 also selects words like the old code.
40
41 I don't like the new selection/popups/hotkeys/perl, how do I
42 change/disable it?
43 You can disable the perl extension completely by setting the
44 perl-ext-common resource to the empty string, which also keeps
45 rxvt-unicode from initialising perl, saving memory.
46
47 If you only want to disable specific features, you first have to
48 identify which perl extension is responsible. For this, read the
49 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
50 example, to disable the selection-popup and option-popup, specify
51 this perl-ext-common resource:
52
53 URxvt.perl-ext-common: default,-selection-popup,-option-popup
54
55 This will keep the default extensions, but disable the two popup
56 extensions. Some extensions can also be configured, for example,
57 scrollback search mode is triggered by M-s. You can move it to any
58 other combination either by setting the searchable-scrollback
59 resource:
60
61 URxvt.searchable-scrollback: CM-s
62
63 Isn't rxvt supposed to be small? Don't all those features bloat?
64 I often get asked about this, and I think, no, they didn't cause
65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
66 can see that the urxvt binary is larger (due to some encoding tables
67 always being compiled in), but it actually uses less memory (RSS)
68 after startup. Even with "--disable-everything", this comparison is
69 a bit unfair, as many features unique to urxvt (locale, encoding
70 conversion, iso14755 etc.) are already in use in this mode.
71
72 text data bss drs rss filename
73 98398 1664 24 15695 1824 rxvt --disable-everything
74 188985 9048 66616 18222 1788 urxvt --disable-everything
75
76 When you "--enable-everything" (which _is_ unfair, as this involves
77 xft and full locale/XIM support which are quite bloaty inside libX11
78 and my libc), the two diverge, but not unreasnobaly so.
79
80 text data bss drs rss filename
81 163431 2152 24 20123 2060 rxvt --enable-everything
82 1035683 49680 66648 29096 3680 urxvt --enable-everything
83
84 The very large size of the text section is explained by the
85 east-asian encoding tables, which, if unused, take up disk space but
86 nothing else and can be compiled out unless you rely on X11 core
87 fonts that use those encodings. The BSS size comes from the 64k
88 emergency buffer that my c++ compiler allocates (but of course
89 doesn't use unless you are out of memory). Also, using an xft font
90 instead of a core font immediately adds a few megabytes of RSS. Xft
91 indeed is responsible for a lot of RSS even when not used.
92
93 Of course, due to every character using two or four bytes instead of
94 one, a large scrollback buffer will ultimately make rxvt-unicode use
95 more memory.
96
97 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
98 this still fares rather well. And compared to some monsters like
99 gnome-terminal (21152k + extra 4204k in separate processes) or
100 konsole (22200k + extra 43180k in daemons that stay around after
101 exit, plus half a minute of startup time, including the hundreds of
102 warnings it spits out), it fares extremely well *g*.
103
104 Why C++, isn't that unportable/bloated/uncool?
105 Is this a question? :) It comes up very often. The simple answer is:
106 I had to write it, and C++ allowed me to write and maintain it in a
107 fraction of the time and effort (which is a scarce resource for me).
108 Put even shorter: It simply wouldn't exist without C++.
109
110 My personal stance on this is that C++ is less portable than C, but
111 in the case of rxvt-unicode this hardly matters, as its portability
112 limits are defined by things like X11, pseudo terminals, locale
113 support and unix domain sockets, which are all less portable than
114 C++ itself.
115
116 Regarding the bloat, see the above question: It's easy to write
117 programs in C that use gobs of memory, an certainly possible to
118 write programs in C++ that don't. C++ also often comes with large
119 libraries, but this is not necessarily the case with GCC. Here is
120 what rxvt links against on my system with a minimal config:
121
122 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
123 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
124 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
125 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
126
127 And here is rxvt-unicode:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
131 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
132 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
133 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
134
135 No large bloated libraries (of course, none were linked in
136 statically), except maybe libX11 :)
137
138 Does it support tabs, can I have a tabbed rxvt-unicode?
139 rxvt-unicode does not directly support tabs. It will work fine with
140 tabbing functionality of many window managers or similar tabbing
141 programs, and its embedding-features allow it to be embedded into
142 other programs, as witnessed by doc/rxvt-tabbed or the upcoming
143 "Gtk2::URxvt" perl module, which features a tabbed urxvt (murxvt)
144 terminal as an example embedding application.
145
23 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape 147 The version number is displayed with the usage (-h). Also the escape
25 sequence "ESC [ 8 n" sets the window title to the version number. 148 sequence "ESC [ 8 n" sets the window title to the version number.
149 When using the rxvtc client, the version displayed is that of the
150 daemon.
26 151
27 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode in sarge contains large 153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
29 patches that considerably change the behaviour of rxvt-unicode. 154 patches that considerably change the behaviour of rxvt-unicode.
30 Before reporting a bug to the original rxvt-unicode author please 155 Before reporting a bug to the original rxvt-unicode author please
… …
36 161
37 For other problems that also affect the Debian package, you can and 162 For other problems that also affect the Debian package, you can and
38 probably should use the Debian BTS, too, because, after all, it's 163 probably should use the Debian BTS, too, because, after all, it's
39 also a bug in the Debian version and it serves as a reminder for 164 also a bug in the Debian version and it serves as a reminder for
40 other users that might encounter the same issue. 165 other users that might encounter the same issue.
166
167 I am maintaining rxvt-unicode for distribution/OS XXX, any
168 recommendation?
169 You should build one binary with the default options. configure now
170 enables most useful options, and the trend goes to making them
171 runtime-switchable, too, so there is usually no drawback to enbaling
172 them, except higher disk and possibly memory usage. The perl
173 interpreter should be enabled, as important functionality (menus,
174 selection, likely more in the future) depends on it.
175
176 You should not overwrite the "perl-ext-common" snd "perl-ext"
177 resources system-wide (except maybe with "defaults"). This will
178 result in useful behaviour. If your distribution aims at low memory,
179 add an empty "perl-ext-common" resource to the app-defaults file.
180 This will keep the perl interpreter disabled until the user enables
181 it.
182
183 If you can/want build more binaries, I recommend building a minimal
184 one with "--disable-everything" (very useful) and a maximal one with
185 "--enable-everything" (less useful, it will be very big due to a lot
186 of encodings built-in that increase download times and are rarely
187 used).
188
189 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
190 safe?
191 Likely not. While I honestly try to make it secure, and am probably
192 not bad at it, I think it is simply unreasonable to expect all of
193 freetype + fontconfig + xft + xlib + perl + ... + rxvt-unicode
194 itself to all be secure. Also, rxvt-unicode disables some options
195 when it detects that it runs setuid or setgid, which is not nice.
196 Besides, with the embedded perl interpreter the possibility for
197 security problems easily multiplies.
198
199 Elevated privileges are only required for utmp and pty operations on
200 some systems (for example, GNU/Linux doesn't need any extra
201 privileges for ptys, but some need it for utmp support). It is
202 planned to mvoe this into a forked handler process, but this is not
203 yet done.
204
205 So, while setuid/setgid operation is supported and not a problem on
206 your typical single-user-no-other-logins unix desktop, always
207 remember that its an awful lot of code, most of which isn't checked
208 for security issues regularly.
41 209
42 When I log-in to another system it tells me about missing terminfo data? 210 When I log-in to another system it tells me about missing terminfo data?
43 The terminal description used by rxvt-unicode is not as widely 211 The terminal description used by rxvt-unicode is not as widely
44 available as that for xterm, or even rxvt (for which the same 212 available as that for xterm, or even rxvt (for which the same
45 problem often arises). 213 problem often arises).
… …
1146 1314
1147 "Ps = 1011" (rxvt) 1315 "Ps = 1011" (rxvt)
1148 h Scroll to bottom when a key is pressed 1316 h Scroll to bottom when a key is pressed
1149 l Don't scroll to bottom when a key is pressed 1317 l Don't scroll to bottom when a key is pressed
1150 1318
1319 "Ps = 1021" (rxvt)
1320 h Bold/italic implies high intensity (see option -is)
1321 l Font styles have no effect on intensity (Compile styles)
1322
1151 "Ps = 1047" 1323 "Ps = 1047"
1152 h Use Alternate Screen Buffer 1324 h Use Alternate Screen Buffer
1153 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1325 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1154 1326
1155 "Ps = 1048" 1327 "Ps = 1048"
… …
1177 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1349 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1178 Ps = 11 Change colour of text background to Pt (NB: may change in future) 1350 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1179 Ps = 12 Change colour of text cursor foreground to Pt 1351 Ps = 12 Change colour of text cursor foreground to Pt
1180 Ps = 13 Change colour of mouse foreground to Pt 1352 Ps = 13 Change colour of mouse foreground to Pt
1181 Ps = 17 Change colour of highlight characters to Pt 1353 Ps = 17 Change colour of highlight characters to Pt
1182 Ps = 18 Change colour of bold characters to Pt 1354 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1183 Ps = 19 Change colour of underlined characters to Pt 1355 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1184 Ps = 20 Change default background to Pt 1356 Ps = 20 Change default background to Pt
1185 Ps = 39 Change default foreground colour to Pt. 1357 Ps = 39 Change default foreground colour to Pt.
1186 Ps = 46 Change Log File to Pt unimplemented 1358 Ps = 46 Change Log File to Pt unimplemented
1187 Ps = 49 Change default background colour to Pt. 1359 Ps = 49 Change default background colour to Pt.
1188 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1360 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1189 Ps = 55 Log all scrollback buffer and all of screen to Pt 1361 Ps = 55 Log all scrollback buffer and all of screen to Pt
1190 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1362 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1191 Ps = 703 Menubar command Pt (Compile menubar). 1363 Ps = 703 Menubar command Pt (Compile menubar).
1192 Ps = 704 Change colour of italic characters to Pt 1364 Ps = 704 Change colour of italic characters to Pt
1193 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1365 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1366 Ps = 706 Change colour of bold characters to Pt
1367 Ps = 707 Change colour of underlined characters to Pt
1194 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1368 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1195 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1369 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1196 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1370 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1197 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1371 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1198 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1372 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1199 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1373 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1374 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1200 1375
1201 1376
1202 1377
1203menuBar 1378menuBar
1204 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1379 The exact syntax used is *almost* solidified. In the menus, DON'T try to
… …
1775 --enable-lastlog (default: on) 1950 --enable-lastlog (default: on)
1776 Write user and tty to lastlog file (used by programs like lastlogin) 1951 Write user and tty to lastlog file (used by programs like lastlogin)
1777 at start of rxvt execution. This option requires --enable-utmp to 1952 at start of rxvt execution. This option requires --enable-utmp to
1778 also be specified. 1953 also be specified.
1779 1954
1780 --enable-xpm-background (default: off) 1955 --enable-xpm-background (default: on)
1781 Add support for XPM background pixmaps. 1956 Add support for XPM background pixmaps.
1782 1957
1783 --enable-transparency (default: off) 1958 --enable-transparency (default: on)
1784 Add support for inheriting parent backgrounds thus giving a fake 1959 Add support for inheriting parent backgrounds thus giving a fake
1785 transparency to the term. 1960 transparency to the term.
1786 1961
1787 --enable-fading (default: on) 1962 --enable-fading (default: on)
1788 Add support for fading the text when focus is lost (requires 1963 Add support for fading the text when focus is lost (requires
… …
1790 1965
1791 --enable-tinting (default: on) 1966 --enable-tinting (default: on)
1792 Add support for tinting of transparent backgrounds (requires 1967 Add support for tinting of transparent backgrounds (requires
1793 "--enable-transparency"). 1968 "--enable-transparency").
1794 1969
1795 --enable-menubar (default: off) 1970 --enable-menubar (default: off) [DEPRECATED]
1796 Add support for our menu bar system (this interacts badly with 1971 Add support for our menu bar system (this interacts badly with
1797 dynamic locale switching currently). 1972 dynamic locale switching currently). This option is DEPRECATED and
1973 will be removed in the future.
1798 1974
1799 --enable-rxvt-scroll (default: on) 1975 --enable-rxvt-scroll (default: on)
1800 Add support for the original rxvt scrollbar. 1976 Add support for the original rxvt scrollbar.
1801 1977
1802 --enable-next-scroll (default: on) 1978 --enable-next-scroll (default: on)
… …
1826 Removes any handling of the delete key by us - let the X server do 2002 Removes any handling of the delete key by us - let the X server do
1827 it. 2003 it.
1828 2004
1829 --disable-resources 2005 --disable-resources
1830 Removes any support for resource checking. 2006 Removes any support for resource checking.
1831
1832 --enable-xgetdefault
1833 Make resources checking via XGetDefault() instead of our small
1834 version which only checks ~/.Xdefaults, or if that doesn't exist
1835 then ~/.Xresources.
1836
1837 Please note that nowadays, things like XIM will automatically pull
1838 in and use the full X resource manager, so the overhead of using it
1839 might be very small, if nonexistant.
1840 2007
1841 --enable-strings (default: off) 2008 --enable-strings (default: off)
1842 Add support for our possibly faster memset() function and other 2009 Add support for our possibly faster memset() function and other
1843 various routines, overriding your system's versions which may have 2010 various routines, overriding your system's versions which may have
1844 been hand-crafted in assembly or may require extra libraries to link 2011 been hand-crafted in assembly or may require extra libraries to link
… …
1856 A non-exhaustive list of features enabled by "--enable-frills" 2023 A non-exhaustive list of features enabled by "--enable-frills"
1857 (possibly in combination with other switches) is: 2024 (possibly in combination with other switches) is:
1858 2025
1859 MWM-hints 2026 MWM-hints
1860 EWMH-hints (pid, utf8 names) and protocols (ping) 2027 EWMH-hints (pid, utf8 names) and protocols (ping)
1861 seperate underline colour 2028 seperate underline colour (-underlineColor)
1862 settable border widths and borderless switch 2029 settable border widths and borderless switch (-w, -b, -bl)
1863 settable extra linespacing 2030 settable extra linespacing /-lsp)
1864 iso-14755-2 and -3, and visual feedback 2031 iso-14755-2 and -3, and visual feedback
1865 backindex and forwardindex escape sequence 2032 backindex and forwardindex escape sequence
1866 window op and some xterm/OSC escape sequences 2033 window op and some xterm/OSC escape sequences
1867 tripleclickwords 2034 tripleclickwords (-tcw)
1868 settable insecure mode 2035 settable insecure mode (-insecure)
1869 keysym remapping support 2036 keysym remapping support
1870 cursor blinking and underline cursor 2037 cursor blinking and underline cursor (-cb, -uc)
1871 -embed and -pty-fd options 2038 XEmbed support (-embed)
2039 user-pty (-pty-fd)
2040 hold on exit (-hold)
2041 skip builtin block graphics (-sbg)
2042 sgr modes 90..97 and 100..107
1872 2043
1873 --enable-iso14755 (default: on) 2044 --enable-iso14755 (default: on)
1874 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 2045 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1875 Basic support (section 5.1) is enabled by "--enable-frills", while 2046 Basic support (section 5.1) is enabled by "--enable-frills", while
1876 support for 5.2, 5.3 and 5.4 is enabled with this switch. 2047 support for 5.2, 5.3 and 5.4 is enabled with this switch.
… …
1902 --enable-dlmalloc (default: off) 2073 --enable-dlmalloc (default: off)
1903 Use Doug Lea's malloc - which is good for a production version See 2074 Use Doug Lea's malloc - which is good for a production version See
1904 <http://g.oswego.edu/dl/html/malloc.html> for details. 2075 <http://g.oswego.edu/dl/html/malloc.html> for details.
1905 2076
1906 --enable-smart-resize (default: on) 2077 --enable-smart-resize (default: on)
1907 Add smart growth/shrink behaviour when changing font size via from 2078 Add smart growth/shrink behaviour when changing font size via hot
1908 hot keys. This should keep in a fixed position the rxvt corner which 2079 keys. This should keep the window corner which is closest to a
1909 is closest to a corner of the screen. 2080 corner of the screen in a fixed position.
1910 2081
1911 --enable-pointer-blank (default: on) 2082 --enable-pointer-blank (default: on)
1912 Add support to have the pointer disappear when typing or inactive. 2083 Add support to have the pointer disappear when typing or inactive.
2084
2085 --enable-perl (default: off)
2086 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2087 (doc/rxvtperl.txt) for more info on this feature, or the files in
2088 src/perl-ext/ for the extensions that are installed by default. The
2089 perl interpreter that is used can be specified via the "PERL"
2090 environment variable when running configure.
1913 2091
1914 --with-name=NAME (default: urxvt) 2092 --with-name=NAME (default: urxvt)
1915 Set the basename for the installed binaries, resulting in "urxvt", 2093 Set the basename for the installed binaries, resulting in "urxvt",
1916 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 2094 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1917 2095

Diff Legend

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