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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.115 by root, Tue Feb 21 01:01:33 2006 UTC

 =head1 DESCRIPTION
 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
 all escape sequences, and other background information.
-The newest version of this document is
+The newest version of this document is also available on the World Wide Web at
-also available on the World Wide Web at
 L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
-=head1 FREQUENTLY ASKED QUESTIONS
+=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
-=over 4
+=head2 Meta, Features & Commandline Issues
+=head3 My question isn't answered here, can I ask a human?
+Before sending me mail, you could go to IRC: C<irc.freenode.net>,
+channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
+interested in learning about new and exciting problems (but not FAQs :).
+=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
+Beginning with version 7.3, there is a perl extension that implements a
+simple tabbed terminal. It is installed by default, so any of these should
+give you tabs:
+   @@URXVT_NAME@@ -pe tabbed
+   URxvt.perl-ext-common: default,tabbed
+It will also work fine with tabbing functionality of many window managers
+or similar tabbing programs, and its embedding-features allow it to be
+embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
+the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
+(murxvt) terminal as an example embedding application.
-=item How do I know which rxvt-unicode version I'm using?
+=head3 How do I know which rxvt-unicode version I'm using?
 The version number is displayed with the usage (-h). Also the escape
-sequence C<ESC [ 8 n> sets the window title to the version number.
+sequence C<ESC [ 8 n> sets the window title to the version number. When
+using the @@URXVT_NAME@@c client, the version displayed is that of the
+daemon.
-=item I am using Debian GNU/Linux and have a problem...
+=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
-The Debian GNU/Linux package of rxvt-unicode contains large patches that
+Rxvt-unicode tries to obey the rule of not charging you for something you
-considerably change the behaviour of rxvt-unicode. Before reporting a
+don't use. One thing you should try is to configure out all settings that
-bug to the original rxvt-unicode author please download and install the
+you don't need, for example, Xft support is a resource hog by design,
-genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
+when used. Compiling it out ensures that no Xft font will be loaded
-reproduce the problem. If you cannot, chances are that the problems are
+accidentally when rxvt-unicode tries to find a font for your characters.
-specific to Debian GNU/Linux, in which case it should be reported via the
-Debian Bug Tracking System (use C<reportbug> to report the bug).
-For other problems that also affect the Debian package, you can and
+Also, many people (me included) like large windows and even larger
-probably should use the Debian BTS, too, because, after all, it's also a
+scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
-bug in the Debian version and it serves as a reminder for other users that
+6 bytes per screen cell. For a 160x?? window this amounts to almost a
-might encounter the same issue.
+kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
+use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
+rxvt-unicode then uses 8 bytes per screen cell.
+=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?
+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
+   @@URXVT_NAME@@c "$@"
+   if [ $? -eq 2 ]; then
+      @@URXVT_NAME@@d -q -o -f
+      @@URXVT_NAME@@c "$@"
+   fi
+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.
+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.
+=head3 How do I set the correct, full IP address for the DISPLAY variable?
+If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
+insecure mode then it is possible to use the following shell script
+snippets to correctly set the display. If your version of rxvt-unicode
+wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
+the COLORTERM variable can be used to distinguish rxvt-unicode from a
+regular xterm.
+Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
+snippets:
+   # Bourne/Korn/POSIX family of shells:
+   [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
+   if [ ${TERM:-foo} = xterm ]; then
+      stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
+      echo -n '^[Z'
+      read term_id
+      stty icanon echo
+      if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
+         echo -n '^[[7n'        # query the rxvt we are in for the DISPLAY string
+         read DISPLAY           # set it in our local shell
+      fi
+   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
+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
+that the urxvt binary is larger (due to some encoding tables always being
+compiled in), but it actually uses less memory (RSS) after startup. Even
+with C<--disable-everything>, this comparison is a bit unfair, as many
+features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
+already in use in this mode.
+    text    data     bss     drs     rss filename
+   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.
+    text    data     bss     drs     rss filename
+  163431    2152      24   20123    2060 rxvt --enable-everything
+ 1035683   49680   66648   29096    3680 urxvt --enable-everything
+The very large size of the text section is explained by the east-asian
+encoding tables, which, if unused, take up disk space but nothing else
+and can be compiled out unless you rely on X11 core fonts that use those
+encodings. The BSS size comes from the 64k emergency buffer that my c++
+compiler allocates (but of course doesn't use unless you are out of
+memory). Also, using an xft font instead of a core font immediately adds a
+few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
+not used.
+Of course, due to every character using two or four bytes instead of one,
+a large scrollback buffer will ultimately make rxvt-unicode use more
+memory.
+Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
+still fares rather well. And compared to some monsters like gnome-terminal
+(21152k + extra 4204k in separate processes) or konsole (22200k + extra
+43180k in daemons that stay around after exit, plus half a minute of
+startup time, including the hundreds of warnings it spits out), it fares
+extremely well *g*.
+=head3 Why C++, isn't that unportable/bloated/uncool?
+Is this a question? :) It comes up very often. The simple answer is: I had
+to write it, and C++ allowed me to write and maintain it in a fraction
+of the time and effort (which is a scarce resource for me). Put even
+shorter: It simply wouldn't exist without C++.
+My personal stance on this is that C++ is less portable than C, but in
+the case of rxvt-unicode this hardly matters, as its portability limits
+are defined by things like X11, pseudo terminals, locale support and unix
+domain sockets, which are all less portable than C++ itself.
+Regarding the bloat, see the above question: It's easy to write programs
+in C that use gobs of memory, an certainly possible to write programs in
+C++ that don't. C++ also often comes with large libraries, but this is
+not necessarily the case with GCC. Here is what rxvt links against on my
+system with a minimal config:
+   libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
+   libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
+   libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
+   /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
+And here is rxvt-unicode:
+   libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
+   libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
+   libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
+   libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
+   /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
+No large bloated libraries (of course, none were linked in statically),
+except maybe libX11 :)
+=head2 Rendering, Font & Look and Feel Issues
+=head3 I can't get transparency working, what am I doing wrong?
+First of all, transparency isn't officially supported in rxvt-unicode, so
+you are mostly on your own. Do not bug the author about it (but you may
+bug everybody else). Also, if you can't get it working consider it a rite
+of passage: ... and you failed.
+Here are four ways to get transparency. B<Do> read the manpage and option
+descriptions for the programs mentioned and rxvt-unicode. Really, do it!
+1. Use inheritPixmap:
+   Esetroot wallpaper.jpg
+   @@URXVT_NAME@@ -ip -tint red -sh 40
+That works. If you think it doesn't, you lack transparency and tinting
+support, or you are unable to read.
+2. Use a simple pixmap and emulate pseudo-transparency. This enables you
+to use effects other than tinting and shading: Just shade/tint/whatever
+your picture with gimp or any other tool:
+   convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
+   @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
+That works. If you think it doesn't, you lack XPM and Perl support, or you
+are unable to read.
+3. Use an ARGB visual:
+   @@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
+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:
+  xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
+        -set _NET_WM_WINDOW_OPACITY 0xc0000000
+Then click on a window you want to make transparent. Replace C<0xc0000000>
+by other values to change the degree of opacity. If it doesn't work and
+your server crashes, you got to keep the pieces.
+=head3 Why does rxvt-unicode sometimes leave pixel droppings?
+Most fonts were not designed for terminal use, which means that character
+size varies a lot. A font that is otherwise fine for terminal use might
+contain some characters that are simply too wide. Rxvt-unicode will avoid
+these characters. For characters that are just "a bit" too wide a special
+"careful" rendering mode is used that redraws adjacent characters.
+All of this requires that fonts do not lie about character sizes,
+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,
+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
+box data is correct.
+=head3 How can I keep rxvt-unicode from using reverse video so much?
+First of all, make sure you are running with the right terminal settings
+(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
+make sure you have specified colours for italic and bold, as otherwise
+rxvt-unicode might use reverse video to simulate the effect:
+   URxvt.colorBD:  white
+   URxvt.colorIT:  green
+=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
+For some unexplainable reason, some rare programs assume a very weird
+colour palette when confronted with a terminal with more than the standard
+8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
+these programs not to assume non-ISO colours without very good reasons.
+In the meantime, you can either edit your C<rxvt-unicode> terminfo
+definition to only claim 8 colour support or use C<TERM=rxvt>, which will
+fix colours but keep you from using other rxvt-unicode features.
+=head3 Can I switch the fonts at runtime?
+Yes, using an escape sequence. Try something like this, which has the same
+effect as using the C<-fn> switch, and takes effect immediately:
+   printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
+This is useful if you e.g. work primarily with japanese (and prefer a
+japanese font), but you have to switch to chinese temporarily, where
+japanese fonts would only be in your way.
+You can think of this as a kind of manual ISO-2022 switching.
+=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
+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
+=head3 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 C<:antialias=false>), which saves lots of
+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
+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.
+=head3 What's with this bold/blink stuff?
+If no bold colour is set via C<colorBD:>, bold will invert text using the
+standard foreground colour.
+For the standard background colour, blinking will actually make the
+text blink when compiled with C<--enable-blinking>. with standard
+colours. Without C<--enable-blinking>, the blink attribute will be
+ignored.
+On ANSI colours, bold/blink attributes are used to set high-intensity
+foreground/background colors.
+color0-7 are the low-intensity colors.
+color8-15 are the corresponding high-intensity colors.
+=head3 I don't like the screen colors.  How do I change them?
+You can change the screen colors at run-time using F<~/.Xdefaults>
+resources (or as long-options).
+Here are values that are supposed to resemble a VGA screen,
+including the murky brown that passes for low-intensity yellow:
+   URxvt.color0:   #000000
+   URxvt.color1:   #A80000
+   URxvt.color2:   #00A800
+   URxvt.color3:   #A8A800
+   URxvt.color4:   #0000A8
+   URxvt.color5:   #A800A8
+   URxvt.color6:   #00A8A8
+   URxvt.color7:   #A8A8A8
+   URxvt.color8:   #000054
+   URxvt.color9:   #FF0054
+   URxvt.color10:  #00FF54
+   URxvt.color11:  #FFFF54
+   URxvt.color12:  #0000FF
+   URxvt.color13:  #FF00FF
+   URxvt.color14:  #00FFFF
+   URxvt.color15:  #FFFFFF
+And here is a more complete set of non-standard colors.
+   URxvt.cursorColor:  #dc74d1
+   URxvt.pointerColor: #dc74d1
+   URxvt.background:   #0e0e0e
+   URxvt.foreground:   #4ad5e1
+   URxvt.color0:       #000000
+   URxvt.color8:       #8b8f93
+   URxvt.color1:       #dc74d1
+   URxvt.color9:       #dc74d1
+   URxvt.color2:       #0eb8c7
+   URxvt.color10:      #0eb8c7
+   URxvt.color3:       #dfe37e
+   URxvt.color11:      #dfe37e
+   URxvt.color5:       #9e88f0
+   URxvt.color13:      #9e88f0
+   URxvt.color6:       #73f7ff
+   URxvt.color14:      #73f7ff
+   URxvt.color7:       #e1dddd
+   URxvt.color15:      #e1dddd
+They have been described (not by me) as "pretty girly".
+=head3 Why do some characters look so much different than others?
+See next entry.
+=head3 How does rxvt-unicode choose fonts?
+Most fonts do not contain the full range of Unicode, which is
+fine. Chances are that the font you (or the admin/package maintainer of
+your system/os) have specified does not cover all the characters you want
+to display.
+B<rxvt-unicode> makes a best-effort try at finding a replacement
+font. Often the result is fine, but sometimes the chosen font looks
+bad/ugly/wrong. Some fonts have totally strange characters that don't
+resemble the correct glyph at all, and rxvt-unicode lacks the artificial
+intelligence to detect that a specific glyph is wrong: it has to believe
+the font that the characters it claims to contain indeed look correct.
+In that case, select a font of your taste and add it to the font list,
+e.g.:
+   @@URXVT_NAME@@ -fn basefont,font2,font3...
+When rxvt-unicode sees a character, it will first look at the base
+font. If the base font does not contain the character, it will go to the
+next font, and so on. Specifying your own fonts will also speed up this
+search and use less resources within rxvt-unicode and the X-server.
+The only limitation is that none of the fonts may be larger than the base
+font, as the base font defines the terminal character cell size, which
+must be the same due to the way terminals work.
+=head3 Why do some chinese characters look so different than others?
+This is because there is a difference between script and language --
+rxvt-unicode does not know which language the text that is output is,
+as it only knows the unicode character codes. If rxvt-unicode first
+sees a japanese/chinese character, it might choose a japanese font for
+display. Subsequent japanese characters will use that font. Now, many
+chinese characters aren't represented in japanese fonts, so when the first
+non-japanese character comes up, rxvt-unicode will look for a chinese font
+-- unfortunately at this point, it will still use the japanese font for
+chinese characters that are also in the japanese font.
+The workaround is easy: just tag a chinese font at the end of your font
+list (see the previous question). The key is to view the font list as
+a preference list: If you expect more japanese, list a japanese font
+first. If you expect more chinese, put a chinese font first.
+In the future it might be possible to switch language preferences at
+runtime (the internal data structure has no problem with using different
+fonts for the same character at the same time, but no interface for this
+has been designed yet).
+Until then, you might get away with switching fonts at runtime (see L<Can
+I switch the fonts at runtime?> later in this document).
+=head2 Keyboard, Mouse & User Interaction
+=head3 The new selection selects pieces that are too big, how can I select single words?
+If you want to select e.g. alphanumeric words, you can use the following
+setting:
+   URxvt.selection.pattern-0: ([[:word:]]+)
+If you click more than twice, the selection will be extended
+more and more.
+To get a selection that is very similar to the old code, try this pattern:
+   URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
+Please also note that the I<LeftClick Shift-LeftClik> combination also
+selects words like the old code.
+=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
+You can disable the perl extension completely by setting the
+B<perl-ext-common> resource to the empty string, which also keeps
+rxvt-unicode from initialising perl, saving memory.
+If you only want to disable specific features, you first have to
+identify which perl extension is responsible. For this, read the section
+B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
+example, to disable the B<selection-popup> and B<option-popup>, specify
+this B<perl-ext-common> resource:
+   URxvt.perl-ext-common: default,-selection-popup,-option-popup
+This will keep the default extensions, but disable the two popup
+extensions. Some extensions can also be configured, for example,
+scrollback search mode is triggered by B<M-s>. You can move it to any
+other combination either by setting the B<searchable-scrollback> resource:
+   URxvt.searchable-scrollback: CM-s
+=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
+See next entry.
+=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
+These are caused by the C<readline> perl extension. Under normal
+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>
+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
+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.
+The most common causes for this are that either your locale is not set
+correctly, or you specified a B<preeditStyle> that is not supported by
+your input method. For example, if you specified B<OverTheSpot> and
+your input method (e.g. the default input method handling Compose keys)
+does not support this (for instance because it is not visual), then
+rxvt-unicode will continue without an input method.
+In this case either do not specify a B<preeditStyle> or specify more than
+one pre-edit style, such as B<OverTheSpot,Root,None>.
+=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
+Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
+international keyboards) or simply use ISO 14755 support to your
+advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
+codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
+character and so on.
+=head3 Mouse cut/paste suddenly no longer works.
+Make sure that mouse reporting is actually turned off since killing
+some editors prematurely may leave the mouse in mouse report mode. I've
+heard that tcsh may use mouse reporting unless it otherwise specified. A
+quick check is to see if cut/paste works when the Alt or Shift keys are
+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
+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
+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
+system value of `erase', which corresponds to CERASE in <termios.h>, will
+be used (which may not be the same as your stty setting).
+For starting a new rxvt-unicode:
+   # use Backspace = ^H
+   $ stty erase ^H
+   $ @@URXVT_NAME@@
+   # use Backspace = ^?
+   $ stty erase ^?
+   $ @@URXVT_NAME@@
+Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
+For an existing rxvt-unicode:
+   # use Backspace = ^H
+   $ stty erase ^H
+   $ echo -n "^[[36h"
+   # use Backspace = ^?
+   $ stty erase ^?
+   $ echo -n "^[[36l"
+This helps satisfy some of the Backspace discrepancies that occur, but
+if you use Backspace = C<^H>, make sure that the termcap/terminfo value
+properly reflects that.
+The Delete key is a another casualty of the ill-defined Backspace problem.
+To avoid confusion between the Backspace and Delete keys, the Delete
+key has been assigned an escape sequence to match the vt100 for Execute
+(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
+Some other Backspace problems:
+some editors use termcap/terminfo,
+some editors (vim I'm told) expect Backspace = ^H,
+GNU Emacs (and Emacs-like editors) use ^H for help.
+Perhaps someday this will all be resolved in a consistent manner.
+=head3 I don't like the key-bindings.  How do I change them?
+There are some compile-time selections available via configure. Unless
+you have run "configure" with the C<--disable-resources> option you can
+use the `keysym' resource to alter the keystrings associated with keysyms.
+Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
+   URxvt.keysym.Home:          \033[1~
+   URxvt.keysym.End:           \033[4~
+   URxvt.keysym.C-apostrophe:  \033<C-'>
+   URxvt.keysym.C-slash:       \033<C-/>
+   URxvt.keysym.C-semicolon:   \033<C-;>
+   URxvt.keysym.C-grave:       \033<C-`>
+   URxvt.keysym.C-comma:       \033<C-,>
+   URxvt.keysym.C-period:      \033<C-.>
+   URxvt.keysym.C-0x60:        \033<C-`>
+   URxvt.keysym.C-Tab:         \033<C-Tab>
+   URxvt.keysym.C-Return:      \033<C-Return>
+   URxvt.keysym.S-Return:      \033<S-Return>
+   URxvt.keysym.S-space:       \033<S-Space>
+   URxvt.keysym.M-Up:          \033<M-Up>
+   URxvt.keysym.M-Down:        \033<M-Down>
+   URxvt.keysym.M-Left:        \033<M-Left>
+   URxvt.keysym.M-Right:       \033<M-Right>
+   URxvt.keysym.M-C-0:         list \033<M-C- 0123456789 >
+   URxvt.keysym.M-C-a:         list \033<M-C- abcdefghijklmnopqrstuvwxyz >
+   URxvt.keysym.F12:           command:\033]701;zh_CN.GBK\007
+See some more examples in the documentation for the B<keysym> resource.
+=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
+   KP_Insert == Insert
+   F22 == Print
+   F27 == Home
+   F29 == Prior
+   F33 == End
+   F35 == Next
+Rather than have rxvt-unicode try to accommodate all the various possible
+keyboard mappings, it is better to use `xmodmap' to remap the keys as
+required for your particular machine.
+=head2 Terminal Configuration
+=head3 Can I see a typical configuration?
+The default configuration tries to be xterm-like, which I don't like that
+much, but it's least surprise to regular users.
+As a rxvt or rxvt-unicode user, you are practically supposed to invest
+time into customising your terminal. To get you started, here is the
+author's .Xdefaults entries, with comments on what they do. It's certainly
+not I<typical>, but what's typical...
+   URxvt.cutchars: "()*,<>[]{}|'
+   URxvt.print-pipe: cat >/tmp/xxx
+These are just for testing stuff.
+   URxvt.imLocale: ja_JP.UTF-8
+   URxvt.preeditType: OnTheSpot,None
+This tells rxvt-unicode to use a special locale when communicating with
+the X Input Method, and also tells it to only use the OnTheSpot pre-edit
+type, which requires the C<xim-onthespot> perl extension but rewards me
+with correct-looking fonts.
+   URxvt.perl-lib: /root/lib/urxvt
+   URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
+   URxvt.selection.pattern-0: ( at .*? line \\d+)
+   URxvt.selection.pattern-1: ^(/[^:]+):\
+   URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
+   URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
+This is my perl configuration. The first two set the perl library
+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
+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
+apps, like screen, so lines scorlled out of screen end up in urxvt's
+scrollback buffer.
+   URxvt.background:       #000000
+   URxvt.foreground:       gray90
+   URxvt.color7:           gray90
+   URxvt.colorBD:          #ffffff
+   URxvt.cursorColor:      #e0e080
+   URxvt.throughColor:     #8080f0
+   URxvt.highlightColor:   #f0f0f0
+Some colours. Not sure which ones are being used or even non-defaults, but
+these are in my .Xdefaults. Most notably, they set foreground/background
+to light gray/black, and also make sure that the colour 7 matches the
+default foreground colour.
+   URxvt.underlineColor:   yellow
+Another colour, makes underline lines look different. Sometimes hurts, but
+is mostly a nice effect.
+   URxvt.geometry:         154x36
+   URxvt.loginShell:       false
+   URxvt.meta:             ignore
+   URxvt.utmpInhibit:      true
+Uh, well, should be mostly self-explanatory. By specifying some defaults
+manually, I can quickly switch them for testing.
+   URxvt.saveLines:        8192
+A large scrollback buffer is essential. Really.
+   URxvt.mapAlert:         true
+The only case I use it is for my IRC window, which I like to keep
+iconified till people msg me (which beeps).
+   URxvt.visualBell:       true
+The audible bell is often annoying, especially when in a crowd.
+   URxvt.insecure:         true
+Please don't hack my mutt! Ooops...
+   URxvt.pastableTabs:     false
+I once thought this is a great idea.
+   urxvt.font:             9x15bold,\
+                           -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
+                           -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
+                           [codeset=JISX0208]xft:Kochi Gothic, \
+                           xft:Bitstream Vera Sans Mono:autohint=true, \
+                           xft:Code2000:antialias=false
+   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
+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
+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
+normal fonts.
+Please note that I used the C<urxvt> instance name and not the C<URxvt>
+class name. Thats because I use different configs for different purposes,
+for example, my IRC window is started with C<-name IRC>, and uses these
+defaults:
+   IRC*title:              IRC
+   IRC*geometry:           87x12+535+542
+   IRC*saveLines:          0
+   IRC*mapAlert:           true
+   IRC*font:               suxuseuro
+   IRC*boldFont:           suxuseuro
+   IRC*colorBD:            white
+   IRC*keysym.M-C-1:       command:\033]710;suxuseuro\007\033]711;suxuseuro\007
+   IRC*keysym.M-C-2:       command:\033]710;9x15bold\007\033]711;9x15bold\007
+C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
+sizes. C<suxuseuro> allows me to keep an eye (and actually read)
+stuff while keeping a very small window. If somebody pastes something
+complicated (e.g. japanese), I temporarily switch to a larger font.
+The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
+C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
+file for different hosts, for example, on ym main desktop, I use:
+   URxvt.keysym.C-M-q: command:\033[3;5;5t
+   URxvt.keysym.C-M-y: command:\033[3;5;606t
+   URxvt.keysym.C-M-e: command:\033[3;1605;5t
+   URxvt.keysym.C-M-c: command:\033[3;1605;606t
+   URxvt.keysym.C-M-p: perl:test
+The first for keysym definitions allow me to quickly bring some windows
+in the layout I like most. Ion users might start laughing but will stop
+immediately when I tell them that I use my own Fvwm2 module for much the
+same effect as Ion provides, and I only very rarely use the above key
+combinations :->
+=head3 Why doesn't rxvt-unicode read my resources?
+Well, why, indeed? It does, in a way very similar to other X
+applications. Most importantly, this means that if you or your OS loads
+resources into the X display (the right way to do it), rxvt-unicode will
+ignore any resource files in your home directory. It will only read
+F<$HOME/.Xdefaults> when no resources are attached to the display.
+If you have or use an F<$HOME/.Xresources> file, chances are that
+resources are loaded into your X-server. In this case, you have to
+re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
+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
+works. If unsure, use the form above.
-=item When I log-in to another system it tells me about missing terminfo data?
+=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
 resource to set it:
    URxvt.termName: rxvt
 If you don't plan to use B<rxvt> (quite common...) you could also replace
-the rxvt terminfo file with the rxvt-unicode one.
+the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
+=head3 C<tic> outputs some error when compiling the terminfo entry.
+Most likely it's the empty definition for C<enacs=>. Just replace it by
+C<enacs=\E[0@> and try again.
-=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
+=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
+See next entry.
-=item I need a termcap file entry.
+=head3 I need a termcap file entry.
 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>.
            :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
            :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
            :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
            :vs=\E[?25h:
-=item Why does C<ls> no longer have coloured output?
+=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
 file. Needless to say, C<rxvt-unicode> is not in it's default file (among
 with most other terminals supporting colour). Either add:
    alias ls='ls --color=auto'
 to your C<.profile> or C<.bashrc>.
-=item Why doesn't vim/emacs etc. use the 88 colour mode?
+=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
+See next entry.
-=item Why doesn't vim/emacs etc. make use of italic?
+=head3 Why doesn't vim/emacs etc. make use of italic?
+See next entry.
-=item Why are the secondary screen-related options not working properly?
+=head3 Why are the secondary screen-related options not working properly?
 Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
 distributions (most notably Debian GNU/Linux) break rxvt-unicode
 by setting C<TERM> to C<rxvt>, which doesn't have these extra
 features. Unfortunately, some of these (most notably, again, Debian
 GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
 file, so you will need to install it on your own (See the question B<When
 I log-in to another system it tells me about missing terminfo data?> on
 how to do this).
-=item My numerical keypad acts weird and generates differing output?
-Some Debian GNUL/Linux users seem to have this problem, although no
+=head2 Encoding / Locale / Input Method Issues
-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
-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.
-=item Rxvt-unicode does not seem to understand the selected encoding?
+=head3 Rxvt-unicode does not seem to understand the selected encoding?
+See next entry.
-=item Unicode does not seem to work?
+=head3 Unicode does not seem to work?
 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.
 If nothing works and you are sure that everything is set correctly then
 you will need to remember a little known fact: Some programs just don't
 support locales :(
-=item Why do some characters look so much different than others?
-=item How does rxvt-unicode choose fonts?
-Most fonts do not contain the full range of Unicode, which is
-fine. Chances are that the font you (or the admin/package maintainer of
-your system/os) have specified does not cover all the characters you want
-to display.
-B<rxvt-unicode> makes a best-effort try at finding a replacement
-font. Often the result is fine, but sometimes the chosen font looks
-bad/ugly/wrong. Some fonts have totally strange characters that don't
-resemble the correct glyph at all, and rxvt-unicode lacks the artificial
-intelligence to detect that a specific glyph is wrong: it has to believe
-the font that the characters it claims to contain indeed look correct.
-In that case, select a font of your taste and add it to the font list,
-e.g.:
-   @@RXVT_NAME@@ -fn basefont,font2,font3...
-When rxvt-unicode sees a character, it will first look at the base
-font. If the base font does not contain the character, it will go to the
-next font, and so on. Specifying your own fonts will also speed up this
-search and use less resources within rxvt-unicode and the X-server.
-The only limitation is that none of the fonts may be larger than the base
-font, as the base font defines the terminal character cell size, which
-must be the same due to the way terminals work.
-=item Why do some chinese characters look so different than others?
-This is because there is a difference between script and language --
-rxvt-unicode does not know which language the text that is output is,
-as it only knows the unicode character codes. If rxvt-unicode first
-sees a japanese/chinese character, it might choose a japanese font for
-display. Subsequent japanese characters will use that font. Now, many
-chinese characters aren't represented in japanese fonts, so when the first
-non-japanese character comes up, rxvt-unicode will look for a chinese font
--- unfortunately at this point, it will still use the japanese font for
-chinese characters that are also in the japanese font.
-The workaround is easy: just tag a chinese font at the end of your font
-list (see the previous question). The key is to view the font list as
-a preference list: If you expect more japanese, list a japanese font
-first. If you expect more chinese, put a chinese font first.
-In the future it might be possible to switch language preferences at
-runtime (the internal data structure has no problem with using different
-fonts for the same character at the same time, but no interface for this
-has been designed yet).
-Until then, you might get away with switching fonts at runtime (see L<Can
-I switch the fonts at runtime?> later in this document).
-=item Why does rxvt-unicode sometimes leave pixel droppings?
-Most fonts were not designed for terminal use, which means that character
-size varies a lot. A font that is otherwise fine for terminal use might
-contain some characters that are simply too wide. Rxvt-unicode will avoid
-these characters. For characters that are just "a bit" too wide a special
-"careful" rendering mode is used that redraws adjacent characters.
-All of this requires that fonts do not lie about character sizes,
-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,
-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
-box data is correct.
-=item My Compose (Multi_key) key is no longer working.
-The most common causes for this are that either your locale is not set
-correctly, or you specified a B<preeditStyle> that is not supported by
-your input method. For example, if you specified B<OverTheSpot> and
-your input method (e.g. the default input method handling Compose keys)
-does not support this (for instance because it is not visual), then
-rxvt-unicode will continue without an input method.
-In this case either do not specify a B<preeditStyle> or specify more than
-one pre-edit style, such as B<OverTheSpot,Root,None>.
-=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
-Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
-international keyboards) or simply use ISO 14755 support to your
-advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
-codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
-character and so on.
-=item How can I keep rxvt-unicode from using reverse video so much?
-First of all, make sure you are running with the right terminal settings
-(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
-make sure you have specified colours for italic and bold, as otherwise
-rxvt-unicode might use reverse video to simulate the effect:
-   URxvt.colorBD:  white
-   URxvt.colorIT:  green
-=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
-For some unexplainable reason, some rare programs assume a very weird
-colour palette when confronted with a terminal with more than the standard
-8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
-these programs not to assume non-ISO colours without very good reasons.
-In the meantime, you can either edit your C<rxvt-unicode> terminfo
-definition to only claim 8 colour support or use C<TERM=rxvt>, which will
-fix colours but keep you from using other rxvt-unicode features.
-=item 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
-B<wchar_t> is represented as unicode.
-As you might have guessed, FreeBSD does neither define this symobl nor
-does it support it. Instead, it uses it's own internal representation of
-B<wchar_t>. 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<wchar_t> makes it impossible to
-convert between B<wchar_t> (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<wchar_t> into anything
-except the current locale encoding.
-Some applications (such as the formidable B<mlterm>) work around this
-by carrying their own replacement functions for character set handling
-with them, and either implementing OS-dependent hacks or doing multiple
-conversions (which is slow and unreliable in case the OS implements
-encodings slightly different than the terminal emulator).
-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 :)
-=item How does rxvt-unicode determine the encoding to use?
+=head3 How does rxvt-unicode determine the encoding to use?
+See next entry.
-=item Is there an option to switch encodings?
+=head3 Is there an option to switch encodings?
 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
 UTF-8 or any other encodings with respect to terminal I/O.
 rxvt-unicode.
 If you want to use a specific encoding you have to make sure you start
 rxvt-unicode with the correct C<LC_CTYPE> category.
-=item Can I switch locales at runtime?
+=head3 Can I switch locales at runtime?
 Yes, using an escape sequence. Try something like this, which sets
 rxvt-unicode's idea of C<LC_CTYPE>.
   printf '\e]701;%s\007' ja_JP.SJIS
 You can also use xterm's C<luit> program, which usually works fine, except
 for some locales where character width differs between program- and
 rxvt-unicode-locales.
-=item Can I switch the fonts at runtime?
+=head3 I have problems getting my input method working.
-Yes, using an escape sequence. Try something like this, which has the same
+Try a search engine, as this is slightly different for every input method server.
-effect as using the C<-fn> switch, and takes effect immediately:
-   printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
+Here is a checklist:
-This is useful if you e.g. work primarily with japanese (and prefer a
+=over 4
-japanese font), but you have to switch to chinese temporarily, where
-japanese fonts would only be in your way.
-You can think of this as a kind of manual ISO-2022 switching.
+=item - Make sure your locale I<and> the imLocale are supported on your OS.
-=item Why do italic characters look as if clipped?
+Try C<locale -a> or check the documentation for your OS.
-Many fonts have difficulties with italic characters and hinting. For
+=item - Make sure your locale or imLocale matches a locale supported by your XIM.
-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
-enable freetype autohinting, i.e. like this:
-   URxvt.italicFont:        xft:Bitstream Vera Sans Mono:italic:autohint=true
+For example, B<kinput2> does not support UTF-8 locales, you should use
-   URxvt.boldItalicFont:    xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
+C<ja_JP.EUC-JP> or equivalent.
+=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
+method servers are running with this command:
+   xprop -root XIM_SERVERS
+=item
+=back
-=item My input method wants <some encoding> but I want UTF-8, what can I do?
+=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
 You can specify separate locales for the input method and the rest of the
 terminal, using the resource C<imlocale>:
-   URxvt*imlocale: ja_JP.EUC-JP
+   URxvt.imlocale: ja_JP.EUC-JP
 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
-use your input method. Please note, however, that you will not be able to
+use your input method. Please note, however, that, depending on your Xlib
-input characters outside C<EUC-JP> in a normal way then, as your input
+version, you may not be able to input characters outside C<EUC-JP> in a
-method limits you.
+normal way then, as your input method limits you.
-=item Rxvt-unicode crashes when the X Input Method changes or exits.
+=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
 Unfortunately, this is unavoidable, as the XIM protocol is racy by
 design. Applications can avoid some crashes at the expense of memory
 leaks, and Input Methods can avoid some crashes by careful ordering at
 exit time. B<kinput2> (and derived input methods) generally succeeds,
 while B<SCIM> (or similar input methods) fails. In the end, however,
 crashes cannot be completely avoided even if both sides cooperate.
 So the only workaround is not to kill your Input Method Servers.
-=item Rxvt-unicode uses gobs of memory, how can I reduce that?
-Rxvt-unicode tries to obey the rule of not charging you for something you
+=head2 Operating Systems / Package Maintaining
-don't use. One thing you should try is to configure out all settings that
-you don't need, for example, Xft support is a resource hog by design,
-when used. Compiling it out ensures that no Xft font will be loaded
-accidentally when rxvt-unicode tries to find a font for your characters.
-Also, many people (me included) like large windows and even larger
+=head3 I am using Debian GNU/Linux and have a problem...
-scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
-6 bytes per screen cell. For a 160x?? window this amounts to almost a
-kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
-use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
-rxvt-unicode then uses 8 bytes per screen cell.
-=item Can I speed up Xft rendering somehow?
+The Debian GNU/Linux package of rxvt-unicode in sarge contains large
+patches that considerably change the behaviour of rxvt-unicode (but
+unfortunately this notice has been removed). Before reporting a bug to
+the original rxvt-unicode author please download and install the genuine
+version (L<http://software.schmorp.de#rxvt-unicode>) 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<reportbug> to report the bug).
-Yes, the most obvious way to speed it up is to avoid Xft entirely, as
+For other problems that also affect the Debian package, you can and
-it is simply slow. If you still want Xft fonts you might try to disable
+probably should use the Debian BTS, too, because, after all, it's also a
-antialiasing (by appending C<:antialiasing=false>), which saves lots of
+bug in the Debian version and it serves as a reminder for other users that
-memory and also speeds up rendering considerably.
+might encounter the same issue.
-=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
+=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
-Rxvt-unicode will use whatever you specify as a font. If it needs to
+You should build one binary with the default options. F<configure>
-fall back to it's default font search list it will prefer X11 core
+now enables most useful options, and the trend goes to making them
-fonts, because they are small and fast, and then use Xft fonts. It has
+runtime-switchable, too, so there is usually no drawback to enbaling them,
-antialiasing disabled for most of them, because the author thinks they
+except higher disk and possibly memory usage. The perl interpreter should
-look best that way.
+be enabled, as important functionality (menus, selection, likely more in
+the future) depends on it.
-If you want antialiasing, you have to specify the fonts manually.
+You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
+system-wide (except maybe with C<defaults>). This will result in useful
+behaviour. If your distribution aims at low memory, add an empty
+C<perl-ext-common> resource to the app-defaults file. This will keep the
+perl interpreter disabled until the user enables it.
-=item Mouse cut/paste suddenly no longer works.
+If you can/want build more binaries, I recommend building a minimal
+one with C<--disable-everything> (very useful) and a maximal one with
+C<--enable-everything> (less useful, it will be very big due to a lot of
+encodings built-in that increase download times and are rarely used).
-Make sure that mouse reporting is actually turned off since killing
+=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
-some editors prematurely may leave the mouse in mouse report mode. I've
-heard that tcsh may use mouse reporting unless it otherwise specified. A
-quick check is to see if cut/paste works when the Alt or Shift keys are
-depressed. See @@RXVT_NAME@@(7)
-=item What's with this bold/blink stuff?
+It should be, starting with release 7.1. You are encouraged to properly
+install urxvt with privileges necessary for your OS now.
-If no bold colour is set via C<colorBD:>, bold will invert text using the
+When rxvt-unicode detects that it runs setuid or setgid, it will fork
-standard foreground colour.
+into a helper process for privileged operations (pty handling on some
+systems, utmp/wtmp/lastlog handling on others) and drop privileges
+immediately. This is much safer than most other terminals that keep
+privileges while running (but is more relevant to urxvt, as it contains
+things as perl interpreters, which might be "helpful" to attackers).
-For the standard background colour, blinking will actually make the
+This forking is done as the very first within main(), which is very early
-text blink when compiled with C<--enable-blinking>. with standard
+and reduces possible bugs to initialisation code run before main(), or
-colours. Without C<--enable-blinking>, the blink attribute will be
+things like the dynamic loader of your system, which should result in very
-ignored.
+little risk.
-On ANSI colours, bold/blink attributes are used to set high-intensity
+=head3 On Solaris 9, many line-drawing characters are too wide.
-foreground/background colors.
-color0-7 are the low-intensity colors.
+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:
-color8-15 are the corresponding high-intensity colors.
+   #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
-=item I don't like the screen colors.  How do I change them?
+=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
-You can change the screen colors at run-time using F<~/.Xdefaults>
+Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
-resources (or as long-options).
+in your compile environment, or an implementation that implements it,
+wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
+B<wchar_t> is represented as unicode.
-Here are values that are supposed to resemble a VGA screen,
+As you might have guessed, FreeBSD does neither define this symobl nor
-including the murky brown that passes for low-intensity yellow:
+does it support it. Instead, it uses it's own internal representation of
+B<wchar_t>. This is, of course, completely fine with respect to standards.
-   URxvt.color0:   #000000
+However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
-   URxvt.color1:   #A80000
+C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
-   URxvt.color2:   #00A800
-   URxvt.color3:   #A8A800
-   URxvt.color4:   #0000A8
-   URxvt.color5:   #A800A8
-   URxvt.color6:   #00A8A8
-   URxvt.color7:   #A8A8A8
-   URxvt.color8:   #000054
+C<__STDC_ISO_10646__> is the only sane way to support multi-language
-   URxvt.color9:   #FF0054
+apps in an OS, as using a locale-dependent (and non-standardized)
-   URxvt.color10:  #00FF54
+representation of B<wchar_t> makes it impossible to convert between
-   URxvt.color11:  #FFFF54
+B<wchar_t> (as used by X11 and your applications) and any other encoding
-   URxvt.color12:  #0000FF
+without implementing OS-specific-wrappers for each and every locale. There
-   URxvt.color13:  #FF00FF
+simply are no APIs to convert B<wchar_t> into anything except the current
-   URxvt.color14:  #00FFFF
+locale encoding.
-   URxvt.color15:  #FFFFFF
-And here is a more complete set of non-standard colors described (not by
+Some applications (such as the formidable B<mlterm>) work around this
-me) as "pretty girly".
+by carrying their own replacement functions for character set handling
+with them, and either implementing OS-dependent hacks or doing multiple
+conversions (which is slow and unreliable in case the OS implements
+encodings slightly different than the terminal emulator).
-   URxvt.cursorColor:  #dc74d1
+The rxvt-unicode author insists that the right way to fix this is in the
-   URxvt.pointerColor: #dc74d1
+system libraries once and for all, instead of forcing every app to carry
-   URxvt.background:   #0e0e0e
+complete replacements for them :)
-   URxvt.foreground:   #4ad5e1
-   URxvt.color0:       #000000
-   URxvt.color8:       #8b8f93
-   URxvt.color1:       #dc74d1
-   URxvt.color9:       #dc74d1
-   URxvt.color2:       #0eb8c7
-   URxvt.color10:      #0eb8c7
-   URxvt.color3:       #dfe37e
-   URxvt.color11:      #dfe37e
-   URxvt.color5:       #9e88f0
-   URxvt.color13:      #9e88f0
-   URxvt.color6:       #73f7ff
-   URxvt.color14:      #73f7ff
-   URxvt.color7:       #e1dddd
-   URxvt.color15:      #e1dddd
-=item How can I start @@RXVT_NAME@@d in a race-free way?
+=head3 I use Solaris 9 and it doesn't compile/work/etc.
-Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
+Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
-server that answers @@RXVT_NAME@@c's requests, so it doesn't background
+problems with C<wcwidth> and a compile problem.
-itself.
-To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
+=head3 How can I use rxvt-unicode under cygwin?
-following method to wait for the startup message before continuing:
-  { @@RXVT_NAME@@d & } | read
+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.
-=item What's with the strange Backspace/Delete key behaviour?
+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.
-Assuming that the physical Backspace key corresponds to the
-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
-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
-system value of `erase', which corresponds to CERASE in <termios.h>, will
-be used (which may not be the same as your stty setting).
-For starting a new rxvt-unicode:
-   # use Backspace = ^H
-   $ stty erase ^H
-   $ @@RXVT_NAME@@
-   # use Backspace = ^?
-   $ stty erase ^?
-   $ @@RXVT_NAME@@
-Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
-For an existing rxvt-unicode:
-   # use Backspace = ^H
-   $ stty erase ^H
-   $ echo -n "^[[36h"
-   # use Backspace = ^?
-   $ stty erase ^?
-   $ echo -n "^[[36l"
-This helps satisfy some of the Backspace discrepancies that occur, but
-if you use Backspace = C<^H>, make sure that the termcap/terminfo value
-properly reflects that.
-The Delete key is a another casualty of the ill-defined Backspace problem.
-To avoid confusion between the Backspace and Delete keys, the Delete
-key has been assigned an escape sequence to match the vt100 for Execute
-(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
-Some other Backspace problems:
-some editors use termcap/terminfo,
-some editors (vim I'm told) expect Backspace = ^H,
-GNU Emacs (and Emacs-like editors) use ^H for help.
-Perhaps someday this will all be resolved in a consistent manner.
-=item I don't like the key-bindings.  How do I change them?
-There are some compile-time selections available via configure. Unless
-you have run "configure" with the C<--disable-resources> option you can
-use the `keysym' resource to alter the keystrings associated with keysyms.
-Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
-   URxvt.keysym.Home:          \033[1~
-   URxvt.keysym.End:           \033[4~
-   URxvt.keysym.C-apostrophe:  \033<C-'>
-   URxvt.keysym.C-slash:       \033<C-/>
-   URxvt.keysym.C-semicolon:   \033<C-;>
-   URxvt.keysym.C-grave:       \033<C-`>
-   URxvt.keysym.C-comma:       \033<C-,>
-   URxvt.keysym.C-period:      \033<C-.>
-   URxvt.keysym.C-0x60:        \033<C-`>
-   URxvt.keysym.C-Tab:         \033<C-Tab>
-   URxvt.keysym.C-Return:      \033<C-Return>
-   URxvt.keysym.S-Return:      \033<S-Return>
-   URxvt.keysym.S-space:       \033<S-Space>
-   URxvt.keysym.M-Up:          \033<M-Up>
-   URxvt.keysym.M-Down:        \033<M-Down>
-   URxvt.keysym.M-Left:        \033<M-Left>
-   URxvt.keysym.M-Right:       \033<M-Right>
-   URxvt.keysym.M-C-0:         list \033<M-C- 0123456789 >
-   URxvt.keysym.M-C-a:         list \033<M-C- abcdefghijklmnopqrstuvwxyz >
-   URxvt.keysym.F12:           command:\033]701;zh_CN.GBK\007
-See some more examples in the documentation for the B<keysym> resource.
-=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
-How do I make use of them?  For example, the Sun Keyboard type 4
-has the following mappings that rxvt-unicode doesn't recognize.
-   KP_Insert == Insert
-   F22 == Print
-   F27 == Home
-   F29 == Prior
-   F33 == End
-   F35 == Next
-Rather than have rxvt-unicode try to accommodate all the various possible
-keyboard mappings, it is better to use `xmodmap' to remap the keys as
-required for your particular machine.
-=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
-I need this to decide about setting colors etc.
-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.
-=item How do I set the correct, full IP address for the DISPLAY variable?
-If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
-insecure mode then it is possible to use the following shell script
-snippets to correctly set the display. If your version of rxvt-unicode
-wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
-the COLORTERM variable can be used to distinguish rxvt-unicode from a
-regular xterm.
-Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
-snippets:
-   # Bourne/Korn/POSIX family of shells:
-   [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
-   if [ ${TERM:-foo} = xterm ]; then
-      stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
-      echo -n '^[Z'
-      read term_id
-      stty icanon echo
-      if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
-         echo -n '^[[7n'     	# query the rxvt we are in for the DISPLAY string
-         read DISPLAY     	# set it in our local shell
-      fi
-   fi
-=item How do I compile the manual pages for myself?
-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
-the doc subdirectory and enter C<make alldoc>.
-=item My question isn't answered here, can I ask a human?
-Before sending me mail, you could go to IRC: C<irc.freenode.net>,
-channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
-interested in learning about new and exciting problems (but not FAQs :).
-=back
-=head1 RXVT TECHNICAL REFERENCE
+=head1 RXVT-UNICODE TECHNICAL REFERENCE
-=head1 DESCRIPTION
 The rest of this document describes various technical aspects of
 B<rxvt-unicode>. First the description of supported command sequences,
-followed by menu and pixmap support and last by a description of all
+followed by pixmap support and last by a description of all features
-features selectable at C<configure> time.
+selectable at C<configure> time.
-=head1 Definitions
+=head2 Definitions
 =over 4
 =item B<< C<c> >>
 A text parameter composed of printable characters.
 =back
-=head1 Values
+=head2 Values
 =over 4
 =item B<< C<ENQ> >>
 Space Character
 =back
-=head1 Escape Sequences
+=head2 Escape Sequences
 =over 4
 =item B<< C<ESC # 8> >>
 =back
 X<CSI>
-=head1 CSI (Command Sequence Introducer) Sequences
+=head2 CSI (Command Sequence Introducer) Sequences
 =over 4
 =item B<< C<ESC [ Ps @> >>
 =back
 X<PrivateModes>
-=head1 DEC Private Modes
+=head2 DEC Private Modes
 =over 4
 =item B<< C<ESC [ ? Pm h> >>
 	B<< C<h> >>	Send Mouse X & Y on button press.
 	B<< C<l> >>	No mouse reporting.
 =end table
-=item B<< C<Ps = 10> >> (B<rxvt>)
-=begin table
-	B<< C<h> >>	menuBar visible
-	B<< C<l> >>	menuBar invisible
-=end table
 =item B<< C<Ps = 25> >>
 =begin table
 	B<< C<h> >>	Visible cursor {cnorm/cvvis}
 	B<< C<h> >>	Scroll to bottom when a key is pressed
 	B<< C<l> >>	Don't scroll to bottom when a key is pressed
 =end table
+=item B<< C<Ps = 1021> >> (B<rxvt>)
+=begin table
+	B<< C<h> >>	Bold/italic implies high intensity (see option B<-is>)
+	B<< C<l> >>	Font styles have no effect on intensity (Compile styles)
+=end table
 =item B<< C<Ps = 1047> >>
 =begin table
 	B<< C<h> >>	Use Alternate Screen Buffer
 =back
 X<XTerm>
-=head1 XTerm Operating System Commands
+=head2 XTerm Operating System Commands
 =over 4
 =item B<< C<ESC ] Ps;Pt ST> >>
 	B<< C<Ps = 10> >>	Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
 	B<< C<Ps = 11> >>	Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
 	B<< C<Ps = 12> >>	Change colour of text cursor foreground to B<< C<Pt> >>
 	B<< C<Ps = 13> >>	Change colour of mouse foreground to B<< C<Pt> >>
 	B<< C<Ps = 17> >>	Change colour of highlight characters to B<< C<Pt> >>
-	B<< C<Ps = 18> >>	Change colour of bold characters to B<< C<Pt> >>
+	B<< C<Ps = 18> >>	Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
-	B<< C<Ps = 19> >>	Change colour of underlined characters to B<< C<Pt> >>
+	B<< C<Ps = 19> >>	Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
-	B<< C<Ps = 20> >>	Change default background to B<< C<Pt> >>
+	B<< C<Ps = 20> >>	Change background pixmap parameters (see section XPM) (Compile XPM).
 	B<< C<Ps = 39> >>	Change default foreground colour to B<< C<Pt> >>.
 	B<< C<Ps = 46> >>	Change Log File to B<< C<Pt> >> I<unimplemented>
 	B<< C<Ps = 49> >>	Change default background colour to B<< C<Pt> >>.
 	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> >>
 	B<< C<Ps = 55> >>	Log all scrollback buffer and all of screen to B<< C<Pt> >>
 	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).
-	B<< C<Ps = 703> >>	Menubar command B<< C<Pt> >> (Compile menubar).
+	B<< C<Ps = 702> >>	Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
 	B<< C<Ps = 704> >>	Change colour of italic characters to B<< C<Pt> >>
 	B<< C<Ps = 705> >>	Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
+	B<< C<Ps = 706> >>	Change colour of bold characters to B<< C<Pt> >>
+	B<< C<Ps = 707> >>	Change colour of underlined characters to B<< C<Pt> >>
 	B<< C<Ps = 710> >>	Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
 	B<< C<Ps = 711> >>	Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 712> >>	Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 713> >>	Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
 	B<< C<Ps = 720> >>	Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
 	B<< C<Ps = 721> >>	Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
+	B<< C<Ps = 777> >>	Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
 =end table
 =back
-X<menuBar>
-=head1 menuBar
-B<< The exact syntax used is I<almost> solidified. >>
-In the menus, B<DON'T> try to use menuBar commands that add or remove a
-menuBar.
-Note that in all of the commands, the B<< I</path/> >> I<cannot> be
-omitted: use B<./> to specify a menu relative to the current menu.
-=head2 Overview of menuBar operation
-For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
-of C<Pt> can be used for a variety of tasks:
-At the top level is the current menuBar which is a member of a circular
-linked-list of other such menuBars.
-The menuBar acts as a parent for the various drop-down menus, which in
-turn, may have labels, separator lines, menuItems and subMenus.
-The menuItems are the useful bits: you can use them to mimic keyboard
-input or even to send text or escape sequences back to rxvt.
-The menuBar syntax is intended to provide a simple yet robust method of
-constructing and manipulating menus and navigating through the
-menuBars.
-The first step is to use the tag B<< [menu:I<name>] >> which creates
-the menuBar called I<name> and allows access. You may now or menus,
-subMenus, and menuItems. Finally, use the tag B<[done]> to set the
-menuBar access as B<readonly> to prevent accidental corruption of the
-menus. To re-access the current menuBar for alterations, use the tag
-B<[menu]>, make the alterations and then use B<[done]>
-X<menuBarCommands>
-=head2 Commands
-=over 4
-=item B<< [menu:+I<name>] >>
-access the named menuBar for creation or alteration. If a new menuBar
-is created, it is called I<name> (max of 15 chars) and the current
-menuBar is pushed onto the stack
-=item B<[menu]>
-access the current menuBar for alteration
-=item B<< [title:+I<string>] >>
-set the current menuBar's title to I<string>, which may contain the
-following format specifiers:
-   B<%n>  rxvt name (as per the B<-name> command-line option)
-   B<%v>  rxvt version
-   B<%%>  literal B<%> character
-=item B<[done]>
-set menuBar access as B<readonly>.
-End-of-file tag for B<< [read:+I<file>] >> operations.
-=item B<< [read:+I<file>] >>
-read menu commands directly from I<file> (extension ".menu" will be
-appended if required.) Start reading at a line with B<[menu]> or B<<
-[menu:+I<name> >> and continuing until B<[done]> is encountered.
-Blank and comment lines (starting with B<#>) are ignored. Actually,
-since any invalid menu commands are also ignored, almost anything could
-be construed as a comment line, but this may be tightened up in the
-future ... so don't count on it!.
-=item B<< [read:+I<file>;+I<name>] >>
-The same as B<< [read:+I<file>] >>, but start reading at a line with
-B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
-B<[done]> is encountered.
-=item B<[dump]>
-dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
-later rereading.
-=item B<[rm:name]>
-remove the named menuBar
-=item B<[rm] [rm:]>
-remove the current menuBar
-=item B<[rm*] [rm:*]>
-remove all menuBars
-=item B<[swap]>
-swap the top two menuBars
-=item B<[prev]>
-access the previous menuBar
-=item B<[next]>
-access the next menuBar
-=item B<[show]>
-Enable display of the menuBar
-=item B<[hide]>
-Disable display of the menuBar
-=item B<< [pixmap:+I<name>] >>
-=item B<< [pixmap:+I<name>;I<scaling>] >>
-(set the background pixmap globally
-B<< A Future implementation I<may> make this local to the menubar >>)
-=item B<< [:+I<command>:] >>
-ignore the menu readonly status and issue a I<command> to or a menu or
-menuitem or change the ; a useful shortcut for setting the quick arrows
-from a menuBar.
-=back
-X<menuBarAdd>
-=head2 Adding and accessing menus
-The following commands may also be B<+> prefixed.
-=over 4
-=item B</+>
-access menuBar top level
-=item B<./+>
-access current menu level
-=item B<../+>
-access parent menu (1 level up)
-=item B<../../>
-access parent menu (multiple levels up)
-=item B<< I</path/>menu >>
-add/access menu
-=item B<< I</path/>menu/* >>
-add/access menu and clear it if it exists
-=item B<< I</path/>{-} >>
-add separator
-=item B<< I</path/>{item} >>
-add B<item> as a label
-=item B<< I</path/>{item} action >>
-add/alter I<menuitem> with an associated I<action>
-=item B<< I</path/>{item}{right-text} >>
-add/alter I<menuitem> with B<right-text> as the right-justified text
-and as the associated I<action>
-=item B<< I</path/>{item}{rtext} action >>
-add/alter I<menuitem> with an associated I<action> and with B<rtext> as
-the right-justified text.
-=back
-=over 4
-=item Special characters in I<action> must be backslash-escaped:
-B<\a \b \E \e \n \r \t \octal>
-=item or in control-character notation:
-B<^@, ^A .. ^Z .. ^_, ^?>
-=back
-To send a string starting with a B<NUL> (B<^@>) character to the
-program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
-the first of which will be stripped off and the balance directed to the
-program. Otherwise if I<action> begins with B<NUL> followed by
-non-+B<NUL> characters, the leading B<NUL> is stripped off and the
-balance is sent back to rxvt.
-As a convenience for the many Emacs-type editors, I<action> may start
-with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
-appended if missed from B<M-x> commands.
-As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
-quick arrow), a B<BEL> (B<^G>) will be appended if needed.
-=over 4
-=item For example,
-B<M-xapropos> is equivalent to B<\Exapropos\r>
-=item and
-B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
-=back
-The option B<< {I<right-rtext>} >> will be right-justified. In the
-absence of a specified action, this text will be used as the I<action>
-as well.
-=over 4
-=item For example,
-B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
-=back
-The left label I<is> necessary, since it's used for matching, but
-implicitly hiding the left label (by using same name for both left and
-right labels), or explicitly hiding the left label (by preceeding it
-with a dot), makes it possible to have right-justified text only.
-=over 4
-=item For example,
-B</File/{Open}{Open} Open-File-Action>
-=item or hiding it
-B</File/{.anylabel}{Open} Open-File-Action>
-=back
-X<menuBarRemove>
-=head2 Removing menus
-=over 4
-=item B<< -/*+ >>
-remove all menus from the menuBar, the same as B<[clear]>
-=item B<< -+I</path>menu+ >>
-remove menu
-=item B<< -+I</path>{item}+ >>
-remove item
-=item B<< -+I</path>{-} >>
-remove separator)
-=item B<-/path/menu/*>
-remove all items, separators and submenus from menu
-=back
-X<menuBarArrows>
-=head2 Quick Arrows
-The menus also provide a hook for I<quick arrows> to provide easier
-user access. If nothing has been explicitly set, the default is to
-emulate the curror keys. The syntax permits each arrow to be altered
-individually or all four at once without re-entering their common
-beginning/end text. For example, to explicitly associate cursor actions
-with the arrows, any of the following forms could be used:
-=over 4
-=item B<< <r>+I<Right> >>
-=item B<< <l>+I<Left> >>
-=item B<< <u>+I<Up> >>
-=item B<< <d>+I<Down> >>
-Define actions for the respective arrow buttons
-=item B<< <b>+I<Begin> >>
-=item B<< <e>+I<End> >>
-Define common beginning/end parts for I<quick arrows> which used in
-conjunction with the above <r> <l> <u> <d> constructs
-=back
-=over 4
-=item For example, define arrows individually,
- <u>\E[A
- <d>\E[B
- <r>\E[C
- <l>\E[D
-=item or all at once
- <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
-=item or more compactly (factoring out common parts)
- <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
-=back
-X<menuBarSummary>
-=head2 Command Summary
-A short summary of the most I<common> commands:
-=over 4
-=item [menu:name]
-use an existing named menuBar or start a new one
-=item [menu]
-use the current menuBar
-=item [title:string]
-set menuBar title
-=item [done]
-set menu access to readonly and, if reading from a file, signal EOF
-=item [done:name]
-if reading from a file using [read:file;name] signal EOF
-=item [rm:name]
-remove named menuBar(s)
-=item [rm] [rm:]
-remove current menuBar
-=item [rm*] [rm:*]
-remove all menuBar(s)
-=item [swap]
-swap top two menuBars
-=item [prev]
-access the previous menuBar
-=item [next]
-access the next menuBar
-=item [show]
-map menuBar
-=item [hide]
-unmap menuBar
-=item [pixmap;file]
-=item [pixmap;file;scaling]
-set a background pixmap
-=item [read:file]
-=item [read:file;name]
-read in a menu from a file
-=item [dump]
-dump out all menuBars to /tmp/rxvt-PID
-=item /
-access menuBar top level
-=item ./
-=item ../
-=item ../../
-access current or parent menu level
-=item /path/menu
-add/access menu
-=item /path/{-}
-add separator
-=item /path/{item}{rtext} action
-add/alter menu item
-=item -/*
-remove all menus from the menuBar
-=item -/path/menu
-remove menu items, separators and submenus from menu
-=item -/path/menu
-remove menu
-=item -/path/{item}
-remove item
-=item -/path/{-}
-remove separator
-=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
-menu quick arrows
-=back
-X<XPM>
 =head1 XPM
 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
 of B<< C<Pt> >> can be the name of the background pixmap followed by a
 =begin table
 	4	Shift
 	8	Meta
 	16	Control
-	32	Double Click I<(Rxvt extension)>
+	32	Double Click I<(rxvt extension)>
 =end table
 Col = B<< C<< <x> - SPACE >> >>
 =end table
 =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
+hasn't been tested well. Either try with C<--enable-everything> or use
-./reconf script as a base for experiments. ./reconf is used by myself,
+the F<./reconf> script as a base for experiments. F<./reconf> is used by
-so it should generally be a working config. Of course, you should always
+myself, so it should generally be a working config. Of course, you should
-report when a combination doesn't work, so it can be fixed. Marc Lehmann
+always report when a combination doesn't work, so it can be fixed. Marc
-<rxvt@schmorp.de>.
+Lehmann <rxvt@schmorp.de>.
+All
 =over 4
 =item --enable-everything
-Add support for all non-multichoice options listed in "./configure
+Add (or remove) support for all non-multichoice options listed in "./configure
---help". Note that unlike other enable options this is order dependant.
+--help".
-You can specify this and then disable options which this enables by
+You can specify this and then disable options you do not like by
-I<following> this with the appropriate commands.
+I<following> 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
+=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<bold>, I<italic> and B<< I<bold italic> >> 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
+Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
-always compiled in, which includes most 8-bit character sets). These
+are always compiled in, which includes most 8-bit character sets). These
-codeset tables are currently only used for driving X11 core fonts, they
+codeset tables are used for driving X11 core fonts, they are not required
-are not required for Xft fonts. Compiling them in will make your binary
+for Xft fonts, although having them compiled in lets rxvt-unicode choose
-bigger (together about 700kB), but it doesn't increase memory usage unless
+replacement fonts more intelligently. Compiling them in will make your
+binary bigger (all of together cost about 700kB), but it doesn't increase
-you use an X11 font requiring one of these encodings.
+memory usage unless you use a font requiring one of these encodings.
 =begin table
 	all	all available codeset groups
 	zh	common chinese encodings
 	jp_ext	rarely used but big japanese encodings
 	kr	korean encodings
 =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)
+Recommended to stay off unless you really need non-BMP characters.
 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
 support these extra characters, but Xft does.
 even without this flag, but the number of such characters is
 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).
-=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
 where accents are encoded as seperate unicode characters. This is
 done by using precomposited characters when available or creating
 new pseudo-characters when no precomposed form exists.
-Without --enable-unicode3, the number of additional precomposed characters
+Without --enable-unicode3, the number of additional precomposed
-is rather limited (2048, if this is full, rxvt-unicode will use the
+characters is somewhat limited (the 6400 private use characters will be
-private use area, extending the number of combinations to 8448). With
---enable-unicode3, no practical limit exists.
+(ab-)used). With --enable-unicode3, no practical limit exists.
 This option will also enable storage (but not display) of characters
 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
 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...).
-=item --enable-fallback(=CLASS)
+=item --enable-fallback(=CLASS) (default: Rxvt)
-When reading resource settings, also read settings for class CLASS
+When reading resource settings, also read settings for class CLASS. To
-(default: Rxvt). To disable resource fallback use --disable-fallback.
+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
+Use the given class as default application class
-when reading resources.  Specify --with-res-class=Rxvt to replace
+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<w>) 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<last>) 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<lastlogin>) at start of rxvt execution.  This option requires
 --enable-utmp to also be specified.
-=item --enable-xpm-background
+=item --enable-xpm-background (default: on)
 Add support for XPM background pixmaps.
-=item --enable-transparency
+=item --enable-transparency (default: on)
 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
-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-ttygid (default: off)
-Make shadows on the scrollbar only half the normal width & height.
-only applicable to rxvt scrollbars.
-=item --enable-ttygid
 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
+Removes any handling of the backspace key by us - let the X server do it.
+=item --disable-delete-key
+Removes any handling of the delete 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
-do it.
 =item --disable-resources
-Remove all resources checking.
+Removes any support for resource checking.
-=item --enable-xgetdefault
-Make resources checking via XGetDefault() instead of our small
-version which only checks ~/.Xdefaults, or if that doesn't exist then
-~/.Xresources.
-Please note that nowadays, things like XIM will automatically pull in and
-use the full X resource manager, so the overhead of using it might be very
-small, if nonexistant.
-=item --enable-strings
-Add support for our possibly faster memset() function and other
-various routines, overriding your system's versions which may
-have been hand-crafted in assembly or may require extra libraries
-to link in. (this breaks ANSI-C rules and has problems on many
-GNU/Linux systems).
 =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
 disable this.
 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)
-  seperate underline colour
+  seperate underline colour (-underlineColor)
-  settable border widths and borderless switch
+  settable border widths and borderless switch (-w, -b, -bl)
+  visual depth selection (-depth)
-  settable extra linespacing
+  settable extra linespacing /-lsp)
   iso-14755-2 and -3, and visual feedback
+  tripleclickwords (-tcw)
+  settable insecure mode (-insecure)
+  keysym remapping support
+  cursor blinking and underline cursor (-cb, -uc)
+  XEmbed support (-embed)
+  user-pty (-pty-fd)
+  hold on exit (-hold)
+  skip builtin block graphics (-sbg)
+It also enabled some non-essential features otherwise disabled, such as:
+  some round-trip time optimisations
+  nearest color allocation on pseudocolor screens
+  UTF8_STRING supporr for selection
+  sgr modes 90..97 and 100..107
-  backindex and forwardindex escape sequence
+  backindex and forwardindex escape sequences
+  view change/zero scorllback esacpe sequences
+  locale switching escape sequence
   window op and some xterm/OSC escape sequences
-  tripleclickwords
+  rectangular selections
-  settable insecure mode
+  trailing space removal for selections
-  keysym remapping support
+  verbose X error handling
-  -embed and -pty-fd options
-=item --enable-iso14755
+=item --enable-iso14755 (default: on)
 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
 F<doc/rxvt.1.txt>). 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
 requires --enable-mousewheel to also be specified.
 =item --disable-new-selection
 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
+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
+=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
+=item --enable-smart-resize (default: on)
-Add smart growth/shrink behaviour when changing font size via from hot
+Add smart growth/shrink behaviour when changing font size via hot
-keys. This should keep in a fixed position the rxvt corner which is
+keys. This should keep the window corner which is closest to a corner of
-closest to a corner of the screen.
+the screen in a fixed position.
-=item --enable-cursor-blink
-Add support for a blinking cursor.
-=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 --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
+in F<src/perl-ext/> for the extensions that are installed by default. The
+perl interpreter that is used can be specified via the C<PERL> environment
+variable when running configure.
+=item --with-name=NAME (default: urxvt)
-Set the basename for the installed binaries (default: C<urxvt>, resulting
+Set the basename for the installed binaries, resulting
 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
 C<rxvt>.
-=item --with-term=NAME
+=item --with-term=NAME (default: rxvt-unicode)
-Change the environmental variable for the terminal to NAME (default
+Change the environmental variable for the terminal to NAME.
-C<rxvt-unicode>)
 =item --with-terminfo=PATH
 Change the environmental variable for the path to the terminfo tree to
 PATH.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs. Revision 1.115 by root, Tue Feb 21 01:01:33 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.51 by root, Mon Feb 21 19:26:06 2005 UTC vs.
Revision 1.115 by root, Tue Feb 21 01:01:33 2006 UTC