Plan9 has a man(7) implementation that looks extremely archaic,

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index a08e32b2f4715c208a6922762f35d71712529e76..4619cec601de7790e2b52fe8729a61a299353e26 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.84 2010/08/24 13:07:01 kristaps Exp $
+.\"    $Id: man.7,v 1.93 2010/12/29 16:18:13 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 29 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,11 @@ 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 \&i   Ta    n         Ta    current   Ta    compat
+.It Sx \&ft  Ta    1         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 \&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 \&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


@@ -509,12 +507,9 @@ The optional arguments specify which release it is from.
 Text is rendered in bold face.
 .Pp
 See also
 Text is rendered in bold face.
 .Pp
 See also

-.Sx \&I ,
-.Sx \&R ,
-.Sx \&b ,
-.Sx \&i ,
+.Sx \&I

 and
 and

-.Sx \&r .
+.Sx \&R .

 .Ss \&BI
 Text is rendered alternately in bold face and italic.
 Thus,
 .Ss \&BI
 Text is rendered alternately in bold face and italic.
 Thus,


@@ -532,7 +527,7 @@ Whitespace between arguments is omitted in output.
 .Pp
 Examples:
 .Pp
 .Pp
 Examples:
 .Pp

-.D1 \&.BI bold italic bold italic
+.Dl \&.BI bold italic bold italic

 .Pp
 The output of this example will be emboldened
 .Dq bold
 .Pp
 The output of this example will be emboldened
 .Dq bold


@@ -591,12 +586,9 @@ and
 Text is rendered in italics.
 .Pp
 See also
 Text is rendered in italics.
 .Pp
 See also

-.Sx \&B ,
-.Sx \&R ,
-.Sx \&b ,
-.Sx \&i ,
+.Sx \&B

 and
 and

-.Sx \&r .
+.Sx \&R .

 .Ss \&IB
 Text is rendered alternately in italics and bold face.
 Whitespace between arguments is omitted in output.
 .Ss \&IB
 Text is rendered alternately in italics and bold face.
 Whitespace between arguments is omitted in output.


@@ -692,12 +684,9 @@ and
 Text is rendered in roman (the default font).
 .Pp
 See also
 Text is rendered in roman (the default font).
 .Pp
 See also

-.Sx \&I ,
-.Sx \&B ,
-.Sx \&b ,
-.Sx \&i ,
+.Sx \&I

 and
 and

-.Sx \&r .
+.Sx \&B .

 .Ss \&RB
 Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.
 .Ss \&RB
 Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.


@@ -792,7 +781,7 @@ manual section.
 .Pp
 Examples:
 .Pp
 .Pp
 Examples:
 .Pp

-.D1 \&.TH CVS 5 "1992-02-12" GNU
+.Dl \&.TH CVS 5 "1992-02-12" GNU

 .Ss \&TP
 Begin a paragraph where the head, if exceeding the indentation width, is
 followed by a newline; if not, the body follows on the same line after a
 .Ss \&TP
 Begin a paragraph where the head, if exceeding the indentation width, is
 followed by a newline; if not, the body follows on the same line after a


@@ -818,12 +807,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,18 +820,11 @@ See also
 .Ss \&fi
 End literal mode begun by
 .Sx \&nf .
 .Ss \&fi
 End literal mode begun by
 .Sx \&nf .

-.Ss \&i
-Italicise arguments.
-Synonym for
-.Sx \&I .
-.Pp
-See also
-.Sx \&B ,
-.Sx \&I ,
-.Sx \&R .
-.Sx \&b ,
-and
-.Sx \&r .
+.Ss \&ft
+Change the current font mode.
+See
+.Sx Text Decoration
+for a listing of available font modes.

 .Ss \&in
 Indent relative to the current indentation:
 .Pp
 .Ss \&in
 Indent relative to the current indentation:
 .Pp


@@ -866,16 +842,6 @@ Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.
 May be ended by
 .Sx \&fi .
 line boundaries preserved.
 May be ended by
 .Sx \&fi .

-.Ss \&r
-Fonts and styles (bold face, italics) reset to roman (default font).
-.Pp
-See also
-.Sx \&B ,
-.Sx \&I ,
-.Sx \&R ,
-.Sx \&b ,
-and
-.Sx \&i .

 .Ss \&sp
 Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent
 .Ss \&sp
 Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent


@@ -894,21 +860,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


@@ -940,6 +891,10 @@ The
 .Pq zero-length character ,
 .Sq \ew
 .Pq string length ,
 .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


@@ -955,8 +910,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