diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-06-25 10:51:21 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-06-25 10:51:21 +0000 |
commit | fc9bc78e28ac02a4916711b1222932df9694727b (patch) | |
tree | 2861ea73b483f5632bfecfa85fa4bc1984524b14 /mdoc.7 | |
parent | f1d8bfff832e20c78f73a7f15cf44a4816eb3118 (diff) | |
download | mandoc-fc9bc78e28ac02a4916711b1222932df9694727b.tar.gz |
Fixed STRUCTURE repeat (schwarze@openbsd.org).
Simplified some explanations (nobody cares about ontologies these days).
Diffstat (limited to 'mdoc.7')
-rw-r--r-- | mdoc.7 | 48 |
1 files changed, 24 insertions, 24 deletions
@@ -28,8 +28,8 @@ The language is used to format .Bx .Ux -manuals. In this reference document, we describe the syntax, ontology -and structure of the +manuals. In this reference document, we describe the syntax and +structure of the .Nm language. Our reference implementation is .Xr mandoc 1 . @@ -139,11 +139,27 @@ Characters may alternatively be escaped by a slash-asterisk, with the same combinations as described above. This form is deprecated. .\" SECTION .Sh STRUCTURE -Macros are classified in an ontology described by their scope rules. -Some macros are allowed to deviate from their classifications to -preserve backward-compatibility with old macro combinations still found -in the manual corpus. These are specifically noted on a per-macro -basis. +Each +.Nm +document must begin with the document prologue, containing, in order, +.Sq \&.Dd , +.Sq \&.Dt , +and +.Sq \&.Os . +Following these, the document body must begin with the NAME section +containing at least one +.Sq \&.Nm +followed by a +.Sq \&.Nd +macro. +.Pp +At least one free-form or macro line must follow this prologue. +.\" +.Ss Classification +Macros are classified by their scope rules. Some macros are allowed to +deviate from their classifications to preserve backward-compatibility +with old macro combinations still found in the manual corpus. These are +specifically noted on a per-macro basis. .\" SUB-SECTION .Ss Scope .Bl -inset @@ -279,26 +295,10 @@ In-lines have \(>=0 scoped arguments. \&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN .Ed .\" SECTION -.Sh STRUCTURE -Each -.Nm -document must begin with the document prologue, containing, in order, -.Sq \&.Dd , -.Sq \&.Dt , -and -.Sq \&.Os . -.Pp -Following these, the document body must begin with the NAME section -containing at least one -.Sq \&.Nm -followed by a -.Sq \&.Nd -macro. -.\" SECTION .Sh MACROS This section contains a complete list of all .Nm -macros, arranged ontologically. A +macros, arranged by classification. A .Qq callable macro is invoked subsequent to the initial macro-line macro. A .Qq parsable |