[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.118 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC

 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
 all escape sequences, and other background information.
 The newest version of this document is also available on the World Wide Web at
-L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
+L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
 =head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
 =head2 Meta, Features & Commandline Issues
 =head3 How can I start @@URXVT_NAME@@d in a race-free way?
 Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
 display, create the listening socket and then fork.
-=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
+=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
 If you want to start @@URXVT_NAME@@d automatically whenever you run
 @@URXVT_NAME@@c and the daemon isn't running yet, use this script:
    #!/bin/sh
 This tries to create a new terminal, and if fails with exit status 2,
 meaning it couldn't connect to the daemon, it will start the daemon and
 re-run the command. Subsequent invocations of the script will re-use the
 existing daemon.
-=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
+=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
 The original rxvt and rxvt-unicode always export the variable "COLORTERM",
 so you can check and see if that is set. Note that several programs, JED,
 slrn, Midnight Commander automatically check this variable to decide
 whether or not to use color.
    fi
 =head3 How do I compile the manual pages on my own?
 You need to have a recent version of perl installed as F</usr/bin/perl>,
-one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
+one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
-the doc subdirectory and enter C<make alldoc>.
+F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
 =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
 I often get asked about this, and I think, no, they didn't cause extra
 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
    98398    1664      24   15695    1824 rxvt --disable-everything
   188985    9048   66616   18222    1788 urxvt --disable-everything
 When you C<--enable-everything> (which I<is> unfair, as this involves xft
 and full locale/XIM support which are quite bloaty inside libX11 and my
-libc), the two diverge, but not unreasnobaly so.
+libc), the two diverge, but not unreasonably so.
     text    data     bss     drs     rss filename
   163431    2152      24   20123    2060 rxvt --enable-everything
  1035683   49680   66648   29096    3680 urxvt --enable-everything
    @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
 This requires XFT support, and the support of your X-server. If that
 doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
-there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
+there yet, no matter what they claim. Rxvt-Unicode contains the necessary
 bugfixes and workarounds for Xft and Xlib to make it work, but that
 doesn't mean that your WM has the required kludges in place.
 4. Use xcompmgr and let it do the job:
 however: Xft fonts often draw glyphs larger than their acclaimed bounding
 box, and rxvt-unicode has no way of detecting this (the correct way is to
 ask for the character bounding box, which unfortunately is wrong in these
 cases).
-It's not clear (to me at least), wether this is a bug in Xft, freetype,
+It's not clear (to me at least), whether this is a bug in Xft, freetype,
 or the respective font. If you encounter this problem you might try using
 the C<-lsp> option to give the font more height. If that doesn't work, you
 might be forced to use a different font.
 All of this is not a problem when using X11 core fonts, as their bounding
 =head3 Why do italic characters look as if clipped?
 Many fonts have difficulties with italic characters and hinting. For
 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
-Mono> completely fails in it's italic face. A workaround might be to
+Mono> completely fails in its italic face. A workaround might be to
 enable freetype autohinting, i.e. like this:
    URxvt.italicFont:        xft:Bitstream Vera Sans Mono:italic:autohint=true
    URxvt.boldItalicFont:    xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
 memory and also speeds up rendering considerably.
 =head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
 Rxvt-unicode will use whatever you specify as a font. If it needs to
-fall back to it's default font search list it will prefer X11 core
+fall back to its default font search list it will prefer X11 core
 fonts, because they are small and fast, and then use Xft fonts. It has
 antialiasing disabled for most of them, because the author thinks they
 look best that way.
 If you want antialiasing, you have to specify the fonts manually.
 circumstances, it will move your cursor around when you click into the
 line that contains it. It tries hard not to do this at the wrong moment,
 but when running a program that doesn't parse cursor movements or in some
 cases during rlogin sessions, it fails to detect this properly.
-You can permamently switch this feature off by disabling the C<readline>
+You can permanently switch this feature off by disabling the C<readline>
 extension:
    URxvt.perl-ext-common: default,-readline
 =head3 My numerical keypad acts weird and generates differing output?
 Some Debian GNUL/Linux users seem to have this problem, although no
 specific details were reported so far. It is possible that this is caused
-by the wrong C<TERM> setting, although the details of wether and how
+by the wrong C<TERM> setting, although the details of whether and how
 this can happen are unknown, as C<TERM=rxvt> should offer a compatible
 keymap. See the answer to the previous question, and please report if that
 helped.
 =head3 My Compose (Multi_key) key is no longer working.
 depressed.
 =head3 What's with the strange Backspace/Delete key behaviour?
 Assuming that the physical Backspace key corresponds to the
