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

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.47 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.54 by root, Sat Jan 28 22:16:58 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 7" 131.IX Title "rxvt 7"
132.TH rxvt 7 "2006-01-16" "7.0" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-28" "7.4" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
… …
284.Sp 284.Sp
285No large bloated libraries (of course, none were linked in statically), 285No large bloated libraries (of course, none were linked in statically),
286except maybe libX11 :) 286except maybe libX11 :)
287.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4 287.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4
288.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?" 288.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?"
289rxvt-unicode does not directly support tabs. It will work fine with 289Beginning with version 7.3, there is a perl extension that implements a
290tabbing functionality of many window managers or similar tabbing programs, 290simple tabbed terminal. It is installed by default, so any of these should
291and its embedding-features allow it to be embedded into other programs, 291give you tabs:
292as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl 292.Sp
293module, which features a tabbed urxvt (murxvt) terminal as an example 293.Vb 1
294embedding application. 294\& @@RXVT_NAME@@ -pe tabbed
295.Ve
296.Sp
297.Vb 1
298\& URxvt.perl-ext-common: default,tabbed
299.Ve
300.Sp
301It will also work fine with tabbing functionality of many window managers
302or similar tabbing programs, and its embedding-features allow it to be
303embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
304the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
305(murxvt) terminal as an example embedding application.
295.IP "How do I know which rxvt-unicode version I'm using?" 4 306.IP "How do I know which rxvt-unicode version I'm using?" 4
296.IX Item "How do I know which rxvt-unicode version I'm using?" 307.IX Item "How do I know which rxvt-unicode version I'm using?"
297The version number is displayed with the usage (\-h). Also the escape 308The version number is displayed with the usage (\-h). Also the escape
298sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When 309sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
299using the @@RXVT_NAME@@c client, the version displayed is that of the 310using the @@RXVT_NAME@@c client, the version displayed is that of the
300daemon. 311daemon.
301.IP "I am using Debian GNU/Linux and have a problem..." 4 312.IP "I am using Debian GNU/Linux and have a problem..." 4
302.IX Item "I am using Debian GNU/Linux and have a problem..." 313.IX Item "I am using Debian GNU/Linux and have a problem..."
303The Debian GNU/Linux package of rxvt-unicode in sarge contains large 314The Debian GNU/Linux package of rxvt-unicode in sarge contains large
304patches that considerably change the behaviour of rxvt\-unicode. Before 315patches that considerably change the behaviour of rxvt-unicode (but
305reporting a bug to the original rxvt-unicode author please download and 316unfortunately this notice has been removed). Before reporting a bug to
306install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 317the original rxvt-unicode author please download and install the genuine
307and try to reproduce the problem. If you cannot, chances are that the 318version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
308problems are specific to Debian GNU/Linux, in which case it should be 319the problem. If you cannot, chances are that the problems are specific to
320Debian GNU/Linux, in which case it should be reported via the Debian Bug
309reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report 321Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
310the bug).
311.Sp 322.Sp
312For other problems that also affect the Debian package, you can and 323For other problems that also affect the Debian package, you can and
313probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 324probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
314bug in the Debian version and it serves as a reminder for other users that 325bug in the Debian version and it serves as a reminder for other users that
315might encounter the same issue. 326might encounter the same issue.
… …
332one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with 343one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
333\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of 344\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
334encodings built-in that increase download times and are rarely used). 345encodings built-in that increase download times and are rarely used).
335.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4 346.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
336.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?" 347.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
337Likely not. While I honestly try to make it secure, and am probably not 348It should be, starting with release 7.1. You are encouraged to properly
338bad at it, I think it is simply unreasonable to expect all of freetype 349install urxvt with privileges necessary for your \s-1OS\s0 now.
339+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
340secure. Also, rxvt-unicode disables some options when it detects that it
341runs setuid or setgid, which is not nice. Besides, with the embedded perl
342interpreter the possibility for security problems easily multiplies.
343.Sp 350.Sp
344Elevated privileges are only required for utmp and pty operations on some 351When rxvt-unicode detects that it runs setuid or setgid, it will fork
345systems (for example, GNU/Linux doesn't need any extra privileges for 352into a helper process for privileged operations (pty handling on some
346ptys, but some need it for utmp support). It is planned to mvoe this into 353systems, utmp/wtmp/lastlog handling on others) and drop privileges
347a forked handler process, but this is not yet done. 354immediately. This is much safer than most other terminals that keep
355privileges while running (but is more relevant to urxvt, as it contains
356things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
348.Sp 357.Sp
349So, while setuid/setgid operation is supported and not a problem on your 358This forking is done as the very first within \fImain()\fR, which is very early
350typical single-user-no-other-logins unix desktop, always remember that 359and reduces possible bugs to initialisation code run before \fImain()\fR, or
351its an awful lot of code, most of which isn't checked for security issues 360things like the dynamic loader of your system, which should result in very
352regularly. 361little risk.
353.IP "When I log-in to another system it tells me about missing terminfo data?" 4 362.IP "When I log-in to another system it tells me about missing terminfo data?" 4
354.IX Item "When I log-in to another system it tells me about missing terminfo data?" 363.IX Item "When I log-in to another system it tells me about missing terminfo data?"
355The terminal description used by rxvt-unicode is not as widely available 364The terminal description used by rxvt-unicode is not as widely available
356as that for xterm, or even rxvt (for which the same problem often arises). 365as that for xterm, or even rxvt (for which the same problem often arises).
357.Sp 366.Sp
… …
1058.IX Header "RXVT TECHNICAL REFERENCE" 1067.IX Header "RXVT TECHNICAL REFERENCE"
1059.SH "DESCRIPTION" 1068.SH "DESCRIPTION"
1060.IX Header "DESCRIPTION" 1069.IX Header "DESCRIPTION"
1061The rest of this document describes various technical aspects of 1070The rest of this document describes various technical aspects of
1062\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1071\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1063followed by menu and pixmap support and last by a description of all 1072followed by pixmap support and last by a description of all features
1064features selectable at \f(CW\*(C`configure\*(C'\fR time. 1073selectable at \f(CW\*(C`configure\*(C'\fR time.
1065.SH "Definitions" 1074.SH "Definitions"
1066.IX Header "Definitions" 1075.IX Header "Definitions"
1067.ie n .IP "\fB\fB""c""\fB\fR" 4 1076.ie n .IP "\fB\fB""c""\fB\fR" 4
1068.el .IP "\fB\f(CBc\fB\fR" 4 1077.el .IP "\fB\f(CBc\fB\fR" 4
1069.IX Item "c" 1078.IX Item "c"
… …
1811Ps = 12 Change colour of text cursor foreground to Pt 1820Ps = 12 Change colour of text cursor foreground to Pt
1812Ps = 13 Change colour of mouse foreground to Pt 1821Ps = 13 Change colour of mouse foreground to Pt
1813Ps = 17 Change colour of highlight characters to Pt 1822Ps = 17 Change colour of highlight characters to Pt
1814Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 1823Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1815Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 1824Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1816Ps = 20 Change default background to Pt 1825Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1817Ps = 39 Change default foreground colour to Pt. 1826Ps = 39 Change default foreground colour to Pt.
1818Ps = 46 Change Log File to Pt unimplemented 1827Ps = 46 Change Log File to Pt unimplemented
1819Ps = 49 Change default background colour to Pt. 1828Ps = 49 Change default background colour to Pt.
1820Ps = 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 1829Ps = 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
1821Ps = 55 Log all scrollback buffer and all of screen to Pt 1830Ps = 55 Log all scrollback buffer and all of screen to Pt
1822Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1831Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1832Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1823Ps = 704 Change colour of italic characters to Pt 1833Ps = 704 Change colour of italic characters to Pt
1824Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1834Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1825Ps = 706 Change colour of bold characters to Pt 1835Ps = 706 Change colour of bold characters to Pt
1826Ps = 707 Change colour of underlined characters to Pt 1836Ps = 707 Change colour of underlined characters to Pt
1827Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1837Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
… …
2045Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2055Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2046alternative input methods (e.g. kinput2) and will also correctly 2056alternative input methods (e.g. kinput2) and will also correctly
2047set up the input for people using dead keys or compose keys. 2057set up the input for people using dead keys or compose keys.
2048.IP "\-\-enable\-unicode3 (default: off)" 4 2058.IP "\-\-enable\-unicode3 (default: off)" 4
2049.IX Item "--enable-unicode3 (default: off)" 2059.IX Item "--enable-unicode3 (default: off)"
2060Recommended to stay off unless you really need non-BMP characters.
2061.Sp
2050Enable direct support for displaying unicode codepoints above 2062Enable direct support for displaying unicode codepoints above
205165535 (the basic multilingual page). This increases storage 206365535 (the basic multilingual page). This increases storage
2052requirements per character from 2 to 4 bytes. X11 fonts do not yet 2064requirements per character from 2 to 4 bytes. X11 fonts do not yet
2053support these extra characters, but Xft does. 2065support these extra characters, but Xft does.
2054.Sp 2066.Sp
… …
2063composite characters. This is required for proper viewing of text 2075composite characters. This is required for proper viewing of text
2064where accents are encoded as seperate unicode characters. This is 2076where accents are encoded as seperate unicode characters. This is
2065done by using precomposited characters when available or creating 2077done by using precomposited characters when available or creating
2066new pseudo-characters when no precomposed form exists. 2078new pseudo-characters when no precomposed form exists.
2067.Sp 2079.Sp
2068Without \-\-enable\-unicode3, the number of additional precomposed characters 2080Without \-\-enable\-unicode3, the number of additional precomposed
2069is rather limited (2048, if this is full, rxvt-unicode will use the 2081characters is somewhat limited (the 6400 private use characters will be
2070private use area, extending the number of combinations to 8448). With
2071\&\-\-enable\-unicode3, no practical limit exists. 2082(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2072.Sp 2083.Sp
2073This option will also enable storage (but not display) of characters 2084This option will also enable storage (but not display) of characters
2074beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2085beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2075.Sp 2086.Sp
2076The combining table also contains entries for arabic presentation forms, 2087The combining table also contains entries for arabic presentation forms,
2077but these are not currently used. Bug me if you want these to be used (and 2088but these are not currently used. Bug me if you want these to be used (and
2078tell me how these are to be used...). 2089tell me how these are to be used...).
2079.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2090.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2080.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2091.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2081When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. 2092When reading resource settings, also read settings for class \s-1CLASS\s0. To
2093disable resource fallback use \-\-disable\-fallback.
2082.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2094.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2083.IX Item "--with-res-name=NAME (default: urxvt)" 2095.IX Item "--with-res-name=NAME (default: urxvt)"
2084Use the given name as default application name when 2096Use the given name as default application name when
2085reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2097reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2086.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2098.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
… …
2127.IP "\-\-enable\-plain\-scroll (default: on)" 4 2139.IP "\-\-enable\-plain\-scroll (default: on)" 4
2128.IX Item "--enable-plain-scroll (default: on)" 2140.IX Item "--enable-plain-scroll (default: on)"
2129Add support for a very unobtrusive, plain-looking scrollbar that 2141Add support for a very unobtrusive, plain-looking scrollbar that
2130is the favourite of the rxvt-unicode author, having used it for 2142is the favourite of the rxvt-unicode author, having used it for
2131many years. 2143many years.
2132.IP "\-\-enable\-half\-shadow (default: off)" 4
2133.IX Item "--enable-half-shadow (default: off)"
2134Make shadows on the scrollbar only half the normal width & height.
2135only applicable to rxvt scrollbars.
2136.IP "\-\-enable\-ttygid (default: off)" 4 2144.IP "\-\-enable\-ttygid (default: off)" 4
2137.IX Item "--enable-ttygid (default: off)" 2145.IX Item "--enable-ttygid (default: off)"
2138Change tty device setting to group \*(L"tty\*(R" \- only use this if 2146Change tty device setting to group \*(L"tty\*(R" \- only use this if
2139your system uses this type of security. 2147your system uses this type of security.
2140.IP "\-\-disable\-backspace\-key" 4 2148.IP "\-\-disable\-backspace\-key" 4
… …
2157disable this. 2165disable this.
2158.Sp 2166.Sp
2159A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2167A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2160in combination with other switches) is: 2168in combination with other switches) is:
2161.Sp 2169.Sp
2162.Vb 17 2170.Vb 18
2163\& MWM-hints 2171\& MWM-hints
2164\& EWMH-hints (pid, utf8 names) and protocols (ping) 2172\& EWMH-hints (pid, utf8 names) and protocols (ping)
2165\& seperate underline colour (-underlineColor) 2173\& seperate underline colour (-underlineColor)
2166\& settable border widths and borderless switch (-w, -b, -bl) 2174\& settable border widths and borderless switch (-w, -b, -bl)
2175\& visual selection (-depth)
2167\& settable extra linespacing /-lsp) 2176\& settable extra linespacing /-lsp)
2168\& iso-14755-2 and -3, and visual feedback 2177\& iso-14755-2 and -3, and visual feedback
2169\& backindex and forwardindex escape sequence 2178\& backindex and forwardindex escape sequence
2170\& window op and some xterm/OSC escape sequences 2179\& window op and some xterm/OSC escape sequences
2171\& tripleclickwords (-tcw) 2180\& tripleclickwords (-tcw)
… …
2218keys. This should keep the window corner which is closest to a corner of 2227keys. This should keep the window corner which is closest to a corner of
2219the screen in a fixed position. 2228the screen in a fixed position.
2220.IP "\-\-enable\-pointer\-blank (default: on)" 4 2229.IP "\-\-enable\-pointer\-blank (default: on)" 4
2221.IX Item "--enable-pointer-blank (default: on)" 2230.IX Item "--enable-pointer-blank (default: on)"
2222Add support to have the pointer disappear when typing or inactive. 2231Add support to have the pointer disappear when typing or inactive.
2223.IP "\-\-enable\-perl (default: off)" 4 2232.IP "\-\-enable\-perl (default: on)" 4
2224.IX Item "--enable-perl (default: off)" 2233.IX Item "--enable-perl (default: on)"
2225Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2234Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2226manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2235manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2227in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2236in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2228perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2237perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2229variable when running configure. 2238variable when running configure.

Diff Legend

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