--- rxvt-unicode/doc/rxvt.7.man.in 2005/04/17 22:36:13 1.20 +++ rxvt-unicode/doc/rxvt.7.man.in 2005/10/25 20:04:59 1.25 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 7" -.TH rxvt 7 "2005-04-17" "5.3" "RXVT-UNICODE" +.TH rxvt 7 "2005-10-25" "5.8" "RXVT-UNICODE" .SH "NAME" RXVT REFERENCE \- FAQ, command sequences and other background information .SH "SYNOPSIS" @@ -164,13 +164,14 @@ sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. .IP "I am using Debian GNU/Linux and have a problem..." 4 .IX Item "I am using Debian GNU/Linux and have a problem..." -The Debian GNU/Linux package of rxvt-unicode contains large patches that -considerably change the behaviour of rxvt\-unicode. Before reporting a -bug to the original rxvt-unicode author please download and install the -genuine version () and try to -reproduce the problem. If you cannot, chances are that the problems are -specific to Debian GNU/Linux, in which case it should be reported via the -Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug). +The Debian GNU/Linux package of rxvt-unicode in sarge contains large +patches that considerably change the behaviour of rxvt\-unicode. Before +reporting a bug to the original rxvt-unicode author please download and +install the genuine version () +and try to reproduce the problem. If you cannot, chances are that the +problems are specific to Debian GNU/Linux, in which case it should be +reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report +the bug). .Sp For other problems that also affect the Debian package, you can and probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a @@ -207,6 +208,11 @@ .Sp If you don't plan to use \fBrxvt\fR (quite common...) you could also replace the rxvt terminfo file with the rxvt-unicode one. +.ie n .IP """tic"" outputs some error when compiling the terminfo entry." 4 +.el .IP "\f(CWtic\fR outputs some error when compiling the terminfo entry." 4 +.IX Item "tic outputs some error when compiling the terminfo entry." +Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by +\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again. .ie n .IP """bash""'s readline does not work correctly under @@RXVT_NAME@@." 4 .el .IP "\f(CWbash\fR's readline does not work correctly under @@RXVT_NAME@@." 4 .IX Item "bash's readline does not work correctly under @@RXVT_NAME@@." @@ -408,6 +414,15 @@ .Sp All of this is not a problem when using X11 core fonts, as their bounding box data is correct. +.IP "On Solaris 9, many line-drawing characters are too wide." 4 +.IX Item "On Solaris 9, many line-drawing characters are too wide." +Seems to be a known bug, read +. Some people use the +following ugly workaround to get non-double-wide-characters working: +.Sp +.Vb 1 +\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) +.Ve .IP "My Compose (Multi_key) key is no longer working." 4 .IX Item "My Compose (Multi_key) key is no longer working." The most common causes for this are that either your locale is not set @@ -479,6 +494,22 @@ The rxvt-unicode author insists that the right way to fix this is in the system libraries once and for all, instead of forcing every app to carry complete replacements for them :) +.IP "I use Solaris 9 and it doesn't compile/work/etc." 4 +.IX Item "I use Solaris 9 and it doesn't compile/work/etc." +Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst +problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem. +.IP "How can I use rxvt-unicode under cygwin?" 4 +.IX Item "How can I use rxvt-unicode under cygwin?" +rxvt-unicode should compile and run out of the box on cygwin, using +the X11 libraries that come with cygwin. libW11 emulation is no +longer supported (and makes no sense, either, as it only supported a +single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or +\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the +old libW11 emulation. +.Sp +At the time of this writing, cygwin didn't seem to support any multi-byte +encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited +to 8\-bit encodings. .IP "How does rxvt-unicode determine the encoding to use?" 4 .IX Item "How does rxvt-unicode determine the encoding to use?" .PD 0 @@ -608,7 +639,7 @@ .IX Item "Can I speed up Xft rendering somehow?" Yes, the most obvious way to speed it up is to avoid Xft entirely, as it is simply slow. If you still want Xft fonts you might try to disable -antialiasing (by appending \f(CW\*(C`:antialiasing=false\*(C'\fR), which saves lots of +antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of memory and also speeds up rendering considerably. .IP "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 4 .IX Item "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" @@ -697,16 +728,8 @@ .Ve .IP "How can I start @@RXVT_NAME@@d in a race-free way?" 4 .IX Item "How can I start @@RXVT_NAME@@d in a race-free way?" -Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a -server that answers @@RXVT_NAME@@c's requests, so it doesn't background -itself. -.Sp -To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the -following method to wait for the startup message before continuing: -.Sp -.Vb 1 -\& { @@RXVT_NAME@@d & } | read -.Ve +Try \f(CW\*(C`@@RXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@RXVT_NAME@@d to open the +display, create the listening socket and then fork. .IP "What's with the strange Backspace/Delete key behaviour?" 4 .IX Item "What's with the strange Backspace/Delete key behaviour?" Assuming that the physical Backspace key corresponds to the @@ -2170,28 +2193,34 @@ .SH "CONFIGURE OPTIONS" .IX Header "CONFIGURE OPTIONS" General hint: if you get compile errors, then likely your configuration -hasn't been tested well. Either try with \-\-enable\-everything or use the -\&./reconf script as a base for experiments. ./reconf is used by myself, -so it should generally be a working config. Of course, you should always -report when a combination doesn't work, so it can be fixed. Marc Lehmann -. +hasn't been tested well. Either try with \f(CW\*(C`\-\-enable\-everything\*(C'\fR or use +the \fI./reconf\fR script as a base for experiments. \fI./reconf\fR is used by +myself, so it should generally be a working config. Of course, you should +always report when a combination doesn't work, so it can be fixed. Marc +Lehmann . +.PP +All .IP "\-\-enable\-everything" 4 .IX Item "--enable-everything" -Add support for all non-multichoice options listed in \*(L"./configure -\&\-\-help\*(R". Note that unlike other enable options this is order dependant. -You can specify this and then disable options which this enables by -\&\fIfollowing\fR this with the appropriate commands. -.IP "\-\-enable\-xft" 4 -.IX Item "--enable-xft" +Add (or remove) support for all non-multichoice options listed in \*(L"./configure +\&\-\-help\*(R". +.Sp +You can specify this and then disable options you do not like by +\&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments, +or you can start with a minimal configuration by specifying +\&\f(CW\*(C`\-\-disable\-everything\*(C'\fR and than adding just the \f(CW\*(C`\-\-enable\-...\*(C'\fR arguments +you want. +.IP "\-\-enable\-xft (default: enabled)" 4 +.IX Item "--enable-xft (default: enabled)" Add support for Xft (anti\-aliases, among others) fonts. Xft fonts are slower and require lots of memory, but as long as you don't use them, you don't pay for them. -.IP "\-\-enable\-font\-styles" 4 -.IX Item "--enable-font-styles" +.IP "\-\-enable\-font\-styles (default: on)" 4 +.IX Item "--enable-font-styles (default: on)" Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font styles. The fonts can be set manually or automatically. -.IP "\-\-with\-codesets=NAME,..." 4 -.IX Item "--with-codesets=NAME,..." +.IP "\-\-with\-codesets=NAME,... (default: all)" 4 +.IX Item "--with-codesets=NAME,... (default: all)" Compile in support for additional codeset (encoding) groups (\f(CW\*(C`eu\*(C'\fR, \f(CW\*(C`vn\*(C'\fR are always compiled in, which includes most 8\-bit character sets). These codeset tables are used for driving X11 core fonts, they are not required @@ -2209,13 +2238,13 @@ kr korean encodings .TE -.IP "\-\-enable\-xim" 4 -.IX Item "--enable-xim" +.IP "\-\-enable\-xim (default: on)" 4 +.IX Item "--enable-xim (default: on)" Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using alternative input methods (e.g. kinput2) and will also correctly set up the input for people using dead keys or compose keys. -.IP "\-\-enable\-unicode3" 4 -.IX Item "--enable-unicode3" +.IP "\-\-enable\-unicode3 (default: off)" 4 +.IX Item "--enable-unicode3 (default: off)" Enable direct support for displaying unicode codepoints above 65535 (the basic multilingual page). This increases storage requirements per character from 2 to 4 bytes. X11 fonts do not yet @@ -2226,8 +2255,8 @@ limited to a view thousand (shared with combining characters, see next switch), and right now rxvt-unicode cannot display them (input/output and cut&paste still work, though). -.IP "\-\-enable\-combining" 4 -.IX Item "--enable-combining" +.IP "\-\-enable\-combining (default: on)" 4 +.IX Item "--enable-combining (default: on)" Enable automatic composition of combining characters into composite characters. This is required for proper viewing of text where accents are encoded as seperate unicode characters. This is @@ -2245,83 +2274,81 @@ The combining table also contains entries for arabic presentation forms, but these are not currently used. Bug me if you want these to be used (and tell me how these are to be used...). -.IP "\-\-enable\-fallback(=CLASS)" 4 -.IX Item "--enable-fallback(=CLASS)" -When reading resource settings, also read settings for class \s-1CLASS\s0 -(default: Rxvt). To disable resource fallback use \-\-disable\-fallback. -.IP "\-\-with\-res\-name=NAME" 4 -.IX Item "--with-res-name=NAME" -Use the given name (default: urxvt) as default application name when +.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 +.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" +When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. +.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 +.IX Item "--with-res-name=NAME (default: urxvt)" +Use the given name as default application name when reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. -.IP "\-\-with\-res\-class=CLASS" 4 -.IX Item "--with-res-class=CLASS" -Use the given class (default: URxvt) as default application class -when reading resources. Specify \-\-with\-res\-class=Rxvt to replace +.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 +.IX Item "--with-res-class=CLASS /default: URxvt)" +Use the given class as default application class +when reading resources. Specify \-\-with\-res\-class=Rxvt to replace rxvt. -.IP "\-\-enable\-utmp" 4 -.IX Item "--enable-utmp" +.IP "\-\-enable\-utmp (default: on)" 4 +.IX Item "--enable-utmp (default: on)" Write user and tty to utmp file (used by programs like \fIw\fR) at start of rxvt execution and delete information when rxvt exits. -.IP "\-\-enable\-wtmp" 4 -.IX Item "--enable-wtmp" +.IP "\-\-enable\-wtmp (default: on)" 4 +.IX Item "--enable-wtmp (default: on)" Write user and tty to wtmp file (used by programs like \fIlast\fR) at start of rxvt execution and write logout when rxvt exits. This option requires \-\-enable\-utmp to also be specified. -.IP "\-\-enable\-lastlog" 4 -.IX Item "--enable-lastlog" +.IP "\-\-enable\-lastlog (default: on)" 4 +.IX Item "--enable-lastlog (default: on)" Write user and tty to lastlog file (used by programs like \&\fIlastlogin\fR) at start of rxvt execution. This option requires \&\-\-enable\-utmp to also be specified. -.IP "\-\-enable\-xpm\-background" 4 -.IX Item "--enable-xpm-background" +.IP "\-\-enable\-xpm\-background (default: off)" 4 +.IX Item "--enable-xpm-background (default: off)" Add support for \s-1XPM\s0 background pixmaps. -.IP "\-\-enable\-transparency" 4 -.IX Item "--enable-transparency" +.IP "\-\-enable\-transparency (default: off)" 4 +.IX Item "--enable-transparency (default: off)" Add support for inheriting parent backgrounds thus giving a fake transparency to the term. -.IP "\-\-enable\-fading" 4 -.IX Item "--enable-fading" -Add support for fading the text when focus is lost. -.IP "\-\-enable\-tinting" 4 -.IX Item "--enable-tinting" -Add support for tinting of transparent backgrounds. -.IP "\-\-enable\-menubar" 4 -.IX Item "--enable-menubar" +.IP "\-\-enable\-fading (default: on)" 4 +.IX Item "--enable-fading (default: on)" +Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). +.IP "\-\-enable\-tinting (default: on)" 4 +.IX Item "--enable-tinting (default: on)" +Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). +.IP "\-\-enable\-menubar (default: off)" 4 +.IX Item "--enable-menubar (default: off)" Add support for our menu bar system (this interacts badly with dynamic locale switching currently). -.IP "\-\-enable\-rxvt\-scroll" 4 -.IX Item "--enable-rxvt-scroll" +.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 +.IX Item "--enable-rxvt-scroll (default: on)" Add support for the original rxvt scrollbar. -.IP "\-\-enable\-next\-scroll" 4 -.IX Item "--enable-next-scroll" +.IP "\-\-enable\-next\-scroll (default: on)" 4 +.IX Item "--enable-next-scroll (default: on)" Add support for a NeXT-like scrollbar. -.IP "\-\-enable\-xterm\-scroll" 4 -.IX Item "--enable-xterm-scroll" +.IP "\-\-enable\-xterm\-scroll (default: on)" 4 +.IX Item "--enable-xterm-scroll (default: on)" Add support for an Xterm-like scrollbar. -.IP "\-\-enable\-plain\-scroll" 4 -.IX Item "--enable-plain-scroll" +.IP "\-\-enable\-plain\-scroll (default: on)" 4 +.IX Item "--enable-plain-scroll (default: on)" Add support for a very unobtrusive, plain-looking scrollbar that is the favourite of the rxvt-unicode author, having used it for many years. -.IP "\-\-enable\-half\-shadow" 4 -.IX Item "--enable-half-shadow" +.IP "\-\-enable\-half\-shadow (default: off)" 4 +.IX Item "--enable-half-shadow (default: off)" Make shadows on the scrollbar only half the normal width & height. only applicable to rxvt scrollbars. -.IP "\-\-enable\-ttygid" 4 -.IX Item "--enable-ttygid" +.IP "\-\-enable\-ttygid (default: off)" 4 +.IX Item "--enable-ttygid (default: off)" Change tty device setting to group \*(L"tty\*(R" \- only use this if your system uses this type of security. .IP "\-\-disable\-backspace\-key" 4 .IX Item "--disable-backspace-key" -Disable any handling of the backspace key by us \- let the X server -do it. +Removes any handling of the backspace key by us \- let the X server do it. .IP "\-\-disable\-delete\-key" 4 .IX Item "--disable-delete-key" -Disable any handling of the delete key by us \- let the X server +Removes any handling of the delete key by us \- let the X server do it. .IP "\-\-disable\-resources" 4 .IX Item "--disable-resources" -Remove all resources checking. +Removes any support for resource checking. .IP "\-\-enable\-xgetdefault" 4 .IX Item "--enable-xgetdefault" Make resources checking via \fIXGetDefault()\fR instead of our small @@ -2331,8 +2358,8 @@ Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and use the full X resource manager, so the overhead of using it might be very small, if nonexistant. -.IP "\-\-enable\-strings" 4 -.IX Item "--enable-strings" +.IP "\-\-enable\-strings (default: off)" 4 +.IX Item "--enable-strings (default: off)" Add support for our possibly faster \fImemset()\fR function and other various routines, overriding your system's versions which may have been hand-crafted in assembly or may require extra libraries @@ -2340,9 +2367,9 @@ GNU/Linux systems). .IP "\-\-disable\-swapscreen" 4 .IX Item "--disable-swapscreen" -Remove support for swap screen. -.IP "\-\-enable\-frills" 4 -.IX Item "--enable-frills" +Remove support for secondary/swap screen. +.IP "\-\-enable\-frills (default: on)" 4 +.IX Item "--enable-frills (default: on)" Add support for many small features that are not essential but nice to have. Normally you want this, but for very small binaries you may want to disable this. @@ -2365,29 +2392,29 @@ \& cursor blinking and underline cursor \& -embed and -pty-fd options .Ve -.IP "\-\-enable\-iso14755" 4 -.IX Item "--enable-iso14755" +.IP "\-\-enable\-iso14755 (default: on)" 4 +.IX Item "--enable-iso14755 (default: on)" Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or \&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, while support for 5.2, 5.3 and 5.4 is enabled with this switch. -.IP "\-\-enable\-keepscrolling" 4 -.IX Item "--enable-keepscrolling" +.IP "\-\-enable\-keepscrolling (default: on)" 4 +.IX Item "--enable-keepscrolling (default: on)" Add support for continual scrolling of the display when you hold the mouse button down on a scrollbar arrow. -.IP "\-\-enable\-mousewheel" 4 -.IX Item "--enable-mousewheel" +.IP "\-\-enable\-mousewheel (default: on)" 4 +.IX Item "--enable-mousewheel (default: on)" Add support for scrolling via mouse wheel or buttons 4 & 5. -.IP "\-\-enable\-slipwheeling" 4 -.IX Item "--enable-slipwheeling" +.IP "\-\-enable\-slipwheeling (default: on)" 4 +.IX Item "--enable-slipwheeling (default: on)" Add support for continual scrolling (using the mouse wheel as an accelerator) while the control key is held down. This option requires \-\-enable\-mousewheel to also be specified. .IP "\-\-disable\-new\-selection" 4 .IX Item "--disable-new-selection" Remove support for mouse selection style like that of xterm. -.IP "\-\-enable\-dmalloc" 4 -.IX Item "--enable-dmalloc" +.IP "\-\-enable\-dmalloc (default: off)" 4 +.IX Item "--enable-dmalloc (default: off)" Use Gray Watson's malloc \- which is good for debugging See http://www.letters.com/dmalloc/ for details If you use either this or the next option, you may need to edit src/Makefile after compiling to point @@ -2395,27 +2422,26 @@ .Sp You can only use either this option and the following (should you use either) . -.IP "\-\-enable\-dlmalloc" 4 -.IX Item "--enable-dlmalloc" +.IP "\-\-enable\-dlmalloc (default: off)" 4 +.IX Item "--enable-dlmalloc (default: off)" Use Doug Lea's malloc \- which is good for a production version See for details. -.IP "\-\-enable\-smart\-resize" 4 -.IX Item "--enable-smart-resize" +.IP "\-\-enable\-smart\-resize (default: on)" 4 +.IX Item "--enable-smart-resize (default: on)" Add smart growth/shrink behaviour when changing font size via from hot keys. This should keep in a fixed position the rxvt corner which is closest to a corner of the screen. -.IP "\-\-enable\-pointer\-blank" 4 -.IX Item "--enable-pointer-blank" +.IP "\-\-enable\-pointer\-blank (default: on)" 4 +.IX Item "--enable-pointer-blank (default: on)" Add support to have the pointer disappear when typing or inactive. -.IP "\-\-with\-name=NAME" 4 -.IX Item "--with-name=NAME" -Set the basename for the installed binaries (default: \f(CW\*(C`urxvt\*(C'\fR, resulting +.IP "\-\-with\-name=NAME (default: urxvt)" 4 +.IX Item "--with-name=NAME (default: urxvt)" +Set the basename for the installed binaries, resulting in \f(CW\*(C`urxvt\*(C'\fR, \f(CW\*(C`urxvtd\*(C'\fR etc.). Specify \f(CW\*(C`\-\-with\-name=rxvt\*(C'\fR to replace with \&\f(CW\*(C`rxvt\*(C'\fR. -.IP "\-\-with\-term=NAME" 4 -.IX Item "--with-term=NAME" -Change the environmental variable for the terminal to \s-1NAME\s0 (default -\&\f(CW\*(C`rxvt\-unicode\*(C'\fR) +.IP "\-\-with\-term=NAME (default: rxvt\-unicode)" 4 +.IX Item "--with-term=NAME (default: rxvt-unicode)" +Change the environmental variable for the terminal to \s-1NAME\s0. .IP "\-\-with\-terminfo=PATH" 4 .IX Item "--with-terminfo=PATH" Change the environmental variable for the path to the terminfo tree to