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.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

179 179
180Apply Gaussian Blur with the specified radii to the transparent 180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
185resource I<blurRadius>. 185resource I<blurRadius>.
186 186
187=item B<-icon> I<file> 187=item B<-icon> I<file>
188 188
189Compile I<afterimage>: Use the specified image as application icon. This 189Compile 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 190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 191application window; resource I<iconFile>.
192 192
193=item B<-bg> I<colour> 193=item B<-bg> I<colour>
194 194
198 198
199Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
200 200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202 202
203Compile I<afterimage>: Specify image file for the background and also 203Compile 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 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 205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
207 207
208=item B<-cr> I<colour> 208=item B<-cr> I<colour>
760 760
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
762 762
763Use the specified image file for the background and also 763Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>, 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 765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (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 768The 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...>. 769Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are: 770Supported operations are:
773 771
774 tile force background image to be tiled and not scaled. Equivalent to 0x0 772 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions 773 propscale will scale image keeping proportions
779 scale will scale image to match window size 777 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting 778 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves 779 whenever terminal window moves
782 780
783If used in conjunction with B<-tr> option, the specified pixmap will be 781If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any 782blended over transparency image using alpha-blending. If I<afterimage>
785other blending type, specified with B<-blt "type"> option. 783support has been compiled in it is possible to choose other blending
784types with B<-blt "type"> option.
786 785
787=item B<path:> I<path> 786=item B<path:> I<path>
788 787
789Specify the colon-delimited search path for finding background image files. 788Specify the colon-delimited search path for finding background image files.
790 789
1040large number (e.g. C<987654321>) to effectively disable the timeout. 1039large number (e.g. C<987654321>) to effectively disable the timeout.
1041 1040
1042=item B<backspacekey:> I<string> 1041=item B<backspacekey:> I<string>
1043 1042
1044The string to send when the backspace key is pressed. If set to B<DEC> 1043The 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> 1044or 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 1045(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 1046escape sequence.
1048 1047
1049=item B<deletekey:> I<string> 1048=item B<deletekey:> I<string>
1050 1049
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1168omitting 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 1169keysym 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. 1170performed in an exact manner; however, the closest match is assured.
1172 1171
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1172I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1173number), see RESOURCES in C<man 7 X> for further details.
1175 1174
1176You can define a range of keysyms in one shot by providing a I<string> 1175You can define a range of keysyms in one shot by providing a I<string>
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1176with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178should be a character not used by the strings. 1177should be a character not used by the strings.
1179 1178
1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1199C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201 1200
1202 URxvt.keysym.M-C-c: perl:selection:rot13 1201 URxvt.keysym.M-C-c: perl:selection:rot13
1203 1202
1204Due the the large number of modifier combinations, a defined key mapping 1203Due 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 1204will 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 1205no other key mappings with those and more bits are being defined. That
1207means that defining a key map for C<a> will automatically provide 1206means 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 1207definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209mappings themselves. 1208mappings themselves.
1210 1209
1459on some systems or setgid to root or to some other group on others. 1458on some systems or setgid to root or to some other group on others.
1460 1459
1461=head1 COLOURS AND GRAPHICS 1460=head1 COLOURS AND GRAPHICS
1462 1461
1463In addition to the default foreground and background colours, 1462In addition to the default foreground and background colours,
1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1463B<@@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 1464high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466colours with their names. 1465240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1466cube plus a 8 (24) colour greyscale ramp.
1467
1468Here is a list of the ANSI colours with their names.
1467 1469
1468=begin table 1470=begin table
1469 1471
1470 B<color0> (black) = Black 1472 B<color0> (black) = Black
1471 B<color1> (red) = Red3 1473 B<color1> (red) = Red3
1491It is also possible to specify the colour values of B<foreground>, 1493It is also possible to specify the colour values of B<foreground>,
1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1494B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493a number 0-15, as a convenient shorthand to reference the colour name of 1495a number 0-15, as a convenient shorthand to reference the colour name of
1494color0-color15. 1496color0-color15.
1495 1497
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an 1498The following text gives values for the standard 88 colour mode (and
1497additional 72 colours. The first 64 of those (with indices 16 to 79) 1499values 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 1500
1501The RGB cube uses indices 16..79 (16..231) using the following formulas:
1502
1503 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1504 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1505
1506The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1507steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1508the RGB cube.
1509
1501Together, all those colours implement the 88 colour xterm colours. Only 1510Together, all those colours implement the 88 (256) colour xterm
1502the first 16 can be changed using resources currently, the rest can only 1511colours. Only the first 16 can be changed using resources currently, the
1503be changed via command sequences ("escape codes"). 1512rest can only be changed via command sequences ("escape codes").
1513
1514Applications are advised to use terminfo or command sequences to discover
1515number and RGB values of all colours (yes, you can query this...).
1504 1516
1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1517Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506always swapping the foreground/background colours. This is in contrast to 1518always swapping the foreground/background colours. This is in contrast to
1507I<xterm>(1) where the colours are only swapped if they have not otherwise 1519I<xterm>(1) where the colours are only swapped if they have not otherwise
1508been specified. For example, 1520been specified. For example,
1515=head2 ALPHA CHANNEL SUPPORT 1527=head2 ALPHA CHANNEL SUPPORT
1516 1528
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1529If 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: 1530their act together, rxvt-unicode will do it's own alpha channel management:
1519 1531
1520You can prefix any colour with an opaquenes percentage enclosed in 1532You can prefix any colour with an opaqueness percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1533brackets, 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 1534(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 1535transparent 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 1536half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with 1537is the recommended format to specify transparency values, and works with

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines