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.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC

… …
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
106=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
107 112
108Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
109 114
110=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
… …
566 571
567=item B<depth:> I<bitdepth> 572=item B<depth:> I<bitdepth>
568 573
569Compile I<xft>: Attempt to find a visual with the given bit depth; 574Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>. 575option B<-depth>.
576
577=item B<buffered:> I<boolean>
578
579Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
580On some card/driver combination enabling it slightly decreases
581performance, on most it greatly helps it. The slowdown is small, so it
582should normally be enabled.
571 583
572=item B<geometry:> I<geom> 584=item B<geometry:> I<geom>
573 585
574Create the window with the specified X window geometry [default 80x24]; 586Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 587option B<-geometry>.
… …
1456=back 1468=back
1457 1469
1458=head2 ALPHA CHANNEL SUPPORT 1470=head2 ALPHA CHANNEL SUPPORT
1459 1471
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1473their act together, rxvt-unicode will do it's own alpha channel management:
1462(recommended, but B<MUST> have 4 digits/component) colour specifications, 1474
1463in addition to the ones provided by X, where the additional A component 1475You can prefix any color with an opaquenes percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(0-100) that specifies the opacity of the color, where C<0> is completely
1478transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with
1481all ways to specify a colour.
1482
1483For complete control, rxvt-unicode also supports
1484C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1485specifications, where the additional C<aaaa> component specifies opacity
1464specifies opacity (alpha) values. The minimum value of C<0> is completely 1486(alpha) values. The minimum value of C<0000> is completely transparent,
1465transparent). You can also prefix any color with C<[percent]>, where 1487while C<ffff> is completely opaque). The two example colours from
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of 1488earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1467the color, where C<0> is completely transparent and C<100> is completelxy 1489C<rgba:0000/ff00/0000/f332>.
1468opaque.
1469 1490
1470You probably need to specify B<"-depth 32">, too, and have the luck that 1491You probably need to specify B<"-depth 32">, too, to force a visual with
1471your X-server uses ARGB pixel layout, as X is far from just supporting 1492alpha channels, and have the luck that your X-server uses ARGB pixel
1472ARGB visuals out of the box, and rxvt-unicode just fudges around. 1493layout, as X is far from just supporting ARGB visuals out of the box, and
1494rxvt-unicode just fudges around.
1473 1495
1474For example, the following selects an almost completely transparent red 1496For example, the following selects an almost completely transparent black
1475background, and an almost opaque pink foreground: 1497background, and an almost opaque pink foreground:
1476 1498
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1499 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478 1500
1479I<Please note that transparency of any kind if completely unsupported by 1501When not using a background image, then the interpretation of the
1480the author. Don't bug him with installation questions!> 1502alpha channel is up to your compositing manager (most interpret it as
1503transparency of course).
1504
1505When using a background pixmap or pseudo-transparency, then the background
1506colour will always behave as if it were completely transparent (so the
1507background image shows instead), regardless of how it was specified, while
1508other colours will either be transparent as specified (the background
1509image will show through) on servers supporting the RENDER extension, or
1510fully opaque on servers not supporting the RENDER EXTENSION.
1511
1512Please note that due to bugs in Xft, specifying alpha values might result
1513in garbage being displayed when the X-server does not support the RENDER
1514extension.
1481 1515
1482=head1 ENVIRONMENT 1516=head1 ENVIRONMENT
1483 1517
1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485 1519

Diff Legend

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