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.20 by root, Sat Jul 31 15:32:50 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-07-31" "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\&.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;
66resource \fBforeground\fP\&. 72resource \fBforeground\fP\&.
67.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 73.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
68Compile \fIXPM\fP: Specify XPM file for the background and also 74Compile \fIXPM\fP: Specify XPM file for the background and also
69optionally specify its scaling with a geometry string\&. Note you 75optionally specify its scaling with a geometry string\&. Note you
70may need to add quotes to avoid special shell interpretation of 76may need to add quotes to avoid special shell interpretation of
71the `;\&' in the command-line; 77the `;\&' in the command-line;
72resource \fBbackgroundPixmap\fP\&. 78resource \fBbackgroundPixmap\fP\&.
… …
81resource \fBpointerColor2\fP\&. 87resource \fBpointerColor2\fP\&.
82.IP "\fB-bd\fP \fIcolour\fP" 88.IP "\fB-bd\fP \fIcolour\fP"
83The colour of the border between the xterm scrollbar and the text; 89The colour of the border between the xterm scrollbar and the text;
84resource \fBborderColor\fP\&. 90resource \fBborderColor\fP\&.
85.IP "\fB-fn\fP \fIfontname\fP" 91.IP "\fB-fn\fP \fIfontname\fP"
86Select the fonts to be used used\&. This is a comma seperated 92Select the fonts to be used\&.
87list 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
88unicode characters\&. The first font defines the cell size for characters, 94trying to display Unicode characters\&.
89other fonts might be smaller, but not larger\&. A reasonable default font list 95The first font defines the cell size for characters; other fonts might
90is always appended to it\&. 96be smaller, but not larger\&.
97A reasonable default font list is always appended to it\&.
91resource \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\&.
92.IP "\fB-name\fP \fIname\fP" 107.IP "\fB-name\fP \fIname\fP"
93Specify the application name under which resources 108Specify the application name under which resources
94are to be obtained, rather than the default executable file name\&. 109are to be obtained, rather than the default executable file name\&.
95Name should not contain `\&.\&' or `*\&' characters\&. 110Name should not contain `\&.\&' or `*\&' characters\&.
96Also sets the icon and title name\&. 111Also sets the icon and title name\&.
… …
200in some window managers\&. 215in some window managers\&.
201.SH "RESOURCES (available also as long-options)" 216.SH "RESOURCES (available also as long-options)"
202.PP 217.PP
203Note: `rxvt --help\&' gives a list of all resources (long options) compiled 218Note: `rxvt --help\&' gives a list of all resources (long options) compiled
204into 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
205If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 228If compiled with internal Xresources support (i\&.e\&. \fBrxvt
206\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 229-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
207XAPPLOADDIR/Rxvt (compile-time defined: usually 230defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
208\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
209or \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\&.
210reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 233Note that when reading X resources, \fBrxvt\fP recognizes two class
211\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
212\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,
213\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 236while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
214key-handling, to be shared between different \fBrxvt\fP configurations\&. 237notably colours and key-handling, to be shared between different
215If no resources are specified, suitable defaults will be used\&. 238\fBrxvt\fP configurations\&. If no resources are specified, suitable
216Command-line arguments can be used to override resource settings\&. The 239defaults will be used\&. Command-line arguments can be used to override
217following resources are allowed: 240resource settings\&. The following resources are allowed:
218.PP 241.PP
219.IP "\fBgeometry:\fP \fIgeom\fP" 242.IP "\fBgeometry:\fP \fIgeom\fP"
220Create the window with the specified X window geometry [default 243Create the window with the specified X window geometry [default
22180x24]; 24480x24];
222option \fB-geometry\fP\&. 245option \fB-geometry\fP\&.
… …
237but the actual colour names used are listed in the 260but the actual colour names used are listed in the
238\fBCOLORS AND GRAPHICS\fP section\&. 261\fBCOLORS AND GRAPHICS\fP section\&.
239.IP "\fBcolorBD:\fP \fIcolour\fP" 262.IP "\fBcolorBD:\fP \fIcolour\fP"
240Use the specified colour to display bold characters when the 263Use the specified colour to display bold characters when the
241foreground colour is the default\&. 264foreground colour is the default\&.
265This option will be ignored if \fBrealBold\fP is enabled\&.
242.IP "\fBcolorUL:\fP \fIcolour\fP" 266.IP "\fBcolorUL:\fP \fIcolour\fP"
243Use the specified colour to display underlined characters when the 267Use the specified colour to display underlined characters when the
244foreground colour is the default\&. 268foreground colour is the default\&.
245.IP "\fBcolorRV:\fP \fIcolour\fP" 269.IP "\fBcolorRV:\fP \fIcolour\fP"
246Use the specified colour as the background for reverse video 270Use the specified colour as the background for reverse video
… …
267option \fB+j\fP\&. 291option \fB+j\fP\&.
268.IP "\fBinheritPixmap:\fP \fIboolean\fP" 292.IP "\fBinheritPixmap:\fP \fIboolean\fP"
269\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 293\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
270giving artificial transparency\&. 294giving artificial transparency\&.
271\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\&.
272.IP "\fBtintColor\fP \fIcolour\fP" 298.IP "\fBtintColor:\fP \fIcolour\fP"
273Tint 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\&.
274.IP "\fBscrollColor:\fP \fIcolour\fP" 302.IP "\fBscrollColor:\fP \fIcolour\fP"
275Use the specified colour for the scrollbar [default #B2B2B2]\&. 303Use the specified colour for the scrollbar [default #B2B2B2]\&.
276.IP "\fBtroughColor:\fP \fIcolour\fP" 304.IP "\fBtroughColor:\fP \fIcolour\fP"
277Use the specified colour for the scrollbar\&'s trough area [default 305Use the specified colour for the scrollbar\&'s trough area [default
278#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 306#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
293.IP "\fBpath:\fP \fIpath\fP" 321.IP "\fBpath:\fP \fIpath\fP"
294Specify the colon-delimited search path for finding files (XPM and 322Specify the colon-delimited search path for finding files (XPM and
295menus), in addition to the paths specified by the \fBRXVTPATH\fP and 323menus), in addition to the paths specified by the \fBRXVTPATH\fP and
296\fBPATH\fP environment variables\&. 324\fBPATH\fP environment variables\&.
297.IP "\fBfont:\fP \fIfontname\fP" 325.IP "\fBfont:\fP \fIfontname\fP"
298Select the fonts to be used used\&. This is a comma seperated 326Select the fonts to be used\&.
299list 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
300unicode characters\&. The first font defines the cell size for characters, 328trying to display Unicode characters\&.
301other fonts might be smaller, but not larger\&. A reasonable default font list 329The first font defines the cell size for characters; other fonts might
302is always appended to this list\&. 330be smaller, but not larger\&.
331A reasonable default font list is always appended to it\&.
303option \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\&.
304.IP "\fBselectstyle:\fP \fImode\fP" 344.IP "\fBselectstyle:\fP \fImode\fP"
305Set 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
306is 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
307gives xterm style selection\&. 347gives xterm style selection\&.
308.IP "\fBscrollstyle:\fP \fImode\fP" 348.IP "\fBscrollstyle:\fP \fImode\fP"
… …
1055.PP 1095.PP
1056Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1096Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1057.PP 1097.PP
1058.SH "FTP LOCATION" 1098.SH "FTP LOCATION"
1059.PP 1099.PP
1060rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites 1100rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1061ftp://ftp\&.rxvt\&.org/pub/rxvt 1101ftp://ftp\&.rxvt\&.org/pub/rxvt
1062.PP 1102.PP
1063.SH "CURRENT PROJECT COORDINATOR" 1103.SH "CURRENT PROJECT COORDINATOR"
1064.PP 1104.PP
1065.IP "Project Coordinator" 1105.IP "Project Coordinator"

Diff Legend

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