--- rxvt-unicode/doc/rxvt.1.pod 2007/11/15 18:40:10 1.144 +++ rxvt-unicode/doc/rxvt.1.pod 2008/01/23 14:34:00 1.159 @@ -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. @@ -118,12 +121,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 illusion of a transparent window 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!> +B<-ip> is still accepted as an obsolete alias but will be removed in +future versions. I @@ -246,7 +247,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 +275,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 +300,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 @@ -419,8 +420,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 +452,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. @@ -494,7 +508,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,10 +533,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 @@ -533,6 +549,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 @@ -644,14 +661,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 + +Turn on/off illusion of a transparent window background. -B: make the background inherit the parent windows' pixmap, giving -artificial transparency. B: do not inherit the parent windows' -pixmap. +B is still accepted as an obsolete alias but will be removed in +future versions. -I +I =item B I @@ -697,29 +715,29 @@ =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. -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. +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 - specified pixmap will be +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 @@ -790,23 +808,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 @@ -861,6 +867,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: @@ -1002,7 +1013,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