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.7 by pcg, Mon Mar 29 16:52:06 2004 UTC vs.
Revision 1.16 by root, Fri Jul 30 14:59:12 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-28" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-07-26" "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\&.5\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.3\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-fade\fP \fInumber\fP"
60Fade the text by the given percentage when focus is lost\&.
61.IP "\fB-tint\fP \fIcolour\fP"
62Tint the transparent background pixmap with the given colour\&.
59.IP "\fB-bg\fP \fIcolour\fP" 63.IP "\fB-bg\fP \fIcolour\fP"
60Window background colour; 64Window background colour;
61resource \fBbackground\fP\&. 65resource \fBbackground\fP\&.
62.IP "\fB-fg\fP \fIcolour\fP" 66.IP "\fB-fg\fP \fIcolour\fP"
63Window foreground colour; 67Window foreground colour;
… …
70resource \fBbackgroundPixmap\fP\&. 74resource \fBbackgroundPixmap\fP\&.
71.IP "\fB-cr\fP \fIcolour\fP" 75.IP "\fB-cr\fP \fIcolour\fP"
72The cursor colour; 76The cursor colour;
73resource \fBcursorColor\fP\&. 77resource \fBcursorColor\fP\&.
74.IP "\fB-pr\fP \fIcolour\fP" 78.IP "\fB-pr\fP \fIcolour\fP"
75The mouse pointer colour; 79The mouse pointer foreground colour;
76resource \fBpointerColor\fP\&. 80resource \fBpointerColor\fP\&.
81.IP "\fB-pr2\fP \fIcolour\fP"
82The mouse pointer background colour;
83resource \fBpointerColor2\fP\&.
77.IP "\fB-bd\fP \fIcolour\fP" 84.IP "\fB-bd\fP \fIcolour\fP"
78The colour of the border between the xterm scrollbar and the text; 85The colour of the border between the xterm scrollbar and the text;
79resource \fBborderColor\fP\&. 86resource \fBborderColor\fP\&.
80.IP "\fB-fn\fP \fIfontname\fP" 87.IP "\fB-fn\fP \fIfontname\fP"
81Select the fonts to be used used\&. This is a comma seperated 88Select the fonts to be used\&.
82list of font names that are used in turn when trying to display 89This 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, 90trying to display Unicode characters\&.
84other fonts might be smaller, but not larger\&. A reasonable default font list 91The first font defines the cell size for characters; other fonts might
85is always appended to it\&. 92be smaller, but not larger\&.
93A reasonable default font list is always appended to it\&.
86resource \fBfont\fP\&. 94resource \fBfont\fP\&.
95.IP "\fB-rb\fP|\fB+rb\fP"
96Enable "real bold" support\&.
97When this option is on, bold text will be displayed using the first
98available bold font in the font list\&.
99Bold fonts should thus be specified in the font list after their
100corresponding regular fonts\&.
101If no bold font can be found, a regular font will be used\&.
102resource \fBrealBold\fP\&.
87.IP "\fB-name\fP \fIname\fP" 103.IP "\fB-name\fP \fIname\fP"
88Specify the application name under which resources 104Specify the application name under which resources
89are to be obtained, rather than the default executable file name\&. 105are to be obtained, rather than the default executable file name\&.
90Name should not contain `\&.\&' or `*\&' characters\&. 106Name should not contain `\&.\&' or `*\&' characters\&.
91Also sets the icon and title name\&. 107Also sets the icon and title name\&.
… …
181.IP "\fB-mod\fP \fImodifier\fP" 197.IP "\fB-mod\fP \fImodifier\fP"
182Override detection of Meta modifier with specified key: 198Override detection of Meta modifier with specified key:
183\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 199\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
184\fBmod4\fP, \fBmod5\fP; 200\fBmod4\fP, \fBmod5\fP;
185resource \fImodifier\fP\&. 201resource \fImodifier\fP\&.
202.IP "\fB-ssc\fP|\fB+ssc\fP"
203Turn on/off secondary screen (default enabled);
204resource \fBsecondaryScreen\fP\&.
205.IP "\fB-ssr\fP|\fB+ssr\fP"
206Turn on/off secondary screen scroll (default enabled);
207resource \fBsecondaryScroll\fP\&.
186.IP "\fB-xrm\fP \fIresourcestring\fP" 208.IP "\fB-xrm\fP \fIresourcestring\fP"
187No effect on rxvt\&. Simply passes through an argument to be made 209No effect on rxvt\&. Simply passes through an argument to be made
188available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 210available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
189in some window managers\&. 211in some window managers\&.
190.SH "RESOURCES (available also as long-options)" 212.SH "RESOURCES (available also as long-options)"
… …
226but the actual colour names used are listed in the 248but the actual colour names used are listed in the
227\fBCOLORS AND GRAPHICS\fP section\&. 249\fBCOLORS AND GRAPHICS\fP section\&.
228.IP "\fBcolorBD:\fP \fIcolour\fP" 250.IP "\fBcolorBD:\fP \fIcolour\fP"
229Use the specified colour to display bold characters when the 251Use the specified colour to display bold characters when the
230foreground colour is the default\&. 252foreground colour is the default\&.
253This option will be ignored if \fBrealBold\fP is enabled\&.
231.IP "\fBcolorUL:\fP \fIcolour\fP" 254.IP "\fBcolorUL:\fP \fIcolour\fP"
232Use the specified colour to display underlined characters when the 255Use the specified colour to display underlined characters when the
233foreground colour is the default\&. 256foreground colour is the default\&.
234.IP "\fBcolorRV:\fP \fIcolour\fP" 257.IP "\fBcolorRV:\fP \fIcolour\fP"
235Use the specified colour as the background for reverse video 258Use the specified colour as the background for reverse video
… …
256option \fB+j\fP\&. 279option \fB+j\fP\&.
257.IP "\fBinheritPixmap:\fP \fIboolean\fP" 280.IP "\fBinheritPixmap:\fP \fIboolean\fP"
258\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 281\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
259giving artificial transparency\&. 282giving artificial transparency\&.
260\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 283\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
284.IP "\fBtintColor:\fP \fIcolour\fP"
285Tint the transparent background pixmap with the given colour\&.
261.IP "\fBscrollColor:\fP \fIcolour\fP" 286.IP "\fBscrollColor:\fP \fIcolour\fP"
262Use the specified colour for the scrollbar [default #B2B2B2]\&. 287Use the specified colour for the scrollbar [default #B2B2B2]\&.
263.IP "\fBtroughColor:\fP \fIcolour\fP" 288.IP "\fBtroughColor:\fP \fIcolour\fP"
264Use the specified colour for the scrollbar\&'s trough area [default 289Use the specified colour for the scrollbar\&'s trough area [default
265#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 290#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
280.IP "\fBpath:\fP \fIpath\fP" 305.IP "\fBpath:\fP \fIpath\fP"
281Specify the colon-delimited search path for finding files (XPM and 306Specify the colon-delimited search path for finding files (XPM and
282menus), in addition to the paths specified by the \fBRXVTPATH\fP and 307menus), in addition to the paths specified by the \fBRXVTPATH\fP and
283\fBPATH\fP environment variables\&. 308\fBPATH\fP environment variables\&.
284.IP "\fBfont:\fP \fIfontname\fP" 309.IP "\fBfont:\fP \fIfontname\fP"
285Select the fonts to be used used\&. This is a comma seperated 310Select the fonts to be used\&.
286list of font names that are used in turn when trying to display 311This 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, 312trying to display Unicode characters\&.
288other fonts might be smaller, but not larger\&. A reasonable default font list 313The first font defines the cell size for characters; other fonts might
289is always appended to this list\&. 314be smaller, but not larger\&.
315A reasonable default font list is always appended to it\&.
290option \fB-fn\fP\&. 316option \fB-fn\fP\&.
317.IP "\fBrealBold:\fP \fIboolean\fP"
318\fBTrue\fP: Enable "real bold" support\&.
319When this option is on, bold text will be displayed using the first
320available bold font in the font list\&.
321Bold fonts should thus be specified in the font list after their
322corresponding regular fonts\&.
323If no bold font can be found, a regular font will be used\&.
324option \fB-rb\fP\&.
325\fBFalse\fP: Display bold text in a regular font, using the color
326specified with \fBcolorBD\fP;
327option \fB+rb\fP\&.
291.IP "\fBselectstyle:\fP \fImode\fP" 328.IP "\fBselectstyle:\fP \fImode\fP"
292Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 329Set 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 330is xterm style with 2\&.20 old word selection, or anything else which
294gives xterm style selection\&. 331gives xterm style selection\&.
295.IP "\fBscrollstyle:\fP \fImode\fP" 332.IP "\fBscrollstyle:\fP \fImode\fP"
296Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 333Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
297.IP "\fBtitle:\fP \fIstring\fP" 334.IP "\fBtitle:\fP \fIstring\fP"
298Set window title string, the default title is the command-line 335Set window title string, the default title is the command-line
299specified after the \fB-e\fP option, if any, otherwise the application 336specified after the \fB-e\fP option, if any, otherwise the application
300name; 337name;
301option \fB-title\fP\&. 338option \fB-title\fP\&.
… …
402option \fB-bc\fP\&. 439option \fB-bc\fP\&.
403.IP "\fBpointerBlank:\fP \fIboolean\fP" 440.IP "\fBpointerBlank:\fP \fIboolean\fP"
404\fBTrue\fP: blank the pointer when a key is pressed or after a set number 441\fBTrue\fP: blank the pointer when a key is pressed or after a set number
405of seconds of inactivity\&. 442of seconds of inactivity\&.
406\fBFalse\fP: the pointer is always visible [default]\&. 443\fBFalse\fP: the pointer is always visible [default]\&.
444.IP "\fBpointerColor:\fP \fIcolour\fP"
445Mouse pointer foreground colour\&.
446.IP "\fBpointerColor2:\fP \fIcolour\fP"
447Mouse pointer background colour\&.
407.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 448.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
408Specifies number of seconds before blanking the pointer [default 2]\&. 449Specifies number of seconds before blanking the pointer [default 2]\&.
409.IP "\fBbackspacekey:\fP \fIstring\fP" 450.IP "\fBbackspacekey:\fP \fIstring\fP"
410The string to send when the backspace key is pressed\&. If set to 451The string to send when the backspace key is pressed\&. If set to
411\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 452\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
433while staying in another locale\&. 474while staying in another locale\&.
434option \fB-imlocale\fP\&. 475option \fB-imlocale\fP\&.
435.IP "\fBinsecure\fP" 476.IP "\fBinsecure\fP"
436Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 477Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
437that echo arbitrary strings like the icon name or the locale\&. This 478that echo arbitrary strings like the icon name or the locale\&. This
438could be abused if somebody gets 8-bit-clean access to your display, 479could be abused if somebody gets 8-bit-clean access to your
439wether throuh a mail client displaying mail bodies unfiltered or 480display, wether throuh a mail client displaying mail bodies
440though write(1)\&. Therefore, these sequences are disabled by default\&. 481unfiltered or though write(1)\&. Therefore, these sequences are
441You can enable them by setting this boolean resource or specifying 482disabled by default\&. (Note that other terminals, including xterm,
483have these sequences enabled by default)\&. You can enable them
484by setting this boolean resource or specifying \fB-insecure\fP as
442\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 485an option\&. At the moment, this enabled display-answer, locale,
443locale, findfont, icon label and window title requests as well as 486findfont, icon label and window title requests as well as dynamic
444dynamic menubar dispatch\&. 487menubar dispatch\&.
445.IP "\fBmodifier:\fP \fImodifier\fP" 488.IP "\fBmodifier:\fP \fImodifier\fP"
446Set the key to be interpreted as the Meta key to: 489Set the key to be interpreted as the Meta key to:
447\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 490\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
448\fBmod4\fP, \fBmod5\fP; 491\fBmod4\fP, \fBmod5\fP;
449option \fB-mod\fP\&. 492option \fB-mod\fP\&.
450.IP "\fBanswerbackString:\fP \fIstring\fP" 493.IP "\fBanswerbackString:\fP \fIstring\fP"
451Specify the reply rxvt sends to the shell when an ENQ (control-E) 494Specify the reply rxvt sends to the shell when an ENQ (control-E)
452character is passed through\&. It may contain escape values as 495character is passed through\&. It may contain escape values as
453described in the entry on \fBkeysym\fP following\&. 496described in the entry on \fBkeysym\fP following\&.
497.IP "\fBsecondaryScreen:\fP \fIbool\fP"
498Turn on/off secondary screen (default enabled)\&.
499.IP "\fBsecondaryScroll:\fP \fIbool\fP"
500Turn on/off secondary screen scroll (default enabled)\&. If
501the this option is enabled, scrolls on the secondary screen will
502change the scrollback buffer and switching to/from the secondary screen
503will instead scroll the screen up\&.
454.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 504.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
455Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 505Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
456may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 506may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
457\en: newline, \er: return, \et: tab, \e000: octal number) or control 507\en: newline, \er: return, \et: tab, \e000: octal number) or control
458characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 508characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
1029.PP 1079.PP
1030Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1080Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1031.PP 1081.PP
1032.SH "FTP LOCATION" 1082.SH "FTP LOCATION"
1033.PP 1083.PP
1034rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites 1084rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1035ftp://ftp\&.rxvt\&.org/pub/rxvt 1085ftp://ftp\&.rxvt\&.org/pub/rxvt
1036.PP 1086.PP
1037.SH "CURRENT PROJECT COORDINATOR" 1087.SH "CURRENT PROJECT COORDINATOR"
1038.PP 1088.PP
1039.IP "Project Coordinator" 1089.IP "Project Coordinator"
… …
1060.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1110.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1061Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1111Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1062.IP "Geoff Wing <gcw@pobox\&.com>" 1112.IP "Geoff Wing <gcw@pobox\&.com>"
1063Rewrote screen display and text selection routines\&. 1113Rewrote screen display and text selection routines\&.
1064Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1114Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1065.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1115.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1066Rewrote most of the display code and internal character handling 1116Forked rxvt-unicode, rewrote most of the display code and
1067to store text in unicode\&. Numerous other fixes and extensions\&. 1117internal character handling to store text in unicode,
1118improve xterm compatibility and apply numerous other bugfixes
1119and extensions\&.
1068.br 1120.br
1069Project Coordinator (Changes 1\&.0 - ) 1121Project Coordinator (Changes 1\&.0 - )
1070.PP 1122.PP

Diff Legend

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