--- rxvt-unicode/doc/rxvt.1.man.in 2006/08/07 16:17:30 1.63 +++ rxvt-unicode/doc/rxvt.1.man.in 2008/01/25 18:43:47 1.80 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04) +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== @@ -25,11 +25,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +48,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +132,11 @@ .\" ======================================================================== .\" .IX Title "@@RXVT_NAME@@ 1" -.TH @@RXVT_NAME@@ 1 "2006-08-07" "7.9" "RXVT-UNICODE" +.TH @@RXVT_NAME@@ 1 "2008-01-25" "9.0" "RXVT-UNICODE" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) .SH "SYNOPSIS" @@ -142,12 +149,15 @@ require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- a significant advantage on a machine serving many X sessions. +.PP +This document is also available on the World-Wide-Web at +. .SH "FREQUENTLY ASKED QUESTIONS" .IX Header "FREQUENTLY ASKED QUESTIONS" See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) 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 -. +. .SH "RXVT-UNICODE VS. RXVT" .IX Header "RXVT-UNICODE VS. RXVT" Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode @@ -155,11 +165,11 @@ 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: \fBrxvt-unicode\fR 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. .PP @@ -194,7 +204,7 @@ .IX Header "OPTIONS" The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed below. In keeping with the smaller-is-better philosophy, options may be -eliminated or default values chosen at compile\-time, so options and +eliminated or default values chosen at compile-time, so options and defaults listed may not accurately reflect the version installed on your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on the \fIOptions\fR line. Option descriptions may be prefixed with which @@ -220,6 +230,11 @@ .IX Item "-depth bitdepth" Compile \fIxft\fR: Attempt to find a visual with the given bit depth; resource \fBdepth\fR. +.Sp +[Please note that many X servers (and libXft) are buggy with +respect to \f(CW\*(C`\-depth 32\*(C'\fR 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] .IP "\fB\-geometry\fR \fIgeom\fR" 4 .IX Item "-geometry geom" Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. @@ -228,15 +243,19 @@ Turn on/off simulated reverse video; resource \fBreverseVideo\fR. .IP "\fB\-j\fR|\fB+j\fR" 4 .IX Item "-j|+j" -Turn on/off jump scrolling; resource \fBjumpScroll\fR. -.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 -.IX Item "-ip|+ip | -tr|+tr" -Turn on/off inheriting parent window's pixmap. Alternative form is -\&\fB\-tr\fR; resource \fBinheritPixmap\fR. -.Sp -\&\fIPlease note that transparency of any kind if completely unsupported by -the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 -@@RXVT_NAME@@)!\fR +Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR. +.IP "\fB\-ss\fR|\fB+ss\fR" 4 +.IX Item "-ss|+ss" +Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. +.IP "\fB\-tr\fR|\fB+tr\fR" 4 +.IX Item "-tr|+tr" +Turn on/off illusion of a transparent window background; resource \fBtransparent\fR. +.Sp +\&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in +future versions. +.Sp +\&\fIPlease address all transparency related issues to Sasha Vasko at +sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR .IP "\fB\-fade\fR \fInumber\fR" 4 .IX Item "-fade number" Fade the text by the given percentage when focus is lost. Small values @@ -249,31 +268,52 @@ .IP "\fB\-tint\fR \fIcolour\fR" 4 .IX Item "-tint colour" Tint the transparent background pixmap with the given colour when -transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for +transparency is enabled with \fB\-tr\fR. This only works for non-tiled backgrounds, currently. See also the \fB\-sh\fR 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 \&\fItintColor\fR. Example: .Sp .Vb 1 \& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 .Ve -.IP "\fB\-sh\fR" 4 -.IX Item "-sh" -\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent -background image in addition to tinting it (i.e. \fB\-tint\fR must be -specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). +.IP "\fB\-sh\fR \fInumber\fR" 4 +.IX Item "-sh number" +Darken (0 .. 100) or lighten (100 .. 200) the transparent +background image in addition to (or instead of) tinting it; +resource \fIshading\fR. +.IP "\fB\-blt\fR \fIstring\fR" 4 +.IX Item "-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 : +\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR, +\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, +\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is +alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR. +.IP "\fB\-blr\fR \fIHxV\fR" 4 +.IX Item "-blr HxV" +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 \fIafterimage\fR; +resource \fIblurRadius\fR. .IP "\fB\-bg\fR \fIcolour\fR" 4 .IX Item "-bg colour" Window background colour; resource \fBbackground\fR. .IP "\fB\-fg\fR \fIcolour\fR" 4 .IX Item "-fg colour" Window foreground colour; resource \fBforeground\fR. -.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 -.IX Item "-pixmap file[;geom]" -Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally -specify its scaling with a geometry string. Note you may need to +.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4 +.IX Item "-pixmap file[;geom[:op1][:op2][...]]" +Compile \fIafterimage\fR: 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 \f(CW\*(C`;\*(C'\fR in the -command\-line; resource \fBbackgroundPixmap\fR. +command-line; for more details see resource \fBbackgroundPixmap\fR. .IP "\fB\-cr\fR \fIcolour\fR" 4 .IX Item "-cr colour" The cursor colour; resource \fBcursorColor\fR. @@ -296,7 +336,7 @@ font list is always appended to it. See resource \fBfont\fR for more details. .Sp In short, to specify an X11 core font, just specify its name or prefix it -with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, +with \f(CW\*(C`x:\*(C'\fR. To specify an XFT-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, e.g.: .Sp .Vb 2 @@ -321,7 +361,7 @@ for details. .IP "\fB\-is\fR|\fB+is\fR" 4 .IX Item "-is|+is" -Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity +Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity foreground/background (default). See resource \fBintensityStyles\fR for details. .IP "\fB\-name\fR \fIname\fR" 4 @@ -343,6 +383,13 @@ .IP "\fB\-sb\fR|\fB+sb\fR" 4 .IX Item "-sb|+sb" Turn on/off scrollbar; resource \fBscrollBar\fR. +.IP "\fB\-sr\fR|\fB+sr\fR" 4 +.IX Item "-sr|+sr" +Put scrollbar on right/left; resource \fBscrollBar_right\fR. +.IP "\fB\-st\fR|\fB+st\fR" 4 +.IX Item "-st|+st" +Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; +resource \fBscrollBar_floating\fR. .IP "\fB\-si\fR|\fB+si\fR" 4 .IX Item "-si|+si" Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource @@ -356,13 +403,6 @@ Turn on/off scrolling with the scrollback buffer as new lines appear. This only takes effect if \fB\-si\fR is also given; resource \&\fBscrollWithBuffer\fR. -.IP "\fB\-sr\fR|\fB+sr\fR" 4 -.IX Item "-sr|+sr" -Put scrollbar on right/left; resource \fBscrollBar_right\fR. -.IP "\fB\-st\fR|\fB+st\fR" 4 -.IX Item "-st|+st" -Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; -resource \fBscrollBar_floating\fR. .IP "\fB\-ptab\fR|\fB+ptab\fR" 4 .IX Item "-ptab|+ptab" If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as @@ -409,7 +449,7 @@ .IX Item "-lsp number" Compile \fIfrills\fR: Lines (pixel height) to insert between each row of the display. Useful to work around font rendering problems; resource -\&\fBlinespace\fR. +\&\fBlineSpace\fR. .IP "\fB\-tn\fR \fItermname\fR" 4 .IX Item "-tn termname" This option specifies the name of the terminal type to be set in the @@ -422,7 +462,7 @@ window; also sets the window title and icon name to be the basename of the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are given on the command line. If this option is used, it must be the last -on the command\-line. If there is no \fB\-e\fR option then the default is to +on the command-line. If there is no \fB\-e\fR option then the default is to run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, failing that, \fI\fIsh\fI\|(1)\fR. .Sp @@ -465,8 +505,9 @@ .IP "\fB\-tcw\fR" 4 .IX Item "-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 -end of the logical line only. resource \fBtripleclickwords\fR. +button. Only effective when the original (non-perl) selection code is +in-use. Instead of selecting a full line it will extend the selection to +the end of the logical line only. resource \fBtripleclickwords\fR. .IP "\fB\-insecure\fR" 4 .IX Item "-insecure" Enable \*(L"insecure\*(R" mode, which currently enables most of the escape @@ -491,6 +532,18 @@ will not immediately destroy its window when the program executed within it exits. Instead, it will wait till it is being killed or closed by the user; resource \fBhold\fR. +.IP "\fB\-xrm\fR \fIstring\fR" 4 +.IX Item "-xrm string" +Works like the X Toolkit option of the same name, by adding the \fIstring\fR +as if it were specified in a resource file. Resource values specified this +way take precedence over all other resource specifications. +.Sp +Note that you need to use the \fIsame\fR syntax as in the .Xdefaults file, +e.g. \f(CW\*(C`*.background: black\*(C'\fR. Also note that all @@RXVT_NAME@@\-specific +options can be specified as long-options on the commandline, so use +of \fB\-xrm\fR is mostly limited to cases where you want to specify other +resources (e.g. for input methods) or for compatibility with other +programs. .IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 .IX Item "-keysym.sym string" Remap a key symbol. See resource \fBkeysym\fR. @@ -534,7 +587,8 @@ yourself if you want that. .Sp As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress -pty/tty operations. +pty/tty operations, which is probably only useful in conjunction with some +perl extension that manages the terminal. .Sp Here is a example in perl that illustrates how this option can be used (a longer example is in \fIdoc/pty\-fd\fR): @@ -556,22 +610,24 @@ .IX Item "-pe string" Comma-separated list of perl extension scripts to use (or not to use) in this terminal instance. See resource \fBperl-ext\fR for details. -.SH "RESOURCES (available also as long\-options)" -.IX Header "RESOURCES (available also as long-options)" +.SH "RESOURCES" +.IX Header "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. .PP You can set and change the resources using X11 tools like \fBxrdb\fR. Many distribution do also load settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@ will consult the following files/resources in order, with later settings overwriting earlier ones: .PP -.Vb 5 +.Vb 6 \& 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 \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\- +\& 6. resources specified via \-xrm on the commandline .Ve .PP Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class @@ -629,8 +685,8 @@ foreground colour is the default. .IP "\fBcolorRV:\fR \fIcolour\fR" 4 .IX Item "colorRV: colour" -Use the specified colour as the background for reverse video -characters. +Use the specified colour as the background for reverse video characters +when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills). .IP "\fBunderlineColor:\fR \fIcolour\fR" 4 .IX Item "underlineColor: colour" If set, use the specified colour as the colour for the underline @@ -651,17 +707,33 @@ \&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. .IP "\fBjumpScroll:\fR \fIboolean\fR" 4 .IX Item "jumpScroll: boolean" -\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling -quickly, fewer screen updates are performed [default]; option \fB\-j\fR. -\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. -.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 -.IX Item "inheritPixmap: boolean" -\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving -artificial transparency. \fBFalse\fR: do not inherit the parent windows' -pixmap. +\&\fBTrue\fR: 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 \fB\-j\fR. +.Sp +\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will +force a screen refresh on each new line it received; option \fB+j\fR. +.IP "\fBskipScroll:\fR \fIboolean\fR" 4 +.IX Item "skipScroll: boolean" +\&\fBTrue\fR: (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 \fB\-ss\fR. +.Sp +\&\fBFalse\fR: 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 \fB+ss\fR. +.IP "\fBtransparent:\fR \fIboolean\fR" 4 +.IX Item "transparent: boolean" +Turn on/off illusion of a transparent window background. .Sp -\&\fIPlease note that transparency of any kind if completely unsupported by -the author. Don't bug him with installation questions!\fR +\&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in +future versions. +.Sp +\&\fIPlease address all transparency related issues to Sasha Vasko at +sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR .IP "\fBfading:\fR \fInumber\fR" 4 .IX Item "fading: number" Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. @@ -675,8 +747,15 @@ \&\fB\-tint\fR. .IP "\fBshading:\fR \fInumber\fR" 4 .IX Item "shading: number" -Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background -image in addition to tinting it. +Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image +in addition to tinting it; option \fB\-sh\fR. +.IP "\fBblendType:\fR \fIstring\fR" 4 +.IX Item "blendType: string" +Specify background blending type; option \fB\-blt\fR. +.IP "\fBblurRadius:\fR \fInumber\fR" 4 +.IX Item "blurRadius: number" +Apply Gaussian Blurr with the specified radius to the transparent +background image; option \fB\-blr\fR. .IP "\fBscrollColor:\fR \fIcolour\fR" 4 .IX Item "scrollColor: colour" Use the specified colour for the scrollbar [default #B2B2B2]. @@ -688,20 +767,36 @@ .IX Item "borderColor: colour" The colour of the border around the text area and between the scrollbar and the text. -.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 -.IX Item "backgroundPixmap: file[;geom]" -Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for -the background and also optionally specify its scaling with a geometry -string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the -horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR 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] +.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4 +.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]" +Use the specified image file for the background and also +optionally specify its scaling with a geometry string \fBWxH+X+Y\fR, +(default \f(CW\*(C`0x0+50+50\*(C'\fR) in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the +horizontal/vertical scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR 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 \fB:op1:op2...\fR. +Supported operations are: +.Sp +.Vb 8 +\& 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 +.Ve +.Sp +If used in conjunction with \fB\-tr\fR option, the specified pixmap will be +blended over transparency image using either alpha-blending, or any +other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option. .IP "\fBpath:\fR \fIpath\fR" 4 .IX Item "path: path" -Specify the colon-delimited search path for finding \s-1XPM\s0 files. +Specify the colon-delimited search path for finding background image files. .IP "\fBfont:\fR \fIfontlist\fR" 4 .IX Item "font: fontlist" Select the fonts to be used. This is a comma separated list of font names @@ -734,7 +829,7 @@ wide and 15 pixels high. .Sp 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 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 useful supplement. .Sp @@ -755,7 +850,7 @@ The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold italic\fB\fR characters, respectively. .Sp -If specified and non\-empty, then the syntax is the same as for the +If specified and non-empty, then the syntax is the same as for the \&\fBfont\fR\-resource, and the given font list will be used as is, which makes it possible to substitute completely different font styles for bold and italic. @@ -769,19 +864,10 @@ .IP "\fBintensityStyles:\fR \fIboolean\fR" 4 .IX Item "intensityStyles: boolean" When font styles are not enabled, or this option is enabled (\fBTrue\fR, -option \fB\-is\fR, the default), bold and italic font styles imply high +option \fB\-is\fR, the default), bold/blink font styles imply high intensity foreground/background colours. Disabling this option (\fBFalse\fR, option \fB+is\fR) disables this behaviour, the high intensity colours are not reachable. -.IP "\fBselectstyle:\fR \fImode\fR" 4 -.IX Item "selectstyle: mode" -Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is -xterm style with 2.20 old word selection, or anything else which gives -xterm style selection. -.IP "\fBscrollstyle:\fR \fImode\fR" 4 -.IX Item "scrollstyle: mode" -Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is -the author's favourite. .IP "\fBtitle:\fR \fIstring\fR" 4 .IX Item "title: string" Set window title string, the default title is the command-line @@ -796,6 +882,10 @@ .IX Item "mapAlert: boolean" \&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no de-iconify (map) on receipt of a bell character [default]. +.IP "\fBurgentOnBell:\fR \fIboolean\fR" 4 +.IX Item "urgentOnBell: boolean" +\&\fBTrue\fR: set the urgency hint for the wm on receipt of a bell character. +\&\fBFalse\fR: do not set the urgency hint [default]. .IP "\fBvisualBell:\fR \fIboolean\fR" 4 .IX Item "visualBell: boolean" \&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. @@ -810,13 +900,13 @@ \&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR [default]; option \fB+ut\fR. -.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 +.IP "\fBprint-pipe:\fR \fIstring\fR" 4 .IX Item "print-pipe: string" Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or \&\fBShift-Print\fR to include the scrollback as well. .Sp -The string will be interpreted as if typed into the shell as\-is. +The string will be interpreted as if typed into the shell as-is. .Sp Example: .Sp @@ -826,6 +916,10 @@ .Sp This creates a new file in your home directory with the screen contents every time you hit \f(CW\*(C`Print\*(C'\fR. +.IP "\fBscrollstyle:\fR \fImode\fR" 4 +.IX Item "scrollstyle: mode" +Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is +the author's favourite. .IP "\fBscrollBar:\fR \fIboolean\fR" 4 .IX Item "scrollBar: boolean" \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: @@ -884,8 +978,8 @@ .IX Item "termName: termname" Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment variable; option \fB\-tn\fR. -.IP "\fBlinespace:\fR \fInumber\fR" 4 -.IX Item "linespace: number" +.IP "\fBlineSpace:\fR \fInumber\fR" 4 +.IX Item "lineSpace: number" Specifies number of lines (pixel height) to insert between each row of the display [default 0]; option \fB\-lsp\fR. .IP "\fBmeta8:\fR \fIboolean\fR" 4 @@ -935,15 +1029,15 @@ The characters used as delimiters for double-click word selection (whitespace delimiting is added automatically if resource is given). .Sp -When the selection extension is in use (the default if compiled in, see -the @@RXVT_NAME@@\fIperl\fR\|(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 \s-1ISO\-8859\-1\s0 can be used. +When the perl selection extension is in use (the default if compiled +in, see the @@RXVT_NAME@@\fIperl\fR\|(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 \s-1ISO\-8859\-1\s0 can be used. .Sp When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can be used. If not specified, the built-in default is used: .Sp -\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR +\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR .IP "\fBpreeditType:\fR \fIstyle\fR" 4 .IX Item "preeditType: style" \&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. @@ -980,7 +1074,7 @@ sequences enabled by default, which doesn't make it safer, though). .Sp You can enable them by setting this boolean resource or specifying -\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer, +\&\fB\-insecure\fR as an option. At the moment, this enables display-answer, locale, findfont, icon label and window title requests. .IP "\fBmodifier:\fR \fImodifier\fR" 4 .IX Item "modifier: modifier" @@ -989,7 +1083,7 @@ \&\fB\-mod\fR. .IP "\fBanswerbackString:\fR \fIstring\fR" 4 .IX Item "answerbackString: string" -Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) +Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control-E) character is passed through. It may contain escape values as described in the entry on \fBkeysym\fR following. .IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 @@ -997,7 +1091,7 @@ Turn on/off secondary screen (default enabled). .IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4 .IX Item "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. @@ -1029,16 +1123,8 @@ keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not performed in an exact manner; however, the closest match is assured. .Sp -\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, -\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, -\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, -\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it -can start or end with whitespace. -.Sp -Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as -Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of -\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own -processing). +\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal +number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details. .Sp You can define a range of keysyms in one shot by providing a \fIstring\fR with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' @@ -1159,18 +1245,18 @@ .IX Item "selection.pattern-idx: perl-regex" Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for details. -.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4 +.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4 .IX Item "selection-autotransform.idx: perl-transform" Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for details. -.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4 +.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4 .IX Item "searchable-scrollback: keysym" Sets the hotkey that starts the incremental scrollback buffer search (default: \f(CW\*(C`M\-s\*(C'\fR). .IP "\fBurlLauncher\fR: \fIstring\fR" 4 .IX Item "urlLauncher: string" Specifies the program to be started with a \s-1URL\s0 argument. Used by the -\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions. +\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions. .IP "\fBtransient-for\fR: \fIwindowid\fR" 4 .IX Item "transient-for: windowid" Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. @@ -1178,6 +1264,9 @@ .IX Item "override-redirect: boolean" Compile \fIfrills\fR: Sets override-redirect for the terminal window, making it almost invisible to window managers; option \fB\-override\-redirect\fR. +.IP "\fBiso14755_52:\fR \fIboolean\fR" 4 +.IX Item "iso14755_52: boolean" +Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled). .SH "THE SCROLLBAR" .IX Header "THE SCROLLBAR" Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window @@ -1201,12 +1290,12 @@ (Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down), respectively. -.SH "TEXT SELECTION AND INSERTION" -.IX Header "TEXT SELECTION AND INSERTION" -The behaviour of text selection and insertion mechanism is similar to -\&\fIxterm\fR(1). -.IP "\fBSelection\fR:" 4 -.IX Item "Selection:" +.SH "THE SELECTION: SELECTING AND PASTING TEXT" +.IX Header "THE SELECTION: SELECTING AND PASTING TEXT" +The behaviour of text selection and insertion/pasting mechanism is similar +to \fIxterm\fR(1). +.IP "\fBSelecting\fR:" 4 +.IX Item "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 entire logical line @@ -1218,23 +1307,23 @@ normal one. In this mode, every selected row becomes its own line in the selection, and trailing whitespace is visually underlined and removed from the selection. -.IP "\fBInsertion\fR:" 4 -.IX Item "Insertion:" +.IP "\fBPasting\fR:" 4 +.IX Item "Pasting:" Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the -Meta modifier) to be inserted as if it had been typed on the keyboard. +\&\fBMeta\fR modifier) to be inserted as if it had been typed on the keyboard. .Sp Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be inserted too. .SH "CHANGING FONTS" .IX Header "CHANGING FONTS" Changing fonts (or font sizes, respectively) via the keypad is not yet -supported in rxvt\-unicode. Bug me if you need this. +supported in rxvt-unicode. Bug me if you need this. .PP You can, however, switch fonts at runtime using escape sequences, e.g.: .PP .Vb 1 -\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic" +\& printf \*(Aq\ee]710;%s\e007\*(Aq "9x15bold,xft:Kochi Gothic" .Ve .PP You can use keyboard shortcuts, too: @@ -1249,7 +1338,7 @@ .IX Header "ISO 14755 SUPPORT" \&\s-1ISO\s0 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 \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. .IP "\(bu" 4 @@ -1281,7 +1370,7 @@ keycap symbol. The symbol will only be entered when the key has been released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for \&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a -reverse tab (Shift\-Tab). +reverse tab (Shift-Tab). .IP "\(bu" 4 5.3: Screen-selection entry method .Sp @@ -1364,26 +1453,50 @@ .Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0" .IX Subsection "ALPHA CHANNEL SUPPORT" If Xft support has been compiled in and as long as Xft/Xrender/X don't get -their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR -(recommended, but \fB\s-1MUST\s0\fR have 4 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 \f(CW0\fR is completely -transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on -to four hex digits specifiying the opacity value. -.PP -You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that -your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting -\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around. +their act together, rxvt-unicode will do it's own alpha channel management: +.PP +You can prefix any color with an opaquenes percentage enclosed in +brackets, i.e. \f(CW\*(C`[percent]\*(C'\fR, where \f(CW\*(C`percent\*(C'\fR is a decimal percentage +(0\-100) that specifies the opacity of the color, where \f(CW0\fR is completely +transparent and \f(CW100\fR is completely opaque. For example, \f(CW\*(C`[50]red\*(C'\fR is a +half-transparent red, while \f(CW\*(C`[95]#00ff00\*(C'\fR is an almost opaque green. This +is the recommended format to specify transparency values, and works with +all ways to specify a colour. +.PP +For complete control, rxvt-unicode also supports +\&\f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR (exactly four hex digits/component) colour +specifications, where the additional \f(CW\*(C`aaaa\*(C'\fR component specifies opacity +(alpha) values. The minimum value of \f(CW0000\fR is completely transparent, +while \f(CW\*(C`ffff\*(C'\fR is completely opaque). The two example colours from +earlier could also be specified as \f(CW\*(C`rgba:ff00/0000/0000/8000\*(C'\fR and +\&\f(CW\*(C`rgba:0000/ff00/0000/f332\*(C'\fR. +.PP +You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, to force a visual with +alpha channels, and have the luck that your X\-server uses \s-1ARGB\s0 pixel +layout, as X is far from just supporting \s-1ARGB\s0 visuals out of the box, and +rxvt-unicode just fudges around. .PP -For example, the following selects an almost completely transparent red +For example, the following selects an almost completely transparent black background, and an almost opaque pink foreground: .PP .Vb 1 -\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/2222 \-fg "[e]pink" +\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/4444 \-fg "[80]pink" .Ve .PP -\&\fIPlease note that transparency of any kind if completely unsupported by -the author. Don't bug him with installation questions!\fR +When not using a background image, then the interpretation of the +alpha channel is up to your compositing manager (most interpret it as +transparency of course). +.PP +When using a background pixmap or pseudo-transparency, then the background +colour will always behave as if it were completely transparent (so the +background image shows instead), regardless of how it was specified, while +other colours will either be transparent as specified (the background +image will show through) on servers supporting the \s-1RENDER\s0 extension, or +fully opaque on servers not supporting the \s-1RENDER\s0 \s-1EXTENSION\s0. +.PP +Please note that due to bugs in Xft, specifying alpha values might result +in garbage being displayed when the X\-server does not support the \s-1RENDER\s0 +extension. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: @@ -1394,8 +1507,9 @@ .IP "\fB\s-1COLORTERM\s0\fR" 4 .IX Item "COLORTERM" Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was -compiled with \s-1XPM\s0 support, and optionally with the added extension -\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. +compiled with background image support, and optionally with the added +extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome +screen. .IP "\fB\s-1COLORFGBG\s0\fR" 4 .IX Item "COLORFGBG" Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is @@ -1403,8 +1517,8 @@ \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@ -was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can -(and do) use this information to optimize screen output. +was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR +and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output. .IP "\fB\s-1WINDOWID\s0\fR" 4 .IX Item "WINDOWID" Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel @@ -1477,10 +1591,10 @@ .IX Item "Geoff Wing " Rewrote screen display and text selection routines. .Sp -Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode) +Project Coordinator (changes.txt 2.4.6 \- rxvt-unicode) .IP "Marc Alexander Lehmann " 4 .IX Item "Marc Alexander Lehmann " -Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl +Forked rxvt-unicode, unicode support, rewrote almost all the code, perl extension, random hacks, numerous bugfixes and extensions. .Sp Project Coordinator (Changes 1.0 \-)