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.178 by root, Sun May 23 01:05:01 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>
… …
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
… …
808it 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
809wide and 15 pixels high. 818wide and 15 pixels high.
810 819
811The 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
812the base font, likewise the third, which is unfortunately non-bold, but 821the 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 822the bold version of the font does contain fewer characters, so this is a
814useful supplement. 823useful supplement.
815 824
816The 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
817are 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
818contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
1003 1012
1004=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
1005 1014
1006B<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];
1007option 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>.
1008 1022
1009=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
1010 1024
1011B<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
1012of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
… …
1179when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1180 1194
1181 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
1182 1196
1183If 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>
1184is 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)
1185manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1201
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1189 1203
… …
1286 1300
1287=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1288 1302
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1290it 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).
1291 1309
1292=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1293 1311
1294Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1295 1313
… …
1438B<@@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
1439it 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
1440allow 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
1441on 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.
1442 1460
1443=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1444 1462
1445In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1446B<@@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
1447high-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
1448colours 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.
1449 1470
1450=begin table 1471=begin table
1451 1472
1452 B<color0> (black) = Black 1473 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1474 B<color1> (red) = Red3
… …
1473It is also possible to specify the colour values of B<foreground>, 1494It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1495B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a 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
1476color0-color15. 1497color0-color15.
1477 1498
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1499The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1500values 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 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).
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").
1486 1513
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1514Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1515always swapping the foreground/background colours. This is in contrast to
1489I<xterm>(1) where the colours are only swapped if they have not otherwise 1516I<xterm>(1) where the colours are only swapped if they have not otherwise
1490been specified. For example, 1517been specified. For example,
1491 1518
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1519 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1520
1496would yield White on Black, while on I<xterm>(1) it would yield Black 1521would yield White on Black, while on I<xterm>(1) it would yield Black on
1497on White. 1522White.
1498
1499=back
1500 1523
1501=head2 ALPHA CHANNEL SUPPORT 1524=head2 ALPHA CHANNEL SUPPORT
1502 1525
1503If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1526If 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: 1527their act together, rxvt-unicode will do it's own alpha channel management:
1505 1528
1506You can prefix any color with an opaquenes percentage enclosed in 1529You can prefix any colour with an opaquenes percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1530brackets, 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 1531(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 1532transparent 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 1533half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with 1534is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1535all ways to specify a colour.
1513 1536
… …
1621 1644
1622=over 4 1645=over 4
1623 1646
1624=item B</usr/lib/X11/rgb.txt> 1647=item B</usr/lib/X11/rgb.txt>
1625 1648
1626Color names. 1649Colour names.
1627 1650
1628=back 1651=back
1629 1652
1630=head1 SEE ALSO 1653=head1 SEE ALSO
1631 1654

Diff Legend

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