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.165 by root, Thu Oct 2 17:06:50 2008 UTC vs.
Revision 1.181 by sf-exg, Tue Jun 15 13:05:39 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
… …
360=item B<-lsp> I<number> 370=item B<-lsp> I<number>
361 371
362Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
363the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
364B<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>.
365 382
366=item B<-tn> I<termname> 383=item B<-tn> I<termname>
367 384
368This 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
369B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
608Use 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
609corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
610high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
611colours. 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,
6123=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
613names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
614 631
615Colours 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
616changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
617 634
618Colours 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
… …
629=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
630 647
631Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
632foreground colour is the default. 649foreground colour is the default.
633 650
634=item B<colorRV:> I<colour>
635
636Use the specified colour as the background for reverse video characters
637when OPTION_HC is disabled (--disable-frills).
638
639=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
640 652
641If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
642itself. 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.
643 665
644=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
645 667
646Use 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
647foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
654 676
655=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
656 678
657B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
658option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
659B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
660 682
661=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
662 684
663B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
664of 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
… …
713 735
714Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
715 737
716=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
717 739
718Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
719background 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>.
720 746
721=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
722 748
723Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
724 750
… …
791it 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
792wide and 15 pixels high. 818wide and 15 pixels high.
793 819
794The 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
795the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
796the 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
797useful supplement. 823useful supplement.
798 824
799The 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
800are 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
801contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
852=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
853 879
854B<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.
855B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
856 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
857=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
858 886
859B<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>.
860B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
861 889
… …
985=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
986 1014
987B<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];
988option B<-bc>. 1016option B<-bc>.
989 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>.
1022
990=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
991 1024
992B<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
993of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
994[default]. 1027[default].
… …
1007large number (e.g. C<987654321>) to effectively disable the timeout. 1040large number (e.g. C<987654321>) to effectively disable the timeout.
1008 1041
1009=item B<backspacekey:> I<string> 1042=item B<backspacekey:> I<string>
1010 1043
1011The string to send when the backspace key is pressed. If set to B<DEC> 1044The string to send when the backspace key is pressed. If set to B<DEC>
1012or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1045or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1013(code 8) - which can be reversed with the appropriate DEC private mode 1046(code 8) - which can be reversed with the appropriate DEC private mode
1014escape sequence. 1047escape sequence.
1015 1048
1016=item B<deletekey:> I<string> 1049=item B<deletekey:> I<string>
1017 1050
… …
1160when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1161 1194
1162 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
1163 1196
1164If 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>
1165is 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)
1166manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1201
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1170 1203
… …
1228all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1229 1262
1230=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1231 1264
1232Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1233the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1234will be ignored when running setuid/setgid.
1235 1267
1236=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1237 1269
1238Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1239scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1240@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1241F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1242will be ignored when running setuid/setgid.
1243 1274
1244See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1245 1276
1246=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1247 1278
… …
1269 1300
1270=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1271 1302
1272Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1273it 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).
1274 1309
1275=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1276 1311
1277Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1278 1313
… …
1421B<@@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
1422it 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
1423allow 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
1424on 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.
1425 1460
1426=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1427 1462
1428In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1429B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1464B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1430high-intensity bold/blink versions of the same). Here is a list of the 1465high-intensity (potentially bold/blink) versions of the same, and 72 (or
1431colours with their names. 1466240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1467cube plus a 8 (24) colour greyscale ramp.
1468
1469Here is a list of the ANSI colours with their names.
1432 1470
1433=begin table 1471=begin table
1434 1472
1435 B<color0> (black) = Black 1473 B<color0> (black) = Black
1436 B<color1> (red) = Red3 1474 B<color1> (red) = Red3
… …
1456It is also possible to specify the colour values of B<foreground>, 1494It is also possible to specify the colour values of B<foreground>,
1457B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1495B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1458a number 0-15, as a convenient shorthand to reference the colour name of 1496a number 0-15, as a convenient shorthand to reference the colour name of
1459color0-color15. 1497color0-color15.
1460 1498
1461In addition to the colours defined above, @@RXVT_NAME@@ offers an 1499The following text gives values for the standard 88 colour mode (and
1462additional 72 colours. The first 64 of those (with indices 16 to 79) 1500values for the 256 colour mode in parentheses).
1463consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146416>), followed by 8 additional shades of gray (with indices 80 to 87).
1465 1501
1502The RGB cube uses indices 16..79 (16..231) using the following formulas:
1503
1504 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1505 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1506
1507The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1508steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1509the RGB cube.
1510
1466Together, all those colours implement the 88 colour xterm colours. Only 1511Together, all those colours implement the 88 (256) colour xterm
1467the first 16 can be changed using resources currently, the rest can only 1512colours. Only the first 16 can be changed using resources currently, the
1468be changed via command sequences ("escape codes"). 1513rest can only be changed via command sequences ("escape codes").
1514
1515Applications are advised to use terminfo or command sequences to discover
1516number and RGB values of all colours (yes, you can query this...).
1469 1517
1470Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1518Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1471always swapping the foreground/background colours. This is in contrast to 1519always swapping the foreground/background colours. This is in contrast to
1472I<xterm>(1) where the colours are only swapped if they have not otherwise 1520I<xterm>(1) where the colours are only swapped if they have not otherwise
1473been specified. For example, 1521been specified. For example,
1474 1522
1475=over 4
1476
1477=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1523 @@RXVT_NAME@@ -fg Black -bg White -rv
1478 1524
1479would yield White on Black, while on I<xterm>(1) it would yield Black 1525would yield White on Black, while on I<xterm>(1) it would yield Black on
1480on White. 1526White.
1481
1482=back
1483 1527
1484=head2 ALPHA CHANNEL SUPPORT 1528=head2 ALPHA CHANNEL SUPPORT
1485 1529
1486If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1530If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1487their act together, rxvt-unicode will do it's own alpha channel management: 1531their act together, rxvt-unicode will do it's own alpha channel management:
1488 1532
1489You can prefix any color with an opaquenes percentage enclosed in 1533You can prefix any colour with an opaqueness percentage enclosed in
1490brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1534brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1491(0-100) that specifies the opacity of the color, where C<0> is completely 1535(0-100) that specifies the opacity of the colour, where C<0> is completely
1492transparent and C<100> is completely opaque. For example, C<[50]red> is a 1536transparent and C<100> is completely opaque. For example, C<[50]red> is a
1493half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1537half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1494is the recommended format to specify transparency values, and works with 1538is the recommended format to specify transparency values, and works with
1495all ways to specify a colour. 1539all ways to specify a colour.
1496 1540
… …
1604 1648
1605=over 4 1649=over 4
1606 1650
1607=item B</usr/lib/X11/rgb.txt> 1651=item B</usr/lib/X11/rgb.txt>
1608 1652
1609Color names. 1653Colour names.
1610 1654
1611=back 1655=back
1612 1656
1613=head1 SEE ALSO 1657=head1 SEE ALSO
1614 1658

Diff Legend

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