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" |
148 | This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting |
148 | This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting |
149 | all escape sequences, and other background information. |
149 | all escape sequences, and other background information. |
150 | .PP |
150 | .PP |
151 | The newest version of this document is also available on the World Wide Web at |
151 | The 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>. |
152 | http://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 |
154 | The main manual page for @@RXVT_NAME@@ itself is available at |
154 | The 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>. |
155 | http://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 |
… | |
… | |
348 | the case of rxvt-unicode this hardly matters, as its portability limits |
348 | the case of rxvt-unicode this hardly matters, as its portability limits |
349 | are defined by things like X11, pseudo terminals, locale support and unix |
349 | are defined by things like X11, pseudo terminals, locale support and unix |
350 | domain sockets, which are all less portable than \*(C+ itself. |
350 | domain sockets, which are all less portable than \*(C+ itself. |
351 | .PP |
351 | .PP |
352 | Regarding the bloat, see the above question: It's easy to write programs |
352 | Regarding the bloat, see the above question: It's easy to write programs |
353 | in C that use gobs of memory, an certainly possible to write programs in |
353 | in 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 |
355 | not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my |
355 | not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my |
356 | system with a minimal config: |
356 | system 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 |
397 | That works. If you think it doesn't, you lack transparency and tinting |
397 | That works. If you think it doesn't, you lack transparency and tinting |
398 | support, or you are unable to read. |
398 | support, or you are unable to read. |
|
|
399 | This method requires that the background-setting program sets the |
|
|
400 | _XROOTPMAP_ID or \s-1ESETROOT_PMAP_ID\s0 property. Compatible programs |
|
|
401 | are Esetroot, hsetroot and feh. |
399 | .PP |
402 | .PP |
400 | 2. Use a simple pixmap and emulate pseudo-transparency. This enables you |
403 | 2. Use a simple pixmap and emulate pseudo-transparency. This enables you |
401 | to use effects other than tinting and shading: Just shade/tint/whatever |
404 | to use effects other than tinting and shading: Just shade/tint/whatever |
402 | your picture with gimp or any other tool: |
405 | your picture with gimp or any other tool: |
403 | .PP |
406 | .PP |
… | |
… | |
1374 | .PP |
1377 | .PP |
1375 | The Debian GNU/Linux package of rxvt-unicode in sarge contains large |
1378 | The Debian GNU/Linux package of rxvt-unicode in sarge contains large |
1376 | patches that considerably change the behaviour of rxvt-unicode (but |
1379 | patches that considerably change the behaviour of rxvt-unicode (but |
1377 | unfortunately this notice has been removed). Before reporting a bug to |
1380 | unfortunately this notice has been removed). Before reporting a bug to |
1378 | the original rxvt-unicode author please download and install the genuine |
1381 | the original rxvt-unicode author please download and install the genuine |
1379 | version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce |
1382 | version (http://software.schmorp.de#rxvt\-unicode <http://software.schmorp.de#rxvt-unicode>) and try to reproduce |
1380 | the problem. If you cannot, chances are that the problems are specific to |
1383 | the problem. If you cannot, chances are that the problems are specific to |
1381 | Debian GNU/Linux, in which case it should be reported via the Debian Bug |
1384 | Debian GNU/Linux, in which case it should be reported via the Debian Bug |
1382 | Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug). |
1385 | Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug). |
1383 | .PP |
1386 | .PP |
1384 | For other problems that also affect the Debian package, you can and |
1387 | For 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" |
1499 | The literal character c. |
1502 | The 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" |
1503 | A single (required) character. |
1506 | A 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 |
2145 | l l . |
2148 | l l . |
2146 | h Send Mouse X & Y on button press and release, and motion. |
2149 | h Send Mouse X & Y on button press and release, and motion. |
2147 | l No mouse reporting. |
2150 | l 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 |
|
|
2156 | Try to avoid this mode, it doesn't work sensibly in non\-UTF\-8 locales. Use |
|
|
2157 | mode \f(CW1015\fR instead. |
|
|
2158 | .Sp |
|
|
2159 | Unlike XTerm, coordinates larger than 2015) will work fine. |
|
|
2160 | .TS |
|
|
2161 | l l . |
|
|
2162 | h Enable mouse coordinates in locale-specific encoding. |
|
|
2163 | l 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 |
2153 | l l . |
2169 | l l . |
2154 | h Don't scroll to bottom on TTY output |
2170 | h Don't scroll to bottom on TTY output |
2155 | l Scroll to bottom on TTY output |
2171 | l 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 |
2161 | l l . |
2178 | l l . |
2162 | h Scroll to bottom when a key is pressed |
2179 | h Scroll to bottom when a key is pressed |
2163 | l Don't scroll to bottom when a key is pressed |
2180 | l 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 |
|
|
2186 | Changes all mouse reporting codes to use decimal parameters instead of |
|
|
2187 | octets or characters. |
|
|
2188 | .Sp |
|
|
2189 | This mode should be enabled \fIbefore\fR actually enabling mouse reporting, |
|
|
2190 | for semi-obvious reasons. |
|
|
2191 | .Sp |
|
|
2192 | The 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 |
|
|
2200 | The 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 |
|
|
2201 | as for the other modes (but encoded as a decimal number), \f(CW\*(C`x\*(C'\fR and \f(CW\*(C`y\*(C'\fR |
|
|
2202 | are the coordinates (1|1 is the upper left corner, just as with cursor |
|
|
2203 | positioning). |
|
|
2204 | .Sp |
|
|
2205 | Example: Shift\-Button\-1 press at top row, column 80. |
|
|
2206 | .Sp |
|
|
2207 | .Vb 1 |
|
|
2208 | \& ESC [ 5 ; 80 ; 1 M |
|
|
2209 | .Ve |
|
|
2210 | .Sp |
|
|
2211 | One can use this feature by simply enabling it and then looking for |
|
|
2212 | parameters to the \f(CW\*(C`ESC [ M\*(C'\fR reply \- if there are any, this mode is |
|
|
2213 | active, otherwise one of the old reporting styles is used. |
|
|
2214 | .Sp |
|
|
2215 | Other (to be implemented) reply sequences will use a similar encoding. |
|
|
2216 | .Sp |
|
|
2217 | In the future, more parameters might get added (pixel coordinates for |
|
|
2218 | example \- anybody out there who needs this?). |
|
|
2219 | .TS |
|
|
2220 | l l . |
|
|
2221 | h Enable new mouse coordinate reporting. |
|
|
2222 | l 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 |
2169 | l l . |
2228 | l l . |
2170 | h Bold/italic implies high intensity (see option -is) |
2229 | h Bold/italic implies high intensity (see option -is) |
2171 | l Font styles have no effect on intensity (Compile styles) |
2230 | l 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 |
2177 | l l . |
2237 | l l . |
… | |
… | |
2252 | Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). |
2312 | Ps = 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" |
2256 | For the \s-1BACKGROUND\s0 \s-1IMAGE\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR the value |
2316 | For the \s-1BACKGROUND\s0 \s-1IMAGE\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR the value |
2257 | of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background image file followed by a |
2317 | of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be one of the following commands: |
2258 | sequence of scaling/positioning commands separated by semi-colons. The |
2318 | .ie n .IP "\fB\fB""?""\fB\fR" 4 |
2259 | scaling/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" |
2321 | display 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 |
2325 | change 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) |
2329 | change 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 |
|
|
2292 | For example: |
|
|
2293 | .IP "\fB\eE]20;funky.jpg\ea\fR" 4 |
|
|
2294 | .IX Item "E]20;funky.jpga" |
|
|
2295 | load \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" |
|
|
2298 | load \fBmona.jpg\fR with a scaling of 100% |
|
|
2299 | .IP "\fB\eE]20;;200;?\ea\fR" 4 |
|
|
2300 | .IX Item "E]20;;200;?a" |
|
|
2301 | rescale the current pixmap to 200% and display the image geometry in |
|
|
2302 | the 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" |
… | |
… | |
2538 | It adds support for many file formats including \s-1JPG\s0, \s-1PNG\s0, |
2565 | It 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)" |
2542 | Add support for using the root pixmap as background to simulate transparency. |
2569 | Add support for using the root pixmap as background to simulate transparency. |
2543 | Note that tint, blur and blend effects depend on libAfterImage or on |
2570 | Note that blur and blend effects depend on libAfterImage or on |
2544 | libXrender and on the availability of the \s-1RENDER\s0 extension in the X |
2571 | libXrender and on the availability of the \s-1RENDER\s0 extension in the X |
2545 | server. |
2572 | server. |
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)" |
2548 | Add support for fading the text when focus is lost. |
2575 | Add 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 |
2601 | It also enables some non-essential features otherwise disabled, such as: |
2629 | It also enables some non-essential features otherwise disabled, such as: |
2602 | .Sp |
2630 | .Sp |
2603 | .Vb 11 |
2631 | .Vb 11 |