-BackSpace keysym (not likely for Linux ... see the following
+Backspace keysym (not likely for Linux ... see the following
 question) there are two standard values that can be used for
 Backspace: C<^H> and C<^?>.
 Historically, either value is correct, but rxvt-unicode adopts the debian
-policy of using C<^?> when unsure, because it's the one only only correct
+policy of using C<^?> when unsure, because it's the one and only correct
 choice :).
 Rxvt-unicode tries to inherit the current stty settings and uses the value
 of `erase' to guess the value for backspace.  If rxvt-unicode wasn't
 started from a terminal (say, from a menu or by remote shell), then the
 directory and also tells urxvt to use a large number of extensions. I
 develop for myself mostly, so I actually use most of the extensions I
 write.
 The selection stuff mainly makes the selection perl-error-message aware
-and tells it to convert pelr error mssages into vi-commands to load the
+and tells it to convert perl error messages into vi-commands to load the
 relevant file and go tot he error line number.
    URxvt.scrollstyle:      plain
    URxvt.secondaryScroll:  true
 As the documentation says: plain is the preferred scrollbar for the
-author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
+author. The C<secondaryScroll> configures urxvt to scroll in full-screen
-apps, like screen, so lines scorlled out of screen end up in urxvt's
+apps, like screen, so lines scrolled out of screen end up in urxvt's
 scrollback buffer.
    URxvt.background:       #000000
    URxvt.foreground:       gray90
    URxvt.color7:           gray90
    urxvt.boldFont:         -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
    urxvt.italicFont:       xft:Bitstream Vera Sans Mono:italic:autohint=true
    urxvt.boldItalicFont:   xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
 I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
-overwhelmed. A special note: the C<9x15bold> mentioend above is actually
+overwhelmed. A special note: the C<9x15bold> mentioned above is actually
 the version from XFree-3.3, as XFree-4 replaced it by a totally different
 font (different glyphs for C<;> and many other harmless characters),
 while the second font is actually the C<9x15bold> from XFree4/XOrg. The
 bold version has less chars than the medium version, so I use it for rare
-characters, too. Whene ditign sources with vim, I use italic for comments
+characters, too. When editing sources with vim, I use italic for comments
 and other stuff, which looks quite good with Bitstream Vera anti-aliased.
 Terminus is a quite bad font (many very wrong glyphs), but for most of my
 purposes, it works, and gives a different look, as my normal (Non-bold)
 font is already bold, and I want to see a difference between bold and
 Also consider the form resources have to use:
   URxvt.resource: value
 If you want to use another form (there are lots of different ways of
-specifying resources), make sure you understand wether and why it
+specifying resources), make sure you understand whether and why it
 works. If unsure, use the form above.
 =head3 When I log-in to another system it tells me about missing terminfo data?
 The terminal description used by rxvt-unicode is not as widely available
 as that for xterm, or even rxvt (for which the same problem often arises).
 The correct solution for this problem is to install the terminfo, this can
-be done like this (with ncurses' infocmp):
+be done like this (with ncurses' infocmp and works as user and admin):
    REMOTE=remotesystem.domain
-   infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
+   infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
 ... or by installing rxvt-unicode normally on the remote system,
+One some systems you might need to set C<$TERMINFO> to the full path of
+F<$HOME/.terminfo> for this to work.
 If you cannot or do not want to do this, then you can simply set
 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
 problems arising, which includes wrong keymapping, less and different
 colours and some refresh errors in fullscreen applications. It's a nice
 One reason you might want this is that some distributions or operating
 systems still compile some programs using the long-obsoleted termcap
 library (Fedora Core's bash is one example) and rely on a termcap entry
 for C<rxvt-unicode>.
-You could use rxvt's termcap entry with resonable results in many cases.
+You could use rxvt's termcap entry with reasonable results in many cases.
 You can also create a termcap entry by using terminfo's infocmp program
 like this:
    infocmp -C rxvt-unicode
            :vs=\E[?25h:
 =head3 Why does C<ls> no longer have coloured output?
 The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
-decide wether a terminal has colour, but uses it's own configuration
+decide whether a terminal has colour, but uses its own configuration
-file. Needless to say, C<rxvt-unicode> is not in it's default file (among
+file. Needless to say, C<rxvt-unicode> is not in its default file (among
 with most other terminals supporting colour). Either add:
    TERM rxvt-unicode
 to C</etc/DIR_COLORS> or simply add:
 If you encounter strange problems like typing an accented character but
 getting two unrelated other characters or similar, or if program output is
 subtly garbled, then you should check your locale settings.
 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
-programs. Often rxvt-unicode is started in the C<C> locale, while the
+programs running in it. Often rxvt-unicode is started in the C<C> locale,
-login script running within the rxvt-unicode window changes the locale to
+while the login script running within the rxvt-unicode window changes the
-something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
+locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
+not going to work, and is the most common cause for problems.
 The best thing is to fix your startup environment, as you will likely run
 into other problems. If nothing works you can try this in your .profile.
-  printf '\33]701;%s\007' "$LC_CTYPE"
+  printf '\33]701;%s\007' "$LC_CTYPE"   # $LANG or $LC_ALL are worth a try, too
 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
 supported on your systems. Some systems have a C<locale> command which
 displays this (also, C<perl -e0> can be used to check locale settings, as
 it will complain loudly if it cannot set the locale). If it displays something
 The reasons is that there exists a perfectly fine mechanism for selecting
 the encoding, doing I/O and (most important) communicating this to all
 applications so everybody agrees on character properties such as width
 and code number. This mechanism is the I<locale>. Applications not using
 that info will have problems (for example, C<xterm> gets the width of
-characters wrong as it uses it's own, locale-independent table under all
+characters wrong as it uses its own, locale-independent table under all
 locales).
 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
 programs doing the same (that is, most) will automatically agree in the
 interpretation of characters.
 =item - Make sure your XIM server is actually running.
 =item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
 When you want to use e.g. B<kinput2>, it must be set to
-C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
+C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
 method servers are running with this command:
    xprop -root XIM_SERVERS
 =item
 =head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
 You should build one binary with the default options. F<configure>
 now enables most useful options, and the trend goes to making them
-runtime-switchable, too, so there is usually no drawback to enbaling them,
+runtime-switchable, too, so there is usually no drawback to enabling them,
 except higher disk and possibly memory usage. The perl interpreter should
 be enabled, as important functionality (menus, selection, likely more in
 the future) depends on it.
 You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
 This forking is done as the very first within main(), which is very early
 and reduces possible bugs to initialisation code run before main(), or
 things like the dynamic loader of your system, which should result in very
 little risk.
-=head3 On Solaris 9, many line-drawing characters are too wide.
-Seems to be a known bug, read
-L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
-following ugly workaround to get non-double-wide-characters working:
-   #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
 =head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
 in your compile environment, or an implementation that implements it,
-wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
+whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
 B<wchar_t> is represented as unicode.
-As you might have guessed, FreeBSD does neither define this symobl nor
+As you might have guessed, FreeBSD does neither define this symbol nor
-does it support it. Instead, it uses it's own internal representation of
+does it support it. Instead, it uses its own internal representation of
 B<wchar_t>. This is, of course, completely fine with respect to standards.
 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
 C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
 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 :)
-=head3 I use Solaris 9 and it doesn't compile/work/etc.
-Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
-problems with C<wcwidth> and a compile problem.
 =head3 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
 old libW11 emulation.
 At the time of this writing, cygwin didn't seem to support any multi-byte
 encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
 to 8-bit encodings.
+=head3 Character widths are not correct.
+urxvt uses the system wcwidth function to know the information about
+the width of characters, so on systems with incorrect locale data you
+will likely get bad results. Two notorious examples are Solaris 9,
+where single-width characters like U+2514 are reported as double-width,
+and Darwin 8, where combining chars are reported having width 1.
+The solution is to upgrade your system or switch to a better one. A
+possibly working workaround is to use a wcwidth implementation like
+http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
 =head1 RXVT-UNICODE TECHNICAL REFERENCE
 The rest of this document describes various technical aspects of
 B<rxvt-unicode>. First the description of supported command sequences,
 =head1 CONFIGURE OPTIONS
 General hint: if you get compile errors, then likely your configuration
 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
+the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
-myself, so it should generally be a working config. Of course, you should
+course, you should always report when a combination doesn't work, so it
-always report when a combination doesn't work, so it can be fixed. Marc
+can be fixed. Marc Lehmann <rxvt@schmorp.de>.
-Lehmann <rxvt@schmorp.de>.
 All
 =over 4
 =begin table
 	all	all available codeset groups
 	zh	common chinese encodings
-	zh_ext	rarely used but very big chinese encodigs
+	zh_ext	rarely used but very big chinese encodings
 	jp	common japanese encodings
 	jp_ext	rarely used but big japanese encodings
 	kr	korean encodings
 =end table
 requirements per character from 2 to 4 bytes. X11 fonts do not yet
 support these extra characters, but Xft does.
 Please note that rxvt-unicode can store unicode code points >65535
 even without this flag, but the number of such characters is
-limited to a view thousand (shared with combining characters,
+limited to a few thousand (shared with combining characters,
 see next switch), and right now rxvt-unicode cannot display them
 (input/output and cut&paste still work, though).
 =item --enable-combining (default: on)
 Write user and tty to lastlog file (used by programs like
 F<lastlogin>) at start of rxvt execution.  This option requires
 --enable-utmp to also be specified.
-=item --enable-xpm-background (default: on)
+=item --enable-afterimage (default: on)
-Add support for XPM background pixmaps.
+Add support for libAfterImage to be used for transparency and background
+images. It adds support for many file formats including JPG, PNG,
+SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
+(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
+This option also adds such eye candy as blending an image over the root
+background, as well as dynamic scaling and bluring of background images.
+Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
+increase by a few megabytes even if no extra features are used (mostly due
+to third-party libraries used by libAI). Memory footprint may somewhat be
+lowered if libAfterImage is configured without support for SVG.
 =item --enable-transparency (default: on)
 Add support for inheriting parent backgrounds thus giving a fake
 transparency to the term.
 =item --enable-fading (default: on)
-Add support for fading the text when focus is lost (requires C<--enable-transparency>).
+Add support for fading the text when focus is lost.
 =item --enable-tinting (default: on)
 Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
 in combination with other switches) is:
   MWM-hints
   EWMH-hints (pid, utf8 names) and protocols (ping)
+  urgency hint
   seperate underline colour (-underlineColor)
   settable border widths and borderless switch (-w, -b, -bl)
   visual depth selection (-depth)
   settable extra linespacing /-lsp)
-  iso-14755-2 and -3, and visual feedback
+  iso-14755 5.1 (basic) support
   tripleclickwords (-tcw)
   settable insecure mode (-insecure)
   keysym remapping support
   cursor blinking and underline cursor (-cb, -uc)
   XEmbed support (-embed)
 It also enables some non-essential features otherwise disabled, such as:
   some round-trip time optimisations
   nearest color allocation on pseudocolor screens
-  UTF8_STRING supporr for selection
+  UTF8_STRING support for selection
   sgr modes 90..97 and 100..107
   backindex and forwardindex escape sequences
-  view change/zero scorllback esacpe sequences
+  view change/zero scrollback escape sequences
   locale switching escape sequence
   window op and some xterm/OSC escape sequences
   rectangular selections
   trailing space removal for selections
   verbose X error handling
 =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-selectionscrolling (default: on)
+Add support for scrolling when the selection moves to the top or
+bottom of the screen.
 =item --enable-mousewheel (default: on)
 Add support for scrolling via mouse wheel or buttons 4 & 5.
 =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.
-=item --disable-new-selection
-Remove support for mouse selection style like that of xterm.
-=item --enable-dmalloc (default: off)
-Use Gray Watson's malloc - which is good for debugging See
-L<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
-DINCLUDE and DLIB to the right places.
-You can only use either this option and the following (should
-you use either) .
-=item --enable-dlmalloc (default: off)
-Use Doug Lea's malloc - which is good for a production version
-See L<http://g.oswego.edu/dl/html/malloc.html> for details.
-=item --enable-smart-resize (default: on)
+=item --enable-smart-resize (default: off)
-Add smart growth/shrink behaviour when changing font size via hot
+Add smart growth/shrink behaviour when resizing.
-keys. This should keep the window corner which is closest to a corner of
+This should keep the window corner which is closest to a corner of
 the screen in a fixed position.
 =item --enable-pointer-blank (default: on)
 Add support to have the pointer disappear when typing or inactive.
 =item --enable-perl (default: on)
 Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
-manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
+manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
-in F<src/perl-ext/> for the extensions that are installed by default. The
+files in F<src/perl-ext/> for the extensions that are installed by
-perl interpreter that is used can be specified via the C<PERL> environment
+default. The perl interpreter that is used can be specified via the
-variable when running configure.
+C<PERL> environment variable when running configure. Even when compiled
+in, perl will I<not> be initialised when all extensions have been disabled
+C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
+resource standpoint.
+=item --with-afterimage-config=DIR
+Look for the libAfterImage config script in DIR.
 =item --with-name=NAME (default: urxvt)
 Set the basename for the installed binaries, resulting
 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
 PATH.
 =item --with-x
 Use the X Window System (pretty much default, eh?).
-=item --with-xpm-includes=DIR
-Look for the XPM includes in DIR.
-=item --with-xpm-library=DIR
-Look for the XPM library in DIR.
-=item --with-xpm
-Not needed - define via --enable-xpm-background.
 =back
 =head1 AUTHORS

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.118 by root, Thu Jul 6 18:56:10 2006 UTC vs. Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.118 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC