--- rxvt-unicode/doc/rxvt.1.pod 2007/01/19 23:45:03 1.125 +++ rxvt-unicode/doc/rxvt.1.pod 2007/09/01 09:38:50 1.137 @@ -28,7 +28,7 @@ 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 @@ -110,7 +110,11 @@ =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> @@ -137,16 +141,37 @@ Tint the transparent background pixmap with the given colour when transparency is enabled with B<-tr> or B<-ip>. 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; 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 (-1 .. -100) 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; 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; resource I. =item B<-bg> I @@ -158,10 +183,10 @@ =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 @@ -324,7 +349,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,7 +413,8 @@ =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 +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. =item B<-insecure> @@ -593,9 +619,25 @@ =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>. +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>. + +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 @@ -625,6 +667,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]. @@ -641,15 +692,20 @@ =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, +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 +other blending type, specified with B<-blt "type"> option. +[default 0x0+50+50] =item B I @@ -727,9 +783,10 @@ =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. +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 @@ -753,6 +810,11 @@ B: de-iconify (map) on receipt of a bell character. B: no de-iconify (map) on receipt of a bell character [default]. +=item B I + +B: set the urgency hint for the wm on receipt of a bell character. +B: do not set the urgency hint [default]. + =item B I B: use visual bell on receipt of a bell character; option B<-vb>. @@ -856,7 +918,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>. @@ -918,10 +980,10 @@ 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: @@ -990,7 +1052,7 @@ =item B I -Turn on/off secondary screen scroll (default enabled). If the this +Turn on/off secondary screen scroll (default enabled). If this option is enabled, scrolls on the secondary screen will change the scrollback buffer and switching to/from the secondary screen will instead scroll the screen up. @@ -1168,6 +1230,10 @@ Compile I: Sets override-redirect for the terminal window, making it almost invisible to window managers; option B<-override-redirect>. +=item B I + +Turn on/off ISO 14755 5.2 mode (default enabled). + =back =head1 THE SCROLLBAR @@ -1195,14 +1261,14 @@ up and down arrows sends B (Up) and B (Down), respectively. -=head1 TEXT SELECTION AND INSERTION +=head1 THE SELECTION: SELECTING AND PASTING TEXT -The behaviour of text selection and insertion mechanism is similar to -I(1). +The behaviour of text selection and insertion/pasting mechanism is similar +to I(1). =over 4 -=item B: +=item B: Left click at the beginning of the region, drag to the end of the region and release; Right click to extend the marked region; Left double-click @@ -1216,11 +1282,11 @@ selection, and trailing whitespace is visually underlined and removed from the selection. -=item B: +=item B: Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> window causes the value of the PRIMARY selection (or CLIPBOARD with the -Meta modifier) to be inserted as if it had been typed on the keyboard. +B modifier) to be inserted as if it had been typed on the keyboard. Pressing B causes the value of the PRIMARY selection to be inserted too. @@ -1247,7 +1313,7 @@ ISO 14755 is a standard for entering and viewing unicode characters and character codes using the keyboard. It consists of 4 parts. The -first part is available rxvt-unicode has been compiled with +first part is available if rxvt-unicode has been compiled with C<--enable-frills>, the rest is available when rxvt-unicode was compiled with C<--enable-iso14755>.