--- rxvt-unicode/doc/rxvt.1.pod 2011/08/13 09:05:43 1.203 +++ rxvt-unicode/doc/rxvt.1.pod 2014/04/26 14:07:36 1.227 @@ -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 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. @@ -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,52 +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: - - 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. The maximum permitted scale is 1000. - 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 - -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 - -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. - -=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 @@ -1181,7 +1068,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 +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. @@ -1297,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. @@ -1321,6 +1209,120 @@ =back +=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES + +=over 4 + +=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 Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window @@ -1376,6 +1378,12 @@ Pressing B causes the value of the PRIMARY selection to be inserted too. +rxvt-unicode also provides the bindings B and + to interact with the CLIPBOARD selection. The first +binding causes the value of the internal selection to be copied to the +CLIPBOARD selection, while the second binding causes the value of the +CLIPBOARD selection to be inserted. + =back =head1 CHANGING FONTS @@ -1509,8 +1517,8 @@ 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 + index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 + index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 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 @@ -1536,7 +1544,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 +1636,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 +1682,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 @@ -1672,7 +1691,7 @@ =item Project Coordinator -Marc A. Lehmann L<< >> +Marc A. Lehmann . L @@ -1686,38 +1705,38 @@ University of Kent, 1992, wrote the original Xvt. -=item Rob Nation L<< >> +=item Rob Nation very heavily modified Xvt and came up with Rxvt -=item Angelo Haritsis L<< >> +=item Angelo Haritsis wrote the Greek Keyboard Input (no longer in code) -=item mj olesen L<< >> +=item mj olesen Wrote the menu system. Project Coordinator (changes.txt 2.11 to 2.21) -=item Oezguer Kesim L<< >> +=item Oezguer Kesim Project Coordinator (changes.txt 2.21a to 2.4.5) -=item Geoff Wing L<< >> +=item Geoff Wing Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) -=item Marc Alexander Lehmann L<< >> +=item Marc Alexander Lehmann Forked rxvt-unicode, unicode support, rewrote almost all the code, perl extension, random hacks, numerous bugfixes and extensions. Project Coordinator (Changes 1.0 -) -=item Emanuele Giaquinta L<< >> +=item Emanuele Giaquinta pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.