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.177 by root, Sun May 23 00:48:53 2010 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
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 131
137=item B<-fade> I<number> 132=item B<-fade> I<number>
138 133
139Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
143=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
144 139
145Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
147 142
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
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 colours essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
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> - colour 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
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 147application window; resource I<iconFile>.
192 148
193=item B<-bg> I<colour> 149=item B<-bg> I<colour>
194 150
195Window background colour; resource B<background>. 151Window background colour; resource B<background>.
196 152
197=item B<-fg> I<colour> 153=item B<-fg> I<colour>
198 154
199Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 156
208=item B<-cr> I<colour> 157=item B<-cr> I<colour>
209 158
210The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
211 160
… …
571You can set and change the resources using X11 tools like B<xrdb>. Many 520You 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 521distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
575 524
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
582 531
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
700 649
701B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
702if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
704 653
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715=item B<fading:> I<number> 654=item B<fading:> I<number>
716 655
717Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
718 657
719=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
720 659
721Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
722colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
723 662
724=item B<tintColor:> I<colour>
725
726Tint the transparent background pixmap with the given colour; option
727B<-tint>.
728
729=item B<shading:> I<number>
730
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
744 664
745Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
746 666
747=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
755 675
756=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
757 677
758The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
759and the text. 679and the text.
760
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762
763Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<0x0+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. A scale
768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
769an integer number of images in that direction. No image will be magnified
770beyond 10 times its original size. The maximum permitted scale is 1000.
771Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are:
773
774 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions
776 auto will scale image to match window size. Equivalent to 100x100
777 hscale will scale image horizontally to the window size
778 vscale will scale image vertically to the window size
779 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves
782
783If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any
785other blending type, specified with B<-blt "type"> option.
786
787=item B<path:> I<path>
788
789Specify the colon-delimited search path for finding background image files.
790 680
791=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
792 682
793Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
794that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
917=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
918 808
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite. 810the author's favourite.
921 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
922=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
923 817
924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
925disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
926 820
… …
945B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
946B<+si>. 840B<+si>.
947 841
948=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
949 843
950B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
951B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
952with scrollback buffer when tty receives new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
953 848
954=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
955 850
956B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
957are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
1040large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
1041 936
1042=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
1043 938
1044The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
1045or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1046(code 8) - which can be reversed with the appropriate DEC private mode 941(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 942escape sequence.
1048 943
1049=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1050 945
… …
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1064omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1170keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1065keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1171performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1172 1067
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1069number), see RESOURCES in C<man 7 X> for further details.
1175 1070
1176You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178should be a character not used by the strings. 1074should be a character not used by the strings.
1179 1075
1180Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1181 1077
1182 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1183 1079
1184The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1185 1081
1186 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1187 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1188 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1189 1085
1190If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1086If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1191is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1192example the following means "change the current locale to C<zh_CN.GBK> 1088example the following means "change the current locale to C<zh_CN.GBK>
1193when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
… …
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1097
1202 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1203 1099
1204Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1205will match if at I<at least> the specified identifiers are being set, and 1101will match if I<at least> the specified identifiers are being set, and
1206no other key mappings with those and more bits are being defined. That 1102no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1208definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1104definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves. 1105mappings themselves.
1210 1106
… …
1266the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1267 1163
1268=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1269 1165
1270Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1271scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1272@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1273F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1274 1170
1275See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1276 1172
1277=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1278 1174
… …
1308Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1309 1205
1310=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1311 1207
1312Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1211
1212=item B<-pixmap> I<file[;oplist]>
1213
1214=item B<backgroundPixmap:> I<file[;oplist]>
1215
1216Compile I<pixbuf>: Use the specified image file as the window's
1217background and also optionally specify a colon separated list of
1218operations to modify it. Note that you may need to quote the C<;>
1219character when using the command line option, as C<;> is usually a
1220metacharacter in shells. Supported operations are:
1221
1222=over 4
1223
1224=item B<WxH+X+Y>
1225
1226sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1227scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1228scale of 0 disables scaling.
1229
1230=item B<op=tile>
1231
1232enables tiling
1233
1234=item B<op=keep-aspect>
1235
1236maintain the image aspect ratio when scaling
1237
1238=item B<op=root-align>
1239
1240use the position of the terminal window relative to the root window as
1241the image offset, simulating a root window background
1242
1243=back
1244
1245The default scale and position setting is C<100x100+50+50>.
1246Alternatively, a predefined set of templates can be used to achieve
1247the most common setups:
1248
1249=over 4
1250
1251=item B<style=tiled>
1252
1253the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1254
1255=item B<style=aspect-stretched>
1256
1257the image is scaled to fill the whole window maintaining the aspect
1258ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1259
1260=item B<style=stretched>
1261
1262the image is scaled to fill the whole window. Equivalent to 100x100
1263
1264=item B<style=centered>
1265
1266the image is centered with no scaling. Equivalent to 0x0+50+50
1267
1268=item B<style=root-tiled>
1269
1270the image is tiled with no scaling and using 'root' positioning.
1271Equivalent to 0x0:op=tile:op=root-align
1272
1273=back
1274
1275If multiple templates are specified the last one wins. Note that a
1276template overrides all the scale, position and operations settings.
1277
1278If used in conjunction with pseudo-transparency, the specified pixmap
1279will be blended over the transparent background using alpha-blending.
1280
1281=item B<-tr>|B<+tr>
1282
1283=item B<transparent:> I<boolean>
1284
1285Turn on/off pseudo-transparency by using the root pixmap as background.
1286
1287B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1288will be removed in future versions.
1289
1290=item B<-tint> I<colour>
1291
1292=item B<tintColor:> I<colour>
1293
1294Tint the transparent background with the given colour. Note that a
1295black tint yields a completely black image while a white tint yields
1296the image unchanged.
1297
1298=item B<-sh> I<number>
1299
1300=item B<shading:> I<number>
1301
1302Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1303A value of 100 means no shading.
1304
1305=item B<-blr> I<HxV>
1306
1307=item B<blurRadius:> I<HxV>
1308
1309Apply gaussian blur with the specified radius to the transparent
1310background. If a single number is specified, the vertical and
1311horizontal radii are considered to be the same. Setting one of the
1312radii to 1 and the other to a large number creates interesting effects
1313on some backgrounds. The maximum radius value is 128. An horizontal or
1314vertical radius of 0 disables blurring.
1315
1316=item B<path:> I<path>
1317
1318Specify the colon-delimited search path for finding background image files.
1313 1319
1314=back 1320=back
1315 1321
1316=head1 THE SCROLLBAR 1322=head1 THE SCROLLBAR
1317 1323
… …
1459on some systems or setgid to root or to some other group on others. 1465on some systems or setgid to root or to some other group on others.
1460 1466
1461=head1 COLOURS AND GRAPHICS 1467=head1 COLOURS AND GRAPHICS
1462 1468
1463In addition to the default foreground and background colours, 1469In addition to the default foreground and background colours,
1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1470B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1465high-intensity bold/blink versions of the same). Here is a list of the 1471high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466colours with their names. 1472240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1473cube plus a 8 (24) colour greyscale ramp.
1474
1475Here is a list of the ANSI colours with their names.
1467 1476
1468=begin table 1477=begin table
1469 1478
1470 B<color0> (black) = Black 1479 B<color0> (black) = Black
1471 B<color1> (red) = Red3 1480 B<color1> (red) = Red3
… …
1491It is also possible to specify the colour values of B<foreground>, 1500It is also possible to specify the colour values of B<foreground>,
1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1501B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493a number 0-15, as a convenient shorthand to reference the colour name of 1502a number 0-15, as a convenient shorthand to reference the colour name of
1494color0-color15. 1503color0-color15.
1495 1504
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an 1505The following text gives values for the standard 88 colour mode (and
1497additional 72 colours. The first 64 of those (with indices 16 to 79) 1506values for the 256 colour mode in parentheses).
1498consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149916>), followed by 8 additional shades of gray (with indices 80 to 87).
1500 1507
1508The RGB cube uses indices 16..79 (16..231) using the following formulas:
1509
1510 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1511 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1512
1513The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1514steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1515the RGB cube.
1516
1501Together, all those colours implement the 88 colour xterm colours. Only 1517Together, all those colours implement the 88 (256) colour xterm
1502the first 16 can be changed using resources currently, the rest can only 1518colours. Only the first 16 can be changed using resources currently, the
1503be changed via command sequences ("escape codes"). 1519rest can only be changed via command sequences ("escape codes").
1520
1521Applications are advised to use terminfo or command sequences to discover
1522number and RGB values of all colours (yes, you can query this...).
1504 1523
1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1524Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506always swapping the foreground/background colours. This is in contrast to 1525always swapping the foreground/background colours. This is in contrast to
1507I<xterm>(1) where the colours are only swapped if they have not otherwise 1526I<xterm>(1) where the colours are only swapped if they have not otherwise
1508been specified. For example, 1527been specified. For example,
… …
1513White. 1532White.
1514 1533
1515=head2 ALPHA CHANNEL SUPPORT 1534=head2 ALPHA CHANNEL SUPPORT
1516 1535
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1536If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1518their act together, rxvt-unicode will do it's own alpha channel management: 1537their act together, rxvt-unicode will do its own alpha channel management:
1519 1538
1520You can prefix any colour with an opaquenes percentage enclosed in 1539You can prefix any colour with an opaqueness percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1540brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1522(0-100) that specifies the opacity of the colour, where C<0> is completely 1541(0-100) that specifies the opacity of the colour, where C<0> is completely
1523transparent and C<100> is completely opaque. For example, C<[50]red> is a 1542transparent and C<100> is completely opaque. For example, C<[50]red> is a
1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1543half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with 1544is the recommended format to specify transparency values, and works with
… …
1605 1624
1606=item B<SHELL> 1625=item B<SHELL>
1607 1626
1608The shell to be used for command execution, defaults to C</bin/sh>. 1627The shell to be used for command execution, defaults to C</bin/sh>.
1609 1628
1610=item B<RXVT_SOCKET> 1629=item B<RXVT_SOCKET> [I<sic>]
1611 1630
1612The unix domain socket path used by @@RXVT_NAME@@c(1) and 1631The unix domain socket path used by @@RXVT_NAME@@c(1) and
1613@@RXVT_NAME@@d(1). 1632@@RXVT_NAME@@d(1).
1614 1633
1615Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1634Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1635
1636=item B<URXVT_PERL_LIB>
1637
1638Additional F<:>-separated library search path for perl extensions. Will be
1639searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1640directory.
1641
1642=item B<URXVT_PERL_VERBOSITY>
1643
1644See L<@@RXVT_NAME@@perl>(3).
1616 1645
1617=item B<HOME> 1646=item B<HOME>
1618 1647
1619Used to locate the default directory for the unix domain socket for 1648Used to locate the default directory for the unix domain socket for
1620daemon communications and to locate various resource files (such as 1649daemon communications and to locate various resource files (such as
1621C<.Xdefaults>) 1650C<.Xdefaults>)
1622 1651
1623=item B<XAPPLRESDIR> 1652=item B<XAPPLRESDIR>
1624 1653
1625Directory where various X resource files are being located. 1654Directory where application-specific X resource files are located.
1626 1655
1627=item B<XENVIRONMENT> 1656=item B<XENVIRONMENT>
1628 1657
1629If set and accessible, gives the name of a X resource file to be loaded by 1658If set and accessible, gives the name of a X resource file to be loaded by
1630@@RXVT_NAME@@. 1659@@RXVT_NAME@@.
… …
1641 1670
1642=back 1671=back
1643 1672
1644=head1 SEE ALSO 1673=head1 SEE ALSO
1645 1674
1675@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1646@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1676@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1647 1677
1648=head1 CURRENT PROJECT COORDINATOR 1678=head1 CURRENT PROJECT COORDINATOR
1649 1679
1650=over 4 1680=over 4
1651 1681
… …
1696 1726
1697Project Coordinator (Changes 1.0 -) 1727Project Coordinator (Changes 1.0 -)
1698 1728
1699=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1729=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1700 1730
1701Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1731pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1702 1732
1703=back 1733=back
1704 1734

Diff Legend

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