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.14 by root, Thu Jul 29 22:30:28 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-07-26" "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\&.2\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\&.
82list of font names that are used in turn when trying to display 87This is a comma seperated list of font names that are used in turn when
83unicode characters\&. The first font defines the cell size for characters, 88trying to display Unicode characters\&.
84pther fonts might be smaller, but not larger\&. A reasonable default list 89The first font defines the cell size for characters; other fonts might
85is appended\&. 90be smaller, but not larger\&.
91A reasonable default font list is always appended to it\&.
86resource \fBfont\fP\&. 92resource \fBfont\fP\&.
93.IP "\fB-rb\fP|\fB+rb\fP"
94Enable "real bold" support\&.
95When this option is on, bold text will be displayed using the first
96available bold font in the font list\&.
97Bold fonts should thus be specified in the font list after their
98corresponding regular fonts\&.
99If no bold font can be found, a regular font will be used\&.
100resource \fBrealBold\fP\&.
87.IP "\fB-name\fP \fIname\fP" 101.IP "\fB-name\fP \fIname\fP"
88Specify the application name under which resources 102Specify the application name under which resources
89are to be obtained, rather than the default executable file name\&. 103are to be obtained, rather than the default executable file name\&.
90Name should not contain `\&.\&' or `*\&' characters\&. 104Name should not contain `\&.\&' or `*\&' characters\&.
91Also sets the icon and title name\&. 105Also sets the icon and title name\&.
115Put scrollbar on right/left; 129Put scrollbar on right/left;
116resource \fBscrollBar_right\fP\&. 130resource \fBscrollBar_right\fP\&.
117.IP "\fB-st\fP|\fB+st\fP" 131.IP "\fB-st\fP|\fB+st\fP"
118Display normal (non XTerm/NeXT) scrollbar without/with a trough; 132Display normal (non XTerm/NeXT) scrollbar without/with a trough;
119resource \fBscrollBar_floating\fP\&. 133resource \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" 134.IP "\fB-bc\fP|\fB+bc\fP"
125Blink the cursor; resource \fBcursorBlink\fP\&. 135Blink the cursor; resource \fBcursorBlink\fP\&.
126.IP "\fB-iconic\fP" 136.IP "\fB-iconic\fP"
127Start iconified, if the window manager supports that option\&. 137Start iconified, if the window manager supports that option\&.
128Alternative form is \fB-ic\fP\&. 138Alternative form is \fB-ic\fP\&.
176.IP "\fB-imlocale\fP \fIstring\fP" 186.IP "\fB-imlocale\fP \fIstring\fP"
177The locale to use for opening the IM\&. You can use an LC_CTYPE 187The 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 188of 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 189for the input extension to be able to input japanese characters
180while staying in another locale\&. 190while staying in another locale\&.
191.IP "\fB-insecure\fP"
192Enable "insecure" mode, which currently enables most of the escape
193sequences that echo strings\&. See the resource \fBinsecure\fP for
194more info\&.
181.IP "\fB-mod\fP \fImodifier\fP" 195.IP "\fB-mod\fP \fImodifier\fP"
182Override detection of Meta modifier with specified key: 196Override detection of Meta modifier with specified key:
183\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 197\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
184\fBmod4\fP, \fBmod5\fP; 198\fBmod4\fP, \fBmod5\fP;
185resource \fImodifier\fP\&. 199resource \fImodifier\fP\&.
200.IP "\fB-ssc\fP|\fB+ssc\fP"
201Turn on/off secondary screen (default enabled);
202resource \fBsecondaryScreen\fP\&.
203.IP "\fB-ssr\fP|\fB+ssr\fP"
204Turn on/off secondary screen scroll (default enabled);
205resource \fBsecondaryScroll\fP\&.
186.IP "\fB-xrm\fP \fIresourcestring\fP" 206.IP "\fB-xrm\fP \fIresourcestring\fP"
187No effect on rxvt\&. Simply passes through an argument to be made 207No effect on rxvt\&. Simply passes through an argument to be made
188available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 208available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
189in some window managers\&. 209in some window managers\&.
190.SH "RESOURCES (available also as long-options)" 210.SH "RESOURCES (available also as long-options)"
226but the actual colour names used are listed in the 246but the actual colour names used are listed in the
227\fBCOLORS AND GRAPHICS\fP section\&. 247\fBCOLORS AND GRAPHICS\fP section\&.
228.IP "\fBcolorBD:\fP \fIcolour\fP" 248.IP "\fBcolorBD:\fP \fIcolour\fP"
229Use the specified colour to display bold characters when the 249Use the specified colour to display bold characters when the
230foreground colour is the default\&. 250foreground colour is the default\&.
251This option will be ignored if \fBrealBold\fP is enabled\&.
231.IP "\fBcolorUL:\fP \fIcolour\fP" 252.IP "\fBcolorUL:\fP \fIcolour\fP"
232Use the specified colour to display underlined characters when the 253Use the specified colour to display underlined characters when the
233foreground colour is the default\&. 254foreground colour is the default\&.
234.IP "\fBcolorRV:\fP \fIcolour\fP" 255.IP "\fBcolorRV:\fP \fIcolour\fP"
235Use the specified colour as the background for reverse video 256Use the specified colour as the background for reverse video
256option \fB+j\fP\&. 277option \fB+j\fP\&.
257.IP "\fBinheritPixmap:\fP \fIboolean\fP" 278.IP "\fBinheritPixmap:\fP \fIboolean\fP"
258\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 279\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
259giving artificial transparency\&. 280giving artificial transparency\&.
260\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 281\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
282.IP "\fBtintColor:\fP \fIcolour\fP"
283Tint the transparent background pixmap with the given colour\&.
261.IP "\fBscrollColor:\fP \fIcolour\fP" 284.IP "\fBscrollColor:\fP \fIcolour\fP"
262Use the specified colour for the scrollbar [default #B2B2B2]\&. 285Use the specified colour for the scrollbar [default #B2B2B2]\&.
263.IP "\fBtroughColor:\fP \fIcolour\fP" 286.IP "\fBtroughColor:\fP \fIcolour\fP"
264Use the specified colour for the scrollbar\&'s trough area [default 287Use the specified colour for the scrollbar\&'s trough area [default
265#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 288#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
280.IP "\fBpath:\fP \fIpath\fP" 303.IP "\fBpath:\fP \fIpath\fP"
281Specify the colon-delimited search path for finding files (XPM and 304Specify the colon-delimited search path for finding files (XPM and
282menus), in addition to the paths specified by the \fBRXVTPATH\fP and 305menus), in addition to the paths specified by the \fBRXVTPATH\fP and
283\fBPATH\fP environment variables\&. 306\fBPATH\fP environment variables\&.
284.IP "\fBfont:\fP \fIfontname\fP" 307.IP "\fBfont:\fP \fIfontname\fP"
285Select the fonts to be used used\&. This is a comma seperated 308Select the fonts to be used\&.
286list of font names that are used in turn when trying to display 309This is a comma seperated list of font names that are used in turn when
287unicode characters\&. The first font defines the cell size for characters, 310trying to display Unicode characters\&.
288pther fonts might be smaller, but not larger\&. A reasonable default list 311The first font defines the cell size for characters; other fonts might
289is appended\&. 312be smaller, but not larger\&.
313A reasonable default font list is always appended to it\&.
290option \fB-fn\fP\&. 314option \fB-fn\fP\&.
315.IP "\fBrealBold:\fP \fIboolean\fP"
316\fBTrue\fP: Enable "real bold" support\&.
317When this option is on, bold text will be displayed using the first
318available bold font in the font list\&.
319Bold fonts should thus be specified in the font list after their
320corresponding regular fonts\&.
321If no bold font can be found, a regular font will be used\&.
322option \fB-rb\fP\&.
323\fBFalse\fP: Display bold text in a regular font, using the color
324specified with \fBcolorBD\fP;
325option \fB+rb\fP\&.
291.IP "\fBselectstyle:\fP \fImode\fP" 326.IP "\fBselectstyle:\fP \fImode\fP"
292Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 327Set 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 328is xterm style with 2\&.20 old word selection, or anything else which
294gives xterm style selection\&. 329gives xterm style selection\&.
295.IP "\fBscrollstyle:\fP \fImode\fP" 330.IP "\fBscrollstyle:\fP \fImode\fP"
296Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 331Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
297.IP "\fBtitle:\fP \fIstring\fP" 332.IP "\fBtitle:\fP \fIstring\fP"
298Set window title string, the default title is the command-line 333Set window title string, the default title is the command-line
299specified after the \fB-e\fP option, if any, otherwise the application 334specified after the \fB-e\fP option, if any, otherwise the application
300name; 335name;
301option \fB-title\fP\&. 336option \fB-title\fP\&.
402option \fB-bc\fP\&. 437option \fB-bc\fP\&.
403.IP "\fBpointerBlank:\fP \fIboolean\fP" 438.IP "\fBpointerBlank:\fP \fIboolean\fP"
404\fBTrue\fP: blank the pointer when a key is pressed or after a set number 439\fBTrue\fP: blank the pointer when a key is pressed or after a set number
405of seconds of inactivity\&. 440of seconds of inactivity\&.
406\fBFalse\fP: the pointer is always visible [default]\&. 441\fBFalse\fP: the pointer is always visible [default]\&.
442.IP "\fBpointerColor:\fP \fIcolour\fP"
443Mouse pointer foreground colour\&.
444.IP "\fBpointerColor2:\fP \fIcolour\fP"
445Mouse pointer background colour\&.
407.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 446.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
408Specifies number of seconds before blanking the pointer [default 2]\&. 447Specifies 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" 448.IP "\fBbackspacekey:\fP \fIstring\fP"
416The string to send when the backspace key is pressed\&. If set to 449The 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, 450\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 451\fBBackspace\fP (code 8) - which can be reversed with the appropriate
419DEC private mode escape sequence\&. 452DEC private mode escape sequence\&.
436The locale to use for opening the IM\&. You can use an LC_CTYPE 469The 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 470of 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 471for the input extension to be able to input japanese characters
439while staying in another locale\&. 472while staying in another locale\&.
440option \fB-imlocale\fP\&. 473option \fB-imlocale\fP\&.
474.IP "\fBinsecure\fP"
475Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
476that echo arbitrary strings like the icon name or the locale\&. This
477could be abused if somebody gets 8-bit-clean access to your
478display, wether throuh a mail client displaying mail bodies
479unfiltered or though write(1)\&. Therefore, these sequences are
480disabled by default\&. (Note that other terminals, including xterm,
481have these sequences enabled by default)\&. You can enable them
482by setting this boolean resource or specifying \fB-insecure\fP as
483an option\&. At the moment, this enabled display-answer, locale,
484findfont, icon label and window title requests as well as dynamic
485menubar dispatch\&.
441.IP "\fBmodifier:\fP \fImodifier\fP" 486.IP "\fBmodifier:\fP \fImodifier\fP"
442Set the key to be interpreted as the Meta key to: 487Set 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, 488\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
444\fBmod4\fP, \fBmod5\fP; 489\fBmod4\fP, \fBmod5\fP;
445option \fB-mod\fP\&. 490option \fB-mod\fP\&.
446.IP "\fBanswerbackString:\fP \fIstring\fP" 491.IP "\fBanswerbackString:\fP \fIstring\fP"
447Specify the reply rxvt sends to the shell when an ENQ (control-E) 492Specify the reply rxvt sends to the shell when an ENQ (control-E)
448character is passed through\&. It may contain escape values as 493character is passed through\&. It may contain escape values as
449described in the entry on \fBkeysym\fP following\&. 494described in the entry on \fBkeysym\fP following\&.
495.IP "\fBsecondaryScreen:\fP \fIbool\fP"
496Turn on/off secondary screen (default enabled)\&.
497.IP "\fBsecondaryScroll:\fP \fIbool\fP"
498Turn on/off secondary screen scroll (default enabled)\&. If
499the this option is enabled, scrolls on the secondary screen will
500change the scrollback buffer and switching to/from the secondary screen
501will instead scroll the screen up\&.
450.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 502.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
451Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 503Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
452may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 504may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
453\en: newline, \er: return, \et: tab, \e000: octal number) or control 505\en: newline, \er: return, \et: tab, \e000: octal number) or control
454characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 506characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
1025.PP 1077.PP
1026Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1078Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1027.PP 1079.PP
1028.SH "FTP LOCATION" 1080.SH "FTP LOCATION"
1029.PP 1081.PP
1030rxvt-+RXVTVERSION()\&.tar\&.gz can be found at the following ftp sites 1082rxvt-3\&.2\&.tar\&.gz can be found at the following ftp sites
1031RXVTFTPSITE() 1083ftp://ftp\&.rxvt\&.org/pub/rxvt
1032.PP 1084.PP
1033.SH "CURRENT PROJECT COORDINATOR" 1085.SH "CURRENT PROJECT COORDINATOR"
1034.PP 1086.PP
1035.IP "Project Coordinator" 1087.IP "Project Coordinator"
1036RXVTMAINT() RXVTMAINTEMAIL() 1088Marc A\&. Lehmann <rxvt@schmorp\&.de>
1037.br 1089.br
1038.IP "Web page maintainter" 1090.IP "Web page maintainter"
1039RXVTWEBMAINT() RXVTWEBMAINTEMAIL() 1091Marc A\&. Lehmann <rxvt@schmorp\&.de>
1040.br 1092.br
1041RXVTWEBPAGE() 1093<http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1042.br 1094.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 1095.PP
1052.SH "AUTHORS" 1096.SH "AUTHORS"
1053.PP 1097.PP
1054.IP "John Bovey" 1098.IP "John Bovey"
1055University of Kent, 1992, wrote the original Xvt\&. 1099University of Kent, 1992, wrote the original Xvt\&.
1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1108.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1109Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1066.IP "Geoff Wing <gcw@pobox\&.com>" 1110.IP "Geoff Wing <gcw@pobox\&.com>"
1067Rewrote screen display and text selection routines\&. 1111Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1112Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1113.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling 1114Forked rxvt-unicode, rewrote most of the display code and
1071to store text in unicode\&. Numerous other fixes and extensions\&. 1115internal character handling to store text in unicode,
1116improve xterm compatibility and apply numerous other bugfixes
1117and extensions\&.
1072.br 1118.br
1073Project Coordinator (Changes 1\&.0 - ) 1119Project Coordinator (Changes 1\&.0 - )
1074.PP 1120.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines