--- rxvt-unicode/doc/rxvt.1.pod 2012/09/21 23:31:43 1.220 +++ rxvt-unicode/doc/rxvt.1.pod 2012/11/05 12:59:13 1.221 @@ -129,13 +129,6 @@ Turn on/off skip scrolling (allow multiple screens per refresh); resource B. -=item B<-tr>|B<+tr> - -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. - =item B<-fade> I Fade the text by the given percentage when focus is lost. Small values @@ -147,26 +140,6 @@ Fade to this colour when fading is used (see B<-fade>). The default colour is opaque black. resource B. -=item B<-tint> I - -Tint the transparent background with the given colour; -resource I. - -=item B<-sh> I - -Darken (0 .. 99) or lighten (101 .. 200) the transparent background. -A value of 100 means no shading; resource I. - -=item B<-blr> I - -Apply Gaussian Blur with the specified radii to the transparent -background. If a single number is specified, the vertical and -horizontal radii are considered to be the same. Setting one of the -radii to 1 and the other to a large number creates interesting effects -on some backgrounds. The maximum radius value is 128. An horizontal or -vertical radius of 0 disables blurring; -resource I. - =item B<-icon> I Compile I: Use the specified image as application icon. This @@ -181,13 +154,6 @@ Window foreground colour; resource B. -=item B<-pixmap> I - -Compile I: Specify image file for the background and also -optionally specify a list of operations to modify it. 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. - =item B<-cr> I The cursor colour; resource B. @@ -685,13 +651,6 @@ if the refresh is too fast for the human eye to read anything (or the monitor to display anything); option B<+ss>. -=item B I - -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. - =item B I Fade the text by the given percentage when focus is lost; option B<-fade>. @@ -701,24 +660,6 @@ Fade to this colour, when fading is used (see B). The default colour is black; option B<-fadecolor>. -=item B I - -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 .. 99) or lighten (101 .. 200) the transparent background. -A value of 100 means no shading; option B<-sh>. - -=item B I - -Apply gaussian blur with the specified radius to the transparent -background; option B<-blr>. - =item B I Set the application icon pixmap; option B<-icon>. @@ -737,75 +678,6 @@ The colour of the border around the text area and between the scrollbar and the text. -=item B I - -Use the specified image file for the background and also -optionally specify a colon separated list of operations to modify it. -Supported operations are: - -=over 4 - -=item B - -sets scale and position. B<"W" / "H"> specify the horizontal/vertical -scale (percent), and B<"X" / "Y"> locate the image centre (percent). A -scale of 0 disables scaling. - -=item B - -enables tiling - -=item B - -maintain the image aspect ratio when scaling - -=item B - -use the position of the terminal window relative to the root window as -the image offset, simulating a root window background - -=back - -The default scale and position setting is C<100x100+50+50>. -Alternatively, a predefined set of templates can be used to achieve -the most common setups: - -=over 4 - -=item B - -the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile - -=item B - -the image is scaled to fill the whole window maintaining the aspect -ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect - -=item B - -the image is scaled to fill the whole window. Equivalent to 100x100 - -=item B - -the image is centered with no scaling. Equivalent to 0x0+50+50 - -=item B - -the image is tiled with no scaling and using 'root' positioning. -Equivalent to 0x0:op=tile:op=root-align - -=back - -If multiple templates are specified the last one wins. Note that a -template overrides all the scale, position and operations settings. - -If used in conjunction with B<-tr> option, the specified pixmap will be -blended over the transparent background using alpha-blending. - -=item B I - -Specify the colon-delimited search path for finding background image files. - =item B I Select the fonts to be used. This is a comma separated list of font names @@ -1335,6 +1207,116 @@ Turn on/off ISO 14755 5.2 mode (default enabled). +=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES + +=item B<-pixmap> I + +=item B I + +Compile I: Use the specified image file as the window's +background and also optionally specify a colon separated list of +operations to modify it. Note that you may need to quote the C<;> +character when using the command line option, as C<;> is usually a +metacharacter in shells. Supported operations are: + +=over 4 + +=item B + +sets scale and position. B<"W" / "H"> specify the horizontal/vertical +scale (percent), and B<"X" / "Y"> locate the image centre (percent). A +scale of 0 disables scaling. + +=item B + +enables tiling + +=item B + +maintain the image aspect ratio when scaling + +=item B + +use the position of the terminal window relative to the root window as +the image offset, simulating a root window background + +=back + +The default scale and position setting is C<100x100+50+50>. +Alternatively, a predefined set of templates can be used to achieve +the most common setups: + +=over 4 + +=item B + +the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile + +=item B + +the image is scaled to fill the whole window maintaining the aspect +ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect + +=item B + +the image is scaled to fill the whole window. Equivalent to 100x100 + +=item B + +the image is centered with no scaling. Equivalent to 0x0+50+50 + +=item B + +the image is tiled with no scaling and using 'root' positioning. +Equivalent to 0x0:op=tile:op=root-align + +=back + +If multiple templates are specified the last one wins. Note that a +template overrides all the scale, position and operations settings. + +If used in conjunction with pseudo-transparency, the specified pixmap +will be blended over the transparent background using alpha-blending. + +=item B<-tr>|B<+tr> + +=item B I + +Turn on/off pseudo-transparency by using the root pixmap as background. + +B<-ip> (B) is still accepted as an obsolete alias but +will be removed in future versions. + +=item B<-tint> I + +=item B I + +Tint the transparent background with the given colour. Note that a +black tint yields a completely black image while a white tint yields +the image unchanged. + +=item B<-sh> I + +=item B I + +Darken (0 .. 99) or lighten (101 .. 200) the transparent background. +A value of 100 means no shading. + +=item B<-blr> I + +=item B I + +Apply gaussian blur with the specified radius to the transparent +background. If a single number is specified, the vertical and +horizontal radii are considered to be the same. Setting one of the +radii to 1 and the other to a large number creates interesting effects +on some backgrounds. The maximum radius value is 128. An horizontal or +vertical radius of 0 disables blurring. + +=item B I + +Specify the colon-delimited search path for finding background image files. + =back =head1 THE SCROLLBAR