mandoc/man.3 - diff

Return to man.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/man.3 between version 1.17 and 1.24

version 1.17, 2010/05/25 21:46:48

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

Line 32

.In man.h

.Vt extern const char * const * man_macronames;

.Ft "struct man *"

.Fn man_alloc "void *data" "int pflags" "mandocmsg msgs"

.Fo man_alloc

.Fa "struct regset *regs"

.Fa "void *data"

.Fa "mandocmsg msgs"

.Fc

.Ft int

.Fn man_endparse "struct man *man"

.Ft void

Line 42

Line 46

.Ft "const struct man_node *"

.Fn man_node "const struct man *man"

.Ft int

.Fn man_parseln "struct man *man" "int line" "char *buf"

.Fo man_parseln

.Fa "struct man *man"

.Fa "int line"

.Fa "char *buf"

.Fc

.Ft void

.Fn man_reset "struct man *man"

.Sh DESCRIPTION

Line 107 documents to be correctly formatted:

Line 115 documents to be correctly formatted:

\e*(PI (pi),

\e*(L" (left double-quote),

\e*(R" (right double-quote),

\e*(C+ (C++),

\e*(C` (left single-quote),

\e*(C' (right single-quote),

\e*(Aq (apostrophe),

Line 162 Function descriptions follow:

Line 169 Function descriptions follow:

Allocates a parsing structure.

The

.Fa data

pointer is passed to callbacks in

pointer is passed to

.Fa cb ,

.Fa msgs .

which are documented further in the header file.

The

.Fa pflags

arguments are defined in

.Pa man.h .

Returns NULL on failure.

If non-NULL, the pointer must be freed with

.Fn man_free .

Line 282 on the finished parse tree with

Line 284 on the finished parse tree with

.Fn parsed .

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

.Bd -literal -offset indent

struct regset regs;

struct man *man;

struct man_node *node;

char *buf;

size_t len;

int line;

bzero(&regs, sizeof(struct regset));

line = 1;

man = man_alloc(NULL, 0, NULL);

man = man_alloc(&regs, NULL, NULL);

buf = NULL;

alloc_len = 0;

CVSweb