ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.txt (file contents):
Revision 1.12 by root, Sun Feb 13 11:07:57 2005 UTC vs.
Revision 1.21 by root, Wed Jul 13 02:53:54 2005 UTC

23 How do I know which rxvt-unicode version I'm using? 23 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape 24 The version number is displayed with the usage (-h). Also the escape
25 sequence "ESC [ 8 n" sets the window title to the version number. 25 sequence "ESC [ 8 n" sets the window title to the version number.
26 26
27 I am using Debian GNU/Linux and have a problem... 27 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode contains large patches 28 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
29 that considerably change the behaviour of rxvt-unicode. Before 29 patches that considerably change the behaviour of rxvt-unicode.
30 reporting a bug to the original rxvt-unicode author please download 30 Before reporting a bug to the original rxvt-unicode author please
31 and install the genuine version 31 download and install the genuine version
32 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the 32 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
33 problem. If you cannot, chances are that the problems are specific 33 problem. If you cannot, chances are that the problems are specific
34 to Debian GNU/Linux, in which case it should be reported via the 34 to Debian GNU/Linux, in which case it should be reported via the
35 Debian Bug Tracking System (use "reportbug" to report the bug). 35 Debian Bug Tracking System (use "reportbug" to report the bug).
36 36
66 URxvt.termName: rxvt 66 URxvt.termName: rxvt
67 67
68 If you don't plan to use rxvt (quite common...) you could also 68 If you don't plan to use rxvt (quite common...) you could also
69 replace the rxvt terminfo file with the rxvt-unicode one. 69 replace the rxvt terminfo file with the rxvt-unicode one.
70 70
71 "tic" outputs some error when compiling the terminfo entry.
72 Most likely it's the empty definition for "enacs=". Just replace it
73 by "enacs=\E[0@" and try again.
74
71 "bash"'s readline does not work correctly under rxvt. 75 "bash"'s readline does not work correctly under rxvt.
72 I need a termcap file entry. 76 I need a termcap file entry.
73 One reason you might want this is that some distributions or 77 One reason you might want this is that some distributions or
74 operating systems still compile some programs using the 78 operating systems still compile some programs using the
75 long-obsoleted termcap (Fedora Core's bash is one example) and rely 79 long-obsoleted termcap library (Fedora Core's bash is one example)
76 on a termcap entry for "rxvt-unicode". 80 and rely on a termcap entry for "rxvt-unicode".
77 81
78 You could use rxvt's termcap entry with resonable results in many 82 You could use rxvt's termcap entry with resonable results in many
79 cases. You can also create a termcap entry by using terminfo's 83 cases. You can also create a termcap entry by using terminfo's
80 infocmp program like this: 84 infocmp program like this:
81 85
83 87
84 Or you could use this termcap entry, generated by the command above: 88 Or you could use this termcap entry, generated by the command above:
85 89
86 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 90 rxvt-unicode|rxvt-unicode terminal (X Window System):\
87 :am:bw:eo:km:mi:ms:xn:xo:\ 91 :am:bw:eo:km:mi:ms:xn:xo:\
88 :co#80:it#8:li#24:\ 92 :co#80:it#8:li#24:lm#0:\
89 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 93 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
90 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 94 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
91 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 95 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
92 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 96 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
93 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 97 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
94 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 98 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
99 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
95 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 100 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
96 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\ 101 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
97 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ 102 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
98 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ 103 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
99 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ 104 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
100 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ 105 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
101 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ 106 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
102 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ 107 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
103 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 108 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
104 :vs=\E[?25h: 109 :vs=\E[?25h:
105 110
106 Why does "ls" no longer have coloured output? 111 Why does "ls" no longer have coloured output?
107 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to 112 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
108 decide wether a terminal has colour, but uses it's own configuration 113 decide wether a terminal has colour, but uses it's own configuration
246 that doesn't work, you might be forced to use a different font. 251 that doesn't work, you might be forced to use a different font.
247 252
248 All of this is not a problem when using X11 core fonts, as their 253 All of this is not a problem when using X11 core fonts, as their
249 bounding box data is correct. 254 bounding box data is correct.
250 255
256 On Solaris 9, many line-drawing characters are too wide.
257 Seems to be a known bug, read
258 <http://nixdoc.net/files/forum/about34198.html>. Some people use the
259 following ugly workaround to get non-double-wide-characters working:
260
261 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
262
251 My Compose (Multi_key) key is no longer working. 263 My Compose (Multi_key) key is no longer working.
252 The most common causes for this are that either your locale is not 264 The most common causes for this are that either your locale is not
253 set correctly, or you specified a preeditStyle that is not supported 265 set correctly, or you specified a preeditStyle that is not supported
254 by your input method. For example, if you specified OverTheSpot and 266 by your input method. For example, if you specified OverTheSpot and
255 your input method (e.g. the default input method handling Compose 267 your input method (e.g. the default input method handling Compose
299 As you might have guessed, FreeBSD does neither define this symobl 311 As you might have guessed, FreeBSD does neither define this symobl
300 nor does it support it. Instead, it uses it's own internal 312 nor does it support it. Instead, it uses it's own internal
301 representation of wchar_t. This is, of course, completely fine with 313 representation of wchar_t. This is, of course, completely fine with
302 respect to standards. 314 respect to standards.
303 315
316 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1"
317 and "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
318
304 However, "__STDC_ISO_10646__" is the only sane way to support 319 "__STDC_ISO_10646__" is the only sane way to support multi-language
305 multi-language apps in an OS, as using a locale-dependent (and 320 apps in an OS, as using a locale-dependent (and non-standardized)
306 non-standardized) representation of wchar_t makes it impossible to 321 representation of wchar_t makes it impossible to convert between
307 convert between wchar_t (as used by X11 and your applications) and 322 wchar_t (as used by X11 and your applications) and any other
308 any other encoding without implementing OS-specific-wrappers for 323 encoding without implementing OS-specific-wrappers for each and
309 each and every locale. There simply are no APIs to convert wchar_t 324 every locale. There simply are no APIs to convert wchar_t into
310 into anything except the current locale encoding. 325 anything except the current locale encoding.
311 326
312 Some applications (such as the formidable mlterm) work around this 327 Some applications (such as the formidable mlterm) work around this
313 by carrying their own replacement functions for character set 328 by carrying their own replacement functions for character set
314 handling with them, and either implementing OS-dependent hacks or 329 handling with them, and either implementing OS-dependent hacks or
315 doing multiple conversions (which is slow and unreliable in case the 330 doing multiple conversions (which is slow and unreliable in case the
317 emulator). 332 emulator).
318 333
319 The rxvt-unicode author insists that the right way to fix this is in 334 The rxvt-unicode author insists that the right way to fix this is in
320 the system libraries once and for all, instead of forcing every app 335 the system libraries once and for all, instead of forcing every app
321 to carry complete replacements for them :) 336 to carry complete replacements for them :)
337
338 I use Solaris 9 and it doesn't compile/work/etc.
339 Try the diff in doc/solaris9.patch as a base. It fixes the worst
340 problems with "wcwidth" and a compile problem.
341
342 How can I use rxvt-unicode under cygwin?
343 rxvt-unicode should compile and run out of the box on cygwin, using
344 the X11 libraries that come with cygwin. libW11 emulation is no
345 longer supported (and makes no sense, either, as it only supported a
346 single font). I recommend starting the X-server in "-multiwindow" or
347 "-rootless" mode instead, which will result in similar look&feel as
348 the old libW11 emulation.
349
350 At the time of this writing, cygwin didn't seem to support any
351 multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
352 likely limited to 8-bit encodings.
322 353
323 How does rxvt-unicode determine the encoding to use? 354 How does rxvt-unicode determine the encoding to use?
324 Is there an option to switch encodings? 355 Is there an option to switch encodings?
325 Unlike some other terminals, rxvt-unicode has no encoding switch, 356 Unlike some other terminals, rxvt-unicode has no encoding switch,
326 and no specific "utf-8" mode, such as xterm. In fact, it doesn't 357 and no specific "utf-8" mode, such as xterm. In fact, it doesn't
1155 Ps = 13 Change colour of mouse foreground to Pt 1186 Ps = 13 Change colour of mouse foreground to Pt
1156 Ps = 17 Change colour of highlight characters to Pt 1187 Ps = 17 Change colour of highlight characters to Pt
1157 Ps = 18 Change colour of bold characters to Pt 1188 Ps = 18 Change colour of bold characters to Pt
1158 Ps = 19 Change colour of underlined characters to Pt 1189 Ps = 19 Change colour of underlined characters to Pt
1159 Ps = 20 Change default background to Pt 1190 Ps = 20 Change default background to Pt
1160 Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1191 Ps = 39 Change default foreground colour to Pt.
1161 Ps = 46 Change Log File to Pt unimplemented 1192 Ps = 46 Change Log File to Pt unimplemented
1162 Ps = 49 Change default background colour to Pt rxvt compile-time option 1193 Ps = 49 Change default background colour to Pt.
1163 Ps = 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 1194 Ps = 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
1164 Ps = 55 Log all scrollback buffer and all of screen to Pt 1195 Ps = 55 Log all scrollback buffer and all of screen to Pt
1165 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension) 1196 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1166 Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension) 1197 Ps = 703 Menubar command Pt (Compile menubar).
1167 Ps = 704 Change colour of italic characters to Pt 1198 Ps = 704 Change colour of italic characters to Pt
1168 Ps = 705 Change background pixmap tint colour to Pt 1199 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1169 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1200 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1170 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1201 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1171 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50. 1202 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1172 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50. 1203 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1204 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1205 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1173 1206
1174 1207
1175 1208
1176menuBar 1209menuBar
1177 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1210 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1214 [menu] 1247 [menu]
1215 access the current menuBar for alteration 1248 access the current menuBar for alteration
1216 1249
1217 [title:+*string*] 1250 [title:+*string*]
1218 set the current menuBar's title to *string*, which may contain the 1251 set the current menuBar's title to *string*, which may contain the
1219 following format specifiers: %% : literal % character %n : rxvt name 1252 following format specifiers:
1220 (as per the -name command-line option) %v : rxvt version 1253
1254 B<%n> rxvt name (as per the B<-name> command-line option)
1255 B<%v> rxvt version
1256 B<%%> literal B<%> character
1221 1257
1222 [done] 1258 [done]
1223 set menuBar access as readonly. End-of-file tag for [read:+*file*] 1259 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1224 operations. 1260 operations.
1225 1261
1661 --enable-font-styles 1697 --enable-font-styles
1662 Add support for bold, *italic* and *bold italic* font styles. The 1698 Add support for bold, *italic* and *bold italic* font styles. The
1663 fonts can be set manually or automatically. 1699 fonts can be set manually or automatically.
1664 1700
1665 --with-codesets=NAME,... 1701 --with-codesets=NAME,...
1666 Compile in support for additional codeset (encoding) groups (eu, vn 1702 Compile in support for additional codeset (encoding) groups ("eu",
1667 are always compiled in, which includes most 8-bit character sets). 1703 "vn" are always compiled in, which includes most 8-bit character
1668 These codeset tables are currently only used for driving X11 core 1704 sets). These codeset tables are used for driving X11 core fonts,
1669 fonts, they are not required for Xft fonts. Compiling them in will 1705 they are not required for Xft fonts, although having them compiled
1670 make your binary bigger (together about 700kB), but it doesn't 1706 in lets rxvt-unicode choose replacement fonts more intelligently.
1671 increase memory usage unless you use an X11 font requiring one of 1707 Compiling them in will make your binary bigger (all of together cost
1672 these encodings. 1708 about 700kB), but it doesn't increase memory usage unless you use a
1709 font requiring one of these encodings.
1673 1710
1674 all all available codeset groups 1711 all all available codeset groups
1675 zh common chinese encodings 1712 zh common chinese encodings
1676 zh_ext rarely used but very big chinese encodigs 1713 zh_ext rarely used but very big chinese encodigs
1677 jp common japanese encodings 1714 jp common japanese encodings
1701 accents are encoded as seperate unicode characters. This is done by 1738 accents are encoded as seperate unicode characters. This is done by
1702 using precomposited characters when available or creating new 1739 using precomposited characters when available or creating new
1703 pseudo-characters when no precomposed form exists. 1740 pseudo-characters when no precomposed form exists.
1704 1741
1705 Without --enable-unicode3, the number of additional precomposed 1742 Without --enable-unicode3, the number of additional precomposed
1706 characters is rather limited (2048, if this is full, rxvt will use 1743 characters is rather limited (2048, if this is full, rxvt-unicode
1707 the private use area, extending the number of combinations to 8448). 1744 will use the private use area, extending the number of combinations
1708 With --enable-unicode3, no practical limit exists. This will also 1745 to 8448). With --enable-unicode3, no practical limit exists.
1709 enable storage of characters >65535. 1746
1747 This option will also enable storage (but not display) of characters
1748 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1710 1749
1711 The combining table also contains entries for arabic presentation 1750 The combining table also contains entries for arabic presentation
1712 forms, but these are not currently used. Bug me if you want these to 1751 forms, but these are not currently used. Bug me if you want these to
1713 be used. 1752 be used (and tell me how these are to be used...).
1714 1753
1715 --enable-fallback(=CLASS) 1754 --enable-fallback(=CLASS)
1716 When reading resource settings, also read settings for class CLASS 1755 When reading resource settings, also read settings for class CLASS
1717 (default: Rxvt). To disable resource fallback use 1756 (default: Rxvt). To disable resource fallback use
1718 --disable-fallback. 1757 --disable-fallback.
1816 1855
1817 A non-exhaustive list of features enabled by "--enable-frills" 1856 A non-exhaustive list of features enabled by "--enable-frills"
1818 (possibly in combination with other switches) is: 1857 (possibly in combination with other switches) is:
1819 1858
1820 MWM-hints 1859 MWM-hints
1860 EWMH-hints (pid, utf8 names) and protocols (ping)
1821 seperate underline colour 1861 seperate underline colour
1822 settable border widths and borderless switch 1862 settable border widths and borderless switch
1823 settable extra linespacing 1863 settable extra linespacing
1824 extra window properties (e.g. UTF-8 window names and PID)
1825 iso-14755-2 and -3, and visual feedback 1864 iso-14755-2 and -3, and visual feedback
1826 backindex and forwardindex escape sequence 1865 backindex and forwardindex escape sequence
1827 window op and locale change escape sequences 1866 window op and some xterm/OSC escape sequences
1828 tripleclickwords 1867 tripleclickwords
1829 settable insecure mode 1868 settable insecure mode
1830 keysym remapping support 1869 keysym remapping support
1870 cursor blinking and underline cursor
1871 -embed and -pty-fd options
1831 1872
1832 --enable-iso14755 1873 --enable-iso14755
1833 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 1874 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1834 Basic support (section 5.1) is enabled by "--enable-frills", while 1875 Basic support (section 5.1) is enabled by "--enable-frills", while
1835 support for 5.2, 5.3 and 5.4 is enabled with this switch. 1876 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1865 --enable-smart-resize 1906 --enable-smart-resize
1866 Add smart growth/shrink behaviour when changing font size via from 1907 Add smart growth/shrink behaviour when changing font size via from
1867 hot keys. This should keep in a fixed position the rxvt corner which 1908 hot keys. This should keep in a fixed position the rxvt corner which
1868 is closest to a corner of the screen. 1909 is closest to a corner of the screen.
1869 1910
1870 --enable-cursor-blink
1871 Add support for a blinking cursor.
1872
1873 --enable-pointer-blank 1911 --enable-pointer-blank
1874 Add support to have the pointer disappear when typing or inactive. 1912 Add support to have the pointer disappear when typing or inactive.
1875 1913
1876 --with-name=NAME 1914 --with-name=NAME
1877 Set the basename for the installed binaries (default: "urxvt", 1915 Set the basename for the installed binaries (default: "urxvt",

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines