version 1.20, 2010/06/27 15:52:41 |
version 1.24, 2010/08/20 01:02:07 |
|
|
.Nd man macro compiler library |
.Nd man macro compiler library |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.In mandoc.h |
.In mandoc.h |
.In regs.h |
|
.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 *" |
.Fo man_alloc |
.Fo man_alloc |
.Fa "const struct regset *regs" |
.Fa "struct regset *regs" |
.Fa "void *data" |
.Fa "void *data" |
.Fa "int pflags" |
|
.Fa "mandocmsg msgs" |
.Fa "mandocmsg msgs" |
.Fc |
.Fc |
.Ft int |
.Ft int |
Line 117 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), |
|
|
.Fa data |
.Fa data |
pointer is passed to |
pointer is passed to |
.Fa msgs . |
.Fa msgs . |
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 291 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; |
|
|