--- rxvt-unicode/doc/rxvt.1.txt 2006/11/02 17:37:47 1.63 +++ rxvt-unicode/doc/rxvt.1.txt 2007/06/24 22:12:18 1.67 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 8.0, is a colour vt102 terminal emulator intended + rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended as an *xterm*(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- a significant @@ -97,7 +97,12 @@ Turn on/off simulated reverse video; resource reverseVideo. -j|+j - Turn on/off jump scrolling; resource jumpScroll. + Turn on/off jump scrolling (allow multiple lines per refresh); + resource jumpScroll. + + -ss|+ss + Turn on/off skip scrolling (allow multiple screens per refresh); + resource skipScroll. -ip|+ip | -tr|+tr Turn on/off inheriting parent window's pixmap. Alternative form is @@ -125,9 +130,21 @@ rxvt -tr -tint blue -sh 40 - -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent - background image in addition to tinting it (i.e. -tint must be - specified, too, e.g. "-tint white"). + -sh *number* + Darken (0 .. 100) or lighten (-1 .. -100) the transparent background + image in addition to (or instead of) tinting it; resource *shading*. + + -blt *string* + 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 : + add, alphablend, allanon - color values averaging, colorize, darken, + diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint, + value. The default is alpha-blending; resource *blendType*. + + -blr *number* + Apply Gaussian Blur with the specified radius to the transparent + background image; resource *blurRadius*. -bg *colour* Window background colour; resource background. @@ -136,10 +153,10 @@ Window foreground colour; resource foreground. -pixmap *file[;geom]* - Compile *XPM*: Specify XPM file for the background and also + Compile *afterimage*: 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 ";" - in the command-line; resource backgroundPixmap. + in the command-line; for more details see resource backgroundPixmap. -cr *colour* The cursor colour; resource cursorColor. @@ -329,7 +346,8 @@ -tcw Change the meaning of triple-click selection with the left mouse - button. Instead of selecting a full line it will extend 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 tripleclickwords. @@ -486,7 +504,7 @@ colorRV: *colour* Use the specified colour as the background for reverse video - characters. + characters when OPTION_HC is disabled (--disable-frills). underlineColor: *colour* If set, use the specified colour as the colour for the underline @@ -507,9 +525,24 @@ note in COLORS AND GRAPHICS section. jumpScroll: *boolean* - True: specify that jump scrolling should be used. When scrolling - quickly, fewer screen updates are performed [default]; option -j. - False: specify that smooth scrolling should be used; option +j. + True: specify that jump scrolling should be used. When receiving + lots of lines, rxvt will only scroll once a whole screen height of + lines has been read, resulting in fewer updates while still + displaying every received line; option -j. + + False: specify that smooth scrolling should be used. rxvt will force + a screen refresh on each new line it received; option +j. + + skipScroll: *boolean* + True: (the default) specify that skip scrolling should be used. When + receiving lots of lines, rxvt will only scroll once in a while + (around 60 times per second), resulting in far fewer updates. This + can result in rxvt not ever displaying some of the lines it + receives; option -ss. + + False: 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 +ss. inheritPixmap: *boolean* True: make the background inherit the parent windows' pixmap, giving @@ -533,7 +566,14 @@ shading: *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent background - image in addition to tinting it. + image in addition to tinting it; option -sh. + + blendType: *string* + Specify background blending type; option -blt. + + blurRadius: *number* + Apply Gaussian Blurr with the specified radius to the transparent + background image; option -blr. scrollColor: *colour* Use the specified colour for the scrollbar [default #B2B2B2]. @@ -547,15 +587,19 @@ scrollbar and the text. backgroundPixmap: *file[;geom]* - Use the specified XPM file (note the `.xpm' extension is optional) - for the background and also optionally specify its scaling with a - geometry string WxH+X+Y, in which "W" / "H" specify the - horizontal/vertical scale (percent) and "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 WxH+X+Y, in which "W" / + "H" specify the horizontal/vertical scale (percent), and "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 "auto" + used as a geometry will cause image to be automatically scaled to + match window size. If used in conjunction with -tr option - + specified pixmap will be blended over transparency image using + either alpha-blending, or any other blending type, specified with + -blt "type" option. [default 0x0+50+50] path: *path* Specify the colon-delimited search path for finding XPM files. @@ -632,7 +676,8 @@ selectstyle: *mode* Set mouse selection style to old which is 2.20, oldword which is xterm style with 2.20 old word selection, or anything else which - gives xterm style selection. + gives xterm style selection. Only effective when the original + (non-perl) selection code is in use. scrollstyle: *mode* Set scrollbar style to rxvt, plain, next or xterm. plain is the @@ -652,6 +697,10 @@ True: de-iconify (map) on receipt of a bell character. False: no de-iconify (map) on receipt of a bell character [default]. + urgentOnBell: *boolean* + True: set the urgency hint for the wm on receipt of a bell + character. False: do not set the urgency hint [default]. + visualBell: *boolean* True: use visual bell on receipt of a bell character; option -vb. False: no visual bell [default]; option +vb. @@ -789,8 +838,8 @@ 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 rxvtperl(3) manpage), a suitable regex using these + When the perl selection extension is in use (the default if compiled + in, see the rxvtperl(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. @@ -852,7 +901,7 @@ Turn on/off secondary screen (default enabled). secondaryScroll: *boolean* - 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. @@ -1010,7 +1059,7 @@ urlLauncher: *string* Specifies the program to be started with a URL argument. Used by the - "selection-popup" and "mark-urls" perl extensions. + "selection-popup" and "matcher" perl extensions. transient-for: *windowid* Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given @@ -1021,6 +1070,9 @@ making it almost invisible to window managers; option -override-redirect. + iso14755_52: *boolean* + Turn on/off ISO 14755 5.2 mode (default enabled). + THE SCROLLBAR Lines of text that scroll off the top of the rxvt window (resource: saveLines) and can be scrolled back using the scrollbar or by @@ -1043,11 +1095,11 @@ (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. -TEXT SELECTION AND INSERTION - The behaviour of text selection and insertion mechanism is similar to - *xterm*(1). +THE SELECTION: SELECTING AND PASTING TEXT + The behaviour of text selection and insertion/pasting mechanism is + similar to *xterm*(1). - Selection: + Selecting: 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 to select a word; Left triple-click to select the @@ -1060,7 +1112,7 @@ the selection, and trailing whitespace is visually underlined and removed from the selection. - Insertion: + Pasting: Pressing and releasing the Middle mouse button in an rxvt 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 @@ -1204,8 +1256,9 @@ digits/component) colour specifications, in addition to the ones provided by X, where the additional A component specifies opacity (alpha) values. The minimum value of 0 is completely transparent). You - can also prefix any color with "[a]", where "a" is on to four hex digits - specifiying the opacity value. + can also prefix any color with "[percent]", where "percent" is a decimal + percentage (0-100) that specifies the opacity of the color, where 0 is + completely transparent and 100 is completelxy opaque. You probably need to specify "-depth 32", too, and have the luck that your X-server uses ARGB pixel layout, as X is far from just supporting @@ -1214,7 +1267,7 @@ For example, the following selects an almost completely transparent red background, and an almost opaque pink foreground: - rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" + rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" *Please note that transparency of any kind if completely unsupported by the author. Don't bug him with installation questions!*