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

Comparing rxvt-unicode/doc/rxvt.1 (file contents):
Revision 1.6 by pcg, Sun Mar 14 21:59:57 2004 UTC vs.
Revision 1.9 by pcg, Fri Apr 2 18:00:00 2004 UTC

1.if !\n(.g .ab GNU tbl requires GNU troff. 1.if !\n(.g .ab GNU tbl requires GNU troff.
2.if !dTS .ds TS 2.if !dTS .ds TS
3.if !dTE .ds TE 3.if !dTE .ds TE
4.TH "RXVT" "1" "2004-03-14" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7.PP 7.PP
8.SH "SYNOPSIS" 8.SH "SYNOPSIS"
9.PP 9.PP
10\fBrxvt\fP [options] [-e command [ args ]] 10\fBrxvt\fP [options] [-e command [ args ]]
11.PP 11.PP
12.SH "DESCRIPTION" 12.SH "DESCRIPTION"
13.PP 13.PP
14\fBrxvt-unicode\fP, version \fB2\&.4\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB2\&.6\fP, is a colour vt102 terminal emulator
15intended as an \fIxterm\fP(1) replacement for users who do not require 15intended as an \fIxterm\fP(1) replacement for users who do not require
16features such as Tektronix 4014 emulation and toolkit-style configurability\&. 16features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18advantage on a machine serving many X sessions\&. 18advantage on a machine serving many X sessions\&.
19.PP 19.PP
… …
54resource \fBjumpScroll\fP\&. 54resource \fBjumpScroll\fP\&.
55.IP "\fB-ip\fP|\fB+ip\fP" 55.IP "\fB-ip\fP|\fB+ip\fP"
56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
57is \fB-tr\fP; 57is \fB-tr\fP;
58resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&.
59.IP "\fB-bg\fP \fIcolour\fP" 61.IP "\fB-bg\fP \fIcolour\fP"
60Window background colour; 62Window background colour;
61resource \fBbackground\fP\&. 63resource \fBbackground\fP\&.
62.IP "\fB-fg\fP \fIcolour\fP" 64.IP "\fB-fg\fP \fIcolour\fP"
63Window foreground colour; 65Window foreground colour;
… …
79resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
80.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
81Select the fonts to be used used\&. This is a comma seperated 83Select the fonts to be used used\&. This is a comma seperated
82list of font names that are used in turn when trying to display 84list of font names that are used in turn when trying to display
83unicode characters\&. The first font defines the cell size for characters, 85unicode characters\&. The first font defines the cell size for characters,
84pther fonts might be smaller, but not larger\&. A reasonable default list 86other fonts might be smaller, but not larger\&. A reasonable default font list
85is appended\&. 87is always appended to it\&.
86resource \fBfont\fP\&. 88resource \fBfont\fP\&.
87.IP "\fB-name\fP \fIname\fP" 89.IP "\fB-name\fP \fIname\fP"
88Specify the application name under which resources 90Specify the application name under which resources
89are to be obtained, rather than the default executable file name\&. 91are to be obtained, rather than the default executable file name\&.
90Name should not contain `\&.\&' or `*\&' characters\&. 92Name should not contain `\&.\&' or `*\&' characters\&.
… …
172.IP "\fB-imlocale\fP \fIstring\fP" 174.IP "\fB-imlocale\fP \fIstring\fP"
173The locale to use for opening the IM\&. You can use an LC_CTYPE 175The locale to use for opening the IM\&. You can use an LC_CTYPE
174of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 176of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
175for the input extension to be able to input japanese characters 177for the input extension to be able to input japanese characters
176while staying in another locale\&. 178while staying in another locale\&.
179.IP "\fB-insecure\fP"
180Enable "insecure" mode, which currently enables most of the escape
181sequences that echo strings\&. See the resource \fBinsecure\fP for
182more info\&.
177.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
178Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
179\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
180\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
181resource \fImodifier\fP\&. 187resource \fImodifier\fP\&.
188.IP "\fB-ssc\fP|\fB+ssc\fP"
189Turn on/off secondary screen (default enabled);
190resource \fBsecondaryScreen\fP\&.
191.IP "\fB-ssr\fP|\fB+ssr\fP"
192Turn on/off secondary screen scroll (default enabled);
193resource \fBsecondaryScroll\fP\&.
182.IP "\fB-xrm\fP \fIresourcestring\fP" 194.IP "\fB-xrm\fP \fIresourcestring\fP"
183No effect on rxvt\&. Simply passes through an argument to be made 195No effect on rxvt\&. Simply passes through an argument to be made
184available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 196available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
185in some window managers\&. 197in some window managers\&.
186.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
… …
252option \fB+j\fP\&. 264option \fB+j\fP\&.
253.IP "\fBinheritPixmap:\fP \fIboolean\fP" 265.IP "\fBinheritPixmap:\fP \fIboolean\fP"
254\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 266\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
255giving artificial transparency\&. 267giving artificial transparency\&.
256\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 268\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
269.IP "\fBtintColor\fP \fIcolour\fP"
270Tint the transparent background pixmap with the given colour\&.
257.IP "\fBscrollColor:\fP \fIcolour\fP" 271.IP "\fBscrollColor:\fP \fIcolour\fP"
258Use the specified colour for the scrollbar [default #B2B2B2]\&. 272Use the specified colour for the scrollbar [default #B2B2B2]\&.
259.IP "\fBtroughColor:\fP \fIcolour\fP" 273.IP "\fBtroughColor:\fP \fIcolour\fP"
260Use the specified colour for the scrollbar\&'s trough area [default 274Use the specified colour for the scrollbar\&'s trough area [default
261#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 275#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
279\fBPATH\fP environment variables\&. 293\fBPATH\fP environment variables\&.
280.IP "\fBfont:\fP \fIfontname\fP" 294.IP "\fBfont:\fP \fIfontname\fP"
281Select the fonts to be used used\&. This is a comma seperated 295Select the fonts to be used used\&. This is a comma seperated
282list of font names that are used in turn when trying to display 296list of font names that are used in turn when trying to display
283unicode characters\&. The first font defines the cell size for characters, 297unicode characters\&. The first font defines the cell size for characters,
284pther fonts might be smaller, but not larger\&. A reasonable default list 298other fonts might be smaller, but not larger\&. A reasonable default font list
285is appended\&. 299is always appended to this list\&.
286option \fB-fn\fP\&. 300option \fB-fn\fP\&.
287.IP "\fBselectstyle:\fP \fImode\fP" 301.IP "\fBselectstyle:\fP \fImode\fP"
288Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 302Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
289is xterm style with 2\&.20 old word selection, or anything else which 303is xterm style with 2\&.20 old word selection, or anything else which
290gives xterm style selection\&. 304gives xterm style selection\&.
… …
426The locale to use for opening the IM\&. You can use an LC_CTYPE 440The locale to use for opening the IM\&. You can use an LC_CTYPE
427of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 441of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
428for the input extension to be able to input japanese characters 442for the input extension to be able to input japanese characters
429while staying in another locale\&. 443while staying in another locale\&.
430option \fB-imlocale\fP\&. 444option \fB-imlocale\fP\&.
445.IP "\fBinsecure\fP"
446Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
447that echo arbitrary strings like the icon name or the locale\&. This
448could be abused if somebody gets 8-bit-clean access to your
449display, wether throuh a mail client displaying mail bodies
450unfiltered or though write(1)\&. Therefore, these sequences are
451disabled by default\&. (Note that other terminals, including xterm,
452have these sequences enabled by default)\&. You can enable them
453by setting this boolean resource or specifying \fB-insecure\fP as
454an option\&. At the moment, this enabled display-answer, locale,
455findfont, icon label and window title requests as well as dynamic
456menubar dispatch\&.
431.IP "\fBmodifier:\fP \fImodifier\fP" 457.IP "\fBmodifier:\fP \fImodifier\fP"
432Set the key to be interpreted as the Meta key to: 458Set the key to be interpreted as the Meta key to:
433\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 459\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
434\fBmod4\fP, \fBmod5\fP; 460\fBmod4\fP, \fBmod5\fP;
435option \fB-mod\fP\&. 461option \fB-mod\fP\&.
436.IP "\fBanswerbackString:\fP \fIstring\fP" 462.IP "\fBanswerbackString:\fP \fIstring\fP"
437Specify the reply rxvt sends to the shell when an ENQ (control-E) 463Specify the reply rxvt sends to the shell when an ENQ (control-E)
438character is passed through\&. It may contain escape values as 464character is passed through\&. It may contain escape values as
439described in the entry on \fBkeysym\fP following\&. 465described in the entry on \fBkeysym\fP following\&.
466.IP "\fBsecondaryScreen:\fP \fIbool\fP"
467Turn on/off secondary screen (default enabled)\&.
468.IP "\fBsecondaryScroll:\fP \fIbool\fP"
469Turn on/off secondary screen scroll (default enabled)\&. If
470the this option is enabled, scrolls on the secondary screen will
471change the scrollback buffer and switching to/from the secondary screen
472will instead scroll the screen up\&.
440.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 473.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
441Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 474Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
442may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 475may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
443\en: newline, \er: return, \et: tab, \e000: octal number) or control 476\en: newline, \er: return, \et: tab, \e000: octal number) or control
444characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 477characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
1015.PP 1048.PP
1016Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1049Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1017.PP 1050.PP
1018.SH "FTP LOCATION" 1051.SH "FTP LOCATION"
1019.PP 1052.PP
1020rxvt-2\&.4\&.tar\&.gz can be found at the following ftp sites 1053rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites
1021ftp://ftp\&.rxvt\&.org/pub/rxvt 1054ftp://ftp\&.rxvt\&.org/pub/rxvt
1022.PP 1055.PP
1023.SH "CURRENT PROJECT COORDINATOR" 1056.SH "CURRENT PROJECT COORDINATOR"
1024.PP 1057.PP
1025.IP "Project Coordinator" 1058.IP "Project Coordinator"

Diff Legend

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