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.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.171 by root, Sat May 30 08:53:48 2009 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>
315 321
316=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
317 323
318Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
319 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
320=item B<-iconic> 330=item B<-iconic>
321 331
322Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 333Alternative form is B<-ic>.
324 334
340 350
341=item B<-bl> 351=item B<-bl>
342 352
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile 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 354if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
346 357
347=item B<-override-redirect> 358=item B<-override-redirect>
348 359
349Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 361B<override-redirect>.
359=item B<-lsp> I<number> 370=item B<-lsp> I<number>
360 371
361Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
364 382
365=item B<-tn> I<termname> 383=item B<-tn> I<termname>
366 384
367This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
454 472
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 474will 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 475it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 476user; resource B<hold>.
477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
459 483
460=item B<-xrm> I<string> 484=item B<-xrm> I<string>
461 485
462Works like the X Toolkit option of the same name, by adding the I<string> 486Works 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 487as if it were specified in a resource file. Resource values specified this
572=item B<depth:> I<bitdepth> 596=item B<depth:> I<bitdepth>
573 597
574Compile I<xft>: Attempt to find a visual with the given bit depth; 598Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>. 599option B<-depth>.
576 600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
607
577=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
578 609
579Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
580option B<-geometry>. 611option B<-geometry>.
581 612
699 730
700Specify background blending type; option B<-blt>. 731Specify background blending type; option B<-blt>.
701 732
702=item B<blurRadius:> I<number> 733=item B<blurRadius:> I<number>
703 734
704Apply Gaussian Blurr with the specified radius to the transparent 735Apply gaussian blur with the specified radius to the transparent
705background image; option B<-blr>. 736background image; option B<-blr>.
737
738=item B<iconFile:> I<file>
739
740Set the application icon pixmap; option B<-icon>.
706 741
707=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
708 743
709Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
710 745
838=item B<urgentOnBell:> I<boolean> 873=item B<urgentOnBell:> I<boolean>
839 874
840B<True>: set the urgency hint for the wm on receipt of a bell character. 875B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default]. 876B<False>: do not set the urgency hint [default].
842 877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
843=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
844 881
845B<True>: use visual bell on receipt of a bell character; option B<-vb>. 882B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
847 884
970 1007
971=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
972 1009
973B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1010B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974option B<-bc>. 1011option B<-bc>.
1012
1013=item B<cursorUnderline:> I<boolean>
1014
1015B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1016option B<-uc>.
975 1017
976=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
977 1019
978B<True>: blank the pointer when a key is pressed or after a set number 1020B<True>: blank the pointer when a key is pressed or after a set number
979of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
1082 1124
1083=item B<secondaryScroll:> I<boolean> 1125=item B<secondaryScroll:> I<boolean>
1084 1126
1085Turn on/off secondary screen scroll (default enabled). If this 1127Turn on/off secondary screen scroll (default enabled). If this
1086option is enabled, scrolls on the secondary screen will change the 1128option is enabled, scrolls on the secondary screen will change the
1087scrollback buffer and switching to/from the secondary screen will 1129scrollback buffer and, when secondaryScreen is off, switching
1088instead scroll the screen up. 1130to/from the secondary screen will instead scroll the screen up.
1089 1131
1090=item B<hold>: I<boolean> 1132=item B<hold>: I<boolean>
1091 1133
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1134Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1135will not immediately destroy its window when the program executed within
1094it exits. Instead, it will wait till it is being killed or closed by the 1136it exits. Instead, it will wait till it is being killed or closed by the
1095user. 1137user.
1138
1139=item B<chdir>: I<path>
1140
1141Sets the working directory for the shell (or the command specified via
1142B<-e>). The I<path> must be an absolute path and it must exist for
1143@@RXVT_NAME@@ to start. If it isn't specified then the current working
1144directory will be used; option B<-cd>.
1096 1145
1097=item B<keysym.>I<sym>: I<string> 1146=item B<keysym.>I<sym>: I<string>
1098 1147
1099Compile I<frills>: Associate I<string> with keysym I<sym>. The 1148Compile I<frills>: Associate I<string> with keysym I<sym>. The
1100intervening resource name B<keysym.> cannot be omitted. 1149intervening resource name B<keysym.> cannot be omitted.
1207all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1208 1257
1209=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1210 1259
1211Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1213will be ignored when running setuid/setgid.
1214 1262
1215=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1216 1264
1217Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1219@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221will be ignored when running setuid/setgid.
1222 1269
1223See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1224 1271
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226 1273
1546C<--with-terminfo=PATH>. 1593C<--with-terminfo=PATH>.
1547 1594
1548=item B<DISPLAY> 1595=item B<DISPLAY>
1549 1596
1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1597Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551display in its child processes. 1598display in its child processes if C<-display> isn't used to override. It
1599defaults to C<:0> if it doesn't exist.
1552 1600
1553=item B<SHELL> 1601=item B<SHELL>
1554 1602
1555The shell to be used for command execution, defaults to C</bin/sh>. 1603The shell to be used for command execution, defaults to C</bin/sh>.
1556 1604

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines