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.171 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 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
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
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
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 154
178=item B<-blr> I<HxV> 155=item B<-blr> I<HxV>
179 156
180Apply Gaussian Blur with the specified radii to the transparent 157Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 158background. If a single number is specified, the vertical and
182horizontal radii are considered to be the same. Setting one of the 159horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 160radii to 1 and the other to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
185resource I<blurRadius>. 163resource I<blurRadius>.
186 164
187=item B<-icon> I<file> 165=item B<-icon> I<file>
188 166
189Compile I<afterimage>: Use the specified image as application icon. This 167Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 168is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 169application window; resource I<iconFile>.
192 170
193=item B<-bg> I<colour> 171=item B<-bg> I<colour>
194 172
… …
196 174
197=item B<-fg> I<colour> 175=item B<-fg> I<colour>
198 176
199Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
200 178
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 179=item B<-pixmap> I<file[;oplist]>
202 180
203Compile I<afterimage>: Specify image file for the background and also 181Compile I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to 182optionally 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 183add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
207 185
208=item B<-cr> I<colour> 186=item B<-cr> I<colour>
209 187
… …
571You can set and change the resources using X11 tools like B<xrdb>. Many 549You can set and change the resources using X11 tools like B<xrdb>. Many
572distribution do also load settings from the B<~/.Xresources> file when X 550distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 552with later settings overwriting earlier ones:
575 553
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 559 6. resources specified via -xrm on the commandline
582 560
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 562names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
625Use the specified colour for the colour value I<n>, where 0-7 603Use the specified colour for the colour value I<n>, where 0-7
626corresponds to low-intensity (normal) colours and 8-15 corresponds to 604corresponds to low-intensity (normal) colours and 8-15 corresponds to
627high-intensity (bold = bright foreground, blink = bright background) 605high-intensity (bold = bright foreground, blink = bright background)
628colours. The canonical names are as follows: 0=black, 1=red, 2=green, 606colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6073=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630names used are listed in the B<COLORS AND GRAPHICS> section. 608names used are listed in the B<COLOURS AND GRAPHICS> section.
631 609
632Colours higher than 15 cannot be set using resources (yet), but can be 610Colours higher than 15 cannot be set using resources (yet), but can be
633changed using an escape command (see @@RXVT_NAME@@(7)). 611changed using an escape command (see @@RXVT_NAME@@(7)).
634 612
635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 613Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
646=item B<colorUL:> I<colour> 624=item B<colorUL:> I<colour>
647 625
648Use the specified colour to display underlined characters when the 626Use the specified colour to display underlined characters when the
649foreground colour is the default. 627foreground colour is the default.
650 628
651=item B<colorRV:> I<colour>
652
653Use the specified colour as the background for reverse video characters
654when OPTION_HC is disabled (--disable-frills).
655
656=item B<underlineColor:> I<colour> 629=item B<underlineColor:> I<colour>
657 630
658If set, use the specified colour as the colour for the underline 631If set, use the specified colour as the colour for the underline
659itself. If unset, use the foreground colour. 632itself. If unset, use the foreground colour.
633
634=item B<highlightColor:> I<colour>
635
636If set, use the specified colour as the background for highlighted
637characters. If unset, use reverse video.
638
639=item B<highlightTextColor:> I<colour>
640
641If set and highlightColor is set, use the specified colour as the
642foreground for highlighted characters.
660 643
661=item B<cursorColor:> I<colour> 644=item B<cursorColor:> I<colour>
662 645
663Use the specified colour for the cursor. The default is to use the 646Use the specified colour for the cursor. The default is to use the
664foreground colour; option B<-cr>. 647foreground colour; option B<-cr>.
… …
671 654
672=item B<reverseVideo:> I<boolean> 655=item B<reverseVideo:> I<boolean>
673 656
674B<True>: simulate reverse video by foreground and background colours; 657B<True>: simulate reverse video by foreground and background colours;
675option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
676B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
677 660
678=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
679 662
680B<True>: specify that jump scrolling should be used. When receiving lots 663B<True>: specify that jump scrolling should be used. When receiving lots
681of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
697if the refresh is too fast for the human eye to read anything (or the 680if the refresh is too fast for the human eye to read anything (or the
698monitor to display anything); option B<+ss>. 681monitor to display anything); option B<+ss>.
699 682
700=item B<transparent:> I<boolean> 683=item B<transparent:> I<boolean>
701 684
702Turn on/off illusion of a transparent window background. 685Turn on/off pseudo-transparency by using the root pixmap as background.
703 686
704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705future versions. 688future versions.
706 689
707I<Please address all transparency related issues to Sasha Vasko at
708sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
709
710=item B<fading:> I<number> 690=item B<fading:> I<number>
711 691
712Fade the text by the given percentage when focus is lost; option B<-fade>. 692Fade the text by the given percentage when focus is lost; option B<-fade>.
713 693
714=item B<fadeColor:> I<colour> 694=item B<fadeColor:> I<colour>
… …
716Fade to this colour, when fading is used (see B<fading:>). The default 696Fade to this colour, when fading is used (see B<fading:>). The default
717colour is black; option B<-fadecolor>. 697colour is black; option B<-fadecolor>.
718 698
719=item B<tintColor:> I<colour> 699=item B<tintColor:> I<colour>
720 700
721Tint the transparent background pixmap with the given colour; option 701Tint the transparent background with the given colour. If the RENDER
722B<-tint>. 702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
723 706
724=item B<shading:> I<number> 707=item B<shading:> I<number>
725 708
726Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
727in addition to tinting it; option B<-sh>. 710A value of 100 means no shading; option B<-sh>.
728 711
729=item B<blendType:> I<string> 712=item B<blendType:> I<string>
730 713
731Specify background blending type; option B<-blt>. 714Specify background blending type; option B<-blt>.
732 715
733=item B<blurRadius:> I<number> 716=item B<blurRadius:> I<number>
734 717
735Apply gaussian blur with the specified radius to the transparent 718Apply gaussian blur with the specified radius to the transparent
736background image; option B<-blr>. 719background; option B<-blr>.
737 720
738=item B<iconFile:> I<file> 721=item B<iconFile:> I<file>
739 722
740Set the application icon pixmap; option B<-icon>. 723Set the application icon pixmap; option B<-icon>.
741 724
… …
751=item B<borderColor:> I<colour> 734=item B<borderColor:> I<colour>
752 735
753The colour of the border around the text area and between the scrollbar 736The colour of the border around the text area and between the scrollbar
754and the text. 737and the text.
755 738
756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 739=item B<backgroundPixmap:> I<file[;oplist]>
757 740
758Use the specified image file for the background and also 741Use the specified image file for the background and also
759optionally specify its scaling with a geometry string B<WxH+X+Y>, 742optionally specify a colon separated list of operations to modify it.
760(default C<0x0+50+50>) in which B<"W" / "H"> specify the
761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
762centre (percent). A scale of 0 displays the image with tiling. A scale
763of 1 displays the image without any scaling. A scale of 2 to 9 specifies
764an integer number of images in that direction. No image will be magnified
765beyond 10 times its original size. The maximum permitted scale is 1000.
766Additional operations can be specified after colon B<:op1:op2...>.
767Supported operations are: 743Supported operations are:
768 744
769 tile force background image to be tiled and not scaled. Equivalent to 0x0 745=over 4
770 propscale will scale image keeping proportions 746
771 auto will scale image to match window size. Equivalent to 100x100 747=item B<WxH+X+Y>
772 hscale will scale image horizontally to the window size 748
773 vscale will scale image vertically to the window size 749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
774 scale will scale image to match window size 750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
775 root will tile image as if it was a root window background, auto-adjusting 751scale of 0 disables scaling. The maximum permitted scale is 1000.
776 whenever terminal window moves 752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
777 800
778If used in conjunction with B<-tr> option, the specified pixmap will be 801If used in conjunction with B<-tr> option, the specified pixmap will be
779blended over transparency image using either alpha-blending, or any 802blended over the transparent background using alpha-blending.
780other blending type, specified with B<-blt "type"> option.
781 803
782=item B<path:> I<path> 804=item B<path:> I<path>
783 805
784Specify the colon-delimited search path for finding background image files. 806Specify the colon-delimited search path for finding background image files.
785 807
… …
812it is named first) and thus defines the character cell grid to be 9 pixels 834it is named first) and thus defines the character cell grid to be 9 pixels
813wide and 15 pixels high. 835wide and 15 pixels high.
814 836
815The second font is just used to add additional unicode characters not in 837The second font is just used to add additional unicode characters not in
816the base font, likewise the third, which is unfortunately non-bold, but 838the base font, likewise the third, which is unfortunately non-bold, but
817the bold version of the font does contain less characters, so this is a 839the bold version of the font does contain fewer characters, so this is a
818useful supplement. 840useful supplement.
819 841
820The third font is an Xft font with aliasing turned off, and the characters 842The third font is an Xft font with aliasing turned off, and the characters
821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 843are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
822contains other characters, but we are not interested in them. 844contains other characters, but we are not interested in them.
… …
912=item B<scrollstyle:> I<mode> 934=item B<scrollstyle:> I<mode>
913 935
914Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 936Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915the author's favourite. 937the author's favourite.
916 938
939=item B<thickness:> I<number>
940
941Set the scrollbar width in pixels.
942
917=item B<scrollBar:> I<boolean> 943=item B<scrollBar:> I<boolean>
918 944
919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 945B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
920disable the scrollbar; option B<+sb>. 946disable the scrollbar; option B<+sb>.
921 947
… …
940B<False>: do not scroll to bottom when tty receives output; option 966B<False>: do not scroll to bottom when tty receives output; option
941B<+si>. 967B<+si>.
942 968
943=item B<scrollWithBuffer:> I<boolean> 969=item B<scrollWithBuffer:> I<boolean>
944 970
945B<True>: scroll with scrollback buffer when tty receives new lines (and 971B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
946B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 972try to show the same lines) and B<scrollTtyOutput> is False; option
947with scrollback buffer when tty receives new lines; option B<+sw>. 973B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
974new lines; option B<+sw>.
948 975
949=item B<scrollTtyKeypress:> I<boolean> 976=item B<scrollTtyKeypress:> I<boolean>
950 977
951B<True>: scroll to bottom when a non-special key is pressed. Special keys 978B<True>: scroll to bottom when a non-special key is pressed. Special keys
952are those which are intercepted by rxvt-unicode for special handling and 979are those which are intercepted by rxvt-unicode for special handling and
… …
1035large number (e.g. C<987654321>) to effectively disable the timeout. 1062large number (e.g. C<987654321>) to effectively disable the timeout.
1036 1063
1037=item B<backspacekey:> I<string> 1064=item B<backspacekey:> I<string>
1038 1065
1039The string to send when the backspace key is pressed. If set to B<DEC> 1066The string to send when the backspace key is pressed. If set to B<DEC>
1040or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1067or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1041(code 8) - which can be reversed with the appropriate DEC private mode 1068(code 8) - which can be reversed with the appropriate DEC private mode
1042escape sequence. 1069escape sequence.
1043 1070
1044=item B<deletekey:> I<string> 1071=item B<deletekey:> I<string>
1045 1072
… …
1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1191omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1165keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1192keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1166performed in an exact manner; however, the closest match is assured. 1193performed in an exact manner; however, the closest match is assured.
1167 1194
1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1195I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1169number), see RESOURCES in C<man 7 X> for futher details. 1196number), see RESOURCES in C<man 7 X> for further details.
1170 1197
1171You can define a range of keysyms in one shot by providing a I<string> 1198You can define a range of keysyms in one shot by
1199loading the C<keysym-list> perl extension and providing a I<string>
1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1173should be a character not used by the strings. 1201should be a character not used by the strings.
1174 1202
1175Its usage can be demonstrated by an example: 1203Its usage can be demonstrated by an example:
1176 1204
1177 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1205 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1178 1206
1179The above line is equivalent to the following three lines: 1207The above line is equivalent to the following three lines:
1180 1208
1181 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1209 URxvt.keysym.Meta-Control-0x61: \033<a>
1182 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1210 URxvt.keysym.Meta-Control-0x62: \033<b>
1183 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1211 URxvt.keysym.Meta-Control-0x63: \033<c>
1184 1212
1185If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1213If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1186is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1214is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1187example the following means "change the current locale to C<zh_CN.GBK> 1215example the following means "change the current locale to C<zh_CN.GBK>
1188when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1189 1217
1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1218 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1191 1219
1192If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1220If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1193is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1221is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1194manpage. For example, the F<selection> extension (activated via 1222manpage. For example, the F<selection> extension (activated via
1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1223C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1196 1224
1197 URxvt.keysym.M-C-c: perl:selection:rot13 1225 URxvt.keysym.M-C-c: perl:selection:rot13
1198 1226
1199Due the the large number of modifier combinations, a defined key mapping 1227Due the the large number of modifier combinations, a defined key mapping
1200will match if at I<at least> the specified identifiers are being set, and 1228will match if I<at least> the specified identifiers are being set, and
1201no other key mappings with those and more bits are being defined. That 1229no other key mappings with those and more bits are being defined. That
1202means that defining a key map for C<a> will automatically provide 1230means that defining a key map for C<a> will automatically provide
1203definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1231definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204mappings themselves. 1232mappings themselves.
1205 1233
… …
1261the @@RXVT_NAME@@perl(3) manpage. 1289the @@RXVT_NAME@@perl(3) manpage.
1262 1290
1263=item B<perl-lib>: I<path> 1291=item B<perl-lib>: I<path>
1264 1292
1265Colon-separated list of additional directories that hold extension 1293Colon-separated list of additional directories that hold extension
1266scripts. When looking for extensions specified by the C<perl> resource, 1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1267@@RXVT_NAME@@ will first look in these directories and then in 1295look in these directories, then in $HOME/.urxvt/ext and lastly in
1268F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1296F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1269 1297
1270See the @@RXVT_NAME@@perl(3) manpage. 1298See the @@RXVT_NAME@@perl(3) manpage.
1271 1299
1272=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1300=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1295 1323
1296=item B<override-redirect>: I<boolean> 1324=item B<override-redirect>: I<boolean>
1297 1325
1298Compile I<frills>: Sets override-redirect for the terminal window, making 1326Compile I<frills>: Sets override-redirect for the terminal window, making
1299it almost invisible to window managers; option B<-override-redirect>. 1327it almost invisible to window managers; option B<-override-redirect>.
1328
1329=item B<iso14755:> I<boolean>
1330
1331Turn on/off ISO 14755 (default enabled).
1300 1332
1301=item B<iso14755_52:> I<boolean> 1333=item B<iso14755_52:> I<boolean>
1302 1334
1303Turn on/off ISO 14755 5.2 mode (default enabled). 1335Turn on/off ISO 14755 5.2 mode (default enabled).
1304 1336
… …
1447B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1479B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1448it can be seen via the I<who(1)> command, and can accept messages. To 1480it can be seen via the I<who(1)> command, and can accept messages. To
1449allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1481allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1450on some systems or setgid to root or to some other group on others. 1482on some systems or setgid to root or to some other group on others.
1451 1483
1452=head1 COLORS AND GRAPHICS 1484=head1 COLOURS AND GRAPHICS
1453 1485
1454In addition to the default foreground and background colours, 1486In addition to the default foreground and background colours,
1455B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1487B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1456high-intensity bold/blink versions of the same). Here is a list of the 1488high-intensity (potentially bold/blink) versions of the same, and 72 (or
1457colours with their names. 1489240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1490cube plus a 8 (24) colour greyscale ramp.
1491
1492Here is a list of the ANSI colours with their names.
1458 1493
1459=begin table 1494=begin table
1460 1495
1461 B<color0> (black) = Black 1496 B<color0> (black) = Black
1462 B<color1> (red) = Red3 1497 B<color1> (red) = Red3
… …
1482It is also possible to specify the colour values of B<foreground>, 1517It is also possible to specify the colour values of B<foreground>,
1483B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1518B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1484a number 0-15, as a convenient shorthand to reference the colour name of 1519a number 0-15, as a convenient shorthand to reference the colour name of
1485color0-color15. 1520color0-color15.
1486 1521
1487In addition to the colours defined above, @@RXVT_NAME@@ offers an 1522The following text gives values for the standard 88 colour mode (and
1488additional 72 colours. The first 64 of those (with indices 16 to 79) 1523values for the 256 colour mode in parentheses).
1489consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149016>), followed by 8 additional shades of gray (with indices 80 to 87).
1491 1524
1525The RGB cube uses indices 16..79 (16..231) using the following formulas:
1526
1527 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1528 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1529
1530The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532the RGB cube.
1533
1492Together, all those colours implement the 88 colour xterm colours. Only 1534Together, all those colours implement the 88 (256) colour xterm
1493the first 16 can be changed using resources currently, the rest can only 1535colours. Only the first 16 can be changed using resources currently, the
1494be changed via command sequences ("escape codes"). 1536rest can only be changed via command sequences ("escape codes").
1537
1538Applications are advised to use terminfo or command sequences to discover
1539number and RGB values of all colours (yes, you can query this...).
1495 1540
1496Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1541Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1497always swapping the foreground/background colours. This is in contrast to 1542always swapping the foreground/background colours. This is in contrast to
1498I<xterm>(1) where the colours are only swapped if they have not otherwise 1543I<xterm>(1) where the colours are only swapped if they have not otherwise
1499been specified. For example, 1544been specified. For example,
1500 1545
1501=over 4
1502
1503=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1546 @@RXVT_NAME@@ -fg Black -bg White -rv
1504 1547
1505would yield White on Black, while on I<xterm>(1) it would yield Black 1548would yield White on Black, while on I<xterm>(1) it would yield Black on
1506on White. 1549White.
1507
1508=back
1509 1550
1510=head2 ALPHA CHANNEL SUPPORT 1551=head2 ALPHA CHANNEL SUPPORT
1511 1552
1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1553If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1513their act together, rxvt-unicode will do it's own alpha channel management: 1554their act together, rxvt-unicode will do its own alpha channel management:
1514 1555
1515You can prefix any color with an opaquenes percentage enclosed in 1556You can prefix any colour with an opaqueness percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1557brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517(0-100) that specifies the opacity of the color, where C<0> is completely 1558(0-100) that specifies the opacity of the colour, where C<0> is completely
1518transparent and C<100> is completely opaque. For example, C<[50]red> is a 1559transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1560half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520is the recommended format to specify transparency values, and works with 1561is the recommended format to specify transparency values, and works with
1521all ways to specify a colour. 1562all ways to specify a colour.
1522 1563
… …
1605=item B<RXVT_SOCKET> 1646=item B<RXVT_SOCKET>
1606 1647
1607The unix domain socket path used by @@RXVT_NAME@@c(1) and 1648The unix domain socket path used by @@RXVT_NAME@@c(1) and
1608@@RXVT_NAME@@d(1). 1649@@RXVT_NAME@@d(1).
1609 1650
1610Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1611 1652
1612=item B<HOME> 1653=item B<HOME>
1613 1654
1614Used to locate the default directory for the unix domain socket for 1655Used to locate the default directory for the unix domain socket for
1615daemon communications and to locate various resource files (such as 1656daemon communications and to locate various resource files (such as
1616C<.Xdefaults>) 1657C<.Xdefaults>)
1617 1658
1618=item B<XAPPLRESDIR> 1659=item B<XAPPLRESDIR>
1619 1660
1620Directory where various X resource files are being located. 1661Directory where application-specific X resource files are located.
1621 1662
1622=item B<XENVIRONMENT> 1663=item B<XENVIRONMENT>
1623 1664
1624If set and accessible, gives the name of a X resource file to be loaded by 1665If set and accessible, gives the name of a X resource file to be loaded by
1625@@RXVT_NAME@@. 1666@@RXVT_NAME@@.
… …
1630 1671
1631=over 4 1672=over 4
1632 1673
1633=item B</usr/lib/X11/rgb.txt> 1674=item B</usr/lib/X11/rgb.txt>
1634 1675
1635Color names. 1676Colour names.
1636 1677
1637=back 1678=back
1638 1679
1639=head1 SEE ALSO 1680=head1 SEE ALSO
1640 1681
… …
1691 1732
1692Project Coordinator (Changes 1.0 -) 1733Project Coordinator (Changes 1.0 -)
1693 1734
1694=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1735=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1695 1736
1696Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1737pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1697 1738
1698=back 1739=back
1699 1740

Diff Legend

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