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.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
16 19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile 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;
101resource B<depth>. 104resource B<depth>.
102 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
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
242italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 251for details.
244 252
245=item B<-is>|B<+is> 253=item B<-is>|B<+is>
246 254
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
249details. 257details.
250 258
251=item B<-name> I<name> 259=item B<-name> I<name>
252 260
270 278
271=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
272 280
273Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
274 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
275=item B<-si>|B<+si> 292=item B<-si>|B<+si>
276 293
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
279 296
285=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
286 303
287Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 306B<scrollWithBuffer>.
290
291=item B<-sr>|B<+sr>
292
293Put scrollbar on right/left; resource B<scrollBar_right>.
294
295=item B<-st>|B<+st>
296
297Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298resource B<scrollBar_floating>.
299 307
300=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
301 309
302If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
721an integer number of images in that direction. No image will be magnified 729an integer number of images in that direction. No image will be magnified
722beyond 10 times its original size. The maximum permitted scale is 1000. 730beyond 10 times its original size. The maximum permitted scale is 1000.
723Additional operations can be specified after colon B<:op1:op2...>. 731Additional operations can be specified after colon B<:op1:op2...>.
724Supported operations are: 732Supported operations are:
725 733
726 tile force background image to be tiled and not scaled. Equivalent to 0x0, 734 tile force background image to be tiled and not scaled. Equivalent to 0x0
727 propscale will scale image keeping proportions, 735 propscale will scale image keeping proportions
728 auto will scale image to match window size. Equivalent to 100x100; 736 auto will scale image to match window size. Equivalent to 100x100
729 hscale will scale image horizontally to the window size; 737 hscale will scale image horizontally to the window size
730 vscale will scale image vertically to the window size; 738 vscale will scale image vertically to the window size
731 scale will scale image to match window size; 739 scale will scale image to match window size
732 root will tile image as if it was a root window background, auto-adjusting 740 root will tile image as if it was a root window background, auto-adjusting
733 whenever terminal window moves. 741 whenever terminal window moves
734 742
735If used in conjunction with B<-tr> option, the specified pixmap will be 743If used in conjunction with B<-tr> option, the specified pixmap will be
736blended over transparency image using either alpha-blending, or any 744blended over transparency image using either alpha-blending, or any
737other blending type, specified with B<-blt "type"> option. 745other blending type, specified with B<-blt "type"> option.
738 746
803text font will being used for the given style. 811text font will being used for the given style.
804 812
805=item B<intensityStyles:> I<boolean> 813=item B<intensityStyles:> I<boolean>
806 814
807When font styles are not enabled, or this option is enabled (B<True>, 815When font styles are not enabled, or this option is enabled (B<True>,
808option B<-is>, the default), bold and italic font styles imply high 816option B<-is>, the default), bold/blink font styles imply high
809intensity foreground/background colours. Disabling this option (B<False>, 817intensity foreground/background colours. Disabling this option (B<False>,
810option B<+is>) disables this behaviour, the high intensity colours are not 818option B<+is>) disables this behaviour, the high intensity colours are not
811reachable. 819reachable.
812 820
813=item B<selectstyle:> I<mode>
814
815Set mouse selection style to B<old> which is 2.20, B<oldword> which
816is xterm style with 2.20 old word selection, or anything else which
817gives xterm style selection. Only effective when the original (non-perl)
818selection code is in use.
819
820=item B<scrollstyle:> I<mode>
821
822Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
823the author's favourite.
824
825=item B<title:> I<string> 821=item B<title:> I<string>
826 822
827Set window title string, the default title is the command-line 823Set window title string, the default title is the command-line
828specified after the B<-e> option, if any, otherwise the application 824specified after the B<-e> option, if any, otherwise the application
829name; option B<-title>. 825name; option B<-title>.
873 869
874 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875 871
876This 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
877every 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.
878 879
879=item B<scrollBar:> I<boolean> 880=item B<scrollBar:> I<boolean>
880 881
881B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882disable the scrollbar; option B<+sb>. 883disable the scrollbar; option B<+sb>.
1460=back 1461=back
1461 1462
1462=head2 ALPHA CHANNEL SUPPORT 1463=head2 ALPHA CHANNEL SUPPORT
1463 1464
1464If 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
1465their 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:
1466(recommended, but B<MUST> have 4 digits/component) colour specifications, 1467
1467in 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
1468specifies opacity (alpha) values. The minimum value of C<0> is completely 1479(alpha) values. The minimum value of C<0000> is completely transparent,
1469transparent). You can also prefix any color with C<[percent]>, where 1480while C<ffff> is completely opaque). The two example colours from
1470C<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
1471the color, where C<0> is completely transparent and C<100> is completelxy 1482C<rgba:0000/ff00/0000/f332>.
1472opaque.
1473 1483
1474You 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
1475your 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
1476ARGB 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.
1477 1488
1478For example, the following selects an almost completely transparent red 1489For example, the following selects an almost completely transparent black
1479background, and an almost opaque pink foreground: 1490background, and an almost opaque pink foreground:
1480 1491
1481 @@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"
1482 1493
1483I<Please note that transparency of any kind if completely unsupported by 1494When not using a background image, then the interpretation of the
1484the 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.
1485 1508
1486=head1 ENVIRONMENT 1509=head1 ENVIRONMENT
1487 1510
1488B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489 1512

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines