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.30 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.42 by root, Thu Jan 12 05:37:34 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 7" 131.IX Title "rxvt 7"
132.TH rxvt 7 "2006-01-02" "6.2" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-12" "7.0" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
… …
156The newest version of this document is 156The newest version of this document is
157also available on the World Wide Web at 157also available on the World Wide Web at
158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
159.SH "FREQUENTLY ASKED QUESTIONS" 159.SH "FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 160.IX Header "FREQUENTLY ASKED QUESTIONS"
161.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4
162.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
163You can disable the perl extension completely by setting the
164\&\fBperl-ext-common\fR resource to the empty string, which also keeps
165rxvt-unicode from initialising perl, saving memory.
166.Sp
167If you only want to disable specific features, you first have to
168identify which perl extension is responsible. For this, read the section
169\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For
170example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
171this \fBperl-ext-common\fR resource:
172.Sp
173.Vb 1
174\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
175.Ve
176.Sp
177This will keep the default extensions, but disable the two popup
178extensions. Some extensions can also be configured, for example,
179scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
180other combination either by setting the \fBsearchable-scrollback\fR resource:
181.Sp
182.Vb 1
183\& URxvt.searchable-scrollback: CM-s
184.Ve
161.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 185.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
162.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 186.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
163I often get asked about this, and I think, no, they didn't cause extra 187I often get asked about this, and I think, no, they didn't cause extra
164bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 188bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
165that the urxvt binary is larger (due to some encoding tables always being 189that the urxvt binary is larger (due to some encoding tables always being
… …
198memory. 222memory.
199.Sp 223.Sp
200Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 224Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
201still fares rather well. And compared to some monsters like gnome-terminal 225still fares rather well. And compared to some monsters like gnome-terminal
202(21152k + extra 4204k in separate processes) or konsole (22200k + extra 226(21152k + extra 4204k in separate processes) or konsole (22200k + extra
20343180k in daemons that stay around after exit, plus half aminute of 22743180k in daemons that stay around after exit, plus half a minute of
204startup time, including the hundreds of warnings it spits out), it fares 228startup time, including the hundreds of warnings it spits out), it fares
205extremely well *g*. 229extremely well *g*.
206.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 230.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4
207.IX Item "Why , isn't that unportable/bloated/uncool?" 231.IX Item "Why , isn't that unportable/bloated/uncool?"
208Is this a question? :) It comes up very often. The simple answer is: I had 232Is this a question? :) It comes up very often. The simple answer is: I had
… …
267.Sp 291.Sp
268For other problems that also affect the Debian package, you can and 292For other problems that also affect the Debian package, you can and
269probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 293probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
270bug in the Debian version and it serves as a reminder for other users that 294bug in the Debian version and it serves as a reminder for other users that
271might encounter the same issue. 295might encounter the same issue.
296.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4
297.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
298You should build one binary with the default options. \fIconfigure\fR
299now enables most useful options, and the trend goes to making them
300runtime\-switchable, too, so there is usually no drawback to enbaling them,
301except higher disk and possibly memory usage. The perl interpreter should
302be enabled, as important functionality (menus, selection, likely more in
303the future) depends on it.
304.Sp
305You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
306system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
307behaviour. If your distribution aims at low memory, add an empty
308\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
309perl interpreter disabled until the user enables it.
310.Sp
311If you can/want build more binaries, I recommend building a minimal
312one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
313\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
314encodings built-in that increase download times and are rarely used).
315.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
316.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
317Likely not. While I honestly try to make it secure, and am probably not
318bad at it, I think it is simply unreasonable to expect all of freetype
319+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
320secure. Also, rxvt-unicode disables some options when it detects that it
321runs setuid or setgid, which is not nice. Besides, with the embedded perl
322interpreter the possibility for security problems easily multiplies.
323.Sp
324Elevated privileges are only required for utmp and pty operations on some
325systems (for example, GNU/Linux doesn't need any extra privileges for
326ptys, but some need it for utmp support). It is planned to mvoe this into
327a forked handler process, but this is not yet done.
328.Sp
329So, while setuid/setgid operation is supported and not a problem on your
330typical single-user-no-other-logins unix desktop, always remember that
331its an awful lot of code, most of which isn't checked for security issues
332regularly.
272.IP "When I log-in to another system it tells me about missing terminfo data?" 4 333.IP "When I log-in to another system it tells me about missing terminfo data?" 4
273.IX Item "When I log-in to another system it tells me about missing terminfo data?" 334.IX Item "When I log-in to another system it tells me about missing terminfo data?"
274The terminal description used by rxvt-unicode is not as widely available 335The terminal description used by rxvt-unicode is not as widely available
275as that for xterm, or even rxvt (for which the same problem often arises). 336as that for xterm, or even rxvt (for which the same problem often arises).
276.Sp 337.Sp
… …
1737Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1798Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1738Ps = 11 Change colour of text background to Pt (NB: may change in future) 1799Ps = 11 Change colour of text background to Pt (NB: may change in future)
1739Ps = 12 Change colour of text cursor foreground to Pt 1800Ps = 12 Change colour of text cursor foreground to Pt
1740Ps = 13 Change colour of mouse foreground to Pt 1801Ps = 13 Change colour of mouse foreground to Pt
1741Ps = 17 Change colour of highlight characters to Pt 1802Ps = 17 Change colour of highlight characters to Pt
1742Ps = 18 Change colour of bold characters to Pt 1803Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1743Ps = 19 Change colour of underlined characters to Pt 1804Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1744Ps = 20 Change default background to Pt 1805Ps = 20 Change default background to Pt
1745Ps = 39 Change default foreground colour to Pt. 1806Ps = 39 Change default foreground colour to Pt.
1746Ps = 46 Change Log File to Pt unimplemented 1807Ps = 46 Change Log File to Pt unimplemented
1747Ps = 49 Change default background colour to Pt. 1808Ps = 49 Change default background colour to Pt.
1748Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1809Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1749Ps = 55 Log all scrollback buffer and all of screen to Pt 1810Ps = 55 Log all scrollback buffer and all of screen to Pt
1750Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1811Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1751Ps = 703 Menubar command Pt (Compile menubar). 1812Ps = 703 Menubar command Pt (Compile menubar).
1752Ps = 704 Change colour of italic characters to Pt 1813Ps = 704 Change colour of italic characters to Pt
1753Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1814Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1815Ps = 706 Change colour of bold characters to Pt
1816Ps = 707 Change colour of underlined characters to Pt
1754Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1817Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1755Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1818Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1756Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1819Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1757Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1820Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1758Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1821Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1759Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1822Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1823Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1760.TE 1824.TE
1761 1825
1762.PP 1826.PP
1763 1827
1764.IX Xref "menuBar" 1828.IX Xref "menuBar"
… …
2399.IP "\-\-enable\-lastlog (default: on)" 4 2463.IP "\-\-enable\-lastlog (default: on)" 4
2400.IX Item "--enable-lastlog (default: on)" 2464.IX Item "--enable-lastlog (default: on)"
2401Write user and tty to lastlog file (used by programs like 2465Write user and tty to lastlog file (used by programs like
2402\&\fIlastlogin\fR) at start of rxvt execution. This option requires 2466\&\fIlastlogin\fR) at start of rxvt execution. This option requires
2403\&\-\-enable\-utmp to also be specified. 2467\&\-\-enable\-utmp to also be specified.
2404.IP "\-\-enable\-xpm\-background (default: off)" 4 2468.IP "\-\-enable\-xpm\-background (default: on)" 4
2405.IX Item "--enable-xpm-background (default: off)" 2469.IX Item "--enable-xpm-background (default: on)"
2406Add support for \s-1XPM\s0 background pixmaps. 2470Add support for \s-1XPM\s0 background pixmaps.
2407.IP "\-\-enable\-transparency (default: off)" 4 2471.IP "\-\-enable\-transparency (default: on)" 4
2408.IX Item "--enable-transparency (default: off)" 2472.IX Item "--enable-transparency (default: on)"
2409Add support for inheriting parent backgrounds thus giving a fake 2473Add support for inheriting parent backgrounds thus giving a fake
2410transparency to the term. 2474transparency to the term.
2411.IP "\-\-enable\-fading (default: on)" 4 2475.IP "\-\-enable\-fading (default: on)" 4
2412.IX Item "--enable-fading (default: on)" 2476.IX Item "--enable-fading (default: on)"
2413Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2477Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2414.IP "\-\-enable\-tinting (default: on)" 4 2478.IP "\-\-enable\-tinting (default: on)" 4
2415.IX Item "--enable-tinting (default: on)" 2479.IX Item "--enable-tinting (default: on)"
2416Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2480Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2417.IP "\-\-enable\-menubar (default: off)" 4 2481.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2418.IX Item "--enable-menubar (default: off)" 2482.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2419Add support for our menu bar system (this interacts badly with 2483Add support for our menu bar system (this interacts badly with dynamic
2420dynamic locale switching currently). 2484locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2485in the future.
2421.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2486.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2422.IX Item "--enable-rxvt-scroll (default: on)" 2487.IX Item "--enable-rxvt-scroll (default: on)"
2423Add support for the original rxvt scrollbar. 2488Add support for the original rxvt scrollbar.
2424.IP "\-\-enable\-next\-scroll (default: on)" 4 2489.IP "\-\-enable\-next\-scroll (default: on)" 4
2425.IX Item "--enable-next-scroll (default: on)" 2490.IX Item "--enable-next-scroll (default: on)"
… …
2448Removes any handling of the delete key by us \- let the X server 2513Removes any handling of the delete key by us \- let the X server
2449do it. 2514do it.
2450.IP "\-\-disable\-resources" 4 2515.IP "\-\-disable\-resources" 4
2451.IX Item "--disable-resources" 2516.IX Item "--disable-resources"
2452Removes any support for resource checking. 2517Removes any support for resource checking.
2453.IP "\-\-enable\-xgetdefault" 4
2454.IX Item "--enable-xgetdefault"
2455Make resources checking via \fIXGetDefault()\fR instead of our small
2456version which only checks ~/.Xdefaults, or if that doesn't exist then
2457~/.Xresources.
2458.Sp
2459Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and
2460use the full X resource manager, so the overhead of using it might be very
2461small, if nonexistant.
2462.IP "\-\-enable\-strings (default: off)" 4 2518.IP "\-\-enable\-strings (default: off)" 4
2463.IX Item "--enable-strings (default: off)" 2519.IX Item "--enable-strings (default: off)"
2464Add support for our possibly faster \fImemset()\fR function and other 2520Add support for our possibly faster \fImemset()\fR function and other
2465various routines, overriding your system's versions which may 2521various routines, overriding your system's versions which may
2466have been hand-crafted in assembly or may require extra libraries 2522have been hand-crafted in assembly or may require extra libraries
… …
2476disable this. 2532disable this.
2477.Sp 2533.Sp
2478A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2534A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2479in combination with other switches) is: 2535in combination with other switches) is:
2480.Sp 2536.Sp
2481.Vb 13 2537.Vb 17
2482\& MWM-hints 2538\& MWM-hints
2483\& EWMH-hints (pid, utf8 names) and protocols (ping) 2539\& EWMH-hints (pid, utf8 names) and protocols (ping)
2484\& seperate underline colour 2540\& seperate underline colour (-underlineColor)
2485\& settable border widths and borderless switch 2541\& settable border widths and borderless switch (-w, -b, -bl)
2486\& settable extra linespacing 2542\& settable extra linespacing /-lsp)
2487\& iso-14755-2 and -3, and visual feedback 2543\& iso-14755-2 and -3, and visual feedback
2488\& backindex and forwardindex escape sequence 2544\& backindex and forwardindex escape sequence
2489\& window op and some xterm/OSC escape sequences 2545\& window op and some xterm/OSC escape sequences
2490\& tripleclickwords 2546\& tripleclickwords (-tcw)
2491\& settable insecure mode 2547\& settable insecure mode (-insecure)
2492\& keysym remapping support 2548\& keysym remapping support
2493\& cursor blinking and underline cursor 2549\& cursor blinking and underline cursor (-cb, -uc)
2494\& -embed, -pty-fd and -hold options 2550\& XEmbed support (-embed)
2551\& user-pty (-pty-fd)
2552\& hold on exit (-hold)
2553\& skip builtin block graphics (-sbg)
2554\& sgr modes 90..97 and 100..107
2495.Ve 2555.Ve
2496.IP "\-\-enable\-iso14755 (default: on)" 4 2556.IP "\-\-enable\-iso14755 (default: on)" 4
2497.IX Item "--enable-iso14755 (default: on)" 2557.IX Item "--enable-iso14755 (default: on)"
2498Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2558Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2499\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2559\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
… …
2533keys. This should keep the window corner which is closest to a corner of 2593keys. This should keep the window corner which is closest to a corner of
2534the screen in a fixed position. 2594the screen in a fixed position.
2535.IP "\-\-enable\-pointer\-blank (default: on)" 4 2595.IP "\-\-enable\-pointer\-blank (default: on)" 4
2536.IX Item "--enable-pointer-blank (default: on)" 2596.IX Item "--enable-pointer-blank (default: on)"
2537Add support to have the pointer disappear when typing or inactive. 2597Add support to have the pointer disappear when typing or inactive.
2598.IP "\-\-enable\-perl (default: off)" 4
2599.IX Item "--enable-perl (default: off)"
2600Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2601manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2602in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2603perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2604variable when running configure.
2538.IP "\-\-with\-name=NAME (default: urxvt)" 4 2605.IP "\-\-with\-name=NAME (default: urxvt)" 4
2539.IX Item "--with-name=NAME (default: urxvt)" 2606.IX Item "--with-name=NAME (default: urxvt)"
2540Set the basename for the installed binaries, resulting 2607Set the basename for the installed binaries, resulting
2541in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with 2608in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with
2542\&\f(CW\*(C`rxvt\*(C'\fR. 2609\&\f(CW\*(C`rxvt\*(C'\fR.

Diff Legend

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