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.169 by root, Wed Nov 5 00:14:18 2008 UTC vs.
Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 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>
… …
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> 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>
… …
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 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
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>.
330 334
… …
366=item B<-lsp> I<number> 370=item B<-lsp> I<number>
367 371
368Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
369the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
370B<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>.
371 382
372=item B<-tn> I<termname> 383=item B<-tn> I<termname>
373 384
374This 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
375B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
614Use 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
615corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
616high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
617colours. 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,
6183=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
619names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
620 631
621Colours 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
622changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
623 634
624Colours 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
… …
635=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
636 647
637Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
638foreground colour is the default. 649foreground colour is the default.
639 650
640=item B<colorRV:> I<colour>
641
642Use the specified colour as the background for reverse video characters
643when OPTION_HC is disabled (--disable-frills).
644
645=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
646 652
647If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
648itself. 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.
649 665
650=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
651 667
652Use 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
653foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
660 676
661=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
662 678
663B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
664option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
665B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666 682
667=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
668 684
669B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
670of 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
… …
744 760
745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
746 762
747Use the specified image file for the background and also 763Use the specified image file for the background and also
748optionally specify its scaling with a geometry string B<WxH+X+Y>, 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
749(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
750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling.
752of 1 displays the image without any scaling. A scale of 2 to 9 specifies 768The maximum permitted scale is 1000.
753an integer number of images in that direction. No image will be magnified
754beyond 10 times its original size. The maximum permitted scale is 1000.
755Additional operations can be specified after colon B<:op1:op2...>. 769Additional operations can be specified after colon B<:op1:op2...>.
756Supported operations are: 770Supported operations are:
757 771
758 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
759 propscale will scale image keeping proportions 773 propscale will scale image keeping proportions
… …
801it is named first) and thus defines the character cell grid to be 9 pixels 815it is named first) and thus defines the character cell grid to be 9 pixels
802wide and 15 pixels high. 816wide and 15 pixels high.
803 817
804The second font is just used to add additional unicode characters not in 818The second font is just used to add additional unicode characters not in
805the base font, likewise the third, which is unfortunately non-bold, but 819the base font, likewise the third, which is unfortunately non-bold, but
806the bold version of the font does contain less characters, so this is a 820the bold version of the font does contain fewer characters, so this is a
807useful supplement. 821useful supplement.
808 822
809The third font is an Xft font with aliasing turned off, and the characters 823The third font is an Xft font with aliasing turned off, and the characters
810are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 824are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
811contains other characters, but we are not interested in them. 825contains other characters, but we are not interested in them.
… …
997=item B<cursorBlink:> I<boolean> 1011=item B<cursorBlink:> I<boolean>
998 1012
999B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1013B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1000option B<-bc>. 1014option B<-bc>.
1001 1015
1016=item B<cursorUnderline:> I<boolean>
1017
1018B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1019option B<-uc>.
1020
1002=item B<pointerBlank:> I<boolean> 1021=item B<pointerBlank:> I<boolean>
1003 1022
1004B<True>: blank the pointer when a key is pressed or after a set number 1023B<True>: blank the pointer when a key is pressed or after a set number
1005of seconds of inactivity. B<False>: the pointer is always visible 1024of seconds of inactivity. B<False>: the pointer is always visible
1006[default]. 1025[default].
… …
1019large number (e.g. C<987654321>) to effectively disable the timeout. 1038large number (e.g. C<987654321>) to effectively disable the timeout.
1020 1039
1021=item B<backspacekey:> I<string> 1040=item B<backspacekey:> I<string>
1022 1041
1023The string to send when the backspace key is pressed. If set to B<DEC> 1042The string to send when the backspace key is pressed. If set to B<DEC>
1024or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1043or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1025(code 8) - which can be reversed with the appropriate DEC private mode 1044(code 8) - which can be reversed with the appropriate DEC private mode
1026escape sequence. 1045escape sequence.
1027 1046
1028=item B<deletekey:> I<string> 1047=item B<deletekey:> I<string>
1029 1048
… …
1148omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1167omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1149keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1168keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1150performed in an exact manner; however, the closest match is assured. 1169performed in an exact manner; however, the closest match is assured.
1151 1170
1152I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1171I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1153number), see RESOURCES in C<man 7 X> for futher details. 1172number), see RESOURCES in C<man 7 X> for further details.
1154 1173
1155You can define a range of keysyms in one shot by providing a I<string> 1174You can define a range of keysyms in one shot by providing a I<string>
1156with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1157should be a character not used by the strings. 1176should be a character not used by the strings.
1158 1177
… …
1172when Control-Meta-c is being pressed": 1191when Control-Meta-c is being pressed":
1173 1192
1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1193 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1175 1194
1176If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1195If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1177is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1196is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1178manpage. For example, the F<selection> extension (activated via 1197manpage. For example, the F<selection> extension (activated via
1179C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180 1199
1181 URxvt.keysym.M-C-c: perl:selection:rot13 1200 URxvt.keysym.M-C-c: perl:selection:rot13
1182 1201
… …
1279 1298
1280=item B<override-redirect>: I<boolean> 1299=item B<override-redirect>: I<boolean>
1281 1300
1282Compile I<frills>: Sets override-redirect for the terminal window, making 1301Compile I<frills>: Sets override-redirect for the terminal window, making
1283it almost invisible to window managers; option B<-override-redirect>. 1302it almost invisible to window managers; option B<-override-redirect>.
1303
1304=item B<iso14755:> I<boolean>
1305
1306Turn on/off ISO 14755 (default enabled).
1284 1307
1285=item B<iso14755_52:> I<boolean> 1308=item B<iso14755_52:> I<boolean>
1286 1309
1287Turn on/off ISO 14755 5.2 mode (default enabled). 1310Turn on/off ISO 14755 5.2 mode (default enabled).
1288 1311
… …
1431B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1454B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1432it can be seen via the I<who(1)> command, and can accept messages. To 1455it can be seen via the I<who(1)> command, and can accept messages. To
1433allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1456allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1434on some systems or setgid to root or to some other group on others. 1457on some systems or setgid to root or to some other group on others.
1435 1458
1436=head1 COLORS AND GRAPHICS 1459=head1 COLOURS AND GRAPHICS
1437 1460
1438In addition to the default foreground and background colours, 1461In addition to the default foreground and background colours,
1439B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1462B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1440high-intensity bold/blink versions of the same). Here is a list of the 1463high-intensity (potentially bold/blink) versions of the same, and 72 (or
1441colours with their names. 1464240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1465cube plus a 8 (24) colour greyscale ramp.
1466
1467Here is a list of the ANSI colours with their names.
1442 1468
1443=begin table 1469=begin table
1444 1470
1445 B<color0> (black) = Black 1471 B<color0> (black) = Black
1446 B<color1> (red) = Red3 1472 B<color1> (red) = Red3
… …
1466It is also possible to specify the colour values of B<foreground>, 1492It is also possible to specify the colour values of B<foreground>,
1467B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1493B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1468a number 0-15, as a convenient shorthand to reference the colour name of 1494a number 0-15, as a convenient shorthand to reference the colour name of
1469color0-color15. 1495color0-color15.
1470 1496
1471In addition to the colours defined above, @@RXVT_NAME@@ offers an 1497The following text gives values for the standard 88 colour mode (and
1472additional 72 colours. The first 64 of those (with indices 16 to 79) 1498values for the 256 colour mode in parentheses).
1473consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
147416>), followed by 8 additional shades of gray (with indices 80 to 87).
1475 1499
1500The RGB cube uses indices 16..79 (16..231) using the following formulas:
1501
1502 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1503 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1504
1505The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1506steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1507the RGB cube.
1508
1476Together, all those colours implement the 88 colour xterm colours. Only 1509Together, all those colours implement the 88 (256) colour xterm
1477the first 16 can be changed using resources currently, the rest can only 1510colours. Only the first 16 can be changed using resources currently, the
1478be changed via command sequences ("escape codes"). 1511rest can only be changed via command sequences ("escape codes").
1512
1513Applications are advised to use terminfo or command sequences to discover
1514number and RGB values of all colours (yes, you can query this...).
1479 1515
1480Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1516Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481always swapping the foreground/background colours. This is in contrast to 1517always swapping the foreground/background colours. This is in contrast to
1482I<xterm>(1) where the colours are only swapped if they have not otherwise 1518I<xterm>(1) where the colours are only swapped if they have not otherwise
1483been specified. For example, 1519been specified. For example,
1484 1520
1485=over 4
1486
1487=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1521 @@RXVT_NAME@@ -fg Black -bg White -rv
1488 1522
1489would yield White on Black, while on I<xterm>(1) it would yield Black 1523would yield White on Black, while on I<xterm>(1) it would yield Black on
1490on White. 1524White.
1491
1492=back
1493 1525
1494=head2 ALPHA CHANNEL SUPPORT 1526=head2 ALPHA CHANNEL SUPPORT
1495 1527
1496If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1528If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1497their act together, rxvt-unicode will do it's own alpha channel management: 1529their act together, rxvt-unicode will do it's own alpha channel management:
1498 1530
1499You can prefix any color with an opaquenes percentage enclosed in 1531You can prefix any colour with an opaqueness percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1532brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(0-100) that specifies the opacity of the color, where C<0> is completely 1533(0-100) that specifies the opacity of the colour, where C<0> is completely
1502transparent and C<100> is completely opaque. For example, C<[50]red> is a 1534transparent and C<100> is completely opaque. For example, C<[50]red> is a
1503half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1535half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1504is the recommended format to specify transparency values, and works with 1536is the recommended format to specify transparency values, and works with
1505all ways to specify a colour. 1537all ways to specify a colour.
1506 1538
… …
1614 1646
1615=over 4 1647=over 4
1616 1648
1617=item B</usr/lib/X11/rgb.txt> 1649=item B</usr/lib/X11/rgb.txt>
1618 1650
1619Color names. 1651Colour names.
1620 1652
1621=back 1653=back
1622 1654
1623=head1 SEE ALSO 1655=head1 SEE ALSO
1624 1656

Diff Legend

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