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.165 by root, Thu Oct 2 17:06:50 2008 UTC vs.
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC

… …
124 124
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 126
127=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
128 128
129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as 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
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 133
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
… …
145Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
147 144
148=item B<-tint> I<colour> 145=item B<-tint> I<colour>
149 146
150Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
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.
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:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 149
162=item B<-sh> I<number> 150=item B<-sh> I<number>
163 151
164Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
166resource I<shading>.
167 154
168=item B<-blt> I<string> 155=item B<-blt> I<string>
169 156
170Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 164
178=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
179 166
180Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
185resource I<blurRadius>. 172resource I<blurRadius>.
186 173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
179
187=item B<-bg> I<colour> 180=item B<-bg> I<colour>
188 181
189Window background colour; resource B<background>. 182Window background colour; resource B<background>.
190 183
191=item B<-fg> I<colour> 184=item B<-fg> I<colour>
192 185
193Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
194 187
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196 189
197Compile I<afterimage>: Specify image file for the background and also 190Compile 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 191optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
201 194
202=item B<-cr> I<colour> 195=item B<-cr> I<colour>
… …
315 308
316=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
317 310
318Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
319 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
320=item B<-iconic> 317=item B<-iconic>
321 318
322Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 320Alternative form is B<-ic>.
324 321
… …
360=item B<-lsp> I<number> 357=item B<-lsp> I<number>
361 358
362Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
363the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
364B<lineSpace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
365 369
366=item B<-tn> I<termname> 370=item B<-tn> I<termname>
367 371
368This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
369B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
… …
608Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
609corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
610high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
611colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6123=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
613names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
614 618
615Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
616changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
617 621
618Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
629=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
630 634
631Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
632foreground colour is the default. 636foreground colour is the default.
633 637
634=item B<colorRV:> I<colour>
635
636Use the specified colour as the background for reverse video characters
637when OPTION_HC is disabled (--disable-frills).
638
639=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
640 639
641If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
642itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
643 652
644=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
645 654
646Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
647foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
… …
654 663
655=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
656 665
657B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
658option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
659B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
660 669
661=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
662 671
663B<True>: specify that jump scrolling should be used. When receiving lots 672B<True>: specify that jump scrolling should be used. When receiving lots
664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
680if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
682 691
683=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
684 693
685Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
686 695
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions. 697future versions.
689 698
690I<Please address all transparency related issues to Sasha Vasko at
691sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
692
693=item B<fading:> I<number> 699=item B<fading:> I<number>
694 700
695Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
696 702
697=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
… …
699Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
700colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
701 707
702=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
703 709
704Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
705B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
706 715
707=item B<shading:> I<number> 716=item B<shading:> I<number>
708 717
709Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
711 720
712=item B<blendType:> I<string> 721=item B<blendType:> I<string>
713 722
714Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
715 724
716=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
717 726
718Apply Gaussian Blurr with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
719background image; option B<-blr>. 728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
720 733
721=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
722 735
723Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
724 737
… …
734 747
735=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
736 749
737Use the specified image file for the background and also 750Use the specified image file for the background and also
738optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
739(default C<0x0+50+50>) in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
740horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
741centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 displays the image with tiling.
742of 1 displays the image without any scaling. A scale of 2 to 9 specifies 755The maximum permitted scale is 1000.
743an integer number of images in that direction. No image will be magnified
744beyond 10 times its original size. The maximum permitted scale is 1000.
745Additional operations can be specified after colon B<:op1:op2...>. 756Additional operations can be specified after colon B<:op1:op2...>.
746Supported operations are: 757Supported operations are:
747 758
748 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 tile force background image to be tiled and not scaled. Equivalent to 0x0
749 propscale will scale image keeping proportions 760 propscale will scale image keeping proportions
… …
753 scale will scale image to match window size 764 scale will scale image to match window size
754 root will tile image as if it was a root window background, auto-adjusting 765 root will tile image as if it was a root window background, auto-adjusting
755 whenever terminal window moves 766 whenever terminal window moves
756 767
757If used in conjunction with B<-tr> option, the specified pixmap will be 768If used in conjunction with B<-tr> option, the specified pixmap will be
758blended over transparency image using either alpha-blending, or any 769blended over the transparent background using alpha-blending. If I<afterimage>
759other blending type, specified with B<-blt "type"> option. 770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
760 772
761=item B<path:> I<path> 773=item B<path:> I<path>
762 774
763Specify the colon-delimited search path for finding background image files. 775Specify the colon-delimited search path for finding background image files.
764 776
… …
791it is named first) and thus defines the character cell grid to be 9 pixels 803it is named first) and thus defines the character cell grid to be 9 pixels
792wide and 15 pixels high. 804wide and 15 pixels high.
793 805
794The second font is just used to add additional unicode characters not in 806The second font is just used to add additional unicode characters not in
795the base font, likewise the third, which is unfortunately non-bold, but 807the base font, likewise the third, which is unfortunately non-bold, but
796the bold version of the font does contain less characters, so this is a 808the bold version of the font does contain fewer characters, so this is a
797useful supplement. 809useful supplement.
798 810
799The third font is an Xft font with aliasing turned off, and the characters 811The third font is an Xft font with aliasing turned off, and the characters
800are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 812are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
801contains other characters, but we are not interested in them. 813contains other characters, but we are not interested in them.
… …
852=item B<urgentOnBell:> I<boolean> 864=item B<urgentOnBell:> I<boolean>
853 865
854B<True>: set the urgency hint for the wm on receipt of a bell character. 866B<True>: set the urgency hint for the wm on receipt of a bell character.
855B<False>: do not set the urgency hint [default]. 867B<False>: do not set the urgency hint [default].
856 868
869@@RXVT_NAME@@ resets the urgency hint on every focus change.
870
857=item B<visualBell:> I<boolean> 871=item B<visualBell:> I<boolean>
858 872
859B<True>: use visual bell on receipt of a bell character; option B<-vb>. 873B<True>: use visual bell on receipt of a bell character; option B<-vb>.
860B<False>: no visual bell [default]; option B<+vb>. 874B<False>: no visual bell [default]; option B<+vb>.
861 875
… …
985=item B<cursorBlink:> I<boolean> 999=item B<cursorBlink:> I<boolean>
986 1000
987B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1001B<True>: blink the cursor. B<False>: do not blink the cursor [default];
988option B<-bc>. 1002option B<-bc>.
989 1003
1004=item B<cursorUnderline:> I<boolean>
1005
1006B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1007option B<-uc>.
1008
990=item B<pointerBlank:> I<boolean> 1009=item B<pointerBlank:> I<boolean>
991 1010
992B<True>: blank the pointer when a key is pressed or after a set number 1011B<True>: blank the pointer when a key is pressed or after a set number
993of seconds of inactivity. B<False>: the pointer is always visible 1012of seconds of inactivity. B<False>: the pointer is always visible
994[default]. 1013[default].
… …
1007large number (e.g. C<987654321>) to effectively disable the timeout. 1026large number (e.g. C<987654321>) to effectively disable the timeout.
1008 1027
1009=item B<backspacekey:> I<string> 1028=item B<backspacekey:> I<string>
1010 1029
1011The string to send when the backspace key is pressed. If set to B<DEC> 1030The string to send when the backspace key is pressed. If set to B<DEC>
1012or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1031or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1013(code 8) - which can be reversed with the appropriate DEC private mode 1032(code 8) - which can be reversed with the appropriate DEC private mode
1014escape sequence. 1033escape sequence.
1015 1034
1016=item B<deletekey:> I<string> 1035=item B<deletekey:> I<string>
1017 1036
… …
1136omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1137keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1138performed in an exact manner; however, the closest match is assured. 1157performed in an exact manner; however, the closest match is assured.
1139 1158
1140I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1141number), see RESOURCES in C<man 7 X> for futher details. 1160number), see RESOURCES in C<man 7 X> for further details.
1142 1161
1143You can define a range of keysyms in one shot by providing a I<string> 1162You can define a range of keysyms in one shot by providing a I<string>
1144with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1145should be a character not used by the strings. 1164should be a character not used by the strings.
1146 1165
… …
1160when Control-Meta-c is being pressed": 1179when Control-Meta-c is being pressed":
1161 1180
1162 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1163 1182
1164If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1165is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1184is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1166manpage. For example, the F<selection> extension (activated via 1185manpage. For example, the F<selection> extension (activated via
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1187
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1188 URxvt.keysym.M-C-c: perl:selection:rot13
1170 1189
1171Due the the large number of modifier combinations, a defined key mapping 1190Due the the large number of modifier combinations, a defined key mapping
1172will match if at I<at least> the specified identifiers are being set, and 1191will match if I<at least> the specified identifiers are being set, and
1173no other key mappings with those and more bits are being defined. That 1192no other key mappings with those and more bits are being defined. That
1174means that defining a key map for C<a> will automatically provide 1193means that defining a key map for C<a> will automatically provide
1175definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1176mappings themselves. 1195mappings themselves.
1177 1196
… …
1228all instances, while B<perl-ext> is used for specific instances. 1247all instances, while B<perl-ext> is used for specific instances.
1229 1248
1230=item B<perl-eval>: I<string> 1249=item B<perl-eval>: I<string>
1231 1250
1232Perl code to be evaluated when all extensions have been registered. See 1251Perl code to be evaluated when all extensions have been registered. See
1233the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1252the @@RXVT_NAME@@perl(3) manpage.
1234will be ignored when running setuid/setgid.
1235 1253
1236=item B<perl-lib>: I<path> 1254=item B<perl-lib>: I<path>
1237 1255
1238Colon-separated list of additional directories that hold extension 1256Colon-separated list of additional directories that hold extension
1239scripts. When looking for extensions specified by the C<perl> resource, 1257scripts. When looking for extensions specified by the C<perl> resource,
1240@@RXVT_NAME@@ will first look in these directories and then in 1258@@RXVT_NAME@@ will first look in these directories and then in
1241F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1259F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1242will be ignored when running setuid/setgid.
1243 1260
1244See the @@RXVT_NAME@@perl(3) manpage. 1261See the @@RXVT_NAME@@perl(3) manpage.
1245 1262
1246=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1263=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1247 1264
… …
1269 1286
1270=item B<override-redirect>: I<boolean> 1287=item B<override-redirect>: I<boolean>
1271 1288
1272Compile I<frills>: Sets override-redirect for the terminal window, making 1289Compile I<frills>: Sets override-redirect for the terminal window, making
1273it almost invisible to window managers; option B<-override-redirect>. 1290it almost invisible to window managers; option B<-override-redirect>.
1291
1292=item B<iso14755:> I<boolean>
1293
1294Turn on/off ISO 14755 (default enabled).
1274 1295
1275=item B<iso14755_52:> I<boolean> 1296=item B<iso14755_52:> I<boolean>
1276 1297
1277Turn on/off ISO 14755 5.2 mode (default enabled). 1298Turn on/off ISO 14755 5.2 mode (default enabled).
1278 1299
… …
1421B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1442B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1422it can be seen via the I<who(1)> command, and can accept messages. To 1443it can be seen via the I<who(1)> command, and can accept messages. To
1423allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1444allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1424on some systems or setgid to root or to some other group on others. 1445on some systems or setgid to root or to some other group on others.
1425 1446
1426=head1 COLORS AND GRAPHICS 1447=head1 COLOURS AND GRAPHICS
1427 1448
1428In addition to the default foreground and background colours, 1449In addition to the default foreground and background colours,
1429B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1450B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1430high-intensity bold/blink versions of the same). Here is a list of the 1451high-intensity (potentially bold/blink) versions of the same, and 72 (or
1431colours with their names. 1452240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1453cube plus a 8 (24) colour greyscale ramp.
1454
1455Here is a list of the ANSI colours with their names.
1432 1456
1433=begin table 1457=begin table
1434 1458
1435 B<color0> (black) = Black 1459 B<color0> (black) = Black
1436 B<color1> (red) = Red3 1460 B<color1> (red) = Red3
… …
1456It is also possible to specify the colour values of B<foreground>, 1480It is also possible to specify the colour values of B<foreground>,
1457B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1481B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1458a number 0-15, as a convenient shorthand to reference the colour name of 1482a number 0-15, as a convenient shorthand to reference the colour name of
1459color0-color15. 1483color0-color15.
1460 1484
1461In addition to the colours defined above, @@RXVT_NAME@@ offers an 1485The following text gives values for the standard 88 colour mode (and
1462additional 72 colours. The first 64 of those (with indices 16 to 79) 1486values for the 256 colour mode in parentheses).
1463consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146416>), followed by 8 additional shades of gray (with indices 80 to 87).
1465 1487
1488The RGB cube uses indices 16..79 (16..231) using the following formulas:
1489
1490 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1491 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1492
1493The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1494steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1495the RGB cube.
1496
1466Together, all those colours implement the 88 colour xterm colours. Only 1497Together, all those colours implement the 88 (256) colour xterm
1467the first 16 can be changed using resources currently, the rest can only 1498colours. Only the first 16 can be changed using resources currently, the
1468be changed via command sequences ("escape codes"). 1499rest can only be changed via command sequences ("escape codes").
1500
1501Applications are advised to use terminfo or command sequences to discover
1502number and RGB values of all colours (yes, you can query this...).
1469 1503
1470Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1504Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1471always swapping the foreground/background colours. This is in contrast to 1505always swapping the foreground/background colours. This is in contrast to
1472I<xterm>(1) where the colours are only swapped if they have not otherwise 1506I<xterm>(1) where the colours are only swapped if they have not otherwise
1473been specified. For example, 1507been specified. For example,
1474 1508
1475=over 4
1476
1477=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1509 @@RXVT_NAME@@ -fg Black -bg White -rv
1478 1510
1479would yield White on Black, while on I<xterm>(1) it would yield Black 1511would yield White on Black, while on I<xterm>(1) it would yield Black on
1480on White. 1512White.
1481
1482=back
1483 1513
1484=head2 ALPHA CHANNEL SUPPORT 1514=head2 ALPHA CHANNEL SUPPORT
1485 1515
1486If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1516If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1487their act together, rxvt-unicode will do it's own alpha channel management: 1517their act together, rxvt-unicode will do it's own alpha channel management:
1488 1518
1489You can prefix any color with an opaquenes percentage enclosed in 1519You can prefix any colour with an opaqueness percentage enclosed in
1490brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1491(0-100) that specifies the opacity of the color, where C<0> is completely 1521(0-100) that specifies the opacity of the colour, where C<0> is completely
1492transparent and C<100> is completely opaque. For example, C<[50]red> is a 1522transparent and C<100> is completely opaque. For example, C<[50]red> is a
1493half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1523half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1494is the recommended format to specify transparency values, and works with 1524is the recommended format to specify transparency values, and works with
1495all ways to specify a colour. 1525all ways to specify a colour.
1496 1526
… …
1604 1634
1605=over 4 1635=over 4
1606 1636
1607=item B</usr/lib/X11/rgb.txt> 1637=item B</usr/lib/X11/rgb.txt>
1608 1638
1609Color names. 1639Colour names.
1610 1640
1611=back 1641=back
1612 1642
1613=head1 SEE ALSO 1643=head1 SEE ALSO
1614 1644
… …
1665 1695
1666Project Coordinator (Changes 1.0 -) 1696Project Coordinator (Changes 1.0 -)
1667 1697
1668=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1698=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1669 1699
1670Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1700pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1671 1701
1672=back 1702=back
1673 1703

Diff Legend

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