mandoc/mdoc.3 - diff

Return to mdoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdoc.3 between version 1.8 and 1.11

version 1.8, 2009/02/23 12:45:19

version 1.11, 2009/02/25 17:02:47

Line 59 library implements only those macros documented in the

.Xr mdoc 7

and

.Xr mdoc.samples 7

manuals.

manuals. Documents with

.Xr refer 1 ,

.Xr eqn 1

and other pre-processor sections aren't accomodated.

.\" PARAGRAPH

.Pp

.Nm

Line 89 This section further defines the

Line 92 This section further defines the

.Sx Functions

and

.Sx Variables

available to programmers. The last sub-section,

available to programmers. Following that,

.Sx Character Encoding

describes input format. Lastly,

.Sx Abstract Syntax Tree ,

documents the output tree.

.\" SUBSECTION

Line 99 Both functions (see

Line 104 Both functions (see

and variables (see

.Sx Variables )

may use the following types:

.Bl -ohang

.Bl -ohang -offset "XXXX"

.\" LIST-ITEM

.It Vt struct mdoc

An opaque type defined in

Line 120 for details.

Line 125 for details.

.\" SUBSECTION

.Ss Functions

Function descriptions follow:

.Bl -ohang

.Bl -ohang -offset "XXXX"

.\" LIST-ITEM

.It Fn mdoc_alloc

Allocates a parsing structure. The

Line 165 return 0, the data will be incomplete.

Line 170 return 0, the data will be incomplete.

.\" SUBSECTION

.Ss Variables

The following variables are also defined:

.Bl -ohang

.Bl -ohang -offset "XXXX"

.\" LIST-ITEM

.It Va mdoc_macronames

An array of string-ified token names.

Line 174 An array of string-ified token names.

Line 179 An array of string-ified token names.

An array of string-ified token argument names.

.El

.\" SUBSECTION

.Ss Character Encoding

The

.Xr mdoc 3

library accepts only printable ASCII characters as defined by

.Xr isprint 3 .

Non-ASCII character sequences are escaped with an escape character

.Sq \\

and followed by either an open-parenthesis

.Sq \&(

for two-character sequences; an open-bracket

.Sq \&[

for n-character sequences (terminated at a close-bracket

.Sq \&] ) ;

or one of a small set of single characters for other escapes.

.\" SUBSECTION

.Ss Abstract Syntax Tree

The

.Nm

Line 213 field).

Line 233 field).

The tree itself is arranged according to the following normal form,

where capitalised non-terminals represent nodes.

.Pp

.Bl -tag -width "ELEMENTXX" -compact

.Bl -tag -width "ELEMENTXX" -compact -offset "XXXX"

.\" LIST-ITEM

.It ROOT

\(<- mnode+

Line 272 Note that, if the last line of the file isn't newline-

Line 292 Note that, if the last line of the file isn't newline-

will truncate the file's last character (see

.Xr fgetln 3 ) .

Further, this example does not error-check nor free memory upon failure.

.Bd -literal

.Bd -literal -offset "XXXX"

struct mdoc *mdoc;

struct mdoc_node *node;

char *buf;

Line 318 is the default

Line 338 is the default

.Xr groff 1

system bundled with

.Ox .

.\" PARAGRAPH

.Pp

Un-implemented: the

.Sq \&Xc

Line 327 macros aren't handled when used to span lines for the

Line 348 macros aren't handled when used to span lines for the

.Sq \&It

macro. Such usage is specifically discouraged in

.Xr mdoc.samples 7 .

.\" PARAGRAPH

.Pp

Bugs: when

.Sq \&It \-column

is invoked, whitespace is not stripped around

.Sq \&Ta

or tab-character separators.

.\" PARAGRAPH

.Pp

Bugs: elements within columns for

.Sq \&It \-column

are not yet supported.

.\" PARAGRAPH

.Pp

Incompatible: the

.Sq \&At

macro only accepts a single parameter. Furthermore, several macros

.Pf ( Sq \&Pp ,

.Sq \&It ,

and possibly others) accept multiple arguments with a warning.

.\" PARAGRAPH

.Pp

Incompatible: only those macros specified by

.Xr mdoc.samples 7

CVSweb