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.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.169 by root, Wed Nov 5 00:14:18 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>.
182horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>. 185resource I<blurRadius>.
186 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
191application window; resource I<iconFile>.
192
187=item B<-bg> I<colour> 193=item B<-bg> I<colour>
188 194
189Window background colour; resource B<background>. 195Window background colour; resource B<background>.
190 196
191=item B<-fg> I<colour> 197=item B<-fg> I<colour>
340 346
341=item B<-bl> 347=item B<-bl>
342 348
343Compile 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.
344if 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
345decorations; resource B<borderLess>. 351decorations; resource B<borderLess>. If the window manager does not
352support MWM hints (e.g. kwin), enables override-redirect mode.
346 353
347=item B<-override-redirect> 354=item B<-override-redirect>
348 355
349Compile I<frills>: Sets override-redirect on the window; resource 356Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 357B<override-redirect>.
454 461
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 462Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 463will not immediately destroy its window when the program executed within
457it 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
458user; 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>.
459 472
460=item B<-xrm> I<string> 473=item B<-xrm> I<string>
461 474
462Works 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>
463as 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
706 719
707Specify background blending type; option B<-blt>. 720Specify background blending type; option B<-blt>.
708 721
709=item B<blurRadius:> I<number> 722=item B<blurRadius:> I<number>
710 723
711Apply Gaussian Blurr with the specified radius to the transparent 724Apply gaussian blur with the specified radius to the transparent
712background 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>.
713 730
714=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
715 732
716Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
717 734
845=item B<urgentOnBell:> I<boolean> 862=item B<urgentOnBell:> I<boolean>
846 863
847B<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.
848B<False>: do not set the urgency hint [default]. 865B<False>: do not set the urgency hint [default].
849 866
867@@RXVT_NAME@@ resets the urgency hint on every focus change.
868
850=item B<visualBell:> I<boolean> 869=item B<visualBell:> I<boolean>
851 870
852B<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>.
853B<False>: no visual bell [default]; option B<+vb>. 872B<False>: no visual bell [default]; option B<+vb>.
854 873
1089 1108
1090=item B<secondaryScroll:> I<boolean> 1109=item B<secondaryScroll:> I<boolean>
1091 1110
1092Turn on/off secondary screen scroll (default enabled). If this 1111Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
1096 1115
1097=item B<hold>: I<boolean> 1116=item B<hold>: I<boolean>
1098 1117
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1119will not immediately destroy its window when the program executed within
1101it 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
1102user. 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>.
1103 1129
1104=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<string>
1105 1131
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<string> with keysym I<sym>. The
1107intervening resource name B<keysym.> cannot be omitted. 1133intervening resource name B<keysym.> cannot be omitted.
1214all instances, while B<perl-ext> is used for specific instances. 1240all instances, while B<perl-ext> is used for specific instances.
1215 1241
1216=item B<perl-eval>: I<string> 1242=item B<perl-eval>: I<string>
1217 1243
1218Perl code to be evaluated when all extensions have been registered. See 1244Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1245the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1246
1222=item B<perl-lib>: I<path> 1247=item B<perl-lib>: I<path>
1223 1248
1224Colon-separated list of additional directories that hold extension 1249Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1250scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in 1251@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1252F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1253
1230See the @@RXVT_NAME@@perl(3) manpage. 1254See the @@RXVT_NAME@@perl(3) manpage.
1231 1255
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1256=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1257
1553C<--with-terminfo=PATH>. 1577C<--with-terminfo=PATH>.
1554 1578
1555=item B<DISPLAY> 1579=item B<DISPLAY>
1556 1580
1557Used 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
1558display 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.
1559 1584
1560=item B<SHELL> 1585=item B<SHELL>
1561 1586
1562The 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>.
1563 1588

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines