Hook 256-color support in configure.
[dana/urxvt.git] / doc / rxvt.7.pod
index b850bcf..5140f0d 100644 (file)
@@ -35,6 +35,18 @@ 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 I use Gentoo, and I have a problem...
+
+There are three big problems with Gentoo Linux: first of all, most if not
+all Gentoo systems are completely broken (missing or mismatched header
+files, broken compiler etc. are just the tip of the iceberg); secondly,
+the Gentoo maintainer thinks it is a good idea to add broken patches to
+the code; and lastly, it should be called Gentoo GNU/Linux.
+
+For these reasons, it is impossible to support rxvt-unicode on
+Gentoo. Problems appearing on Gentoo systems will usually simply be
+ignored unless they can be reproduced on non-Gentoo systems.
+
 =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
@@ -548,6 +560,10 @@ 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>.
 
+If it still doesn't work, then maybe your input method doesn't support
+compose sequences - to fall back to the built-in one, make sure you don't
+specify an input method via C<-im> or C<XMODIFIERS>.
+
 =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
@@ -704,7 +720,7 @@ write.
 
 The selection stuff mainly makes the selection perl-error-message aware
 and tells it to convert perl error messages into vi-commands to load the
-relevant file and go tohe error line number.
+relevant file and go to the error line number.
 
    URxvt.scrollstyle:      plain
    URxvt.secondaryScroll:  true
@@ -786,7 +802,7 @@ 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,
+class name. That is because I use different configs for different purposes,
 for example, my IRC window is started with C<-name IRC>, and uses these
 defaults:
 
@@ -800,7 +816,7 @@ defaults:
    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
+C<Alt-Ctrl-1> and C<Alt-Ctrl-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.
@@ -847,13 +863,14 @@ The terminal description used by rxvt-unicode is not as widely available
 as that for xterm, or even rxvt (for which the same problem often arises).
 
 The correct solution for this problem is to install the terminfo, this can
-be done like this (with ncurses' infocmp and works as user and admin):
+be done by simply installing rxvt-unicode on the remote system as well
+(in case you have a nice package manager ready), or you can install the
+terminfo database manually like this (with ncurses infocmp. works as
+user and root):
 
    REMOTE=remotesystem.domain
    infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
 
-... or by installing rxvt-unicode normally on the remote system,
-
 One some systems you might need to set C<$TERMINFO> to the full path of
 F<$HOME/.terminfo> for this to work.
 
@@ -872,6 +889,12 @@ resource to set it:
 If you don't plan to use B<rxvt> (quite common...) you could also replace
 the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
 
+=head3 nano fails with "Error opening terminal: rxvt-unicode"
+
+This exceptionally confusing and useless error message is printed by nano
+when it can't find the terminfo database. Nothing is wrong with your
+terminal, read the previous answer for a solution.
+
 =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
@@ -1112,7 +1135,7 @@ except higher disk and possibly memory usage. The perl interpreter should
 be enabled, as important functionality (menus, selection, likely more in
 the future) depends on it.
 
-You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
+You should not overwrite the C<perl-ext-common> and 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
@@ -1306,7 +1329,7 @@ Restore Cursor
 
 Application Keypad (SMKX). See also next sequence.
 
-=item B<<< C<< ESC >> >>>
+=item B<<< C<< ESC > >> >>>
 
 Normal Keypad (RMKX)
 
@@ -2013,6 +2036,7 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
        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 = 708> >>      Change colour of the border 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).
@@ -2231,8 +2255,8 @@ All
 
 =item --enable-everything
 
-Add (or remove) support for all non-multichoice options listed in "./configure
---help".
+Add (or remove) support for all non-multichoice options listed in
+C<./configure --help>, except for C<--enable-assert>.
 
 You can specify this and then disable options you do not like by
 I<following> this with the appropriate C<--disable-...> arguments,
@@ -2240,6 +2264,10 @@ 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-256-color (default: off)
+
+Add support for 256 colors.
+
 =item --enable-xft (default: enabled)
 
 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
@@ -2297,7 +2325,7 @@ see next switch), and right now rxvt-unicode cannot display them
 
 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
+where accents are encoded as separate unicode characters. This is
 done by using precomposited characters when available or creating
 new pseudo-characters when no precomposed form exists.
 
@@ -2409,7 +2437,7 @@ in combination with other switches) is:
   MWM-hints
   EWMH-hints (pid, utf8 names) and protocols (ping)
   urgency hint
-  seperate underline colour (-underlineColor)
+  separate underline colour (-underlineColor)
   settable border widths and borderless switch (-w, -b, -bl)
   visual depth selection (-depth)
   settable extra linespacing /-lsp)
@@ -2417,7 +2445,7 @@ in combination with other switches) is:
   tripleclickwords (-tcw)
   settable insecure mode (-insecure)
   keysym remapping support
-  cursor blinking and underline cursor (-cb, -uc)
+  cursor blinking and underline cursor (-bc, -uc)
   XEmbed support (-embed)
   user-pty (-pty-fd)
   hold on exit (-hold)
@@ -2490,6 +2518,11 @@ perl will I<not> be initialised when all extensions have been disabled
 C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
 resource standpoint.
 
+=item --enable-assert (default: off)
+
+Enables the assertions in the code, normally disabled. This switch is only
+useful when developing rxvt-unicode.
+
 =item --with-afterimage-config=DIR
 
 Look for the libAfterImage config script in DIR.