--- rxvt-unicode/doc/rxvt.1.pod 2010/04/12 17:06:55 1.175 +++ rxvt-unicode/doc/rxvt.1.pod 2011/04/30 18:45:38 1.195 @@ -126,14 +126,11 @@ =item B<-tr>|B<+tr> -Turn on/off illusion of a transparent window background; resource B. +Turn on/off pseudo-transparency by using the root pixmap as background; resource B. B<-ip> is still accepted as an obsolete alias but will be removed in future versions. -I - =item B<-fade> I Fade the text by the given percentage when focus is lost. Small values @@ -147,30 +144,20 @@ =item B<-tint> I -Tint the transparent background pixmap with the given colour when -transparency is enabled with B<-tr>. This only works for -non-tiled backgrounds, currently. See also the B<-sh> option that can be -used to brighten or darken the image in addition to tinting it. -Please note that certain tint colours can be applied on the server-side, -thus yielding performance gain of two orders of magnitude. These colours are: -blue, red, green, cyan, magenta, yellow, and those close to them. Also -pure black and pure white colors essentially mean no tinting; resource -I. Example: - - @@RXVT_NAME@@ -tr -tint blue -sh 40 +Tint the transparent background with the given colour; +resource I. =item B<-sh> I -Darken (0 .. 100) or lighten (100 .. 200) the transparent -background image in addition to (or instead of) tinting it; -resource I. +Darken (0 .. 99) or lighten (101 .. 200) the transparent background. +A value of 100 means no shading; resource I. =item B<-blt> I Specify background blending type. If background pixmap is specified at the same time as transparency - such pixmap will be blended over -transparency image, using method specified. Supported values are : -B, B, B - color values averaging, B, +the transparent background, using the method specified. Supported values are: +B, B, B - colour values averaging, B, B, B, B, B, B, B, B, B, B, B, B. The default is alpha-blending. Compile I; resource I. @@ -178,15 +165,15 @@ =item B<-blr> I Apply Gaussian Blur with the specified radii to the transparent -background image. If single number is specified - both vertical and +background. If a single number is specified - both vertical and horizontal radii are considered to be the same. Setting one of the radii to 1 and another to a large number creates interesting effects -on some backgrounds. Maximum radius value is 128. Compile I; +on some backgrounds. Maximum radius value is 128; resource I. =item B<-icon> I -Compile I: Use the specified image as application icon. This +Compile I or I: Use the specified image as application icon. This is used by many window managers, taskbars and pagers to represent the application window; resource I. @@ -200,7 +187,7 @@ =item B<-pixmap> I -Compile I: Specify image file for the background and also +Compile I or I: Specify image file for the background and also optionally specify its scaling with a geometry string. Note you may need to add quotes to avoid special shell interpretation of the C<;> in the command-line; for more details see resource B. @@ -573,10 +560,10 @@ starts. @@RXVT_NAME@@ will consult the following files/resources in order, with later settings overwriting earlier ones: - 1. system-wide app-defaults file, either locale-dependent OR global - 2. app-defaults file in $XAPPLRESDIR - 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults - 4. SCREEN_RESOURCES for the current screen + 1. app-defaults file in $XAPPLRESDIR + 2. $HOME/.Xdefaults + 3. RESOURCE_MANAGER property on root-window of screen 0 + 4. SCREEN_RESOURCES property on root-window of the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- 6. resources specified via -xrm on the commandline @@ -627,7 +614,7 @@ high-intensity (bold = bright foreground, blink = bright background) colours. The canonical names are as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour -names used are listed in the B section. +names used are listed in the B section. Colours higher than 15 cannot be set using resources (yet), but can be changed using an escape command (see @@RXVT_NAME@@(7)). @@ -648,16 +635,21 @@ Use the specified colour to display underlined characters when the foreground colour is the default. -=item B I - -Use the specified colour as the background for reverse video characters -when OPTION_HC is disabled (--disable-frills). - =item B I If set, use the specified colour as the colour for the underline itself. If unset, use the foreground colour. +=item B I + +If set, use the specified colour as the background for highlighted +characters. If unset, use reverse video. + +=item B I + +If set and highlightColor is set, use the specified colour as the +foreground for highlighted characters. + =item B I Use the specified colour for the cursor. The default is to use the @@ -673,7 +665,7 @@ B: simulate reverse video by foreground and background colours; option B<-rv>. B: regular screen colours [default]; option -B<+rv>. See note in B section. +B<+rv>. See note in B section. =item B I @@ -699,14 +691,11 @@ =item B I -Turn on/off illusion of a transparent window background. +Turn on/off pseudo-transparency by using the root pixmap as background. B is still accepted as an obsolete alias but will be removed in future versions. -I - =item B I Fade the text by the given percentage when focus is lost; option B<-fade>. @@ -718,13 +707,16 @@ =item B I -Tint the transparent background pixmap with the given colour; option -B<-tint>. +Tint the transparent background with the given colour. If the RENDER +extension is not available only black, red, green, yellow, blue, +magenta, cyan and white tints can be performed server-side. Note that +a black tint yields a completely black image while a white tint yields +the image unchanged; option B<-tint>. =item B I -Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image -in addition to tinting it; option B<-sh>. +Darken (0 .. 99) or lighten (101 .. 200) the transparent background. +A value of 100 means no shading; option B<-sh>. =item B I @@ -733,7 +725,7 @@ =item B I Apply gaussian blur with the specified radius to the transparent -background image; option B<-blr>. +background; option B<-blr>. =item B I @@ -757,12 +749,10 @@ Use the specified image file for the background and also optionally specify its scaling with a geometry string B, -(default C<0x0+50+50>) in which B<"W" / "H"> specify the +(default C<100x100+50+50>) in which B<"W" / "H"> specify the horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image -centre (percent). A scale of 0 displays the image with tiling. A scale -of 1 displays the image without any scaling. A scale of 2 to 9 specifies -an integer number of images in that direction. No image will be magnified -beyond 10 times its original size. The maximum permitted scale is 1000. +centre (percent). A scale of 0 displays the image with tiling. +The maximum permitted scale is 1000. Additional operations can be specified after colon B<:op1:op2...>. Supported operations are: @@ -776,8 +766,9 @@ whenever terminal window moves If used in conjunction with B<-tr> option, the specified pixmap will be -blended over transparency image using either alpha-blending, or any -other blending type, specified with B<-blt "type"> option. +blended over the transparent background using alpha-blending. If I +support has been compiled in it is possible to choose other blending +types with B<-blt "type"> option. =item B I @@ -914,6 +905,10 @@ Set scrollbar style to B, B, B or B. B is the author's favourite. +=item B I + +Set the scrollbar width in pixels. + =item B I B: enable the scrollbar [default]; option B<-sb>. B: @@ -1037,7 +1032,7 @@ =item B I The string to send when the backspace key is pressed. If set to B -or unset it will send B (code 127) or, if shifted, B +or unset it will send B (code 127) or, with control, B (code 8) - which can be reversed with the appropriate DEC private mode escape sequence. @@ -1166,21 +1161,7 @@ performed in an exact manner; however, the closest match is assured. I may contain escape values (C<\n>: newline, C<\000>: octal -number), see RESOURCES in C for futher details. - -You can define a range of keysyms in one shot by providing a I -with pattern B, where the delimiter `/' -should be a character not used by the strings. - -Its usage can be demonstrated by an example: - - URxvt.keysym.M-C-0x61: list|\033 - -The above line is equivalent to the following three lines: - - URxvt.keysym.Meta-Control-0x61: \033 - URxvt.keysym.Meta-Control-0x62: \033 - URxvt.keysym.Meta-Control-0x63: \033 +number), see RESOURCES in C for further details. If I takes the form of C, the specified B is interpreted and executed as @@RXVT_NAME@@'s control sequence. For @@ -1197,7 +1178,7 @@ URxvt.keysym.M-C-c: perl:selection:rot13 Due the the large number of modifier combinations, a defined key mapping -will match if at I the specified identifiers are being set, and +will match if I the specified identifiers are being set, and no other key mappings with those and more bits are being defined. That means that defining a key map for C will automatically provide definitions for C, C and so on, unless some of those are defined @@ -1453,12 +1434,15 @@ allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root on some systems or setgid to root or to some other group on others. -=head1 COLORS AND GRAPHICS +=head1 COLOURS AND GRAPHICS In addition to the default foreground and background colours, -B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus -high-intensity bold/blink versions of the same). Here is a list of the -colours with their names. +B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus +high-intensity (potentially bold/blink) versions of the same, and 72 (or +240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB +cube plus a 8 (24) colour greyscale ramp. + +Here is a list of the ANSI colours with their names. =begin table @@ -1488,14 +1472,24 @@ a number 0-15, as a convenient shorthand to reference the colour name of color0-color15. -In addition to the colours defined above, @@RXVT_NAME@@ offers an -additional 72 colours. The first 64 of those (with indices 16 to 79) -consist of a 4*4*4 RGB colour cube (i.e. I), followed by 8 additional shades of gray (with indices 80 to 87). - -Together, all those colours implement the 88 colour xterm colours. Only -the first 16 can be changed using resources currently, the rest can only -be changed via command sequences ("escape codes"). +The following text gives values for the standard 88 colour mode (and +values for the 256 colour mode in parentheses). + +The RGB cube uses indices 16..79 (16..231) using the following formulas: + + index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 + index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 + +The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% +steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of +the RGB cube. + +Together, all those colours implement the 88 (256) colour xterm +colours. Only the first 16 can be changed using resources currently, the +rest can only be changed via command sequences ("escape codes"). + +Applications are advised to use terminfo or command sequences to discover +number and RGB values of all colours (yes, you can query this...). Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by always swapping the foreground/background colours. This is in contrast to @@ -1512,9 +1506,9 @@ If Xft support has been compiled in and as long as Xft/Xrender/X don't get their act together, rxvt-unicode will do it's own alpha channel management: -You can prefix any color with an opaquenes percentage enclosed in +You can prefix any colour with an opaqueness percentage enclosed in brackets, i.e. C<[percent]>, where C is a decimal percentage -(0-100) that specifies the opacity of the color, where C<0> is completely +(0-100) that specifies the opacity of the colour, where C<0> is completely transparent and C<100> is completely opaque. For example, C<[50]red> is a half-transparent red, while C<[95]#00ff00> is an almost opaque green. This is the recommended format to specify transparency values, and works with @@ -1607,7 +1601,7 @@ The unix domain socket path used by @@RXVT_NAME@@c(1) and @@RXVT_NAME@@d(1). -Default F<<< $HOME/.rxvt-unicode-I<< > >>>. +Default F<<< $HOME/.rxvt-unicode-I<< >> >>>. =item B @@ -1617,7 +1611,7 @@ =item B -Directory where various X resource files are being located. +Directory where application-specific X resource files are located. =item B @@ -1632,7 +1626,7 @@ =item B -Color names. +Colour names. =back @@ -1693,7 +1687,7 @@ =item Emanuele Giaquinta L<< >> -Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. +pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. =back