--- rxvt-unicode/doc/rxvt.1.pod 2007/08/13 10:01:18 1.136 +++ rxvt-unicode/doc/rxvt.1.pod 2007/12/12 19:55:55 1.151 @@ -32,7 +32,7 @@ scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work fine, though. A somewhat difficult case are right-to-left scripts, such as hebrew: B adopts the view that bidirectional algorithms -belong into the application, not the terminal emulator (too many things -- +belong in the application, not the terminal emulator (too many things -- such as cursor-movement while editing -- break otherwise), but that might change. @@ -116,14 +116,15 @@ Turn on/off skip scrolling (allow multiple screens per refresh); resource B. -=item B<-ip>|B<+ip> | B<-tr>|B<+tr> +=item B<-tr>|B<+tr> -Turn on/off inheriting parent window's pixmap. Alternative form is -B<-tr>; resource B. +Turn on/off illusion of a transparent window background; resource B. -I +B<-ip> is still accepted as an obsolete alias but will be removed in +future versions. + +I =item B<-fade> I @@ -139,19 +140,20 @@ =item B<-tint> I Tint the transparent background pixmap with the given colour when -transparency is enabled with B<-tr> or B<-ip>. This only works for +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; resource +blue, red, green, cyan, magenta, yellow, and those close to them. Also +pure black and pure white colors essentially mean no tinting; resource I. Example: @@RXVT_NAME@@ -tr -tint blue -sh 40 =item B<-sh> I -Darken (0 .. 100) or lighten (-1 .. -100) the transparent +Darken (0 .. 100) or lighten (100 .. 200) the transparent background image in addition to (or instead of) tinting it; resource I. @@ -163,7 +165,7 @@ B, B, B - color values averaging, B, B, B, B, B, B, B, B, B, B, B, B. The default is -alpha-blending; resource I. +alpha-blending. Compile I; resource I. =item B<-blr> I @@ -171,7 +173,8 @@ background image. If 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. +on some backgrounds. Maximum radius value is 128. Compile I; +resource I. =item B<-bg> I @@ -181,9 +184,9 @@ Window foreground colour; resource B. -=item B<-pixmap> I +=item B<-pixmap> I -Compile I: Specify image file for the background and also +Compile 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. @@ -349,7 +352,7 @@ Compile I: Lines (pixel height) to insert between each row of the display. Useful to work around font rendering problems; resource -B. +B. =item B<-tn> I @@ -414,8 +417,8 @@ Change the meaning of triple-click selection with the left mouse button. Only effective when the original (non-perl) selection code is -in-use. Instead of selecting a full line it will extend the selection the -end of the logical line only. resource B. +in-use. Instead of selecting a full line it will extend the selection to +the end of the logical line only. resource B. =item B<-insecure> @@ -446,6 +449,19 @@ it exits. Instead, it will wait till it is being killed or closed by the user; resource B. +=item B<-xrm> I + +Works like the X Toolkit option of the same name, by adding the I +as if it were specified in a resource file. Resource values specified this +way take precedence over all other resource specifications. + +Note that you need to use the I syntax as in the .Xdefaults file, +e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific +options can be specified as long-options on the commandline, so use +of B<-xrm> is mostly limited to cases where you want to specify other +resources (e.g. for input methods) or for compatibility with other +programs. + =item B<-keysym.>I I Remap a key symbol. See resource B. @@ -489,7 +505,8 @@ yourself if you want that. As an extremely special case, specifying C<-1> will completely suppress -pty/tty operations. +pty/tty operations, which is probably only useful in conjunction with some +perl extension that manages the terminal. Here is a example in perl that illustrates how this option can be used (a longer example is in F): @@ -513,10 +530,11 @@ =back -=head1 RESOURCES (available also as long-options) +=head1 RESOURCES Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long -options) compiled into your version. +options) compiled into your version. All resources are also available as +long-options. You can set and change the resources using X11 tools like B. Many distribution do also load settings from the B<~/.Xresources> file when X @@ -528,6 +546,7 @@ 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 4. SCREEN_RESOURCES for the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- + 6. resources specified via -xrm on the commandline Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class names: B and B. The class name B allows resources @@ -639,14 +658,15 @@ 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 +=item B I -B: make the background inherit the parent windows' pixmap, giving -artificial transparency. B: do not inherit the parent windows' -pixmap. +Turn on/off illusion of a transparent window background. -I +B is still accepted as an obsolete alias but will be removed in +future versions. + +I =item B I @@ -673,7 +693,7 @@ =item B I -Apply Gaussian Blurr with the specified radius to the transparent +Apply Gaussian Blurr with the specified radius to the transparent background image; option B<-blr>. =item B I @@ -690,26 +710,35 @@ 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, -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. -Special string of B<"auto"> used as a geometry will cause image to be -automatically scaled to match window size. -If used in conjunction with B<-tr> option - specified pixmap will be -blended over transparency image using either alpha-blending, or any +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...>. +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 transparency image using either alpha-blending, or any other blending type, specified with B<-blt "type"> option. -[default 0x0+50+50] =item B I -Specify the colon-delimited search path for finding XPM files. +Specify the colon-delimited search path for finding background image files. =item B I @@ -918,7 +947,7 @@ Specifies the terminal type name to be set in the B environment variable; option B<-tn>. -=item B I +=item B I Specifies number of lines (pixel height) to insert between each row of the display [default 0]; option B<-lsp>. @@ -988,7 +1017,7 @@ When the selection extension is not used, only ISO-8859-1 characters can be used. If not specified, the built-in default is used: -B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> +B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> =item B I