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.37 by root, Wed Jan 11 05:29:40 2006 UTC

… …
56 56
57 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), 57 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
58 this still fares rather well. And compared to some monsters like 58 this still fares rather well. And compared to some monsters like
59 gnome-terminal (21152k + extra 4204k in separate processes) or 59 gnome-terminal (21152k + extra 4204k in separate processes) or
60 konsole (22200k + extra 43180k in daemons that stay around after 60 konsole (22200k + extra 43180k in daemons that stay around after
61 exit, plus half aminute of startup time, including the hundreds of 61 exit, plus half a minute of startup time, including the hundreds of
62 warnings it spits out), it fares extremely well *g*. 62 warnings it spits out), it fares extremely well *g*.
63 63
64 Why C++, isn't that unportable/bloated/uncool? 64 Why C++, isn't that unportable/bloated/uncool?
65 Is this a question? :) It comes up very often. The simple answer is: 65 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 66 I had to write it, and C++ allowed me to write and maintain it in a
… …
104 terminal as an example embedding application. 104 terminal as an example embedding application.
105 105
106 How do I know which rxvt-unicode version I'm using? 106 How do I know which rxvt-unicode version I'm using?
107 The version number is displayed with the usage (-h). Also the escape 107 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. 108 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 109 When using the rxvtc client, the version displayed is that of the
110 daemon. 110 daemon.
111 111
112 I am using Debian GNU/Linux and have a problem... 112 I am using Debian GNU/Linux and have a problem...
113 The Debian GNU/Linux package of rxvt-unicode in sarge contains large 113 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
114 patches that considerably change the behaviour of rxvt-unicode. 114 patches that considerably change the behaviour of rxvt-unicode.
… …
122 For other problems that also affect the Debian package, you can and 122 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 123 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 124 also a bug in the Debian version and it serves as a reminder for
125 other users that might encounter the same issue. 125 other users that might encounter the same issue.
126 126
127 I am maintaining rxvt-unicode for distribution/OS XXX, any
128 recommendation?
129 You should build one binary with the default options. configure now
130 enables most useful options, and the trend goes to making them
131 runtime-switchable, too, so there is usually no drawback to enbaling
132 them, except higher disk and possibly memory usage. The perl
133 interpreter should be enabled, as important functionality (menus,
134 selection, likely more in the future) depends on it.
135
136 You should not overwrite the "perl-ext-common" snd "perl-ext"
137 resources system-wide (except maybe with "defaults"). This will
138 result in useful behaviour. If your distribution aims at low memory,
139 add an empty "perl-ext-common" resource to the app-defaults file.
140 This will keep the perl interpreter disabled until the user enables
141 it.
142
143 If you can/want build more binaries, I recommend building a minimal
144 one with "--disable-everything" (very useful) and a maximal one with
145 "--enable-everything" (less useful, it will be very big due to a lot
146 of encodings built-in that increase download times and are rarely
147 used).
148
149 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
150 safe?
151 Likely not. While I honestly try to make it secure, and am probably
152 not bad at it, I think it is simply unreasonable to expect all of
153 freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to
154 all be secure. Also, rxvt-unicode disables some options when it
155 detects that it runs setuid or setgid, which is not nice.
156
157 Elevated privileges are only required for utmp and pty operations on
158 some systems (for example, GNU/Linux doesn't need any extra
159 privileges for ptys, but some need it for utmp support). If
160 rxvt-unicode doesn't support the library/setuid helper that your OS
161 needs I'll be happy to assist you in implementing support for it.
162
163 So, while setuid/setgid operation is supported and not a problem on
164 your typical single-user-no-other-logins unix desktop, always
165 remember that its an awful lot of code, most of which isn't checked
166 for security issues regularly.
167
127 When I log-in to another system it tells me about missing terminfo data? 168 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 169 The terminal description used by rxvt-unicode is not as widely
129 available as that for xterm, or even rxvt (for which the same 170 available as that for xterm, or even rxvt (for which the same
130 problem often arises). 171 problem often arises).
131 172
… …
155 196
156 "tic" outputs some error when compiling the terminfo entry. 197 "tic" outputs some error when compiling the terminfo entry.
157 Most likely it's the empty definition for "enacs=". Just replace it 198 Most likely it's the empty definition for "enacs=". Just replace it
158 by "enacs=\E[0@" and try again. 199 by "enacs=\E[0@" and try again.
159 200
160 "bash"'s readline does not work correctly under urxvt. 201 "bash"'s readline does not work correctly under rxvt.
161 I need a termcap file entry. 202 I need a termcap file entry.
162 One reason you might want this is that some distributions or 203 One reason you might want this is that some distributions or
163 operating systems still compile some programs using the 204 operating systems still compile some programs using the
164 long-obsoleted termcap library (Fedora Core's bash is one example) 205 long-obsoleted termcap library (Fedora Core's bash is one example)
165 and rely on a termcap entry for "rxvt-unicode". 206 and rely on a termcap entry for "rxvt-unicode".
… …
276 indeed look correct. 317 indeed look correct.
277 318
278 In that case, select a font of your taste and add it to the font 319 In that case, select a font of your taste and add it to the font
279 list, e.g.: 320 list, e.g.:
280 321
281 urxvt -fn basefont,font2,font3... 322 rxvt -fn basefont,font2,font3...
282 323
283 When rxvt-unicode sees a character, it will first look at the base 324 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 325 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 326 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 327 up this search and use less resources within rxvt-unicode and the
… …
571 Mouse cut/paste suddenly no longer works. 612 Mouse cut/paste suddenly no longer works.
572 Make sure that mouse reporting is actually turned off since killing 613 Make sure that mouse reporting is actually turned off since killing
573 some editors prematurely may leave the mouse in mouse report mode. 614 some editors prematurely may leave the mouse in mouse report mode.
574 I've heard that tcsh may use mouse reporting unless it otherwise 615 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 616 specified. A quick check is to see if cut/paste works when the Alt
576 or Shift keys are depressed. See urxvt(7) 617 or Shift keys are depressed. See rxvt(7)
577 618
578 What's with this bold/blink stuff? 619 What's with this bold/blink stuff?
579 If no bold colour is set via "colorBD:", bold will invert text using 620 If no bold colour is set via "colorBD:", bold will invert text using
580 the standard foreground colour. 621 the standard foreground colour.
581 622
… …
636 URxvt.color6: #73f7ff 677 URxvt.color6: #73f7ff
637 URxvt.color14: #73f7ff 678 URxvt.color14: #73f7ff
638 URxvt.color7: #e1dddd 679 URxvt.color7: #e1dddd
639 URxvt.color15: #e1dddd 680 URxvt.color15: #e1dddd
640 681
641 How can I start urxvtd in a race-free way? 682 How can I start rxvtd in a race-free way?
642 Try "urxvtd -f -o", which tells urxvtd to open the display, create 683 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
643 the listening socket and then fork. 684 listening socket and then fork.
644 685
645 What's with the strange Backspace/Delete key behaviour? 686 What's with the strange Backspace/Delete key behaviour?
646 Assuming that the physical Backspace key corresponds to the 687 Assuming that the physical Backspace key corresponds to the
647 BackSpace keysym (not likely for Linux ... see the following 688 BackSpace keysym (not likely for Linux ... see the following
648 question) there are two standard values that can be used for 689 question) there are two standard values that can be used for
… …
661 702
662 For starting a new rxvt-unicode: 703 For starting a new rxvt-unicode:
663 704
664 # use Backspace = ^H 705 # use Backspace = ^H
665 $ stty erase ^H 706 $ stty erase ^H
666 $ urxvt 707 $ rxvt
667 708
668 # use Backspace = ^? 709 # use Backspace = ^?
669 $ stty erase ^? 710 $ stty erase ^?
670 $ urxvt 711 $ rxvt
671 712
672 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in urxvt(7). 713 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7).
673 714
674 For an existing rxvt-unicode: 715 For an existing rxvt-unicode:
675 716
676 # use Backspace = ^H 717 # use Backspace = ^H
677 $ stty erase ^H 718 $ stty erase ^H
… …
703 There are some compile-time selections available via configure. 744 There are some compile-time selections available via configure.
704 Unless you have run "configure" with the "--disable-resources" 745 Unless you have run "configure" with the "--disable-resources"
705 option you can use the `keysym' resource to alter the keystrings 746 option you can use the `keysym' resource to alter the keystrings
706 associated with keysyms. 747 associated with keysyms.
707 748
708 Here's an example for a URxvt session started using "urxvt -name 749 Here's an example for a URxvt session started using "rxvt -name
709 URxvt" 750 URxvt"
710 751
711 URxvt.keysym.Home: \033[1~ 752 URxvt.keysym.Home: \033[1~
712 URxvt.keysym.End: \033[4~ 753 URxvt.keysym.End: \033[4~
713 URxvt.keysym.C-apostrophe: \033<C-'> 754 URxvt.keysym.C-apostrophe: \033<C-'>
… …
1231 1272
1232 "Ps = 1011" (rxvt) 1273 "Ps = 1011" (rxvt)
1233 h Scroll to bottom when a key is pressed 1274 h Scroll to bottom when a key is pressed
1234 l Don't scroll to bottom when a key is pressed 1275 l Don't scroll to bottom when a key is pressed
1235 1276
1277 "Ps = 1021" (rxvt)
1278 h Bold/italic implies high intensity (see option -is)
1279 l Font styles have no effect on intensity (Compile styles)
1280
1236 "Ps = 1047" 1281 "Ps = 1047"
1237 h Use Alternate Screen Buffer 1282 h Use Alternate Screen Buffer
1238 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1283 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1239 1284
1240 "Ps = 1048" 1285 "Ps = 1048"
… …
1262 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1307 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) 1308 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 1309 Ps = 12 Change colour of text cursor foreground to Pt
1265 Ps = 13 Change colour of mouse foreground to Pt 1310 Ps = 13 Change colour of mouse foreground to Pt
1266 Ps = 17 Change colour of highlight characters to Pt 1311 Ps = 17 Change colour of highlight characters to Pt
1267 Ps = 18 Change colour of bold characters to Pt 1312 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1268 Ps = 19 Change colour of underlined characters to Pt 1313 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1269 Ps = 20 Change default background to Pt 1314 Ps = 20 Change default background to Pt
1270 Ps = 39 Change default foreground colour to Pt. 1315 Ps = 39 Change default foreground colour to Pt.
1271 Ps = 46 Change Log File to Pt unimplemented 1316 Ps = 46 Change Log File to Pt unimplemented
1272 Ps = 49 Change default background colour to Pt. 1317 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 1318 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 1319 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). 1320 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). 1321 Ps = 703 Menubar command Pt (Compile menubar).
1277 Ps = 704 Change colour of italic characters to Pt 1322 Ps = 704 Change colour of italic characters to Pt
1278 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1323 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1324 Ps = 706 Change colour of bold characters to Pt
1325 Ps = 707 Change colour of underlined characters to Pt
1279 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1326 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). 1327 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). 1328 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). 1329 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). 1330 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). 1331 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1332 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1285 1333
1286 1334
1287 1335
1288menuBar 1336menuBar
1289 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1337 The exact syntax used is *almost* solidified. In the menus, DON'T try to
… …
1860 --enable-lastlog (default: on) 1908 --enable-lastlog (default: on)
1861 Write user and tty to lastlog file (used by programs like lastlogin) 1909 Write user and tty to lastlog file (used by programs like lastlogin)
1862 at start of rxvt execution. This option requires --enable-utmp to 1910 at start of rxvt execution. This option requires --enable-utmp to
1863 also be specified. 1911 also be specified.
1864 1912
1865 --enable-xpm-background (default: off) 1913 --enable-xpm-background (default: on)
1866 Add support for XPM background pixmaps. 1914 Add support for XPM background pixmaps.
1867 1915
1868 --enable-transparency (default: off) 1916 --enable-transparency (default: on)
1869 Add support for inheriting parent backgrounds thus giving a fake 1917 Add support for inheriting parent backgrounds thus giving a fake
1870 transparency to the term. 1918 transparency to the term.
1871 1919
1872 --enable-fading (default: on) 1920 --enable-fading (default: on)
1873 Add support for fading the text when focus is lost (requires 1921 Add support for fading the text when focus is lost (requires
… …
1875 1923
1876 --enable-tinting (default: on) 1924 --enable-tinting (default: on)
1877 Add support for tinting of transparent backgrounds (requires 1925 Add support for tinting of transparent backgrounds (requires
1878 "--enable-transparency"). 1926 "--enable-transparency").
1879 1927
1880 --enable-menubar (default: off) 1928 --enable-menubar (default: off) [DEPRECATED]
1881 Add support for our menu bar system (this interacts badly with 1929 Add support for our menu bar system (this interacts badly with
1882 dynamic locale switching currently). 1930 dynamic locale switching currently). This option is DEPRECATED and
1931 will be removed in the future.
1883 1932
1884 --enable-rxvt-scroll (default: on) 1933 --enable-rxvt-scroll (default: on)
1885 Add support for the original rxvt scrollbar. 1934 Add support for the original rxvt scrollbar.
1886 1935
1887 --enable-next-scroll (default: on) 1936 --enable-next-scroll (default: on)
… …
1941 A non-exhaustive list of features enabled by "--enable-frills" 1990 A non-exhaustive list of features enabled by "--enable-frills"
1942 (possibly in combination with other switches) is: 1991 (possibly in combination with other switches) is:
1943 1992
1944 MWM-hints 1993 MWM-hints
1945 EWMH-hints (pid, utf8 names) and protocols (ping) 1994 EWMH-hints (pid, utf8 names) and protocols (ping)
1946 seperate underline colour 1995 seperate underline colour (-underlineColor)
1947 settable border widths and borderless switch 1996 settable border widths and borderless switch (-w, -b, -bl)
1948 settable extra linespacing 1997 settable extra linespacing /-lsp)
1949 iso-14755-2 and -3, and visual feedback 1998 iso-14755-2 and -3, and visual feedback
1950 backindex and forwardindex escape sequence 1999 backindex and forwardindex escape sequence
1951 window op and some xterm/OSC escape sequences 2000 window op and some xterm/OSC escape sequences
1952 tripleclickwords 2001 tripleclickwords (-tcw)
1953 settable insecure mode 2002 settable insecure mode (-insecure)
1954 keysym remapping support 2003 keysym remapping support
1955 cursor blinking and underline cursor 2004 cursor blinking and underline cursor (-cb, -uc)
1956 -embed, -pty-fd and -hold options 2005 XEmbed support (-embed)
2006 user-pty (-pty-fd)
2007 hold on exit (-hold)
2008 skip builtin block graphics (-sbg)
2009 sgr modes 90..97 and 100..107
1957 2010
1958 --enable-iso14755 (default: on) 2011 --enable-iso14755 (default: on)
1959 Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt). 2012 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 2013 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. 2014 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1962 2015
1963 --enable-keepscrolling (default: on) 2016 --enable-keepscrolling (default: on)
1964 Add support for continual scrolling of the display when you hold the 2017 Add support for continual scrolling of the display when you hold the
… …
1994 corner of the screen in a fixed position. 2047 corner of the screen in a fixed position.
1995 2048
1996 --enable-pointer-blank (default: on) 2049 --enable-pointer-blank (default: on)
1997 Add support to have the pointer disappear when typing or inactive. 2050 Add support to have the pointer disappear when typing or inactive.
1998 2051
2052 --enable-perl (default: off)
2053 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2054 (doc/rxvtperl.txt) for more info on this feature, or the files in
2055 src/perl-ext/ for the extensions that are installed by default. The
2056 perl interpreter that is used can be specified via the "PERL"
2057 environment variable when running configure.
2058
1999 --with-name=NAME (default: urxvt) 2059 --with-name=NAME (default: urxvt)
2000 Set the basename for the installed binaries, resulting in "urxvt", 2060 Set the basename for the installed binaries, resulting in "urxvt",
2001 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 2061 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
2002 2062
2003 --with-term=NAME (default: rxvt-unicode) 2063 --with-term=NAME (default: rxvt-unicode)

Diff Legend

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