mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.28 and 1.34

version 1.28, 2009/06/12 12:40:44

version 1.34, 2009/06/25 11:35:28

Line 28 The

language is used to format

.Bx

.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

language. Our reference implementation is

.Xr mandoc 1 .

Line 78 or

.Sq \&.Bd \-unfilled

contexts.

.\" SUB-SECTION

.Ss Comments

Anything following a

.Sq \e"

delimiter is considered a comment (unless the

.Sq \e

itself has been escaped) and is ignored to the end of line.

Furthermore, a macro line with only a control character

.Sq \. ,

optionally followed by whitespace, is ignored.

.\" SUB-SECTION

.Ss Reserved Characters

Within a macro line, the following characters are reserved:

.Bl -tag -width 12n -offset XXXX -compact

.Bl -tag -width Ds -offset XXXX -compact

.It \&.

.Pq period

.It \&,

Line 127 or a single one-character sequence.

Line 137 or a single one-character sequence.

Characters may alternatively be escaped by a slash-asterisk,

.Sq \e* ,

with the same combinations as described above. This form is deprecated.

.\" SUB-SECTION

.Ss Whitespace

Unless in literal mode or specifically escaped, consecutive blocks of

whitespace are pruned from input. These are later re-added, if

applicable, by a front-end utility such as

.Xr mandoc 1 .

.\" SECTION

.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

.Ss Scope

.Bl -inset

Line 268 In-lines have \(>=0 scoped arguments.

Line 300 In-lines have \(>=0 scoped arguments.

\&.Yy \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN

.Ed

.\"

.\" 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

Line 291 some

Line 323 some

.Pc

don't have heads.

.Pp

.Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX

.Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "Closing"

.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing

.It \&.Sh Ta \&No Ta \&No Ta \&.Sh

.It \&.Ss Ta \&No Ta \&No Ta \&.Sh, \&.Ss

Line 303 None of these macros are callable or parsed. The last

Line 335 None of these macros are callable or parsed. The last

the explicit scope rules. All contains bodies, some may contain heads

.Pq So \&Bf Sc .

.Pp

.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX

.Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "closed by XXX"

.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope

.It \&.Bd Ta \&No Ta \&No Ta closed by \&.Ed

.It \&.Ed Ta \&No Ta \&No Ta opened by \&.Bd

Line 608 etc.).

Line 640 etc.).

There's no way to refer to references in

.Sq \&.Rs/.Re

blocks.

.\" LIST-ITEM

.It

The \-split and \-nosplit arguments to

.Sq \&.An

are inane.

.El

CVSweb