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.28 by root, Sat Dec 24 12:55:17 2005 UTC vs.
Revision 1.40 by root, Thu Jan 12 05:37:34 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 I don't like the new selection/popups/hotkeys/perl, how do I
24 change/disable it?
25 You can disable the perl extension completely by setting the
26 perl-ext-common resource to the empty string, which also keeps
27 rxvt-unicode from initialising perl, saving memory.
28
29 If you only want to disable specific features, you first have to
30 identify which perl extension is responsible. For this, read the
31 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
32 example, to disable the selection-popup and option-popup, specify
33 this perl-ext-common resource:
34
35 URxvt.perl-ext-common: default,-selection-popup,-option-popup
36
37 This will keep the default extensions, but disable the two popup
38 extensions. Some extensions can also be configured, for example,
39 scrollback search mode is triggered by M-s. You can move it to any
40 other combination either by setting the searchable-scrollback
41 resource:
42
43 URxvt.searchable-scrollback: CM-s
44
23 Isn't rxvt supposed to be small? Don't all those features bloat? 45 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 46 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 47 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 48 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) 49 always being compiled in), but it actually uses less memory (RSS)
56 78
57 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), 79 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
58 this still fares rather well. And compared to some monsters like 80 this still fares rather well. And compared to some monsters like
59 gnome-terminal (21152k + extra 4204k in separate processes) or 81 gnome-terminal (21152k + extra 4204k in separate processes) or
60 konsole (22200k + extra 43180k in daemons that stay around after 82 konsole (22200k + extra 43180k in daemons that stay around after
61 exit, plus half aminute of startup time, including the hundreds of 83 exit, plus half a minute of startup time, including the hundreds of
62 warnings it spits out), it fares extremely well *g*. 84 warnings it spits out), it fares extremely well *g*.
63 85
64 Why C++, isn't that unportable/bloated/uncool? 86 Why C++, isn't that unportable/bloated/uncool?
65 Is this a question? :) It comes up very often. The simple answer is: 87 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 88 I had to write it, and C++ allowed me to write and maintain it in a
104 terminal as an example embedding application. 126 terminal as an example embedding application.
105 127
106 How do I know which rxvt-unicode version I'm using? 128 How do I know which rxvt-unicode version I'm using?
107 The version number is displayed with the usage (-h). Also the escape 129 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. 130 sequence "ESC [ 8 n" sets the window title to the version number.
109 When using the urxvtc client, the version displayed is that of the 131 When using the rxvtc client, the version displayed is that of the
110 daemon. 132 daemon.
111 133
112 I am using Debian GNU/Linux and have a problem... 134 I am using Debian GNU/Linux and have a problem...
113 The Debian GNU/Linux package of rxvt-unicode in sarge contains large 135 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
114 patches that considerably change the behaviour of rxvt-unicode. 136 patches that considerably change the behaviour of rxvt-unicode.
122 For other problems that also affect the Debian package, you can and 144 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 145 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 146 also a bug in the Debian version and it serves as a reminder for
125 other users that might encounter the same issue. 147 other users that might encounter the same issue.
126 148
149 I am maintaining rxvt-unicode for distribution/OS XXX, any
150 recommendation?
151 You should build one binary with the default options. configure now
152 enables most useful options, and the trend goes to making them
153 runtime-switchable, too, so there is usually no drawback to enbaling
154 them, except higher disk and possibly memory usage. The perl
155 interpreter should be enabled, as important functionality (menus,
156 selection, likely more in the future) depends on it.
157
158 You should not overwrite the "perl-ext-common" snd "perl-ext"
159 resources system-wide (except maybe with "defaults"). This will
160 result in useful behaviour. If your distribution aims at low memory,
161 add an empty "perl-ext-common" resource to the app-defaults file.
162 This will keep the perl interpreter disabled until the user enables
163 it.
164
165 If you can/want build more binaries, I recommend building a minimal
166 one with "--disable-everything" (very useful) and a maximal one with
167 "--enable-everything" (less useful, it will be very big due to a lot
168 of encodings built-in that increase download times and are rarely
169 used).
170
171 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
172 safe?
173 Likely not. While I honestly try to make it secure, and am probably
174 not bad at it, I think it is simply unreasonable to expect all of
175 freetype + fontconfig + xft + xlib + perl + ... + rxvt-unicode
176 itself to all be secure. Also, rxvt-unicode disables some options
177 when it detects that it runs setuid or setgid, which is not nice.
178 Besides, with the embedded perl interpreter the possibility for
179 security problems easily multiplies.
180
181 Elevated privileges are only required for utmp and pty operations on
182 some systems (for example, GNU/Linux doesn't need any extra
183 privileges for ptys, but some need it for utmp support). It is
184 planned to mvoe this into a forked handler process, but this is not
185 yet done.
186
187 So, while setuid/setgid operation is supported and not a problem on
188 your typical single-user-no-other-logins unix desktop, always
189 remember that its an awful lot of code, most of which isn't checked
190 for security issues regularly.
191
127 When I log-in to another system it tells me about missing terminfo data? 192 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 193 The terminal description used by rxvt-unicode is not as widely
129 available as that for xterm, or even rxvt (for which the same 194 available as that for xterm, or even rxvt (for which the same
130 problem often arises). 195 problem often arises).
131 196
155 220
156 "tic" outputs some error when compiling the terminfo entry. 221 "tic" outputs some error when compiling the terminfo entry.
157 Most likely it's the empty definition for "enacs=". Just replace it 222 Most likely it's the empty definition for "enacs=". Just replace it
158 by "enacs=\E[0@" and try again. 223 by "enacs=\E[0@" and try again.
159 224
160 "bash"'s readline does not work correctly under urxvt. 225 "bash"'s readline does not work correctly under rxvt.
161 I need a termcap file entry. 226 I need a termcap file entry.
162 One reason you might want this is that some distributions or 227 One reason you might want this is that some distributions or
163 operating systems still compile some programs using the 228 operating systems still compile some programs using the
164 long-obsoleted termcap library (Fedora Core's bash is one example) 229 long-obsoleted termcap library (Fedora Core's bash is one example)
165 and rely on a termcap entry for "rxvt-unicode". 230 and rely on a termcap entry for "rxvt-unicode".
276 indeed look correct. 341 indeed look correct.
277 342
278 In that case, select a font of your taste and add it to the font 343 In that case, select a font of your taste and add it to the font
279 list, e.g.: 344 list, e.g.:
280 345
281 urxvt -fn basefont,font2,font3... 346 rxvt -fn basefont,font2,font3...
282 347
283 When rxvt-unicode sees a character, it will first look at the base 348 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 349 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 350 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 351 up this search and use less resources within rxvt-unicode and the
571 Mouse cut/paste suddenly no longer works. 636 Mouse cut/paste suddenly no longer works.
572 Make sure that mouse reporting is actually turned off since killing 637 Make sure that mouse reporting is actually turned off since killing
573 some editors prematurely may leave the mouse in mouse report mode. 638 some editors prematurely may leave the mouse in mouse report mode.
574 I've heard that tcsh may use mouse reporting unless it otherwise 639 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 640 specified. A quick check is to see if cut/paste works when the Alt
576 or Shift keys are depressed. See urxvt(7) 641 or Shift keys are depressed. See rxvt(7)
577 642
578 What's with this bold/blink stuff? 643 What's with this bold/blink stuff?
579 If no bold colour is set via "colorBD:", bold will invert text using 644 If no bold colour is set via "colorBD:", bold will invert text using
580 the standard foreground colour. 645 the standard foreground colour.
581 646
636 URxvt.color6: #73f7ff 701 URxvt.color6: #73f7ff
637 URxvt.color14: #73f7ff 702 URxvt.color14: #73f7ff
638 URxvt.color7: #e1dddd 703 URxvt.color7: #e1dddd
639 URxvt.color15: #e1dddd 704 URxvt.color15: #e1dddd
640 705
641 How can I start urxvtd in a race-free way? 706 How can I start rxvtd in a race-free way?
642 Try "urxvtd -f -o", which tells urxvtd to open the display, create 707 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
643 the listening socket and then fork. 708 listening socket and then fork.
644 709
645 What's with the strange Backspace/Delete key behaviour? 710 What's with the strange Backspace/Delete key behaviour?
646 Assuming that the physical Backspace key corresponds to the 711 Assuming that the physical Backspace key corresponds to the
647 BackSpace keysym (not likely for Linux ... see the following 712 BackSpace keysym (not likely for Linux ... see the following
648 question) there are two standard values that can be used for 713 question) there are two standard values that can be used for
661 726
662 For starting a new rxvt-unicode: 727 For starting a new rxvt-unicode:
663 728
664 # use Backspace = ^H 729 # use Backspace = ^H
665 $ stty erase ^H 730 $ stty erase ^H
666 $ urxvt 731 $ rxvt
667 732
668 # use Backspace = ^? 733 # use Backspace = ^?
669 $ stty erase ^? 734 $ stty erase ^?
670 $ urxvt 735 $ rxvt
671 736
672 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in urxvt(7). 737 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7).
673 738
674 For an existing rxvt-unicode: 739 For an existing rxvt-unicode:
675 740
676 # use Backspace = ^H 741 # use Backspace = ^H
677 $ stty erase ^H 742 $ stty erase ^H
703 There are some compile-time selections available via configure. 768 There are some compile-time selections available via configure.
704 Unless you have run "configure" with the "--disable-resources" 769 Unless you have run "configure" with the "--disable-resources"
705 option you can use the `keysym' resource to alter the keystrings 770 option you can use the `keysym' resource to alter the keystrings
706 associated with keysyms. 771 associated with keysyms.
707 772
708 Here's an example for a URxvt session started using "urxvt -name 773 Here's an example for a URxvt session started using "rxvt -name
709 URxvt" 774 URxvt"
710 775
711 URxvt.keysym.Home: \033[1~ 776 URxvt.keysym.Home: \033[1~
712 URxvt.keysym.End: \033[4~ 777 URxvt.keysym.End: \033[4~
713 URxvt.keysym.C-apostrophe: \033<C-'> 778 URxvt.keysym.C-apostrophe: \033<C-'>
1231 1296
1232 "Ps = 1011" (rxvt) 1297 "Ps = 1011" (rxvt)
1233 h Scroll to bottom when a key is pressed 1298 h Scroll to bottom when a key is pressed
1234 l Don't scroll to bottom when a key is pressed 1299 l Don't scroll to bottom when a key is pressed
1235 1300
1301 "Ps = 1021" (rxvt)
1302 h Bold/italic implies high intensity (see option -is)
1303 l Font styles have no effect on intensity (Compile styles)
1304
1236 "Ps = 1047" 1305 "Ps = 1047"
1237 h Use Alternate Screen Buffer 1306 h Use Alternate Screen Buffer
1238 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1307 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1239 1308
1240 "Ps = 1048" 1309 "Ps = 1048"
1262 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1331 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1263 Ps = 11 Change colour of text background to Pt (NB: may change in future) 1332 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1264 Ps = 12 Change colour of text cursor foreground to Pt 1333 Ps = 12 Change colour of text cursor foreground to Pt
1265 Ps = 13 Change colour of mouse foreground to Pt 1334 Ps = 13 Change colour of mouse foreground to Pt
1266 Ps = 17 Change colour of highlight characters to Pt 1335 Ps = 17 Change colour of highlight characters to Pt
1267 Ps = 18 Change colour of bold characters to Pt 1336 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1268 Ps = 19 Change colour of underlined characters to Pt 1337 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1269 Ps = 20 Change default background to Pt 1338 Ps = 20 Change default background to Pt
1270 Ps = 39 Change default foreground colour to Pt. 1339 Ps = 39 Change default foreground colour to Pt.
1271 Ps = 46 Change Log File to Pt unimplemented 1340 Ps = 46 Change Log File to Pt unimplemented
1272 Ps = 49 Change default background colour to Pt. 1341 Ps = 49 Change default background colour to Pt.
1273 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 1342 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
1274 Ps = 55 Log all scrollback buffer and all of screen to Pt 1343 Ps = 55 Log all scrollback buffer and all of screen to Pt
1275 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1344 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1276 Ps = 703 Menubar command Pt (Compile menubar). 1345 Ps = 703 Menubar command Pt (Compile menubar).
1277 Ps = 704 Change colour of italic characters to Pt 1346 Ps = 704 Change colour of italic characters to Pt
1278 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1347 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1348 Ps = 706 Change colour of bold characters to Pt
1349 Ps = 707 Change colour of underlined characters to Pt
1279 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1350 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1280 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1351 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1281 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1352 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1282 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1353 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1283 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1354 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1284 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1355 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1356 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1285 1357
1286 1358
1287 1359
1288menuBar 1360menuBar
1289 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1361 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1860 --enable-lastlog (default: on) 1932 --enable-lastlog (default: on)
1861 Write user and tty to lastlog file (used by programs like lastlogin) 1933 Write user and tty to lastlog file (used by programs like lastlogin)
1862 at start of rxvt execution. This option requires --enable-utmp to 1934 at start of rxvt execution. This option requires --enable-utmp to
1863 also be specified. 1935 also be specified.
1864 1936
1865 --enable-xpm-background (default: off) 1937 --enable-xpm-background (default: on)
1866 Add support for XPM background pixmaps. 1938 Add support for XPM background pixmaps.
1867 1939
1868 --enable-transparency (default: off) 1940 --enable-transparency (default: on)
1869 Add support for inheriting parent backgrounds thus giving a fake 1941 Add support for inheriting parent backgrounds thus giving a fake
1870 transparency to the term. 1942 transparency to the term.
1871 1943
1872 --enable-fading (default: on) 1944 --enable-fading (default: on)
1873 Add support for fading the text when focus is lost (requires 1945 Add support for fading the text when focus is lost (requires
1875 1947
1876 --enable-tinting (default: on) 1948 --enable-tinting (default: on)
1877 Add support for tinting of transparent backgrounds (requires 1949 Add support for tinting of transparent backgrounds (requires
1878 "--enable-transparency"). 1950 "--enable-transparency").
1879 1951
1880 --enable-menubar (default: off) 1952 --enable-menubar (default: off) [DEPRECATED]
1881 Add support for our menu bar system (this interacts badly with 1953 Add support for our menu bar system (this interacts badly with
1882 dynamic locale switching currently). 1954 dynamic locale switching currently). This option is DEPRECATED and
1955 will be removed in the future.
1883 1956
1884 --enable-rxvt-scroll (default: on) 1957 --enable-rxvt-scroll (default: on)
1885 Add support for the original rxvt scrollbar. 1958 Add support for the original rxvt scrollbar.
1886 1959
1887 --enable-next-scroll (default: on) 1960 --enable-next-scroll (default: on)
1911 Removes any handling of the delete key by us - let the X server do 1984 Removes any handling of the delete key by us - let the X server do
1912 it. 1985 it.
1913 1986
1914 --disable-resources 1987 --disable-resources
1915 Removes any support for resource checking. 1988 Removes any support for resource checking.
1916
1917 --enable-xgetdefault
1918 Make resources checking via XGetDefault() instead of our small
1919 version which only checks ~/.Xdefaults, or if that doesn't exist
1920 then ~/.Xresources.
1921
1922 Please note that nowadays, things like XIM will automatically pull
1923 in and use the full X resource manager, so the overhead of using it
1924 might be very small, if nonexistant.
1925 1989
1926 --enable-strings (default: off) 1990 --enable-strings (default: off)
1927 Add support for our possibly faster memset() function and other 1991 Add support for our possibly faster memset() function and other
1928 various routines, overriding your system's versions which may have 1992 various routines, overriding your system's versions which may have
1929 been hand-crafted in assembly or may require extra libraries to link 1993 been hand-crafted in assembly or may require extra libraries to link
1941 A non-exhaustive list of features enabled by "--enable-frills" 2005 A non-exhaustive list of features enabled by "--enable-frills"
1942 (possibly in combination with other switches) is: 2006 (possibly in combination with other switches) is:
1943 2007
1944 MWM-hints 2008 MWM-hints
1945 EWMH-hints (pid, utf8 names) and protocols (ping) 2009 EWMH-hints (pid, utf8 names) and protocols (ping)
1946 seperate underline colour 2010 seperate underline colour (-underlineColor)
1947 settable border widths and borderless switch 2011 settable border widths and borderless switch (-w, -b, -bl)
1948 settable extra linespacing 2012 settable extra linespacing /-lsp)
1949 iso-14755-2 and -3, and visual feedback 2013 iso-14755-2 and -3, and visual feedback
1950 backindex and forwardindex escape sequence 2014 backindex and forwardindex escape sequence
1951 window op and some xterm/OSC escape sequences 2015 window op and some xterm/OSC escape sequences
1952 tripleclickwords 2016 tripleclickwords (-tcw)
1953 settable insecure mode 2017 settable insecure mode (-insecure)
1954 keysym remapping support 2018 keysym remapping support
1955 cursor blinking and underline cursor 2019 cursor blinking and underline cursor (-cb, -uc)
1956 -embed, -pty-fd and -hold options 2020 XEmbed support (-embed)
2021 user-pty (-pty-fd)
2022 hold on exit (-hold)
2023 skip builtin block graphics (-sbg)
2024 sgr modes 90..97 and 100..107
1957 2025
1958 --enable-iso14755 (default: on) 2026 --enable-iso14755 (default: on)
1959 Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt). 2027 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1960 Basic support (section 5.1) is enabled by "--enable-frills", while 2028 Basic support (section 5.1) is enabled by "--enable-frills", while
1961 support for 5.2, 5.3 and 5.4 is enabled with this switch. 2029 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1962 2030
1963 --enable-keepscrolling (default: on) 2031 --enable-keepscrolling (default: on)
1964 Add support for continual scrolling of the display when you hold the 2032 Add support for continual scrolling of the display when you hold the
1994 corner of the screen in a fixed position. 2062 corner of the screen in a fixed position.
1995 2063
1996 --enable-pointer-blank (default: on) 2064 --enable-pointer-blank (default: on)
1997 Add support to have the pointer disappear when typing or inactive. 2065 Add support to have the pointer disappear when typing or inactive.
1998 2066
2067 --enable-perl (default: off)
2068 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2069 (doc/rxvtperl.txt) for more info on this feature, or the files in
2070 src/perl-ext/ for the extensions that are installed by default. The
2071 perl interpreter that is used can be specified via the "PERL"
2072 environment variable when running configure.
2073
1999 --with-name=NAME (default: urxvt) 2074 --with-name=NAME (default: urxvt)
2000 Set the basename for the installed binaries, resulting in "urxvt", 2075 Set the basename for the installed binaries, resulting in "urxvt",
2001 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 2076 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
2002 2077
2003 --with-term=NAME (default: rxvt-unicode) 2078 --with-term=NAME (default: rxvt-unicode)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines