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.12 by root, Sat Jul 10 20:59:39 2004 UTC vs.
Revision 1.23 by root, Sun Aug 8 16:43:55 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-05-10" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-08-06" "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 \fB3\&.1\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.4\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\&. See also
64the \fB-sh\fP option that can be used to brighten or darken
65the image in addition to tinting it\&.
66.IP "\fB-sh\fP"
67\fInumber\fP
68Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
69image in addition to tinting it (i\&.e\&. \fB-tint\fP must be specified, too)\&.
61.IP "\fB-bg\fP \fIcolour\fP" 70.IP "\fB-bg\fP \fIcolour\fP"
62Window background colour; 71Window background colour;
63resource \fBbackground\fP\&. 72resource \fBbackground\fP\&.
64.IP "\fB-fg\fP \fIcolour\fP" 73.IP "\fB-fg\fP \fIcolour\fP"
65Window foreground colour; 74Window foreground colour;
66resource \fBforeground\fP\&. 75resource \fBforeground\fP\&.
67.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 76.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
68Compile \fIXPM\fP: Specify XPM file for the background and also 77Compile \fIXPM\fP: Specify XPM file for the background and also
69optionally specify its scaling with a geometry string\&. Note you 78optionally specify its scaling with a geometry string\&. Note you
70may need to add quotes to avoid special shell interpretation of 79may need to add quotes to avoid special shell interpretation of
71the `;\&' in the command-line; 80the `;\&' in the command-line;
72resource \fBbackgroundPixmap\fP\&. 81resource \fBbackgroundPixmap\fP\&.
… …
81resource \fBpointerColor2\fP\&. 90resource \fBpointerColor2\fP\&.
82.IP "\fB-bd\fP \fIcolour\fP" 91.IP "\fB-bd\fP \fIcolour\fP"
83The colour of the border between the xterm scrollbar and the text; 92The colour of the border between the xterm scrollbar and the text;
84resource \fBborderColor\fP\&. 93resource \fBborderColor\fP\&.
85.IP "\fB-fn\fP \fIfontname\fP" 94.IP "\fB-fn\fP \fIfontname\fP"
86Select the fonts to be used used\&. This is a comma seperated 95Select the fonts to be used\&.
87list of font names that are used in turn when trying to display 96This is a comma seperated list of font names that are used in turn when
88unicode characters\&. The first font defines the cell size for characters, 97trying to display Unicode characters\&.
89other fonts might be smaller, but not larger\&. A reasonable default font list 98The first font defines the cell size for characters; other fonts might
90is always appended to it\&. 99be smaller, but not larger\&.
100A reasonable default font list is always appended to it\&.
91resource \fBfont\fP\&. 101resource \fBfont\fP\&.
102.IP "\fB-rb\fP|\fB+rb\fP"
103Enable "real bold" support\&.
104When this option is on, bold text will be displayed using the first
105available bold font in the font list\&.
106Bold fonts should thus be specified in the font list after their
107corresponding regular fonts\&.
108If no bold font can be found, a regular font will be used\&.
109resource \fBrealBold\fP\&.
92.IP "\fB-name\fP \fIname\fP" 110.IP "\fB-name\fP \fIname\fP"
93Specify the application name under which resources 111Specify the application name under which resources
94are to be obtained, rather than the default executable file name\&. 112are to be obtained, rather than the default executable file name\&.
95Name should not contain `\&.\&' or `*\&' characters\&. 113Name should not contain `\&.\&' or `*\&' characters\&.
96Also sets the icon and title name\&. 114Also sets the icon and title name\&.
… …
137resource \fBinternalBorder\fP\&. 155resource \fBinternalBorder\fP\&.
138.IP "\fB-w\fP \fInumber\fP" 156.IP "\fB-w\fP \fInumber\fP"
139Compile \fIfrills\fP: External border of \fInumber\fP pixels\&. 157Compile \fIfrills\fP: External border of \fInumber\fP pixels\&.
140Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits; 158Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits;
141resource \fBexternalBorder\fP\&. 159resource \fBexternalBorder\fP\&.
160.IP "\fB-bl\fP"
161Compile \fIfrills\fP: Set MWM hints to request a borderless window,
162i\&.e\&. if honoured by the WM, the rxvt window will not have window
163decorations; resource \fBborderLess\fP\&.
142.IP "\fB-lsp\fP \fInumber\fP" 164.IP "\fB-lsp\fP \fInumber\fP"
143Compile \fIlinespace\fP: Lines (pixel height) to insert between each 165Compile \fIlinespace\fP: Lines (pixel height) to insert between each
144row of the display; 166row of the display;
145resource \fBlinespace\fP\&. 167resource \fBlinespace\fP\&.
146.IP "\fB-tn\fP \fItermname\fP" 168.IP "\fB-tn\fP \fItermname\fP"
… …
200in some window managers\&. 222in some window managers\&.
201.SH "RESOURCES (available also as long-options)" 223.SH "RESOURCES (available also as long-options)"
202.PP 224.PP
203Note: `rxvt --help\&' gives a list of all resources (long options) compiled 225Note: `rxvt --help\&' gives a list of all resources (long options) compiled
204into your version\&. 226into your version\&.
227.PP
228There are two different methods that rxvt can use to get the
229Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
230reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
231\fBXGetDefaults\fP), you can set and change the resources using X11
232tools like \fBxset\fP\&. Many distribution do also load settings from the
233\fB~/\&.Xresources\fP file when X starts\&.
234.PP
205If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 235If compiled with internal Xresources support (i\&.e\&. \fBrxvt
206\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 236-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
207XAPPLOADDIR/Rxvt (compile-time defined: usually 237defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
208\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 238\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
209or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 239\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
210reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 240Note that when reading X resources, \fBrxvt\fP recognizes two class
211\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 241names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
212\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 242common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
213\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 243while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
214key-handling, to be shared between different \fBrxvt\fP configurations\&. 244notably colours and key-handling, to be shared between different
215If no resources are specified, suitable defaults will be used\&. 245\fBrxvt\fP configurations\&. If no resources are specified, suitable
216Command-line arguments can be used to override resource settings\&. The 246defaults will be used\&. Command-line arguments can be used to override
217following resources are allowed: 247resource settings\&. The following resources are allowed:
218.PP 248.PP
219.IP "\fBgeometry:\fP \fIgeom\fP" 249.IP "\fBgeometry:\fP \fIgeom\fP"
220Create the window with the specified X window geometry [default 250Create the window with the specified X window geometry [default
22180x24]; 25180x24];
222option \fB-geometry\fP\&. 252option \fB-geometry\fP\&.
… …
237but the actual colour names used are listed in the 267but the actual colour names used are listed in the
238\fBCOLORS AND GRAPHICS\fP section\&. 268\fBCOLORS AND GRAPHICS\fP section\&.
239.IP "\fBcolorBD:\fP \fIcolour\fP" 269.IP "\fBcolorBD:\fP \fIcolour\fP"
240Use the specified colour to display bold characters when the 270Use the specified colour to display bold characters when the
241foreground colour is the default\&. 271foreground colour is the default\&.
272This option will be ignored if \fBrealBold\fP is enabled\&.
242.IP "\fBcolorUL:\fP \fIcolour\fP" 273.IP "\fBcolorUL:\fP \fIcolour\fP"
243Use the specified colour to display underlined characters when the 274Use the specified colour to display underlined characters when the
244foreground colour is the default\&. 275foreground colour is the default\&.
245.IP "\fBcolorRV:\fP \fIcolour\fP" 276.IP "\fBcolorRV:\fP \fIcolour\fP"
246Use the specified colour as the background for reverse video 277Use the specified colour as the background for reverse video
… …
267option \fB+j\fP\&. 298option \fB+j\fP\&.
268.IP "\fBinheritPixmap:\fP \fIboolean\fP" 299.IP "\fBinheritPixmap:\fP \fIboolean\fP"
269\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 300\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
270giving artificial transparency\&. 301giving artificial transparency\&.
271\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 302\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
303.IP "\fBfading:\fP \fInumber\fP"
304Fade the text by the given percentage when focus is lost\&.
272.IP "\fBtintColor\fP \fIcolour\fP" 305.IP "\fBtintColor:\fP \fIcolour\fP"
273Tint the transparent background pixmap with the given colour\&. 306Tint the transparent background pixmap with the given colour\&.
307.IP "\fBshading:\fP \fInumber\fP"
308Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
309image in addition to tinting it\&.
310.IP "\fBfading:\fP \fInumber\fP"
311Scale the tint colour by the given percentage\&.
274.IP "\fBscrollColor:\fP \fIcolour\fP" 312.IP "\fBscrollColor:\fP \fIcolour\fP"
275Use the specified colour for the scrollbar [default #B2B2B2]\&. 313Use the specified colour for the scrollbar [default #B2B2B2]\&.
276.IP "\fBtroughColor:\fP \fIcolour\fP" 314.IP "\fBtroughColor:\fP \fIcolour\fP"
277Use the specified colour for the scrollbar\&'s trough area [default 315Use the specified colour for the scrollbar\&'s trough area [default
278#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 316#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
293.IP "\fBpath:\fP \fIpath\fP" 331.IP "\fBpath:\fP \fIpath\fP"
294Specify the colon-delimited search path for finding files (XPM and 332Specify the colon-delimited search path for finding files (XPM and
295menus), in addition to the paths specified by the \fBRXVTPATH\fP and 333menus), in addition to the paths specified by the \fBRXVTPATH\fP and
296\fBPATH\fP environment variables\&. 334\fBPATH\fP environment variables\&.
297.IP "\fBfont:\fP \fIfontname\fP" 335.IP "\fBfont:\fP \fIfontname\fP"
298Select the fonts to be used used\&. This is a comma seperated 336Select the fonts to be used\&.
299list of font names that are used in turn when trying to display 337This is a comma seperated list of font names that are used in turn when
300unicode characters\&. The first font defines the cell size for characters, 338trying to display Unicode characters\&.
301other fonts might be smaller, but not larger\&. A reasonable default font list 339The first font defines the cell size for characters; other fonts might
302is always appended to this list\&. 340be smaller, but not larger\&.
341A reasonable default font list is always appended to it\&.
303option \fB-fn\fP\&. 342option \fB-fn\fP\&.
343.IP "\fBrealBold:\fP \fIboolean\fP"
344\fBTrue\fP: Enable "real bold" support\&.
345When this option is on, bold text will be displayed using the first
346available bold font in the font list\&.
347Bold fonts should thus be specified in the font list after their
348corresponding regular fonts\&.
349If no bold font can be found, a regular font will be used\&.
350option \fB-rb\fP\&.
351\fBFalse\fP: Display bold text in a regular font, using the color
352specified with \fBcolorBD\fP;
353option \fB+rb\fP\&.
304.IP "\fBselectstyle:\fP \fImode\fP" 354.IP "\fBselectstyle:\fP \fImode\fP"
305Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 355Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
306is xterm style with 2\&.20 old word selection, or anything else which 356is xterm style with 2\&.20 old word selection, or anything else which
307gives xterm style selection\&. 357gives xterm style selection\&.
308.IP "\fBscrollstyle:\fP \fImode\fP" 358.IP "\fBscrollstyle:\fP \fImode\fP"
… …
393Internal border of \fInumber\fP pixels\&. This resource is limited to 100; 443Internal border of \fInumber\fP pixels\&. This resource is limited to 100;
394option \fB-b\fP\&. 444option \fB-b\fP\&.
395.IP "\fBexternalBorder:\fP \fInumber\fP" 445.IP "\fBexternalBorder:\fP \fInumber\fP"
396External border of \fInumber\fP pixels\&. This resource is limited to 100; 446External border of \fInumber\fP pixels\&. This resource is limited to 100;
397option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&. 447option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&.
448.IP "\fBborderLess:\fP \fIboolean\fP"
449Set MWM hints to request a borderless window,
450i\&.e\&. if honoured by the WM, the rxvt window will not have window
451decorations; option \fB-bl\fP\&.
398.IP "\fBtermName:\fP \fItermname\fP" 452.IP "\fBtermName:\fP \fItermname\fP"
399Specifies the terminal type name to be set in the \fBTERM\fP 453Specifies the terminal type name to be set in the \fBTERM\fP
400environment variable; 454environment variable;
401option \fB-tn\fP\&. 455option \fB-tn\fP\&.
402.IP "\fBlinespace:\fP \fInumber\fP" 456.IP "\fBlinespace:\fP \fInumber\fP"
… …
1055.PP 1109.PP
1056Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1110Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1057.PP 1111.PP
1058.SH "FTP LOCATION" 1112.SH "FTP LOCATION"
1059.PP 1113.PP
1060rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites 1114rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites
1061ftp://ftp\&.rxvt\&.org/pub/rxvt 1115ftp://ftp\&.rxvt\&.org/pub/rxvt
1062.PP 1116.PP
1063.SH "CURRENT PROJECT COORDINATOR" 1117.SH "CURRENT PROJECT COORDINATOR"
1064.PP 1118.PP
1065.IP "Project Coordinator" 1119.IP "Project Coordinator"

Diff Legend

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