aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-08-20 13:22:48 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-08-20 13:22:48 +0000
commite1705017f36f9b6ace72ca94ca546e984e919b18 (patch)
tree4c61c2efc3ba7879b3f98840d3df2236a615a6bd /mdoc.7
parentc3829fc88899838b68249bab2a47f14c64d611f4 (diff)
downloadmandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.tar.gz
mandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.tar.zst
mandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.zip
Updated manual structure in mdoc.7.
Synchronised mdoc.template and mdoc.7 manual structure. `Rv' and `Ex' now accept multiple arguments (-std made standalone, terms as children). `Rv' and `Ex' format correctly in -Tascii (plurals, commas, etc.).
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.746
1 files changed, 40 insertions, 6 deletions
diff --git a/mdoc.7 b/mdoc.7
index 4fb87614..ea263c2f 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.57 2009/08/20 12:08:40 kristaps Exp $
+.\" $Id: mdoc.7,v 1.58 2009/08/20 13:22:48 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -67,7 +67,8 @@ Text following a
whether in a macro or free-form text line, is ignored to the end of
line. A macro line with only a control character and comment escape,
.Sq \&.\e" ,
-is also ignored.
+is also ignored. Macro lines with only a control charater and optionally
+whitespace are stripped from input.
.
.
.Ss Reserved Characters
@@ -224,9 +225,42 @@ followed by
\&.Dd $\&Mdocdate$
\&.Dt mdoc 7
\&.Os
+\&.
\&.Sh NAME
-\&.Nm mdoc
-\&.Nd mdoc language reference
+\&.Nm foo
+\&.Nd a description goes here
+\&.\e\*q The next is for sections 2 & 3 only.
+\&.\e\*q .Sh LIBRARY
+\&.
+\&.Sh SYNOPSIS
+\&.Nm foo
+\&.Op Fl options
+\&.Ar
+\&.
+\&.Sh DESCRIPTION
+The
+\&.Nm
+utility processes files ...
+\&.\e\*q The next is for sections 1 & 8 only.
+\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q .Sh RETURN VALUES
+\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q .Sh ENVIRONMENT
+\&.\e\*q .Sh FILES
+\&.\e\*q .Sh EXAMPLES
+\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
+\&.\e\*q .Sh DIAGNOSTICS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q .Sh ERRORS
+\&.\e\*q .Sh SEE ALSO
+\&.\e\*q .Xr foobar 1
+\&.\e\*q .Sh STANDARDS
+\&.\e\*q .Sh HISTORY
+\&.\e\*q .Sh AUTHORS
+\&.\e\*q .Sh CAVEATS
+\&.\e\*q .Sh BUGS
+\&.\e\*q .Sh SECURITY CONSIDERATIONS
.Ed
.
.Pp
@@ -453,7 +487,7 @@ then the macro accepts an arbitrary number of arguments.
.It \&Er Ta Yes Ta Yes Ta >0
.It \&Es Ta \&No Ta \&No Ta 0
.It \&Ev Ta Yes Ta Yes Ta n
-.It \&Ex Ta \&No Ta \&No Ta 0
+.It \&Ex Ta \&No Ta \&No Ta n
.It \&Fa Ta Yes Ta Yes Ta n
.It \&Fd Ta \&No Ta \&No Ta >0
.It \&Fl Ta Yes Ta Yes Ta n
@@ -480,7 +514,7 @@ then the macro accepts an arbitrary number of arguments.
.It \&Pa Ta Yes Ta Yes Ta n
.It \&Pf Ta \&No Ta Yes Ta 1
.It \&Pp Ta \&No Ta \&No Ta 0
-.It \&Rv Ta \&No Ta \&No Ta 0
+.It \&Rv Ta \&No Ta \&No Ta n
.It \&Sm Ta \&No Ta \&No Ta 1
.It \&St Ta \&No Ta Yes Ta 1
.It \&Sx Ta Yes Ta Yes Ta >0