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.8 by pcg, Fri Apr 2 00:51:09 2004 UTC vs.
Revision 1.19 by root, Fri Jul 30 22:36:42 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\&.6\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\&.
59.IP "\fB-tint\fP \fIcolour\fP" 61.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&. 62Tint the transparent background pixmap with the given colour when
63transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. You can also
64emulate the "shading" or "brigthness change" option known from
65other terminal programs using gray10 (gray20, etc\&.) colour
66strings\&.
61.IP "\fB-bg\fP \fIcolour\fP" 67.IP "\fB-bg\fP \fIcolour\fP"
62Window background colour; 68Window background colour;
63resource \fBbackground\fP\&. 69resource \fBbackground\fP\&.
64.IP "\fB-fg\fP \fIcolour\fP" 70.IP "\fB-fg\fP \fIcolour\fP"
65Window foreground colour; 71Window foreground colour;
… …
72resource \fBbackgroundPixmap\fP\&. 78resource \fBbackgroundPixmap\fP\&.
73.IP "\fB-cr\fP \fIcolour\fP" 79.IP "\fB-cr\fP \fIcolour\fP"
74The cursor colour; 80The cursor colour;
75resource \fBcursorColor\fP\&. 81resource \fBcursorColor\fP\&.
76.IP "\fB-pr\fP \fIcolour\fP" 82.IP "\fB-pr\fP \fIcolour\fP"
77The mouse pointer colour; 83The mouse pointer foreground colour;
78resource \fBpointerColor\fP\&. 84resource \fBpointerColor\fP\&.
85.IP "\fB-pr2\fP \fIcolour\fP"
86The mouse pointer background colour;
87resource \fBpointerColor2\fP\&.
79.IP "\fB-bd\fP \fIcolour\fP" 88.IP "\fB-bd\fP \fIcolour\fP"
80The colour of the border between the xterm scrollbar and the text; 89The colour of the border between the xterm scrollbar and the text;
81resource \fBborderColor\fP\&. 90resource \fBborderColor\fP\&.
82.IP "\fB-fn\fP \fIfontname\fP" 91.IP "\fB-fn\fP \fIfontname\fP"
83Select the fonts to be used used\&. This is a comma seperated 92Select the fonts to be used\&.
84list of font names that are used in turn when trying to display 93This is a comma seperated list of font names that are used in turn when
85unicode characters\&. The first font defines the cell size for characters, 94trying to display Unicode characters\&.
86other fonts might be smaller, but not larger\&. A reasonable default font list 95The first font defines the cell size for characters; other fonts might
87is always appended to it\&. 96be smaller, but not larger\&.
97A reasonable default font list is always appended to it\&.
88resource \fBfont\fP\&. 98resource \fBfont\fP\&.
99.IP "\fB-rb\fP|\fB+rb\fP"
100Enable "real bold" support\&.
101When this option is on, bold text will be displayed using the first
102available bold font in the font list\&.
103Bold fonts should thus be specified in the font list after their
104corresponding regular fonts\&.
105If no bold font can be found, a regular font will be used\&.
106resource \fBrealBold\fP\&.
89.IP "\fB-name\fP \fIname\fP" 107.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 108Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 109are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 110Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 111Also sets the icon and title name\&.
… …
183.IP "\fB-mod\fP \fImodifier\fP" 201.IP "\fB-mod\fP \fImodifier\fP"
184Override detection of Meta modifier with specified key: 202Override detection of Meta modifier with specified key:
185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 203\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
186\fBmod4\fP, \fBmod5\fP; 204\fBmod4\fP, \fBmod5\fP;
187resource \fImodifier\fP\&. 205resource \fImodifier\fP\&.
206.IP "\fB-ssc\fP|\fB+ssc\fP"
207Turn on/off secondary screen (default enabled);
208resource \fBsecondaryScreen\fP\&.
209.IP "\fB-ssr\fP|\fB+ssr\fP"
210Turn on/off secondary screen scroll (default enabled);
211resource \fBsecondaryScroll\fP\&.
188.IP "\fB-xrm\fP \fIresourcestring\fP" 212.IP "\fB-xrm\fP \fIresourcestring\fP"
189No effect on rxvt\&. Simply passes through an argument to be made 213No effect on rxvt\&. Simply passes through an argument to be made
190available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 214available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
191in some window managers\&. 215in some window managers\&.
192.SH "RESOURCES (available also as long-options)" 216.SH "RESOURCES (available also as long-options)"
193.PP 217.PP
194Note: `rxvt --help\&' gives a list of all resources (long options) compiled 218Note: `rxvt --help\&' gives a list of all resources (long options) compiled
195into your version\&. 219into your version\&.
220.PP
221There are two different methods that rxvt can use to get the
222Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
223reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
224\fBXGetDefaults\fP), you can set and change the resources using X11
225tools like \fBxset\fP\&. Many distribution do also load settings from the
226\fB~/\&.Xresources\fP file when X starts\&.
227.PP
196If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 228If compiled with internal Xresources support (i\&.e\&. \fBrxvt
197\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 229-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
198XAPPLOADDIR/Rxvt (compile-time defined: usually 230defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
199\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 231\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
200or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 232\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
201reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 233Note that when reading X resources, \fBrxvt\fP recognizes two class
202\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 234names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
203\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 235common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
204\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 236while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
205key-handling, to be shared between different \fBrxvt\fP configurations\&. 237notably colours and key-handling, to be shared between different
206If no resources are specified, suitable defaults will be used\&. 238\fBrxvt\fP configurations\&. If no resources are specified, suitable
207Command-line arguments can be used to override resource settings\&. The 239defaults will be used\&. Command-line arguments can be used to override
208following resources are allowed: 240resource settings\&. The following resources are allowed:
209.PP 241.PP
210.IP "\fBgeometry:\fP \fIgeom\fP" 242.IP "\fBgeometry:\fP \fIgeom\fP"
211Create the window with the specified X window geometry [default 243Create the window with the specified X window geometry [default
21280x24]; 24480x24];
213option \fB-geometry\fP\&. 245option \fB-geometry\fP\&.
… …
228but the actual colour names used are listed in the 260but the actual colour names used are listed in the
229\fBCOLORS AND GRAPHICS\fP section\&. 261\fBCOLORS AND GRAPHICS\fP section\&.
230.IP "\fBcolorBD:\fP \fIcolour\fP" 262.IP "\fBcolorBD:\fP \fIcolour\fP"
231Use the specified colour to display bold characters when the 263Use the specified colour to display bold characters when the
232foreground colour is the default\&. 264foreground colour is the default\&.
265This option will be ignored if \fBrealBold\fP is enabled\&.
233.IP "\fBcolorUL:\fP \fIcolour\fP" 266.IP "\fBcolorUL:\fP \fIcolour\fP"
234Use the specified colour to display underlined characters when the 267Use the specified colour to display underlined characters when the
235foreground colour is the default\&. 268foreground colour is the default\&.
236.IP "\fBcolorRV:\fP \fIcolour\fP" 269.IP "\fBcolorRV:\fP \fIcolour\fP"
237Use the specified colour as the background for reverse video 270Use the specified colour as the background for reverse video
… …
258option \fB+j\fP\&. 291option \fB+j\fP\&.
259.IP "\fBinheritPixmap:\fP \fIboolean\fP" 292.IP "\fBinheritPixmap:\fP \fIboolean\fP"
260\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 293\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
261giving artificial transparency\&. 294giving artificial transparency\&.
262\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 295\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
296.IP "\fBfading:\fP \fInumber\fP"
297Fade the text by the given percentage when focus is lost\&.
263.IP "\fBtintColor\fP \fIcolour\fP" 298.IP "\fBtintColor:\fP \fIcolour\fP"
264Tint the transparent background pixmap with the given colour\&. 299Tint the transparent background pixmap with the given colour\&.
300.IP "\fBfading:\fP \fInumber\fP"
301Scale the tint colour by the given percentage\&.
265.IP "\fBscrollColor:\fP \fIcolour\fP" 302.IP "\fBscrollColor:\fP \fIcolour\fP"
266Use the specified colour for the scrollbar [default #B2B2B2]\&. 303Use the specified colour for the scrollbar [default #B2B2B2]\&.
267.IP "\fBtroughColor:\fP \fIcolour\fP" 304.IP "\fBtroughColor:\fP \fIcolour\fP"
268Use the specified colour for the scrollbar\&'s trough area [default 305Use the specified colour for the scrollbar\&'s trough area [default
269#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 306#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
284.IP "\fBpath:\fP \fIpath\fP" 321.IP "\fBpath:\fP \fIpath\fP"
285Specify the colon-delimited search path for finding files (XPM and 322Specify the colon-delimited search path for finding files (XPM and
286menus), in addition to the paths specified by the \fBRXVTPATH\fP and 323menus), in addition to the paths specified by the \fBRXVTPATH\fP and
287\fBPATH\fP environment variables\&. 324\fBPATH\fP environment variables\&.
288.IP "\fBfont:\fP \fIfontname\fP" 325.IP "\fBfont:\fP \fIfontname\fP"
289Select the fonts to be used used\&. This is a comma seperated 326Select the fonts to be used\&.
290list of font names that are used in turn when trying to display 327This is a comma seperated list of font names that are used in turn when
291unicode characters\&. The first font defines the cell size for characters, 328trying to display Unicode characters\&.
292other fonts might be smaller, but not larger\&. A reasonable default font list 329The first font defines the cell size for characters; other fonts might
293is always appended to this list\&. 330be smaller, but not larger\&.
331A reasonable default font list is always appended to it\&.
294option \fB-fn\fP\&. 332option \fB-fn\fP\&.
333.IP "\fBrealBold:\fP \fIboolean\fP"
334\fBTrue\fP: Enable "real bold" support\&.
335When this option is on, bold text will be displayed using the first
336available bold font in the font list\&.
337Bold fonts should thus be specified in the font list after their
338corresponding regular fonts\&.
339If no bold font can be found, a regular font will be used\&.
340option \fB-rb\fP\&.
341\fBFalse\fP: Display bold text in a regular font, using the color
342specified with \fBcolorBD\fP;
343option \fB+rb\fP\&.
295.IP "\fBselectstyle:\fP \fImode\fP" 344.IP "\fBselectstyle:\fP \fImode\fP"
296Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 345Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
297is xterm style with 2\&.20 old word selection, or anything else which 346is xterm style with 2\&.20 old word selection, or anything else which
298gives xterm style selection\&. 347gives xterm style selection\&.
299.IP "\fBscrollstyle:\fP \fImode\fP" 348.IP "\fBscrollstyle:\fP \fImode\fP"
300Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 349Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
301.IP "\fBtitle:\fP \fIstring\fP" 350.IP "\fBtitle:\fP \fIstring\fP"
302Set window title string, the default title is the command-line 351Set window title string, the default title is the command-line
303specified after the \fB-e\fP option, if any, otherwise the application 352specified after the \fB-e\fP option, if any, otherwise the application
304name; 353name;
305option \fB-title\fP\&. 354option \fB-title\fP\&.
… …
406option \fB-bc\fP\&. 455option \fB-bc\fP\&.
407.IP "\fBpointerBlank:\fP \fIboolean\fP" 456.IP "\fBpointerBlank:\fP \fIboolean\fP"
408\fBTrue\fP: blank the pointer when a key is pressed or after a set number 457\fBTrue\fP: blank the pointer when a key is pressed or after a set number
409of seconds of inactivity\&. 458of seconds of inactivity\&.
410\fBFalse\fP: the pointer is always visible [default]\&. 459\fBFalse\fP: the pointer is always visible [default]\&.
460.IP "\fBpointerColor:\fP \fIcolour\fP"
461Mouse pointer foreground colour\&.
462.IP "\fBpointerColor2:\fP \fIcolour\fP"
463Mouse pointer background colour\&.
411.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 464.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
412Specifies number of seconds before blanking the pointer [default 2]\&. 465Specifies number of seconds before blanking the pointer [default 2]\&.
413.IP "\fBbackspacekey:\fP \fIstring\fP" 466.IP "\fBbackspacekey:\fP \fIstring\fP"
414The string to send when the backspace key is pressed\&. If set to 467The string to send when the backspace key is pressed\&. If set to
415\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 468\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
437while staying in another locale\&. 490while staying in another locale\&.
438option \fB-imlocale\fP\&. 491option \fB-imlocale\fP\&.
439.IP "\fBinsecure\fP" 492.IP "\fBinsecure\fP"
440Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 493Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
441that echo arbitrary strings like the icon name or the locale\&. This 494that echo arbitrary strings like the icon name or the locale\&. This
442could be abused if somebody gets 8-bit-clean access to your display, 495could be abused if somebody gets 8-bit-clean access to your
443wether throuh a mail client displaying mail bodies unfiltered or 496display, wether throuh a mail client displaying mail bodies
444though write(1)\&. Therefore, these sequences are disabled by default\&. 497unfiltered or though write(1)\&. Therefore, these sequences are
445You can enable them by setting this boolean resource or specifying 498disabled by default\&. (Note that other terminals, including xterm,
499have these sequences enabled by default)\&. You can enable them
500by setting this boolean resource or specifying \fB-insecure\fP as
446\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 501an option\&. At the moment, this enabled display-answer, locale,
447locale, findfont, icon label and window title requests as well as 502findfont, icon label and window title requests as well as dynamic
448dynamic menubar dispatch\&. 503menubar dispatch\&.
449.IP "\fBmodifier:\fP \fImodifier\fP" 504.IP "\fBmodifier:\fP \fImodifier\fP"
450Set the key to be interpreted as the Meta key to: 505Set the key to be interpreted as the Meta key to:
451\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 506\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
452\fBmod4\fP, \fBmod5\fP; 507\fBmod4\fP, \fBmod5\fP;
453option \fB-mod\fP\&. 508option \fB-mod\fP\&.
454.IP "\fBanswerbackString:\fP \fIstring\fP" 509.IP "\fBanswerbackString:\fP \fIstring\fP"
455Specify the reply rxvt sends to the shell when an ENQ (control-E) 510Specify the reply rxvt sends to the shell when an ENQ (control-E)
456character is passed through\&. It may contain escape values as 511character is passed through\&. It may contain escape values as
457described in the entry on \fBkeysym\fP following\&. 512described in the entry on \fBkeysym\fP following\&.
513.IP "\fBsecondaryScreen:\fP \fIbool\fP"
514Turn on/off secondary screen (default enabled)\&.
515.IP "\fBsecondaryScroll:\fP \fIbool\fP"
516Turn on/off secondary screen scroll (default enabled)\&. If
517the this option is enabled, scrolls on the secondary screen will
518change the scrollback buffer and switching to/from the secondary screen
519will instead scroll the screen up\&.
458.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 520.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
459Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 521Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
460may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 522may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
461\en: newline, \er: return, \et: tab, \e000: octal number) or control 523\en: newline, \er: return, \et: tab, \e000: octal number) or control
462characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 524characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
1033.PP 1095.PP
1034Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1096Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1035.PP 1097.PP
1036.SH "FTP LOCATION" 1098.SH "FTP LOCATION"
1037.PP 1099.PP
1038rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 1100rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1039ftp://ftp\&.rxvt\&.org/pub/rxvt 1101ftp://ftp\&.rxvt\&.org/pub/rxvt
1040.PP 1102.PP
1041.SH "CURRENT PROJECT COORDINATOR" 1103.SH "CURRENT PROJECT COORDINATOR"
1042.PP 1104.PP
1043.IP "Project Coordinator" 1105.IP "Project Coordinator"
… …
1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1126.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1127Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1066.IP "Geoff Wing <gcw@pobox\&.com>" 1128.IP "Geoff Wing <gcw@pobox\&.com>"
1067Rewrote screen display and text selection routines\&. 1129Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1130Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1131.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling 1132Forked rxvt-unicode, rewrote most of the display code and
1071to store text in unicode\&. Numerous other fixes and extensions\&. 1133internal character handling to store text in unicode,
1134improve xterm compatibility and apply numerous other bugfixes
1135and extensions\&.
1072.br 1136.br
1073Project Coordinator (Changes 1\&.0 - ) 1137Project Coordinator (Changes 1\&.0 - )
1074.PP 1138.PP

Diff Legend

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