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.177 by root, Sun May 23 00:48:53 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>.
… …
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it. 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side, 154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are: 155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also 156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource 157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example: 158I<tintColor>. Example:
159 159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 161
162=item B<-sh> I<number> 162=item B<-sh> I<number>
… …
168=item B<-blt> I<string> 168=item B<-blt> I<string>
169 169
170Specify background blending type. If background pixmap is specified 170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 177
178=item B<-blr> I<HxV> 178=item B<-blr> I<HxV>
… …
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
… …
594Use the specified colour for the colour value I<n>, where 0-7 625Use the specified colour for the colour value I<n>, where 0-7
595corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
596high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
597colours. The canonical names are as follows: 0=black, 1=red, 2=green, 628colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5983=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
599names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
600 631
601Colours higher than 15 cannot be set using resources (yet), but can be 632Colours higher than 15 cannot be set using resources (yet), but can be
602changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
603 634
604Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
615=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
616 647
617Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
618foreground colour is the default. 649foreground colour is the default.
619 650
620=item B<colorRV:> I<colour>
621
622Use the specified colour as the background for reverse video characters
623when OPTION_HC is disabled (--disable-frills).
624
625=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
626 652
627If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
628itself. 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.
629 665
630=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
631 667
632Use 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
633foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
640 676
641=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
642 678
643B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
644option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
645B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646 682
647=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
648 684
649B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
699 735
700Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
701 737
702=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
703 739
704Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
705background 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>.
706 746
707=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
708 748
709Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
710 750
… …
777it 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
778wide and 15 pixels high. 818wide and 15 pixels high.
779 819
780The 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
781the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
782the 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
783useful supplement. 823useful supplement.
784 824
785The 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
786are 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
787contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
838=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
839 879
840B<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.
841B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
842 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
843=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
844 886
845B<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>.
846B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
847 889
… …
970 1012
971=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
972 1014
973B<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];
974option 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>.
975 1022
976=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
977 1024
978B<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
979of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
… …
1082 1129
1083=item B<secondaryScroll:> I<boolean> 1130=item B<secondaryScroll:> I<boolean>
1084 1131
1085Turn on/off secondary screen scroll (default enabled). If this 1132Turn on/off secondary screen scroll (default enabled). If this
1086option is enabled, scrolls on the secondary screen will change the 1133option is enabled, scrolls on the secondary screen will change the
1087scrollback buffer and switching to/from the secondary screen will 1134scrollback buffer and, when secondaryScreen is off, switching
1088instead scroll the screen up. 1135to/from the secondary screen will instead scroll the screen up.
1089 1136
1090=item B<hold>: I<boolean> 1137=item B<hold>: I<boolean>
1091 1138
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1139Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1140will 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 1141it exits. Instead, it will wait till it is being killed or closed by the
1095user. 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>.
1096 1150
1097=item B<keysym.>I<sym>: I<string> 1151=item B<keysym.>I<sym>: I<string>
1098 1152
1099Compile I<frills>: Associate I<string> with keysym I<sym>. The 1153Compile I<frills>: Associate I<string> with keysym I<sym>. The
1100intervening resource name B<keysym.> cannot be omitted. 1154intervening resource name B<keysym.> cannot be omitted.
… …
1139when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1140 1194
1141 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
1142 1196
1143If 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>
1144is 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)
1145manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1146C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147 1201
1148 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1149 1203
… …
1207all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1208 1262
1209=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1210 1264
1211Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1213will be ignored when running setuid/setgid.
1214 1267
1215=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1216 1269
1217Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1219@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221will be ignored when running setuid/setgid.
1222 1274
1223See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1224 1276
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226 1278
… …
1248 1300
1249=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1250 1302
1251Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1252it 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).
1253 1309
1254=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1255 1311
1256Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1257 1313
… …
1400B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1456B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1401it can be seen via the I<who(1)> command, and can accept messages. To 1457it can be seen via the I<who(1)> command, and can accept messages. To
1402allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1458allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1403on some systems or setgid to root or to some other group on others. 1459on some systems or setgid to root or to some other group on others.
1404 1460
1405=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1406 1462
1407In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1408B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1409high-intensity bold/blink versions of the same). Here is a list of the 1465high-intensity bold/blink versions of the same). Here is a list of the
1410colours with their names. 1466colours with their names.
… …
1449Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1451I<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
1452been specified. For example, 1508been specified. For example,
1453 1509
1454=over 4
1455
1456=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1457 1511
1458would 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
1459on White. 1513White.
1460
1461=back
1462 1514
1463=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1464 1516
1465If 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
1466their 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:
1467 1519
1468You can prefix any color with an opaquenes percentage enclosed in 1520You can prefix any colour with an opaquenes percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely 1522(0-100) that specifies the opacity of the colour, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a 1523transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with 1525is the recommended format to specify transparency values, and works with
1474all ways to specify a colour. 1526all ways to specify a colour.
1475 1527
… …
1546C<--with-terminfo=PATH>. 1598C<--with-terminfo=PATH>.
1547 1599
1548=item B<DISPLAY> 1600=item B<DISPLAY>
1549 1601
1550Used 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
1551display 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.
1552 1605
1553=item B<SHELL> 1606=item B<SHELL>
1554 1607
1555The 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>.
1556 1609
… …
1582 1635
1583=over 4 1636=over 4
1584 1637
1585=item B</usr/lib/X11/rgb.txt> 1638=item B</usr/lib/X11/rgb.txt>
1586 1639
1587Color names. 1640Colour names.
1588 1641
1589=back 1642=back
1590 1643
1591=head1 SEE ALSO 1644=head1 SEE ALSO
1592 1645

Diff Legend

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