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.50 by root, Thu Jan 19 19:26:31 2006 UTC vs.
Revision 1.55 by root, Mon Jan 30 22:49:30 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-19" "7.1" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-30" "7.4" "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
… …
200other combination either by setting the \fBsearchable-scrollback\fR resource: 200other combination either by setting the \fBsearchable-scrollback\fR resource:
201.Sp 201.Sp
202.Vb 1 202.Vb 1
203\& URxvt.searchable-scrollback: CM-s 203\& URxvt.searchable-scrollback: CM-s
204.Ve 204.Ve
205.IP "Why doesn't rxvt-unicode read my resources?" 4
206.IX Item "Why doesn't rxvt-unicode read my resources?"
207Well, why, indeed? It does, in a way very similar to other X
208applications. Most importantly, this means that if you or your \s-1OS\s0 loads
209resources into the X display (the right way to do it), rxvt-unicode will
210ignore any resource files in your home directory. It will only read
211\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display.
212.Sp
213If you have or use an \fI$HOME/.Xresources\fR file, chances are that
214resources are loaded into your X\-server. In this case, you have to
215re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
216.Sp
217Also consider the form resources have to use:
218.Sp
219.Vb 1
220\& URxvt.resource: value
221.Ve
222.Sp
223If you want to use another form (there are lots of different ways of
224specifying resources), make sure you understand wether and why it
225works. If unsure, use the form above.
226.IP "I can't get transparency working, what am I doing wrong?" 4
227.IX Item "I can't get transparency working, what am I doing wrong?"
228First of all, transparency isn't officially supported in rxvt\-unicode, so
229you are mostly on your own. Do not bug the author about it (but you may
230bug everybody else). Also, if you can't get it working consider it a rite
231of passage, and you failed.
232.Sp
233Here are three ways to get transparency. \fBDo\fR read the manpage and option
234descriptions for the programs mentioned and rxvt\-unicode. Really, do it!
235.Sp
2361. Use inheritPixmap:
237.Sp
238.Vb 2
239\& Esetroot wallpaper.jpg
240\& @@RXVT_NAME@@ -ip -tint red -sh 40
241.Ve
242.Sp
243That works. If you think it doesn't, you lack transparency and tinting
244support, or you are unable to read.
245.Sp
2462. Use a simple pixmap and emulate pseudo\-transparency. This enables you
247to use effects other than tinting and shading: Just shade/tint/whatever
248your picture with gimp:
249.Sp
250.Vb 2
251\& convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
252\& @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
253.Ve
254.Sp
255That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you
256are unable to read.
257.Sp
2583. Use an \s-1ARGB\s0 visual:
259.Sp
260.Vb 1
261\& @@RXVT_NAME@@ -depth 432 -fg grey90 -bg rgba:0000/0000/0000/c000
262.Ve
263.Sp
264This requires \s-1XFT\s0 support, and support form your X\-server. If that doesn't
265work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't there yet,
266no matter what they claim. Rxvt-Unicode contains the neccessary bugfixes
267and workarounds for Xft and Xlib to make it work.
205.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 268.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
206.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 269.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
207I often get asked about this, and I think, no, they didn't cause extra 270I often get asked about this, and I think, no, they didn't cause extra
208bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 271bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
209that the urxvt binary is larger (due to some encoding tables always being 272that the urxvt binary is larger (due to some encoding tables always being
… …
284.Sp 347.Sp
285No large bloated libraries (of course, none were linked in statically), 348No large bloated libraries (of course, none were linked in statically),
286except maybe libX11 :) 349except maybe libX11 :)
287.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4 350.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4
288.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?" 351.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?"
289rxvt-unicode does not directly support tabs. It will work fine with 352Beginning with version 7.3, there is a perl extension that implements a
290tabbing functionality of many window managers or similar tabbing programs, 353simple tabbed terminal. It is installed by default, so any of these should
291and its embedding-features allow it to be embedded into other programs, 354give you tabs:
292as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl 355.Sp
293module, which features a tabbed urxvt (murxvt) terminal as an example 356.Vb 1
294embedding application. 357\& @@RXVT_NAME@@ -pe tabbed
358.Ve
359.Sp
360.Vb 1
361\& URxvt.perl-ext-common: default,tabbed
362.Ve
363.Sp
364It will also work fine with tabbing functionality of many window managers
365or similar tabbing programs, and its embedding-features allow it to be
366embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
367the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
368(murxvt) terminal as an example embedding application.
295.IP "How do I know which rxvt-unicode version I'm using?" 4 369.IP "How do I know which rxvt-unicode version I'm using?" 4
296.IX Item "How do I know which rxvt-unicode version I'm using?" 370.IX Item "How do I know which rxvt-unicode version I'm using?"
297The version number is displayed with the usage (\-h). Also the escape 371The version number is displayed with the usage (\-h). Also the escape
298sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When 372sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
299using the @@RXVT_NAME@@c client, the version displayed is that of the 373using the @@RXVT_NAME@@c client, the version displayed is that of the
… …
1816Ps = 46 Change Log File to Pt unimplemented 1890Ps = 46 Change Log File to Pt unimplemented
1817Ps = 49 Change default background colour to Pt. 1891Ps = 49 Change default background colour to Pt.
1818Ps = 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 1892Ps = 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
1819Ps = 55 Log all scrollback buffer and all of screen to Pt 1893Ps = 55 Log all scrollback buffer and all of screen to Pt
1820Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1894Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1895Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1821Ps = 704 Change colour of italic characters to Pt 1896Ps = 704 Change colour of italic characters to Pt
1822Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1897Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1823Ps = 706 Change colour of bold characters to Pt 1898Ps = 706 Change colour of bold characters to Pt
1824Ps = 707 Change colour of underlined characters to Pt 1899Ps = 707 Change colour of underlined characters to Pt
1825Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1900Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
… …
2043Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2118Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2044alternative input methods (e.g. kinput2) and will also correctly 2119alternative input methods (e.g. kinput2) and will also correctly
2045set up the input for people using dead keys or compose keys. 2120set up the input for people using dead keys or compose keys.
2046.IP "\-\-enable\-unicode3 (default: off)" 4 2121.IP "\-\-enable\-unicode3 (default: off)" 4
2047.IX Item "--enable-unicode3 (default: off)" 2122.IX Item "--enable-unicode3 (default: off)"
2123Recommended to stay off unless you really need non-BMP characters.
2124.Sp
2048Enable direct support for displaying unicode codepoints above 2125Enable direct support for displaying unicode codepoints above
204965535 (the basic multilingual page). This increases storage 212665535 (the basic multilingual page). This increases storage
2050requirements per character from 2 to 4 bytes. X11 fonts do not yet 2127requirements per character from 2 to 4 bytes. X11 fonts do not yet
2051support these extra characters, but Xft does. 2128support these extra characters, but Xft does.
2052.Sp 2129.Sp
… …
2061composite characters. This is required for proper viewing of text 2138composite characters. This is required for proper viewing of text
2062where accents are encoded as seperate unicode characters. This is 2139where accents are encoded as seperate unicode characters. This is
2063done by using precomposited characters when available or creating 2140done by using precomposited characters when available or creating
2064new pseudo-characters when no precomposed form exists. 2141new pseudo-characters when no precomposed form exists.
2065.Sp 2142.Sp
2066Without \-\-enable\-unicode3, the number of additional precomposed characters 2143Without \-\-enable\-unicode3, the number of additional precomposed
2067is rather limited (2048, if this is full, rxvt-unicode will use the 2144characters is somewhat limited (the 6400 private use characters will be
2068private use area, extending the number of combinations to 8448). With
2069\&\-\-enable\-unicode3, no practical limit exists. 2145(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2070.Sp 2146.Sp
2071This option will also enable storage (but not display) of characters 2147This option will also enable storage (but not display) of characters
2072beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2148beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2073.Sp 2149.Sp
2074The combining table also contains entries for arabic presentation forms, 2150The combining table also contains entries for arabic presentation forms,
2075but these are not currently used. Bug me if you want these to be used (and 2151but these are not currently used. Bug me if you want these to be used (and
2076tell me how these are to be used...). 2152tell me how these are to be used...).
2077.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2153.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2078.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2154.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2079When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. 2155When reading resource settings, also read settings for class \s-1CLASS\s0. To
2156disable resource fallback use \-\-disable\-fallback.
2080.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2157.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2081.IX Item "--with-res-name=NAME (default: urxvt)" 2158.IX Item "--with-res-name=NAME (default: urxvt)"
2082Use the given name as default application name when 2159Use the given name as default application name when
2083reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2160reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2084.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2161.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
… …
2151disable this. 2228disable this.
2152.Sp 2229.Sp
2153A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2230A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2154in combination with other switches) is: 2231in combination with other switches) is:
2155.Sp 2232.Sp
2156.Vb 17 2233.Vb 15
2157\& MWM-hints 2234\& MWM-hints
2158\& EWMH-hints (pid, utf8 names) and protocols (ping) 2235\& EWMH-hints (pid, utf8 names) and protocols (ping)
2159\& seperate underline colour (-underlineColor) 2236\& seperate underline colour (-underlineColor)
2160\& settable border widths and borderless switch (-w, -b, -bl) 2237\& settable border widths and borderless switch (-w, -b, -bl)
2238\& visual depth selection (-depth)
2161\& settable extra linespacing /-lsp) 2239\& settable extra linespacing /-lsp)
2162\& iso-14755-2 and -3, and visual feedback 2240\& iso-14755-2 and -3, and visual feedback
2163\& backindex and forwardindex escape sequence
2164\& window op and some xterm/OSC escape sequences
2165\& tripleclickwords (-tcw) 2241\& tripleclickwords (-tcw)
2166\& settable insecure mode (-insecure) 2242\& settable insecure mode (-insecure)
2167\& keysym remapping support 2243\& keysym remapping support
2168\& cursor blinking and underline cursor (-cb, -uc) 2244\& cursor blinking and underline cursor (-cb, -uc)
2169\& XEmbed support (-embed) 2245\& XEmbed support (-embed)
2170\& user-pty (-pty-fd) 2246\& user-pty (-pty-fd)
2171\& hold on exit (-hold) 2247\& hold on exit (-hold)
2172\& skip builtin block graphics (-sbg) 2248\& skip builtin block graphics (-sbg)
2249.Ve
2250.Sp
2251It also enabled some non-essential features otherwise disabled, such as:
2252.Sp
2253.Vb 11
2254\& some round-trip time optimisations
2255\& nearest color allocation on pseudocolor screens
2256\& UTF8_STRING supporr for selection
2173\& sgr modes 90..97 and 100..107 2257\& sgr modes 90..97 and 100..107
2258\& backindex and forwardindex escape sequences
2259\& view change/zero scorllback esacpe sequences
2260\& locale switching escape sequence
2261\& window op and some xterm/OSC escape sequences
2262\& rectangular selections
2263\& trailing space removal for selections
2264\& verbose X error handling
2174.Ve 2265.Ve
2175.IP "\-\-enable\-iso14755 (default: on)" 4 2266.IP "\-\-enable\-iso14755 (default: on)" 4
2176.IX Item "--enable-iso14755 (default: on)" 2267.IX Item "--enable-iso14755 (default: on)"
2177Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2268Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2178\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2269\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
… …
2212keys. This should keep the window corner which is closest to a corner of 2303keys. This should keep the window corner which is closest to a corner of
2213the screen in a fixed position. 2304the screen in a fixed position.
2214.IP "\-\-enable\-pointer\-blank (default: on)" 4 2305.IP "\-\-enable\-pointer\-blank (default: on)" 4
2215.IX Item "--enable-pointer-blank (default: on)" 2306.IX Item "--enable-pointer-blank (default: on)"
2216Add support to have the pointer disappear when typing or inactive. 2307Add support to have the pointer disappear when typing or inactive.
2217.IP "\-\-enable\-perl (default: off)" 4 2308.IP "\-\-enable\-perl (default: on)" 4
2218.IX Item "--enable-perl (default: off)" 2309.IX Item "--enable-perl (default: on)"
2219Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2310Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2220manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2311manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2221in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2312in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2222perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2313perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2223variable when running configure. 2314variable when running configure.

Diff Legend

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