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.172 by root, Fri Nov 13 23:23:03 2009 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

… …
129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off illusion of a transparent window background; resource B<transparent>.
130 130
131B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions. 132future versions.
133 133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136
137=item B<-fade> I<number> 134=item B<-fade> I<number>
138 135
139Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
141colour; resource B<fading>. 138colour; resource B<fading>.
… …
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 149non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it. 150used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side, 151Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are: 152thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also 153blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource 154pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example: 155I<tintColor>. Example:
159 156
160 @@RXVT_NAME@@ -tr -tint blue -sh 40 157 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 158
162=item B<-sh> I<number> 159=item B<-sh> I<number>
… …
168=item B<-blt> I<string> 165=item B<-blt> I<string>
169 166
170Specify background blending type. If background pixmap is specified 167Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 168at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 169transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 173alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 174
178=item B<-blr> I<HxV> 175=item B<-blr> I<HxV>
179 176
180Apply Gaussian Blur with the specified radii to the transparent 177Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 178background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 179horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 180radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
185resource I<blurRadius>. 182resource I<blurRadius>.
186 183
187=item B<-icon> I<file> 184=item B<-icon> I<file>
188 185
189Compile I<afterimage>: Use the specified image as application icon. This 186Compile 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 187is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 188application window; resource I<iconFile>.
192 189
193=item B<-bg> I<colour> 190=item B<-bg> I<colour>
194 191
… …
198 195
199Window foreground colour; resource B<foreground>. 196Window foreground colour; resource B<foreground>.
200 197
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202 199
203Compile I<afterimage>: Specify image file for the background and also 200Compile 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 201optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 202add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 203command-line; for more details see resource B<backgroundPixmap>.
207 204
208=item B<-cr> I<colour> 205=item B<-cr> I<colour>
… …
625Use the specified colour for the colour value I<n>, where 0-7 622Use the specified colour for the colour value I<n>, where 0-7
626corresponds to low-intensity (normal) colours and 8-15 corresponds to 623corresponds to low-intensity (normal) colours and 8-15 corresponds to
627high-intensity (bold = bright foreground, blink = bright background) 624high-intensity (bold = bright foreground, blink = bright background)
628colours. The canonical names are as follows: 0=black, 1=red, 2=green, 625colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630names used are listed in the B<COLORS AND GRAPHICS> section. 627names used are listed in the B<COLOURS AND GRAPHICS> section.
631 628
632Colours higher than 15 cannot be set using resources (yet), but can be 629Colours higher than 15 cannot be set using resources (yet), but can be
633changed using an escape command (see @@RXVT_NAME@@(7)). 630changed using an escape command (see @@RXVT_NAME@@(7)).
634 631
635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 632Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
646=item B<colorUL:> I<colour> 643=item B<colorUL:> I<colour>
647 644
648Use the specified colour to display underlined characters when the 645Use the specified colour to display underlined characters when the
649foreground colour is the default. 646foreground colour is the default.
650 647
651=item B<colorRV:> I<colour>
652
653Use the specified colour as the background for reverse video characters
654when OPTION_HC is disabled (--disable-frills).
655
656=item B<underlineColor:> I<colour> 648=item B<underlineColor:> I<colour>
657 649
658If set, use the specified colour as the colour for the underline 650If set, use the specified colour as the colour for the underline
659itself. If unset, use the foreground colour. 651itself. If unset, use the foreground colour.
652
653=item B<highlightColor:> I<colour>
654
655If set, use the specified colour as the background for highlighted
656characters. If unset, use reverse video.
657
658=item B<highlightTextColor:> I<colour>
659
660If set and highlightColor is set, use the specified colour as the
661foreground for highlighted characters.
660 662
661=item B<cursorColor:> I<colour> 663=item B<cursorColor:> I<colour>
662 664
663Use the specified colour for the cursor. The default is to use the 665Use the specified colour for the cursor. The default is to use the
664foreground colour; option B<-cr>. 666foreground colour; option B<-cr>.
… …
671 673
672=item B<reverseVideo:> I<boolean> 674=item B<reverseVideo:> I<boolean>
673 675
674B<True>: simulate reverse video by foreground and background colours; 676B<True>: simulate reverse video by foreground and background colours;
675option B<-rv>. B<False>: regular screen colours [default]; option 677option B<-rv>. B<False>: regular screen colours [default]; option
676B<+rv>. See note in B<COLORS AND GRAPHICS> section. 678B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
677 679
678=item B<jumpScroll:> I<boolean> 680=item B<jumpScroll:> I<boolean>
679 681
680B<True>: specify that jump scrolling should be used. When receiving lots 682B<True>: specify that jump scrolling should be used. When receiving lots
681of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 683of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
702Turn on/off illusion of a transparent window background. 704Turn on/off illusion of a transparent window background.
703 705
704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705future versions. 707future versions.
706 708
707I<Please address all transparency related issues to Sasha Vasko at
708sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
709
710=item B<fading:> I<number> 709=item B<fading:> I<number>
711 710
712Fade the text by the given percentage when focus is lost; option B<-fade>. 711Fade the text by the given percentage when focus is lost; option B<-fade>.
713 712
714=item B<fadeColor:> I<colour> 713=item B<fadeColor:> I<colour>
… …
755 754
756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
757 756
758Use the specified image file for the background and also 757Use the specified image file for the background and also
759optionally specify its scaling with a geometry string B<WxH+X+Y>, 758optionally specify its scaling with a geometry string B<WxH+X+Y>,
760(default C<0x0+50+50>) in which B<"W" / "H"> specify the 759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
762centre (percent). A scale of 0 displays the image with tiling. A scale 761centre (percent). A scale of 0 displays the image with tiling.
763of 1 displays the image without any scaling. A scale of 2 to 9 specifies 762The maximum permitted scale is 1000.
764an integer number of images in that direction. No image will be magnified
765beyond 10 times its original size. The maximum permitted scale is 1000.
766Additional operations can be specified after colon B<:op1:op2...>. 763Additional operations can be specified after colon B<:op1:op2...>.
767Supported operations are: 764Supported operations are:
768 765
769 tile force background image to be tiled and not scaled. Equivalent to 0x0 766 tile force background image to be tiled and not scaled. Equivalent to 0x0
770 propscale will scale image keeping proportions 767 propscale will scale image keeping proportions
… …
774 scale will scale image to match window size 771 scale will scale image to match window size
775 root will tile image as if it was a root window background, auto-adjusting 772 root will tile image as if it was a root window background, auto-adjusting
776 whenever terminal window moves 773 whenever terminal window moves
777 774
778If used in conjunction with B<-tr> option, the specified pixmap will be 775If used in conjunction with B<-tr> option, the specified pixmap will be
779blended over transparency image using either alpha-blending, or any 776blended over transparency image using alpha-blending. If I<afterimage>
780other blending type, specified with B<-blt "type"> option. 777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
781 779
782=item B<path:> I<path> 780=item B<path:> I<path>
783 781
784Specify the colon-delimited search path for finding background image files. 782Specify the colon-delimited search path for finding background image files.
785 783
… …
812it is named first) and thus defines the character cell grid to be 9 pixels 810it is named first) and thus defines the character cell grid to be 9 pixels
813wide and 15 pixels high. 811wide and 15 pixels high.
814 812
815The second font is just used to add additional unicode characters not in 813The second font is just used to add additional unicode characters not in
816the base font, likewise the third, which is unfortunately non-bold, but 814the base font, likewise the third, which is unfortunately non-bold, but
817the bold version of the font does contain less characters, so this is a 815the bold version of the font does contain fewer characters, so this is a
818useful supplement. 816useful supplement.
819 817
820The third font is an Xft font with aliasing turned off, and the characters 818The third font is an Xft font with aliasing turned off, and the characters
821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 819are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
822contains other characters, but we are not interested in them. 820contains other characters, but we are not interested in them.
… …
1035large number (e.g. C<987654321>) to effectively disable the timeout. 1033large number (e.g. C<987654321>) to effectively disable the timeout.
1036 1034
1037=item B<backspacekey:> I<string> 1035=item B<backspacekey:> I<string>
1038 1036
1039The string to send when the backspace key is pressed. If set to B<DEC> 1037The string to send when the backspace key is pressed. If set to B<DEC>
1040or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1038or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1041(code 8) - which can be reversed with the appropriate DEC private mode 1039(code 8) - which can be reversed with the appropriate DEC private mode
1042escape sequence. 1040escape sequence.
1043 1041
1044=item B<deletekey:> I<string> 1042=item B<deletekey:> I<string>
1045 1043
… …
1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1162omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1165keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1163keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1166performed in an exact manner; however, the closest match is assured. 1164performed in an exact manner; however, the closest match is assured.
1167 1165
1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1169number), see RESOURCES in C<man 7 X> for futher details. 1167number), see RESOURCES in C<man 7 X> for further details.
1170 1168
1171You can define a range of keysyms in one shot by providing a I<string> 1169You can define a range of keysyms in one shot by providing a I<string>
1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1173should be a character not used by the strings. 1171should be a character not used by the strings.
1174 1172
… …
1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1196 1194
1197 URxvt.keysym.M-C-c: perl:selection:rot13 1195 URxvt.keysym.M-C-c: perl:selection:rot13
1198 1196
1199Due the the large number of modifier combinations, a defined key mapping 1197Due the the large number of modifier combinations, a defined key mapping
1200will match if at I<at least> the specified identifiers are being set, and 1198will match if I<at least> the specified identifiers are being set, and
1201no other key mappings with those and more bits are being defined. That 1199no other key mappings with those and more bits are being defined. That
1202means that defining a key map for C<a> will automatically provide 1200means that defining a key map for C<a> will automatically provide
1203definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204mappings themselves. 1202mappings themselves.
1205 1203
… …
1295 1293
1296=item B<override-redirect>: I<boolean> 1294=item B<override-redirect>: I<boolean>
1297 1295
1298Compile I<frills>: Sets override-redirect for the terminal window, making 1296Compile I<frills>: Sets override-redirect for the terminal window, making
1299it almost invisible to window managers; option B<-override-redirect>. 1297it almost invisible to window managers; option B<-override-redirect>.
1298
1299=item B<iso14755:> I<boolean>
1300
1301Turn on/off ISO 14755 (default enabled).
1300 1302
1301=item B<iso14755_52:> I<boolean> 1303=item B<iso14755_52:> I<boolean>
1302 1304
1303Turn on/off ISO 14755 5.2 mode (default enabled). 1305Turn on/off ISO 14755 5.2 mode (default enabled).
1304 1306
… …
1447B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1449B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1448it can be seen via the I<who(1)> command, and can accept messages. To 1450it can be seen via the I<who(1)> command, and can accept messages. To
1449allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1451allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1450on some systems or setgid to root or to some other group on others. 1452on some systems or setgid to root or to some other group on others.
1451 1453
1452=head1 COLORS AND GRAPHICS 1454=head1 COLOURS AND GRAPHICS
1453 1455
1454In addition to the default foreground and background colours, 1456In addition to the default foreground and background colours,
1455B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1457B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1456high-intensity bold/blink versions of the same). Here is a list of the 1458high-intensity (potentially bold/blink) versions of the same, and 72 (or
1457colours with their names. 1459240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1460cube plus a 8 (24) colour greyscale ramp.
1461
1462Here is a list of the ANSI colours with their names.
1458 1463
1459=begin table 1464=begin table
1460 1465
1461 B<color0> (black) = Black 1466 B<color0> (black) = Black
1462 B<color1> (red) = Red3 1467 B<color1> (red) = Red3
… …
1482It is also possible to specify the colour values of B<foreground>, 1487It is also possible to specify the colour values of B<foreground>,
1483B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1488B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1484a number 0-15, as a convenient shorthand to reference the colour name of 1489a number 0-15, as a convenient shorthand to reference the colour name of
1485color0-color15. 1490color0-color15.
1486 1491
1487In addition to the colours defined above, @@RXVT_NAME@@ offers an 1492The following text gives values for the standard 88 colour mode (and
1488additional 72 colours. The first 64 of those (with indices 16 to 79) 1493values for the 256 colour mode in parentheses).
1489consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149016>), followed by 8 additional shades of gray (with indices 80 to 87).
1491 1494
1495The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1499
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube.
1503
1492Together, all those colours implement the 88 colour xterm colours. Only 1504Together, all those colours implement the 88 (256) colour xterm
1493the first 16 can be changed using resources currently, the rest can only 1505colours. Only the first 16 can be changed using resources currently, the
1494be changed via command sequences ("escape codes"). 1506rest can only be changed via command sequences ("escape codes").
1507
1508Applications are advised to use terminfo or command sequences to discover
1509number and RGB values of all colours (yes, you can query this...).
1495 1510
1496Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1511Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1497always swapping the foreground/background colours. This is in contrast to 1512always swapping the foreground/background colours. This is in contrast to
1498I<xterm>(1) where the colours are only swapped if they have not otherwise 1513I<xterm>(1) where the colours are only swapped if they have not otherwise
1499been specified. For example, 1514been specified. For example,
1500 1515
1501=over 4
1502
1503=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1516 @@RXVT_NAME@@ -fg Black -bg White -rv
1504 1517
1505would yield White on Black, while on I<xterm>(1) it would yield Black 1518would yield White on Black, while on I<xterm>(1) it would yield Black on
1506on White. 1519White.
1507
1508=back
1509 1520
1510=head2 ALPHA CHANNEL SUPPORT 1521=head2 ALPHA CHANNEL SUPPORT
1511 1522
1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1513their act together, rxvt-unicode will do it's own alpha channel management: 1524their act together, rxvt-unicode will do it's own alpha channel management:
1514 1525
1515You can prefix any color with an opaquenes percentage enclosed in 1526You can prefix any colour with an opaqueness percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517(0-100) that specifies the opacity of the color, where C<0> is completely 1528(0-100) that specifies the opacity of the colour, where C<0> is completely
1518transparent and C<100> is completely opaque. For example, C<[50]red> is a 1529transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1530half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520is the recommended format to specify transparency values, and works with 1531is the recommended format to specify transparency values, and works with
1521all ways to specify a colour. 1532all ways to specify a colour.
1522 1533
… …
1630 1641
1631=over 4 1642=over 4
1632 1643
1633=item B</usr/lib/X11/rgb.txt> 1644=item B</usr/lib/X11/rgb.txt>
1634 1645
1635Color names. 1646Colour names.
1636 1647
1637=back 1648=back
1638 1649
1639=head1 SEE ALSO 1650=head1 SEE ALSO
1640 1651

Diff Legend

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