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.175 by root, Mon Apr 12 17:06:55 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 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 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, the 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 the other to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
185resource I<blurRadius>. 173resource I<blurRadius>.
186 174
187=item B<-icon> I<file> 175=item B<-icon> I<file>
188 176
189Compile I<afterimage>: Use the specified image as application icon. This 177Compile 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 178is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 179application window; resource I<iconFile>.
192 180
193=item B<-bg> I<colour> 181=item B<-bg> I<colour>
194 182
… …
196 184
197=item B<-fg> I<colour> 185=item B<-fg> I<colour>
198 186
199Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
200 188
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 189=item B<-pixmap> I<file[;oplist]>
202 190
203Compile I<afterimage>: Specify image file for the background and also 191Compile 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 192optionally 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 193add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
207 195
208=item B<-cr> I<colour> 196=item B<-cr> I<colour>
209 197
… …
571You can set and change the resources using X11 tools like B<xrdb>. Many 559You 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 560distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 561starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 562with later settings overwriting earlier ones:
575 563
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 564 1. app-defaults file in $XAPPLRESDIR
565 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 566 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 567 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 568 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 569 6. resources specified via -xrm on the commandline
582 570
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 571Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 572names: 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 613Use the specified colour for the colour value I<n>, where 0-7
626corresponds to low-intensity (normal) colours and 8-15 corresponds to 614corresponds to low-intensity (normal) colours and 8-15 corresponds to
627high-intensity (bold = bright foreground, blink = bright background) 615high-intensity (bold = bright foreground, blink = bright background)
628colours. The canonical names are as follows: 0=black, 1=red, 2=green, 616colours. 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 6173=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630names used are listed in the B<COLORS AND GRAPHICS> section. 618names used are listed in the B<COLOURS AND GRAPHICS> section.
631 619
632Colours higher than 15 cannot be set using resources (yet), but can be 620Colours higher than 15 cannot be set using resources (yet), but can be
633changed using an escape command (see @@RXVT_NAME@@(7)). 621changed using an escape command (see @@RXVT_NAME@@(7)).
634 622
635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 623Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
646=item B<colorUL:> I<colour> 634=item B<colorUL:> I<colour>
647 635
648Use the specified colour to display underlined characters when the 636Use the specified colour to display underlined characters when the
649foreground colour is the default. 637foreground colour is the default.
650 638
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> 639=item B<underlineColor:> I<colour>
657 640
658If set, use the specified colour as the colour for the underline 641If set, use the specified colour as the colour for the underline
659itself. If unset, use the foreground colour. 642itself. If unset, use the foreground colour.
643
644=item B<highlightColor:> I<colour>
645
646If set, use the specified colour as the background for highlighted
647characters. If unset, use reverse video.
648
649=item B<highlightTextColor:> I<colour>
650
651If set and highlightColor is set, use the specified colour as the
652foreground for highlighted characters.
660 653
661=item B<cursorColor:> I<colour> 654=item B<cursorColor:> I<colour>
662 655
663Use the specified colour for the cursor. The default is to use the 656Use the specified colour for the cursor. The default is to use the
664foreground colour; option B<-cr>. 657foreground colour; option B<-cr>.
… …
671 664
672=item B<reverseVideo:> I<boolean> 665=item B<reverseVideo:> I<boolean>
673 666
674B<True>: simulate reverse video by foreground and background colours; 667B<True>: simulate reverse video by foreground and background colours;
675option B<-rv>. B<False>: regular screen colours [default]; option 668option B<-rv>. B<False>: regular screen colours [default]; option
676B<+rv>. See note in B<COLORS AND GRAPHICS> section. 669B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
677 670
678=item B<jumpScroll:> I<boolean> 671=item B<jumpScroll:> I<boolean>
679 672
680B<True>: specify that jump scrolling should be used. When receiving lots 673B<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 674of 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 690if the refresh is too fast for the human eye to read anything (or the
698monitor to display anything); option B<+ss>. 691monitor to display anything); option B<+ss>.
699 692
700=item B<transparent:> I<boolean> 693=item B<transparent:> I<boolean>
701 694
702Turn on/off illusion of a transparent window background. 695Turn on/off pseudo-transparency by using the root pixmap as background.
703 696
704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 697B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705future versions. 698future versions.
706 699
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> 700=item B<fading:> I<number>
711 701
712Fade the text by the given percentage when focus is lost; option B<-fade>. 702Fade the text by the given percentage when focus is lost; option B<-fade>.
713 703
714=item B<fadeColor:> I<colour> 704=item B<fadeColor:> I<colour>
… …
716Fade to this colour, when fading is used (see B<fading:>). The default 706Fade to this colour, when fading is used (see B<fading:>). The default
717colour is black; option B<-fadecolor>. 707colour is black; option B<-fadecolor>.
718 708
719=item B<tintColor:> I<colour> 709=item B<tintColor:> I<colour>
720 710
721Tint the transparent background pixmap with the given colour; option 711Tint the transparent background with the given colour. If the RENDER
722B<-tint>. 712extension is not available only black, red, green, yellow, blue,
713magenta, cyan and white tints can be performed server-side. Note that
714a black tint yields a completely black image while a white tint yields
715the image unchanged; option B<-tint>.
723 716
724=item B<shading:> I<number> 717=item B<shading:> I<number>
725 718
726Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 719Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
727in addition to tinting it; option B<-sh>. 720A value of 100 means no shading; option B<-sh>.
728 721
729=item B<blendType:> I<string> 722=item B<blendType:> I<string>
730 723
731Specify background blending type; option B<-blt>. 724Specify background blending type; option B<-blt>.
732 725
733=item B<blurRadius:> I<number> 726=item B<blurRadius:> I<number>
734 727
735Apply gaussian blur with the specified radius to the transparent 728Apply gaussian blur with the specified radius to the transparent
736background image; option B<-blr>. 729background; option B<-blr>.
737 730
738=item B<iconFile:> I<file> 731=item B<iconFile:> I<file>
739 732
740Set the application icon pixmap; option B<-icon>. 733Set the application icon pixmap; option B<-icon>.
741 734
… …
751=item B<borderColor:> I<colour> 744=item B<borderColor:> I<colour>
752 745
753The colour of the border around the text area and between the scrollbar 746The colour of the border around the text area and between the scrollbar
754and the text. 747and the text.
755 748
756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 749=item B<backgroundPixmap:> I<file[;oplist]>
757 750
758Use the specified image file for the background and also 751Use the specified image file for the background and also
759optionally specify its scaling with a geometry string B<WxH+X+Y>, 752optionally 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: 753Supported operations are:
768 754
769 tile force background image to be tiled and not scaled. Equivalent to 0x0 755=over 4
770 propscale will scale image keeping proportions 756
771 auto will scale image to match window size. Equivalent to 100x100 757=item B<WxH+X+Y>
772 hscale will scale image horizontally to the window size 758
773 vscale will scale image vertically to the window size 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
774 scale will scale image to match window size 760scale (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 761scale of 0 disables scaling. The maximum permitted scale is 1000.
776 whenever terminal window moves 762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
777 810
778If used in conjunction with B<-tr> option, the specified pixmap will be 811If used in conjunction with B<-tr> option, the specified pixmap will be
779blended over transparency image using either alpha-blending, or any 812blended over the transparent background using alpha-blending. If I<afterimage>
780other blending type, specified with B<-blt "type"> option. 813support has been compiled in it is possible to choose other blending
814types with B<-blt "type"> option.
781 815
782=item B<path:> I<path> 816=item B<path:> I<path>
783 817
784Specify the colon-delimited search path for finding background image files. 818Specify the colon-delimited search path for finding background image files.
785 819
… …
912=item B<scrollstyle:> I<mode> 946=item B<scrollstyle:> I<mode>
913 947
914Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 948Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915the author's favourite. 949the author's favourite.
916 950
951=item B<thickness:> I<number>
952
953Set the scrollbar width in pixels.
954
917=item B<scrollBar:> I<boolean> 955=item B<scrollBar:> I<boolean>
918 956
919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 957B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
920disable the scrollbar; option B<+sb>. 958disable the scrollbar; option B<+sb>.
921 959
… …
940B<False>: do not scroll to bottom when tty receives output; option 978B<False>: do not scroll to bottom when tty receives output; option
941B<+si>. 979B<+si>.
942 980
943=item B<scrollWithBuffer:> I<boolean> 981=item B<scrollWithBuffer:> I<boolean>
944 982
945B<True>: scroll with scrollback buffer when tty receives new lines (and 983B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
946B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 984try to show the same lines) and B<scrollTtyOutput> is False; option
947with scrollback buffer when tty receives new lines; option B<+sw>. 985B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
986new lines; option B<+sw>.
948 987
949=item B<scrollTtyKeypress:> I<boolean> 988=item B<scrollTtyKeypress:> I<boolean>
950 989
951B<True>: scroll to bottom when a non-special key is pressed. Special keys 990B<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 991are those which are intercepted by rxvt-unicode for special handling and
… …
1035large number (e.g. C<987654321>) to effectively disable the timeout. 1074large number (e.g. C<987654321>) to effectively disable the timeout.
1036 1075
1037=item B<backspacekey:> I<string> 1076=item B<backspacekey:> I<string>
1038 1077
1039The string to send when the backspace key is pressed. If set to B<DEC> 1078The 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> 1079or 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 1080(code 8) - which can be reversed with the appropriate DEC private mode
1042escape sequence. 1081escape sequence.
1043 1082
1044=item B<deletekey:> I<string> 1083=item B<deletekey:> I<string>
1045 1084
… …
1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1203omitting 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 1204keysym 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. 1205performed in an exact manner; however, the closest match is assured.
1167 1206
1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1169number), see RESOURCES in C<man 7 X> for futher details. 1208number), see RESOURCES in C<man 7 X> for further details.
1170 1209
1171You can define a range of keysyms in one shot by providing a I<string> 1210You can define a range of keysyms in one shot by
1211loading the C<keysym-list> perl extension and providing a I<string>
1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1173should be a character not used by the strings. 1213should be a character not used by the strings.
1174 1214
1175Its usage can be demonstrated by an example: 1215Its usage can be demonstrated by an example:
1176 1216
1177 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1217 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1178 1218
1179The above line is equivalent to the following three lines: 1219The above line is equivalent to the following three lines:
1180 1220
1181 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1221 URxvt.keysym.Meta-Control-0x61: \033<a>
1182 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1222 URxvt.keysym.Meta-Control-0x62: \033<b>
1183 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1223 URxvt.keysym.Meta-Control-0x63: \033<c>
1184 1224
1185If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1186is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1187example the following means "change the current locale to C<zh_CN.GBK> 1227example the following means "change the current locale to C<zh_CN.GBK>
1188when Control-Meta-c is being pressed": 1228when Control-Meta-c is being pressed":
… …
1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1235C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1196 1236
1197 URxvt.keysym.M-C-c: perl:selection:rot13 1237 URxvt.keysym.M-C-c: perl:selection:rot13
1198 1238
1199Due the the large number of modifier combinations, a defined key mapping 1239Due 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 1240will 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 1241no other key mappings with those and more bits are being defined. That
1202means that defining a key map for C<a> will automatically provide 1242means 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 1243definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204mappings themselves. 1244mappings themselves.
1205 1245
… …
1261the @@RXVT_NAME@@perl(3) manpage. 1301the @@RXVT_NAME@@perl(3) manpage.
1262 1302
1263=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1264 1304
1265Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1266scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1267@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1268F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1269 1309
1270See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1271 1311
1272=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1451B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1491B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1452it can be seen via the I<who(1)> command, and can accept messages. To 1492it can be seen via the I<who(1)> command, and can accept messages. To
1453allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1493allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1454on some systems or setgid to root or to some other group on others. 1494on some systems or setgid to root or to some other group on others.
1455 1495
1456=head1 COLORS AND GRAPHICS 1496=head1 COLOURS AND GRAPHICS
1457 1497
1458In addition to the default foreground and background colours, 1498In addition to the default foreground and background colours,
1459B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1499B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1460high-intensity bold/blink versions of the same). Here is a list of the 1500high-intensity (potentially bold/blink) versions of the same, and 72 (or
1461colours with their names. 1501240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1502cube plus a 8 (24) colour greyscale ramp.
1503
1504Here is a list of the ANSI colours with their names.
1462 1505
1463=begin table 1506=begin table
1464 1507
1465 B<color0> (black) = Black 1508 B<color0> (black) = Black
1466 B<color1> (red) = Red3 1509 B<color1> (red) = Red3
… …
1486It is also possible to specify the colour values of B<foreground>, 1529It is also possible to specify the colour values of B<foreground>,
1487B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1530B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1488a number 0-15, as a convenient shorthand to reference the colour name of 1531a number 0-15, as a convenient shorthand to reference the colour name of
1489color0-color15. 1532color0-color15.
1490 1533
1491In addition to the colours defined above, @@RXVT_NAME@@ offers an 1534The following text gives values for the standard 88 colour mode (and
1492additional 72 colours. The first 64 of those (with indices 16 to 79) 1535values for the 256 colour mode in parentheses).
1493consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149416>), followed by 8 additional shades of gray (with indices 80 to 87).
1495 1536
1537The RGB cube uses indices 16..79 (16..231) using the following formulas:
1538
1539 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1540 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1541
1542The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1543steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1544the RGB cube.
1545
1496Together, all those colours implement the 88 colour xterm colours. Only 1546Together, all those colours implement the 88 (256) colour xterm
1497the first 16 can be changed using resources currently, the rest can only 1547colours. Only the first 16 can be changed using resources currently, the
1498be changed via command sequences ("escape codes"). 1548rest can only be changed via command sequences ("escape codes").
1549
1550Applications are advised to use terminfo or command sequences to discover
1551number and RGB values of all colours (yes, you can query this...).
1499 1552
1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1553Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1501always swapping the foreground/background colours. This is in contrast to 1554always swapping the foreground/background colours. This is in contrast to
1502I<xterm>(1) where the colours are only swapped if they have not otherwise 1555I<xterm>(1) where the colours are only swapped if they have not otherwise
1503been specified. For example, 1556been specified. For example,
… …
1508White. 1561White.
1509 1562
1510=head2 ALPHA CHANNEL SUPPORT 1563=head2 ALPHA CHANNEL SUPPORT
1511 1564
1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1565If 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: 1566their act together, rxvt-unicode will do its own alpha channel management:
1514 1567
1515You can prefix any color with an opaquenes percentage enclosed in 1568You can prefix any colour with an opaqueness percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1569brackets, 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 1570(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 1571transparent 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 1572half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520is the recommended format to specify transparency values, and works with 1573is the recommended format to specify transparency values, and works with
1521all ways to specify a colour. 1574all ways to specify a colour.
1522 1575
… …
1605=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1606 1659
1607The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1608@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1609 1662
1610Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1611 1664
1612=item B<HOME> 1665=item B<HOME>
1613 1666
1614Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1615daemon communications and to locate various resource files (such as 1668daemon communications and to locate various resource files (such as
1616C<.Xdefaults>) 1669C<.Xdefaults>)
1617 1670
1618=item B<XAPPLRESDIR> 1671=item B<XAPPLRESDIR>
1619 1672
1620Directory where various X resource files are being located. 1673Directory where application-specific X resource files are located.
1621 1674
1622=item B<XENVIRONMENT> 1675=item B<XENVIRONMENT>
1623 1676
1624If set and accessible, gives the name of a X resource file to be loaded by 1677If set and accessible, gives the name of a X resource file to be loaded by
1625@@RXVT_NAME@@. 1678@@RXVT_NAME@@.
… …
1630 1683
1631=over 4 1684=over 4
1632 1685
1633=item B</usr/lib/X11/rgb.txt> 1686=item B</usr/lib/X11/rgb.txt>
1634 1687
1635Color names. 1688Colour names.
1636 1689
1637=back 1690=back
1638 1691
1639=head1 SEE ALSO 1692=head1 SEE ALSO
1640 1693
… …
1691 1744
1692Project Coordinator (Changes 1.0 -) 1745Project Coordinator (Changes 1.0 -)
1693 1746
1694=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1695 1748
1696Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1697 1750
1698=back 1751=back
1699 1752

Diff Legend

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