--- rxvt-unicode/doc/rxvt.1.pod 2010/12/09 14:19:39 1.191 +++ rxvt-unicode/doc/rxvt.1.pod 2012/11/05 13:05:51 1.222 @@ -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. @@ -124,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 @@ -142,38 +140,9 @@ 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<-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 -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; -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,13 +154,6 @@ Window foreground colour; resource B. -=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 -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. @@ -560,10 +522,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 @@ -689,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>. @@ -705,28 +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 - -Specify background blending type; option B<-blt>. - -=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>. @@ -745,35 +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 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 displays the image with tiling. -The maximum permitted scale is 1000. -Additional operations can be specified after colon B<:op1:op2...>. -Supported operations are: - - tile force background image to be tiled and not scaled. Equivalent to 0x0 - propscale will scale image keeping proportions - auto will scale image to match window size. Equivalent to 100x100 - hscale will scale image horizontally to the window size - vscale will scale image vertically to the window size - scale will scale image to match window size - root will tile image as if it was a root window background, auto-adjusting - whenever terminal window moves - -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. - -=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 @@ -905,6 +809,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: @@ -933,9 +841,10 @@ =item B I -B: scroll with scrollback buffer when tty receives new lines (and -B is False); option B<-sw>. B: do not scroll -with scrollback buffer when tty receives new lines; option B<+sw>. +B: scroll with scrollback buffer when tty receives new lines (i.e. +try to show the same lines) and B is False; option +B<-sw>. B: do not scroll with scrollback buffer when tty receives +new lines; option B<+sw>. =item B I @@ -1159,19 +1068,20 @@ 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. Its usage can be demonstrated by an example: - URxvt.keysym.M-C-0x61: list|\033 + URxvt.keysym.M-C-0x61: list|\033<|abc|> 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 + URxvt.keysym.Meta-Control-0x61: \033 + URxvt.keysym.Meta-Control-0x62: \033 + URxvt.keysym.Meta-Control-0x63: \033 If I takes the form of C, the specified B is interpreted and executed as @@RXVT_NAME@@'s control sequence. For @@ -1254,9 +1164,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. @@ -1275,7 +1185,7 @@ Sets the hotkey that starts the incremental scrollback buffer search (default: C). -=item B: I +=item B: I Specifies the program to be started with a URL argument. Used by the C and C perl extensions. @@ -1297,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 @@ -1514,7 +1534,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 @@ -1606,12 +1626,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 @@ -1621,7 +1651,7 @@ =item B -Directory where various X resource files are being located. +Directory where application-specific X resource files are located. =item B @@ -1642,7 +1672,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