version 1.17, 2010/05/25 21:46:48 |
version 1.24, 2010/08/20 01:02:07 |
|
|
.In man.h |
.In man.h |
.Vt extern const char * const * man_macronames; |
.Vt extern const char * const * man_macronames; |
.Ft "struct man *" |
.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 |
.Ft int |
.Fn man_endparse "struct man *man" |
.Fn man_endparse "struct man *man" |
.Ft void |
.Ft void |
|
|
.Ft "const struct man_node *" |
.Ft "const struct man_node *" |
.Fn man_node "const struct man *man" |
.Fn man_node "const struct man *man" |
.Ft int |
.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 |
.Ft void |
.Fn man_reset "struct man *man" |
.Fn man_reset "struct man *man" |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
Line 107 documents to be correctly formatted: |
|
Line 115 documents to be correctly formatted: |
|
\e*(PI (pi), |
\e*(PI (pi), |
\e*(L" (left double-quote), |
\e*(L" (left double-quote), |
\e*(R" (right double-quote), |
\e*(R" (right double-quote), |
\e*(C+ (C++), |
|
\e*(C` (left single-quote), |
\e*(C` (left single-quote), |
\e*(C' (right single-quote), |
\e*(C' (right single-quote), |
\e*(Aq (apostrophe), |
\e*(Aq (apostrophe), |
Line 162 Function descriptions follow: |
|
Line 169 Function descriptions follow: |
|
Allocates a parsing structure. |
Allocates a parsing structure. |
The |
The |
.Fa data |
.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. |
Returns NULL on failure. |
If non-NULL, the pointer must be freed with |
If non-NULL, the pointer must be freed with |
.Fn man_free . |
.Fn man_free . |
Line 282 on the finished parse tree with |
|
Line 284 on the finished parse tree with |
|
.Fn parsed . |
.Fn parsed . |
This example does not error-check nor free memory upon failure. |
This example does not error-check nor free memory upon failure. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
|
struct regset regs; |
struct man *man; |
struct man *man; |
struct man_node *node; |
struct man_node *node; |
char *buf; |
char *buf; |
size_t len; |
size_t len; |
int line; |
int line; |
|
|
|
bzero(®s, sizeof(struct regset)); |
line = 1; |
line = 1; |
man = man_alloc(NULL, 0, NULL); |
man = man_alloc(®s, NULL, NULL); |
buf = NULL; |
buf = NULL; |
alloc_len = 0; |
alloc_len = 0; |
|
|