mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.45 and 1.48

version 1.45, 2009/07/17 12:40:48

version 1.48, 2009/07/18 23:31:04

Line 49 prior macros:

Other lines are interpreted within the current state.

.Ed

.\" SECTION---------------------------------------------

.Sh INPUT ENCODING

.Sh LANGUAGE SYNTAX

.Nm

documents may contain only graphable 7-bit ASCII characters, the space

character, and, in certain circumstances, the tab character. All

manuals must have

.Ux

line termination.

line terminators.

.\" SUB-SECTION----------------------

.Ss Comments

Text following a

Line 133 escape followed by an indicator: B (bold), I, (italic)

(Roman, or reset). This form is not recommended.

.\" SUB-SECTION----------------------

.Ss Whitespace

In general, consecutive blocks of whitespace are pruned from input.

In non-literal free-form lines, consecutive blocks of whitespace are

These are later re-added, when applicable, by

pruned from input and added later in the output filter, if applicable:

.Xr mandoc 1 .

.Bd -literal -offset indent

These spaces are pruned from input.

\&.Bd \-literal

These are not.

\&.Ed

.Ed

.\" PARAGRAPH------------

.Pp

Blank lines are permitted within

In macro lines, whitespace delimits arguments and is discarded. If

.Sq \&Bd \-literal

arguments are quoted, whitespace within the quotes is retained.

.\" PARAGRAPH------------

.Sq \&Bd \-unfilled

.Pp

contexts. Tab characters are only acceptable when delimiting

Blank lines are only permitted within literal contexts, as are lines

containing only whitespace. Tab characters are only acceptable when

delimiting

.Sq \&Bl \-column

and in

or when in a literal context.

.Sq \&Bd \-literal

.\" SUB-SECTION----------------------

.Ss Quotation

.Sq \&Bd \-unfilled

Macro arguments may be quoted with a double-quote to group

contexts.

space-delimited terms or to retain blocks of whitespace. A quoted

argument begins with a double-quote preceded by whitespace. The next

double-quote not pair-wise adjacent to another double-quote terminates

the literal, regardless of surrounding whitespace.

.\" PARAGRAPH------------

.Pp

This produces tokens

.Sq a" ,

.Sq b c ,

.Sq de ,

and

.Sq fg" .

Note that any quoted term, be it argument or macro, is indiscriminately

considered literal text. Thus, the following produces

.Sq \&Em a :

.Bd -literal -offset indent

\&.Em "Em a"

.Ed

.\" PARAGRAPH------------

.Pp

In free-form mode, quotes are regarded as opaque text.

.\" SECTION---------------------------------------------

.Sh MANUAL STRUCTURE

Each

Line 157 document must begin with a document prologue, containi

Line 184 document must begin with a document prologue, containi

.Sq \&Dd ,

.Sq \&Dt ,

and

.Sq \&Os

.Sq \&Os ,

(using this manual as an example):

then the NAME section containing at least one

.Sq \&Nm

followed by

.Sq \&Nd :

.Bd -literal -offset indent

\&.Dd $\&Mdocdate$

\&.Dt mdoc 7

Line 167 and

Line 197 and

\&.Nm mdoc

\&.Nd mdoc language reference

.Ed

.Pp

Following these, the document body must begin with the NAME section

containing at least one

.Sq \&Nm

followed by

.Sq \&Nd .

.\" PARAGRAPH------------

.Pp

Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,

Line 181 but non-compulsory.

Line 205 but non-compulsory.

.Sh MACRO SYNTAX

Every line beginning with the control character

.Sq \.

is processed for macros, two- or three-character semantic annotations.

is processed for macros, two- or three-character sequences.

.\" PARAGRAPH------------

.Pp

The syntax of macro depends on its classification. In this section,

The syntax of a macro depends on its classification. In this section,

.Sq \-arg

refers to macro arguments, which may be followed by zero or more

.Sq parm

Line 199 The

Line 223 The

.Em Callable

column indicates that the macro may be called subsequent to the initial

line-macro. The

.Qq Parsable

.Em Parsable

column indicates whether the macro may be followed by further

(ostensibly callable) macros. The

.Em Scope

Line 432 file re-write

Line 456 file re-write

.Bl -dash -compact

.\" LIST-ITEM

.It

In quoted literals, groff allowed pair-wise double-quotes to produce a

standalone double-quote in formatted output. This idiosyncratic

behaviour is no longer applicable.

.\" LIST-ITEM

.It

The

.Sq \&sp

macro does not accept negative numbers.

Line 504 macro only produces the first parameter. This is no l

Line 533 macro only produces the first parameter. This is no l

.Sh AUTHORS

The

.Nm

utility was written by

reference was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

.\" SECTION---------------------------------------------

.Sh CAVEATS

CVSweb