--- rxvt-unicode/doc/rxvt.7.pod 2005/02/17 12:00:33 1.48 +++ rxvt-unicode/doc/rxvt.7.pod 2005/12/22 16:44:10 1.63 @@ -33,13 +33,14 @@ =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 (L) 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 C 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 (L) +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 C to report +the bug). For other problems that also affect the Debian package, you can and probably should use the Debian BTS, too, because, after all, it's also a @@ -74,6 +75,11 @@ If you don't plan to use B (quite common...) you could also replace the rxvt terminfo file with the rxvt-unicode one. +=item C outputs some error when compiling the terminfo entry. + +Most likely it's the empty definition for C. Just replace it by +C and try again. + =item C's readline does not work correctly under @@RXVT_NAME@@. =item I need a termcap file entry. @@ -260,6 +266,14 @@ All of this is not a problem when using X11 core fonts, as their bounding box data is correct. +=item On Solaris 9, many line-drawing characters are too wide. + +Seems to be a known bug, read +L. Some people use the +following ugly workaround to get non-double-wide-characters working: + + #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) + =item My Compose (Multi_key) key is no longer working. The most common causes for this are that either your locale is not set @@ -312,13 +326,16 @@ does it support it. Instead, it uses it's own internal representation of B. This is, of course, completely fine with respect to standards. -However, C<__STDC_ISO_10646__> is the only sane way to support -multi-language apps in an OS, as using a locale-dependent (and -non-standardized) representation of B makes it impossible to -convert between B (as used by X11 and your applications) and any -other encoding without implementing OS-specific-wrappers for each and -every locale. There simply are no APIs to convert B into anything -except the current locale encoding. +However, that means rxvt-unicode only works in C, C and +C locales under FreeBSD (which all use Unicode as B. + +C<__STDC_ISO_10646__> is the only sane way to support multi-language +apps in an OS, as using a locale-dependent (and non-standardized) +representation of B makes it impossible to convert between +B (as used by X11 and your applications) and any other encoding +without implementing OS-specific-wrappers for each and every locale. There +simply are no APIs to convert B into anything except the current +locale encoding. Some applications (such as the formidable B) work around this by carrying their own replacement functions for character set handling @@ -330,6 +347,24 @@ system libraries once and for all, instead of forcing every app to carry complete replacements for them :) +=item I use Solaris 9 and it doesn't compile/work/etc. + +Try the diff in F as a base. It fixes the worst +problems with C and a compile problem. + +=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 C<-multiwindow> or +C<-rootless> mode instead, which will result in similar look&feel as the +old libW11 emulation. + +At the time of this writing, cygwin didn't seem to support any multi-byte +encodings (you might try C), so you are likely limited +to 8-bit encodings. + =item How does rxvt-unicode determine the encoding to use? =item Is there an option to switch encodings? @@ -454,7 +489,7 @@ 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 C<:antialiasing=false>), which saves lots of +antialiasing (by appending C<:antialias=false>), which saves lots of memory and also speeds up rendering considerably. =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? @@ -542,14 +577,8 @@ =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. - -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: - - { @@RXVT_NAME@@d & } | read +Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the +display, create the listening socket and then fork. =item What's with the strange Backspace/Delete key behaviour? @@ -1477,19 +1506,21 @@ B<< C >> Change colour of bold characters to B<< C >> B<< C >> Change colour of underlined characters to B<< C >> B<< C >> Change default background to B<< C >> - B<< C >> Change default foreground colour to B<< C >> I + B<< C >> Change default foreground colour to B<< C >>. B<< C >> Change Log File to B<< C >> I - B<< C >> Change default background colour to B<< C >> I + B<< C >> Change default background colour to B<< C >>. B<< C >> Set fontset to B<< C >>, with the following special values of B<< C >> (B) B<< C<#+n> >> change up B<< C >> B<< C<#-n> >> change down B<< C >> if B<< C >> is missing of 0, a value of 1 is used I change to font0 B<< C >> change to font B<< C >> B<< C >> Log all scrollback buffer and all of screen to B<< C >> - B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (@@RXVT_NAME@@ extension) - B<< C >> Menubar command B<< C >> I (rxvt-unicode extension) + B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (Compile frills). + B<< C >> Menubar command B<< C >> (Compile menubar). B<< C >> Change colour of italic characters to B<< C >> - B<< C >> Change background pixmap tint colour to B<< C >> + B<< C >> Change background pixmap tint colour to B<< C >> (Compile transparency). B<< C >> Set normal fontset to B<< C >>. Same as C. - B<< C >> Set bold fontset to B<< C >>. Similar to C. - B<< C >> Set italic fontset to B<< C >>. Similar to C. - B<< C >> Set bold-italic fontset to B<< C >>. Similar to C. + B<< C >> Set bold fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Set italic fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Set bold-italic fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Move viewing window up by B<< C >> lines, or clear scrollback buffer if C (Compile frills). + B<< C >> Move viewing window down by B<< C >> lines, or clear scrollback buffer if C (Compile frills). =end table @@ -2156,40 +2187,47 @@ =head1 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 C<--enable-everything> or use +the F<./reconf> script as a base for experiments. F<./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 . + +All =over 4 =item --enable-everything -Add support for all non-multichoice options listed in "./configure ---help". Note that unlike other enable options this is order dependant. -You can specify this and then disable options which this enables by -I this with the appropriate commands. +Add (or remove) support for all non-multichoice options listed in "./configure +--help". -=item --enable-xft +You can specify this and then disable options you do not like by +I this with the appropriate C<--disable-...> arguments, +or you can start with a minimal configuration by specifying +C<--disable-everything> and than adding just the C<--enable-...> arguments +you want. + +=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. -=item --enable-font-styles +=item --enable-font-styles (default: on) Add support for B, I and B<< I >> font styles. The fonts can be set manually or automatically. -=item --with-codesets=NAME,... +=item --with-codesets=NAME,... (default: all) -Compile in support for additional codeset (encoding) groups (eu, vn are -always compiled in, which includes most 8-bit character sets). These -codeset tables are currently only used for driving X11 core fonts, they -are not required for Xft fonts. Compiling them in will make your binary -bigger (together about 700kB), but it doesn't increase memory usage unless -you use an X11 font requiring one of these encodings. +Compile in support for additional codeset (encoding) groups (C, C +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 +for Xft fonts, although having them compiled in lets rxvt-unicode choose +replacement fonts more intelligently. Compiling them in will make your +binary bigger (all of together cost about 700kB), but it doesn't increase +memory usage unless you use a font requiring one of these encodings. =begin table @@ -2202,13 +2240,13 @@ =end table -=item --enable-xim +=item --enable-xim (default: on) Add support for XIM (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. -=item --enable-unicode3 +=item --enable-unicode3 (default: off) Enable direct support for displaying unicode codepoints above 65535 (the basic multilingual page). This increases storage @@ -2221,7 +2259,7 @@ see next switch), and right now rxvt-unicode cannot display them (input/output and cut&paste still work, though). -=item --enable-combining +=item --enable-combining (default: on) Enable automatic composition of combining characters into composite characters. This is required for proper viewing of text @@ -2241,102 +2279,100 @@ but these are not currently used. Bug me if you want these to be used (and tell me how these are to be used...). -=item --enable-fallback(=CLASS) +=item --enable-fallback(=CLASS) (default: Rxvt) -When reading resource settings, also read settings for class CLASS -(default: Rxvt). To disable resource fallback use --disable-fallback. +When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. -=item --with-res-name=NAME +=item --with-res-name=NAME (default: urxvt) -Use the given name (default: urxvt) as default application name when +Use the given name as default application name when reading resources. Specify --with-res-name=rxvt to replace rxvt. -=item --with-res-class=CLASS +=item --with-res-class=CLASS /default: URxvt) -Use the given class (default: URxvt) as default application class -when reading resources. Specify --with-res-class=Rxvt to replace +Use the given class as default application class +when reading resources. Specify --with-res-class=Rxvt to replace rxvt. -=item --enable-utmp +=item --enable-utmp (default: on) Write user and tty to utmp file (used by programs like F) at start of rxvt execution and delete information when rxvt exits. -=item --enable-wtmp +=item --enable-wtmp (default: on) Write user and tty to wtmp file (used by programs like F) at start of rxvt execution and write logout when rxvt exits. This option requires --enable-utmp to also be specified. -=item --enable-lastlog +=item --enable-lastlog (default: on) Write user and tty to lastlog file (used by programs like F) at start of rxvt execution. This option requires --enable-utmp to also be specified. -=item --enable-xpm-background +=item --enable-xpm-background (default: off) Add support for XPM background pixmaps. -=item --enable-transparency +=item --enable-transparency (default: off) Add support for inheriting parent backgrounds thus giving a fake transparency to the term. -=item --enable-fading +=item --enable-fading (default: on) -Add support for fading the text when focus is lost. +Add support for fading the text when focus is lost (requires C<--enable-transparency>). -=item --enable-tinting +=item --enable-tinting (default: on) -Add support for tinting of transparent backgrounds. +Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). -=item --enable-menubar +=item --enable-menubar (default: off) Add support for our menu bar system (this interacts badly with dynamic locale switching currently). -=item --enable-rxvt-scroll +=item --enable-rxvt-scroll (default: on) Add support for the original rxvt scrollbar. -=item --enable-next-scroll +=item --enable-next-scroll (default: on) Add support for a NeXT-like scrollbar. -=item --enable-xterm-scroll +=item --enable-xterm-scroll (default: on) Add support for an Xterm-like scrollbar. -=item --enable-plain-scroll +=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. -=item --enable-half-shadow +=item --enable-half-shadow (default: off) Make shadows on the scrollbar only half the normal width & height. only applicable to rxvt scrollbars. -=item --enable-ttygid +=item --enable-ttygid (default: off) Change tty device setting to group "tty" - only use this if your system uses this type of security. =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. =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. =item --disable-resources -Remove all resources checking. +Removes any support for resource checking. =item --enable-xgetdefault @@ -2348,7 +2384,7 @@ use the full X resource manager, so the overhead of using it might be very small, if nonexistant. -=item --enable-strings +=item --enable-strings (default: off) Add support for our possibly faster memset() function and other various routines, overriding your system's versions which may @@ -2358,9 +2394,9 @@ =item --disable-swapscreen -Remove support for swap screen. +Remove support for secondary/swap screen. -=item --enable-frills +=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 @@ -2370,34 +2406,36 @@ in combination with other switches) is: MWM-hints + EWMH-hints (pid, utf8 names) and protocols (ping) seperate underline colour settable border widths and borderless switch settable extra linespacing - extra window properties (e.g. UTF-8 window names and PID) iso-14755-2 and -3, and visual feedback backindex and forwardindex escape sequence - window op and locale change escape sequences + window op and some xterm/OSC escape sequences tripleclickwords settable insecure mode keysym remapping support + cursor blinking and underline cursor + -embed, -pty-fd and -hold options -=item --enable-iso14755 +=item --enable-iso14755 (default: on) Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or F). Basic support (section 5.1) is enabled by C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with this switch. -=item --enable-keepscrolling +=item --enable-keepscrolling (default: on) Add support for continual scrolling of the display when you hold the mouse button down on a scrollbar arrow. -=item --enable-mousewheel +=item --enable-mousewheel (default: on) Add support for scrolling via mouse wheel or buttons 4 & 5. -=item --enable-slipwheeling +=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 @@ -2407,7 +2445,7 @@ Remove support for mouse selection style like that of xterm. -=item --enable-dmalloc +=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 @@ -2417,35 +2455,30 @@ You can only use either this option and the following (should you use either) . -=item --enable-dlmalloc +=item --enable-dlmalloc (default: off) Use Doug Lea's malloc - which is good for a production version See L for details. -=item --enable-smart-resize - -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. - -=item --enable-cursor-blink +=item --enable-smart-resize (default: on) -Add support for a blinking cursor. +Add smart growth/shrink behaviour when changing font size via hot +keys. This should keep the window corner which is closest to a corner of +the screen in a fixed position. -=item --enable-pointer-blank +=item --enable-pointer-blank (default: on) Add support to have the pointer disappear when typing or inactive. -=item --with-name=NAME +=item --with-name=NAME (default: urxvt) -Set the basename for the installed binaries (default: C, resulting +Set the basename for the installed binaries, resulting in C, C etc.). Specify C<--with-name=rxvt> to replace with C. -=item --with-term=NAME +=item --with-term=NAME (default: rxvt-unicode) -Change the environmental variable for the terminal to NAME (default -C) +Change the environmental variable for the terminal to NAME. =item --with-terminfo=PATH