mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.19 and 1.33

version 1.19, 2009/03/27 14:56:15

version 1.33, 2009/06/25 10:51:21

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the

.\" purpose with or without fee is hereby granted, provided that the above

.\" above copyright notice and this permission notice appear in all

.\" copyright notice and this permission notice appear in all copies.

.\" copies.

.\"

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED

.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE

.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR

.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER

.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt mdoc 7

.Dt MDOC 7

.Os

.\" SECTION

.Sh NAME

Line 30 The

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.

language. Our reference implementation is

.Xr mandoc 1 .

The

.Sx COMPATIBILITY

section describes compatibility with

.Xr groff 1 .

.\" PARAGRAPH

.Pp

Line 75 or

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 98 Within a macro line, the following characters are rese

Line 111 Within a macro line, the following characters are rese

.Pq question

.It \&!

.Pq exclamation

.It \&|

.Pq vertical bar

.El

.\" PARAGRAPH

.Pp

Line 124 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.

.\" 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 263 In-lines have \(>=0 scoped arguments.

Line 294 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 286 some

Line 317 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 298 None of these macros are callable or parsed. The last

Line 329 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 395 then the macro accepts an arbitrary number of argument

Line 426 then the macro accepts an arbitrary number of argument

.It \&.Os Ta \&No Ta \&No Ta n

.It \&.Pp Ta \&No Ta \&No Ta 0

.It \&.Ad Ta Yes Ta Yes Ta n

.It \&.An Ta \&No Ta Yes Ta n

.It \&.An Ta Yes Ta Yes Ta n

.It \&.Ar Ta Yes Ta Yes Ta n

.It \&.Cd Ta Yes Ta \&No Ta >0

.It \&.Cm Ta Yes Ta Yes Ta n

Line 407 then the macro accepts an arbitrary number of argument

Line 438 then the macro accepts an arbitrary number of argument

.It \&.Fd Ta \&No Ta \&No Ta >0

.It \&.Fl Ta Yes Ta Yes Ta n

.It \&.Fn Ta Yes Ta Yes Ta >0

.It \&.Ft Ta \&No Ta Yes Ta n

.It \&.Ft Ta Yes Ta Yes Ta n

.It \&.Ic Ta Yes Ta Yes Ta >0

.It \&.In Ta \&No Ta \&No Ta n

.It \&.Li Ta Yes Ta Yes Ta n

Line 438 then the macro accepts an arbitrary number of argument

Line 469 then the macro accepts an arbitrary number of argument

.It \&.Db Ta \&No Ta \&No Ta 1

.It \&.Em Ta Yes Ta Yes Ta >0

.It \&.Fx Ta Yes Ta Yes Ta n

.It \&.Ms Ta \&No Ta Yes Ta >0

.It \&.Ms Ta Yes Ta Yes Ta >0

.It \&.No Ta Yes Ta Yes Ta 0

.It \&.Ns Ta Yes Ta Yes Ta 0

.It \&.Nx Ta Yes Ta Yes Ta n

Line 457 then the macro accepts an arbitrary number of argument

Line 488 then the macro accepts an arbitrary number of argument

.It \&.Lb Ta \&No Ta \&No Ta 1

.It \&.Ap Ta Yes Ta Yes Ta 0

.It \&.Lp Ta \&No Ta \&No Ta 0

.It \&.Lk Ta \&No Ta Yes Ta >0

.It \&.Lk Ta Yes Ta Yes Ta n

.It \&.Mt Ta \&No Ta Yes Ta >0

.It \&.Mt Ta Yes Ta Yes Ta >0

.It \&.Es Ta \&No Ta \&No Ta 0

.It \&.En Ta \&No Ta \&No Ta 0

.El

Line 472 and

Line 503 and

macros are obsolete.

.\" SECTION

.Sh COMPATIBILITY

The mdoc language was traditionally a

This section documents compatibility with other roff implementations, at

.Qq roff

this time limited to

macro package; most existing manuals were written with mdoc syntax

.Xr groff 1 .

dictated by system-dependent roff installations. This section documents

The term

compatibility with these systems.

.Qq historic groff

refers to those versions before the

.Pa doc.tmac

file re-write

.Pq somewhere between 1.15 and 1.19 .

.Pp

.Bl -dash -compact

.\" LIST-ITEM

.It

.Sq \&.Fo

Historic groff has many un-callable macros. Most of these (excluding

and

some block-level macros) are now callable, conforming to the

.Sq \&.St

non-historic groff version.

historically weren't always callable. Both are now correctly callable.

.\" LIST-ITEM

.It

The vertical bar

.Sq \(Ba

made historic groff

.Qq go orbital

but is a proper delimiter in this implementation.

.\" LIST-ITEM

.It

.Sq \&.It \-nested

is assumed for all lists: any list may be nested and

is assumed for all lists (it wasn't in historic groff): any list may be

nested and

.Sq \-enum

lists will restart the sequence only for the sub-list.

.\" LIST-ITEM

.It

.Sq \&.It \-column

syntax where column widths may be preceeded by other arguments (instead

syntax where column widths may be preceded by other arguments (instead

of proceeded) is not supported.

.\" LIST-ITEM

.It

Line 503 The

Line 545 The

macro only accepts a single parameter.

.\" LIST-ITEM

.It

The system-name macros (

.Ns Sq \&.At ,

.Sq \&.Bsx ,

.Sq \&.Bx ,

.Sq \&.Fx ,

.Sq \&.Nx ,

.Sq \&.Ox ,

and

.Sq \&.Ux )

are callable.

.\" LIST-ITEM

.It

Some manuals use

.Sq \&.Li

incorrectly by following it with a reserved character and expecting the

delimiter to render. This is not supported.

.\" LIST-ITEM

.It

.Sq \&.Cd

If an special-character control character

is callable.

.Sq \e

is escaped, it will

obviously not render the sequence. Even newer versions of groff seem to

dither on this.

.El

.\" SECTION

.Sh SEE ALSO

Line 533 is callable.

Line 566 is callable.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.An Kristaps Dzonsons Aq kristaps@kth.se .

.\" SECTION

.Sh CAVEATS

There are several ambiguous parts of mdoc.

There are many ambiguous parts of mdoc.

.Pp

.Bl -dash -compact

.\" LIST-ITEM

Line 560 which ostensibly follows it, should follow the same co

Line 593 which ostensibly follows it, should follow the same co

.It

.Sq \&.Va

should formalise that only one or two arguments are acceptable: a

variable name and optional, preceeding type.

variable name and optional, preceding type.

.\" LIST-ITEM

.It

.Sq \&.Fd

Line 601 etc.).

Line 634 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