--- rxvt-unicode/doc/rxvt.1.pod 2007/06/08 20:04:12 1.130 +++ rxvt-unicode/doc/rxvt.1.pod 2007/11/15 18:40:10 1.144 @@ -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,16 +110,23 @@ =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<-ip>|B<+ip> | B<-tr>|B<+tr> +=item B<-ss>|B<+ss> -Turn on/off inheriting parent window's pixmap. Alternative form is -B<-tr>; resource B. +Turn on/off skip scrolling (allow multiple screens per refresh); resource B. -I +=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. + +I is obsolete and should be +changed to B. Backwards compatibility support for B will +be phased out in future versions of rxvt!> + +I =item B<-fade> I @@ -135,33 +142,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> I +=item B<-sh> I -Darken (0 .. 100) or lighten (-1 .. -100) the transparent -background image in addition to (or instead of) tinting it; +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 +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 radius to the transparent -background image; resource I. +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 @@ -171,9 +186,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. @@ -339,7 +354,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 @@ -609,9 +624,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 @@ -647,7 +678,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 @@ -664,26 +695,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. +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, -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 +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 -Specify the colon-delimited search path for finding XPM files. +Specify the colon-delimited search path for finding background image files. =item B I @@ -892,7 +932,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>. @@ -1060,17 +1100,8 @@ keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of Is is not performed in an exact manner; however, the closest match is assured. -I may contain escape values (C<\a>: bell, C<\b>: backspace, -C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, -C<\000>: octal number) or verbatim control characters (C<^?>: delete, -C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it -can start or end with whitespace. B. - -Please note that you need to double the C<\> in resource files, as -Xlib itself does its own de-escaping (you can use C<\033> instead of -C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own -processing). +I may contain escape values (C<\n>: newline, C<\000>: octal +number), see RESOURCES in C for futher details. You can define a range of keysyms in one shot by providing a I with pattern B, where the delimiter `/' @@ -1204,6 +1235,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 @@ -1283,7 +1318,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>. @@ -1447,8 +1482,9 @@ =item B Either C, C, depending on whether @@RXVT_NAME@@ was -compiled with XPM support, and optionally with the added extension -C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. +compiled with background image support, and optionally with the added +extension C<-mono> to indicate that rxvt-unicode runs on a monochrome +screen. =item B @@ -1457,8 +1493,8 @@ C to indicate that the default-colour escape sequence is to be used), C is the colour code used as default background colour (or the string C), and C is the string C if @@RXVT_NAME@@ -was compiled with XPM support. Libraries like C and C can -(and do) use this information to optimize screen output. +was compiled with background image support. Libraries like C +and C can (and do) use this information to optimize screen output. =item B @@ -1559,7 +1595,7 @@ =item Geoff Wing L<< >> Rewrote screen display and text selection routines. - + Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) =item Marc Alexander Lehmann L<< >>