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.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.177 by root, Sun May 23 00:48:53 2010 UTC

… …
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
… …
607Use 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
608corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
609high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
610colours. 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,
6113=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
612names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
613 631
614Colours 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
615changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
616 634
617Colours 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
… …
628=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
629 647
630Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
631foreground colour is the default. 649foreground colour is the default.
632 650
633=item B<colorRV:> I<colour>
634
635Use the specified colour as the background for reverse video characters
636when OPTION_HC is disabled (--disable-frills).
637
638=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
639 652
640If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
641itself. 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.
642 665
643=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
644 667
645Use 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
646foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
653 676
654=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
655 678
656B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
657option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
658B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
659 682
660=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
661 684
662B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
663of 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
… …
712 735
713Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
714 737
715=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
716 739
717Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
718background 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>.
719 746
720=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
721 748
722Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
723 750
… …
790it 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
791wide and 15 pixels high. 818wide and 15 pixels high.
792 819
793The 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
794the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
795the 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
796useful supplement. 823useful supplement.
797 824
798The 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
799are 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
800contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
851=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
852 879
853B<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.
854B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
855 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
856=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
857 886
858B<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>.
859B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
860 889
… …
983 1012
984=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
985 1014
986B<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];
987option 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>.
988 1022
989=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
990 1024
991B<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
992of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
… …
1159when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1160 1194
1161 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
1162 1196
1163If 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>
1164is 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)
1165manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167 1201
1168 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1169 1203
… …
1227all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1228 1262
1229=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1230 1264
1231Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1233will be ignored when running setuid/setgid.
1234 1267
1235=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1236 1269
1237Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1239@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241will be ignored when running setuid/setgid.
1242 1274
1243See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1244 1276
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246 1278
… …
1268 1300
1269=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1270 1302
1271Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1272it 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).
1273 1309
1274=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1275 1311
1276Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1277 1313
… …
1420B<@@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
1421it 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
1422allow 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
1423on 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.
1424 1460
1425=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1426 1462
1427In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1428B<@@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
1429high-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
1430colours with their names. 1466colours with their names.
… …
1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1471I<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
1472been specified. For example, 1508been specified. For example,
1473 1509
1474=over 4
1475
1476=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1477 1511
1478would 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
1479on White. 1513White.
1480
1481=back
1482 1514
1483=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1484 1516
1485If 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
1486their 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:
1487 1519
1488You can prefix any color with an opaquenes percentage enclosed in 1520You can prefix any colour with an opaquenes percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(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
1491transparent 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
1492half-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
1493is the recommended format to specify transparency values, and works with 1525is the recommended format to specify transparency values, and works with
1494all ways to specify a colour. 1526all ways to specify a colour.
1495 1527
… …
1603 1635
1604=over 4 1636=over 4
1605 1637
1606=item B</usr/lib/X11/rgb.txt> 1638=item B</usr/lib/X11/rgb.txt>
1607 1639
1608Color names. 1640Colour names.
1609 1641
1610=back 1642=back
1611 1643
1612=head1 SEE ALSO 1644=head1 SEE ALSO
1613 1645

Diff Legend

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