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

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.105 by root, Sat Nov 13 00:48:12 2010 UTC vs.
Revision 1.106 by root, Thu Dec 9 10:36:52 2010 UTC

1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) 1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "@@RXVT_NAME@@ 7" 126.IX Title "@@RXVT_NAME@@ 7"
127.TH @@RXVT_NAME@@ 7 "2010-11-13" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 7 "2010-12-09" "@@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"
… …
147.IX Header "DESCRIPTION" 147.IX Header "DESCRIPTION"
148This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting 148This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting
149all escape sequences, and other background information. 149all escape sequences, and other background information.
150.PP 150.PP
151The newest version of this document is also available on the World Wide Web at 151The newest version of this document is also available on the World Wide Web at
152<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>. 152http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
153.PP 153.PP
154The main manual page for @@RXVT_NAME@@ itself is available at 154The main manual page for @@RXVT_NAME@@ itself is available at
155<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>. 155http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
156.SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS" 156.SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
157.IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS" 157.IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
158.SS "Meta, Features & Commandline Issues" 158.SS "Meta, Features & Commandline Issues"
159.IX Subsection "Meta, Features & Commandline Issues" 159.IX Subsection "Meta, Features & Commandline Issues"
160\fIMy question isn't answered here, can I ask a human?\fR 160\fIMy question isn't answered here, can I ask a human?\fR
… …
348the case of rxvt-unicode this hardly matters, as its portability limits 348the case of rxvt-unicode this hardly matters, as its portability limits
349are defined by things like X11, pseudo terminals, locale support and unix 349are defined by things like X11, pseudo terminals, locale support and unix
350domain sockets, which are all less portable than \*(C+ itself. 350domain sockets, which are all less portable than \*(C+ itself.
351.PP 351.PP
352Regarding the bloat, see the above question: It's easy to write programs 352Regarding the bloat, see the above question: It's easy to write programs
353in C that use gobs of memory, an certainly possible to write programs in 353in C that use gobs of memory, and certainly possible to write programs in
354\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is 354\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is
355not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my 355not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my
356system with a minimal config: 356system with a minimal config:
357.PP 357.PP
358.Vb 4 358.Vb 4
… …
394\& @@URXVT_NAME@@ \-tr \-tint red \-sh 40 394\& @@URXVT_NAME@@ \-tr \-tint red \-sh 40
395.Ve 395.Ve
396.PP 396.PP
397That works. If you think it doesn't, you lack transparency and tinting 397That works. If you think it doesn't, you lack transparency and tinting
398support, or you are unable to read. 398support, or you are unable to read.
399This method requires that the background-setting program sets the
400_XROOTPMAP_ID or \s-1ESETROOT_PMAP_ID\s0 property. Compatible programs
401are Esetroot, hsetroot and feh.
399.PP 402.PP
4002. Use a simple pixmap and emulate pseudo-transparency. This enables you 4032. Use a simple pixmap and emulate pseudo-transparency. This enables you
401to use effects other than tinting and shading: Just shade/tint/whatever 404to use effects other than tinting and shading: Just shade/tint/whatever
402your picture with gimp or any other tool: 405your picture with gimp or any other tool:
403.PP 406.PP
… …
1374.PP 1377.PP
1375The Debian GNU/Linux package of rxvt-unicode in sarge contains large 1378The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1376patches that considerably change the behaviour of rxvt-unicode (but 1379patches that considerably change the behaviour of rxvt-unicode (but
1377unfortunately this notice has been removed). Before reporting a bug to 1380unfortunately this notice has been removed). Before reporting a bug to
1378the original rxvt-unicode author please download and install the genuine 1381the original rxvt-unicode author please download and install the genuine
1379version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce 1382version (http://software.schmorp.de#rxvt\-unicode <http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1380the problem. If you cannot, chances are that the problems are specific to 1383the problem. If you cannot, chances are that the problems are specific to
1381Debian GNU/Linux, in which case it should be reported via the Debian Bug 1384Debian GNU/Linux, in which case it should be reported via the Debian Bug
1382Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug). 1385Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
1383.PP 1386.PP
1384For other problems that also affect the Debian package, you can and 1387For other problems that also affect the Debian package, you can and
… …
1494.SS "Definitions" 1497.SS "Definitions"
1495.IX Subsection "Definitions" 1498.IX Subsection "Definitions"
1496.ie n .IP "\fB\fB""c""\fB\fR" 4 1499.ie n .IP "\fB\fB""c""\fB\fR" 4
1497.el .IP "\fB\f(CBc\fB\fR" 4 1500.el .IP "\fB\f(CBc\fB\fR" 4
1498.IX Item "c" 1501.IX Item "c"
1499The literal character c. 1502The literal character c (potentially a multi-byte character).
1500.ie n .IP "\fB\fB""C""\fB\fR" 4 1503.ie n .IP "\fB\fB""C""\fB\fR" 4
1501.el .IP "\fB\f(CBC\fB\fR" 4 1504.el .IP "\fB\f(CBC\fB\fR" 4
1502.IX Item "C" 1505.IX Item "C"
1503A single (required) character. 1506A single (required) character.
1504.ie n .IP "\fB\fB""Ps""\fB\fR" 4 1507.ie n .IP "\fB\fB""Ps""\fB\fR" 4
… …
2144.TS 2147.TS
2145l l . 2148l l .
2146h Send Mouse X & Y on button press and release, and motion. 2149h Send Mouse X & Y on button press and release, and motion.
2147l No mouse reporting. 2150l No mouse reporting.
2148.TE 2151.TE
2152.ie n .IP "\fB\fB""Pm = 1005""\fB\fR (X11 XTerm) (Compile frills)" 4
2153.el .IP "\fB\f(CBPm = 1005\fB\fR (X11 XTerm) (Compile frills)" 4
2154.IX Item "Pm = 1005 (X11 XTerm) (Compile frills)"
2155.PD
2156Try to avoid this mode, it doesn't work sensibly in non\-UTF\-8 locales. Use
2157mode \f(CW1015\fR instead.
2158.Sp
2159Unlike XTerm, coordinates larger than 2015) will work fine.
2160.TS
2161l l .
2162h Enable mouse coordinates in locale-specific encoding.
2163l Enable mouse coordinates as binary octets.
2164.TE
2149.ie n .IP "\fB\fB""Pm = 1010""\fB\fR (\fBrxvt\fR)" 4 2165.ie n .IP "\fB\fB""Pm = 1010""\fB\fR (\fBrxvt\fR)" 4
2150.el .IP "\fB\f(CBPm = 1010\fB\fR (\fBrxvt\fR)" 4 2166.el .IP "\fB\f(CBPm = 1010\fB\fR (\fBrxvt\fR)" 4
2151.IX Item "Pm = 1010 (rxvt)" 2167.IX Item "Pm = 1010 (rxvt)"
2152.TS 2168.TS
2153l l . 2169l l .
2154h Don't scroll to bottom on TTY output 2170h Don't scroll to bottom on TTY output
2155l Scroll to bottom on TTY output 2171l Scroll to bottom on TTY output
2156.TE 2172.TE
2173.PD 0
2157.ie n .IP "\fB\fB""Pm = 1011""\fB\fR (\fBrxvt\fR)" 4 2174.ie n .IP "\fB\fB""Pm = 1011""\fB\fR (\fBrxvt\fR)" 4
2158.el .IP "\fB\f(CBPm = 1011\fB\fR (\fBrxvt\fR)" 4 2175.el .IP "\fB\f(CBPm = 1011\fB\fR (\fBrxvt\fR)" 4
2159.IX Item "Pm = 1011 (rxvt)" 2176.IX Item "Pm = 1011 (rxvt)"
2160.TS 2177.TS
2161l l . 2178l l .
2162h Scroll to bottom when a key is pressed 2179h Scroll to bottom when a key is pressed
2163l Don't scroll to bottom when a key is pressed 2180l Don't scroll to bottom when a key is pressed
2164.TE 2181.TE
2182.ie n .IP "\fB\fB""Pm = 1015""\fB\fR (\fBrxvt-unicode\fR) (Compile frills)" 4
2183.el .IP "\fB\f(CBPm = 1015\fB\fR (\fBrxvt-unicode\fR) (Compile frills)" 4
2184.IX Item "Pm = 1015 (rxvt-unicode) (Compile frills)"
2185.PD
2186Changes all mouse reporting codes to use decimal parameters instead of
2187octets or characters.
2188.Sp
2189This mode should be enabled \fIbefore\fR actually enabling mouse reporting,
2190for semi-obvious reasons.
2191.Sp
2192The sequences received for various modes are as follows:
2193.Sp
2194.Vb 3
2195\& ESC [ M o o o !1005, !1015 (three octets)
2196\& ESC [ M c c c 1005, !1015 (three characters)
2197\& ESC [ Pm M 1015 (three or more numeric paramaters)
2198.Ve
2199.Sp
2200The three parameters are \f(CW\*(C`code\*(C'\fR, \f(CW\*(C`x\*(C'\fR and \f(CW\*(C`y\*(C'\fR. Code is the numeric code
2201as for the other modes (but encoded as a decimal number), \f(CW\*(C`x\*(C'\fR and \f(CW\*(C`y\*(C'\fR
2202are the coordinates (1|1 is the upper left corner, just as with cursor
2203positioning).
2204.Sp
2205Example: Shift\-Button\-1 press at top row, column 80.
2206.Sp
2207.Vb 1
2208\& ESC [ 5 ; 80 ; 1 M
2209.Ve
2210.Sp
2211One can use this feature by simply enabling it and then looking for
2212parameters to the \f(CW\*(C`ESC [ M\*(C'\fR reply \- if there are any, this mode is
2213active, otherwise one of the old reporting styles is used.
2214.Sp
2215Other (to be implemented) reply sequences will use a similar encoding.
2216.Sp
2217In the future, more parameters might get added (pixel coordinates for
2218example \- anybody out there who needs this?).
2219.TS
2220l l .
2221h Enable new mouse coordinate reporting.
2222l Use old-style CSI M C C C encoding.
2223.TE
2165.ie n .IP "\fB\fB""Pm = 1021""\fB\fR (\fBrxvt\fR)" 4 2224.ie n .IP "\fB\fB""Pm = 1021""\fB\fR (\fBrxvt\fR)" 4
2166.el .IP "\fB\f(CBPm = 1021\fB\fR (\fBrxvt\fR)" 4 2225.el .IP "\fB\f(CBPm = 1021\fB\fR (\fBrxvt\fR)" 4
2167.IX Item "Pm = 1021 (rxvt)" 2226.IX Item "Pm = 1021 (rxvt)"
2168.TS 2227.TS
2169l l . 2228l l .
2170h Bold/italic implies high intensity (see option -is) 2229h Bold/italic implies high intensity (see option -is)
2171l Font styles have no effect on intensity (Compile styles) 2230l Font styles have no effect on intensity (Compile styles)
2172.TE 2231.TE
2232.PD 0
2173.ie n .IP "\fB\fB""Pm = 1047""\fB\fR" 4 2233.ie n .IP "\fB\fB""Pm = 1047""\fB\fR" 4
2174.el .IP "\fB\f(CBPm = 1047\fB\fR" 4 2234.el .IP "\fB\f(CBPm = 1047\fB\fR" 4
2175.IX Item "Pm = 1047" 2235.IX Item "Pm = 1047"
2176.TS 2236.TS
2177l l . 2237l l .
… …
2252Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 2312Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
2253.TE 2313.TE
2254.SH "BACKGROUND IMAGE" 2314.SH "BACKGROUND IMAGE"
2255.IX Header "BACKGROUND IMAGE" 2315.IX Header "BACKGROUND IMAGE"
2256For the \s-1BACKGROUND\s0 \s-1IMAGE\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR the value 2316For the \s-1BACKGROUND\s0 \s-1IMAGE\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR the value
2257of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background image file followed by a 2317of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be one of the following commands:
2258sequence of scaling/positioning commands separated by semi-colons. The 2318.ie n .IP "\fB\fB""?""\fB\fR" 4
2259scaling/positioning commands are as follows: 2319.el .IP "\fB\f(CB?\fB\fR" 4
2260.IP "query scale/position" 4 2320.IX Item "?"
2261.IX Item "query scale/position" 2321display scale and position in the title
2262\&\fB?\fR 2322.ie n .IP "\fB\fB"";WxH+X+Y""\fB\fR" 4
2323.el .IP "\fB\f(CB;WxH+X+Y\fB\fR" 4
2324.IX Item ";WxH+X+Y"
2263.IP "change scale and position" 4 2325change scale and/or position
2264.IX Item "change scale and position" 2326.ie n .IP "\fB\fB""FILE;WxH+X+Y""\fB\fR" 4
2265\&\fBWxH+X+Y\fR 2327.el .IP "\fB\f(CBFILE;WxH+X+Y\fB\fR" 4
2266.Sp 2328.IX Item "FILE;WxH+X+Y"
2267\&\fBWxH+X\fR (== \fBWxH+X+X\fR) 2329change background image
2268.Sp
2269\&\fBWxH\fR (same as \fBWxH+50+50\fR)
2270.Sp
2271\&\fBW+X+Y\fR (same as \fBWxW+X+Y\fR)
2272.Sp
2273\&\fBW+X\fR (same as \fBWxW+X+X\fR)
2274.Sp
2275\&\fBW\fR (same as \fBWxW+50+50\fR)
2276.IP "change position (absolute)" 4
2277.IX Item "change position (absolute)"
2278\&\fB=+X+Y\fR
2279.Sp
2280\&\fB=+X\fR (same as \fB=+X+Y\fR)
2281.IP "change position (relative)" 4
2282.IX Item "change position (relative)"
2283\&\fB+X+Y\fR
2284.Sp
2285\&\fB+X\fR (same as \fB+X+Y\fR)
2286.IP "rescale (relative)" 4
2287.IX Item "rescale (relative)"
2288\&\fBWx0\fR \-> \fBW *= (W/100)\fR
2289.Sp
2290\&\fB0xH\fR \-> \fBH *= (H/100)\fR
2291.PP
2292For example:
2293.IP "\fB\eE]20;funky.jpg\ea\fR" 4
2294.IX Item "E]20;funky.jpga"
2295load \fBfunky.jpg\fR as a tiled image
2296.IP "\fB\eE]20;mona.jpg;100\ea\fR" 4
2297.IX Item "E]20;mona.jpg;100a"
2298load \fBmona.jpg\fR with a scaling of 100%
2299.IP "\fB\eE]20;;200;?\ea\fR" 4
2300.IX Item "E]20;;200;?a"
2301rescale the current pixmap to 200% and display the image geometry in
2302the title
2303.PP 2330.PP
2304 2331
2305.IX Xref "Mouse" 2332.IX Xref "Mouse"
2306.SH "Mouse Reporting" 2333.SH "Mouse Reporting"
2307.IX Header "Mouse Reporting" 2334.IX Header "Mouse Reporting"
… …
2538It adds support for many file formats including \s-1JPG\s0, \s-1PNG\s0, 2565It adds support for many file formats including \s-1JPG\s0, \s-1PNG\s0,
2539\&\s-1TIFF\s0, \s-1GIF\s0, \s-1XPM\s0, \s-1BMP\s0, \s-1ICO\s0 and \s-1TGA\s0. 2566\&\s-1TIFF\s0, \s-1GIF\s0, \s-1XPM\s0, \s-1BMP\s0, \s-1ICO\s0 and \s-1TGA\s0.
2540.IP "\-\-enable\-transparency (default: on)" 4 2567.IP "\-\-enable\-transparency (default: on)" 4
2541.IX Item "--enable-transparency (default: on)" 2568.IX Item "--enable-transparency (default: on)"
2542Add support for using the root pixmap as background to simulate transparency. 2569Add support for using the root pixmap as background to simulate transparency.
2543Note that tint, blur and blend effects depend on libAfterImage or on 2570Note that blur and blend effects depend on libAfterImage or on
2544libXrender and on the availability of the \s-1RENDER\s0 extension in the X 2571libXrender and on the availability of the \s-1RENDER\s0 extension in the X
2545server. 2572server.
2546.IP "\-\-enable\-fading (default: on)" 4 2573.IP "\-\-enable\-fading (default: on)" 4
2547.IX Item "--enable-fading (default: on)" 2574.IX Item "--enable-fading (default: on)"
2548Add support for fading the text when focus is lost. 2575Add support for fading the text when focus is lost.
… …
2594\& user\-pty (\-pty\-fd) 2621\& user\-pty (\-pty\-fd)
2595\& hold on exit (\-hold) 2622\& hold on exit (\-hold)
2596\& compile in built\-in block graphics 2623\& compile in built\-in block graphics
2597\& skip builtin block graphics (\-sbg) 2624\& skip builtin block graphics (\-sbg)
2598\& separate highlight colour (\-highlightColor, \-highlightTextColor) 2625\& separate highlight colour (\-highlightColor, \-highlightTextColor)
2626\& extended mouse reporting modes (1005 and 1015).
2599.Ve 2627.Ve
2600.Sp 2628.Sp
2601It also enables some non-essential features otherwise disabled, such as: 2629It also enables some non-essential features otherwise disabled, such as:
2602.Sp 2630.Sp
2603.Vb 11 2631.Vb 11

Diff Legend

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