ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.67 by root, Sat Jun 2 04:58:58 2007 UTC vs.
Revision 1.68 by root, Sun Jun 24 22:12:18 2007 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "@@RXVT_NAME@@ 1" 131.IX Title "@@RXVT_NAME@@ 1"
132.TH @@RXVT_NAME@@ 1 "2007-06-02" "8.2" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-06-25" "8.2" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
226.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
227.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
228Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
229.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
230.IX Item "-j|+j" 230.IX Item "-j|+j"
231Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ss\fR|\fB+ss\fR" 4
233.IX Item "-ss|+ss"
234Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 235.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
233.IX Item "-ip|+ip | -tr|+tr" 236.IX Item "-ip|+ip | -tr|+tr"
234Turn on/off inheriting parent window's pixmap. Alternative form is 237Turn on/off inheriting parent window's pixmap. Alternative form is
235\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 238\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp 239.Sp
255\&\fItintColor\fR. Example: 258\&\fItintColor\fR. Example:
256.Sp 259.Sp
257.Vb 1 260.Vb 1
258\& @@RXVT_NAME@@ -tr -tint blue -sh 40 261\& @@RXVT_NAME@@ -tr -tint blue -sh 40
259.Ve 262.Ve
260.IP "\fB\-sh\fR" 4 263.IP "\fB\-sh\fR \fInumber\fR" 4
261.IX Item "-sh" 264.IX Item "-sh number"
262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 265Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
263background image in addition to tinting it (i.e. \fB\-tint\fR must be 266background image in addition to (or instead of) tinting it;
264specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR); resource \fIshading\fR. 267resource \fIshading\fR.
268.IP "\fB\-blt\fR \fIstring\fR" 4
269.IX Item "-blt string"
270Specify background blending type. If background pixmap is specified
271at the same time as transparency \- such pixmap will be blended over
272transparency image, using method specified. Supported values are :
273\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
274\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
275\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
276alpha\-blending; resource \fIblendType\fR.
277.IP "\fB\-blr\fR \fInumber\fR" 4
278.IX Item "-blr number"
279Apply Gaussian Blur with the specified radius to the transparent
280background image; resource \fIblurRadius\fR.
265.IP "\fB\-bg\fR \fIcolour\fR" 4 281.IP "\fB\-bg\fR \fIcolour\fR" 4
266.IX Item "-bg colour" 282.IX Item "-bg colour"
267Window background colour; resource \fBbackground\fR. 283Window background colour; resource \fBbackground\fR.
268.IP "\fB\-fg\fR \fIcolour\fR" 4 284.IP "\fB\-fg\fR \fIcolour\fR" 4
269.IX Item "-fg colour" 285.IX Item "-fg colour"
270Window foreground colour; resource \fBforeground\fR. 286Window foreground colour; resource \fBforeground\fR.
271.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 287.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
272.IX Item "-pixmap file[;geom]" 288.IX Item "-pixmap file[;geom]"
273Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 289Compile \fIafterimage\fR: Specify image file for the background and also
274specify its scaling with a geometry string. Note you may need to 290optionally specify its scaling with a geometry string. Note you may need to
275add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the 291add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
276command\-line; resource \fBbackgroundPixmap\fR. 292command\-line; for more details see resource \fBbackgroundPixmap\fR.
277.IP "\fB\-cr\fR \fIcolour\fR" 4 293.IP "\fB\-cr\fR \fIcolour\fR" 4
278.IX Item "-cr colour" 294.IX Item "-cr colour"
279The cursor colour; resource \fBcursorColor\fR. 295The cursor colour; resource \fBcursorColor\fR.
280.IP "\fB\-pr\fR \fIcolour\fR" 4 296.IP "\fB\-pr\fR \fIcolour\fR" 4
281.IX Item "-pr colour" 297.IX Item "-pr colour"
654\&\fBTrue\fR: simulate reverse video by foreground and background colours; 670\&\fBTrue\fR: simulate reverse video by foreground and background colours;
655option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 671option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
656\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 672\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
657.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 673.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
658.IX Item "jumpScroll: boolean" 674.IX Item "jumpScroll: boolean"
659\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 675\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
660quickly, fewer screen updates are performed [default]; option \fB\-j\fR. 676of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
677has been read, resulting in fewer updates while still displaying every
678received line; option \fB\-j\fR.
679.Sp
661\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. 680\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
681force a screen refresh on each new line it received; option \fB+j\fR.
682.IP "\fBskipScroll:\fR \fIboolean\fR" 4
683.IX Item "skipScroll: boolean"
684\&\fBTrue\fR: (the default) specify that skip scrolling should be used. When
685receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
686(around 60 times per second), resulting in far fewer updates. This can
687result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
688option \fB\-ss\fR.
689.Sp
690\&\fBFalse\fR: specify that everything is to be displayed, even
691if the refresh is too fast for the human eye to read anything (or the
692monitor to display anything); option \fB+ss\fR.
662.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 693.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
663.IX Item "inheritPixmap: boolean" 694.IX Item "inheritPixmap: boolean"
664\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 695\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
665artificial transparency. \fBFalse\fR: do not inherit the parent windows' 696artificial transparency. \fBFalse\fR: do not inherit the parent windows'
666pixmap. 697pixmap.
680\&\fB\-tint\fR. 711\&\fB\-tint\fR.
681.IP "\fBshading:\fR \fInumber\fR" 4 712.IP "\fBshading:\fR \fInumber\fR" 4
682.IX Item "shading: number" 713.IX Item "shading: number"
683Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image 714Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
684in addition to tinting it; option \fB\-sh\fR. 715in addition to tinting it; option \fB\-sh\fR.
716.IP "\fBblendType:\fR \fIstring\fR" 4
717.IX Item "blendType: string"
718Specify background blending type; option \fB\-blt\fR.
719.IP "\fBblurRadius:\fR \fInumber\fR" 4
720.IX Item "blurRadius: number"
721Apply Gaussian Blurr with the specified radius to the transparent
722background image; option \fB\-blr\fR.
685.IP "\fBscrollColor:\fR \fIcolour\fR" 4 723.IP "\fBscrollColor:\fR \fIcolour\fR" 4
686.IX Item "scrollColor: colour" 724.IX Item "scrollColor: colour"
687Use the specified colour for the scrollbar [default #B2B2B2]. 725Use the specified colour for the scrollbar [default #B2B2B2].
688.IP "\fBtroughColor:\fR \fIcolour\fR" 4 726.IP "\fBtroughColor:\fR \fIcolour\fR" 4
689.IX Item "troughColor: colour" 727.IX Item "troughColor: colour"
693.IX Item "borderColor: colour" 731.IX Item "borderColor: colour"
694The colour of the border around the text area and between the scrollbar 732The colour of the border around the text area and between the scrollbar
695and the text. 733and the text.
696.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 734.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
697.IX Item "backgroundPixmap: file[;geom]" 735.IX Item "backgroundPixmap: file[;geom]"
698Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 736Use the specified image file for the background and also optionally
699the background and also optionally specify its scaling with a geometry 737specify its scaling with a geometry string \fBWxH+X+Y\fR,
700string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the 738in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical scale (percent),
701horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image 739and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent).
702centre (percent). A scale of 0 displays the image with tiling. A scale 740A scale of 0 displays the image with tiling. A scale of 1 displays the
703of 1 displays the image without any scaling. A scale of 2 to 9 741image without any scaling. A scale of 2 to 9 specifies an integer
704specifies an integer number of images in that direction. No image will 742number of images in that direction. No image will be magnified beyond
705be magnified beyond 10 times its original size. The maximum permitted 74310 times its original size. The maximum permitted scale is 1000.
706scale is 1000. [default 0x0+50+50] 744Special string of \fB\*(L"auto\*(R"\fR used as a geometry will cause image to be
745automatically scaled to match window size.
746If used in conjunction with \fB\-tr\fR option \- specified pixmap will be
747blended over transparency image using either alpha\-blending, or any
748other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
749[default 0x0+50+50]
707.IP "\fBpath:\fR \fIpath\fR" 4 750.IP "\fBpath:\fR \fIpath\fR" 4
708.IX Item "path: path" 751.IX Item "path: path"
709Specify the colon-delimited search path for finding \s-1XPM\s0 files. 752Specify the colon-delimited search path for finding \s-1XPM\s0 files.
710.IP "\fBfont:\fR \fIfontlist\fR" 4 753.IP "\fBfont:\fR \fIfontlist\fR" 4
711.IX Item "font: fontlist" 754.IX Item "font: fontlist"
1187Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1230Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1188.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4 1231.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1189.IX Item "override-redirect: boolean" 1232.IX Item "override-redirect: boolean"
1190Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1233Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1191it almost invisible to window managers; option \fB\-override\-redirect\fR. 1234it almost invisible to window managers; option \fB\-override\-redirect\fR.
1235.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1236.IX Item "iso14755_52: boolean"
1237Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1192.SH "THE SCROLLBAR" 1238.SH "THE SCROLLBAR"
1193.IX Header "THE SCROLLBAR" 1239.IX Header "THE SCROLLBAR"
1194Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1240Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1195(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1241(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1196or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1242or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines