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.49 and 1.50

version 1.49, 2010/08/20 01:02:07

version 1.50, 2010/10/10 09:47:05

Line 79 The

.Fn mdoc_reset

function may be used in order to reset the parser for another input

sequence.

See the

.Sx EXAMPLES

section for a simple example.

.Pp

This section further defines the

.Sx Types ,

.Sx Functions

and

.Sx Variables

available to programmers.

Following that, the

.Sx Abstract Syntax Tree

section documents the output tree.

.Ss Types

Both functions (see

.Sx Functions )

and variables (see

.Sx Variables )

may use the following types:

.Bl -ohang

.It Vt struct mdoc

An opaque type defined in

An opaque type.

.Pa mdoc.c .

Its values are only used privately within the library.

.It Vt struct mdoc_node

A parsed node.

Defined in

.Pa mdoc.h .

See

.Sx Abstract Syntax Tree

for details.

.It Vt mandocmsg

A function callback type defined in

.Pa mandoc.h .

.El

.Ss Functions

Function descriptions follow:

.Bl -ohang

.It Fn mdoc_alloc

Allocates a parsing structure.

Line 166 or

Line 141 or

return 0, the data will be incomplete.

.El

.Ss Variables

The following variables are also defined:

.Bl -ohang

.It Va mdoc_macronames

An array of string-ified token names.

Line 354 parsed(mdoc, node);

Line 328 parsed(mdoc, node);

mdoc_free(mdoc);

.Ed

.Pp

Please see

To compile this, execute

.Pp

.D1 % cc main.c libmdoc.a libmandoc.a

.Pp

where

.Pa main.c

in the source archive for a rigorous reference.

is the example file.

.Sh SEE ALSO

.Xr mandoc 1 ,

.Xr mdoc 7

CVSweb