Render roff escape sequences contained in manual page descriptions

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index b7cf7f70e668a9c8dceb7efa97c9add27405d733..62e04826e8158e104d91e8a868e85fc2616ba5e8 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,7 +1,8 @@
-.\"    $Id: man.7,v 1.112 2011/12/02 01:37:14 schwarze Exp $
+.\"    $Id: man.7,v 1.126 2014/03/31 01:05:32 schwarze Exp $

 .\"
 .\"

-.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -15,7 +16,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: December 2 2011 $
+.Dd $Mdocdate: March 31 2014 $

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


@@ -97,30 +98,32 @@ file for a utility
 .Bd -literal -offset indent
 \&.TH PROGNAME 1 2009-10-10
 \&.SH NAME
 .Bd -literal -offset indent
 \&.TH PROGNAME 1 2009-10-10
 \&.SH NAME

-\efBprogname\efR \e(en a description goes here
+\efBprogname\efR \e(en one line about what it does

 \&.\e\(dq .SH LIBRARY
 \&.\e\(dq .SH LIBRARY

-\&.\e\(dq For sections 2 & 3 only.
+\&.\e\(dq For sections 2, 3, and 9 only.

 \&.\e\(dq Not used in OpenBSD.
 \&.SH SYNOPSIS
 \&.\e\(dq Not used in OpenBSD.
 \&.SH SYNOPSIS

-\efBprogname\efR [\efB\e-options\efR] arguments...
+\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR

 \&.SH DESCRIPTION
 \&.SH DESCRIPTION

-The \efBfoo\efR utility processes files...
+The \efBfoo\efR utility processes files ...
+\&.\e\(dq .Sh CONTEXT
+\&.\e\(dq For section 9 functions only.

 \&.\e\(dq .SH IMPLEMENTATION NOTES
 \&.\e\(dq Not used in OpenBSD.
 \&.\e\(dq .SH RETURN VALUES
 \&.\e\(dq .SH IMPLEMENTATION NOTES
 \&.\e\(dq Not used in OpenBSD.
 \&.\e\(dq .SH RETURN VALUES

-\&.\e\(dq For sections 2, 3, & 9 only.
+\&.\e\(dq For sections 2, 3, and 9 function return values only.

 \&.\e\(dq .SH ENVIRONMENT
 \&.\e\(dq .SH ENVIRONMENT

-\&.\e\(dq For sections 1, 6, 7, & 8 only.
+\&.\e\(dq For sections 1, 6, 7, and 8 only.

 \&.\e\(dq .SH FILES
 \&.\e\(dq .SH EXIT STATUS
 \&.\e\(dq .SH FILES
 \&.\e\(dq .SH EXIT STATUS

-\&.\e\(dq For sections 1, 6, & 8 only.
+\&.\e\(dq For sections 1, 6, and 8 only.

 \&.\e\(dq .SH EXAMPLES
 \&.\e\(dq .SH DIAGNOSTICS
 \&.\e\(dq .SH EXAMPLES
 \&.\e\(dq .SH DIAGNOSTICS

-\&.\e\(dq For sections 1, 4, 6, 7, & 8 only.
+\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.

 \&.\e\(dq .SH ERRORS
 \&.\e\(dq .SH ERRORS

-\&.\e\(dq For sections 2, 3, & 9 only.
+\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.

 \&.\e\(dq .SH SEE ALSO
 \&.\e\(dq .SH SEE ALSO

-\&.\e\(dq .BR foo ( 1 )
+\&.\e\(dq .BR foobar ( 1 )

 \&.\e\(dq .SH STANDARDS
 \&.\e\(dq .SH HISTORY
 \&.\e\(dq .SH AUTHORS
 \&.\e\(dq .SH STANDARDS
 \&.\e\(dq .SH HISTORY
 \&.\e\(dq .SH AUTHORS


@@ -170,6 +173,9 @@ This expands upon the brief, one-line description in
 .Em NAME .
 It usually contains a break-down of the options (if documenting a
 command).
 .Em NAME .
 It usually contains a break-down of the options (if documenting a
 command).

+.It Em CONTEXT
+This section lists the contexts in which functions can be called in section 9.
+The contexts are autoconf, process, or interrupt.

 .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side
 .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side


@@ -196,13 +202,19 @@ well-tested invocations.
 Make sure that examples work properly!
 .It Em DIAGNOSTICS
 Documents error conditions.
 Make sure that examples work properly!
 .It Em DIAGNOSTICS
 Documents error conditions.

-This is most useful in section 4 manuals.
+In section 4 and 9 manuals, these are usually messages
+printed by the kernel to the console and to the kernel log.
+In section 1, 6, 7, and 8, these are usually messages
+printed by userland programs to the standard error output.
+.Pp

 Historically, this section was used in place of
 .Em EXIT STATUS
 for manuals in sections 1, 6, and 8; however, this practise is
 discouraged.
 .It Em ERRORS
 Historically, this section was used in place of
 .Em EXIT STATUS
 for manuals in sections 1, 6, and 8; however, this practise is
 discouraged.
 .It Em ERRORS

-Documents error handling in sections 2, 3, and 9.
+Documents
+.Xr errno 2
+settings in sections 2, 3, 4, and 9.

 .It Em SEE ALSO
 References other manuals with related topics.
 This section should exist for most manuals.
 .It Em SEE ALSO
 References other manuals with related topics.
 This section should exist for most manuals.


@@ -253,6 +265,7 @@ in the alphabetical reference below.
 .It Sx IP Ta indented paragraph: Op Ar head Op Ar width
 .It Sx TP Ta tagged paragraph: Op Ar width
 .It Sx HP Ta hanged paragraph: Op Ar width
 .It Sx IP Ta indented paragraph: Op Ar head Op Ar width
 .It Sx TP Ta tagged paragraph: Op Ar width
 .It Sx HP Ta hanged paragraph: Op Ar width

+.It Sx PD Ta set vertical paragraph distance: Op Ar height

 .It Sx \&br Ta force output line break in text mode (no arguments)
 .It Sx \&sp Ta force vertical space: Op Ar height
 .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
 .It Sx \&br Ta force output line break in text mode (no arguments)
 .It Sx \&sp Ta force vertical space: Op Ar height
 .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)


@@ -279,7 +292,7 @@ For the scoping of individual macros, see
 .Sx MACRO SYNTAX .
 .Ss \&AT
 Sets the volume for the footer for compatibility with man pages from
 .Sx MACRO SYNTAX .
 .Ss \&AT
 Sets the volume for the footer for compatibility with man pages from

-.Tn AT&T UNIX
+.At

 releases.
 The optional arguments specify which release it is from.
 .Ss \&B
 releases.
 The optional arguments specify which release it is from.
 .Ss \&B


@@ -339,6 +352,18 @@ and
 .Ss \&DT
 Has no effect.
 Included for compatibility.
 .Ss \&DT
 Has no effect.
 Included for compatibility.

+.Ss \&EE
+This is a non-standard GNU extension, included only for compatibility.
+In
+.Xr mandoc 1 ,
+it does the same as
+.Sx \&fi .
+.Ss \&EX
+This is a non-standard GNU extension, included only for compatibility.
+In
+.Xr mandoc 1 ,
+it does the same as
+.Sx \&nf .

 .Ss \&HP
 Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:
 .Ss \&HP
 Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:


@@ -349,8 +374,9 @@ subsequent output lines are indented, with the following syntax:
 .Pp
 The
 .Cm width
 .Pp
 The
 .Cm width

-argument must conform to
-.Sx Scaling Widths .
+argument is a
+.Xr roff 7
+scaling width.

 If specified, it's saved for later paragraph left-margins; if unspecified, the
 saved or default width is used.
 .Pp
 If specified, it's saved for later paragraph left-margins; if unspecified, the
 saved or default width is used.
 .Pp


@@ -392,8 +418,9 @@ Begin an indented paragraph with the following syntax:
 .Pp
 The
 .Cm width
 .Pp
 The
 .Cm width

-argument defines the width of the left margin and is defined by
-.Sx Scaling Widths .
+argument is a
+.Xr roff 7
+scaling width defining the left margin.

 It's saved for later paragraph left-margins; if unspecified, the saved or
 default width is used.
 .Pp
 It's saved for later paragraph left-margins; if unspecified, the saved or
 default width is used.
 .Pp


@@ -437,6 +464,20 @@ See also
 .Sx \&PP ,
 and
 .Sx \&TP .
 .Sx \&PP ,
 and
 .Sx \&TP .

+.Ss \&OP
+Optional command-line argument.
+This is a non-standard GNU extension, included only for compatibility.
+It has the following syntax:
+.Bd -filled -offset indent
+.Pf \. Sx \&OP
+.Cm key Op Cm value
+.Ed
+.Pp
+The
+.Cm key
+is usually a command-line flag and
+.Cm value
+its argument.

 .Ss \&P
 Synonym for
 .Sx \&LP .
 .Ss \&P
 Synonym for
 .Sx \&LP .


@@ -448,6 +489,36 @@ See also
 .Sx \&PP ,
 and
 .Sx \&TP .
 .Sx \&PP ,
 and
 .Sx \&TP .

+.Ss \&PD
+Specify the vertical space to be inserted before each new paragraph.
+.br
+The syntax is as follows:
+.Bd -filled -offset indent
+.Pf \. Sx \&PD
+.Op Cm height
+.Ed
+.Pp
+The
+.Cm height
+argument is a
+.Xr roff 7
+scaling width.
+It defaults to
+.Cm 1v .
+If the unit is omitted,
+.Cm v
+is assumed.
+.Pp
+This macro affects the spacing before any subsequent instances of
+.Sx \&HP ,
+.Sx \&IP ,
+.Sx \&LP ,
+.Sx \&P ,
+.Sx \&PP ,
+.Sx \&SH ,
+.Sx \&SS ,
+and
+.Sx \&TP .

 .Ss \&PP
 Synonym for
 .Sx \&LP .
 .Ss \&PP
 Synonym for
 .Sx \&LP .


@@ -512,8 +583,9 @@ This has the following syntax:
 .Pp
 The
 .Cm width
 .Pp
 The
 .Cm width

-argument must conform to
-.Sx Scaling Widths .
+argument is a
+.Xr roff 7
+scaling width.

 If not specified, the saved or default width is used.
 .Pp
 See also
 If not specified, the saved or default width is used.
 .Pp
 See also


@@ -578,8 +650,9 @@ The syntax is as follows:
 .Pp
 The
 .Cm width
 .Pp
 The
 .Cm width

-argument must conform to
-.Sx Scaling Widths .
+argument is a
+.Xr roff 7
+scaling width.

 If specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
 .Pp
 If specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
 .Pp


@@ -592,8 +665,23 @@ and
 .Sx \&PP .
 .Ss \&UC
 Sets the volume for the footer for compatibility with man pages from
 .Sx \&PP .
 .Ss \&UC
 Sets the volume for the footer for compatibility with man pages from

-BSD releases.
+.Bx
+releases.

 The optional first argument specifies which release it is from.
 The optional first argument specifies which release it is from.

+.Ss \&UE
+End a uniform resource identifier block.
+This is a non-standard GNU extension, included only for compatibility.
+See
+.Sx \&UE .
+.Ss \&UR
+Begin a uniform resource identifier block.
+This is a non-standard GNU extension, included only for compatibility.
+It has the following syntax:
+.Bd -literal -offset indent
+.Pf \. Sx \&UR Ar uri
+link description to be shown
+.Pf \. Sx UE
+.Ed

 .Ss \&br
 Breaks the current line.
 Consecutive invocations have no further effect.
 .Ss \&br
 Breaks the current line.
 Consecutive invocations have no further effect.


@@ -603,11 +691,6 @@ 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 \&in
 Indent relative to the current indentation:
 .Pp
 .Ss \&in
 Indent relative to the current indentation:
 .Pp


@@ -636,10 +719,10 @@ Insert vertical spaces into output with the following syntax:
 .Op Cm height
 .Ed
 .Pp
 .Op Cm height
 .Ed
 .Pp

-Insert
+The

 .Cm height
 .Cm height

-spaces, which must conform to
-.Sx Scaling Widths .
+argument is a scaling width as described in
+.Xr roff 7 .

 If 0, this is equivalent to the
 .Sx \&br
 macro.
 If 0, this is equivalent to the
 .Sx \&br
 macro.


@@ -688,9 +771,13 @@ The syntax is as follows:
 .It Sx \&BI  Ta    n         Ta    current   Ta    \&
 .It Sx \&BR  Ta    n         Ta    current   Ta    \&
 .It Sx \&DT  Ta    0         Ta    current   Ta    \&
 .It Sx \&BI  Ta    n         Ta    current   Ta    \&
 .It Sx \&BR  Ta    n         Ta    current   Ta    \&
 .It Sx \&DT  Ta    0         Ta    current   Ta    \&

+.It Sx \&EE  Ta    0         Ta    current   Ta    compat
+.It Sx \&EX  Ta    0         Ta    current   Ta    compat

 .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 \&OP  Ta    0, 1      Ta    current   Ta    compat
+.It Sx \&PD  Ta    1         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    \&
 .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    \&


@@ -700,7 +787,6 @@ 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 \&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


@@ -760,6 +846,8 @@ implicitly closed, is syntactically incorrect.
 .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
 .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
 .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&
 .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
 .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
 .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&

+.It Sx \&UE  Ta    0         Ta    current    Ta    none        Ta    compat
+.It Sx \&UR  Ta    1         Ta    current    Ta    part        Ta    compat

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


@@ -854,6 +942,12 @@ number when no
 is given, like in
 .Xr mdoc 7 .
 .El
 is given, like in
 .Xr mdoc 7 .
 .El

+.Pp
+The
+.Sx OP
+macro is part of the extended
+.Nm
+macro set, and may not be portable to non-GNU troff implementations.

 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,


@@ -869,6 +963,9 @@ language first appeared as a macro package for the roff typesetting
 system in
 .At v7 .
 It was later rewritten by James Clark as a macro package for groff.
 system in
 .At v7 .
 It was later rewritten by James Clark as a macro package for groff.

+Eric S. Raymond wrote the extended
+.Nm
+macros for groff in 2007.

 The stand-alone implementation that is part of the
 .Xr mandoc 1
 utility written by Kristaps Dzonsons appeared in
 The stand-alone implementation that is part of the
 .Xr mandoc 1
 utility written by Kristaps Dzonsons appeared in


@@ -877,8 +974,7 @@ utility written by Kristaps Dzonsons appeared in
 This
 .Nm
 reference was written by
 This
 .Nm
 reference was written by

-.An Kristaps Dzonsons ,
-.Mt kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

 .Sh CAVEATS
 Do not use this language.
 Use
 .Sh CAVEATS
 Do not use this language.
 Use