version 1.30, 2009/06/17 14:08:47 |
version 1.33, 2009/06/25 10:51:21 |
|
|
language is used to format |
language is used to format |
.Bx |
.Bx |
.Ux |
.Ux |
manuals. In this reference document, we describe the syntax, ontology |
manuals. In this reference document, we describe the syntax and |
and structure of the |
structure of the |
.Nm |
.Nm |
language. Our reference implementation is |
language. Our reference implementation is |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
Line 139 Characters may alternatively be escaped by a slash-ast |
|
Line 139 Characters may alternatively be escaped by a slash-ast |
|
with the same combinations as described above. This form is deprecated. |
with the same combinations as described above. This form is deprecated. |
.\" SECTION |
.\" SECTION |
.Sh STRUCTURE |
.Sh STRUCTURE |
Macros are classified in an ontology described by their scope rules. |
Each |
Some macros are allowed to deviate from their classifications to |
.Nm |
preserve backward-compatibility with old macro combinations still found |
document must begin with the document prologue, containing, in order, |
in the manual corpus. These are specifically noted on a per-macro |
.Sq \&.Dd , |
basis. |
.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 |
.\" SUB-SECTION |
.Ss Scope |
.Ss Scope |
.Bl -inset |
.Bl -inset |
Line 278 In-lines have \(>=0 scoped arguments. |
|
Line 294 In-lines have \(>=0 scoped arguments. |
|
|
|
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
.Ed |
.Ed |
.\" |
.\" SECTION |
.Sh MACROS |
.Sh MACROS |
This section contains a complete list of all |
This section contains a complete list of all |
.Nm |
.Nm |
macros, arranged ontologically. A |
macros, arranged by classification. A |
.Qq callable |
.Qq callable |
macro is invoked subsequent to the initial macro-line macro. A |
macro is invoked subsequent to the initial macro-line macro. A |
.Qq parsable |
.Qq parsable |
|
|
There's no way to refer to references in |
There's no way to refer to references in |
.Sq \&.Rs/.Re |
.Sq \&.Rs/.Re |
blocks. |
blocks. |
|
.\" LIST-ITEM |
|
.It |
|
The \-split and \-nosplit arguments to |
|
.Sq \&.An |
|
are inane. |
.El |
.El |