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

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.53 by root, Wed Jan 25 21:48:47 2006 UTC vs.
Revision 1.57 by root, Tue Jan 31 00:25:16 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2006-01-25" "7.3" "RXVT-UNICODE" 132.TH rxvt 1 "2006-01-31" "7.5" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
216Attempt to open a window on the named X display (\fB\-d\fR still 216Attempt to open a window on the named X display (\fB\-d\fR still
217respected). In the absence of this option, the display specified by the 217respected). In the absence of this option, the display specified by the
218\&\fB\s-1DISPLAY\s0\fR environment variable is used. 218\&\fB\s-1DISPLAY\s0\fR environment variable is used.
219.IP "\fB\-depth\fR \fIbitdepth\fR" 4 219.IP "\fB\-depth\fR \fIbitdepth\fR" 4
220.IX Item "-depth bitdepth" 220.IX Item "-depth bitdepth"
221Compile \fIfrills\fR: Attempt to find a visual with the given bit depth; 221Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222resource \fBdepth\fR. 222resource \fBdepth\fR.
223.IP "\fB\-geometry\fR \fIgeom\fR" 4 223.IP "\fB\-geometry\fR \fIgeom\fR" 4
224.IX Item "-geometry geom" 224.IX Item "-geometry geom"
225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
226.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
… …
231Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
233.IX Item "-ip|+ip | -tr|+tr" 233.IX Item "-ip|+ip | -tr|+tr"
234Turn on/off inheriting parent window's pixmap. Alternative form is 234Turn on/off inheriting parent window's pixmap. Alternative form is
235\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 235\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp
237\&\fIPlease note that transparency of any kind if completely unsupported by
238the author. Don't bug him with installation questions!\fR
236.IP "\fB\-fade\fR \fInumber\fR" 4 239.IP "\fB\-fade\fR \fInumber\fR" 4
237.IX Item "-fade number" 240.IX Item "-fade number"
238Fade the text by the given percentage when focus is lost. Small values 241Fade the text by the given percentage when focus is lost. Small values
239fade a little only, 100 completely replaces all colours by the fade 242fade a little only, 100 completely replaces all colours by the fade
240colour; resource \fBfading\fR. 243colour; resource \fBfading\fR.
241.IP "\fB\-fadecolor\fR \fIcolour\fR" 4 244.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
242.IX Item "-fadecolor colour" 245.IX Item "-fadecolor colour"
243Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 246Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
244is black. resource \fBfadeColor\fR. 247is opaque black. resource \fBfadeColor\fR.
245.IP "\fB\-tint\fR \fIcolour\fR" 4 248.IP "\fB\-tint\fR \fIcolour\fR" 4
246.IX Item "-tint colour" 249.IX Item "-tint colour"
247Tint the transparent background pixmap with the given colour when 250Tint the transparent background pixmap with the given colour when
248transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 251transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
249non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 252non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
… …
584settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
585check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
586extensions not documented here): 589extensions not documented here):
587.IP "\fBdepth:\fR \fIbitdepth\fR" 4 590.IP "\fBdepth:\fR \fIbitdepth\fR" 4
588.IX Item "depth: bitdepth" 591.IX Item "depth: bitdepth"
589Compile \fIfrills\fR: Attempt to find a visual with the given bit depth; 592Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
590option \fB\-depth\fR. 593option \fB\-depth\fR.
591.IP "\fBgeometry:\fR \fIgeom\fR" 4 594.IP "\fBgeometry:\fR \fIgeom\fR" 4
592.IX Item "geometry: geom" 595.IX Item "geometry: geom"
593Create the window with the specified X window geometry [default 80x24]; 596Create the window with the specified X window geometry [default 80x24];
594option \fB\-geometry\fR. 597option \fB\-geometry\fR.
… …
657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 660.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
658.IX Item "inheritPixmap: boolean" 661.IX Item "inheritPixmap: boolean"
659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 662\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
660artificial transparency. \fBFalse\fR: do not inherit the parent windows' 663artificial transparency. \fBFalse\fR: do not inherit the parent windows'
661pixmap. 664pixmap.
665.Sp
666\&\fIPlease note that transparency of any kind if completely unsupported by
667the author. Don't bug him with installation questions!\fR
662.IP "\fBfading:\fR \fInumber\fR" 4 668.IP "\fBfading:\fR \fInumber\fR" 4
663.IX Item "fading: number" 669.IX Item "fading: number"
664Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. 670Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
665.IP "\fBfadeColor:\fR \fIcolour\fR" 4 671.IP "\fBfadeColor:\fR \fIcolour\fR" 4
666.IX Item "fadeColor: colour" 672.IX Item "fadeColor: colour"
… …
1307.SH "COLORS AND GRAPHICS" 1313.SH "COLORS AND GRAPHICS"
1308.IX Header "COLORS AND GRAPHICS" 1314.IX Header "COLORS AND GRAPHICS"
1309In addition to the default foreground and background colours, 1315In addition to the default foreground and background colours,
1310\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1316\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1311high-intensity bold/blink versions of the same). Here is a list of the 1317high-intensity bold/blink versions of the same). Here is a list of the
1312colours with their \fBrgb.txt\fR names. 1318colours with their names.
1313.TS 1319.TS
1314l l l . 1320l l l .
1315color0 (black) = Black 1321color0 (black) = Black
1316color1 (red) = Red3 1322color1 (red) = Red3
1317color2 (green) = Green3 1323color2 (green) = Green3
… …
1344been specified. For example, 1350been specified. For example,
1345.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1351.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1346.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1352.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1347would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1353would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1348on White. 1354on White.
1355.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1356.IX Subsection "ALPHA CHANNEL SUPPORT"
1357If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1358their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1359(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1360in addition to the ones provided by X, where the additional A component
1361specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1362transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1363to four hex digits specifiying the opacity value.
1364.PP
1365You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1366your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1367\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1368.PP
1369For example, the following selects an almost completely transparent red
1370background, and an almost opaque pink foreground:
1371.PP
1372.Vb 1
1373\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1374.Ve
1375.PP
1376\&\fIPlease note that transparency of any kind if completely unsupported by
1377the author. Don't bug him with installation questions!\fR
1349.SH "ENVIRONMENT" 1378.SH "ENVIRONMENT"
1350.IX Header "ENVIRONMENT" 1379.IX Header "ENVIRONMENT"
1351\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1380\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1352.IP "\fB\s-1TERM\s0\fR" 4 1381.IP "\fB\s-1TERM\s0\fR" 4
1353.IX Item "TERM" 1382.IX Item "TERM"

Diff Legend

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