--- rxvt-unicode/doc/rxvt.1.pod 2010/05/23 01:05:01 1.178 +++ rxvt-unicode/doc/rxvt.1.pod 2012/05/20 16:34:42 1.215 @@ -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,46 +144,27 @@ =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 colours 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. - -=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 - colour values averaging, B, -B, B, B, B, B, B, -B, B, B, B, B. The default is -alpha-blending. Compile I; resource 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 image. If 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. Compile I; +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 +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. @@ -198,10 +176,10 @@ Window foreground colour; resource B. -=item B<-pixmap> I +=item B<-pixmap> I -Compile 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. @@ -573,10 +551,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 @@ -704,14 +682,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>. @@ -723,22 +698,21 @@ =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>. - -=item B I - -Specify background blending type; option B<-blt>. +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 image; option B<-blr>. +background; option B<-blr>. =item B I @@ -758,31 +732,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<0x0+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. -Additional operations can be specified after colon B<:op1:op2...>. +optionally specify a colon separated list of operations to modify it. 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 +=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 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. =item B I @@ -919,6 +932,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: @@ -947,9 +964,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 @@ -1042,7 +1060,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. @@ -1171,21 +1189,22 @@ 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. +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 @@ -1202,7 +1221,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 @@ -1268,8 +1287,8 @@ =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 +scripts. When looking for perl extensions, @@RXVT_NAME@@ will first +look in these directories, then in $HOME/.urxvt/ext and lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. See the @@RXVT_NAME@@perl(3) manpage. @@ -1505,12 +1524,16 @@ 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). +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 I(1) where the colours are only swapped if they have not otherwise @@ -1524,9 +1547,9 @@ =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 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 colour, where C<0> is completely transparent and C<100> is completely opaque. For example, C<[50]red> is a @@ -1621,7 +1644,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/.urxvt/urxvtd-I<< >> >>>. =item B @@ -1631,7 +1654,7 @@ =item B -Directory where various X resource files are being located. +Directory where application-specific X resource files are located. =item B @@ -1707,7 +1730,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