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.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.113 by root, Sun Apr 2 17:07:32 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 don't get 1351In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB> 1352additional 72 colours. The first 64 of those (with indices 16 to 79)
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 1353consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348provided by X, where the additional A component specifies alpha (opacity) 135416>), followed by 8 additional shades of gray (with indices 80 to 87).
1349values (0 is completely transparent and the maximum is opaque). You 1355
1350probably need to specify B<"-depth 32">, too, as X is far from just 1356Together, all those colours implement the 88 colour xterm colours. Only
1351supporting ARGB visuals out of the box. 1357the first 16 can be changed using resources currently, the rest can only
1358be changed via command sequences ("escape codes").
1352 1359
1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1355I<xterm>(1) where the colours are only swapped if they have not otherwise 1362I<xterm>(1) where the colours are only swapped if they have not otherwise
1356been specified. For example, 1363been specified. For example,
… …
1361 1368
1362would yield White on Black, while on I<xterm>(1) it would yield Black 1369would yield White on Black, while on I<xterm>(1) it would yield Black
1363on White. 1370on White.
1364 1371
1365=back 1372=back
1373
1374=head2 ALPHA CHANNEL SUPPORT
1375
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely
1381transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382to four hex digits specifiying the opacity value.
1383
1384You probably need to specify B<"-depth 32">, too, and have the luck that
1385your X-server uses ARGB pixel layout, as X is far from just supporting
1386ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground:
1390
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!>
1366 1395
1367=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1368 1397
1369B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1370 1399
… …
1455 1484
1456=item Project Coordinator 1485=item Project Coordinator
1457 1486
1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459 1488
1460L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461 1490
1462=back 1491=back
1463 1492
1464=head1 AUTHORS 1493=head1 AUTHORS
1465 1494

Diff Legend

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