summaryrefslogtreecommitdiffstats
path: root/man.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-06-22 13:09:17 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-06-22 13:09:17 +0000
commitf951b5d078f310702724f3214b50e17b27716023 (patch)
tree8b2a208c3aa81aa16a9575f4a7b1199e4b8e4537 /man.7
parent101796b4d79943845f21342db70d90db02e715a4 (diff)
downloadmandoc-f951b5d078f310702724f3214b50e17b27716023.tar.gz
libman documents require `TH' and at least one node.
libman requirements documented in man.7 STRUCTURE section. Added STRUCTURE section to mdoc.7, too.
Diffstat (limited to 'man.7')
-rw-r--r--man.717
1 files changed, 15 insertions, 2 deletions
diff --git a/man.7 b/man.7
index 01031d02..88401417 100644
--- a/man.7
+++ b/man.7
@@ -97,7 +97,7 @@ Characters may alternatively be escaped by a slash-asterisk,
.Sq \e* ,
with the same combinations as described above. This form is deprecated.
.\" SECTION
-.Sh STRUCTURE
+.Sh SYNTAX
Macros are one to three three characters in length and begin with a
control character ,
.Sq \&. ,
@@ -155,7 +155,20 @@ The
.Sq \&.TP
macro is similar, but does not need an empty argument line to trigger
the behaviour.
-.\" PARAGRAPH
+.\" SECTION
+.Sh STRUCTURE
+Each
+.Nm
+document must contain contains at least the
+.Sq \&.TH
+macro describing the document's section and title. It may occur
+anywhere in the document, although conventionally, it appears as the
+first macro.
+.Pp
+Beyond the
+.Sq \&.TH ,
+at least one macro or text node must appear in the document.
+.\" SECTION
.Sh MACROS
This section contains a complete list of all
.Nm