Bring schwarze@'s mandoc.h and main.c errors and warnings entirely in sync,

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index 2a78c14696c3d63b38b20dfa6949c8b378a4128a..2bfbd7dacfb3af3322e8fea14f656bf5c00301b7 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.83 2010/08/24 12:18:48 kristaps Exp $
+.\"    $Id: man.7,v 1.91 2010/12/06 15:31:19 kristaps Exp $

 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"


@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: August 24 2010 $
+.Dd $Mdocdate: December 6 2010 $

 .Dt MAN 7
 .Os
 .Sh NAME
 .Dt MAN 7
 .Os
 .Sh NAME


@@ -219,25 +219,27 @@ Documents are generally structured as follows:
 \&.TH FOO 1 2009-10-10
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here
 \&.TH FOO 1 2009-10-10
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here

-\&.\e\*q The next is for sections 2 & 3 only.

 \&.\e\*q .SH LIBRARY
 \&.\e\*q .SH LIBRARY

+\&.\e\*q For sections 2 & 3 only.
+\&.\e\*q Not used in OpenBSD.

 \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES
 \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES

-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.

 \&.\e\*q .SH RETURN VALUES
 \&.\e\*q .SH RETURN VALUES

-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .SH ENVIRONMENT
 \&.\e\*q .SH ENVIRONMENT

+\&.\e\*q For sections 1, 6, 7, & 8 only.

 \&.\e\*q .SH FILES
 \&.\e\*q .SH FILES

-\&.\e\*q The next is for sections 1 & 8 only.

 \&.\e\*q .SH EXIT STATUS
 \&.\e\*q .SH EXIT STATUS

+\&.\e\*q For sections 1, 6, & 8 only.

 \&.\e\*q .SH EXAMPLES
 \&.\e\*q .SH EXAMPLES

-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .SH DIAGNOSTICS
 \&.\e\*q .SH DIAGNOSTICS

-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.

 \&.\e\*q .SH ERRORS
 \&.\e\*q .SH ERRORS

+\&.\e\*q For sections 2, 3, & 9 only.

 \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS
 \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS


@@ -246,6 +248,7 @@ The \efBfoo\efR utility processes files...
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS

+\&.\e\*q Not used in OpenBSD.

 .Ed
 .Pp
 The sections in a
 .Ed
 .Pp
 The sections in a


@@ -411,7 +414,6 @@ The syntax is as follows:
 .It Sx \&I   Ta    n         Ta    next-line Ta    \&
 .It Sx \&IB  Ta    n         Ta    current   Ta    \&
 .It Sx \&IR  Ta    n         Ta    current   Ta    \&
 .It Sx \&I   Ta    n         Ta    next-line Ta    \&
 .It Sx \&IB  Ta    n         Ta    current   Ta    \&
 .It Sx \&IR  Ta    n         Ta    current   Ta    \&

-.\" .It Sx \&PD  Ta    n         Ta    current   Ta    compat

 .It Sx \&R   Ta    n         Ta    next-line Ta    \&
 .It Sx \&RB  Ta    n         Ta    current   Ta    \&
 .It Sx \&RI  Ta    n         Ta    current   Ta    \&
 .It Sx \&R   Ta    n         Ta    next-line Ta    \&
 .It Sx \&RB  Ta    n         Ta    current   Ta    \&
 .It Sx \&RI  Ta    n         Ta    current   Ta    \&


@@ -421,15 +423,13 @@ The syntax is as follows:
 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat

+.It Sx \&ft  Ta    1         Ta    current   Ta    compat

 .It Sx \&i   Ta    n         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It Sx \&na  Ta    0         Ta    current   Ta    compat
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&r   Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .It Sx \&i   Ta    n         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It Sx \&na  Ta    0         Ta    current   Ta    compat
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&r   Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat

-.\" .It Sx \&Sp  Ta    <1        Ta    current   Ta    compat
-.\" .It Sx \&Vb  Ta    <1        Ta    current   Ta    compat
-.\" .It Sx \&Ve  Ta    0         Ta    current   Ta    compat

 .El
 .Pp
 Macros marked as
 .El
 .Pp
 Macros marked as


@@ -818,12 +818,6 @@ See also
 .Sx \&P ,
 and
 .Sx \&PP .
 .Sx \&P ,
 and
 .Sx \&PP .

-.\" .
-.\" .
-.\" .Ss \&PD
-.\" Has no effect.  Included for compatibility.
-.\" .
-.\" .

 .Ss \&UC
 Sets the volume for the footer for compatibility with man pages from
 BSD releases.
 .Ss \&UC
 Sets the volume for the footer for compatibility with man pages from
 BSD releases.


@@ -837,6 +831,11 @@ See also
 .Ss \&fi
 End literal mode begun by
 .Sx \&nf .
 .Ss \&fi
 End literal mode begun by
 .Sx \&nf .

+.Ss \&ft
+Change the current font mode.
+See
+.Sx Text Decoration
+for a listing of available font modes.

 .Ss \&i
 Italicise arguments.
 Synonym for
 .Ss \&i
 Italicise arguments.
 Synonym for


@@ -894,21 +893,6 @@ Defaults to 1, if unspecified.
 .Pp
 See also
 .Sx \&br .
 .Pp
 See also
 .Sx \&br .

-.\" .Ss \&Sp
-.\" A synonym for
-.\" .Sx \&sp
-.\" .Cm 0.5v .
-.\" .
-.\" .Ss \&Vb
-.\" A synonym for
-.\" .Sx \&nf .
-.\" Accepts an argument (the height of the formatted space) which is
-.\" disregarded.
-.\" .
-.\" .Ss \&Ve
-.\" A synonym for
-.\" .Sx \&fi .
-.\" .

 .Sh COMPATIBILITY
 This section documents areas of questionable portability between
 implementations of the
 .Sh COMPATIBILITY
 This section documents areas of questionable portability between
 implementations of the


@@ -938,11 +922,16 @@ The
 .Pq text filling colour ,
 .Sq \ez
 .Pq zero-length character ,
 .Pq text filling colour ,
 .Sq \ez
 .Pq zero-length character ,

+.Sq \ew
+.Pq string length ,
+.Sq \ek
+.Pq horizontal position marker ,
+.Sq \eo
+.Pq text overstrike ,

 and
 .Sq \es
 .Pq text size
 and
 .Sq \es
 .Pq text size

-.Sx Text Decoration
-escapes are all discarded in mandoc.
+escape sequences are all discarded in mandoc.

 .It
 The
 .Sq \ef
 .It
 The
 .Sq \ef


@@ -954,8 +943,10 @@ macro does not accept negative values in mandoc.
 In GNU troff, this would result in strange behaviour.
 .El
 .Sh SEE ALSO
 In GNU troff, this would result in strange behaviour.
 .El
 .Sh SEE ALSO

+.Xr man 1 ,

 .Xr mandoc 1 ,
 .Xr mandoc 1 ,

-.Xr mandoc_char 7
+.Xr mandoc_char 7 ,
+.Xr mdoc 7

 .Sh HISTORY
 The
 .Nm
 .Sh HISTORY
 The
 .Nm