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.176 by sf-exg, Sat Apr 17 23:00:45 2010 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
… …
622=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
623 647
624Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
625foreground colour is the default. 649foreground colour is the default.
626 650
627=item B<colorRV:> I<colour>
628
629Use the specified colour as the background for reverse video characters
630when OPTION_HC is disabled (--disable-frills).
631
632=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
633 652
634If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
635itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
636 665
637=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
638 667
639Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
640foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
706 735
707Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
708 737
709=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
710 739
711Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
712background image; option B<-blr>. 741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
713 746
714=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
715 748
716Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
717 750
… …
784it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
785wide and 15 pixels high. 818wide and 15 pixels high.
786 819
787The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
788the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
789the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
790useful supplement. 823useful supplement.
791 824
792The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
793are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
845=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
846 879
847B<True>: set the urgency hint for the wm on receipt of a bell character. 880B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
849 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
850=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
851 886
852B<True>: use visual bell on receipt of a bell character; option B<-vb>. 887B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
854 889
… …
977 1012
978=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
979 1014
980B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981option B<-bc>. 1016option B<-bc>.
1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
982 1022
983=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
984 1024
985B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
986of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
… …
1089 1129
1090=item B<secondaryScroll:> I<boolean> 1130=item B<secondaryScroll:> I<boolean>
1091 1131
1092Turn on/off secondary screen scroll (default enabled). If this 1132Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1133option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1134scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1135to/from the secondary screen will instead scroll the screen up.
1096 1136
1097=item B<hold>: I<boolean> 1137=item B<hold>: I<boolean>
1098 1138
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1139Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1140will 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 1141it exits. Instead, it will wait till it is being killed or closed by the
1102user. 1142user.
1143
1144=item B<chdir>: I<path>
1145
1146Sets the working directory for the shell (or the command specified via
1147B<-e>). The I<path> must be an absolute path and it must exist for
1148@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149directory will be used; option B<-cd>.
1103 1150
1104=item B<keysym.>I<sym>: I<string> 1151=item B<keysym.>I<sym>: I<string>
1105 1152
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1153Compile I<frills>: Associate I<string> with keysym I<sym>. The
1107intervening resource name B<keysym.> cannot be omitted. 1154intervening resource name B<keysym.> cannot be omitted.
… …
1146when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1147 1194
1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149 1196
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1151is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1152manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1201
1155 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1156 1203
… …
1214all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1215 1262
1216=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1217 1264
1218Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1267
1222=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1223 1269
1224Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1274
1230See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1231 1276
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1278
… …
1255 1300
1256=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1257 1302
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>. 1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1260 1309
1261=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1262 1311
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1264 1313
… …
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1458I<xterm>(1) where the colours are only swapped if they have not otherwise 1507I<xterm>(1) where the colours are only swapped if they have not otherwise
1459been specified. For example, 1508been specified. For example,
1460 1509
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1511
1465would yield White on Black, while on I<xterm>(1) it would yield Black 1512would yield White on Black, while on I<xterm>(1) it would yield Black on
1466on White. 1513White.
1467
1468=back
1469 1514
1470=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1471 1516
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473their act together, rxvt-unicode will do it's own alpha channel management: 1518their act together, rxvt-unicode will do it's own alpha channel management:
… …
1553C<--with-terminfo=PATH>. 1598C<--with-terminfo=PATH>.
1554 1599
1555=item B<DISPLAY> 1600=item B<DISPLAY>
1556 1601
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1602Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes. 1603display in its child processes if C<-display> isn't used to override. It
1604defaults to C<:0> if it doesn't exist.
1559 1605
1560=item B<SHELL> 1606=item B<SHELL>
1561 1607
1562The shell to be used for command execution, defaults to C</bin/sh>. 1608The shell to be used for command execution, defaults to C</bin/sh>.
1563 1609

Diff Legend

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