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.154 by ayin, Fri Dec 14 09:06:36 2007 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>
… …
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
… …
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>.
571 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.
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>.
576 588
… …
724an integer number of images in that direction. No image will be magnified 736an integer number of images in that direction. No image will be magnified
725beyond 10 times its original size. The maximum permitted scale is 1000. 737beyond 10 times its original size. The maximum permitted scale is 1000.
726Additional operations can be specified after colon B<:op1:op2...>. 738Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are: 739Supported operations are:
728 740
729 tile force background image to be tiled and not scaled. Equivalent to 0x0, 741 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions, 742 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100; 743 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size; 744 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size; 745 vscale will scale image vertically to the window size
734 scale will scale image to match window size; 746 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting 747 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves. 748 whenever terminal window moves
737 749
738If used in conjunction with B<-tr> option, the specified pixmap will be 750If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any 751blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option. 752other blending type, specified with B<-blt "type"> option.
741 753
… …
811option B<-is>, the default), bold/blink font styles imply high 823option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 824intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 825option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 826reachable.
815 827
816=item B<selectstyle:> I<mode>
817
818Set mouse selection style to B<old> which is 2.20, B<oldword> which
819is xterm style with 2.20 old word selection, or anything else which
820gives xterm style selection. Only effective when the original (non-perl)
821selection code is in use.
822
823=item B<scrollstyle:> I<mode>
824
825Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826the author's favourite.
827
828=item B<title:> I<string> 828=item B<title:> I<string>
829 829
830Set window title string, the default title is the command-line 830Set window title string, the default title is the command-line
831specified after the B<-e> option, if any, otherwise the application 831specified after the B<-e> option, if any, otherwise the application
832name; option B<-title>. 832name; option B<-title>.
… …
876 876
877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878 878
879This creates a new file in your home directory with the screen contents 879This creates a new file in your home directory with the screen contents
880every time you hit C<Print>. 880every time you hit C<Print>.
881
882=item B<scrollstyle:> I<mode>
883
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite.
881 886
882=item B<scrollBar:> I<boolean> 887=item B<scrollBar:> I<boolean>
883 888
884B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885disable the scrollbar; option B<+sb>. 890disable the scrollbar; option B<+sb>.
… …
1463=back 1468=back
1464 1469
1465=head2 ALPHA CHANNEL SUPPORT 1470=head2 ALPHA CHANNEL SUPPORT
1466 1471
1467If 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
1468their 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:
1469(recommended, but B<MUST> have 4 digits/component) colour specifications, 1474
1470in 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
1471specifies opacity (alpha) values. The minimum value of C<0> is completely 1486(alpha) values. The minimum value of C<0000> is completely transparent,
1472transparent). You can also prefix any color with C<[percent]>, where 1487while C<ffff> is completely opaque). The two example colours from
1473C<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
1474the color, where C<0> is completely transparent and C<100> is completelxy 1489C<rgba:0000/ff00/0000/f332>.
1475opaque.
1476 1490
1477You 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
1478your 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
1479ARGB 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.
1480 1495
1481For example, the following selects an almost completely transparent red 1496For example, the following selects an almost completely transparent black
1482background, and an almost opaque pink foreground: 1497background, and an almost opaque pink foreground:
1483 1498
1484 @@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"
1485 1500
1486I<Please note that transparency of any kind if completely unsupported by 1501When not using a background image, then the interpretation of the
1487the 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.
1488 1515
1489=head1 ENVIRONMENT 1516=head1 ENVIRONMENT
1490 1517
1491B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492 1519

Diff Legend

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