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.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC

… …
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
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
… …
1040large number (e.g. C<987654321>) to effectively disable the timeout. 1038large number (e.g. C<987654321>) to effectively disable the timeout.
1041 1039
1042=item B<backspacekey:> I<string> 1040=item B<backspacekey:> I<string>
1043 1041
1044The string to send when the backspace key is pressed. If set to B<DEC> 1042The 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> 1043or 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 1044(code 8) - which can be reversed with the appropriate DEC private mode
1047escape sequence. 1045escape sequence.
1048 1046
1049=item B<deletekey:> I<string> 1047=item B<deletekey:> I<string>
1050 1048
… …
1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1167omitting 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 1168keysym 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. 1169performed in an exact manner; however, the closest match is assured.
1172 1170
1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1171I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1174number), see RESOURCES in C<man 7 X> for futher details. 1172number), see RESOURCES in C<man 7 X> for further details.
1175 1173
1176You can define a range of keysyms in one shot by providing a I<string> 1174You can define a range of keysyms in one shot by providing a I<string>
1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178should be a character not used by the strings. 1176should be a character not used by the strings.
1179 1177
… …
1459on some systems or setgid to root or to some other group on others. 1457on some systems or setgid to root or to some other group on others.
1460 1458
1461=head1 COLOURS AND GRAPHICS 1459=head1 COLOURS AND GRAPHICS
1462 1460
1463In addition to the default foreground and background colours, 1461In addition to the default foreground and background colours,
1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1462B<@@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 1463high-intensity (potentially bold/blink) versions of the same, and 72 (or
1466colours with their names. 1464240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1465cube plus a 8 (24) colour greyscale ramp.
1466
1467Here is a list of the ANSI colours with their names.
1467 1468
1468=begin table 1469=begin table
1469 1470
1470 B<color0> (black) = Black 1471 B<color0> (black) = Black
1471 B<color1> (red) = Red3 1472 B<color1> (red) = Red3
… …
1491It is also possible to specify the colour values of B<foreground>, 1492It is also possible to specify the colour values of B<foreground>,
1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1493B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1493a number 0-15, as a convenient shorthand to reference the colour name of 1494a number 0-15, as a convenient shorthand to reference the colour name of
1494color0-color15. 1495color0-color15.
1495 1496
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an 1497The following text gives values for the standard 88 colour mode (and
1497additional 72 colours. The first 64 of those (with indices 16 to 79) 1498values 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 1499
1500The RGB cube uses indices 16..79 (16..231) using the following formulas:
1501
1502 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1503 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1504
1505The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1506steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1507the RGB cube.
1508
1501Together, all those colours implement the 88 colour xterm colours. Only 1509Together, all those colours implement the 88 (256) colour xterm
1502the first 16 can be changed using resources currently, the rest can only 1510colours. Only the first 16 can be changed using resources currently, the
1503be changed via command sequences ("escape codes"). 1511rest can only be changed via command sequences ("escape codes").
1512
1513Applications are advised to use terminfo or command sequences to discover
1514number and RGB values of all colours (yes, you can query this...).
1504 1515
1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1516Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1506always swapping the foreground/background colours. This is in contrast to 1517always swapping the foreground/background colours. This is in contrast to
1507I<xterm>(1) where the colours are only swapped if they have not otherwise 1518I<xterm>(1) where the colours are only swapped if they have not otherwise
1508been specified. For example, 1519been specified. For example,
… …
1515=head2 ALPHA CHANNEL SUPPORT 1526=head2 ALPHA CHANNEL SUPPORT
1516 1527
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1528If 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: 1529their act together, rxvt-unicode will do it's own alpha channel management:
1519 1530
1520You can prefix any colour with an opaquenes percentage enclosed in 1531You can prefix any colour with an opaqueness percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1532brackets, 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 1533(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 1534transparent 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 1535half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with 1536is the recommended format to specify transparency values, and works with

Diff Legend

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