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.20 and 1.27

version 1.20, 2009/03/20 15:14:01

version 1.27, 2009/04/12 19:19:57

Line 17

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt mdoc 3

.Dt MDOC 3

.Os

.\" SECTION

.Sh NAME

Line 36

.Vt extern const char * const * mdoc_argnames;

.Ft "struct mdoc *"

.Fn mdoc_alloc "void *data" "int pflags" "const struct mdoc_cb *cb"

.Ft void

.Ft int

.Fn mdoc_reset "struct mdoc *mdoc"

.Ft void

.Fn mdoc_free "struct mdoc *mdoc"

Line 56 library parses lines of

.Xr mdoc 7

input (and

.Em only

mdoc) into an abstract syntax tree that generalises the semantic

mdoc) into an abstract syntax tree (AST).

annotation of its input. Common front-ends for

.Nm

are

.Xr mdocterm 1 ,

.Xr mdoclint 1

and

.Xr mdoctree 1 .

.\" PARAGRAPH

.Pp

In general, applications initiate a parsing sequence with

Line 140 Returns NULL on failure. If non-NULL, the pointer mus

Line 133 Returns NULL on failure. If non-NULL, the pointer mus

.It Fn mdoc_reset

Reset the parser for another parse routine. After its use,

.Fn mdoc_parseln

behaves as if invoked for the first time.

behaves as if invoked for the first time. If it returns 0, memory could

not be allocated.

.\" LIST-ITEM

.It Fn mdoc_free

Free all resources of a parser. The pointer is no longer valid after

Line 227 fields), its position in the tree (the

Line 221 fields), its position in the tree (the

.Va next

and

.Va prev

fields) and type-specific data (the

fields) and some type-specific data.

.Va data

field).

.\" PARAGRAPH

.Pp

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

Line 281 size_t len;

Line 273 size_t len;

int line;

line = 1;

mdoc = mdoc_alloc(NULL, NULL);

mdoc = mdoc_alloc(NULL, 0, NULL);

while ((buf = fgetln(fp, &len))) {

buf[len - 1] = '\\0';

Line 314 utility was written by

Line 306 utility was written by

.\" LIST-ITEM

.It

The

.Sq \&Xc

.Sq \&.Xc

and

.Sq \&Xo

.Sq \&.Xo

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

.Sq \&It

.Sq \&.It

macro.

.\" LIST-ITEM

.It

The

.Sq \&Bsx

.Sq \&.Bsx

macro doesn't yet understand version arguments.

macro family doesn't yet understand version arguments.

.\" LIST-ITEM

.It

If not given a value, the \-offset argument to

.Sq \&.Bd

and

.Sq \&.Bl

should be the width of

.Qq <string> ;

instead, a value of

.Li 10n

is provided.

.\" LIST-ITEM

.It

Columns widths in

.Sq \&.Bl \-column

should default to width

.Qq <stringx>

if not included.

.\" LIST-ITEM

.It

List-width suffix

.Qq m

isn't handled.

.\" LIST-ITEM

.It

Contents of the SYNOPSIS section aren't checked.

.El

CVSweb