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.162 by root, Fri May 16 19:27:16 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>
… …
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> or I<pixbuf>: 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>
192 198
193Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
194 200
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196 202
197Compile I<afterimage>: Specify image file for the background and also 203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198optionally 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
199add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
201 207
202=item B<-cr> I<colour> 208=item B<-cr> 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
… …
340 350
341=item B<-bl> 351=item B<-bl>
342 352
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344if honoured by the WM, the rxvt-unicode window will not have window 354if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
346 357
347=item B<-override-redirect> 358=item B<-override-redirect>
348 359
349Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 361B<override-redirect>.
… …
359=item B<-lsp> I<number> 370=item B<-lsp> I<number>
360 371
361Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
363B<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>.
364 382
365=item B<-tn> I<termname> 383=item B<-tn> I<termname>
366 384
367This 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
368B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
454 472
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 474will not immediately destroy its window when the program executed within
457it exits. Instead, it will wait till it is being killed or closed by the 475it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 476user; resource B<hold>.
477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
459 483
460=item B<-xrm> I<string> 484=item B<-xrm> I<string>
461 485
462Works like the X Toolkit option of the same name, by adding the I<string> 486Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this 487as if it were specified in a resource file. Resource values specified this
… …
601Use 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
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
604colours. 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,
6053=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
606names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
607 631
608Colours 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
609changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
610 634
611Colours 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
… …
622=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
623 647
624Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
625foreground colour is the default. 649foreground colour is the default.
626 650
627=item B<colorRV:> I<colour>
628
629Use the specified colour as the background for reverse video characters
630when OPTION_HC is disabled (--disable-frills).
631
632=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
633 652
634If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
635itself. 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.
636 665
637=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
638 667
639Use 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
640foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
647 676
648=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
649 678
650B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 682
654=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
655 684
656B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
657of 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
… …
706 735
707Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
708 737
709=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
710 739
711Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
712background 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>.
713 746
714=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
715 748
716Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
717 750
… …
727 760
728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
729 762
730Use the specified image file for the background and also 763Use the specified image file for the background and also
731optionally specify its scaling with a geometry string B<WxH+X+Y>, 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
732(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
733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling.
735of 1 displays the image without any scaling. A scale of 2 to 9 specifies 768The maximum permitted scale is 1000.
736an integer number of images in that direction. No image will be magnified
737beyond 10 times its original size. The maximum permitted scale is 1000.
738Additional operations can be specified after colon B<:op1:op2...>. 769Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are: 770Supported operations are:
740 771
741 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
742 propscale will scale image keeping proportions 773 propscale will scale image keeping proportions
… …
784it 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
785wide and 15 pixels high. 816wide and 15 pixels high.
786 817
787The 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
788the base font, likewise the third, which is unfortunately non-bold, but 819the base font, likewise the third, which is unfortunately non-bold, but
789the 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
790useful supplement. 821useful supplement.
791 822
792The 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
793are 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
794contains other characters, but we are not interested in them. 825contains other characters, but we are not interested in them.
… …
845=item B<urgentOnBell:> I<boolean> 876=item B<urgentOnBell:> I<boolean>
846 877
847B<True>: set the urgency hint for the wm on receipt of a bell character. 878B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default]. 879B<False>: do not set the urgency hint [default].
849 880
881@@RXVT_NAME@@ resets the urgency hint on every focus change.
882
850=item B<visualBell:> I<boolean> 883=item B<visualBell:> I<boolean>
851 884
852B<True>: use visual bell on receipt of a bell character; option B<-vb>. 885B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853B<False>: no visual bell [default]; option B<+vb>. 886B<False>: no visual bell [default]; option B<+vb>.
854 887
… …
978=item B<cursorBlink:> I<boolean> 1011=item B<cursorBlink:> I<boolean>
979 1012
980B<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];
981option B<-bc>. 1014option B<-bc>.
982 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
983=item B<pointerBlank:> I<boolean> 1021=item B<pointerBlank:> I<boolean>
984 1022
985B<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
986of seconds of inactivity. B<False>: the pointer is always visible 1024of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 1025[default].
… …
1000large number (e.g. C<987654321>) to effectively disable the timeout. 1038large number (e.g. C<987654321>) to effectively disable the timeout.
1001 1039
1002=item B<backspacekey:> I<string> 1040=item B<backspacekey:> I<string>
1003 1041
1004The 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>
1005or 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>
1006(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
1007escape sequence. 1045escape sequence.
1008 1046
1009=item B<deletekey:> I<string> 1047=item B<deletekey:> I<string>
1010 1048
… …
1089 1127
1090=item B<secondaryScroll:> I<boolean> 1128=item B<secondaryScroll:> I<boolean>
1091 1129
1092Turn on/off secondary screen scroll (default enabled). If this 1130Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1131option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1132scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1133to/from the secondary screen will instead scroll the screen up.
1096 1134
1097=item B<hold>: I<boolean> 1135=item B<hold>: I<boolean>
1098 1136
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1137Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1138will not immediately destroy its window when the program executed within
1101it exits. Instead, it will wait till it is being killed or closed by the 1139it exits. Instead, it will wait till it is being killed or closed by the
1102user. 1140user.
1141
1142=item B<chdir>: I<path>
1143
1144Sets the working directory for the shell (or the command specified via
1145B<-e>). The I<path> must be an absolute path and it must exist for
1146@@RXVT_NAME@@ to start. If it isn't specified then the current working
1147directory will be used; option B<-cd>.
1103 1148
1104=item B<keysym.>I<sym>: I<string> 1149=item B<keysym.>I<sym>: I<string>
1105 1150
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1151Compile I<frills>: Associate I<string> with keysym I<sym>. The
1107intervening resource name B<keysym.> cannot be omitted. 1152intervening resource name B<keysym.> cannot be omitted.
… …
1122omitting 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
1123keysym 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
1124performed in an exact manner; however, the closest match is assured. 1169performed in an exact manner; however, the closest match is assured.
1125 1170
1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1171I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1127number), see RESOURCES in C<man 7 X> for futher details. 1172number), see RESOURCES in C<man 7 X> for further details.
1128 1173
1129You 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>
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1131should be a character not used by the strings. 1176should be a character not used by the strings.
1132 1177
… …
1146when Control-Meta-c is being pressed": 1191when Control-Meta-c is being pressed":
1147 1192
1148 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
1149 1194
1150If 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>
1151is 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)
1152manpage. For example, the F<selection> extension (activated via 1197manpage. For example, the F<selection> extension (activated via
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1199
1155 URxvt.keysym.M-C-c: perl:selection:rot13 1200 URxvt.keysym.M-C-c: perl:selection:rot13
1156 1201
… …
1214all instances, while B<perl-ext> is used for specific instances. 1259all instances, while B<perl-ext> is used for specific instances.
1215 1260
1216=item B<perl-eval>: I<string> 1261=item B<perl-eval>: I<string>
1217 1262
1218Perl code to be evaluated when all extensions have been registered. See 1263Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1264the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1265
1222=item B<perl-lib>: I<path> 1266=item B<perl-lib>: I<path>
1223 1267
1224Colon-separated list of additional directories that hold extension 1268Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1269scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in 1270@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1271F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1272
1230See the @@RXVT_NAME@@perl(3) manpage. 1273See the @@RXVT_NAME@@perl(3) manpage.
1231 1274
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1275=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1276
… …
1255 1298
1256=item B<override-redirect>: I<boolean> 1299=item B<override-redirect>: I<boolean>
1257 1300
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1301Compile I<frills>: Sets override-redirect for the terminal window, making
1259it 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).
1260 1307
1261=item B<iso14755_52:> I<boolean> 1308=item B<iso14755_52:> I<boolean>
1262 1309
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1310Turn on/off ISO 14755 5.2 mode (default enabled).
1264 1311
… …
1407B<@@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
1408it 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
1409allow 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
1410on 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.
1411 1458
1412=head1 COLORS AND GRAPHICS 1459=head1 COLOURS AND GRAPHICS
1413 1460
1414In addition to the default foreground and background colours, 1461In addition to the default foreground and background colours,
1415B<@@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
1416high-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
1417colours 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.
1418 1468
1419=begin table 1469=begin table
1420 1470
1421 B<color0> (black) = Black 1471 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1472 B<color1> (red) = Red3
… …
1442It is also possible to specify the colour values of B<foreground>, 1492It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1493B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a 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
1445color0-color15. 1495color0-color15.
1446 1496
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1497The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1498values for the 256 colour mode in parentheses).
1449consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
145016>), followed by 8 additional shades of gray (with indices 80 to 87).
1451 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
1452Together, all those colours implement the 88 colour xterm colours. Only 1509Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1510colours. Only the first 16 can be changed using resources currently, the
1454be 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...).
1455 1515
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1516Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1517always swapping the foreground/background colours. This is in contrast to
1458I<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
1459been specified. For example, 1519been specified. For example,
1460 1520
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1521 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1522
1465would 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
1466on White. 1524White.
1467
1468=back
1469 1525
1470=head2 ALPHA CHANNEL SUPPORT 1526=head2 ALPHA CHANNEL SUPPORT
1471 1527
1472If 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
1473their 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:
1474 1530
1475You can prefix any color with an opaquenes percentage enclosed in 1531You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1532brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(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
1478transparent 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
1479half-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
1480is the recommended format to specify transparency values, and works with 1536is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1537all ways to specify a colour.
1482 1538
… …
1590 1646
1591=over 4 1647=over 4
1592 1648
1593=item B</usr/lib/X11/rgb.txt> 1649=item B</usr/lib/X11/rgb.txt>
1594 1650
1595Color names. 1651Colour names.
1596 1652
1597=back 1653=back
1598 1654
1599=head1 SEE ALSO 1655=head1 SEE ALSO
1600 1656

Diff Legend

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