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.164 by root, Sun Jun 15 13:54:15 2008 UTC

… …
92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
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
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]
105 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
… …
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
… …
449 454
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
452it exits. Instead, it will wait till it is being killed or closed by the 457it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>. 458user; resource B<hold>.
459
460=item B<-cd> I<path>
461
462Sets the working directory for the shell (or the command specified via
463B<-e>). The I<path> must be an absolute path and it must exist for
464@@RXVT_NAME@@ to start; resource B<chdir>.
454 465
455=item B<-xrm> I<string> 466=item B<-xrm> I<string>
456 467
457Works like the X Toolkit option of the same name, by adding the I<string> 468Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this 469as if it were specified in a resource file. Resource values specified this
… …
567=item B<depth:> I<bitdepth> 578=item B<depth:> I<bitdepth>
568 579
569Compile I<xft>: Attempt to find a visual with the given bit depth; 580Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>. 581option B<-depth>.
571 582
583=item B<buffered:> I<boolean>
584
585Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
586On some card/driver combination enabling it slightly decreases
587performance, on most it greatly helps it. The slowdown is small, so it
588should normally be enabled.
589
572=item B<geometry:> I<geom> 590=item B<geometry:> I<geom>
573 591
574Create the window with the specified X window geometry [default 80x24]; 592Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 593option B<-geometry>.
576 594
… …
811option B<-is>, the default), bold/blink font styles imply high 829option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 830intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 831option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 832reachable.
815 833
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> 834=item B<title:> I<string>
822 835
823Set window title string, the default title is the command-line 836Set window title string, the default title is the command-line
824specified after the B<-e> option, if any, otherwise the application 837specified after the B<-e> option, if any, otherwise the application
825name; option B<-title>. 838name; option B<-title>.
… …
869 882
870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 883 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
871 884
872This creates a new file in your home directory with the screen contents 885This creates a new file in your home directory with the screen contents
873every time you hit C<Print>. 886every time you hit C<Print>.
887
888=item B<scrollstyle:> I<mode>
889
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite.
874 892
875=item B<scrollBar:> I<boolean> 893=item B<scrollBar:> I<boolean>
876 894
877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878disable the scrollbar; option B<+sb>. 896disable the scrollbar; option B<+sb>.
… …
1077 1095
1078=item B<secondaryScroll:> I<boolean> 1096=item B<secondaryScroll:> I<boolean>
1079 1097
1080Turn on/off secondary screen scroll (default enabled). If this 1098Turn on/off secondary screen scroll (default enabled). If this
1081option is enabled, scrolls on the secondary screen will change the 1099option is enabled, scrolls on the secondary screen will change the
1082scrollback buffer and switching to/from the secondary screen will 1100scrollback buffer and, when secondaryScreen is off, switching
1083instead scroll the screen up. 1101to/from the secondary screen will instead scroll the screen up.
1084 1102
1085=item B<hold>: I<boolean> 1103=item B<hold>: I<boolean>
1086 1104
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1105Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within 1106will not immediately destroy its window when the program executed within
1089it exits. Instead, it will wait till it is being killed or closed by the 1107it exits. Instead, it will wait till it is being killed or closed by the
1090user. 1108user.
1109
1110=item B<chdir>: I<path>
1111
1112Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>.
1091 1116
1092=item B<keysym.>I<sym>: I<string> 1117=item B<keysym.>I<sym>: I<string>
1093 1118
1094Compile I<frills>: Associate I<string> with keysym I<sym>. The 1119Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095intervening resource name B<keysym.> cannot be omitted. 1120intervening resource name B<keysym.> cannot be omitted.
… …
1456=back 1481=back
1457 1482
1458=head2 ALPHA CHANNEL SUPPORT 1483=head2 ALPHA CHANNEL SUPPORT
1459 1484
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1485If 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> 1486their act together, rxvt-unicode will do it's own alpha channel management:
1462(recommended, but B<MUST> have 4 digits/component) colour specifications, 1487
1463in addition to the ones provided by X, where the additional A component 1488You can prefix any color with an opaquenes percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with
1494all ways to specify a colour.
1495
1496For complete control, rxvt-unicode also supports
1497C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1498specifications, where the additional C<aaaa> component specifies opacity
1464specifies opacity (alpha) values. The minimum value of C<0> is completely 1499(alpha) values. The minimum value of C<0000> is completely transparent,
1465transparent). You can also prefix any color with C<[percent]>, where 1500while C<ffff> is completely opaque). The two example colours from
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of 1501earlier 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 1502C<rgba:0000/ff00/0000/f332>.
1468opaque.
1469 1503
1470You probably need to specify B<"-depth 32">, too, and have the luck that 1504You 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 1505alpha channels, and have the luck that your X-server uses ARGB pixel
1472ARGB visuals out of the box, and rxvt-unicode just fudges around. 1506layout, as X is far from just supporting ARGB visuals out of the box, and
1507rxvt-unicode just fudges around.
1473 1508
1474For example, the following selects an almost completely transparent red 1509For example, the following selects an almost completely transparent black
1475background, and an almost opaque pink foreground: 1510background, and an almost opaque pink foreground:
1476 1511
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1512 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478 1513
1479I<Please note that transparency of any kind if completely unsupported by 1514When not using a background image, then the interpretation of the
1480the author. Don't bug him with installation questions!> 1515alpha channel is up to your compositing manager (most interpret it as
1516transparency of course).
1517
1518When using a background pixmap or pseudo-transparency, then the background
1519colour will always behave as if it were completely transparent (so the
1520background image shows instead), regardless of how it was specified, while
1521other colours will either be transparent as specified (the background
1522image will show through) on servers supporting the RENDER extension, or
1523fully opaque on servers not supporting the RENDER EXTENSION.
1524
1525Please note that due to bugs in Xft, specifying alpha values might result
1526in garbage being displayed when the X-server does not support the RENDER
1527extension.
1481 1528
1482=head1 ENVIRONMENT 1529=head1 ENVIRONMENT
1483 1530
1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1531B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485 1532
… …
1519C<--with-terminfo=PATH>. 1566C<--with-terminfo=PATH>.
1520 1567
1521=item B<DISPLAY> 1568=item B<DISPLAY>
1522 1569
1523Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1570Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524display in its child processes. 1571display in its child processes if C<-display> isn't used to override. It
1572defaults to C<:0> if it doesn't exist.
1525 1573
1526=item B<SHELL> 1574=item B<SHELL>
1527 1575
1528The shell to be used for command execution, defaults to C</bin/sh>. 1576The shell to be used for command execution, defaults to C</bin/sh>.
1529 1577

Diff Legend

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