9.07
[dana/urxvt.git] / doc / rxvt.7.man.in
index ce51178..2ae84d5 100644 (file)
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -53,7 +45,7 @@
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
 .\" ========================================================================
 .\"
 .IX Title "@@RXVT_NAME@@ 7"
-.TH @@RXVT_NAME@@ 7 "2008-11-08" "@@RXVT_VERSION@@" "RXVT-UNICODE"
+.TH @@RXVT_NAME@@ 7 "2009-12-30" "@@RXVT_VERSION@@" "RXVT-UNICODE"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -163,7 +155,7 @@ The main manual page for @@RXVT_NAME@@ itself is available at
 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
 .SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
 .IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
-.Sh "Meta, Features & Commandline Issues"
+.SS "Meta, Features & Commandline Issues"
 .IX Subsection "Meta, Features & Commandline Issues"
 \fIMy question isn't answered here, can I ask a human?\fR
 .IX Subsection "My question isn't answered here, can I ask a human?"
@@ -382,7 +374,7 @@ And here is rxvt-unicode:
 .PP
 No large bloated libraries (of course, none were linked in statically),
 except maybe libX11 :)
-.Sh "Rendering, Font & Look and Feel Issues"
+.SS "Rendering, Font & Look and Feel Issues"
 .IX Subsection "Rendering, Font & Look and Feel Issues"
 \fII can't get transparency working, what am I doing wrong?\fR
 .IX Subsection "I can't get transparency working, what am I doing wrong?"
