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.15 by root, Thu Jul 29 22:46:41 2004 UTC vs.
Revision 1.21 by root, Sat Jul 31 16:05:45 2004 UTC

1.TH "RXVT" "1" "2004-07-26" "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\&.3\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\&.
… …
206in some window managers\&. 214in some window managers\&.
207.SH "RESOURCES (available also as long-options)" 215.SH "RESOURCES (available also as long-options)"
208.PP 216.PP
209Note: `rxvt --help\&' gives a list of all resources (long options) compiled 217Note: `rxvt --help\&' gives a list of all resources (long options) compiled
210into 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
211If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 227If compiled with internal Xresources support (i\&.e\&. \fBrxvt
212\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 228-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
213XAPPLOADDIR/Rxvt (compile-time defined: usually 229defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
214\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
215or \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\&.
216reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 232Note that when reading X resources, \fBrxvt\fP recognizes two class
217\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
218\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,
219\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 235while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
220key-handling, to be shared between different \fBrxvt\fP configurations\&. 236notably colours and key-handling, to be shared between different
221If no resources are specified, suitable defaults will be used\&. 237\fBrxvt\fP configurations\&. If no resources are specified, suitable
222Command-line arguments can be used to override resource settings\&. The 238defaults will be used\&. Command-line arguments can be used to override
223following resources are allowed: 239resource settings\&. The following resources are allowed:
224.PP 240.PP
225.IP "\fBgeometry:\fP \fIgeom\fP" 241.IP "\fBgeometry:\fP \fIgeom\fP"
226Create the window with the specified X window geometry [default 242Create the window with the specified X window geometry [default
22780x24]; 24380x24];
228option \fB-geometry\fP\&. 244option \fB-geometry\fP\&.
… …
274option \fB+j\fP\&. 290option \fB+j\fP\&.
275.IP "\fBinheritPixmap:\fP \fIboolean\fP" 291.IP "\fBinheritPixmap:\fP \fIboolean\fP"
276\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 292\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
277giving artificial transparency\&. 293giving artificial transparency\&.
278\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\&.
279.IP "\fBtintColor:\fP \fIcolour\fP" 297.IP "\fBtintColor:\fP \fIcolour\fP"
280Tint 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\&.
281.IP "\fBscrollColor:\fP \fIcolour\fP" 304.IP "\fBscrollColor:\fP \fIcolour\fP"
282Use the specified colour for the scrollbar [default #B2B2B2]\&. 305Use the specified colour for the scrollbar [default #B2B2B2]\&.
283.IP "\fBtroughColor:\fP \fIcolour\fP" 306.IP "\fBtroughColor:\fP \fIcolour\fP"
284Use the specified colour for the scrollbar\&'s trough area [default 307Use the specified colour for the scrollbar\&'s trough area [default
285#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 308#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
627.PP 650.PP
628Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 651Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
629.PP 652.PP
630.SH "FTP LOCATION" 653.SH "FTP LOCATION"
631.PP 654.PP
632rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites 655rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites
633ftp://ftp\&.rxvt\&.org/pub/rxvt 656ftp://ftp\&.rxvt\&.org/pub/rxvt
634.PP 657.PP
635.SH "CURRENT PROJECT COORDINATOR" 658.SH "CURRENT PROJECT COORDINATOR"
636.PP 659.PP
637.IP "Project Coordinator" 660.IP "Project Coordinator"

Diff Legend

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