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.36 and 1.37

version 1.36, 2010/01/07 19:10:09

version 1.37, 2010/02/17 19:22:01

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 above

Line 92 Both functions (see

and variables (see

.Sx Variables )

may use the following types:

.Bl -ohang -offset "XXXX"

.Bl -ohang

.\" LIST-ITEM

.It Vt struct mdoc

An opaque type defined in

Line 113 for details.

.\" SUBSECTION

.Ss Functions

Function descriptions follow:

.Bl -ohang -offset "XXXX"

.Bl -ohang

.\" LIST-ITEM

.It Fn mdoc_alloc

Allocates a parsing structure. The

Line 168 return 0, the data will be incomplete.

.\" SUBSECTION

.Ss Variables

The following variables are also defined:

.Bl -ohang -offset "XXXX"

.Bl -ohang

.\" LIST-ITEM

.It Va mdoc_macronames

An array of string-ified token names.

Line 225 fields) and some type-specific data.

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

where capitalised non-terminals represent nodes.

.Pp

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

.Bl -tag -width "ELEMENTXX" -compact

.\" LIST-ITEM

.It ROOT

\(<- mnode+

Line 259 an empty line will produce a zero-length string.

The following example reads lines from stdin and parses them, operating

on the finished parse tree with

.Fn parsed .

Note that, if the last line of the file isn't newline-terminated, this

This example does not error-check nor free memory upon failure.

will truncate the file's last character (see

.Bd -literal -offset indent

.Xr fgetln 3 ) .

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

.Bd -literal -offset "XXXX"

struct mdoc *mdoc;

const struct mdoc_node *node;

char *buf;

Line 272 int line;

Line 269 int line;

line = 1;

mdoc = mdoc_alloc(NULL, 0, NULL);

buf = NULL;

alloc_len = 0;

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

while ((len = getline(&buf, &alloc_len, stdin)) >= 0) {

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

if (len && buflen[len - 1] = '\en')

if ( ! mdoc_parseln(mdoc, line, buf))

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

errx(1, "mdoc_parseln");

if ( ! mdoc_parseln(mdoc, line, buf))

line++;

errx(1, "mdoc_parseln");

line++;

}

if ( ! mdoc_endparse(mdoc))

errx(1, "mdoc_endparse");

if (NULL == (node = mdoc_node(mdoc)))

errx(1, "mdoc_node");

parsed(mdoc, node);

mdoc_free(mdoc);

Line 297 mdoc_free(mdoc);

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.\" SECTION

.Sh CAVEATS

.Bl -dash -compact

CVSweb