@@ -676,7 +668,7 @@ We are working on it, in the meantime, as a workaround, use something like:
 .Vb 1
 \&   @@URXVT_NAME@@ \-b 600 \-geometry 20x1 \-e sh \-c \*(Aqmplayer \-wid $WINDOWID file...\*(Aq
 .Ve
-.Sh "Keyboard, Mouse & User Interaction"
+.SS "Keyboard, Mouse & User Interaction"
 .IX Subsection "Keyboard, Mouse & User Interaction"
 \fIThe new selection selects pieces that are too big, how can I select single words?\fR
 .IX Subsection "The new selection selects pieces that are too big, how can I select single words?"
@@ -770,6 +762,10 @@ rxvt-unicode will continue without an input method.
 In this case either do not specify a \fBpreeditStyle\fR or specify more than
 one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
 .PP
+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 \f(CW\*(C`\-im\*(C'\fR or \f(CW\*(C`XMODIFIERS\*(C'\fR.
+.PP
 \fII cannot type \f(CI\*(C`Ctrl\-Shift\-2\*(C'\fI to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755\fR
 .IX Subsection "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
 .PP
@@ -898,7 +894,7 @@ See some more examples in the documentation for the \fBkeysym\fR resource.
 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.
-.Sh "Terminal Configuration"
+.SS "Terminal Configuration"
 .IX Subsection "Terminal Configuration"
 \fICan I see a typical configuration?\fR
 .IX Subsection "Can I see a typical configuration?"
@@ -1062,7 +1058,7 @@ defaults:
 \&   IRC*keysym.M\-C\-2:       command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
 .Ve
 .PP
-\&\f(CW\*(C`Alt\-Shift\-1\*(C'\fR and \f(CW\*(C`Alt\-Shift\-2\*(C'\fR switch between two different font
+\&\f(CW\*(C`Alt\-Ctrl\-1\*(C'\fR and \f(CW\*(C`Alt\-Ctrl\-2\*(C'\fR switch between two different font
 sizes. \f(CW\*(C`suxuseuro\*(C'\fR 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.
@@ -1115,15 +1111,16 @@ 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).
 .PP
 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):
 .PP
 .Vb 2
 \&   REMOTE=remotesystem.domain
 \&   infocmp rxvt\-unicode | ssh $REMOTE "mkdir \-p .terminfo && cat >/tmp/ti && tic /tmp/ti"
 .Ve
 .PP
-\&... or by installing rxvt-unicode normally on the remote system,
-.PP
 One some systems you might need to set \f(CW$TERMINFO\fR to the full path of
 \&\fI\f(CI$HOME\fI/.terminfo\fR for this to work.
 .PP
@@ -1144,6 +1141,13 @@ resource to set it:
 If you don't plan to use \fBrxvt\fR (quite common...) you could also replace
 the rxvt terminfo file with the rxvt-unicode one and use \f(CW\*(C`TERM=rxvt\*(C'\fR.
 .PP
+\fInano fails with \*(L"Error opening terminal: rxvt-unicode\*(R"\fR
+.IX Subsection "nano fails with Error opening terminal: rxvt-unicode"
+.PP
+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.
+.PP
 \fI\f(CI\*(C`tic\*(C'\fI outputs some error when compiling the terminfo entry.\fR
 .IX Subsection "tic outputs some error when compiling the terminfo entry."
 .PP
@@ -1215,7 +1219,7 @@ GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR
 file, so you will need to install it on your own (See the question \fBWhen
 I log-in to another system it tells me about missing terminfo data?\fR on
 how to do this).
-.Sh "Encoding / Locale / Input Method Issues"
+.SS "Encoding / Locale / Input Method Issues"
 .IX Subsection "Encoding / Locale / Input Method Issues"
 \fIRxvt-unicode does not seem to understand the selected encoding?\fR
 .IX Subsection "Rxvt-unicode does not seem to understand the selected encoding?"
@@ -1342,7 +1346,7 @@ For example, \fBkinput2\fR does not support \s-1UTF\-8\s0 locales, you should us
 .IP "\- Make sure your \s-1XIM\s0 server is actually running." 4
 .IX Item "- Make sure your XIM server is actually running."
 .PD 0
-.ie n .IP "\- Make sure the ""XMODIFIERS""\fR environment variable is set correctly when \fIstarting rxvt-unicode." 4
+.ie n .IP "\- Make sure the ""XMODIFIERS"" environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4
 .el .IP "\- Make sure the \f(CWXMODIFIERS\fR environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4
 .IX Item "- Make sure the XMODIFIERS environment variable is set correctly when starting rxvt-unicode."
 .PD
@@ -1381,7 +1385,7 @@ while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
 crashes cannot be completely avoided even if both sides cooperate.
 .PP
 So the only workaround is not to kill your Input Method Servers.
-.Sh "Operating Systems / Package Maintaining"
+.SS "Operating Systems / Package Maintaining"
 .IX Subsection "Operating Systems / Package Maintaining"
 \fII am using Debian GNU/Linux and have a problem...\fR
 .IX Subsection "I am using Debian GNU/Linux and have a problem..."
@@ -1499,13 +1503,20 @@ The solution is to upgrade your system or switch to a better one. A
 possibly working workaround is to use a wcwidth implementation like
 .PP
 http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
+.PP
+\fII want 256 colors\fR
+.IX Subsection "I want 256 colors"
+.PP
+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.
 .SH "RXVT-UNICODE TECHNICAL REFERENCE"
 .IX Header "RXVT-UNICODE TECHNICAL REFERENCE"
 The rest of this document describes various technical aspects of
 \&\fBrxvt-unicode\fR. First the description of supported command sequences,
 followed by pixmap support and last by a description of all features
 selectable at \f(CW\*(C`configure\*(C'\fR time.
-.Sh "Definitions"
+.SS "Definitions"
 .IX Subsection "Definitions"
 .ie n .IP "\fB\fB""c""\fB\fR" 4
 .el .IP "\fB\f(CBc\fB\fR" 4
@@ -1529,7 +1540,7 @@ parameters, separated by \f(CW\*(C`;\*(C'\fR character(s).
 .el .IP "\fB\f(CBPt\fB\fR" 4
 .IX Item "Pt"
 A text parameter composed of printable characters.
-.Sh "Values"
+.SS "Values"
 .IX Subsection "Values"
 .ie n .IP "\fB\fB""ENQ""\fB\fR" 4
 .el .IP "\fB\f(CBENQ\fB\fR" 4
@@ -1578,7 +1589,7 @@ Switch to Standard Character Set
 .el .IP "\fB\f(CBSPC\fB\fR" 4
 .IX Item "SPC"
 Space Character
-.Sh "Escape Sequences"
+.SS "Escape Sequences"
 .IX Subsection "Escape Sequences"
 .ie n .IP "\fB\fB""ESC # 8""\fB\fR" 4
 .el .IP "\fB\f(CBESC # 8\fB\fR" 4
@@ -1681,7 +1692,7 @@ C = K     German character set unimplemented
 .PP
 
 .IX Xref "CSI"
-.Sh "\s-1CSI\s0 (Command Sequence Introducer) Sequences"
+.SS "\s-1CSI\s0 (Command Sequence Introducer) Sequences"
 .IX Subsection "CSI (Command Sequence Introducer) Sequences"
 .ie n .IP "\fB\fB""ESC [ Ps @""\fB\fR" 4
 .el .IP "\fB\f(CBESC [ Ps @\fB\fR" 4
@@ -1947,7 +1958,7 @@ Request Terminal Parameters (\s-1DECREQTPARM\s0)
 .PP
 
 .IX Xref "PrivateModes"
-.Sh "\s-1DEC\s0 Private Modes"
+.SS "\s-1DEC\s0 Private Modes"
 .IX Subsection "DEC Private Modes"
 .ie n .IP "\fB\fB""ESC [ ? Pm h""\fB\fR" 4
 .el .IP "\fB\f(CBESC [ ? Pm h\fB\fR" 4
@@ -2223,7 +2234,7 @@ l Disable bracketed paste mode
 .PP
 
 .IX Xref "XTerm"
-.Sh "XTerm Operating System Commands"
+.SS "XTerm Operating System Commands"
 .IX Subsection "XTerm Operating System Commands"
 .ie n .IP "\fB\fB""ESC ] Ps;Pt ST""\fB\fR" 4
 .el .IP "\fB\f(CBESC ] Ps;Pt ST\fB\fR" 4
@@ -2436,8 +2447,8 @@ work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
 All
 .IP "\-\-enable\-everything" 4
 .IX Item "--enable-everything"
-Add (or remove) support for all non-multichoice options listed in \*(L"./configure
-\&\-\-help\*(R".
+Add (or remove) support for all non-multichoice options listed in
+\&\f(CW\*(C`./configure \-\-help\*(C'\fR, except for \f(CW\*(C`\-\-enable\-assert\*(C'\fR.
 .Sp
 You can specify this and then disable options you do not like by
 \&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments,
@@ -2598,7 +2609,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)
@@ -2664,6 +2675,10 @@ environment variable when running configure. Even when compiled in,
 perl will \fInot\fR be initialised when all extensions have been disabled
 \&\f(CW\*(C`\-pe "" \-\-perl\-ext\-common ""\*(C'\fR, so it should be safe to enable from a
 resource standpoint.
+.IP "\-\-enable\-assert (default: off)" 4
+.IX Item "--enable-assert (default: off)"
+Enables the assertions in the code, normally disabled. This switch is only
+useful when developing rxvt-unicode.
 .IP "\-\-with\-afterimage\-config=DIR" 4
 .IX Item "--with-afterimage-config=DIR"
 Look for the libAfterImage config script in \s-1DIR\s0.