| … | |
… | |
| 122 | .\} |
122 | .\} |
| 123 | .rm #[ #] #H #V #F C |
123 | .rm #[ #] #H #V #F C |
| 124 | .\" ======================================================================== |
124 | .\" ======================================================================== |
| 125 | .\" |
125 | .\" |
| 126 | .IX Title "@@RXVT_NAME@@ 1" |
126 | .IX Title "@@RXVT_NAME@@ 1" |
| 127 | .TH @@RXVT_NAME@@ 1 "2010-10-15" "@@RXVT_VERSION@@" "RXVT-UNICODE" |
127 | .TH @@RXVT_NAME@@ 1 "2010-11-13" "@@RXVT_VERSION@@" "RXVT-UNICODE" |
| 128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 129 | .\" way too many mistakes in technical documents. |
129 | .\" way too many mistakes in technical documents. |
| 130 | .if n .ad l |
130 | .if n .ad l |
| 131 | .nh |
131 | .nh |
| 132 | .SH "NAME" |
132 | .SH "NAME" |
| … | |
… | |
| 239 | .IP "\fB\-ss\fR|\fB+ss\fR" 4 |
239 | .IP "\fB\-ss\fR|\fB+ss\fR" 4 |
| 240 | .IX Item "-ss|+ss" |
240 | .IX Item "-ss|+ss" |
| 241 | Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. |
241 | Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. |
| 242 | .IP "\fB\-tr\fR|\fB+tr\fR" 4 |
242 | .IP "\fB\-tr\fR|\fB+tr\fR" 4 |
| 243 | .IX Item "-tr|+tr" |
243 | .IX Item "-tr|+tr" |
| 244 | Turn on/off illusion of a transparent window background; resource \fBtransparent\fR. |
244 | Turn on/off pseudo-transparency by using the root pixmap as background; resource \fBtransparent\fR. |
| 245 | .Sp |
245 | .Sp |
| 246 | \&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in |
246 | \&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in |
| 247 | future versions. |
247 | future versions. |
| 248 | .IP "\fB\-fade\fR \fInumber\fR" 4 |
248 | .IP "\fB\-fade\fR \fInumber\fR" 4 |
| 249 | .IX Item "-fade number" |
249 | .IX Item "-fade number" |
| … | |
… | |
| 254 | .IX Item "-fadecolor colour" |
254 | .IX Item "-fadecolor colour" |
| 255 | Fade to this colour when fading is used (see \fB\-fade\fR). The default colour |
255 | Fade to this colour when fading is used (see \fB\-fade\fR). The default colour |
| 256 | is opaque black. resource \fBfadeColor\fR. |
256 | is opaque black. resource \fBfadeColor\fR. |
| 257 | .IP "\fB\-tint\fR \fIcolour\fR" 4 |
257 | .IP "\fB\-tint\fR \fIcolour\fR" 4 |
| 258 | .IX Item "-tint colour" |
258 | .IX Item "-tint colour" |
| 259 | Tint the transparent background pixmap with the given colour when |
259 | Tint the transparent background with the given colour; |
| 260 | transparency is enabled with \fB\-tr\fR. This only works for |
260 | resource \fItintColor\fR. |
| 261 | non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be |
|
|
| 262 | used to brighten or darken the image in addition to tinting it. |
|
|
| 263 | Please note that certain tint colours can be applied on the server-side, |
|
|
| 264 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
| 265 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
| 266 | pure black and pure white colours essentially mean no tinting; resource |
|
|
| 267 | \&\fItintColor\fR. Example: |
|
|
| 268 | .Sp |
|
|
| 269 | .Vb 1 |
|
|
| 270 | \& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 |
|
|
| 271 | .Ve |
|
|
| 272 | .IP "\fB\-sh\fR \fInumber\fR" 4 |
261 | .IP "\fB\-sh\fR \fInumber\fR" 4 |
| 273 | .IX Item "-sh number" |
262 | .IX Item "-sh number" |
| 274 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
263 | Darken (0 .. 100) or lighten (100 .. 200) the transparent background; |
| 275 | background image in addition to (or instead of) tinting it; |
|
|
| 276 | resource \fIshading\fR. |
264 | resource \fIshading\fR. |
| 277 | .IP "\fB\-blt\fR \fIstring\fR" 4 |
265 | .IP "\fB\-blt\fR \fIstring\fR" 4 |
| 278 | .IX Item "-blt string" |
266 | .IX Item "-blt string" |
| 279 | Specify background blending type. If background pixmap is specified |
267 | Specify background blending type. If background pixmap is specified |
| 280 | at the same time as transparency \- such pixmap will be blended over |
268 | at the same time as transparency \- such pixmap will be blended over |
| 281 | transparency image, using method specified. Supported values are : |
269 | the transparent background, using the method specified. Supported values are: |
| 282 | \&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- colour values averaging, \fBcolorize\fR, |
270 | \&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- colour values averaging, \fBcolorize\fR, |
| 283 | \&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, |
271 | \&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, |
| 284 | \&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is |
272 | \&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is |
| 285 | alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR. |
273 | alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR. |
| 286 | .IP "\fB\-blr\fR \fIHxV\fR" 4 |
274 | .IP "\fB\-blr\fR \fIHxV\fR" 4 |
| 287 | .IX Item "-blr HxV" |
275 | .IX Item "-blr HxV" |
| 288 | Apply Gaussian Blur with the specified radii to the transparent |
276 | Apply Gaussian Blur with the specified radii to the transparent |
| 289 | background image. If single number is specified \- both vertical and |
277 | background. If a single number is specified \- both vertical and |
| 290 | horizontal radii are considered to be the same. Setting one of the |
278 | horizontal radii are considered to be the same. Setting one of the |
| 291 | radii to 1 and another to a large number creates interesting effects |
279 | radii to 1 and another to a large number creates interesting effects |
| 292 | on some backgrounds. Maximum radius value is 128. Compile \fIafterimage\fR or \fIxft\fR; |
280 | on some backgrounds. Maximum radius value is 128; |
| 293 | resource \fIblurRadius\fR. |
281 | resource \fIblurRadius\fR. |
| 294 | .IP "\fB\-icon\fR \fIfile\fR" 4 |
282 | .IP "\fB\-icon\fR \fIfile\fR" 4 |
| 295 | .IX Item "-icon file" |
283 | .IX Item "-icon file" |
| 296 | Compile \fIafterimage\fR or \fIpixbuf\fR: Use the specified image as application icon. This |
284 | Compile \fIafterimage\fR or \fIpixbuf\fR: Use the specified image as application icon. This |
| 297 | is used by many window managers, taskbars and pagers to represent the |
285 | is used by many window managers, taskbars and pagers to represent the |
| … | |
… | |
| 744 | \&\fBFalse\fR: specify that everything is to be displayed, even |
732 | \&\fBFalse\fR: specify that everything is to be displayed, even |
| 745 | if the refresh is too fast for the human eye to read anything (or the |
733 | if the refresh is too fast for the human eye to read anything (or the |
| 746 | monitor to display anything); option \fB+ss\fR. |
734 | monitor to display anything); option \fB+ss\fR. |
| 747 | .IP "\fBtransparent:\fR \fIboolean\fR" 4 |
735 | .IP "\fBtransparent:\fR \fIboolean\fR" 4 |
| 748 | .IX Item "transparent: boolean" |
736 | .IX Item "transparent: boolean" |
| 749 | Turn on/off illusion of a transparent window background. |
737 | Turn on/off pseudo-transparency by using the root pixmap as background. |
| 750 | .Sp |
738 | .Sp |
| 751 | \&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in |
739 | \&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in |
| 752 | future versions. |
740 | future versions. |
| 753 | .IP "\fBfading:\fR \fInumber\fR" 4 |
741 | .IP "\fBfading:\fR \fInumber\fR" 4 |
| 754 | .IX Item "fading: number" |
742 | .IX Item "fading: number" |
| … | |
… | |
| 757 | .IX Item "fadeColor: colour" |
745 | .IX Item "fadeColor: colour" |
| 758 | Fade to this colour, when fading is used (see \fBfading:\fR). The default |
746 | Fade to this colour, when fading is used (see \fBfading:\fR). The default |
| 759 | colour is black; option \fB\-fadecolor\fR. |
747 | colour is black; option \fB\-fadecolor\fR. |
| 760 | .IP "\fBtintColor:\fR \fIcolour\fR" 4 |
748 | .IP "\fBtintColor:\fR \fIcolour\fR" 4 |
| 761 | .IX Item "tintColor: colour" |
749 | .IX Item "tintColor: colour" |
| 762 | Tint the transparent background pixmap with the given colour; option |
750 | Tint the transparent background with the given colour; option |
| 763 | \&\fB\-tint\fR. |
751 | \&\fB\-tint\fR. |
| 764 | .IP "\fBshading:\fR \fInumber\fR" 4 |
752 | .IP "\fBshading:\fR \fInumber\fR" 4 |
| 765 | .IX Item "shading: number" |
753 | .IX Item "shading: number" |
| 766 | Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image |
754 | Darken (0 .. 100) or lighten (100 .. 200) the transparent background; |
| 767 | in addition to tinting it; option \fB\-sh\fR. |
755 | option \fB\-sh\fR. |
| 768 | .IP "\fBblendType:\fR \fIstring\fR" 4 |
756 | .IP "\fBblendType:\fR \fIstring\fR" 4 |
| 769 | .IX Item "blendType: string" |
757 | .IX Item "blendType: string" |
| 770 | Specify background blending type; option \fB\-blt\fR. |
758 | Specify background blending type; option \fB\-blt\fR. |
| 771 | .IP "\fBblurRadius:\fR \fInumber\fR" 4 |
759 | .IP "\fBblurRadius:\fR \fInumber\fR" 4 |
| 772 | .IX Item "blurRadius: number" |
760 | .IX Item "blurRadius: number" |
| 773 | Apply gaussian blur with the specified radius to the transparent |
761 | Apply gaussian blur with the specified radius to the transparent |
| 774 | background image; option \fB\-blr\fR. |
762 | background; option \fB\-blr\fR. |
| 775 | .IP "\fBiconFile:\fR \fIfile\fR" 4 |
763 | .IP "\fBiconFile:\fR \fIfile\fR" 4 |
| 776 | .IX Item "iconFile: file" |
764 | .IX Item "iconFile: file" |
| 777 | Set the application icon pixmap; option \fB\-icon\fR. |
765 | Set the application icon pixmap; option \fB\-icon\fR. |
| 778 | .IP "\fBscrollColor:\fR \fIcolour\fR" 4 |
766 | .IP "\fBscrollColor:\fR \fIcolour\fR" 4 |
| 779 | .IX Item "scrollColor: colour" |
767 | .IX Item "scrollColor: colour" |
| … | |
… | |
| 807 | \& root will tile image as if it was a root window background, auto\-adjusting |
795 | \& root will tile image as if it was a root window background, auto\-adjusting |
| 808 | \& whenever terminal window moves |
796 | \& whenever terminal window moves |
| 809 | .Ve |
797 | .Ve |
| 810 | .Sp |
798 | .Sp |
| 811 | If used in conjunction with \fB\-tr\fR option, the specified pixmap will be |
799 | If used in conjunction with \fB\-tr\fR option, the specified pixmap will be |
| 812 | blended over transparency image using alpha-blending. If \fIafterimage\fR |
800 | blended over the transparent background using alpha-blending. If \fIafterimage\fR |
| 813 | support has been compiled in it is possible to choose other blending |
801 | support has been compiled in it is possible to choose other blending |
| 814 | types with \fB\-blt \*(L"type\*(R"\fR option. |
802 | types with \fB\-blt \*(L"type\*(R"\fR option. |
| 815 | .IP "\fBpath:\fR \fIpath\fR" 4 |
803 | .IP "\fBpath:\fR \fIpath\fR" 4 |
| 816 | .IX Item "path: path" |
804 | .IX Item "path: path" |
| 817 | Specify the colon-delimited search path for finding background image files. |
805 | Specify the colon-delimited search path for finding background image files. |
