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.12 by root, Fri Feb 11 18:06:44 2005 UTC vs.
Revision 1.20 by root, Sun Apr 17 22:36:13 2005 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 "2005-02-11" "5.0" "RXVT-UNICODE" 132.TH rxvt 7 "2005-04-17" "5.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
214.IP "I need a termcap file entry." 4 214.IP "I need a termcap file entry." 4
215.IX Item "I need a termcap file entry." 215.IX Item "I need a termcap file entry."
216.PD 216.PD
217One reason you might want this is that some distributions or operating 217One reason you might want this is that some distributions or operating
218systems still compile some programs using the long-obsoleted termcap 218systems still compile some programs using the long-obsoleted termcap
219(Fedora Core's bash is one example) and rely on a termcap entry for 219library (Fedora Core's bash is one example) and rely on a termcap entry
220\&\f(CW\*(C`rxvt\-unicode\*(C'\fR. 220for \f(CW\*(C`rxvt\-unicode\*(C'\fR.
221.Sp 221.Sp
222You could use rxvt's termcap entry with resonable results in many cases. 222You could use rxvt's termcap entry with resonable results in many cases.
223You can also create a termcap entry by using terminfo's infocmp program 223You can also create a termcap entry by using terminfo's infocmp program
224like this: 224like this:
225.Sp 225.Sp
227\& infocmp -C rxvt-unicode 227\& infocmp -C rxvt-unicode
228.Ve 228.Ve
229.Sp 229.Sp
230Or you could use this termcap entry, generated by the command above: 230Or you could use this termcap entry, generated by the command above:
231.Sp 231.Sp
232.Vb 19 232.Vb 20
233\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e 233\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e
234\& :am:bw:eo:km:mi:ms:xn:xo:\e 234\& :am:bw:eo:km:mi:ms:xn:xo:\e
235\& :co#80:it#8:li#24:\e 235\& :co#80:it#8:li#24:lm#0:\e
236\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e 236\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e
237\& :K1=\eEOw:K2=\eEOu:K3=\eEOy:K4=\eEOq:K5=\eEOs:LE=\eE[%dD:\e 237\& :K1=\eEOw:K2=\eEOu:K3=\eEOy:K4=\eEOq:K5=\eEOs:LE=\eE[%dD:\e
238\& :RI=\eE[%dC:SF=\eE[%dS:SR=\eE[%dT:UP=\eE[%dA:ae=^O:al=\eE[L:\e 238\& :RI=\eE[%dC:SF=\eE[%dS:SR=\eE[%dT:UP=\eE[%dA:ae=\eE(B:al=\eE[L:\e
239\& :as=^N:bl=^G:cd=\eE[J:ce=\eE[K:cl=\eE[H\eE[2J:cm=\eE[%i%d;%dH:\e 239\& :as=\eE(0:bl=^G:cd=\eE[J:ce=\eE[K:cl=\eE[H\eE[2J:\e
240\& :cr=^M:cs=\eE[%i%d;%dr:ct=\eE[3g:dc=\eE[P:dl=\eE[M:do=^J:\e 240\& :cm=\eE[%i%d;%dH:cr=^M:cs=\eE[%i%d;%dr:ct=\eE[3g:dc=\eE[P:\e
241\& :ec=\eE[%dX:ei=\eE[4l:ho=\eE[H:i1=\eE[?47l\eE=\eE[?1l:ic=\eE[@:\e 241\& :dl=\eE[M:do=^J:ec=\eE[%dX:ei=\eE[4l:ho=\eE[H:\e
242\& :i1=\eE[?47l\eE=\eE[?1l:ic=\eE[@:im=\eE[4h:\e
242\& :im=\eE[4h:is=\eE[r\eE[m\eE[2J\eE[H\eE[?7h\eE[?1;3;4;6l\eE[4l:\e 243\& :is=\eE[r\eE[m\eE[2J\eE[H\eE[?7h\eE[?1;3;4;6l\eE[4l:\e
243\& :k0=\eE[21~:k1=\eE[11~:k2=\eE[12~:k3=\eE[13~:k4=\eE[14~:\e 244\& :k1=\eE[11~:k2=\eE[12~:k3=\eE[13~:k4=\eE[14~:k5=\eE[15~:\e
244\& :k5=\eE[15~:k6=\eE[17~:k7=\eE[18~:k8=\eE[19~:k9=\eE[20~:\e 245\& :k6=\eE[17~:k7=\eE[18~:k8=\eE[19~:k9=\eE[20~:kD=\eE[3~:\e
245\& :kD=\eE[3~:kI=\eE[2~:kN=\eE[6~:kP=\eE[5~:kb=\e177:kd=\eEOB:\e 246\& :kI=\eE[2~:kN=\eE[6~:kP=\eE[5~:kb=\e177:kd=\eEOB:ke=\eE[?1l\eE>:\e
246\& :ke=\eE[?1l\eE>:kh=\eE[7~:kl=\eEOD:kr=\eEOC:ks=\eE[?1h\eE=:\e 247\& :kh=\eE[7~:kl=\eEOD:kr=\eEOC:ks=\eE[?1h\eE=:ku=\eEOA:le=^H:\e
247\& :ku=\eEOA:le=^H:mb=\eE[5m:md=\eE[1m:me=\eE[m\e017:mr=\eE[7m:\e 248\& :mb=\eE[5m:md=\eE[1m:me=\eE[m\e017:mr=\eE[7m:nd=\eE[C:rc=\eE8:\e
248\& :nd=\eE[C:rc=\eE8:sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:\e 249\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e
249\& :st=\eEH:ta=^I:te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:\e 250\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e
250\& :up=\eE[A:us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e 251\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e
251\& :vs=\eE[?25h: 252\& :vs=\eE[?25h:
252.Ve 253.Ve
253.ie n .IP "Why does ""ls"" no longer have coloured output?" 4 254.ie n .IP "Why does ""ls"" no longer have coloured output?" 4
254.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4 255.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4
255.IX Item "Why does ls no longer have coloured output?" 256.IX Item "Why does ls no longer have coloured output?"
456.Sp 457.Sp
457As you might have guessed, FreeBSD does neither define this symobl nor 458As you might have guessed, FreeBSD does neither define this symobl nor
458does it support it. Instead, it uses it's own internal representation of 459does it support it. Instead, it uses it's own internal representation of
459\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards. 460\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards.
460.Sp 461.Sp
462However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and
463\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR.
464.Sp
461However, \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support 465\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language
462multi-language apps in an \s-1OS\s0, as using a locale-dependent (and 466apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized)
463non\-standardized) representation of \fBwchar_t\fR makes it impossible to 467representation of \fBwchar_t\fR makes it impossible to convert between
464convert between \fBwchar_t\fR (as used by X11 and your applications) and any 468\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding
465other encoding without implementing OS-specific-wrappers for each and 469without implementing OS-specific-wrappers for each and every locale. There
466every locale. There simply are no APIs to convert \fBwchar_t\fR into anything 470simply are no APIs to convert \fBwchar_t\fR into anything except the current
467except the current locale encoding. 471locale encoding.
468.Sp 472.Sp
469Some applications (such as the formidable \fBmlterm\fR) work around this 473Some applications (such as the formidable \fBmlterm\fR) work around this
470by carrying their own replacement functions for character set handling 474by carrying their own replacement functions for character set handling
471with them, and either implementing OS-dependent hacks or doing multiple 475with them, and either implementing OS-dependent hacks or doing multiple
472conversions (which is slow and unreliable in case the \s-1OS\s0 implements 476conversions (which is slow and unreliable in case the \s-1OS\s0 implements
574.Sp 578.Sp
575Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still 579Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
576use your input method. Please note, however, that you will not be able to 580use your input method. Please note, however, that you will not be able to
577input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input 581input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
578method limits you. 582method limits you.
583.IP "Rxvt-unicode crashes when the X Input Method changes or exits." 4
584.IX Item "Rxvt-unicode crashes when the X Input Method changes or exits."
585Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
586design. Applications can avoid some crashes at the expense of memory
587leaks, and Input Methods can avoid some crashes by careful ordering at
588exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
589while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
590crashes cannot be completely avoided even if both sides cooperate.
591.Sp
592So the only workaround is not to kill your Input Method Servers.
579.IP "Rxvt-unicode uses gobs of memory, how can I reduce that?" 4 593.IP "Rxvt-unicode uses gobs of memory, how can I reduce that?" 4
580.IX Item "Rxvt-unicode uses gobs of memory, how can I reduce that?" 594.IX Item "Rxvt-unicode uses gobs of memory, how can I reduce that?"
581Rxvt-unicode tries to obey the rule of not charging you for something you 595Rxvt-unicode tries to obey the rule of not charging you for something you
582don't use. One thing you should try is to configure out all settings that 596don't use. One thing you should try is to configure out all settings that
583you don't need, for example, Xft support is a resource hog by design, 597you don't need, for example, Xft support is a resource hog by design,
1602Ps = 13 Change colour of mouse foreground to Pt 1616Ps = 13 Change colour of mouse foreground to Pt
1603Ps = 17 Change colour of highlight characters to Pt 1617Ps = 17 Change colour of highlight characters to Pt
1604Ps = 18 Change colour of bold characters to Pt 1618Ps = 18 Change colour of bold characters to Pt
1605Ps = 19 Change colour of underlined characters to Pt 1619Ps = 19 Change colour of underlined characters to Pt
1606Ps = 20 Change default background to Pt 1620Ps = 20 Change default background to Pt
1607Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1621Ps = 39 Change default foreground colour to Pt.
1608Ps = 46 Change Log File to Pt unimplemented 1622Ps = 46 Change Log File to Pt unimplemented
1609Ps = 49 Change default background colour to Pt rxvt compile-time option 1623Ps = 49 Change default background colour to Pt.
1610Ps = 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 1624Ps = 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
1611Ps = 55 Log all scrollback buffer and all of screen to Pt 1625Ps = 55 Log all scrollback buffer and all of screen to Pt
1612Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (@@RXVT_NAME@@ extension) 1626Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1613Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension) 1627Ps = 703 Menubar command Pt (Compile menubar).
1614Ps = 704 Change colour of italic characters to Pt 1628Ps = 704 Change colour of italic characters to Pt
1615Ps = 705 Change background pixmap tint colour to Pt 1629Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1616Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1630Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1617Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1631Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1618Ps = 712 Set italic fontset to Pt. Similar to Ps = 50. 1632Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1619Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50. 1633Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1634Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1635Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1620.TE 1636.TE
1621 1637
1622.PP 1638.PP
1623 1639
1624.IX Xref "menuBar" 1640.IX Xref "menuBar"
1669access the current menuBar for alteration 1685access the current menuBar for alteration
1670.IP "\fB[title:+\f(BIstring\fB]\fR" 4 1686.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1671.IX Item "[title:+string]" 1687.IX Item "[title:+string]"
1672set the current menuBar's title to \fIstring\fR, which may contain the 1688set the current menuBar's title to \fIstring\fR, which may contain the
1673following format specifiers: 1689following format specifiers:
1674\&\fB%%\fR : literal \fB%\fR character 1690.Sp
1691.Vb 3
1675\&\fB%n\fR : rxvt name (as per the \fB\-name\fR command-line option) 1692\& B<%n> rxvt name (as per the B<-name> command-line option)
1676\&\fB%v\fR : rxvt version 1693\& B<%v> rxvt version
1694\& B<%%> literal B<%> character
1695.Ve
1677.IP "\fB[done]\fR" 4 1696.IP "\fB[done]\fR" 4
1678.IX Item "[done]" 1697.IX Item "[done]"
1679set menuBar access as \fBreadonly\fR. 1698set menuBar access as \fBreadonly\fR.
1680End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations. 1699End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1681.IP "\fB[read:+\f(BIfile\fB]\fR" 4 1700.IP "\fB[read:+\f(BIfile\fB]\fR" 4
2171.IX Item "--enable-font-styles" 2190.IX Item "--enable-font-styles"
2172Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font 2191Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font
2173styles. The fonts can be set manually or automatically. 2192styles. The fonts can be set manually or automatically.
2174.IP "\-\-with\-codesets=NAME,..." 4 2193.IP "\-\-with\-codesets=NAME,..." 4
2175.IX Item "--with-codesets=NAME,..." 2194.IX Item "--with-codesets=NAME,..."
2176Compile in support for additional codeset (encoding) groups (eu, vn are 2195Compile in support for additional codeset (encoding) groups (\f(CW\*(C`eu\*(C'\fR, \f(CW\*(C`vn\*(C'\fR
2177always compiled in, which includes most 8\-bit character sets). These 2196are always compiled in, which includes most 8\-bit character sets). These
2178codeset tables are currently only used for driving X11 core fonts, they 2197codeset tables are used for driving X11 core fonts, they are not required
2179are not required for Xft fonts. Compiling them in will make your binary 2198for Xft fonts, although having them compiled in lets rxvt-unicode choose
2180bigger (together about 700kB), but it doesn't increase memory usage unless 2199replacement fonts more intelligently. Compiling them in will make your
2200binary bigger (all of together cost about 700kB), but it doesn't increase
2181you use an X11 font requiring one of these encodings. 2201memory usage unless you use a font requiring one of these encodings.
2182.TS 2202.TS
2183l l . 2203l l .
2184all all available codeset groups 2204all all available codeset groups
2185zh common chinese encodings 2205zh common chinese encodings
2186zh_ext rarely used but very big chinese encodigs 2206zh_ext rarely used but very big chinese encodigs
2212composite characters. This is required for proper viewing of text 2232composite characters. This is required for proper viewing of text
2213where accents are encoded as seperate unicode characters. This is 2233where accents are encoded as seperate unicode characters. This is
2214done by using precomposited characters when available or creating 2234done by using precomposited characters when available or creating
2215new pseudo-characters when no precomposed form exists. 2235new pseudo-characters when no precomposed form exists.
2216.Sp 2236.Sp
2217Without \-\-enable\-unicode3, the number of additional precomposed 2237Without \-\-enable\-unicode3, the number of additional precomposed characters
2218characters is rather limited (2048, if this is full, rxvt will use the 2238is rather limited (2048, if this is full, rxvt-unicode will use the
2219private use area, extending the number of combinations to 8448). With 2239private use area, extending the number of combinations to 8448). With
2220\&\-\-enable\-unicode3, no practical limit exists. This will also enable 2240\&\-\-enable\-unicode3, no practical limit exists.
2221storage of characters >65535. 2241.Sp
2242This option will also enable storage (but not display) of characters
2243beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2222.Sp 2244.Sp
2223The combining table also contains entries for arabic presentation forms, 2245The combining table also contains entries for arabic presentation forms,
2224but these are not currently used. Bug me if you want these to be used. 2246but these are not currently used. Bug me if you want these to be used (and
2247tell me how these are to be used...).
2225.IP "\-\-enable\-fallback(=CLASS)" 4 2248.IP "\-\-enable\-fallback(=CLASS)" 4
2226.IX Item "--enable-fallback(=CLASS)" 2249.IX Item "--enable-fallback(=CLASS)"
2227When reading resource settings, also read settings for class \s-1CLASS\s0 2250When reading resource settings, also read settings for class \s-1CLASS\s0
2228(default: Rxvt). To disable resource fallback use \-\-disable\-fallback. 2251(default: Rxvt). To disable resource fallback use \-\-disable\-fallback.
2229.IP "\-\-with\-res\-name=NAME" 4 2252.IP "\-\-with\-res\-name=NAME" 4
2325disable this. 2348disable this.
2326.Sp 2349.Sp
2327A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2350A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2328in combination with other switches) is: 2351in combination with other switches) is:
2329.Sp 2352.Sp
2330.Vb 11 2353.Vb 13
2331\& MWM-hints 2354\& MWM-hints
2355\& EWMH-hints (pid, utf8 names) and protocols (ping)
2332\& seperate underline colour 2356\& seperate underline colour
2333\& settable border widths and borderless switch 2357\& settable border widths and borderless switch
2334\& settable extra linespacing 2358\& settable extra linespacing
2335\& extra window properties (e.g. UTF-8 window names and PID)
2336\& iso-14755-2 and -3, and visual feedback 2359\& iso-14755-2 and -3, and visual feedback
2337\& backindex and forwardindex escape sequence 2360\& backindex and forwardindex escape sequence
2338\& window op and locale change escape sequences 2361\& window op and some xterm/OSC escape sequences
2339\& tripleclickwords 2362\& tripleclickwords
2340\& settable insecure mode 2363\& settable insecure mode
2341\& keysym remapping support 2364\& keysym remapping support
2365\& cursor blinking and underline cursor
2366\& -embed and -pty-fd options
2342.Ve 2367.Ve
2343.IP "\-\-enable\-iso14755" 4 2368.IP "\-\-enable\-iso14755" 4
2344.IX Item "--enable-iso14755" 2369.IX Item "--enable-iso14755"
2345Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2370Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2346\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2371\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
2377.IP "\-\-enable\-smart\-resize" 4 2402.IP "\-\-enable\-smart\-resize" 4
2378.IX Item "--enable-smart-resize" 2403.IX Item "--enable-smart-resize"
2379Add smart growth/shrink behaviour when changing font size via from hot 2404Add smart growth/shrink behaviour when changing font size via from hot
2380keys. This should keep in a fixed position the rxvt corner which is 2405keys. This should keep in a fixed position the rxvt corner which is
2381closest to a corner of the screen. 2406closest to a corner of the screen.
2382.IP "\-\-enable\-cursor\-blink" 4
2383.IX Item "--enable-cursor-blink"
2384Add support for a blinking cursor.
2385.IP "\-\-enable\-pointer\-blank" 4 2407.IP "\-\-enable\-pointer\-blank" 4
2386.IX Item "--enable-pointer-blank" 2408.IX Item "--enable-pointer-blank"
2387Add support to have the pointer disappear when typing or inactive. 2409Add support to have the pointer disappear when typing or inactive.
2388.IP "\-\-with\-name=NAME" 4 2410.IP "\-\-with\-name=NAME" 4
2389.IX Item "--with-name=NAME" 2411.IX Item "--with-name=NAME"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines