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.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC

… …
124 124
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 126
127=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
128 128
129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130 130
131B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions. 132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 133
137=item B<-fade> I<number> 134=item B<-fade> I<number>
138 135
139Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
… …
145Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
147 144
148=item B<-tint> I<colour> 145=item B<-tint> I<colour>
149 146
150Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours 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> - colour values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 164
178=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
179 166
180Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
185resource I<blurRadius>. 172resource I<blurRadius>.
186 173
187=item B<-icon> I<file> 174=item B<-icon> I<file>
188 175
189Compile I<afterimage>: Use the specified image as application icon. This 176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 177is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 178application window; resource I<iconFile>.
192 179
193=item B<-bg> I<colour> 180=item B<-bg> I<colour>
194 181
… …
198 185
199Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
200 187
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202 189
203Compile I<afterimage>: Specify image file for the background and also 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
207 194
208=item B<-cr> I<colour> 195=item B<-cr> I<colour>
… …
702if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
704 691
705=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
706 693
707Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
708 695
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions. 697future versions.
711 698
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> 699=item B<fading:> I<number>
716 700
717Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
718 702
719=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
… …
721Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
722colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
723 707
724=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
725 709
726Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour; option
727B<-tint>. 711B<-tint>.
728 712
729=item B<shading:> I<number> 713=item B<shading:> I<number>
730 714
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 715Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732in addition to tinting it; option B<-sh>. 716A value of 100 means no shading; option B<-sh>.
733 717
734=item B<blendType:> I<string> 718=item B<blendType:> I<string>
735 719
736Specify background blending type; option B<-blt>. 720Specify background blending type; option B<-blt>.
737 721
738=item B<blurRadius:> I<number> 722=item B<blurRadius:> I<number>
739 723
740Apply gaussian blur with the specified radius to the transparent 724Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>. 725background; option B<-blr>.
742 726
743=item B<iconFile:> I<file> 727=item B<iconFile:> I<file>
744 728
745Set the application icon pixmap; option B<-icon>. 729Set the application icon pixmap; option B<-icon>.
746 730
… …
760 744
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762 746
763Use the specified image file for the background and also 747Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>, 748optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<0x0+50+50>) in which B<"W" / "H"> specify the 749(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. A scale 751centre (percent). A scale of 0 displays the image with tiling.
768of 1 displays the image without any scaling. A scale of 2 to 9 specifies 752The maximum permitted scale is 1000.
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...>. 753Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are: 754Supported operations are:
773 755
774 tile force background image to be tiled and not scaled. Equivalent to 0x0 756 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions 757 propscale will scale image keeping proportions
… …
779 scale will scale image to match window size 761 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting 762 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves 763 whenever terminal window moves
782 764
783If used in conjunction with B<-tr> option, the specified pixmap will be 765If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any 766blended over the transparent background using alpha-blending. If I<afterimage>
785other blending type, specified with B<-blt "type"> option. 767support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option.
786 769
787=item B<path:> I<path> 770=item B<path:> I<path>
788 771
789Specify the colon-delimited search path for finding background image files. 772Specify the colon-delimited search path for finding background image files.
790 773
… …
1040large number (e.g. C<987654321>) to effectively disable the timeout. 1023large number (e.g. C<987654321>) to effectively disable the timeout.
1041 1024
1042=item B<backspacekey:> I<string> 1025=item B<backspacekey:> I<string>
1043 1026
1044The string to send when the backspace key is pressed. If set to B<DEC> 1027The 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> 1028or 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 1029(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 1030escape sequence.
1048 1031
1049=item B<deletekey:> I<string> 1032=item B<deletekey:> I<string>
1050 1033
… …
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1152omitting 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 1153keysym 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. 1154performed in an exact manner; however, the closest match is assured.
1172 1155
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1156I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1157number), see RESOURCES in C<man 7 X> for further details.
1175 1158
1176You can define a range of keysyms in one shot by providing a I<string> 1159You can define a range of keysyms in one shot by providing a I<string>
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1160with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178should be a character not used by the strings. 1161should be a character not used by the strings.
1179 1162
… …
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1183C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1184
1202 URxvt.keysym.M-C-c: perl:selection:rot13 1185 URxvt.keysym.M-C-c: perl:selection:rot13
1203 1186
1204Due the the large number of modifier combinations, a defined key mapping 1187Due 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 1188will 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 1189no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide 1190means 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 1191definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves. 1192mappings themselves.
1210 1193
… …
1459on some systems or setgid to root or to some other group on others. 1442on some systems or setgid to root or to some other group on others.
1460 1443
1461=head1 COLOURS AND GRAPHICS 1444=head1 COLOURS AND GRAPHICS
1462 1445
1463In addition to the default foreground and background colours, 1446In addition to the default foreground and background colours,
1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1447B<@@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 1448high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466colours with their names. 1449240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1450cube plus a 8 (24) colour greyscale ramp.
1451
1452Here is a list of the ANSI colours with their names.
1467 1453
1468=begin table 1454=begin table
1469 1455
1470 B<color0> (black) = Black 1456 B<color0> (black) = Black
1471 B<color1> (red) = Red3 1457 B<color1> (red) = Red3
… …
1491It is also possible to specify the colour values of B<foreground>, 1477It is also possible to specify the colour values of B<foreground>,
1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1478B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493a number 0-15, as a convenient shorthand to reference the colour name of 1479a number 0-15, as a convenient shorthand to reference the colour name of
1494color0-color15. 1480color0-color15.
1495 1481
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an 1482The following text gives values for the standard 88 colour mode (and
1497additional 72 colours. The first 64 of those (with indices 16 to 79) 1483values 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 1484
1485The RGB cube uses indices 16..79 (16..231) using the following formulas:
1486
1487 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1488 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1489
1490The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1491steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1492the RGB cube.
1493
1501Together, all those colours implement the 88 colour xterm colours. Only 1494Together, all those colours implement the 88 (256) colour xterm
1502the first 16 can be changed using resources currently, the rest can only 1495colours. Only the first 16 can be changed using resources currently, the
1503be changed via command sequences ("escape codes"). 1496rest can only be changed via command sequences ("escape codes").
1497
1498Applications are advised to use terminfo or command sequences to discover
1499number and RGB values of all colours (yes, you can query this...).
1504 1500
1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1501Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506always swapping the foreground/background colours. This is in contrast to 1502always swapping the foreground/background colours. This is in contrast to
1507I<xterm>(1) where the colours are only swapped if they have not otherwise 1503I<xterm>(1) where the colours are only swapped if they have not otherwise
1508been specified. For example, 1504been specified. For example,
… …
1515=head2 ALPHA CHANNEL SUPPORT 1511=head2 ALPHA CHANNEL SUPPORT
1516 1512
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1513If 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: 1514their act together, rxvt-unicode will do it's own alpha channel management:
1519 1515
1520You can prefix any colour with an opaquenes percentage enclosed in 1516You can prefix any colour with an opaqueness percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1517brackets, 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 1518(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 1519transparent 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 1520half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with 1521is the recommended format to specify transparency values, and works with

Diff Legend

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