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.16 by root, Fri Jul 30 14:59:12 2004 UTC vs.
Revision 1.24 by root, Sun Aug 8 16:47:39 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-07-26" "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\&.3\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.5\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
… …
57is \fB-tr\fP; 57is \fB-tr\fP;
58resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-fade\fP \fInumber\fP" 59.IP "\fB-fade\fP \fInumber\fP"
60Fade the text by the given percentage when focus is lost\&. 60Fade the text by the given percentage when focus is lost\&.
61.IP "\fB-tint\fP \fIcolour\fP" 61.IP "\fB-tint\fP \fIcolour\fP"
62Tint 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)\&.
63.IP "\fB-bg\fP \fIcolour\fP" 70.IP "\fB-bg\fP \fIcolour\fP"
64Window background colour; 71Window background colour;
65resource \fBbackground\fP\&. 72resource \fBbackground\fP\&.
66.IP "\fB-fg\fP \fIcolour\fP" 73.IP "\fB-fg\fP \fIcolour\fP"
67Window foreground colour; 74Window foreground colour;
68resource \fBforeground\fP\&. 75resource \fBforeground\fP\&.
69.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 76.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
70Compile \fIXPM\fP: Specify XPM file for the background and also 77Compile \fIXPM\fP: Specify XPM file for the background and also
71optionally specify its scaling with a geometry string\&. Note you 78optionally specify its scaling with a geometry string\&. Note you
72may need to add quotes to avoid special shell interpretation of 79may need to add quotes to avoid special shell interpretation of
73the `;\&' in the command-line; 80the `;\&' in the command-line;
74resource \fBbackgroundPixmap\fP\&. 81resource \fBbackgroundPixmap\fP\&.
… …
148resource \fBinternalBorder\fP\&. 155resource \fBinternalBorder\fP\&.
149.IP "\fB-w\fP \fInumber\fP" 156.IP "\fB-w\fP \fInumber\fP"
150Compile \fIfrills\fP: External border of \fInumber\fP pixels\&. 157Compile \fIfrills\fP: External border of \fInumber\fP pixels\&.
151Also, \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;
152resource \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\&.
153.IP "\fB-lsp\fP \fInumber\fP" 164.IP "\fB-lsp\fP \fInumber\fP"
154Compile \fIlinespace\fP: Lines (pixel height) to insert between each 165Compile \fIlinespace\fP: Lines (pixel height) to insert between each
155row of the display; 166row of the display;
156resource \fBlinespace\fP\&. 167resource \fBlinespace\fP\&.
157.IP "\fB-tn\fP \fItermname\fP" 168.IP "\fB-tn\fP \fItermname\fP"
… …
211in some window managers\&. 222in some window managers\&.
212.SH "RESOURCES (available also as long-options)" 223.SH "RESOURCES (available also as long-options)"
213.PP 224.PP
214Note: `rxvt --help\&' gives a list of all resources (long options) compiled 225Note: `rxvt --help\&' gives a list of all resources (long options) compiled
215into 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
216If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 235If compiled with internal Xresources support (i\&.e\&. \fBrxvt
217\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 236-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
218XAPPLOADDIR/Rxvt (compile-time defined: usually 237defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
219\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
220or \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\&.
221reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 240Note that when reading X resources, \fBrxvt\fP recognizes two class
222\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
223\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,
224\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 243while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
225key-handling, to be shared between different \fBrxvt\fP configurations\&. 244notably colours and key-handling, to be shared between different
226If no resources are specified, suitable defaults will be used\&. 245\fBrxvt\fP configurations\&. If no resources are specified, suitable
227Command-line arguments can be used to override resource settings\&. The 246defaults will be used\&. Command-line arguments can be used to override
228following resources are allowed: 247resource settings\&. The following resources are allowed:
229.PP 248.PP
230.IP "\fBgeometry:\fP \fIgeom\fP" 249.IP "\fBgeometry:\fP \fIgeom\fP"
231Create the window with the specified X window geometry [default 250Create the window with the specified X window geometry [default
23280x24]; 25180x24];
233option \fB-geometry\fP\&. 252option \fB-geometry\fP\&.
… …
279option \fB+j\fP\&. 298option \fB+j\fP\&.
280.IP "\fBinheritPixmap:\fP \fIboolean\fP" 299.IP "\fBinheritPixmap:\fP \fIboolean\fP"
281\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 300\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
282giving artificial transparency\&. 301giving artificial transparency\&.
283\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\&.
284.IP "\fBtintColor:\fP \fIcolour\fP" 305.IP "\fBtintColor:\fP \fIcolour\fP"
285Tint 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\&.
286.IP "\fBscrollColor:\fP \fIcolour\fP" 312.IP "\fBscrollColor:\fP \fIcolour\fP"
287Use the specified colour for the scrollbar [default #B2B2B2]\&. 313Use the specified colour for the scrollbar [default #B2B2B2]\&.
288.IP "\fBtroughColor:\fP \fIcolour\fP" 314.IP "\fBtroughColor:\fP \fIcolour\fP"
289Use the specified colour for the scrollbar\&'s trough area [default 315Use the specified colour for the scrollbar\&'s trough area [default
290#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 316#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
417Internal border of \fInumber\fP pixels\&. This resource is limited to 100; 443Internal border of \fInumber\fP pixels\&. This resource is limited to 100;
418option \fB-b\fP\&. 444option \fB-b\fP\&.
419.IP "\fBexternalBorder:\fP \fInumber\fP" 445.IP "\fBexternalBorder:\fP \fInumber\fP"
420External border of \fInumber\fP pixels\&. This resource is limited to 100; 446External border of \fInumber\fP pixels\&. This resource is limited to 100;
421option \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\&.
422.IP "\fBtermName:\fP \fItermname\fP" 452.IP "\fBtermName:\fP \fItermname\fP"
423Specifies the terminal type name to be set in the \fBTERM\fP 453Specifies the terminal type name to be set in the \fBTERM\fP
424environment variable; 454environment variable;
425option \fB-tn\fP\&. 455option \fB-tn\fP\&.
426.IP "\fBlinespace:\fP \fInumber\fP" 456.IP "\fBlinespace:\fP \fInumber\fP"
… …
1079.PP 1109.PP
1080Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1110Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1081.PP 1111.PP
1082.SH "FTP LOCATION" 1112.SH "FTP LOCATION"
1083.PP 1113.PP
1084rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites 1114rxvt-3\&.5\&.tar\&.gz can be found at the following ftp sites
1085ftp://ftp\&.rxvt\&.org/pub/rxvt 1115ftp://ftp\&.rxvt\&.org/pub/rxvt
1086.PP 1116.PP
1087.SH "CURRENT PROJECT COORDINATOR" 1117.SH "CURRENT PROJECT COORDINATOR"
1088.PP 1118.PP
1089.IP "Project Coordinator" 1119.IP "Project Coordinator"

Diff Legend

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