ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.tbl
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.tbl (file contents):
Revision 1.12 by root, Sat Jul 10 20:59:39 2004 UTC vs.
Revision 1.21 by root, Sat Jul 31 16:05:45 2004 UTC

1.TH "RXVT" "1" "2004-05-10" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-07-31" "X Version 11" "X Tools"
2.SH "NAME" 2.SH "NAME"
3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
4.PP 4.PP
5.SH "SYNOPSIS" 5.SH "SYNOPSIS"
6.PP 6.PP
7\fBrxvt\fP [options] [-e command [ args ]] 7\fBrxvt\fP [options] [-e command [ args ]]
8.PP 8.PP
9.SH "DESCRIPTION" 9.SH "DESCRIPTION"
10.PP 10.PP
11\fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator 11\fBrxvt-unicode\fP, version \fB3\&.4\fP, is a colour vt102 terminal emulator
12intended as an \fIxterm\fP(1) replacement for users who do not require 12intended as an \fIxterm\fP(1) replacement for users who do not require
13features such as Tektronix 4014 emulation and toolkit-style configurability\&. 13features such as Tektronix 4014 emulation and toolkit-style configurability\&.
14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
15advantage on a machine serving many X sessions\&. 15advantage on a machine serving many X sessions\&.
16.PP 16.PP
… …
51resource \fBjumpScroll\fP\&. 51resource \fBjumpScroll\fP\&.
52.IP "\fB-ip\fP|\fB+ip\fP" 52.IP "\fB-ip\fP|\fB+ip\fP"
53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
54is \fB-tr\fP; 54is \fB-tr\fP;
55resource \fBinheritPixmap\fP\&. 55resource \fBinheritPixmap\fP\&.
56.IP "\fB-fade\fP \fInumber\fP"
57Fade the text by the given percentage when focus is lost\&.
56.IP "\fB-tint\fP \fIcolour\fP" 58.IP "\fB-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&. 59Tint the transparent background pixmap with the given colour when
60transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. See also
61the \fB-sh\fP option that cna be used to brighten or darken
62the image in addition to tinting it\&.
63dot(\fB-sh\fP) \fInumber\fP
64Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
65image in addition to tinting it\&.
58.IP "\fB-bg\fP \fIcolour\fP" 66.IP "\fB-bg\fP \fIcolour\fP"
59Window background colour; 67Window background colour;
60resource \fBbackground\fP\&. 68resource \fBbackground\fP\&.
61.IP "\fB-fg\fP \fIcolour\fP" 69.IP "\fB-fg\fP \fIcolour\fP"
62Window foreground colour; 70Window foreground colour;
63resource \fBforeground\fP\&. 71resource \fBforeground\fP\&.
64.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 72.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
65Compile \fIXPM\fP: Specify XPM file for the background and also 73Compile \fIXPM\fP: Specify XPM file for the background and also
66optionally specify its scaling with a geometry string\&. Note you 74optionally specify its scaling with a geometry string\&. Note you
67may need to add quotes to avoid special shell interpretation of 75may need to add quotes to avoid special shell interpretation of
68the `;\&' in the command-line; 76the `;\&' in the command-line;
69resource \fBbackgroundPixmap\fP\&. 77resource \fBbackgroundPixmap\fP\&.
… …
78resource \fBpointerColor2\fP\&. 86resource \fBpointerColor2\fP\&.
79.IP "\fB-bd\fP \fIcolour\fP" 87.IP "\fB-bd\fP \fIcolour\fP"
80The colour of the border between the xterm scrollbar and the text; 88The colour of the border between the xterm scrollbar and the text;
81resource \fBborderColor\fP\&. 89resource \fBborderColor\fP\&.
82.IP "\fB-fn\fP \fIfontname\fP" 90.IP "\fB-fn\fP \fIfontname\fP"
83Select the fonts to be used used\&. This is a comma seperated 91Select the fonts to be used\&.
84list of font names that are used in turn when trying to display 92This 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, 93trying to display Unicode characters\&.
86other fonts might be smaller, but not larger\&. A reasonable default font list 94The first font defines the cell size for characters; other fonts might
87is always appended to it\&. 95be smaller, but not larger\&.
96A reasonable default font list is always appended to it\&.
88resource \fBfont\fP\&. 97resource \fBfont\fP\&.
98.IP "\fB-rb\fP|\fB+rb\fP"
99Enable "real bold" support\&.
100When this option is on, bold text will be displayed using the first
101available bold font in the font list\&.
102Bold fonts should thus be specified in the font list after their
103corresponding regular fonts\&.
104If no bold font can be found, a regular font will be used\&.
105resource \fBrealBold\fP\&.
89.IP "\fB-name\fP \fIname\fP" 106.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 107Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 108are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 109Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 110Also sets the icon and title name\&.
… …
197in some window managers\&. 214in some window managers\&.
198.SH "RESOURCES (available also as long-options)" 215.SH "RESOURCES (available also as long-options)"
199.PP 216.PP
200Note: `rxvt --help\&' gives a list of all resources (long options) compiled 217Note: `rxvt --help\&' gives a list of all resources (long options) compiled
201into your version\&. 218into your version\&.
219.PP
220There are two different methods that rxvt can use to get the
221Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
222reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
223\fBXGetDefaults\fP), you can set and change the resources using X11
224tools like \fBxset\fP\&. Many distribution do also load settings from the
225\fB~/\&.Xresources\fP file when X starts\&.
226.PP
202If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 227If compiled with internal Xresources support (i\&.e\&. \fBrxvt
203\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 228-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
204XAPPLOADDIR/Rxvt (compile-time defined: usually 229defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
205\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 230\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
206or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 231\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
207reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 232Note that when reading X resources, \fBrxvt\fP recognizes two class
208\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 233names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
209\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 234common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
210\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 235while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
211key-handling, to be shared between different \fBrxvt\fP configurations\&. 236notably colours and key-handling, to be shared between different
212If no resources are specified, suitable defaults will be used\&. 237\fBrxvt\fP configurations\&. If no resources are specified, suitable
213Command-line arguments can be used to override resource settings\&. The 238defaults will be used\&. Command-line arguments can be used to override
214following resources are allowed: 239resource settings\&. The following resources are allowed:
215.PP 240.PP
216.IP "\fBgeometry:\fP \fIgeom\fP" 241.IP "\fBgeometry:\fP \fIgeom\fP"
217Create the window with the specified X window geometry [default 242Create the window with the specified X window geometry [default
21880x24]; 24380x24];
219option \fB-geometry\fP\&. 244option \fB-geometry\fP\&.
… …
234but the actual colour names used are listed in the 259but the actual colour names used are listed in the
235\fBCOLORS AND GRAPHICS\fP section\&. 260\fBCOLORS AND GRAPHICS\fP section\&.
236.IP "\fBcolorBD:\fP \fIcolour\fP" 261.IP "\fBcolorBD:\fP \fIcolour\fP"
237Use the specified colour to display bold characters when the 262Use the specified colour to display bold characters when the
238foreground colour is the default\&. 263foreground colour is the default\&.
264This option will be ignored if \fBrealBold\fP is enabled\&.
239.IP "\fBcolorUL:\fP \fIcolour\fP" 265.IP "\fBcolorUL:\fP \fIcolour\fP"
240Use the specified colour to display underlined characters when the 266Use the specified colour to display underlined characters when the
241foreground colour is the default\&. 267foreground colour is the default\&.
242.IP "\fBcolorRV:\fP \fIcolour\fP" 268.IP "\fBcolorRV:\fP \fIcolour\fP"
243Use the specified colour as the background for reverse video 269Use the specified colour as the background for reverse video
… …
264option \fB+j\fP\&. 290option \fB+j\fP\&.
265.IP "\fBinheritPixmap:\fP \fIboolean\fP" 291.IP "\fBinheritPixmap:\fP \fIboolean\fP"
266\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 292\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
267giving artificial transparency\&. 293giving artificial transparency\&.
268\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 294\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
295.IP "\fBfading:\fP \fInumber\fP"
296Fade the text by the given percentage when focus is lost\&.
269.IP "\fBtintColor\fP \fIcolour\fP" 297.IP "\fBtintColor:\fP \fIcolour\fP"
270Tint the transparent background pixmap with the given colour\&. 298Tint the transparent background pixmap with the given colour\&.
299.IP "\fBshading:\fP \fInumber\fP"
300Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
301image in addition to tinting it\&.
302.IP "\fBfading:\fP \fInumber\fP"
303Scale the tint colour by the given percentage\&.
271.IP "\fBscrollColor:\fP \fIcolour\fP" 304.IP "\fBscrollColor:\fP \fIcolour\fP"
272Use the specified colour for the scrollbar [default #B2B2B2]\&. 305Use the specified colour for the scrollbar [default #B2B2B2]\&.
273.IP "\fBtroughColor:\fP \fIcolour\fP" 306.IP "\fBtroughColor:\fP \fIcolour\fP"
274Use the specified colour for the scrollbar\&'s trough area [default 307Use the specified colour for the scrollbar\&'s trough area [default
275#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 308#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
290.IP "\fBpath:\fP \fIpath\fP" 323.IP "\fBpath:\fP \fIpath\fP"
291Specify the colon-delimited search path for finding files (XPM and 324Specify the colon-delimited search path for finding files (XPM and
292menus), in addition to the paths specified by the \fBRXVTPATH\fP and 325menus), in addition to the paths specified by the \fBRXVTPATH\fP and
293\fBPATH\fP environment variables\&. 326\fBPATH\fP environment variables\&.
294.IP "\fBfont:\fP \fIfontname\fP" 327.IP "\fBfont:\fP \fIfontname\fP"
295Select the fonts to be used used\&. This is a comma seperated 328Select the fonts to be used\&.
296list of font names that are used in turn when trying to display 329This is a comma seperated list of font names that are used in turn when
297unicode characters\&. The first font defines the cell size for characters, 330trying to display Unicode characters\&.
298other fonts might be smaller, but not larger\&. A reasonable default font list 331The first font defines the cell size for characters; other fonts might
299is always appended to this list\&. 332be smaller, but not larger\&.
333A reasonable default font list is always appended to it\&.
300option \fB-fn\fP\&. 334option \fB-fn\fP\&.
335.IP "\fBrealBold:\fP \fIboolean\fP"
336\fBTrue\fP: Enable "real bold" support\&.
337When this option is on, bold text will be displayed using the first
338available bold font in the font list\&.
339Bold fonts should thus be specified in the font list after their
340corresponding regular fonts\&.
341If no bold font can be found, a regular font will be used\&.
342option \fB-rb\fP\&.
343\fBFalse\fP: Display bold text in a regular font, using the color
344specified with \fBcolorBD\fP;
345option \fB+rb\fP\&.
301.IP "\fBselectstyle:\fP \fImode\fP" 346.IP "\fBselectstyle:\fP \fImode\fP"
302Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 347Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
303is xterm style with 2\&.20 old word selection, or anything else which 348is xterm style with 2\&.20 old word selection, or anything else which
304gives xterm style selection\&. 349gives xterm style selection\&.
305.IP "\fBscrollstyle:\fP \fImode\fP" 350.IP "\fBscrollstyle:\fP \fImode\fP"
… …
605.PP 650.PP
606Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 651Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
607.PP 652.PP
608.SH "FTP LOCATION" 653.SH "FTP LOCATION"
609.PP 654.PP
610rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites 655rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites
611ftp://ftp\&.rxvt\&.org/pub/rxvt 656ftp://ftp\&.rxvt\&.org/pub/rxvt
612.PP 657.PP
613.SH "CURRENT PROJECT COORDINATOR" 658.SH "CURRENT PROJECT COORDINATOR"
614.PP 659.PP
615.IP "Project Coordinator" 660.IP "Project Coordinator"

Diff Legend

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