--- rxvt-unicode/doc/rxvt.1.pod 2007/05/16 22:37:10 1.128 +++ rxvt-unicode/doc/rxvt.1.pod 2008/01/26 14:24:42 1.161 @@ -14,12 +14,15 @@ configurability. As a result, B uses much less swap space -- a significant advantage on a machine serving many X sessions. +This document is also available on the World-Wide-Web at +L. + =head1 FREQUENTLY ASKED QUESTIONS See @@RXVT_NAME@@(7) (try C) for a list of frequently asked questions and answer to them and some common problems. That document is also accessible on the World-Wide-Web at -L. +L. =head1 RXVT-UNICODE VS. RXVT @@ -28,11 +31,11 @@ world. Being a terminal emulator, however, some things are very difficult, especially cursive scripts such as arabic, vertically written scripts like mongolian or scripts requiring extremely complex combining rules, -like tibetan or devenagari. Don't expect pretty output when using these +like tibetan or devanagari. Don't expect pretty output when using these 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. @@ -100,6 +103,11 @@ 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 +respect to C<-depth 32> and/or alpha channels, and will cause all sorts +of graphical corruption. This is harmless, but we can't do anything about +this, so watch out] + =item B<-geometry> I Window geometry (B<-g> still respected); resource B. @@ -110,16 +118,21 @@ =item B<-j>|B<+j> -Turn on/off jump scrolling; resource B. +Turn on/off jump scrolling (allow multiple lines per refresh); resource B. + +=item B<-ss>|B<+ss> + +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 @@ -135,18 +148,41 @@ =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; resource +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 colors essentially mean no tinting; resource I. Example: @@RXVT_NAME@@ -tr -tint blue -sh 40 -=item B<-sh> +=item B<-sh> I -I Darken (0 .. 100) or lighten (-1 .. -100) the transparent -background image in addition to tinting it (i.e. B<-tint> must be -specified, too, e.g. C<-tint white>); resource 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 - color 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 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. Compile I; +resource I. =item B<-bg> I @@ -156,12 +192,12 @@ Window foreground colour; resource B. -=item B<-pixmap> I +=item B<-pixmap> I -Compile I: Specify XPM 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 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; resource B. +command-line; for more details see resource B. =item B<-cr> I @@ -216,7 +252,7 @@ =item B<-is>|B<+is> -Compile I: Bold/Italic font styles imply high intensity +Compile I: Bold/Blink font styles imply high intensity foreground/background (default). See resource B for details. @@ -244,6 +280,15 @@ Turn on/off scrollbar; resource B. +=item B<-sr>|B<+sr> + +Put scrollbar on right/left; resource B. + +=item B<-st>|B<+st> + +Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; +resource B. + =item B<-si>|B<+si> Turn on/off scroll-to-bottom on TTY output inhibit; resource @@ -260,15 +305,6 @@ This only takes effect if B<-si> is also given; resource B. -=item B<-sr>|B<+sr> - -Put scrollbar on right/left; resource B. - -=item B<-st>|B<+st> - -Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; -resource B. - =item B<-ptab>|B<+ptab> If enabled (default), "Horizontal Tab" characters are being stored as @@ -324,7 +360,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 @@ -388,8 +424,9 @@ =item B<-tcw> Change the meaning of triple-click selection with the left mouse -button. Instead of selecting a full line it will extend the selection the -end of the logical line only. resource B. +button. Only effective when the original (non-perl) selection code is +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> @@ -420,6 +457,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. @@ -463,7 +513,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): @@ -487,10 +538,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 @@ -502,6 +554,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 @@ -521,6 +574,13 @@ Compile I: Attempt to find a visual with the given bit depth; option B<-depth>. +=item B I + +Compile I: Turn on/off double-buffering for xft (default enabled). +On some card/driver combination enabling it slightly decreases +performance, on most it greatly helps it. The slowdown is small, so it +should normally be enabled. + =item B I Create the window with the specified X window geometry [default 80x24]; @@ -593,18 +653,35 @@ =item B I -B: specify that jump scrolling should be used. When scrolling -quickly, fewer screen updates are performed [default]; option B<-j>. -B: specify that smooth scrolling should be used; option B<+j>. - -=item B I - -B: make the background inherit the parent windows' pixmap, giving -artificial transparency. B: do not inherit the parent windows' -pixmap. +B: specify that jump scrolling should be used. When receiving lots +of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines +has been read, resulting in fewer updates while still displaying every +received line; option B<-j>. -I +B: specify that smooth scrolling should be used. @@RXVT_NAME@@ will +force a screen refresh on each new line it received; option B<+j>. + +=item B I + +B: (the default) specify that skip scrolling should be used. When +receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while +(around 60 times per second), resulting in far fewer updates. This can +result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; +option B<-ss>. + +B: specify that everything is to be displayed, even +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 illusion of a transparent window background. + +B is still accepted as an obsolete alias but will be removed in +future versions. + +I =item B I @@ -625,6 +702,15 @@ 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>. + +=item B I + +Apply Gaussian Blurr with the specified radius to the transparent +background image; option B<-blr>. + =item B I Use the specified colour for the scrollbar [default #B2B2B2]. @@ -639,21 +725,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 XPM file (note the `.xpm' extension is optional) 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. [default 0x0+50+50] +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. =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 @@ -720,22 +820,11 @@ =item B I When font styles are not enabled, or this option is enabled (B, -option B<-is>, the default), bold and italic font styles imply high +option B<-is>, the default), bold/blink font styles imply high intensity foreground/background colours. Disabling this option (B, option B<+is>) disables this behaviour, the high intensity colours are not reachable. -=item B I - -Set mouse selection style to B which is 2.20, B which is -xterm style with 2.20 old word selection, or anything else which gives -xterm style selection. - -=item B I - -Set scrollbar style to B, B, B or B. B is -the author's favourite. - =item B I Set window title string, the default title is the command-line @@ -790,6 +879,11 @@ This creates a new file in your home directory with the screen contents every time you hit C. +=item B I + +Set scrollbar style to B, B, B or B. B is +the author's favourite. + =item B I B: enable the scrollbar [default]; option B<-sb>. B: @@ -861,7 +955,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>. @@ -923,15 +1017,15 @@ The characters used as delimiters for double-click word selection (whitespace delimiting is added automatically if resource is given). -When the selection extension is in use (the default if compiled in, see -the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters -will be created (if the resource exists, otherwise, no regex will be -created). In this mode, characters outside ISO-8859-1 can be used. +When the perl selection extension is in use (the default if compiled +in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these +characters will be created (if the resource exists, otherwise, no regex +will be created). In this mode, characters outside ISO-8859-1 can be used. 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