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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.45 by root, Sun Feb 13 11:07:57 2005 UTC vs.
Revision 1.58 by root, Wed Jul 13 02:24:02 2005 UTC

31The version number is displayed with the usage (-h). Also the escape 31The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 32sequence C<ESC [ 8 n> sets the window title to the version number.
33 33
34=item I am using Debian GNU/Linux and have a problem... 34=item I am using Debian GNU/Linux and have a problem...
35 35
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 36The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 37patches that considerably change the behaviour of rxvt-unicode. Before
38bug to the original rxvt-unicode author please download and install the 38reporting a bug to the original rxvt-unicode author please download and
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40reproduce the problem. If you cannot, chances are that the problems are 40and try to reproduce the problem. If you cannot, chances are that the
41specific to Debian GNU/Linux, in which case it should be reported via the 41problems are specific to Debian GNU/Linux, in which case it should be
42Debian Bug Tracking System (use C<reportbug> to report the bug). 42reported via the Debian Bug Tracking System (use C<reportbug> to report
43the bug).
43 44
44For other problems that also affect the Debian package, you can and 45For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a 46probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that 47bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 48might encounter the same issue.
72 URxvt.termName: rxvt 73 URxvt.termName: rxvt
73 74
74If you don't plan to use B<rxvt> (quite common...) you could also replace 75If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 76the rxvt terminfo file with the rxvt-unicode one.
76 77
78=item C<tic> outputs some error when compiling the terminfo entry.
79
80Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again.
82
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 84
79=item I need a termcap file entry. 85=item I need a termcap file entry.
80 86
81One reason you might want this is that some distributions or operating 87One reason you might want this is that some distributions or operating
82systems still compile some programs using the long-obsoleted termcap 88systems still compile some programs using the long-obsoleted termcap
83(Fedora Core's bash is one example) and rely on a termcap entry for 89library (Fedora Core's bash is one example) and rely on a termcap entry
84C<rxvt-unicode>. 90for C<rxvt-unicode>.
85 91
86You could use rxvt's termcap entry with resonable results in many cases. 92You could use rxvt's termcap entry with resonable results in many cases.
87You can also create a termcap entry by using terminfo's infocmp program 93You can also create a termcap entry by using terminfo's infocmp program
88like this: 94like this:
89 95
91 97
92Or you could use this termcap entry, generated by the command above: 98Or you could use this termcap entry, generated by the command above:
93 99
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 100 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\ 101 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:\ 102 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 103 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 104 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 105 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 106 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 107 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 108 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
109 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
103 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 110 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\ 111 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ 112 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ 113 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ 114 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ 115 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
109 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ 116 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
110 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ 117 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
111 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 118 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
112 :vs=\E[?25h: 119 :vs=\E[?25h:
113 120
114=item Why does C<ls> no longer have coloured output? 121=item Why does C<ls> no longer have coloured output?
115 122
116The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 123The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
257might be forced to use a different font. 264might be forced to use a different font.
258 265
259All of this is not a problem when using X11 core fonts, as their bounding 266All of this is not a problem when using X11 core fonts, as their bounding
260box data is correct. 267box data is correct.
261 268
269=item On Solaris 9, many line-drawing characters are too wide.
270
271Seems to be a known bug, read
272L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
273following ugly workaround to get non-double-wide-characters working:
274
275 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
276
262=item My Compose (Multi_key) key is no longer working. 277=item My Compose (Multi_key) key is no longer working.
263 278
264The most common causes for this are that either your locale is not set 279The most common causes for this are that either your locale is not set
265correctly, or you specified a B<preeditStyle> that is not supported by 280correctly, or you specified a B<preeditStyle> that is not supported by
266your input method. For example, if you specified B<OverTheSpot> and 281your input method. For example, if you specified B<OverTheSpot> and
309 324
310As you might have guessed, FreeBSD does neither define this symobl nor 325As you might have guessed, FreeBSD does neither define this symobl nor
311does it support it. Instead, it uses it's own internal representation of 326does it support it. Instead, it uses it's own internal representation of
312B<wchar_t>. This is, of course, completely fine with respect to standards. 327B<wchar_t>. This is, of course, completely fine with respect to standards.
313 328
329However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
330C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
331
314However, C<__STDC_ISO_10646__> is the only sane way to support 332C<__STDC_ISO_10646__> is the only sane way to support multi-language
315multi-language apps in an OS, as using a locale-dependent (and 333apps in an OS, as using a locale-dependent (and non-standardized)
316non-standardized) representation of B<wchar_t> makes it impossible to 334representation of B<wchar_t> makes it impossible to convert between
317convert between B<wchar_t> (as used by X11 and your applications) and any 335B<wchar_t> (as used by X11 and your applications) and any other encoding
318other encoding without implementing OS-specific-wrappers for each and 336without implementing OS-specific-wrappers for each and every locale. There
319every locale. There simply are no APIs to convert B<wchar_t> into anything 337simply are no APIs to convert B<wchar_t> into anything except the current
320except the current locale encoding. 338locale encoding.
321 339
322Some applications (such as the formidable B<mlterm>) work around this 340Some applications (such as the formidable B<mlterm>) work around this
323by carrying their own replacement functions for character set handling 341by carrying their own replacement functions for character set handling
324with them, and either implementing OS-dependent hacks or doing multiple 342with them, and either implementing OS-dependent hacks or doing multiple
325conversions (which is slow and unreliable in case the OS implements 343conversions (which is slow and unreliable in case the OS implements
326encodings slightly different than the terminal emulator). 344encodings slightly different than the terminal emulator).
327 345
328The rxvt-unicode author insists that the right way to fix this is in the 346The rxvt-unicode author insists that the right way to fix this is in the
329system libraries once and for all, instead of forcing every app to carry 347system libraries once and for all, instead of forcing every app to carry
330complete replacements for them :) 348complete replacements for them :)
349
350=item I use Solaris 9 and it doesn't compile/work/etc.
351
352Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
353problems with C<wcwidth> and a compile problem.
354
355=item How can I use rxvt-unicode under cygwin?
356
357rxvt-unicode should compile and run out of the box on cygwin, using
358the X11 libraries that come with cygwin. libW11 emulation is no
359longer supported (and makes no sense, either, as it only supported a
360single font). I recommend starting the X-server in C<-multiwindow> or
361C<-rootless> mode instead, which will result in similar look&feel as the
362old libW11 emulation.
363
364At the time of this writing, cygwin didn't seem to support any multi-byte
365encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
366to 8-bit encodings.
331 367
332=item How does rxvt-unicode determine the encoding to use? 368=item How does rxvt-unicode determine the encoding to use?
333 369
334=item Is there an option to switch encodings? 370=item Is there an option to switch encodings?
335 371
1474 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1510 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1511 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1512 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
1477 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1513 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
1478 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1514 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1479 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1515 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1480 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1516 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1517 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1518 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1483 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1519 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1520 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1485 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 1521 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1486 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1522 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 1523 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1488 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1524 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1525 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1526 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 1527 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1528 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1529 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1492 1530
1493=end table 1531=end table
1494 1532
1495=back 1533=back
1496 1534
1548 1586
1549=item B<< [title:+I<string>] >> 1587=item B<< [title:+I<string>] >>
1550 1588
1551set the current menuBar's title to I<string>, which may contain the 1589set the current menuBar's title to I<string>, which may contain the
1552following format specifiers: 1590following format specifiers:
1553B<%%> : literal B<%> character 1591
1554B<%n> : rxvt name (as per the B<-name> command-line option) 1592 B<%n> rxvt name (as per the B<-name> command-line option)
1555B<%v> : rxvt version 1593 B<%v> rxvt version
1594 B<%%> literal B<%> character
1556 1595
1557=item B<[done]> 1596=item B<[done]>
1558 1597
1559set menuBar access as B<readonly>. 1598set menuBar access as B<readonly>.
1560End-of-file tag for B<< [read:+I<file>] >> operations. 1599End-of-file tag for B<< [read:+I<file>] >> operations.
2180Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2219Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2181styles. The fonts can be set manually or automatically. 2220styles. The fonts can be set manually or automatically.
2182 2221
2183=item --with-codesets=NAME,... 2222=item --with-codesets=NAME,...
2184 2223
2185Compile in support for additional codeset (encoding) groups (eu, vn are 2224Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2186always compiled in, which includes most 8-bit character sets). These 2225are always compiled in, which includes most 8-bit character sets). These
2187codeset tables are currently only used for driving X11 core fonts, they 2226codeset tables are used for driving X11 core fonts, they are not required
2188are not required for Xft fonts. Compiling them in will make your binary 2227for Xft fonts, although having them compiled in lets rxvt-unicode choose
2189bigger (together about 700kB), but it doesn't increase memory usage unless 2228replacement fonts more intelligently. Compiling them in will make your
2229binary bigger (all of together cost about 700kB), but it doesn't increase
2190you use an X11 font requiring one of these encodings. 2230memory usage unless you use a font requiring one of these encodings.
2191 2231
2192=begin table 2232=begin table
2193 2233
2194 all all available codeset groups 2234 all all available codeset groups
2195 zh common chinese encodings 2235 zh common chinese encodings
2225composite characters. This is required for proper viewing of text 2265composite characters. This is required for proper viewing of text
2226where accents are encoded as seperate unicode characters. This is 2266where accents are encoded as seperate unicode characters. This is
2227done by using precomposited characters when available or creating 2267done by using precomposited characters when available or creating
2228new pseudo-characters when no precomposed form exists. 2268new pseudo-characters when no precomposed form exists.
2229 2269
2230Without --enable-unicode3, the number of additional precomposed 2270Without --enable-unicode3, the number of additional precomposed characters
2231characters is rather limited (2048, if this is full, rxvt will use the 2271is rather limited (2048, if this is full, rxvt-unicode will use the
2232private use area, extending the number of combinations to 8448). With 2272private use area, extending the number of combinations to 8448). With
2233--enable-unicode3, no practical limit exists. This will also enable 2273--enable-unicode3, no practical limit exists.
2234storage of characters >65535. 2274
2275This option will also enable storage (but not display) of characters
2276beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2235 2277
2236The combining table also contains entries for arabic presentation forms, 2278The combining table also contains entries for arabic presentation forms,
2237but these are not currently used. Bug me if you want these to be used. 2279but these are not currently used. Bug me if you want these to be used (and
2280tell me how these are to be used...).
2238 2281
2239=item --enable-fallback(=CLASS) 2282=item --enable-fallback(=CLASS)
2240 2283
2241When reading resource settings, also read settings for class CLASS 2284When reading resource settings, also read settings for class CLASS
2242(default: Rxvt). To disable resource fallback use --disable-fallback. 2285(default: Rxvt). To disable resource fallback use --disable-fallback.
2363 2406
2364A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2407A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2365in combination with other switches) is: 2408in combination with other switches) is:
2366 2409
2367 MWM-hints 2410 MWM-hints
2411 EWMH-hints (pid, utf8 names) and protocols (ping)
2368 seperate underline colour 2412 seperate underline colour
2369 settable border widths and borderless switch 2413 settable border widths and borderless switch
2370 settable extra linespacing 2414 settable extra linespacing
2371 extra window properties (e.g. UTF-8 window names and PID)
2372 iso-14755-2 and -3, and visual feedback 2415 iso-14755-2 and -3, and visual feedback
2373 backindex and forwardindex escape sequence 2416 backindex and forwardindex escape sequence
2374 window op and locale change escape sequences 2417 window op and some xterm/OSC escape sequences
2375 tripleclickwords 2418 tripleclickwords
2376 settable insecure mode 2419 settable insecure mode
2377 keysym remapping support 2420 keysym remapping support
2421 cursor blinking and underline cursor
2422 -embed and -pty-fd options
2378 2423
2379=item --enable-iso14755 2424=item --enable-iso14755
2380 2425
2381Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2426Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2382F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2427F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2421 2466
2422Add smart growth/shrink behaviour when changing font size via from hot 2467Add smart growth/shrink behaviour when changing font size via from hot
2423keys. This should keep in a fixed position the rxvt corner which is 2468keys. This should keep in a fixed position the rxvt corner which is
2424closest to a corner of the screen. 2469closest to a corner of the screen.
2425 2470
2426=item --enable-cursor-blink
2427
2428Add support for a blinking cursor.
2429
2430=item --enable-pointer-blank 2471=item --enable-pointer-blank
2431 2472
2432Add support to have the pointer disappear when typing or inactive. 2473Add support to have the pointer disappear when typing or inactive.
2433 2474
2434=item --with-name=NAME 2475=item --with-name=NAME

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines