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.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.159 by root, Wed Jan 23 14:34:00 2008 UTC

… …
245italic> >> characters are to be printed. See resource B<boldItalicFont> 245italic> >> characters are to be printed. See resource B<boldItalicFont>
246for details. 246for details.
247 247
248=item B<-is>|B<+is> 248=item B<-is>|B<+is>
249 249
250Compile I<font-styles>: Bold/Italic font styles imply high intensity 250Compile I<font-styles>: Bold/Blink font styles imply high intensity
251foreground/background (default). See resource B<intensityStyles> for 251foreground/background (default). See resource B<intensityStyles> for
252details. 252details.
253 253
254=item B<-name> I<name> 254=item B<-name> I<name>
255 255
… …
273 273
274=item B<-sb>|B<+sb> 274=item B<-sb>|B<+sb>
275 275
276Turn on/off scrollbar; resource B<scrollBar>. 276Turn on/off scrollbar; resource B<scrollBar>.
277 277
278=item B<-sr>|B<+sr>
279
280Put scrollbar on right/left; resource B<scrollBar_right>.
281
282=item B<-st>|B<+st>
283
284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285resource B<scrollBar_floating>.
286
278=item B<-si>|B<+si> 287=item B<-si>|B<+si>
279 288
280Turn on/off scroll-to-bottom on TTY output inhibit; resource 289Turn on/off scroll-to-bottom on TTY output inhibit; resource
281B<scrollTtyOutput> has opposite effect. 290B<scrollTtyOutput> has opposite effect.
282 291
… …
288=item B<-sw>|B<+sw> 297=item B<-sw>|B<+sw>
289 298
290Turn on/off scrolling with the scrollback buffer as new lines appear. 299Turn on/off scrolling with the scrollback buffer as new lines appear.
291This only takes effect if B<-si> is also given; resource 300This only takes effect if B<-si> is also given; resource
292B<scrollWithBuffer>. 301B<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 302
303=item B<-ptab>|B<+ptab> 303=item B<-ptab>|B<+ptab>
304 304
305If enabled (default), "Horizontal Tab" characters are being stored as 305If enabled (default), "Horizontal Tab" characters are being stored as
306actual wide characters in the screen buffer, which makes it possible to 306actual wide characters in the screen buffer, which makes it possible to
… …
724an integer number of images in that direction. No image will be magnified 724an integer number of images in that direction. No image will be magnified
725beyond 10 times its original size. The maximum permitted scale is 1000. 725beyond 10 times its original size. The maximum permitted scale is 1000.
726Additional operations can be specified after colon B<:op1:op2...>. 726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are: 727Supported operations are:
728 728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0, 729 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions, 730 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100; 731 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size; 732 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size; 733 vscale will scale image vertically to the window size
734 scale will scale image to match window size; 734 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting 735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves. 736 whenever terminal window moves
737 737
738If used in conjunction with B<-tr> option, the specified pixmap will be 738If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any 739blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option. 740other blending type, specified with B<-blt "type"> option.
741 741
… …
806text font will being used for the given style. 806text font will being used for the given style.
807 807
808=item B<intensityStyles:> I<boolean> 808=item B<intensityStyles:> I<boolean>
809 809
810When font styles are not enabled, or this option is enabled (B<True>, 810When font styles are not enabled, or this option is enabled (B<True>,
811option B<-is>, the default), bold and italic font styles imply high 811option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 812intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 813option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 814reachable.
815 815
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> 816=item B<title:> I<string>
829 817
830Set window title string, the default title is the command-line 818Set window title string, the default title is the command-line
831specified after the B<-e> option, if any, otherwise the application 819specified after the B<-e> option, if any, otherwise the application
832name; option B<-title>. 820name; option B<-title>.
… …
876 864
877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 865 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878 866
879This creates a new file in your home directory with the screen contents 867This creates a new file in your home directory with the screen contents
880every time you hit C<Print>. 868every time you hit C<Print>.
869
870=item B<scrollstyle:> I<mode>
871
872Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873the author's favourite.
881 874
882=item B<scrollBar:> I<boolean> 875=item B<scrollBar:> I<boolean>
883 876
884B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885disable the scrollbar; option B<+sb>. 878disable the scrollbar; option B<+sb>.
… …
1463=back 1456=back
1464 1457
1465=head2 ALPHA CHANNEL SUPPORT 1458=head2 ALPHA CHANNEL SUPPORT
1466 1459
1467If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1460If 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> 1461their act together, rxvt-unicode will do it's own alpha channel management:
1469(recommended, but B<MUST> have 4 digits/component) colour specifications, 1462
1470in addition to the ones provided by X, where the additional A component 1463You can prefix any color with an opaquenes percentage enclosed in
1464brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1465(0-100) that specifies the opacity of the color, where C<0> is completely
1466transparent and C<100> is completely opaque. For example, C<[50]red> is a
1467half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1468is the recommended format to specify transparency values, and works with
1469all ways to specify a colour.
1470
1471For complete control, rxvt-unicode also supports
1472C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1473specifications, where the additional C<aaaa> component specifies opacity
1471specifies opacity (alpha) values. The minimum value of C<0> is completely 1474(alpha) values. The minimum value of C<0000> is completely transparent,
1472transparent). You can also prefix any color with C<[percent]>, where 1475while C<ffff> is completely opaque). The two example colours from
1473C<percent> is a decimal percentage (0-100) that specifies the opacity of 1476earlier 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 1477C<rgba:0000/ff00/0000/f332>.
1475opaque.
1476 1478
1477You probably need to specify B<"-depth 32">, too, and have the luck that 1479You 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 1480alpha channels, and have the luck that your X-server uses ARGB pixel
1479ARGB visuals out of the box, and rxvt-unicode just fudges around. 1481layout, as X is far from just supporting ARGB visuals out of the box, and
1482rxvt-unicode just fudges around.
1480 1483
1481For example, the following selects an almost completely transparent red 1484For example, the following selects an almost completely transparent black
1482background, and an almost opaque pink foreground: 1485background, and an almost opaque pink foreground:
1483 1486
1484 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1487 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485 1488
1486I<Please note that transparency of any kind if completely unsupported by 1489When not using a background image, then the interpretation of the
1487the author. Don't bug him with installation questions!> 1490alpha channel is up to your compositing manager (most interpret it as
1491transparency of course).
1492
1493When using a background pixmap or pseudo-transparency, then the background
1494colour will always behave as if it were completely transparent (so the
1495background image shows instead), regardless of how it was specified, while
1496other colours will either be transparent as specified (the background
1497image will show through) on servers supporting the RENDER extension, or
1498fully opaque on servers not supporting the RENDER EXTENSION.
1499
1500Please note that due to bugs in Xft, specifying alpha values might result
1501in garbage being displayed when the X-server does not support the RENDER
1502extension.
1488 1503
1489=head1 ENVIRONMENT 1504=head1 ENVIRONMENT
1490 1505
1491B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1506B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492 1507

Diff Legend

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