--- rxvt-unicode/doc/rxvt.1.pod 2007/11/15 18:40:10 1.144 +++ rxvt-unicode/doc/rxvt.1.pod 2011/11/22 13:35:10 1.207 @@ -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 @@ -32,7 +35,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. @@ -91,15 +94,20 @@ =item B<-display> I -Attempt to open a window on the named X display (B<-d> still -respected). In the absence of this option, the display specified by the -B environment variable is used. +Attempt to open a window on the named X display (the older form B<-d> +is still respected. but deprecated). In the absence of this option, the +display specified by the B environment variable is used. =item B<-depth> I 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. @@ -118,15 +126,10 @@ =item B<-tr>|B<+tr> -Turn on/off illusion of a transparent window background. Obsolete form of it is -B<-ip> and it should not be used anymore; resource B. +Turn on/off pseudo-transparency by using the root pixmap as background; resource B. -I is obsolete and should be -changed to B. Backwards compatibility support for B will -be phased out in future versions of rxvt!> - -I +B<-ip> is still accepted as an obsolete alias but will be removed in +future versions. =item B<-fade> I @@ -141,30 +144,20 @@ =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 colors 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. +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 -transparency image, using method specified. Supported values are : -B, B, B - color values averaging, B, +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. @@ -172,12 +165,18 @@ =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 - 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; +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 +is used by many window managers, taskbars and pagers to represent the +application window; resource I. + =item B<-bg> I Window background colour; resource B. @@ -186,10 +185,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 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. @@ -246,7 +245,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. @@ -274,6 +273,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 @@ -290,15 +298,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 @@ -311,6 +310,10 @@ Blink the cursor; resource B. +=item B<-uc>|B<+uc> + +Make the cursor underlined; resource B. + =item B<-iconic> Start iconified, if the window manager supports that option. @@ -336,7 +339,8 @@ Compile I: Set MWM hints to request a borderless window, i.e. if honoured by the WM, the rxvt-unicode window will not have window -decorations; resource B. +decorations; resource B. If the window manager does not +support MWM hints (e.g. kwin), enables override-redirect mode. =item B<-override-redirect> @@ -356,6 +360,13 @@ the display. Useful to work around font rendering problems; resource B. +=item B<-letsp> I + +Compile I: Amount to adjust the computed character width by +to control overall letter spacing. Negative values will tighten up the +letter spacing, positive values will space letters out more. Useful to +work around odd font metrics; resource B. + =item B<-tn> I This option specifies the name of the terminal type to be set in the @@ -419,8 +430,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> @@ -451,6 +462,25 @@ it exits. Instead, it will wait till it is being killed or closed by the user; resource B. +=item B<-cd> I + +Sets the working directory for the shell (or the command specified via +B<-e>). The I must be an absolute path and it must exist for +@@RXVT_NAME@@ to start; 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. @@ -494,7 +524,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): @@ -518,21 +549,23 @@ =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 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 Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class names: B and B. The class name B allows resources @@ -552,6 +585,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]; @@ -574,7 +614,7 @@ high-intensity (bold = bright foreground, blink = bright background) colours. The canonical names are as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour -names used are listed in the B section. +names used are listed in the B section. Colours higher than 15 cannot be set using resources (yet), but can be changed using an escape command (see @@RXVT_NAME@@(7)). @@ -595,16 +635,21 @@ Use the specified colour to display underlined characters when the foreground colour is the default. -=item B I - -Use the specified colour as the background for reverse video characters -when OPTION_HC is disabled (--disable-frills). - =item B I If set, use the specified colour as the colour for the underline itself. If unset, use the foreground colour. +=item B I + +If set, use the specified colour as the background for highlighted +characters. If unset, use reverse video. + +=item B I + +If set and highlightColor is set, use the specified colour as the +foreground for highlighted characters. + =item B I Use the specified colour for the cursor. The default is to use the @@ -620,7 +665,7 @@ B: simulate reverse video by foreground and background colours; option B<-rv>. B: regular screen colours [default]; option -B<+rv>. See note in B section. +B<+rv>. See note in B section. =item B I @@ -644,14 +689,12 @@ 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 pseudo-transparency by using the root pixmap as background. -I +B is still accepted as an obsolete alias but will be removed in +future versions. =item B I @@ -664,13 +707,16 @@ =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>. +Darken (0 .. 99) or lighten (101 .. 200) the transparent background. +A value of 100 means no shading; option B<-sh>. =item B I @@ -678,8 +724,12 @@ =item B I -Apply Gaussian Blurr with the specified radius to the transparent -background image; option B<-blr>. +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>. =item B I @@ -695,31 +745,72 @@ 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 a colon separated list of operations to modify it. +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. The maximum permitted scale is 1000. -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. -Additional operations can be specified after colon B<:op1:op2...>. -Supported operations are: - B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0, - B<"propscale"> - will scale image keeping proportions, - B<"auto"> - will scale image to match window size. Equivalent to 100x100; - B<"hscale"> - will scale image horizontally to the window size; - B<"vscale"> - will scale image vertically to the window size; - B<"scale"> - will scale image to match window size; - B<"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 - 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 + +enables tiling + +=item B + +enables proportional 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=pscale + +=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 + +=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 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 @@ -756,7 +847,7 @@ The second font is just used to add additional unicode characters not in the base font, likewise the third, which is unfortunately non-bold, but -the bold version of the font does contain less characters, so this is a +the bold version of the font does contain fewer characters, so this is a useful supplement. The third font is an Xft font with aliasing turned off, and the characters @@ -790,23 +881,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. Only effective when the original (non-perl) -selection code is in use. - -=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 @@ -829,6 +908,8 @@ B: set the urgency hint for the wm on receipt of a bell character. B: do not set the urgency hint [default]. +@@RXVT_NAME@@ resets the urgency hint on every focus change. + =item B I B: use visual bell on receipt of a bell character; option B<-vb>. @@ -861,6 +942,15 @@ 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 + +Set the scrollbar width in pixels. + =item B I B: enable the scrollbar [default]; option B<-sb>. B: @@ -889,9 +979,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 @@ -957,6 +1048,11 @@ B: blink the cursor. B: do not blink the cursor [default]; option B<-bc>. +=item B I + +B: Make the cursor underlined. B: Make the cursor a box [default]; +option B<-uc>. + =item B I B: blank the pointer when a key is pressed or after a set number @@ -979,7 +1075,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. @@ -1002,7 +1098,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