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.30 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.43 by root, Fri Jan 13 12:40:46 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 urxvtperl(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
23 Isn't rxvt supposed to be small? Don't all those features bloat? 63 Isn't rxvt supposed to be small? Don't all those features bloat?
24 I often get asked about this, and I think, no, they didn't cause 64 I often get asked about this, and I think, no, they didn't cause
25 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you 65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
26 can see that the urxvt binary is larger (due to some encoding tables 66 can see that the urxvt binary is larger (due to some encoding tables
27 always being compiled in), but it actually uses less memory (RSS) 67 always being compiled in), but it actually uses less memory (RSS)
56 96
57 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), 97 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
58 this still fares rather well. And compared to some monsters like 98 this still fares rather well. And compared to some monsters like
59 gnome-terminal (21152k + extra 4204k in separate processes) or 99 gnome-terminal (21152k + extra 4204k in separate processes) or
60 konsole (22200k + extra 43180k in daemons that stay around after 100 konsole (22200k + extra 43180k in daemons that stay around after
61 exit, plus half aminute of startup time, including the hundreds of 101 exit, plus half a minute of startup time, including the hundreds of
62 warnings it spits out), it fares extremely well *g*. 102 warnings it spits out), it fares extremely well *g*.
63 103
64 Why C++, isn't that unportable/bloated/uncool? 104 Why C++, isn't that unportable/bloated/uncool?
65 Is this a question? :) It comes up very often. The simple answer is: 105 Is this a question? :) It comes up very often. The simple answer is:
66 I had to write it, and C++ allowed me to write and maintain it in a 106 I had to write it, and C++ allowed me to write and maintain it in a
104 terminal as an example embedding application. 144 terminal as an example embedding application.
105 145
106 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
107 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
108 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.
109 When using the rxvtc client, the version displayed is that of the 149 When using the urxvtc client, the version displayed is that of the
110 daemon. 150 daemon.
111 151
112 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
113 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
114 patches that considerably change the behaviour of rxvt-unicode. 154 patches that considerably change the behaviour of rxvt-unicode.
122 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
123 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
124 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
125 other users that might encounter the same issue. 165 other users that might encounter the same issue.
126 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.
209
127 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?
128 The terminal description used by rxvt-unicode is not as widely 211 The terminal description used by rxvt-unicode is not as widely
129 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
130 problem often arises). 213 problem often arises).
131 214
155 238
156 "tic" outputs some error when compiling the terminfo entry. 239 "tic" outputs some error when compiling the terminfo entry.
157 Most likely it's the empty definition for "enacs=". Just replace it 240 Most likely it's the empty definition for "enacs=". Just replace it
158 by "enacs=\E[0@" and try again. 241 by "enacs=\E[0@" and try again.
159 242
160 "bash"'s readline does not work correctly under rxvt. 243 "bash"'s readline does not work correctly under urxvt.
161 I need a termcap file entry. 244 I need a termcap file entry.
162 One reason you might want this is that some distributions or 245 One reason you might want this is that some distributions or
163 operating systems still compile some programs using the 246 operating systems still compile some programs using the
164 long-obsoleted termcap library (Fedora Core's bash is one example) 247 long-obsoleted termcap library (Fedora Core's bash is one example)
165 and rely on a termcap entry for "rxvt-unicode". 248 and rely on a termcap entry for "rxvt-unicode".
276 indeed look correct. 359 indeed look correct.
277 360
278 In that case, select a font of your taste and add it to the font 361 In that case, select a font of your taste and add it to the font
279 list, e.g.: 362 list, e.g.:
280 363
281 rxvt -fn basefont,font2,font3... 364 urxvt -fn basefont,font2,font3...
282 365
283 When rxvt-unicode sees a character, it will first look at the base 366 When rxvt-unicode sees a character, it will first look at the base
284 font. If the base font does not contain the character, it will go to 367 font. If the base font does not contain the character, it will go to
285 the next font, and so on. Specifying your own fonts will also speed 368 the next font, and so on. Specifying your own fonts will also speed
286 up this search and use less resources within rxvt-unicode and the 369 up this search and use less resources within rxvt-unicode and the
571 Mouse cut/paste suddenly no longer works. 654 Mouse cut/paste suddenly no longer works.
572 Make sure that mouse reporting is actually turned off since killing 655 Make sure that mouse reporting is actually turned off since killing
573 some editors prematurely may leave the mouse in mouse report mode. 656 some editors prematurely may leave the mouse in mouse report mode.
574 I've heard that tcsh may use mouse reporting unless it otherwise 657 I've heard that tcsh may use mouse reporting unless it otherwise
575 specified. A quick check is to see if cut/paste works when the Alt 658 specified. A quick check is to see if cut/paste works when the Alt
576 or Shift keys are depressed. See rxvt(7) 659 or Shift keys are depressed.
577 660
578 What's with this bold/blink stuff? 661 What's with this bold/blink stuff?
579 If no bold colour is set via "colorBD:", bold will invert text using 662 If no bold colour is set via "colorBD:", bold will invert text using
580 the standard foreground colour. 663 the standard foreground colour.
581 664
636 URxvt.color6: #73f7ff 719 URxvt.color6: #73f7ff
637 URxvt.color14: #73f7ff 720 URxvt.color14: #73f7ff
638 URxvt.color7: #e1dddd 721 URxvt.color7: #e1dddd
639 URxvt.color15: #e1dddd 722 URxvt.color15: #e1dddd
640 723
641 How can I start rxvtd in a race-free way? 724 How can I start urxvtd in a race-free way?
642 Try "rxvtd -f -o", which tells rxvtd to open the display, create the 725 Try "urxvtd -f -o", which tells urxvtd to open the display, create
643 listening socket and then fork. 726 the listening socket and then fork.
644 727
645 What's with the strange Backspace/Delete key behaviour? 728 What's with the strange Backspace/Delete key behaviour?
646 Assuming that the physical Backspace key corresponds to the 729 Assuming that the physical Backspace key corresponds to the
647 BackSpace keysym (not likely for Linux ... see the following 730 BackSpace keysym (not likely for Linux ... see the following
648 question) there are two standard values that can be used for 731 question) there are two standard values that can be used for
661 744
662 For starting a new rxvt-unicode: 745 For starting a new rxvt-unicode:
663 746
664 # use Backspace = ^H 747 # use Backspace = ^H
665 $ stty erase ^H 748 $ stty erase ^H
666 $ rxvt 749 $ urxvt
667 750
668 # use Backspace = ^? 751 # use Backspace = ^?
669 $ stty erase ^? 752 $ stty erase ^?
670 $ rxvt 753 $ urxvt
671 754
672 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). 755 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
673 756
674 For an existing rxvt-unicode: 757 For an existing rxvt-unicode:
675 758
676 # use Backspace = ^H 759 # use Backspace = ^H
677 $ stty erase ^H 760 $ stty erase ^H
703 There are some compile-time selections available via configure. 786 There are some compile-time selections available via configure.
704 Unless you have run "configure" with the "--disable-resources" 787 Unless you have run "configure" with the "--disable-resources"
705 option you can use the `keysym' resource to alter the keystrings 788 option you can use the `keysym' resource to alter the keystrings
706 associated with keysyms. 789 associated with keysyms.
707 790
708 Here's an example for a URxvt session started using "rxvt -name 791 Here's an example for a URxvt session started using "urxvt -name
709 URxvt" 792 URxvt"
710 793
711 URxvt.keysym.Home: \033[1~ 794 URxvt.keysym.Home: \033[1~
712 URxvt.keysym.End: \033[4~ 795 URxvt.keysym.End: \033[4~
713 URxvt.keysym.C-apostrophe: \033<C-'> 796 URxvt.keysym.C-apostrophe: \033<C-'>
1266 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)
1267 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)
1268 Ps = 12 Change colour of text cursor foreground to Pt 1351 Ps = 12 Change colour of text cursor foreground to Pt
1269 Ps = 13 Change colour of mouse foreground to Pt 1352 Ps = 13 Change colour of mouse foreground to Pt
1270 Ps = 17 Change colour of highlight characters to Pt 1353 Ps = 17 Change colour of highlight characters to Pt
1271 Ps = 18 Change colour of bold characters to Pt 1354 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1272 Ps = 19 Change colour of underlined characters to Pt 1355 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1273 Ps = 20 Change default background to Pt 1356 Ps = 20 Change default background to Pt
1274 Ps = 39 Change default foreground colour to Pt. 1357 Ps = 39 Change default foreground colour to Pt.
1275 Ps = 46 Change Log File to Pt unimplemented 1358 Ps = 46 Change Log File to Pt unimplemented
1276 Ps = 49 Change default background colour to Pt. 1359 Ps = 49 Change default background colour to Pt.
1277 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
1278 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
1279 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).
1280 Ps = 703 Menubar command Pt (Compile menubar). 1363 Ps = 703 Menubar command Pt (Compile menubar).
1281 Ps = 704 Change colour of italic characters to Pt 1364 Ps = 704 Change colour of italic characters to Pt
1282 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
1283 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1368 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1284 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).
1285 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).
1286 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).
1287 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).
1288 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).
1289 1375
1290 1376
1291 1377
1292menuBar 1378menuBar
1293 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
1864 --enable-lastlog (default: on) 1950 --enable-lastlog (default: on)
1865 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)
1866 at start of rxvt execution. This option requires --enable-utmp to 1952 at start of rxvt execution. This option requires --enable-utmp to
1867 also be specified. 1953 also be specified.
1868 1954
1869 --enable-xpm-background (default: off) 1955 --enable-xpm-background (default: on)
1870 Add support for XPM background pixmaps. 1956 Add support for XPM background pixmaps.
1871 1957
1872 --enable-transparency (default: off) 1958 --enable-transparency (default: on)
1873 Add support for inheriting parent backgrounds thus giving a fake 1959 Add support for inheriting parent backgrounds thus giving a fake
1874 transparency to the term. 1960 transparency to the term.
1875 1961
1876 --enable-fading (default: on) 1962 --enable-fading (default: on)
1877 Add support for fading the text when focus is lost (requires 1963 Add support for fading the text when focus is lost (requires
1879 1965
1880 --enable-tinting (default: on) 1966 --enable-tinting (default: on)
1881 Add support for tinting of transparent backgrounds (requires 1967 Add support for tinting of transparent backgrounds (requires
1882 "--enable-transparency"). 1968 "--enable-transparency").
1883 1969
1884 --enable-menubar (default: off) 1970 --enable-menubar (default: off) [DEPRECATED]
1885 Add support for our menu bar system (this interacts badly with 1971 Add support for our menu bar system (this interacts badly with
1886 dynamic locale switching currently). 1972 dynamic locale switching currently). This option is DEPRECATED and
1973 will be removed in the future.
1887 1974
1888 --enable-rxvt-scroll (default: on) 1975 --enable-rxvt-scroll (default: on)
1889 Add support for the original rxvt scrollbar. 1976 Add support for the original rxvt scrollbar.
1890 1977
1891 --enable-next-scroll (default: on) 1978 --enable-next-scroll (default: on)
1915 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
1916 it. 2003 it.
1917 2004
1918 --disable-resources 2005 --disable-resources
1919 Removes any support for resource checking. 2006 Removes any support for resource checking.
1920
1921 --enable-xgetdefault
1922 Make resources checking via XGetDefault() instead of our small
1923 version which only checks ~/.Xdefaults, or if that doesn't exist
1924 then ~/.Xresources.
1925
1926 Please note that nowadays, things like XIM will automatically pull
1927 in and use the full X resource manager, so the overhead of using it
1928 might be very small, if nonexistant.
1929 2007
1930 --enable-strings (default: off) 2008 --enable-strings (default: off)
1931 Add support for our possibly faster memset() function and other 2009 Add support for our possibly faster memset() function and other
1932 various routines, overriding your system's versions which may have 2010 various routines, overriding your system's versions which may have
1933 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
1945 A non-exhaustive list of features enabled by "--enable-frills" 2023 A non-exhaustive list of features enabled by "--enable-frills"
1946 (possibly in combination with other switches) is: 2024 (possibly in combination with other switches) is:
1947 2025
1948 MWM-hints 2026 MWM-hints
1949 EWMH-hints (pid, utf8 names) and protocols (ping) 2027 EWMH-hints (pid, utf8 names) and protocols (ping)
1950 seperate underline colour 2028 seperate underline colour (-underlineColor)
1951 settable border widths and borderless switch 2029 settable border widths and borderless switch (-w, -b, -bl)
1952 settable extra linespacing 2030 settable extra linespacing /-lsp)
1953 iso-14755-2 and -3, and visual feedback 2031 iso-14755-2 and -3, and visual feedback
1954 backindex and forwardindex escape sequence 2032 backindex and forwardindex escape sequence
1955 window op and some xterm/OSC escape sequences 2033 window op and some xterm/OSC escape sequences
1956 tripleclickwords 2034 tripleclickwords (-tcw)
1957 settable insecure mode 2035 settable insecure mode (-insecure)
1958 keysym remapping support 2036 keysym remapping support
1959 cursor blinking and underline cursor 2037 cursor blinking and underline cursor (-cb, -uc)
1960 -embed, -pty-fd and -hold 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
1961 2043
1962 --enable-iso14755 (default: on) 2044 --enable-iso14755 (default: on)
1963 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 2045 Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt).
1964 Basic support (section 5.1) is enabled by "--enable-frills", while 2046 Basic support (section 5.1) is enabled by "--enable-frills", while
1965 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.
1966 2048
1967 --enable-keepscrolling (default: on) 2049 --enable-keepscrolling (default: on)
1968 Add support for continual scrolling of the display when you hold the 2050 Add support for continual scrolling of the display when you hold the
1999 2081
2000 --enable-pointer-blank (default: on) 2082 --enable-pointer-blank (default: on)
2001 Add support to have the pointer disappear when typing or inactive. 2083 Add support to have the pointer disappear when typing or inactive.
2002 2084
2003 --enable-perl (default: off) 2085 --enable-perl (default: off)
2004 Enable an embedded perl interpreter. See the rxvtperl(3) manpage 2086 Enable an embedded perl interpreter. See the urxvtperl(3) manpage
2005 (doc/rxvtperl.txt) for more info on this feature, or the files in 2087 (doc/rxvtperl.txt) for more info on this feature, or the files in
2006 src/perl-ext/ for the extensions that are installed by default. 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.
2007 2091
2008 --with-name=NAME (default: urxvt) 2092 --with-name=NAME (default: urxvt)
2009 Set the basename for the installed binaries, resulting in "urxvt", 2093 Set the basename for the installed binaries, resulting in "urxvt",
2010 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 2094 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
2011 2095

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines