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.109 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.110 by root, Tue Nov 6 20:58:05 2012 UTC

… …
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 "2012-09-22" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 1 "2012-11-06" "@@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"
… …
241.IX Item "-j|+j" 241.IX Item "-j|+j"
242Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR. 242Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
243.IP "\fB\-ss\fR|\fB+ss\fR" 4 243.IP "\fB\-ss\fR|\fB+ss\fR" 4
244.IX Item "-ss|+ss" 244.IX Item "-ss|+ss"
245Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. 245Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
246.IP "\fB\-tr\fR|\fB+tr\fR" 4
247.IX Item "-tr|+tr"
248Turn on/off pseudo-transparency by using the root pixmap as background; resource \fBtransparent\fR.
249.Sp
250\&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in
251future versions.
252.IP "\fB\-fade\fR \fInumber\fR" 4 246.IP "\fB\-fade\fR \fInumber\fR" 4
253.IX Item "-fade number" 247.IX Item "-fade number"
254Fade the text by the given percentage when focus is lost. Small values 248Fade the text by the given percentage when focus is lost. Small values
255fade a little only, 100 completely replaces all colours by the fade 249fade a little only, 100 completely replaces all colours by the fade
256colour; resource \fBfading\fR. 250colour; resource \fBfading\fR.
257.IP "\fB\-fadecolor\fR \fIcolour\fR" 4 251.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
258.IX Item "-fadecolor colour" 252.IX Item "-fadecolor colour"
259Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 253Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
260is opaque black. resource \fBfadeColor\fR. 254is opaque black. resource \fBfadeColor\fR.
261.IP "\fB\-tint\fR \fIcolour\fR" 4
262.IX Item "-tint colour"
263Tint the transparent background with the given colour;
264resource \fItintColor\fR.
265.IP "\fB\-sh\fR \fInumber\fR" 4
266.IX Item "-sh number"
267Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
268A value of 100 means no shading; resource \fIshading\fR.
269.IP "\fB\-blr\fR \fIHxV\fR" 4
270.IX Item "-blr HxV"
271Apply Gaussian Blur with the specified radii to the transparent
272background. If a single number is specified, the vertical and
273horizontal radii are considered to be the same. Setting one of the
274radii to 1 and the other to a large number creates interesting effects
275on some backgrounds. The maximum radius value is 128. An horizontal or
276vertical radius of 0 disables blurring;
277resource \fIblurRadius\fR.
278.IP "\fB\-icon\fR \fIfile\fR" 4 255.IP "\fB\-icon\fR \fIfile\fR" 4
279.IX Item "-icon file" 256.IX Item "-icon file"
280Compile \fIpixbuf\fR: Use the specified image as application icon. This 257Compile \fIpixbuf\fR: Use the specified image as application icon. This
281is used by many window managers, taskbars and pagers to represent the 258is used by many window managers, taskbars and pagers to represent the
282application window; resource \fIiconFile\fR. 259application window; resource \fIiconFile\fR.
… …
284.IX Item "-bg colour" 261.IX Item "-bg colour"
285Window background colour; resource \fBbackground\fR. 262Window background colour; resource \fBbackground\fR.
286.IP "\fB\-fg\fR \fIcolour\fR" 4 263.IP "\fB\-fg\fR \fIcolour\fR" 4
287.IX Item "-fg colour" 264.IX Item "-fg colour"
288Window foreground colour; resource \fBforeground\fR. 265Window foreground colour; resource \fBforeground\fR.
289.IP "\fB\-pixmap\fR \fIfile[;oplist]\fR" 4
290.IX Item "-pixmap file[;oplist]"
291Compile \fIpixbuf\fR: Specify image file for the background and also
292optionally specify a list of operations to modify it. Note you may need to
293add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
294command-line; for more details see resource \fBbackgroundPixmap\fR.
295.IP "\fB\-cr\fR \fIcolour\fR" 4 266.IP "\fB\-cr\fR \fIcolour\fR" 4
296.IX Item "-cr colour" 267.IX Item "-cr colour"
297The cursor colour; resource \fBcursorColor\fR. 268The cursor colour; resource \fBcursorColor\fR.
298.IP "\fB\-pr\fR \fIcolour\fR" 4 269.IP "\fB\-pr\fR \fIcolour\fR" 4
299.IX Item "-pr colour" 270.IX Item "-pr colour"
… …
726option \fB\-ss\fR. 697option \fB\-ss\fR.
727.Sp 698.Sp
728\&\fBFalse\fR: specify that everything is to be displayed, even 699\&\fBFalse\fR: specify that everything is to be displayed, even
729if the refresh is too fast for the human eye to read anything (or the 700if the refresh is too fast for the human eye to read anything (or the
730monitor to display anything); option \fB+ss\fR. 701monitor to display anything); option \fB+ss\fR.
731.IP "\fBtransparent:\fR \fIboolean\fR" 4
732.IX Item "transparent: boolean"
733Turn on/off pseudo-transparency by using the root pixmap as background.
734.Sp
735\&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in
736future versions.
737.IP "\fBfading:\fR \fInumber\fR" 4 702.IP "\fBfading:\fR \fInumber\fR" 4
738.IX Item "fading: number" 703.IX Item "fading: number"
739Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. 704Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
740.IP "\fBfadeColor:\fR \fIcolour\fR" 4 705.IP "\fBfadeColor:\fR \fIcolour\fR" 4
741.IX Item "fadeColor: colour" 706.IX Item "fadeColor: colour"
742Fade to this colour, when fading is used (see \fBfading:\fR). The default 707Fade to this colour, when fading is used (see \fBfading:\fR). The default
743colour is black; option \fB\-fadecolor\fR. 708colour is black; option \fB\-fadecolor\fR.
744.IP "\fBtintColor:\fR \fIcolour\fR" 4
745.IX Item "tintColor: colour"
746Tint the transparent background with the given colour. If the \s-1RENDER\s0
747extension is not available only black, red, green, yellow, blue,
748magenta, cyan and white tints can be performed server-side. Note that
749a black tint yields a completely black image while a white tint yields
750the image unchanged; option \fB\-tint\fR.
751.IP "\fBshading:\fR \fInumber\fR" 4
752.IX Item "shading: number"
753Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
754A value of 100 means no shading; option \fB\-sh\fR.
755.IP "\fBblurRadius:\fR \fInumber\fR" 4
756.IX Item "blurRadius: number"
757Apply gaussian blur with the specified radius to the transparent
758background; option \fB\-blr\fR.
759.IP "\fBiconFile:\fR \fIfile\fR" 4 709.IP "\fBiconFile:\fR \fIfile\fR" 4
760.IX Item "iconFile: file" 710.IX Item "iconFile: file"
761Set the application icon pixmap; option \fB\-icon\fR. 711Set the application icon pixmap; option \fB\-icon\fR.
762.IP "\fBscrollColor:\fR \fIcolour\fR" 4 712.IP "\fBscrollColor:\fR \fIcolour\fR" 4
763.IX Item "scrollColor: colour" 713.IX Item "scrollColor: colour"
… …
768#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. 718#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
769.IP "\fBborderColor:\fR \fIcolour\fR" 4 719.IP "\fBborderColor:\fR \fIcolour\fR" 4
770.IX Item "borderColor: colour" 720.IX Item "borderColor: colour"
771The colour of the border around the text area and between the scrollbar 721The colour of the border around the text area and between the scrollbar
772and the text. 722and the text.
773.IP "\fBbackgroundPixmap:\fR \fIfile[;oplist]\fR" 4
774.IX Item "backgroundPixmap: file[;oplist]"
775Use the specified image file for the background and also
776optionally specify a colon separated list of operations to modify it.
777Supported operations are:
778.RS 4
779.IP "\fBWxH+X+Y\fR" 4
780.IX Item "WxH+X+Y"
781sets scale and position. \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical
782scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent). A
783scale of 0 disables scaling.
784.IP "\fBop=tile\fR" 4
785.IX Item "op=tile"
786enables tiling
787.IP "\fBop=keep\-aspect\fR" 4
788.IX Item "op=keep-aspect"
789maintain the image aspect ratio when scaling
790.IP "\fBop=root\-align\fR" 4
791.IX Item "op=root-align"
792use the position of the terminal window relative to the root window as
793the image offset, simulating a root window background
794.RE
795.RS 4
796.Sp
797The default scale and position setting is \f(CW\*(C`100x100+50+50\*(C'\fR.
798Alternatively, a predefined set of templates can be used to achieve
799the most common setups:
800.IP "\fBstyle=tiled\fR" 4
801.IX Item "style=tiled"
802the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
803.IP "\fBstyle=aspect\-stretched\fR" 4
804.IX Item "style=aspect-stretched"
805the image is scaled to fill the whole window maintaining the aspect
806ratio and centered. Equivalent to 100x100+50+50:op=keep\-aspect
807.IP "\fBstyle=stretched\fR" 4
808.IX Item "style=stretched"
809the image is scaled to fill the whole window. Equivalent to 100x100
810.IP "\fBstyle=centered\fR" 4
811.IX Item "style=centered"
812the image is centered with no scaling. Equivalent to 0x0+50+50
813.IP "\fBstyle=root\-tiled\fR" 4
814.IX Item "style=root-tiled"
815the image is tiled with no scaling and using 'root' positioning.
816Equivalent to 0x0:op=tile:op=root\-align
817.RE
818.RS 4
819.Sp
820If multiple templates are specified the last one wins. Note that a
821template overrides all the scale, position and operations settings.
822.Sp
823If used in conjunction with \fB\-tr\fR option, the specified pixmap will be
824blended over the transparent background using alpha-blending.
825.RE
826.IP "\fBpath:\fR \fIpath\fR" 4
827.IX Item "path: path"
828Specify the colon-delimited search path for finding background image files.
829.IP "\fBfont:\fR \fIfontlist\fR" 4 723.IP "\fBfont:\fR \fIfontlist\fR" 4
830.IX Item "font: fontlist" 724.IX Item "font: fontlist"
831Select the fonts to be used. This is a comma separated list of font names 725Select the fonts to be used. This is a comma separated list of font names
832that are checked in order when trying to find glyphs for characters. The 726that are checked in order when trying to find glyphs for characters. The
833first font defines the cell size for characters; other fonts might be 727first font defines the cell size for characters; other fonts might be
… …
1295for details. 1189for details.
1296.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4 1190.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4
1297.IX Item "searchable-scrollback: keysym" 1191.IX Item "searchable-scrollback: keysym"
1298Sets the hotkey that starts the incremental scrollback buffer search 1192Sets the hotkey that starts the incremental scrollback buffer search
1299(default: \f(CW\*(C`M\-s\*(C'\fR). 1193(default: \f(CW\*(C`M\-s\*(C'\fR).
1300.IP "\fBurlLauncher\fR: \fIstring\fR" 4 1194.IP "\fBurl-launcher\fR: \fIstring\fR" 4
1301.IX Item "urlLauncher: string" 1195.IX Item "url-launcher: string"
1302Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1196Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1303\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions. 1197\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1304.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1198.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1305.IX Item "transient-for: windowid" 1199.IX Item "transient-for: windowid"
1306Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1200Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
… …
1312.IX Item "iso14755: boolean" 1206.IX Item "iso14755: boolean"
1313Turn on/off \s-1ISO\s0 14755 (default enabled). 1207Turn on/off \s-1ISO\s0 14755 (default enabled).
1314.IP "\fBiso14755_52:\fR \fIboolean\fR" 4 1208.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1315.IX Item "iso14755_52: boolean" 1209.IX Item "iso14755_52: boolean"
1316Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled). 1210Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1211.SH "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1212.IX Header "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1213.IP "\fB\-pixmap\fR \fIfile[;oplist]\fR" 4
1214.IX Item "-pixmap file[;oplist]"
1215.PD 0
1216.IP "\fBbackgroundPixmap:\fR \fIfile[;oplist]\fR" 4
1217.IX Item "backgroundPixmap: file[;oplist]"
1218.PD
1219Compile \fIpixbuf\fR: Use the specified image file as the window's
1220background and also optionally specify a colon separated list of
1221operations to modify it. Note that you may need to quote the \f(CW\*(C`;\*(C'\fR
1222character when using the command line option, as \f(CW\*(C`;\*(C'\fR is usually a
1223metacharacter in shells. Supported operations are:
1224.RS 4
1225.IP "\fBWxH+X+Y\fR" 4
1226.IX Item "WxH+X+Y"
1227sets scale and position. \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical
1228scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent). A
1229scale of 0 disables scaling.
1230.IP "\fBop=tile\fR" 4
1231.IX Item "op=tile"
1232enables tiling
1233.IP "\fBop=keep\-aspect\fR" 4
1234.IX Item "op=keep-aspect"
1235maintain the image aspect ratio when scaling
1236.IP "\fBop=root\-align\fR" 4
1237.IX Item "op=root-align"
1238use the position of the terminal window relative to the root window as
1239the image offset, simulating a root window background
1240.RE
1241.RS 4
1242.Sp
1243The default scale and position setting is \f(CW\*(C`100x100+50+50\*(C'\fR.
1244Alternatively, a predefined set of templates can be used to achieve
1245the most common setups:
1246.IP "\fBstyle=tiled\fR" 4
1247.IX Item "style=tiled"
1248the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1249.IP "\fBstyle=aspect\-stretched\fR" 4
1250.IX Item "style=aspect-stretched"
1251the image is scaled to fill the whole window maintaining the aspect
1252ratio and centered. Equivalent to 100x100+50+50:op=keep\-aspect
1253.IP "\fBstyle=stretched\fR" 4
1254.IX Item "style=stretched"
1255the image is scaled to fill the whole window. Equivalent to 100x100
1256.IP "\fBstyle=centered\fR" 4
1257.IX Item "style=centered"
1258the image is centered with no scaling. Equivalent to 0x0+50+50
1259.IP "\fBstyle=root\-tiled\fR" 4
1260.IX Item "style=root-tiled"
1261the image is tiled with no scaling and using 'root' positioning.
1262Equivalent to 0x0:op=tile:op=root\-align
1263.RE
1264.RS 4
1265.Sp
1266If multiple templates are specified the last one wins. Note that a
1267template overrides all the scale, position and operations settings.
1268.Sp
1269If used in conjunction with pseudo-transparency, the specified pixmap
1270will be blended over the transparent background using alpha-blending.
1271.RE
1272.IP "\fB\-tr\fR|\fB+tr\fR" 4
1273.IX Item "-tr|+tr"
1274.PD 0
1275.IP "\fBtransparent:\fR \fIboolean\fR" 4
1276.IX Item "transparent: boolean"
1277.PD
1278Turn on/off pseudo-transparency by using the root pixmap as background.
1279.Sp
1280\&\fB\-ip\fR (\fBinheritPixmap\fR) is still accepted as an obsolete alias but
1281will be removed in future versions.
1282.IP "\fB\-tint\fR \fIcolour\fR" 4
1283.IX Item "-tint colour"
1284.PD 0
1285.IP "\fBtintColor:\fR \fIcolour\fR" 4
1286.IX Item "tintColor: colour"
1287.PD
1288Tint the transparent background with the given colour. Note that a
1289black tint yields a completely black image while a white tint yields
1290the image unchanged.
1291.IP "\fB\-sh\fR \fInumber\fR" 4
1292.IX Item "-sh number"
1293.PD 0
1294.IP "\fBshading:\fR \fInumber\fR" 4
1295.IX Item "shading: number"
1296.PD
1297Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1298A value of 100 means no shading.
1299.IP "\fB\-blr\fR \fIHxV\fR" 4
1300.IX Item "-blr HxV"
1301.PD 0
1302.IP "\fBblurRadius:\fR \fIHxV\fR" 4
1303.IX Item "blurRadius: HxV"
1304.PD
1305Apply gaussian blur with the specified radius to the transparent
1306background. If a single number is specified, the vertical and
1307horizontal radii are considered to be the same. Setting one of the
1308radii to 1 and the other to a large number creates interesting effects
1309on some backgrounds. The maximum radius value is 128. An horizontal or
1310vertical radius of 0 disables blurring.
1311.IP "\fBpath:\fR \fIpath\fR" 4
1312.IX Item "path: path"
1313Specify the colon-delimited search path for finding background image files.
1317.SH "THE SCROLLBAR" 1314.SH "THE SCROLLBAR"
1318.IX Header "THE SCROLLBAR" 1315.IX Header "THE SCROLLBAR"
1319Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1316Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1320(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1317(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1321or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1318or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
1674.Sp 1671.Sp
1675Project Coordinator (Changes 1.0 \-) 1672Project Coordinator (Changes 1.0 \-)
1676.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4 1673.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1677.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>" 1674.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1678pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1675pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1676.SH "POD ERRORS"
1677.IX Header "POD ERRORS"
1678Hey! \fBThe above document had some coding errors, which are explained below:\fR
1679.IP "Around line 1210:" 4
1680.IX Item "Around line 1210:"
1681You forgot a '=back' before '=head1'
1682.IP "Around line 1212:" 4
1683.IX Item "Around line 1212:"
1684\&'=item' outside of any '=over'

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines