ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.204 by sf-exg, Sun Aug 14 22:01:25 2011 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
187=item B<-icon> I<file> 174=item B<-icon> I<file>
188 175
189Compile I<afterimage>: Use the specified image as application icon. This 176Compile 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 177is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 178application window; resource I<iconFile>.
192 179
193=item B<-bg> I<colour> 180=item B<-bg> I<colour>
194 181
… …
196 183
197=item B<-fg> I<colour> 184=item B<-fg> I<colour>
198 185
199Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
200 187
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
202 189
203Compile I<afterimage>: Specify image file for the background and also 190Compile 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 191optionally specify a list of operations to modify it. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
207 194
208=item B<-cr> I<colour> 195=item B<-cr> I<colour>
209 196
… …
320on a tab character is displayed as a wide cursor; resource B<pastableTabs>. 307on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
321 308
322=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
323 310
324Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
325 316
326=item B<-iconic> 317=item B<-iconic>
327 318
328Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 320Alternative form is B<-ic>.
… …
567You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
568distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
569starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
571 562
572 1. system-wide app-defaults file, either locale-dependent OR global
573 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
574 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
575 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
576 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
578 569
579Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
621Use 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
622corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
623high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
624colours. 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,
6253=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
626names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
627 618
628Colours 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
629changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
630 621
631Colours 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
… …
642=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
643 634
644Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
645foreground colour is the default. 636foreground colour is the default.
646 637
647=item B<colorRV:> I<colour>
648
649Use the specified colour as the background for reverse video characters
650when OPTION_HC is disabled (--disable-frills).
651
652=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
653 639
654If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
655itself. 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.
656 652
657=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
658 654
659Use 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
660foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
… …
667 663
668=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
669 665
670B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
671option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
672B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673 669
674=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
675 671
676B<True>: specify that jump scrolling should be used. When receiving lots 672B<True>: specify that jump scrolling should be used. When receiving lots
677of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
693if 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
694monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
695 691
696=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
697 693
698Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
699 695
700B<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
701future versions. 697future versions.
702 698
703I<Please address all transparency related issues to Sasha Vasko at
704sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706=item B<fading:> I<number> 699=item B<fading:> I<number>
707 700
708Fade 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>.
709 702
710=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
… …
712Fade 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
713colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
714 707
715=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
716 709
717Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
718B<-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>.
719 715
720=item B<shading:> I<number> 716=item B<shading:> I<number>
721 717
722Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
723in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
724 720
725=item B<blendType:> I<string> 721=item B<blendType:> I<string>
726 722
727Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
728 724
729=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
730 726
731Apply gaussian blur with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
732background image; option B<-blr>. 728background; option B<-blr>.
733 729
734=item B<iconFile:> I<file> 730=item B<iconFile:> I<file>
735 731
736Set the application icon pixmap; option B<-icon>. 732Set the application icon pixmap; option B<-icon>.
737 733
… …
747=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
748 744
749The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
750and the text. 746and the text.
751 747
752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
753 749
754Use the specified image file for the background and also 750Use the specified image file for the background and also
755optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify a colon separated list of operations to modify it.
756(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758centre (percent). A scale of 0 displays the image with tiling. A scale
759of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760an integer number of images in that direction. No image will be magnified
761beyond 10 times its original size. The maximum permitted scale is 1000.
762Additional operations can be specified after colon B<:op1:op2...>.
763Supported operations are: 752Supported operations are:
764 753
765 tile force background image to be tiled and not scaled. Equivalent to 0x0 754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the
766 propscale will scale image keeping proportions 755 horizontal/vertical scale (percent), and B<"X" / "Y">
767 auto will scale image to match window size. Equivalent to 100x100 756 locate the image centre (percent). A scale of 0 disables
768 hscale will scale image horizontally to the window size 757 scaling. The maximum permitted scale is 1000.
769 vscale will scale image vertically to the window size 758 op=tile enables tiling
770 scale will scale image to match window size 759 op=pscale enables proportional scaling
771 root will tile image as if it was a root window background, auto-adjusting 760 op=root use the position of the terminal window relative to the root
772 whenever terminal window moves 761 window as the image offset, simulating a root window background
762
763The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve
765the most common setups:
766
767 style=tiled the image is tiled with no scaling
768 style=aspect-stretched the image is scaled to fill the whole window maintaining
769 the aspect ratio and centered
770 style=stretched the image is scaled to fill the whole window
771 style=centered the image is centered with no scaling
772 style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
773
774If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings.
776Indeed, the templates can be specified in terms of low level settings
777as follows:
778
779 style=tiled 0x0+0+0:op=tile
780 style=aspect-stretched 100x100+50+50:op=pscale
781 style=stretched 100x100
782 style=centered 0x0+50+50
783 style=root-tiled 0x0:op=tile:op=root
773 784
774If used in conjunction with B<-tr> option, the specified pixmap will be 785If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any 786blended over the transparent background using alpha-blending. If I<afterimage>
776other blending type, specified with B<-blt "type"> option. 787support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option.
777 789
778=item B<path:> I<path> 790=item B<path:> I<path>
779 791
780Specify the colon-delimited search path for finding background image files. 792Specify the colon-delimited search path for finding background image files.
781 793
… …
808it is named first) and thus defines the character cell grid to be 9 pixels 820it is named first) and thus defines the character cell grid to be 9 pixels
809wide and 15 pixels high. 821wide and 15 pixels high.
810 822
811The second font is just used to add additional unicode characters not in 823The second font is just used to add additional unicode characters not in
812the base font, likewise the third, which is unfortunately non-bold, but 824the base font, likewise the third, which is unfortunately non-bold, but
813the bold version of the font does contain less characters, so this is a 825the bold version of the font does contain fewer characters, so this is a
814useful supplement. 826useful supplement.
815 827
816The third font is an Xft font with aliasing turned off, and the characters 828The third font is an Xft font with aliasing turned off, and the characters
817are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 829are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818contains other characters, but we are not interested in them. 830contains other characters, but we are not interested in them.
… …
908=item B<scrollstyle:> I<mode> 920=item B<scrollstyle:> I<mode>
909 921
910Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 922Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911the author's favourite. 923the author's favourite.
912 924
925=item B<thickness:> I<number>
926
927Set the scrollbar width in pixels.
928
913=item B<scrollBar:> I<boolean> 929=item B<scrollBar:> I<boolean>
914 930
915B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 931B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916disable the scrollbar; option B<+sb>. 932disable the scrollbar; option B<+sb>.
917 933
… …
936B<False>: do not scroll to bottom when tty receives output; option 952B<False>: do not scroll to bottom when tty receives output; option
937B<+si>. 953B<+si>.
938 954
939=item B<scrollWithBuffer:> I<boolean> 955=item B<scrollWithBuffer:> I<boolean>
940 956
941B<True>: scroll with scrollback buffer when tty receives new lines (and 957B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 958try to show the same lines) and B<scrollTtyOutput> is False; option
943with scrollback buffer when tty receives new lines; option B<+sw>. 959B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
960new lines; option B<+sw>.
944 961
945=item B<scrollTtyKeypress:> I<boolean> 962=item B<scrollTtyKeypress:> I<boolean>
946 963
947B<True>: scroll to bottom when a non-special key is pressed. Special keys 964B<True>: scroll to bottom when a non-special key is pressed. Special keys
948are those which are intercepted by rxvt-unicode for special handling and 965are those which are intercepted by rxvt-unicode for special handling and
… …
1004=item B<cursorBlink:> I<boolean> 1021=item B<cursorBlink:> I<boolean>
1005 1022
1006B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1023B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007option B<-bc>. 1024option B<-bc>.
1008 1025
1026=item B<cursorUnderline:> I<boolean>
1027
1028B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1029option B<-uc>.
1030
1009=item B<pointerBlank:> I<boolean> 1031=item B<pointerBlank:> I<boolean>
1010 1032
1011B<True>: blank the pointer when a key is pressed or after a set number 1033B<True>: blank the pointer when a key is pressed or after a set number
1012of seconds of inactivity. B<False>: the pointer is always visible 1034of seconds of inactivity. B<False>: the pointer is always visible
1013[default]. 1035[default].
… …
1026large number (e.g. C<987654321>) to effectively disable the timeout. 1048large number (e.g. C<987654321>) to effectively disable the timeout.
1027 1049
1028=item B<backspacekey:> I<string> 1050=item B<backspacekey:> I<string>
1029 1051
1030The string to send when the backspace key is pressed. If set to B<DEC> 1052The string to send when the backspace key is pressed. If set to B<DEC>
1031or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1053or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1032(code 8) - which can be reversed with the appropriate DEC private mode 1054(code 8) - which can be reversed with the appropriate DEC private mode
1033escape sequence. 1055escape sequence.
1034 1056
1035=item B<deletekey:> I<string> 1057=item B<deletekey:> I<string>
1036 1058
… …
1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1177omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1178keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1157performed in an exact manner; however, the closest match is assured. 1179performed in an exact manner; however, the closest match is assured.
1158 1180
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for futher details. 1182number), see RESOURCES in C<man 7 X> for further details.
1161 1183
1162You can define a range of keysyms in one shot by providing a I<string> 1184You can define a range of keysyms in one shot by providing a I<string>
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1186should be a character not used by the strings.
1165 1187
1166Its usage can be demonstrated by an example: 1188Its usage can be demonstrated by an example:
1167 1189
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1191
1170The above line is equivalent to the following three lines: 1192The above line is equivalent to the following three lines:
1171 1193
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1175 1197
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1198If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178example the following means "change the current locale to C<zh_CN.GBK> 1200example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":
1180 1202
1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1203 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182 1204
1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1205If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1184is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1206is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1185manpage. For example, the F<selection> extension (activated via 1207manpage. For example, the F<selection> extension (activated via
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1208C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1209
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1210 URxvt.keysym.M-C-c: perl:selection:rot13
1189 1211
1190Due the the large number of modifier combinations, a defined key mapping 1212Due the the large number of modifier combinations, a defined key mapping
1191will match if at I<at least> the specified identifiers are being set, and 1213will match if I<at least> the specified identifiers are being set, and
1192no other key mappings with those and more bits are being defined. That 1214no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide 1215means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1216definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves. 1217mappings themselves.
1196 1218
… …
1286 1308
1287=item B<override-redirect>: I<boolean> 1309=item B<override-redirect>: I<boolean>
1288 1310
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1311Compile I<frills>: Sets override-redirect for the terminal window, making
1290it almost invisible to window managers; option B<-override-redirect>. 1312it almost invisible to window managers; option B<-override-redirect>.
1313
1314=item B<iso14755:> I<boolean>
1315
1316Turn on/off ISO 14755 (default enabled).
1291 1317
1292=item B<iso14755_52:> I<boolean> 1318=item B<iso14755_52:> I<boolean>
1293 1319
1294Turn on/off ISO 14755 5.2 mode (default enabled). 1320Turn on/off ISO 14755 5.2 mode (default enabled).
1295 1321
… …
1438B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1464B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439it can be seen via the I<who(1)> command, and can accept messages. To 1465it can be seen via the I<who(1)> command, and can accept messages. To
1440allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1466allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441on some systems or setgid to root or to some other group on others. 1467on some systems or setgid to root or to some other group on others.
1442 1468
1443=head1 COLORS AND GRAPHICS 1469=head1 COLOURS AND GRAPHICS
1444 1470
1445In addition to the default foreground and background colours, 1471In addition to the default foreground and background colours,
1446B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1472B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447high-intensity bold/blink versions of the same). Here is a list of the 1473high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448colours with their names. 1474240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1475cube plus a 8 (24) colour greyscale ramp.
1476
1477Here is a list of the ANSI colours with their names.
1449 1478
1450=begin table 1479=begin table
1451 1480
1452 B<color0> (black) = Black 1481 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1482 B<color1> (red) = Red3
… …
1473It is also possible to specify the colour values of B<foreground>, 1502It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1503B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a number 0-15, as a convenient shorthand to reference the colour name of 1504a number 0-15, as a convenient shorthand to reference the colour name of
1476color0-color15. 1505color0-color15.
1477 1506
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1507The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1508values for the 256 colour mode in parentheses).
1480consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
148116>), followed by 8 additional shades of gray (with indices 80 to 87).
1482 1509
1510The RGB cube uses indices 16..79 (16..231) using the following formulas:
1511
1512 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1513 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1514
1515The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1516steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1517the RGB cube.
1518
1483Together, all those colours implement the 88 colour xterm colours. Only 1519Together, all those colours implement the 88 (256) colour xterm
1484the first 16 can be changed using resources currently, the rest can only 1520colours. Only the first 16 can be changed using resources currently, the
1485be changed via command sequences ("escape codes"). 1521rest can only be changed via command sequences ("escape codes").
1522
1523Applications are advised to use terminfo or command sequences to discover
1524number and RGB values of all colours (yes, you can query this...).
1486 1525
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1526Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1527always swapping the foreground/background colours. This is in contrast to
1489I<xterm>(1) where the colours are only swapped if they have not otherwise 1528I<xterm>(1) where the colours are only swapped if they have not otherwise
1490been specified. For example, 1529been specified. For example,
1491 1530
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1531 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1532
1496would yield White on Black, while on I<xterm>(1) it would yield Black 1533would yield White on Black, while on I<xterm>(1) it would yield Black on
1497on White. 1534White.
1498
1499=back
1500 1535
1501=head2 ALPHA CHANNEL SUPPORT 1536=head2 ALPHA CHANNEL SUPPORT
1502 1537
1503If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1538If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504their act together, rxvt-unicode will do it's own alpha channel management: 1539their act together, rxvt-unicode will do it's own alpha channel management:
1505 1540
1506You can prefix any color with an opaquenes percentage enclosed in 1541You can prefix any colour with an opaqueness percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508(0-100) that specifies the opacity of the color, where C<0> is completely 1543(0-100) that specifies the opacity of the colour, where C<0> is completely
1509transparent and C<100> is completely opaque. For example, C<[50]red> is a 1544transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1545half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with 1546is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1547all ways to specify a colour.
1513 1548
… …
1596=item B<RXVT_SOCKET> 1631=item B<RXVT_SOCKET>
1597 1632
1598The unix domain socket path used by @@RXVT_NAME@@c(1) and 1633The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599@@RXVT_NAME@@d(1). 1634@@RXVT_NAME@@d(1).
1600 1635
1601Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1602 1637
1603=item B<HOME> 1638=item B<HOME>
1604 1639
1605Used to locate the default directory for the unix domain socket for 1640Used to locate the default directory for the unix domain socket for
1606daemon communications and to locate various resource files (such as 1641daemon communications and to locate various resource files (such as
1607C<.Xdefaults>) 1642C<.Xdefaults>)
1608 1643
1609=item B<XAPPLRESDIR> 1644=item B<XAPPLRESDIR>
1610 1645
1611Directory where various X resource files are being located. 1646Directory where application-specific X resource files are located.
1612 1647
1613=item B<XENVIRONMENT> 1648=item B<XENVIRONMENT>
1614 1649
1615If set and accessible, gives the name of a X resource file to be loaded by 1650If set and accessible, gives the name of a X resource file to be loaded by
1616@@RXVT_NAME@@. 1651@@RXVT_NAME@@.
… …
1621 1656
1622=over 4 1657=over 4
1623 1658
1624=item B</usr/lib/X11/rgb.txt> 1659=item B</usr/lib/X11/rgb.txt>
1625 1660
1626Color names. 1661Colour names.
1627 1662
1628=back 1663=back
1629 1664
1630=head1 SEE ALSO 1665=head1 SEE ALSO
1631 1666
… …
1682 1717
1683Project Coordinator (Changes 1.0 -) 1718Project Coordinator (Changes 1.0 -)
1684 1719
1685=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1720=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1686 1721
1687Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1722pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688 1723
1689=back 1724=back
1690 1725

Diff Legend

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