Fix typos.
[dana/urxvt.git] / doc / rxvt.7.pod
index b640f5b..300bb0d 100644 (file)
@@ -19,7 +19,10 @@ This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
 all escape sequences, and other background information.
 
 The newest version of this document is also available on the World Wide Web at
-L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
+L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
+
+The main manual page for @@RXVT_NAME@@ itself is available at
+L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
 
 =head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
 
@@ -32,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
@@ -343,10 +358,9 @@ If you want antialiasing, you have to specify the fonts manually.
 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.
+For the standard background colour, blinking will actually make
+the text blink when compiled with C<--enable-text-blink>. Without
+C<--enable-text-blink>, the blink attribute will be ignored.
 
 On ANSI colours, bold/blink attributes are used to set high-intensity
 foreground/background colors.
@@ -484,7 +498,7 @@ 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
+Please also note that the I<LeftClick Shift-LeftClick> 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?
@@ -546,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
@@ -702,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
@@ -784,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:
 
@@ -798,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.
@@ -845,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.
 
@@ -870,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
@@ -892,28 +917,8 @@ like this:
 
    infocmp -C rxvt-unicode
 
-Or you could use this termcap entry, generated by the command above:
-
-   rxvt-unicode|rxvt-unicode terminal (X Window System):\
-           :am:bw:eo:km:mi:ms:xn:xo:\
-           :co#80:it#8:li#24:lm#0:\
-           :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
-           :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
-           :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
-           :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
-           :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
-           :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
-           :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
-           :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
-           :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
-           :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
-           :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
-           :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
-           :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
-           :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:
+Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
+generated by the command above.
 
 =head3 Why does C<ls> no longer have coloured output?
 
@@ -1130,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
@@ -1170,7 +1175,7 @@ does it support it. Instead, it uses its own internal representation of
 B<wchar_t>. This is, of course, completely fine with respect to standards.
 
 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
-C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
+C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
 
 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)
@@ -1216,6 +1221,12 @@ possibly working workaround is to use a wcwidth implementation like
 
 http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
 
+=head3 I want 256 colors
+
+Are you sure you need 256 colors? 88 colors should be enough for most
+purposes. If you really need more, there is an unsupported patch for
+it in the doc directory, but please do not ask for it to be applied.
+
 =head1 RXVT-UNICODE TECHNICAL REFERENCE
 
 The rest of this document describes various technical aspects of
@@ -1477,6 +1488,8 @@ Erase in Line (EL)
        B<< C<Ps = 0> >>        Clear to Right (default)
        B<< C<Ps = 1> >>        Clear to Left
        B<< C<Ps = 2> >>        Clear All
+       B<< C<Ps = 3> >>        Like Ps = 0, but is ignored when wrapped
+                               (@@RXVT_NAME@@ extension)
 
 =end table
 
@@ -1812,8 +1825,8 @@ Toggle DEC Private Mode Values (rxvt extension). I<where>
 
 =begin table
 
-       B<< C<h> >>     scrollBar visisble
-       B<< C<l> >>     scrollBar invisisble
+       B<< C<h> >>     scrollBar visible
+       B<< C<l> >>     scrollBar invisible
 
 =end table
 
@@ -1978,6 +1991,15 @@ X<Priv66>
 
 =end table
 
+=item B<< C<Pm = 2004> >>
+
+=begin table
+
+       B<< C<h> >>     Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
+       B<< C<l> >>     Disable bracketed paste mode
+
+=end table
+
 =back
 
 =back
@@ -2001,25 +2023,26 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
        B<< C<Ps = 2> >>        Change Window Title to B<< C<Pt> >>
        B<< C<Ps = 3> >>        If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
        B<< C<Ps = 4> >>        B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
-       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 = 10> >>       Change colour of text foreground to B<< C<Pt> >>
+       B<< C<Ps = 11> >>       Change colour of text background to B<< C<Pt> >>
        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> >> [deprecated, see 706]
        B<< C<Ps = 19> >>       Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
        B<< C<Ps = 20> >>       Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
-       B<< C<Ps = 39> >>       Change default foreground colour to B<< C<Pt> >>.
+       B<< C<Ps = 39> >>       Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
        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 = 49> >>       Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
        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 = 55> >>       Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
        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 = 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 = 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).
@@ -2034,7 +2057,7 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
 
 =head1 BACKGROUND IMAGE
 
-For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
+For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
 of B<< C<Pt> >> can be the name of the background image file followed by a
 sequence of scaling/positioning commands separated by semi-colons. The
 scaling/positioning commands are as follows:
@@ -2097,6 +2120,7 @@ rescale the current pixmap to 200% and display the image geometry in
 the title
 
 =back
+
 X<Mouse>
 
 =head1 Mouse Reporting
@@ -2147,10 +2171,11 @@ Col = B<< C<< <x> - SPACE >> >>
 Row = B<< C<< <y> - SPACE >> >>
 
 =back
-X<KeyCodes>
 
 =head1 Key Codes
 
+X<KeyCodes>
+
 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
 
 For the keypad, use B<Shift> to temporarily override Application-Keypad
@@ -2236,8 +2261,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,
@@ -2302,7 +2327,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.
 
@@ -2327,7 +2352,7 @@ disable resource fallback use --disable-fallback.
 Use the given name as default application name when
 reading resources. Specify --with-res-name=rxvt to replace rxvt.
 
-=item --with-res-class=CLASS /default: URxvt)
+=item --with-res-class=CLASS (default: URxvt)
 
 Use the given class as default application class
 when reading resources. Specify --with-res-class=Rxvt to replace
@@ -2385,17 +2410,6 @@ Add support for a NeXT-like scrollbar.
 
 Add support for an Xterm-like scrollbar.
 
-=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-ttygid (default: off)
-
-Change tty device setting to group "tty" - only use this if
-your system uses this type of security.
-
 =item --disable-backspace-key
 
 Removes any handling of the backspace key by us - let the X server do it.
@@ -2425,7 +2439,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)
@@ -2433,10 +2447,11 @@ 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)
+  compile in built-in block graphics
   skip builtin block graphics (-sbg)
   separate highlightcolor support (-hc)
 
@@ -2456,10 +2471,9 @@ It also enables some non-essential features otherwise disabled, such as:
 
 =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.
+Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
+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 (default: on)
 
@@ -2487,6 +2501,10 @@ Add smart growth/shrink behaviour when resizing.
 This should keep the window corner which is closest to a corner of
 the screen in a fixed position.
 
+=item --enable-text-blink (default: on)
+
+Add support for blinking text.
+
 =item --enable-pointer-blank (default: on)
 
 Add support to have the pointer disappear when typing or inactive.
@@ -2494,14 +2512,19 @@ Add support to have the pointer disappear when typing or inactive.
 =item --enable-perl (default: on)
 
 Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
-manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
-files 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. Even when compiled
-in, perl will I<not> be initialised when all extensions have been disabled
+manpage for more info on this feature, or the files in F<src/perl/>
+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. Even when compiled in,
+perl will I<not> be initialised when all extensions have been disabled
 C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
 resource standpoint.
 
+=item --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.