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.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 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>
179 179
180Apply Gaussian Blur with the specified radii to the transparent 180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 181background image. If single number is specified - both vertical and
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> or I<xft>;
185resource I<blurRadius>. 185resource I<blurRadius>.
186 186
187=item B<-icon> I<file> 187=item B<-icon> I<file>
188 188
189Compile I<afterimage>: Use the specified image as application icon. This 189Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 191application window; resource I<iconFile>.
192 192
193=item B<-bg> I<colour> 193=item B<-bg> I<colour>
194 194
… …
198 198
199Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
200 200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202 202
203Compile I<afterimage>: Specify image file for the background and also 203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
207 207
208=item B<-cr> I<colour> 208=item B<-cr> I<colour>
… …
320on a tab character is displayed as a wide cursor; resource B<pastableTabs>. 320on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
321 321
322=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
323 323
324Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
325 329
326=item B<-iconic> 330=item B<-iconic>
327 331
328Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 333Alternative form is B<-ic>.
… …
621Use 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
622corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
623high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
624colours. 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,
6253=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
626names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
627 631
628Colours 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
629changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
630 634
631Colours 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
… …
642=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
643 647
644Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
645foreground colour is the default. 649foreground colour is the default.
646 650
647=item B<colorRV:> I<colour>
648
649Use the specified colour as the background for reverse video characters
650when OPTION_HC is disabled (--disable-frills).
651
652=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
653 652
654If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
655itself. 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.
656 665
657=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
658 667
659Use 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
660foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
667 676
668=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
669 678
670B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
671option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
672B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673 682
674=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
675 684
676B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
677of 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
… …
751 760
752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
753 762
754Use the specified image file for the background and also 763Use the specified image file for the background and also
755optionally specify its scaling with a geometry string B<WxH+X+Y>, 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
756(default C<0x0+50+50>) in which B<"W" / "H"> specify the 765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling.
759of 1 displays the image without any scaling. A scale of 2 to 9 specifies 768The maximum permitted scale is 1000.
760an integer number of images in that direction. No image will be magnified
761beyond 10 times its original size. The maximum permitted scale is 1000.
762Additional operations can be specified after colon B<:op1:op2...>. 769Additional operations can be specified after colon B<:op1:op2...>.
763Supported operations are: 770Supported operations are:
764 771
765 tile force background image to be tiled and not scaled. Equivalent to 0x0 772 tile force background image to be tiled and not scaled. Equivalent to 0x0
766 propscale will scale image keeping proportions 773 propscale will scale image keeping proportions
… …
770 scale will scale image to match window size 777 scale will scale image to match window size
771 root will tile image as if it was a root window background, auto-adjusting 778 root will tile image as if it was a root window background, auto-adjusting
772 whenever terminal window moves 779 whenever terminal window moves
773 780
774If used in conjunction with B<-tr> option, the specified pixmap will be 781If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any 782blended over transparency image using alpha-blending. If I<afterimage>
776other blending type, specified with B<-blt "type"> option. 783support has been compiled in it is possible to choose other blending
784types with B<-blt "type"> option.
777 785
778=item B<path:> I<path> 786=item B<path:> I<path>
779 787
780Specify the colon-delimited search path for finding background image files. 788Specify the colon-delimited search path for finding background image files.
781 789
… …
808it is named first) and thus defines the character cell grid to be 9 pixels 816it is named first) and thus defines the character cell grid to be 9 pixels
809wide and 15 pixels high. 817wide and 15 pixels high.
810 818
811The second font is just used to add additional unicode characters not in 819The second font is just used to add additional unicode characters not in
812the base font, likewise the third, which is unfortunately non-bold, but 820the base font, likewise the third, which is unfortunately non-bold, but
813the bold version of the font does contain less characters, so this is a 821the bold version of the font does contain fewer characters, so this is a
814useful supplement. 822useful supplement.
815 823
816The third font is an Xft font with aliasing turned off, and the characters 824The third font is an Xft font with aliasing turned off, and the characters
817are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 825are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818contains other characters, but we are not interested in them. 826contains other characters, but we are not interested in them.
… …
1004=item B<cursorBlink:> I<boolean> 1012=item B<cursorBlink:> I<boolean>
1005 1013
1006B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1014B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007option B<-bc>. 1015option B<-bc>.
1008 1016
1017=item B<cursorUnderline:> I<boolean>
1018
1019B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1020option B<-uc>.
1021
1009=item B<pointerBlank:> I<boolean> 1022=item B<pointerBlank:> I<boolean>
1010 1023
1011B<True>: blank the pointer when a key is pressed or after a set number 1024B<True>: blank the pointer when a key is pressed or after a set number
1012of seconds of inactivity. B<False>: the pointer is always visible 1025of seconds of inactivity. B<False>: the pointer is always visible
1013[default]. 1026[default].
… …
1026large number (e.g. C<987654321>) to effectively disable the timeout. 1039large number (e.g. C<987654321>) to effectively disable the timeout.
1027 1040
1028=item B<backspacekey:> I<string> 1041=item B<backspacekey:> I<string>
1029 1042
1030The string to send when the backspace key is pressed. If set to B<DEC> 1043The string to send when the backspace key is pressed. If set to B<DEC>
1031or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1044or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1032(code 8) - which can be reversed with the appropriate DEC private mode 1045(code 8) - which can be reversed with the appropriate DEC private mode
1033escape sequence. 1046escape sequence.
1034 1047
1035=item B<deletekey:> I<string> 1048=item B<deletekey:> I<string>
1036 1049
… …
1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1168omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1169keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1157performed in an exact manner; however, the closest match is assured. 1170performed in an exact manner; however, the closest match is assured.
1158 1171
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1172I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for futher details. 1173number), see RESOURCES in C<man 7 X> for further details.
1161 1174
1162You can define a range of keysyms in one shot by providing a I<string> 1175You can define a range of keysyms in one shot by providing a I<string>
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1176with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1177should be a character not used by the strings.
1165 1178
… …
1179when Control-Meta-c is being pressed": 1192when Control-Meta-c is being pressed":
1180 1193
1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1194 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182 1195
1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1196If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1184is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1197is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1185manpage. For example, the F<selection> extension (activated via 1198manpage. For example, the F<selection> extension (activated via
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1199C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1200
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1201 URxvt.keysym.M-C-c: perl:selection:rot13
1189 1202
1190Due the the large number of modifier combinations, a defined key mapping 1203Due the the large number of modifier combinations, a defined key mapping
1191will match if at I<at least> the specified identifiers are being set, and 1204will match if I<at least> the specified identifiers are being set, and
1192no other key mappings with those and more bits are being defined. That 1205no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide 1206means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1207definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves. 1208mappings themselves.
1196 1209
… …
1286 1299
1287=item B<override-redirect>: I<boolean> 1300=item B<override-redirect>: I<boolean>
1288 1301
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1302Compile I<frills>: Sets override-redirect for the terminal window, making
1290it almost invisible to window managers; option B<-override-redirect>. 1303it almost invisible to window managers; option B<-override-redirect>.
1304
1305=item B<iso14755:> I<boolean>
1306
1307Turn on/off ISO 14755 (default enabled).
1291 1308
1292=item B<iso14755_52:> I<boolean> 1309=item B<iso14755_52:> I<boolean>
1293 1310
1294Turn on/off ISO 14755 5.2 mode (default enabled). 1311Turn on/off ISO 14755 5.2 mode (default enabled).
1295 1312
… …
1438B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1455B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439it can be seen via the I<who(1)> command, and can accept messages. To 1456it can be seen via the I<who(1)> command, and can accept messages. To
1440allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1457allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441on some systems or setgid to root or to some other group on others. 1458on some systems or setgid to root or to some other group on others.
1442 1459
1443=head1 COLORS AND GRAPHICS 1460=head1 COLOURS AND GRAPHICS
1444 1461
1445In addition to the default foreground and background colours, 1462In addition to the default foreground and background colours,
1446B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1463B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447high-intensity bold/blink versions of the same). Here is a list of the 1464high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448colours with their names. 1465240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1466cube plus a 8 (24) colour greyscale ramp.
1467
1468Here is a list of the ANSI colours with their names.
1449 1469
1450=begin table 1470=begin table
1451 1471
1452 B<color0> (black) = Black 1472 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1473 B<color1> (red) = Red3
… …
1473It is also possible to specify the colour values of B<foreground>, 1493It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1494B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a number 0-15, as a convenient shorthand to reference the colour name of 1495a number 0-15, as a convenient shorthand to reference the colour name of
1476color0-color15. 1496color0-color15.
1477 1497
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1498The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1499values for the 256 colour mode in parentheses).
1480consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
148116>), followed by 8 additional shades of gray (with indices 80 to 87).
1482 1500
1501The RGB cube uses indices 16..79 (16..231) using the following formulas:
1502
1503 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1504 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1505
1506The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1507steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1508the RGB cube.
1509
1483Together, all those colours implement the 88 colour xterm colours. Only 1510Together, all those colours implement the 88 (256) colour xterm
1484the first 16 can be changed using resources currently, the rest can only 1511colours. Only the first 16 can be changed using resources currently, the
1485be changed via command sequences ("escape codes"). 1512rest can only be changed via command sequences ("escape codes").
1513
1514Applications are advised to use terminfo or command sequences to discover
1515number and RGB values of all colours (yes, you can query this...).
1486 1516
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1517Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1518always swapping the foreground/background colours. This is in contrast to
1489I<xterm>(1) where the colours are only swapped if they have not otherwise 1519I<xterm>(1) where the colours are only swapped if they have not otherwise
1490been specified. For example, 1520been specified. For example,
1491 1521
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1522 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1523
1496would yield White on Black, while on I<xterm>(1) it would yield Black 1524would yield White on Black, while on I<xterm>(1) it would yield Black on
1497on White. 1525White.
1498
1499=back
1500 1526
1501=head2 ALPHA CHANNEL SUPPORT 1527=head2 ALPHA CHANNEL SUPPORT
1502 1528
1503If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1529If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504their act together, rxvt-unicode will do it's own alpha channel management: 1530their act together, rxvt-unicode will do it's own alpha channel management:
1505 1531
1506You can prefix any color with an opaquenes percentage enclosed in 1532You can prefix any colour with an opaqueness percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1533brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508(0-100) that specifies the opacity of the color, where C<0> is completely 1534(0-100) that specifies the opacity of the colour, where C<0> is completely
1509transparent and C<100> is completely opaque. For example, C<[50]red> is a 1535transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1536half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with 1537is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1538all ways to specify a colour.
1513 1539
… …
1621 1647
1622=over 4 1648=over 4
1623 1649
1624=item B</usr/lib/X11/rgb.txt> 1650=item B</usr/lib/X11/rgb.txt>
1625 1651
1626Color names. 1652Colour names.
1627 1653
1628=back 1654=back
1629 1655
1630=head1 SEE ALSO 1656=head1 SEE ALSO
1631 1657

Diff Legend

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