The sh(1) "test" builtin on Solaris 10 doesn't have -e,

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 8982520567d73f5760402071d6dc2c95c5767574..198a46a9636f4bc32d82a50a93be912cd62471bc 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\"    $Id: mdoc.7,v 1.250 2015/01/29 00:33:57 schwarze Exp $
+.\"    $Id: mdoc.7,v 1.257 2015/11/05 12:06:45 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>


@@ -15,7 +15,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: January 29 2015 $
+.Dd $Mdocdate: November 5 2015 $

 .Dt MDOC 7
 .Os
 .Sh NAME
 .Dt MDOC 7
 .Os
 .Sh NAME


@@ -304,6 +304,11 @@ Print verbose information.
 \&.El
 .Ed
 .Pp
 \&.El
 .Ed
 .Pp

+List the options in alphabetical order,
+uppercase before lowercase for each letter and
+with no regard to whether an option takes an argument.
+Put digits in ascending order before all letter options.
+.Pp

 Manuals not documenting a command won't include the above fragment.
 .Pp
 Since the
 Manuals not documenting a command won't include the above fragment.
 .Pp
 Since the


@@ -1622,7 +1627,7 @@ See also
 A function name.
 Its syntax is as follows:
 .Bd -ragged -offset indent
 A function name.
 Its syntax is as follows:
 .Bd -ragged -offset indent

-.Pf \. Ns Sx \&Fn
+.Pf . Sx \&Fn

 .Op Ar functype
 .Ar funcname
 .Op Oo Ar argtype Oc Ar argname
 .Op Ar functype
 .Ar funcname
 .Op Oo Ar argtype Oc Ar argname


@@ -1758,17 +1763,18 @@ is preferred for displaying code; the
 .Sx \&Ic
 macro is used when referring to specific instructions.
 .Ss \&In
 .Sx \&Ic
 macro is used when referring to specific instructions.
 .Ss \&In

-An
-.Dq include
-file.
+The name of an include file.
+This macro is most often used in section 2, 3, and 9 manual pages.
+.Pp

 When invoked as the first macro on an input line in the
 .Em SYNOPSIS
 section, the argument is displayed in angle brackets
 and preceded by
 When invoked as the first macro on an input line in the
 .Em SYNOPSIS
 section, the argument is displayed in angle brackets
 and preceded by

-.Dq #include ,
+.Qq #include ,

 and a blank line is inserted in front if there is a preceding
 function declaration.
 and a blank line is inserted in front if there is a preceding
 function declaration.

-This is most often used in section 2, 3, and 9 manual pages.
+In other sections, it only encloses its argument in angle brackets
+and causes no line break.

 .Pp
 Examples:
 .Dl \&.In sys/types.h
 .Pp
 Examples:
 .Dl \&.In sys/types.h


@@ -1929,11 +1935,9 @@ Examples:
 .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd
 A one line description of the manual's content.
 .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd
 A one line description of the manual's content.

-This may only be invoked in the
-.Em SYNOPSIS
-section subsequent the
-.Sx \&Nm
-macro.
+This is the mandatory last macro of the
+.Em NAME
+section and not appropriate for other sections.

 .Pp
 Examples:
 .Dl Pf . Sx \&Nd mdoc language reference
 .Pp
 Examples:
 .Dl Pf . Sx \&Nd mdoc language reference


@@ -2094,7 +2098,7 @@ It is suggested to leave it unspecified, in which case
 .Xr mandoc 1
 uses its
 .Fl Ios
 .Xr mandoc 1
 uses its
 .Fl Ios

-argument, or, if that isn't specified either,
+argument or, if that isn't specified either,

 .Fa sysname
 and
 .Fa release
 .Fa sysname
 and
 .Fa release


@@ -2156,19 +2160,23 @@ See also
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf

-Removes the space between its argument
-.Pq Dq prefix
-and the following macro.
+Removes the space between its argument and the following macro.

 Its syntax is as follows:
 .Pp
 .D1 .Pf Ar prefix macro arguments ...
 .Pp
 This is equivalent to:
 .Pp
 Its syntax is as follows:
 .Pp
 .D1 .Pf Ar prefix macro arguments ...
 .Pp
 This is equivalent to:
 .Pp

-.D1 .No Ar prefix No \&Ns Ar macro arguments ...
+.D1 .No \e& Ns Ar prefix No \&Ns Ar macro arguments ...
+.Pp
+The
+.Ar prefix
+argument is not parsed for macro names or delimiters,
+but used verbatim as if it were escaped.

 .Pp
 Examples:
 .Dl ".Pf $ Ar variable_name"
 .Pp
 Examples:
 .Dl ".Pf $ Ar variable_name"

+.Dl ".Pf . Ar macro_name"

 .Dl ".Pf 0x Ar hex_digits"
 .Pp
 See also
 .Dl ".Pf 0x Ar hex_digits"
 .Pp
 See also


@@ -2268,7 +2276,7 @@ Examples:
 \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley
 \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley

-\&.%C Reading, Massachusettes
+\&.%C Reading, Massachusetts

 \&.%D 1979
 \&.Re
 .Ed
 \&.%D 1979
 \&.Re
 .Ed