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.156 by ayin, Sun Dec 30 22:43:40 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 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>
… …
273 278
274=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
275 280
276Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
277 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
278=item B<-si>|B<+si> 292=item B<-si>|B<+si>
279 293
280Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
281B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
282 296
… …
288=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
289 303
290Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
291This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
292B<scrollWithBuffer>. 306B<scrollWithBuffer>.
293
294=item B<-sr>|B<+sr>
295
296Put scrollbar on right/left; resource B<scrollBar_right>.
297
298=item B<-st>|B<+st>
299
300Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301resource B<scrollBar_floating>.
302 307
303=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
304 309
305If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
306actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
… …
811option B<-is>, the default), bold/blink font styles imply high 816option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 817intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 818option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 819reachable.
815 820
816=item B<scrollstyle:> I<mode>
817
818Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
819the author's favourite.
820
821=item B<title:> I<string> 821=item B<title:> I<string>
822 822
823Set window title string, the default title is the command-line 823Set window title string, the default title is the command-line
824specified after the B<-e> option, if any, otherwise the application 824specified after the B<-e> option, if any, otherwise the application
825name; option B<-title>. 825name; option B<-title>.
… …
869 869
870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
871 871
872This creates a new file in your home directory with the screen contents 872This creates a new file in your home directory with the screen contents
873every time you hit C<Print>. 873every time you hit C<Print>.
874
875=item B<scrollstyle:> I<mode>
876
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite.
874 879
875=item B<scrollBar:> I<boolean> 880=item B<scrollBar:> I<boolean>
876 881
877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878disable the scrollbar; option B<+sb>. 883disable the scrollbar; option B<+sb>.
… …
1456=back 1461=back
1457 1462
1458=head2 ALPHA CHANNEL SUPPORT 1463=head2 ALPHA CHANNEL SUPPORT
1459 1464
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1465If 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> 1466their act together, rxvt-unicode will do it's own alpha channel management:
1462(recommended, but B<MUST> have 4 digits/component) colour specifications, 1467
1463in addition to the ones provided by X, where the additional A component 1468You can prefix any color with an opaquenes percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with
1474all ways to specify a colour.
1475
1476For complete control, rxvt-unicode also supports
1477C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1478specifications, where the additional C<aaaa> component specifies opacity
1464specifies opacity (alpha) values. The minimum value of C<0> is completely 1479(alpha) values. The minimum value of C<0000> is completely transparent,
1465transparent). You can also prefix any color with C<[percent]>, where 1480while C<ffff> is completely opaque). The two example colours from
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of 1481earlier 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 1482C<rgba:0000/ff00/0000/f332>.
1468opaque.
1469 1483
1470You probably need to specify B<"-depth 32">, too, and have the luck that 1484You 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 1485alpha channels, and have the luck that your X-server uses ARGB pixel
1472ARGB visuals out of the box, and rxvt-unicode just fudges around. 1486layout, as X is far from just supporting ARGB visuals out of the box, and
1487rxvt-unicode just fudges around.
1473 1488
1474For example, the following selects an almost completely transparent red 1489For example, the following selects an almost completely transparent black
1475background, and an almost opaque pink foreground: 1490background, and an almost opaque pink foreground:
1476 1491
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1492 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478 1493
1479I<Please note that transparency of any kind if completely unsupported by 1494When not using a background image, then the interpretation of the
1480the author. Don't bug him with installation questions!> 1495alpha channel is up to your compositing manager (most interpret it as
1496transparency of course).
1497
1498When using a background pixmap or pseudo-transparency, then the background
1499colour will always behave as if it were completely transparent (so the
1500background image shows instead), regardless of how it was specified, while
1501other colours will either be transparent as specified (the background
1502image will show through) on servers supporting the RENDER extension, or
1503fully opaque on servers not supporting the RENDER EXTENSION.
1504
1505Please note that due to bugs in Xft, specifying alpha values might result
1506in garbage being displayed when the X-server does not support the RENDER
1507extension.
1481 1508
1482=head1 ENVIRONMENT 1509=head1 ENVIRONMENT
1483 1510
1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485 1512

Diff Legend

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