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.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.166 by root, Fri Oct 10 13:23:56 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
… …
335 340
336=item B<-bl> 341=item B<-bl>
337 342
338Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile I<frills>: Set MWM hints to request a borderless window, i.e.
339if honoured by the WM, the rxvt-unicode window will not have window 344if honoured by the WM, the rxvt-unicode window will not have window
340decorations; resource B<borderLess>. 345decorations; resource B<borderLess>. If the window manager does not
346support MWM hints (e.g. kwin), enables override-redirect mode.
341 347
342=item B<-override-redirect> 348=item B<-override-redirect>
343 349
344Compile I<frills>: Sets override-redirect on the window; resource 350Compile I<frills>: Sets override-redirect on the window; resource
345B<override-redirect>. 351B<override-redirect>.
… …
449 455
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 456Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 457will 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 458it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>. 459user; resource B<hold>.
460
461=item B<-cd> I<path>
462
463Sets the working directory for the shell (or the command specified via
464B<-e>). The I<path> must be an absolute path and it must exist for
465@@RXVT_NAME@@ to start; resource B<chdir>.
454 466
455=item B<-xrm> I<string> 467=item B<-xrm> I<string>
456 468
457Works like the X Toolkit option of the same name, by adding the I<string> 469Works 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 470as if it were specified in a resource file. Resource values specified this
… …
567=item B<depth:> I<bitdepth> 579=item B<depth:> I<bitdepth>
568 580
569Compile I<xft>: Attempt to find a visual with the given bit depth; 581Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>. 582option B<-depth>.
571 583
584=item B<buffered:> I<boolean>
585
586Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
587On some card/driver combination enabling it slightly decreases
588performance, on most it greatly helps it. The slowdown is small, so it
589should normally be enabled.
590
572=item B<geometry:> I<geom> 591=item B<geometry:> I<geom>
573 592
574Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 594option B<-geometry>.
576 595
… …
1077 1096
1078=item B<secondaryScroll:> I<boolean> 1097=item B<secondaryScroll:> I<boolean>
1079 1098
1080Turn on/off secondary screen scroll (default enabled). If this 1099Turn on/off secondary screen scroll (default enabled). If this
1081option is enabled, scrolls on the secondary screen will change the 1100option is enabled, scrolls on the secondary screen will change the
1082scrollback buffer and switching to/from the secondary screen will 1101scrollback buffer and, when secondaryScreen is off, switching
1083instead scroll the screen up. 1102to/from the secondary screen will instead scroll the screen up.
1084 1103
1085=item B<hold>: I<boolean> 1104=item B<hold>: I<boolean>
1086 1105
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1106Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within 1107will 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 1108it exits. Instead, it will wait till it is being killed or closed by the
1090user. 1109user.
1110
1111=item B<chdir>: I<path>
1112
1113Sets the working directory for the shell (or the command specified via
1114B<-e>). The I<path> must be an absolute path and it must exist for
1115@@RXVT_NAME@@ to start. If it isn't specified then the current working
1116directory will be used; option B<-cd>.
1091 1117
1092=item B<keysym.>I<sym>: I<string> 1118=item B<keysym.>I<sym>: I<string>
1093 1119
1094Compile I<frills>: Associate I<string> with keysym I<sym>. The 1120Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095intervening resource name B<keysym.> cannot be omitted. 1121intervening resource name B<keysym.> cannot be omitted.
… …
1202all instances, while B<perl-ext> is used for specific instances. 1228all instances, while B<perl-ext> is used for specific instances.
1203 1229
1204=item B<perl-eval>: I<string> 1230=item B<perl-eval>: I<string>
1205 1231
1206Perl code to be evaluated when all extensions have been registered. See 1232Perl code to be evaluated when all extensions have been registered. See
1207the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1233the @@RXVT_NAME@@perl(3) manpage.
1208will be ignored when running setuid/setgid.
1209 1234
1210=item B<perl-lib>: I<path> 1235=item B<perl-lib>: I<path>
1211 1236
1212Colon-separated list of additional directories that hold extension 1237Colon-separated list of additional directories that hold extension
1213scripts. When looking for extensions specified by the C<perl> resource, 1238scripts. When looking for extensions specified by the C<perl> resource,
1214@@RXVT_NAME@@ will first look in these directories and then in 1239@@RXVT_NAME@@ will first look in these directories and then in
1215F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1240F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216will be ignored when running setuid/setgid.
1217 1241
1218See the @@RXVT_NAME@@perl(3) manpage. 1242See the @@RXVT_NAME@@perl(3) manpage.
1219 1243
1220=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1244=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221 1245
… …
1456=back 1480=back
1457 1481
1458=head2 ALPHA CHANNEL SUPPORT 1482=head2 ALPHA CHANNEL SUPPORT
1459 1483
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1484If 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> 1485their act together, rxvt-unicode will do it's own alpha channel management:
1462(recommended, but B<MUST> have 4 digits/component) colour specifications, 1486
1463in addition to the ones provided by X, where the additional A component 1487You can prefix any color with an opaquenes percentage enclosed in
1488brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1489(0-100) that specifies the opacity of the color, where C<0> is completely
1490transparent and C<100> is completely opaque. For example, C<[50]red> is a
1491half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1492is the recommended format to specify transparency values, and works with
1493all ways to specify a colour.
1494
1495For complete control, rxvt-unicode also supports
1496C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1497specifications, where the additional C<aaaa> component specifies opacity
1464specifies opacity (alpha) values. The minimum value of C<0> is completely 1498(alpha) values. The minimum value of C<0000> is completely transparent,
1465transparent). You can also prefix any color with C<[percent]>, where 1499while C<ffff> is completely opaque). The two example colours from
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of 1500earlier 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 1501C<rgba:0000/ff00/0000/f332>.
1468opaque.
1469 1502
1470You probably need to specify B<"-depth 32">, too, and have the luck that 1503You 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 1504alpha channels, and have the luck that your X-server uses ARGB pixel
1472ARGB visuals out of the box, and rxvt-unicode just fudges around. 1505layout, as X is far from just supporting ARGB visuals out of the box, and
1506rxvt-unicode just fudges around.
1473 1507
1474For example, the following selects an almost completely transparent red 1508For example, the following selects an almost completely transparent black
1475background, and an almost opaque pink foreground: 1509background, and an almost opaque pink foreground:
1476 1510
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1511 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478 1512
1479I<Please note that transparency of any kind if completely unsupported by 1513When not using a background image, then the interpretation of the
1480the author. Don't bug him with installation questions!> 1514alpha channel is up to your compositing manager (most interpret it as
1515transparency of course).
1516
1517When using a background pixmap or pseudo-transparency, then the background
1518colour will always behave as if it were completely transparent (so the
1519background image shows instead), regardless of how it was specified, while
1520other colours will either be transparent as specified (the background
1521image will show through) on servers supporting the RENDER extension, or
1522fully opaque on servers not supporting the RENDER EXTENSION.
1523
1524Please note that due to bugs in Xft, specifying alpha values might result
1525in garbage being displayed when the X-server does not support the RENDER
1526extension.
1481 1527
1482=head1 ENVIRONMENT 1528=head1 ENVIRONMENT
1483 1529
1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1530B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485 1531
… …
1519C<--with-terminfo=PATH>. 1565C<--with-terminfo=PATH>.
1520 1566
1521=item B<DISPLAY> 1567=item B<DISPLAY>
1522 1568
1523Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1569Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524display in its child processes. 1570display in its child processes if C<-display> isn't used to override. It
1571defaults to C<:0> if it doesn't exist.
1525 1572
1526=item B<SHELL> 1573=item B<SHELL>
1527 1574
1528The shell to be used for command execution, defaults to C</bin/sh>. 1575The shell to be used for command execution, defaults to C</bin/sh>.
1529 1576

Diff Legend

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