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.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.60 by root, Fri Jul 29 03:12:10 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
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:lm#0:\ 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 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ 111 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ 112 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ 113 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ 114 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ 115 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
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
451 487
452=item Can I speed up Xft rendering somehow? 488=item Can I speed up Xft rendering somehow?
453 489
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as 490Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455it is simply slow. If you still want Xft fonts you might try to disable 491it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of 492antialiasing (by appending C<:antialias=false>), which saves lots of
457memory and also speeds up rendering considerably. 493memory and also speeds up rendering considerably.
458 494
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460 496
461Rxvt-unicode will use whatever you specify as a font. If it needs to 497Rxvt-unicode will use whatever you specify as a font. If it needs to
539 URxvt.color7: #e1dddd 575 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd 576 URxvt.color15: #e1dddd
541 577
542=item How can I start @@RXVT_NAME@@d in a race-free way? 578=item How can I start @@RXVT_NAME@@d in a race-free way?
543 579
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 580Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
545server that answers @@RXVT_NAME@@c's requests, so it doesn't background 581display, create the listening socket and then fork.
546itself.
547
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549following method to wait for the startup message before continuing:
550
551 { @@RXVT_NAME@@d & } | read
552 582
553=item What's with the strange Backspace/Delete key behaviour? 583=item What's with the strange Backspace/Delete key behaviour?
554 584
555Assuming that the physical Backspace key corresponds to the 585Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following 586BackSpace keysym (not likely for Linux ... see the following
1474 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1504 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> >> 1505 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> >> 1506 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> >> 1507 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> >> 1508 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> 1509 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> 1510 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> 1511 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> >> 1512 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> >> 1513 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) 1514 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) 1515 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> >> 1516 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> >> 1517 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>. 1518 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>. 1519 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>. 1520 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>. 1521 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1492 1524
1493=end table 1525=end table
1494 1526
1495=back 1527=back
1496 1528
2181Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2213Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182styles. The fonts can be set manually or automatically. 2214styles. The fonts can be set manually or automatically.
2183 2215
2184=item --with-codesets=NAME,... 2216=item --with-codesets=NAME,...
2185 2217
2186Compile in support for additional codeset (encoding) groups (eu, vn are 2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187always compiled in, which includes most 8-bit character sets). These 2219are always compiled in, which includes most 8-bit character sets). These
2188codeset tables are currently only used for driving X11 core fonts, they 2220codeset tables are used for driving X11 core fonts, they are not required
2189are not required for Xft fonts. Compiling them in will make your binary 2221for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190bigger (together about 700kB), but it doesn't increase memory usage unless 2222replacement fonts more intelligently. Compiling them in will make your
2223binary bigger (all of together cost about 700kB), but it doesn't increase
2191you use an X11 font requiring one of these encodings. 2224memory usage unless you use a font requiring one of these encodings.
2192 2225
2193=begin table 2226=begin table
2194 2227
2195 all all available codeset groups 2228 all all available codeset groups
2196 zh common chinese encodings 2229 zh common chinese encodings
2367 2400
2368A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2401A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369in combination with other switches) is: 2402in combination with other switches) is:
2370 2403
2371 MWM-hints 2404 MWM-hints
2405 EWMH-hints (pid, utf8 names) and protocols (ping)
2372 seperate underline colour 2406 seperate underline colour
2373 settable border widths and borderless switch 2407 settable border widths and borderless switch
2374 settable extra linespacing 2408 settable extra linespacing
2375 extra window properties (e.g. UTF-8 window names and PID)
2376 iso-14755-2 and -3, and visual feedback 2409 iso-14755-2 and -3, and visual feedback
2377 backindex and forwardindex escape sequence 2410 backindex and forwardindex escape sequence
2378 window op and locale change escape sequences 2411 window op and some xterm/OSC escape sequences
2379 tripleclickwords 2412 tripleclickwords
2380 settable insecure mode 2413 settable insecure mode
2381 keysym remapping support 2414 keysym remapping support
2415 cursor blinking and underline cursor
2416 -embed and -pty-fd options
2382 2417
2383=item --enable-iso14755 2418=item --enable-iso14755
2384 2419
2385Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2421F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2425 2460
2426Add smart growth/shrink behaviour when changing font size via from hot 2461Add smart growth/shrink behaviour when changing font size via from hot
2427keys. This should keep in a fixed position the rxvt corner which is 2462keys. This should keep in a fixed position the rxvt corner which is
2428closest to a corner of the screen. 2463closest to a corner of the screen.
2429 2464
2430=item --enable-cursor-blink
2431
2432Add support for a blinking cursor.
2433
2434=item --enable-pointer-blank 2465=item --enable-pointer-blank
2435 2466
2436Add support to have the pointer disappear when typing or inactive. 2467Add support to have the pointer disappear when typing or inactive.
2437 2468
2438=item --with-name=NAME 2469=item --with-name=NAME

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines