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.178 by root, Sun May 23 01:05:01 2010 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off illusion of a transparent window 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 133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136
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
141colour; resource B<fading>. 138colour; resource B<fading>.
179 176
180Apply Gaussian Blur with the specified radii to the transparent 177Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 178background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 179horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 180radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
185resource I<blurRadius>. 182resource I<blurRadius>.
186 183
187=item B<-icon> I<file> 184=item B<-icon> I<file>
188 185
189Compile I<afterimage>: Use the specified image as application icon. This 186Compile 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 187is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 188application window; resource I<iconFile>.
192 189
193=item B<-bg> I<colour> 190=item B<-bg> I<colour>
194 191
198 195
199Window foreground colour; resource B<foreground>. 196Window foreground colour; resource B<foreground>.
200 197
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202 199
203Compile I<afterimage>: Specify image file for the background and also 200Compile 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 201optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 202add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 203command-line; for more details see resource B<backgroundPixmap>.
207 204
208=item B<-cr> I<colour> 205=item B<-cr> I<colour>
707Turn on/off illusion of a transparent window background. 704Turn on/off illusion of a transparent window background.
708 705
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions. 707future versions.
711 708
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> 709=item B<fading:> I<number>
716 710
717Fade the text by the given percentage when focus is lost; option B<-fade>. 711Fade the text by the given percentage when focus is lost; option B<-fade>.
718 712
719=item B<fadeColor:> I<colour> 713=item B<fadeColor:> I<colour>
760 754
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762 756
763Use the specified image file for the background and also 757Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>, 758optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(default C<0x0+50+50>) in which B<"W" / "H"> specify the 759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. A scale 761centre (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 762The 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...>. 763Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are: 764Supported operations are:
773 765
774 tile force background image to be tiled and not scaled. Equivalent to 0x0 766 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions 767 propscale will scale image keeping proportions
779 scale will scale image to match window size 771 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting 772 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves 773 whenever terminal window moves
782 774
783If used in conjunction with B<-tr> option, the specified pixmap will be 775If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any 776blended over transparency image using alpha-blending. If I<afterimage>
785other blending type, specified with B<-blt "type"> option. 777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
786 779
787=item B<path:> I<path> 780=item B<path:> I<path>
788 781
789Specify the colon-delimited search path for finding background image files. 782Specify the colon-delimited search path for finding background image files.
790 783
1040large number (e.g. C<987654321>) to effectively disable the timeout. 1033large number (e.g. C<987654321>) to effectively disable the timeout.
1041 1034
1042=item B<backspacekey:> I<string> 1035=item B<backspacekey:> I<string>
1043 1036
1044The string to send when the backspace key is pressed. If set to B<DEC> 1037The 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> 1038or 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 1039(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 1040escape sequence.
1048 1041
1049=item B<deletekey:> I<string> 1042=item B<deletekey:> I<string>
1050 1043
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1162omitting 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 1163keysym 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. 1164performed in an exact manner; however, the closest match is assured.
1172 1165
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1167number), see RESOURCES in C<man 7 X> for further details.
1175 1168
1176You can define a range of keysyms in one shot by providing a I<string> 1169You can define a range of keysyms in one shot by providing a I<string>
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178should be a character not used by the strings. 1171should be a character not used by the strings.
1179 1172
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1194
1202 URxvt.keysym.M-C-c: perl:selection:rot13 1195 URxvt.keysym.M-C-c: perl:selection:rot13
1203 1196
1204Due the the large number of modifier combinations, a defined key mapping 1197Due 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 1198will 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 1199no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide 1200means 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 1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves. 1202mappings themselves.
1210 1203
1503 1496
1504 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1505 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1506 1499
1507The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% 1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1508steps (1/26 to 25/26 in 1/26 steps). 1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube.
1509 1503
1510Together, all those colours implement the 88 (256) colour xterm 1504Together, all those colours implement the 88 (256) colour xterm
1511colours. Only the first 16 can be changed using resources currently, the 1505colours. Only the first 16 can be changed using resources currently, the
1512rest can only be changed via command sequences ("escape codes"). 1506rest can only be changed via command sequences ("escape codes").
1507
1508Applications are advised to use terminfo or command sequences to discover
1509number and RGB values of all colours (yes, you can query this...).
1513 1510
1514Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1511Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1515always swapping the foreground/background colours. This is in contrast to 1512always swapping the foreground/background colours. This is in contrast to
1516I<xterm>(1) where the colours are only swapped if they have not otherwise 1513I<xterm>(1) where the colours are only swapped if they have not otherwise
1517been specified. For example, 1514been specified. For example,
1524=head2 ALPHA CHANNEL SUPPORT 1521=head2 ALPHA CHANNEL SUPPORT
1525 1522
1526If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1527their act together, rxvt-unicode will do it's own alpha channel management: 1524their act together, rxvt-unicode will do it's own alpha channel management:
1528 1525
1529You can prefix any colour with an opaquenes percentage enclosed in 1526You can prefix any colour with an opaqueness percentage enclosed in
1530brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1531(0-100) that specifies the opacity of the colour, where C<0> is completely 1528(0-100) that specifies the opacity of the colour, where C<0> is completely
1532transparent and C<100> is completely opaque. For example, C<[50]red> is a 1529transparent and C<100> is completely opaque. For example, C<[50]red> is a
1533half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1530half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1534is the recommended format to specify transparency values, and works with 1531is the recommended format to specify transparency values, and works with

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines