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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.108 by root, Sun Jan 29 21:45:47 2006 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC

… …
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth> 98=item B<-depth> I<bitdepth>
99 99
100Compile I<frills>: Attempt to find a visual with the given bit depth; 100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 101resource B<depth>.
102 102
103=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
104 104
105Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
… …
114 114
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
119 122
120=item B<-fade> I<number> 123=item B<-fade> I<number>
121 124
122Fade the text by the given percentage when focus is lost. Small values 125Fade the text by the given percentage when focus is lost. Small values
123fade a little only, 100 completely replaces all colours by the fade 126fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>. 127colour; resource B<fading>.
125 128
126=item B<-fadecolor> I<colour> 129=item B<-fadecolor> I<colour>
127 130
128Fade to this colour when fading is used (see B<-fade>). The default colour 131Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>. 132is opaque black. resource B<fadeColor>.
130 133
131=item B<-tint> I<colour> 134=item B<-tint> I<colour>
132 135
133Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
134transparency is enabled with B<-tr> or B<-ip>. This only works for 137transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
512 515
513=over 4 516=over 4
514 517
515=item B<depth:> I<bitdepth> 518=item B<depth:> I<bitdepth>
516 519
517Compile I<frills>: Attempt to find a visual with the given bit depth; 520Compile I<xft>: Attempt to find a visual with the given bit depth;
518option B<-depth>. 521option B<-depth>.
519 522
520=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
521 524
522Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
… …
596=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
597 600
598B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
599artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
600pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
601 607
602=item B<fading:> I<number> 608=item B<fading:> I<number>
603 609
604Fade the text by the given percentage when focus is lost; option B<-fade>. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
605 611
… …
1340It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a number 0-15, as a convenient shorthand to reference the colour name of 1348a number 0-15, as a convenient shorthand to reference the colour name of
1343color0-color15. 1349color0-color15.
1344 1350
1345If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1346their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1347(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>
1348and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
1349provided by X, where the additional A component specifies alpha (opacity)
1350values (0 is completely transparent and the maximum is opaque). You
1351probably need to specify B<"-depth 32">, too, and have the luck that your
1352X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1353visuals out of the box, and rxvt-unicode just fudges around.
1354
1355Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1351Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356always swapping the foreground/background colours. This is in contrast to 1352always swapping the foreground/background colours. This is in contrast to
1357I<xterm>(1) where the colours are only swapped if they have not otherwise 1353I<xterm>(1) where the colours are only swapped if they have not otherwise
1358been specified. For example, 1354been specified. For example,
1359 1355
… …
1363 1359
1364would yield White on Black, while on I<xterm>(1) it would yield Black 1360would yield White on Black, while on I<xterm>(1) it would yield Black
1365on White. 1361on White.
1366 1362
1367=back 1363=back
1364
1365=head2 ALPHA CHANNEL SUPPORT
1366
1367If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1368their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1369(recommended, but B<MUST> have 4 digits/component) colour specifications,
1370in addition to the ones provided by X, where the additional A component
1371specifies opacity (alpha) values. The minimum value of C<0> is completely
1372transparent). You can also prefix any color with C<[a]>, where C<a> is on
1373to four hex digits specifiying the opacity value.
1374
1375You probably need to specify B<"-depth 32">, too, and have the luck that
1376your X-server uses ARGB pixel layout, as X is far from just supporting
1377ARGB visuals out of the box, and rxvt-unicode just fudges around.
1378
1379For example, the following selects an almost completely transparent red
1380background, and an almost opaque pink foreground:
1381
1382 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383
1384I<Please note that transparency of any kind if completely unsupported by
1385the author. Don't bug him with installation questions!>
1368 1386
1369=head1 ENVIRONMENT 1387=head1 ENVIRONMENT
1370 1388
1371B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1389B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372 1390

Diff Legend

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