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.168 by root, Tue Nov 4 11:03:29 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
… …
177horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>. 185resource I<blurRadius>.
181 186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191appliation window; resource I<iconFile>.
192
182=item B<-bg> I<colour> 193=item B<-bg> I<colour>
183 194
184Window background colour; resource B<background>. 195Window background colour; resource B<background>.
185 196
186=item B<-fg> I<colour> 197=item B<-fg> I<colour>
… …
335 346
336=item B<-bl> 347=item B<-bl>
337 348
338Compile I<frills>: Set MWM hints to request a borderless window, i.e. 349Compile 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 350if honoured by the WM, the rxvt-unicode window will not have window
340decorations; resource B<borderLess>. 351decorations; resource B<borderLess>. If the window manager does not
352support MWM hints (e.g. kwin), enables override-redirect mode.
341 353
342=item B<-override-redirect> 354=item B<-override-redirect>
343 355
344Compile I<frills>: Sets override-redirect on the window; resource 356Compile I<frills>: Sets override-redirect on the window; resource
345B<override-redirect>. 357B<override-redirect>.
… …
449 461
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 462Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 463will 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 464it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>. 465user; resource B<hold>.
466
467=item B<-cd> I<path>
468
469Sets the working directory for the shell (or the command specified via
470B<-e>). The I<path> must be an absolute path and it must exist for
471@@RXVT_NAME@@ to start; resource B<chdir>.
454 472
455=item B<-xrm> I<string> 473=item B<-xrm> I<string>
456 474
457Works like the X Toolkit option of the same name, by adding the I<string> 475Works 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 476as if it were specified in a resource file. Resource values specified this
… …
567=item B<depth:> I<bitdepth> 585=item B<depth:> I<bitdepth>
568 586
569Compile I<xft>: Attempt to find a visual with the given bit depth; 587Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>. 588option B<-depth>.
571 589
590=item B<buffered:> I<boolean>
591
592Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
593On some card/driver combination enabling it slightly decreases
594performance, on most it greatly helps it. The slowdown is small, so it
595should normally be enabled.
596
572=item B<geometry:> I<geom> 597=item B<geometry:> I<geom>
573 598
574Create the window with the specified X window geometry [default 80x24]; 599Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 600option B<-geometry>.
576 601
… …
694 719
695Specify background blending type; option B<-blt>. 720Specify background blending type; option B<-blt>.
696 721
697=item B<blurRadius:> I<number> 722=item B<blurRadius:> I<number>
698 723
699Apply Gaussian Blurr with the specified radius to the transparent 724Apply gaussian blur with the specified radius to the transparent
700background image; option B<-blr>. 725background image; option B<-blr>.
726
727=item B<iconFile:> I<file>
728
729Set the application icon pixmap; option B<-icon>.
701 730
702=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
703 732
704Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
705 734
… …
833=item B<urgentOnBell:> I<boolean> 862=item B<urgentOnBell:> I<boolean>
834 863
835B<True>: set the urgency hint for the wm on receipt of a bell character. 864B<True>: set the urgency hint for the wm on receipt of a bell character.
836B<False>: do not set the urgency hint [default]. 865B<False>: do not set the urgency hint [default].
837 866
867@@RXVT_NAME@@ resets the urgency hint on every focus change.
868
838=item B<visualBell:> I<boolean> 869=item B<visualBell:> I<boolean>
839 870
840B<True>: use visual bell on receipt of a bell character; option B<-vb>. 871B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841B<False>: no visual bell [default]; option B<+vb>. 872B<False>: no visual bell [default]; option B<+vb>.
842 873
… …
1077 1108
1078=item B<secondaryScroll:> I<boolean> 1109=item B<secondaryScroll:> I<boolean>
1079 1110
1080Turn on/off secondary screen scroll (default enabled). If this 1111Turn on/off secondary screen scroll (default enabled). If this
1081option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
1082scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
1083instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
1084 1115
1085=item B<hold>: I<boolean> 1116=item B<hold>: I<boolean>
1086 1117
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within 1119will 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 1120it exits. Instead, it will wait till it is being killed or closed by the
1090user. 1121user.
1122
1123=item B<chdir>: I<path>
1124
1125Sets the working directory for the shell (or the command specified via
1126B<-e>). The I<path> must be an absolute path and it must exist for
1127@@RXVT_NAME@@ to start. If it isn't specified then the current working
1128directory will be used; option B<-cd>.
1091 1129
1092=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<string>
1093 1131
1094Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095intervening resource name B<keysym.> cannot be omitted. 1133intervening resource name B<keysym.> cannot be omitted.
… …
1202all instances, while B<perl-ext> is used for specific instances. 1240all instances, while B<perl-ext> is used for specific instances.
1203 1241
1204=item B<perl-eval>: I<string> 1242=item B<perl-eval>: I<string>
1205 1243
1206Perl code to be evaluated when all extensions have been registered. See 1244Perl code to be evaluated when all extensions have been registered. See
1207the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1245the @@RXVT_NAME@@perl(3) manpage.
1208will be ignored when running setuid/setgid.
1209 1246
1210=item B<perl-lib>: I<path> 1247=item B<perl-lib>: I<path>
1211 1248
1212Colon-separated list of additional directories that hold extension 1249Colon-separated list of additional directories that hold extension
1213scripts. When looking for extensions specified by the C<perl> resource, 1250scripts. When looking for extensions specified by the C<perl> resource,
1214@@RXVT_NAME@@ will first look in these directories and then in 1251@@RXVT_NAME@@ will first look in these directories and then in
1215F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1252F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216will be ignored when running setuid/setgid.
1217 1253
1218See the @@RXVT_NAME@@perl(3) manpage. 1254See the @@RXVT_NAME@@perl(3) manpage.
1219 1255
1220=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1256=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221 1257
… …
1453would yield White on Black, while on I<xterm>(1) it would yield Black 1489would yield White on Black, while on I<xterm>(1) it would yield Black
1454on White. 1490on White.
1455 1491
1456=back 1492=back
1457 1493
1458=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS 1494=head2 ALPHA CHANNEL SUPPORT
1459 1495
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1496If 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: 1497their act together, rxvt-unicode will do it's own alpha channel management:
1462 1498
1463You can prefix any color with an opaquenes percentage enclosed in 1499You can prefix any color with an opaquenes percentage enclosed in
… …
1541C<--with-terminfo=PATH>. 1577C<--with-terminfo=PATH>.
1542 1578
1543=item B<DISPLAY> 1579=item B<DISPLAY>
1544 1580
1545Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1581Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1546display in its child processes. 1582display in its child processes if C<-display> isn't used to override. It
1583defaults to C<:0> if it doesn't exist.
1547 1584
1548=item B<SHELL> 1585=item B<SHELL>
1549 1586
1550The shell to be used for command execution, defaults to C</bin/sh>. 1587The shell to be used for command execution, defaults to C</bin/sh>.
1551 1588

Diff Legend

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