--- rxvt-unicode/doc/rxvt.1.pod 2011/08/11 08:37:17 1.202 +++ rxvt-unicode/doc/rxvt.1.pod 2012/09/21 23:31:43 1.220 @@ -100,7 +100,7 @@ =item B<-depth> I -Compile I: Attempt to find a visual with the given bit depth; +Compile I: Attempt to find a visual with the given bit depth; resource B. [Please note that many X servers (and libXft) are buggy with @@ -108,6 +108,11 @@ of graphical corruption. This is harmless, but we can't do anything about this, so watch out] +=item B<-visual> I + +Compile I: Use the given visual (see e.g. C for possible +visual ids). + =item B<-geometry> I Window geometry (B<-g> still respected); resource B. @@ -152,28 +157,19 @@ 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 -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. - =item B<-blr> I Apply Gaussian Blur with the specified radii to the transparent -background. If a single number is specified - both vertical and +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 another to a large number creates interesting effects -on some backgrounds. Maximum radius value is 128; +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 or I: Use the specified image as application icon. This +Compile 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. @@ -185,10 +181,10 @@ Window foreground colour; resource B. -=item B<-pixmap> I +=item B<-pixmap> I -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 +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. @@ -718,10 +714,6 @@ Darken (0 .. 99) or lighten (101 .. 200) the transparent background. A value of 100 means no shading; option B<-sh>. -=item B I - -Specify background blending type; option B<-blt>. - =item B I Apply gaussian blur with the specified radius to the transparent @@ -745,47 +737,70 @@ The colour of the border around the text area and between the scrollbar and the text. -=item B I +=item B I Use the specified image file for the background and also -optionally specify its scaling with a geometry string B, -(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 disables scaling. -The maximum permitted scale is 1000. -Additional operations can be specified after colon B<:op1:op2...>. +optionally specify a colon separated list of operations to modify it. Supported operations are: - op=tile enables tiling - op=pscale enables proportional scaling - op=root use the position of the terminal window relative to the root - window as the image offset, simulating a root window background +=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: - style=tiled the image is tiled with no scaling - style=aspect-stretched the image is scaled to fill the whole window maintaining - the aspect ratio and centered - style=stretched the image is scaled to fill the whole window - style=centered the image is centered with no scaling - style=root-tiled the image is tiled with no scaling and using 'op=root' positioning +=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. -Indeed, the templates can be specified in terms of low level settings -as follows: - - style=tiled 0x0+0+0:op=tile - style=aspect-stretched +50+50:op=pscale - style=stretched 100x100 - style=centered 0x0+50+50 - style=root-tiled 0x0:op=tile:op=root If used in conjunction with B<-tr> option, the specified pixmap will be -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. +blended over the transparent background using alpha-blending. =item B I @@ -1181,7 +1196,8 @@ I may contain escape values (C<\n>: newline, C<\000>: octal number), see RESOURCES in C for further details. -You can define a range of keysyms in one shot by providing a I +You can define a range of keysyms in one shot by +loading the C perl extension and providing a I with pattern B, where the delimiter `/' should be a character not used by the strings. @@ -1276,9 +1292,9 @@ =item B: I Colon-separated list of additional directories that hold extension -scripts. When looking for extensions specified by the C resource, -@@RXVT_NAME@@ will first look in these directories and then in -F<@@RXVT_LIBDIR@@/urxvt/perl/>. +scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look +in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and +lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. See the @@RXVT_NAME@@perl(3) manpage. @@ -1536,7 +1552,7 @@ =head2 ALPHA CHANNEL SUPPORT 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: +their act together, rxvt-unicode will do its own alpha channel management: You can prefix any colour with an opaqueness percentage enclosed in brackets, i.e. C<[percent]>, where C is a decimal percentage @@ -1628,12 +1644,22 @@ The shell to be used for command execution, defaults to C. -=item B +=item B [I] 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/.urxvt/urxvtd-I<< >> >>>. + +=item B + +Additional F<:>-separated library search path for perl extensions. Will be +searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library +directory. + +=item B + +See L<@@RXVT_NAME@@perl>(3). =item B @@ -1664,7 +1690,8 @@ =head1 SEE ALSO -@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) +@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), +@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) =head1 CURRENT PROJECT COORDINATOR