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.40 by root, Wed Jan 11 19:55: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-11" "6.3" "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
… …
198memory. 198memory.
199.Sp 199.Sp
200Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 200Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
201still fares rather well. And compared to some monsters like gnome-terminal 201still fares rather well. And compared to some monsters like gnome-terminal
202(21152k + extra 4204k in separate processes) or konsole (22200k + extra 202(21152k + extra 4204k in separate processes) or konsole (22200k + extra
20343180k in daemons that stay around after exit, plus half aminute of 20343180k in daemons that stay around after exit, plus half a minute of
204startup time, including the hundreds of warnings it spits out), it fares 204startup time, including the hundreds of warnings it spits out), it fares
205extremely well *g*. 205extremely well *g*.
206.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 206.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4
207.IX Item "Why , isn't that unportable/bloated/uncool?" 207.IX Item "Why , isn't that unportable/bloated/uncool?"
208Is this a question? :) It comes up very often. The simple answer is: I had 208Is this a question? :) It comes up very often. The simple answer is: I had
… …
267.Sp 267.Sp
268For other problems that also affect the Debian package, you can and 268For 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 269probably 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 270bug in the Debian version and it serves as a reminder for other users that
271might encounter the same issue. 271might encounter the same issue.
272.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4
273.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
274You should build one binary with the default options. \fIconfigure\fR
275now enables most useful options, and the trend goes to making them
276runtime\-switchable, too, so there is usually no drawback to enbaling them,
277except higher disk and possibly memory usage. The perl interpreter should
278be enabled, as important functionality (menus, selection, likely more in
279the future) depends on it.
280.Sp
281You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
282system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
283behaviour. If your distribution aims at low memory, add an empty
284\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
285perl interpreter disabled until the user enables it.
286.Sp
287If you can/want build more binaries, I recommend building a minimal
288one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
289\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
290encodings built-in that increase download times and are rarely used).
291.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
292.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
293Likely not. While I honestly try to make it secure, and am probably not
294bad at it, I think it is simply unreasonable to expect all of freetype
295+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
296secure. Also, rxvt-unicode disables some options when it detects that it
297runs setuid or setgid, which is not nice. Besides, with the embedded perl
298interpreter the possibility for security problems easily multiplies.
299.Sp
300Elevated privileges are only required for utmp and pty operations on some
301systems (for example, GNU/Linux doesn't need any extra privileges for
302ptys, but some need it for utmp support). It is planned to mvoe this into
303a forked handler process, but this is not yet done.
304.Sp
305So, while setuid/setgid operation is supported and not a problem on your
306typical single-user-no-other-logins unix desktop, always remember that
307its an awful lot of code, most of which isn't checked for security issues
308regularly.
272.IP "When I log-in to another system it tells me about missing terminfo data?" 4 309.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?" 310.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 311The 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). 312as that for xterm, or even rxvt (for which the same problem often arises).
276.Sp 313.Sp
… …
1737Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1774Ps = 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) 1775Ps = 11 Change colour of text background to Pt (NB: may change in future)
1739Ps = 12 Change colour of text cursor foreground to Pt 1776Ps = 12 Change colour of text cursor foreground to Pt
1740Ps = 13 Change colour of mouse foreground to Pt 1777Ps = 13 Change colour of mouse foreground to Pt
1741Ps = 17 Change colour of highlight characters to Pt 1778Ps = 17 Change colour of highlight characters to Pt
1742Ps = 18 Change colour of bold characters to Pt 1779Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1743Ps = 19 Change colour of underlined characters to Pt 1780Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1744Ps = 20 Change default background to Pt 1781Ps = 20 Change default background to Pt
1745Ps = 39 Change default foreground colour to Pt. 1782Ps = 39 Change default foreground colour to Pt.
1746Ps = 46 Change Log File to Pt unimplemented 1783Ps = 46 Change Log File to Pt unimplemented
1747Ps = 49 Change default background colour to Pt. 1784Ps = 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 1785Ps = 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 1786Ps = 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). 1787Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1751Ps = 703 Menubar command Pt (Compile menubar). 1788Ps = 703 Menubar command Pt (Compile menubar).
1752Ps = 704 Change colour of italic characters to Pt 1789Ps = 704 Change colour of italic characters to Pt
1753Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1790Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1791Ps = 706 Change colour of bold characters to Pt
1792Ps = 707 Change colour of underlined characters to Pt
1754Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1793Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1755Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1794Ps = 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). 1795Ps = 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). 1796Ps = 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). 1797Ps = 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). 1798Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1799Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1760.TE 1800.TE
1761 1801
1762.PP 1802.PP
1763 1803
1764.IX Xref "menuBar" 1804.IX Xref "menuBar"
… …
2399.IP "\-\-enable\-lastlog (default: on)" 4 2439.IP "\-\-enable\-lastlog (default: on)" 4
2400.IX Item "--enable-lastlog (default: on)" 2440.IX Item "--enable-lastlog (default: on)"
2401Write user and tty to lastlog file (used by programs like 2441Write user and tty to lastlog file (used by programs like
2402\&\fIlastlogin\fR) at start of rxvt execution. This option requires 2442\&\fIlastlogin\fR) at start of rxvt execution. This option requires
2403\&\-\-enable\-utmp to also be specified. 2443\&\-\-enable\-utmp to also be specified.
2404.IP "\-\-enable\-xpm\-background (default: off)" 4 2444.IP "\-\-enable\-xpm\-background (default: on)" 4
2405.IX Item "--enable-xpm-background (default: off)" 2445.IX Item "--enable-xpm-background (default: on)"
2406Add support for \s-1XPM\s0 background pixmaps. 2446Add support for \s-1XPM\s0 background pixmaps.
2407.IP "\-\-enable\-transparency (default: off)" 4 2447.IP "\-\-enable\-transparency (default: on)" 4
2408.IX Item "--enable-transparency (default: off)" 2448.IX Item "--enable-transparency (default: on)"
2409Add support for inheriting parent backgrounds thus giving a fake 2449Add support for inheriting parent backgrounds thus giving a fake
2410transparency to the term. 2450transparency to the term.
2411.IP "\-\-enable\-fading (default: on)" 4 2451.IP "\-\-enable\-fading (default: on)" 4
2412.IX Item "--enable-fading (default: on)" 2452.IX Item "--enable-fading (default: on)"
2413Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2453Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2414.IP "\-\-enable\-tinting (default: on)" 4 2454.IP "\-\-enable\-tinting (default: on)" 4
2415.IX Item "--enable-tinting (default: on)" 2455.IX Item "--enable-tinting (default: on)"
2416Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2456Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2417.IP "\-\-enable\-menubar (default: off)" 4 2457.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2418.IX Item "--enable-menubar (default: off)" 2458.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2419Add support for our menu bar system (this interacts badly with 2459Add support for our menu bar system (this interacts badly with dynamic
2420dynamic locale switching currently). 2460locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2461in the future.
2421.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2462.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2422.IX Item "--enable-rxvt-scroll (default: on)" 2463.IX Item "--enable-rxvt-scroll (default: on)"
2423Add support for the original rxvt scrollbar. 2464Add support for the original rxvt scrollbar.
2424.IP "\-\-enable\-next\-scroll (default: on)" 4 2465.IP "\-\-enable\-next\-scroll (default: on)" 4
2425.IX Item "--enable-next-scroll (default: on)" 2466.IX Item "--enable-next-scroll (default: on)"
… …
2476disable this. 2517disable this.
2477.Sp 2518.Sp
2478A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2519A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2479in combination with other switches) is: 2520in combination with other switches) is:
2480.Sp 2521.Sp
2481.Vb 13 2522.Vb 17
2482\& MWM-hints 2523\& MWM-hints
2483\& EWMH-hints (pid, utf8 names) and protocols (ping) 2524\& EWMH-hints (pid, utf8 names) and protocols (ping)
2484\& seperate underline colour 2525\& seperate underline colour (-underlineColor)
2485\& settable border widths and borderless switch 2526\& settable border widths and borderless switch (-w, -b, -bl)
2486\& settable extra linespacing 2527\& settable extra linespacing /-lsp)
2487\& iso-14755-2 and -3, and visual feedback 2528\& iso-14755-2 and -3, and visual feedback
2488\& backindex and forwardindex escape sequence 2529\& backindex and forwardindex escape sequence
2489\& window op and some xterm/OSC escape sequences 2530\& window op and some xterm/OSC escape sequences
2490\& tripleclickwords 2531\& tripleclickwords (-tcw)
2491\& settable insecure mode 2532\& settable insecure mode (-insecure)
2492\& keysym remapping support 2533\& keysym remapping support
2493\& cursor blinking and underline cursor 2534\& cursor blinking and underline cursor (-cb, -uc)
2494\& -embed, -pty-fd and -hold options 2535\& XEmbed support (-embed)
2536\& user-pty (-pty-fd)
2537\& hold on exit (-hold)
2538\& skip builtin block graphics (-sbg)
2539\& sgr modes 90..97 and 100..107
2495.Ve 2540.Ve
2496.IP "\-\-enable\-iso14755 (default: on)" 4 2541.IP "\-\-enable\-iso14755 (default: on)" 4
2497.IX Item "--enable-iso14755 (default: on)" 2542.IX Item "--enable-iso14755 (default: on)"
2498Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2543Enable 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 2544\&\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 2578keys. This should keep the window corner which is closest to a corner of
2534the screen in a fixed position. 2579the screen in a fixed position.
2535.IP "\-\-enable\-pointer\-blank (default: on)" 4 2580.IP "\-\-enable\-pointer\-blank (default: on)" 4
2536.IX Item "--enable-pointer-blank (default: on)" 2581.IX Item "--enable-pointer-blank (default: on)"
2537Add support to have the pointer disappear when typing or inactive. 2582Add support to have the pointer disappear when typing or inactive.
2583.IP "\-\-enable\-perl (default: off)" 4
2584.IX Item "--enable-perl (default: off)"
2585Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2586manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2587in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2588perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2589variable when running configure.
2538.IP "\-\-with\-name=NAME (default: urxvt)" 4 2590.IP "\-\-with\-name=NAME (default: urxvt)" 4
2539.IX Item "--with-name=NAME (default: urxvt)" 2591.IX Item "--with-name=NAME (default: urxvt)"
2540Set the basename for the installed binaries, resulting 2592Set 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 2593in \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. 2594\&\f(CW\*(C`rxvt\*(C'\fR.

Diff Legend

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