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.4 by pcg, Sun Feb 22 12:58:01 2004 UTC vs.
Revision 1.12 by root, Sat Jul 10 20:59:39 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" "RXVTDATE()" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-05-10" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt (ouR XVT) \- 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\fP, version \fBRXVTVERSION()\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.1\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\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
20.PP 20.PP
21.SH "OPTIONS" 21.SH "OPTIONS"
22.PP 22.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;
70resource \fBbackgroundPixmap\fP\&. 72resource \fBbackgroundPixmap\fP\&.
71.IP "\fB-cr\fP \fIcolour\fP" 73.IP "\fB-cr\fP \fIcolour\fP"
72The cursor colour; 74The cursor colour;
73resource \fBcursorColor\fP\&. 75resource \fBcursorColor\fP\&.
74.IP "\fB-pr\fP \fIcolour\fP" 76.IP "\fB-pr\fP \fIcolour\fP"
75The mouse pointer colour; 77The mouse pointer foreground colour;
76resource \fBpointerColor\fP\&. 78resource \fBpointerColor\fP\&.
79.IP "\fB-pr2\fP \fIcolour\fP"
80The mouse pointer background colour;
81resource \fBpointerColor2\fP\&.
77.IP "\fB-bd\fP \fIcolour\fP" 82.IP "\fB-bd\fP \fIcolour\fP"
78The colour of the border between the xterm scrollbar and the text; 83The colour of the border between the xterm scrollbar and the text;
79resource \fBborderColor\fP\&. 84resource \fBborderColor\fP\&.
80.IP "\fB-fn\fP \fIfontname\fP" 85.IP "\fB-fn\fP \fIfontname\fP"
81Select the fonts to be used used\&. This is a comma seperated 86Select the fonts to be used used\&. This is a comma seperated
82list of font names that are used in turn when trying to display 87list of font names that are used in turn when trying to display
83unicode characters\&. The first font defines the cell size for characters, 88unicode characters\&. The first font defines the cell size for characters,
84pther fonts might be smaller, but not larger\&. A reasonable default list 89other fonts might be smaller, but not larger\&. A reasonable default font list
85is appended\&. 90is always appended to it\&.
86resource \fBfont\fP\&. 91resource \fBfont\fP\&.
87.IP "\fB-name\fP \fIname\fP" 92.IP "\fB-name\fP \fIname\fP"
88Specify the application name under which resources 93Specify the application name under which resources
89are to be obtained, rather than the default executable file name\&. 94are to be obtained, rather than the default executable file name\&.
90Name should not contain `\&.\&' or `*\&' characters\&. 95Name should not contain `\&.\&' or `*\&' characters\&.
115Put scrollbar on right/left; 120Put scrollbar on right/left;
116resource \fBscrollBar_right\fP\&. 121resource \fBscrollBar_right\fP\&.
117.IP "\fB-st\fP|\fB+st\fP" 122.IP "\fB-st\fP|\fB+st\fP"
118Display normal (non XTerm/NeXT) scrollbar without/with a trough; 123Display normal (non XTerm/NeXT) scrollbar without/with a trough;
119resource \fBscrollBar_floating\fP\&. 124resource \fBscrollBar_floating\fP\&.
120.IP "\fB-mcc\fP|\fB+mcc\fP"
121Compile \fImultichar_languages\fP: treat multibyte glyphs as single
122character for backspace, delete and cursor movement keys;
123resource \fBmultibyte_cursor\fP\&.
124.IP "\fB-bc\fP|\fB+bc\fP" 125.IP "\fB-bc\fP|\fB+bc\fP"
125Blink the cursor; resource \fBcursorBlink\fP\&. 126Blink the cursor; resource \fBcursorBlink\fP\&.
126.IP "\fB-iconic\fP" 127.IP "\fB-iconic\fP"
127Start iconified, if the window manager supports that option\&. 128Start iconified, if the window manager supports that option\&.
128Alternative form is \fB-ic\fP\&. 129Alternative form is \fB-ic\fP\&.
176.IP "\fB-imlocale\fP \fIstring\fP" 177.IP "\fB-imlocale\fP \fIstring\fP"
177The locale to use for opening the IM\&. You can use an LC_CTYPE 178The locale to use for opening the IM\&. You can use an LC_CTYPE
178of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 179of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
179for the input extension to be able to input japanese characters 180for the input extension to be able to input japanese characters
180while staying in another locale\&. 181while staying in another locale\&.
182.IP "\fB-insecure\fP"
183Enable "insecure" mode, which currently enables most of the escape
184sequences that echo strings\&. See the resource \fBinsecure\fP for
185more info\&.
181.IP "\fB-mod\fP \fImodifier\fP" 186.IP "\fB-mod\fP \fImodifier\fP"
182Override detection of Meta modifier with specified key: 187Override detection of Meta modifier with specified key:
183\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 188\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
184\fBmod4\fP, \fBmod5\fP; 189\fBmod4\fP, \fBmod5\fP;
185resource \fImodifier\fP\&. 190resource \fImodifier\fP\&.
191.IP "\fB-ssc\fP|\fB+ssc\fP"
192Turn on/off secondary screen (default enabled);
193resource \fBsecondaryScreen\fP\&.
194.IP "\fB-ssr\fP|\fB+ssr\fP"
195Turn on/off secondary screen scroll (default enabled);
196resource \fBsecondaryScroll\fP\&.
186.IP "\fB-xrm\fP \fIresourcestring\fP" 197.IP "\fB-xrm\fP \fIresourcestring\fP"
187No effect on rxvt\&. Simply passes through an argument to be made 198No effect on rxvt\&. Simply passes through an argument to be made
188available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 199available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
189in some window managers\&. 200in some window managers\&.
190.SH "RESOURCES (available also as long-options)" 201.SH "RESOURCES (available also as long-options)"
256option \fB+j\fP\&. 267option \fB+j\fP\&.
257.IP "\fBinheritPixmap:\fP \fIboolean\fP" 268.IP "\fBinheritPixmap:\fP \fIboolean\fP"
258\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 269\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
259giving artificial transparency\&. 270giving artificial transparency\&.
260\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 271\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
272.IP "\fBtintColor\fP \fIcolour\fP"
273Tint the transparent background pixmap with the given colour\&.
261.IP "\fBscrollColor:\fP \fIcolour\fP" 274.IP "\fBscrollColor:\fP \fIcolour\fP"
262Use the specified colour for the scrollbar [default #B2B2B2]\&. 275Use the specified colour for the scrollbar [default #B2B2B2]\&.
263.IP "\fBtroughColor:\fP \fIcolour\fP" 276.IP "\fBtroughColor:\fP \fIcolour\fP"
264Use the specified colour for the scrollbar\&'s trough area [default 277Use the specified colour for the scrollbar\&'s trough area [default
265#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 278#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
283\fBPATH\fP environment variables\&. 296\fBPATH\fP environment variables\&.
284.IP "\fBfont:\fP \fIfontname\fP" 297.IP "\fBfont:\fP \fIfontname\fP"
285Select the fonts to be used used\&. This is a comma seperated 298Select the fonts to be used used\&. This is a comma seperated
286list of font names that are used in turn when trying to display 299list of font names that are used in turn when trying to display
287unicode characters\&. The first font defines the cell size for characters, 300unicode characters\&. The first font defines the cell size for characters,
288pther fonts might be smaller, but not larger\&. A reasonable default list 301other fonts might be smaller, but not larger\&. A reasonable default font list
289is appended\&. 302is always appended to this list\&.
290option \fB-fn\fP\&. 303option \fB-fn\fP\&.
291.IP "\fBselectstyle:\fP \fImode\fP" 304.IP "\fBselectstyle:\fP \fImode\fP"
292Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 305Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
293is xterm style with 2\&.20 old word selection, or anything else which 306is xterm style with 2\&.20 old word selection, or anything else which
294gives xterm style selection\&. 307gives xterm style selection\&.
295.IP "\fBscrollstyle:\fP \fImode\fP" 308.IP "\fBscrollstyle:\fP \fImode\fP"
296Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 309Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
297.IP "\fBtitle:\fP \fIstring\fP" 310.IP "\fBtitle:\fP \fIstring\fP"
298Set window title string, the default title is the command-line 311Set window title string, the default title is the command-line
299specified after the \fB-e\fP option, if any, otherwise the application 312specified after the \fB-e\fP option, if any, otherwise the application
300name; 313name;
301option \fB-title\fP\&. 314option \fB-title\fP\&.
402option \fB-bc\fP\&. 415option \fB-bc\fP\&.
403.IP "\fBpointerBlank:\fP \fIboolean\fP" 416.IP "\fBpointerBlank:\fP \fIboolean\fP"
404\fBTrue\fP: blank the pointer when a key is pressed or after a set number 417\fBTrue\fP: blank the pointer when a key is pressed or after a set number
405of seconds of inactivity\&. 418of seconds of inactivity\&.
406\fBFalse\fP: the pointer is always visible [default]\&. 419\fBFalse\fP: the pointer is always visible [default]\&.
420.IP "\fBpointerColor:\fP \fIcolour\fP"
421Mouse pointer foreground colour\&.
422.IP "\fBpointerColor2:\fP \fIcolour\fP"
423Mouse pointer background colour\&.
407.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 424.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
408Specifies number of seconds before blanking the pointer [default 2]\&. 425Specifies number of seconds before blanking the pointer [default 2]\&.
409.IP "\fBmultibyte_cursor:\fP \fIboolean\fP"
410\fBTrue\fP: consider multibyte glyphs as single character for backspace,
411delete and cursor movement keys;
412option \fB-mcc\fP\&.
413\fBFalse\fP: move through all components of all glyphs;
414option \fB+mcc\fP\&.
415.IP "\fBbackspacekey:\fP \fIstring\fP" 426.IP "\fBbackspacekey:\fP \fIstring\fP"
416The string to send when the backspace key is pressed\&. If set to 427The string to send when the backspace key is pressed\&. If set to
417\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 428\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
418\fBBackspace\fP (code 8) - which can be reversed with the appropriate 429\fBBackspace\fP (code 8) - which can be reversed with the appropriate
419DEC private mode escape sequence\&. 430DEC private mode escape sequence\&.
436The locale to use for opening the IM\&. You can use an LC_CTYPE 447The locale to use for opening the IM\&. You can use an LC_CTYPE
437of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP 448of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
438for the input extension to be able to input japanese characters 449for the input extension to be able to input japanese characters
439while staying in another locale\&. 450while staying in another locale\&.
440option \fB-imlocale\fP\&. 451option \fB-imlocale\fP\&.
452.IP "\fBinsecure\fP"
453Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
454that echo arbitrary strings like the icon name or the locale\&. This
455could be abused if somebody gets 8-bit-clean access to your
456display, wether throuh a mail client displaying mail bodies
457unfiltered or though write(1)\&. Therefore, these sequences are
458disabled by default\&. (Note that other terminals, including xterm,
459have these sequences enabled by default)\&. You can enable them
460by setting this boolean resource or specifying \fB-insecure\fP as
461an option\&. At the moment, this enabled display-answer, locale,
462findfont, icon label and window title requests as well as dynamic
463menubar dispatch\&.
441.IP "\fBmodifier:\fP \fImodifier\fP" 464.IP "\fBmodifier:\fP \fImodifier\fP"
442Set the key to be interpreted as the Meta key to: 465Set the key to be interpreted as the Meta key to:
443\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 466\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
444\fBmod4\fP, \fBmod5\fP; 467\fBmod4\fP, \fBmod5\fP;
445option \fB-mod\fP\&. 468option \fB-mod\fP\&.
446.IP "\fBanswerbackString:\fP \fIstring\fP" 469.IP "\fBanswerbackString:\fP \fIstring\fP"
447Specify the reply rxvt sends to the shell when an ENQ (control-E) 470Specify the reply rxvt sends to the shell when an ENQ (control-E)
448character is passed through\&. It may contain escape values as 471character is passed through\&. It may contain escape values as
449described in the entry on \fBkeysym\fP following\&. 472described in the entry on \fBkeysym\fP following\&.
473.IP "\fBsecondaryScreen:\fP \fIbool\fP"
474Turn on/off secondary screen (default enabled)\&.
475.IP "\fBsecondaryScroll:\fP \fIbool\fP"
476Turn on/off secondary screen scroll (default enabled)\&. If
477the this option is enabled, scrolls on the secondary screen will
478change the scrollback buffer and switching to/from the secondary screen
479will instead scroll the screen up\&.
450.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 480.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
451Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 481Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
452may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 482may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
453\en: newline, \er: return, \et: tab, \e000: octal number) or control 483\en: newline, \er: return, \et: tab, \e000: octal number) or control
454characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 484characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
1025.PP 1055.PP
1026Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1056Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1027.PP 1057.PP
1028.SH "FTP LOCATION" 1058.SH "FTP LOCATION"
1029.PP 1059.PP
1030rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1060rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
1031RXVTFTPSITE() 1061ftp://ftp\&.rxvt\&.org/pub/rxvt
1032.PP 1062.PP
1033.SH "CURRENT PROJECT COORDINATOR" 1063.SH "CURRENT PROJECT COORDINATOR"
1034.PP 1064.PP
1035.IP "Project Coordinator" 1065.IP "Project Coordinator"
1036RXVTMAINT() RXVTMAINTEMAIL() 1066Marc A\&. Lehmann <rxvt@schmorp\&.de>
1037.br 1067.br
1038.IP "Web page maintainter" 1068.IP "Web page maintainter"
1039RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1069Marc A\&. Lehmann <rxvt@schmorp\&.de>
1040.br 1070.br
1041RXVTWEBPAGE() 1071<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1042.br 1072.br
1043.IP "Mailing list"
1044The Rxvt Workers <rxvt-workers@rxvt\&.org>
1045mailing list has also been established for rxvt development, to
1046subscribe, email to
1047<rxvt-workers-subscribe@rxvt\&.org>\&.
1048There is also a mailing list for announcements of new releases of
1049rxvt\&. To subscribe, email to
1050<rxvt-announce-subscribe@rxvt\&.org>\&.
1051.PP 1073.PP
1052.SH "AUTHORS" 1074.SH "AUTHORS"
1053.PP 1075.PP
1054.IP "John Bovey" 1076.IP "John Bovey"
1055University of Kent, 1992, wrote the original Xvt\&. 1077University of Kent, 1992, wrote the original Xvt\&.
1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1086.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1087Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1066.IP "Geoff Wing <gcw@pobox\&.com>" 1088.IP "Geoff Wing <gcw@pobox\&.com>"
1067Rewrote screen display and text selection routines\&. 1089Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1090Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1091.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling 1092Forked rxvt-unicode, rewrote most of the display code and
1071to store text in unicode\&. Numerous other fixes and extensions\&. 1093internal character handling to store text in unicode,
1094improve xterm compatibility and apply numerous other bugfixes
1095and extensions\&.
1072.br 1096.br
1073Project Coordinator (Changes 1\&.0 - ) 1097Project Coordinator (Changes 1\&.0 - )
1074.PP 1098.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines