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.158 by root, Wed Jan 23 14:33:42 2008 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
… …
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
… …
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.
… …
1453would yield White on Black, while on I<xterm>(1) it would yield Black 1478would yield White on Black, while on I<xterm>(1) it would yield Black
1454on White. 1479on White.
1455 1480
1456=back 1481=back
1457 1482
1458=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS 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 do it's own alpha channel management: 1486their act together, rxvt-unicode will do it's own alpha channel management:
1462 1487
1463You can prefix any color with an opaquenes percentage enclosed in 1488You can prefix any color with an opaquenes percentage enclosed in
… …
1541C<--with-terminfo=PATH>. 1566C<--with-terminfo=PATH>.
1542 1567
1543=item B<DISPLAY> 1568=item B<DISPLAY>
1544 1569
1545Used 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
1546display 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.
1547 1573
1548=item B<SHELL> 1574=item B<SHELL>
1549 1575
1550The 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>.
1551 1577

Diff Legend

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