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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.83 by root, Mon Jan 16 14:48:39 2006 UTC vs.
Revision 1.90 by root, Mon Jan 23 01:46:55 2006 UTC

159daemon. 159daemon.
160 160
161=item I am using Debian GNU/Linux and have a problem... 161=item I am using Debian GNU/Linux and have a problem...
162 162
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large 163The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164patches that considerably change the behaviour of rxvt-unicode. Before 164patches that considerably change the behaviour of rxvt-unicode (but
165reporting a bug to the original rxvt-unicode author please download and 165unfortunately this notice has been removed). Before reporting a bug to
166install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 166the original rxvt-unicode author please download and install the genuine
167and try to reproduce the problem. If you cannot, chances are that the 167version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168problems are specific to Debian GNU/Linux, in which case it should be 168the problem. If you cannot, chances are that the problems are specific to
169reported via the Debian Bug Tracking System (use C<reportbug> to report 169Debian GNU/Linux, in which case it should be reported via the Debian Bug
170the bug). 170Tracking System (use C<reportbug> to report the bug).
171 171
172For other problems that also affect the Debian package, you can and 172For other problems that also affect the Debian package, you can and
173probably should use the Debian BTS, too, because, after all, it's also a 173probably should use the Debian BTS, too, because, after all, it's also a
174bug in the Debian version and it serves as a reminder for other users that 174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue. 175might encounter the same issue.
176 176
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 177=item I am maintaining rxvt-unicode for distribution/OS XXX, any
178recommendation?
178 179
179You should build one binary with the default options. F<configure> 180You should build one binary with the default options. F<configure>
180now enables most useful options, and the trend goes to making them 181now enables most useful options, and the trend goes to making them
181runtime-switchable, too, so there is usually no drawback to enbaling them, 182runtime-switchable, too, so there is usually no drawback to enbaling them,
182except higher disk and possibly memory usage. The perl interpreter should 183except higher disk and possibly memory usage. The perl interpreter should
194C<--enable-everything> (less useful, it will be very big due to a lot of 195C<--enable-everything> (less useful, it will be very big due to a lot of
195encodings built-in that increase download times and are rarely used). 196encodings built-in that increase download times and are rarely used).
196 197
197=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 198=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
198 199
199Likely not. While I honestly try to make it secure, and am probably not 200It should be, starting with release 7.1. You are encouraged to properly
200bad at it, I think it is simply unreasonable to expect all of freetype 201install urxvt with privileges necessary for your OS now.
201+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
202secure. Also, rxvt-unicode disables some options when it detects that it
203runs setuid or setgid, which is not nice. Besides, with the embedded perl
204interpreter the possibility for security problems easily multiplies.
205 202
206Elevated privileges are only required for utmp and pty operations on some 203When rxvt-unicode detects that it runs setuid or setgid, it will fork
207systems (for example, GNU/Linux doesn't need any extra privileges for 204into a helper process for privileged operations (pty handling on some
208ptys, but some need it for utmp support). It is planned to mvoe this into 205systems, utmp/wtmp/lastlog handling on others) and drop privileges
209a forked handler process, but this is not yet done. 206immediately. This is much safer than most other terminals that keep
207privileges while running (but is more relevant to urxvt, as it contains
208things as perl interpreters, which might be "helpful" to attackers).
210 209
211So, while setuid/setgid operation is supported and not a problem on your 210This forking is done as the very first within main(), which is very early
212typical single-user-no-other-logins unix desktop, always remember that 211and reduces possible bugs to initialisation code run before main(), or
213its an awful lot of code, most of which isn't checked for security issues 212things like the dynamic loader of your system, which should result in very
214regularly. 213little risk.
215 214
216=item When I log-in to another system it tells me about missing terminfo data? 215=item When I log-in to another system it tells me about missing terminfo data?
217 216
218The terminal description used by rxvt-unicode is not as widely available 217The terminal description used by rxvt-unicode is not as widely available
219as that for xterm, or even rxvt (for which the same problem often arises). 218as that for xterm, or even rxvt (for which the same problem often arises).
616=item My input method wants <some encoding> but I want UTF-8, what can I do? 615=item My input method wants <some encoding> but I want UTF-8, what can I do?
617 616
618You can specify separate locales for the input method and the rest of the 617You can specify separate locales for the input method and the rest of the
619terminal, using the resource C<imlocale>: 618terminal, using the resource C<imlocale>:
620 619
621 URxvt*imlocale: ja_JP.EUC-JP 620 URxvt.imlocale: ja_JP.EUC-JP
622 621
623Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 622Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
624use your input method. Please note, however, that you will not be able to 623use your input method. Please note, however, that you will not be able to
625input characters outside C<EUC-JP> in a normal way then, as your input 624input characters outside C<EUC-JP> in a normal way then, as your input
626method limits you. 625method limits you.
899 898
900=head1 DESCRIPTION 899=head1 DESCRIPTION
901 900
902The rest of this document describes various technical aspects of 901The rest of this document describes various technical aspects of
903B<rxvt-unicode>. First the description of supported command sequences, 902B<rxvt-unicode>. First the description of supported command sequences,
904followed by menu and pixmap support and last by a description of all 903followed by pixmap support and last by a description of all features
905features selectable at C<configure> time. 904selectable at C<configure> time.
906 905
907=head1 Definitions 906=head1 Definitions
908 907
909=over 4 908=over 4
910 909
1669 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1668 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1670 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1669 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1671 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1670 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1672 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 1671 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1673 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 1672 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1674 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1673 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1675 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1674 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1676 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1675 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1677 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1676 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1678 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1677 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1679 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1678 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1948alternative input methods (e.g. kinput2) and will also correctly 1947alternative input methods (e.g. kinput2) and will also correctly
1949set up the input for people using dead keys or compose keys. 1948set up the input for people using dead keys or compose keys.
1950 1949
1951=item --enable-unicode3 (default: off) 1950=item --enable-unicode3 (default: off)
1952 1951
1952Recommended to stay off unless you really need non-BMP characters.
1953
1953Enable direct support for displaying unicode codepoints above 1954Enable direct support for displaying unicode codepoints above
195465535 (the basic multilingual page). This increases storage 195565535 (the basic multilingual page). This increases storage
1955requirements per character from 2 to 4 bytes. X11 fonts do not yet 1956requirements per character from 2 to 4 bytes. X11 fonts do not yet
1956support these extra characters, but Xft does. 1957support these extra characters, but Xft does.
1957 1958
1967composite characters. This is required for proper viewing of text 1968composite characters. This is required for proper viewing of text
1968where accents are encoded as seperate unicode characters. This is 1969where accents are encoded as seperate unicode characters. This is
1969done by using precomposited characters when available or creating 1970done by using precomposited characters when available or creating
1970new pseudo-characters when no precomposed form exists. 1971new pseudo-characters when no precomposed form exists.
1971 1972
1972Without --enable-unicode3, the number of additional precomposed characters 1973Without --enable-unicode3, the number of additional precomposed
1973is rather limited (2048, if this is full, rxvt-unicode will use the 1974characters is somewhat limited (the 6400 private use characters will be
1974private use area, extending the number of combinations to 8448). With
1975--enable-unicode3, no practical limit exists. 1975(ab-)used). With --enable-unicode3, no practical limit exists.
1976 1976
1977This option will also enable storage (but not display) of characters 1977This option will also enable storage (but not display) of characters
1978beyond plane 0 (>65535) when --enable-unicode3 was not specified. 1978beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1979 1979
1980The combining table also contains entries for arabic presentation forms, 1980The combining table also contains entries for arabic presentation forms,
1981but these are not currently used. Bug me if you want these to be used (and 1981but these are not currently used. Bug me if you want these to be used (and
1982tell me how these are to be used...). 1982tell me how these are to be used...).
1983 1983
1984=item --enable-fallback(=CLASS) (default: Rxvt) 1984=item --enable-fallback(=CLASS) (default: Rxvt)
1985 1985
1986When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 1986When reading resource settings, also read settings for class CLASS. To
1987disable resource fallback use --disable-fallback.
1987 1988
1988=item --with-res-name=NAME (default: urxvt) 1989=item --with-res-name=NAME (default: urxvt)
1989 1990
1990Use the given name as default application name when 1991Use the given name as default application name when
1991reading resources. Specify --with-res-name=rxvt to replace rxvt. 1992reading resources. Specify --with-res-name=rxvt to replace rxvt.
2045=item --enable-plain-scroll (default: on) 2046=item --enable-plain-scroll (default: on)
2046 2047
2047Add support for a very unobtrusive, plain-looking scrollbar that 2048Add support for a very unobtrusive, plain-looking scrollbar that
2048is the favourite of the rxvt-unicode author, having used it for 2049is the favourite of the rxvt-unicode author, having used it for
2049many years. 2050many years.
2050
2051=item --enable-half-shadow (default: off)
2052
2053Make shadows on the scrollbar only half the normal width & height.
2054only applicable to rxvt scrollbars.
2055 2051
2056=item --enable-ttygid (default: off) 2052=item --enable-ttygid (default: off)
2057 2053
2058Change tty device setting to group "tty" - only use this if 2054Change tty device setting to group "tty" - only use this if
2059your system uses this type of security. 2055your system uses this type of security.
2151 2147
2152=item --enable-pointer-blank (default: on) 2148=item --enable-pointer-blank (default: on)
2153 2149
2154Add support to have the pointer disappear when typing or inactive. 2150Add support to have the pointer disappear when typing or inactive.
2155 2151
2156=item --enable-perl (default: off) 2152=item --enable-perl (default: on)
2157 2153
2158Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2154Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2159manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2155manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2160in F<src/perl-ext/> for the extensions that are installed by default. The 2156in F<src/perl-ext/> for the extensions that are installed by default. The
2161perl interpreter that is used can be specified via the C<PERL> environment 2157perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines