version 1.25, 2010/10/10 09:47:05 |
version 1.30, 2011/02/09 09:18:15 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm man , |
.Nm man , |
|
.Nm man_addeqn , |
|
.Nm man_addspan , |
.Nm man_alloc , |
.Nm man_alloc , |
.Nm man_endparse , |
.Nm man_endparse , |
.Nm man_free , |
.Nm man_free , |
|
|
.In mandoc.h |
.In mandoc.h |
.In man.h |
.In man.h |
.Vt extern const char * const * man_macronames; |
.Vt extern const char * const * man_macronames; |
|
.Ft int |
|
.Fo man_addeqn |
|
.Fa "struct man *man" |
|
.Fa "const struct eqn *eqn" |
|
.Fc |
|
.Ft int |
|
.Fo man_addspan |
|
.Fa "struct man *man" |
|
.Fa "const struct tbl_span *span" |
|
.Fc |
.Ft "struct man *" |
.Ft "struct man *" |
.Fo man_alloc |
.Fo man_alloc |
.Fa "struct regset *regs" |
.Fa "struct regset *regs" |
Line 81 Beyond the full set of macros defined in |
|
Line 93 Beyond the full set of macros defined in |
|
.Xr man 7 , |
.Xr man 7 , |
the |
the |
.Nm |
.Nm |
library also accepts the following macros: |
library also accepts the following macro: |
.Pp |
.Pp |
.Bl -tag -width Ds -compact |
.Bl -tag -width Ds -compact |
.It PD |
.It PD |
Has no effect. Handled as a current-scope line macro. |
Has no effect. |
.It Sp |
|
A synonym for |
|
.Sq sp 0.5v |
|
.Pq part of the standard preamble for Perl documentation . |
|
Handled as a line macro. |
|
.It Vb |
|
A synonym for |
|
.Sq nf |
|
.Pq part of the standard preamble for Perl documentation . |
|
Handled as a current-scope line macro. |
Handled as a current-scope line macro. |
.It Ve |
|
A synonym for |
|
.Sq fi , |
|
closing |
|
.Sq Vb |
|
.Pq part of the standard preamble for Perl documentation . |
|
Handled as a current-scope line macro. |
|
.El |
.El |
.Ss Types |
.Ss Types |
.Bl -ohang |
.Bl -ohang |
|
|
for details. |
for details. |
.El |
.El |
.Ss Functions |
.Ss Functions |
|
If |
|
.Fn man_addeqn , |
|
.Fn man_addspan , |
|
.Fn man_parseln , |
|
or |
|
.Fn man_endparse |
|
return 0, calls to any function but |
|
.Fn man_reset |
|
or |
|
.Fn man_free |
|
will raise an assertion. |
.Bl -ohang |
.Bl -ohang |
|
.It Fn man_addeqn |
|
Add an equation to the parsing stream. |
|
Returns 0 on failure, 1 on success. |
|
.It Fn man_addspan |
|
Add a table span to the parsing stream. |
|
Returns 0 on failure, 1 on success. |
.It Fn man_alloc |
.It Fn man_alloc |
Allocates a parsing structure. |
Allocates a parsing structure. |
The |
The |
.Fa data |
.Fa data |
pointer is passed to |
pointer is passed to |
.Fa msgs . |
.Fa msgs . |
Returns NULL on failure. |
Always returns a valid pointer. |
If non-NULL, the pointer must be freed with |
The pointer must be freed with |
.Fn man_free . |
.Fn man_free . |
.It Fn man_reset |
.It Fn man_reset |
Reset the parser for another parse routine. |
Reset the parser for another parse routine. |
Line 143 The input buffer |
|
Line 156 The input buffer |
|
is modified by this function. |
is modified by this function. |
.It Fn man_endparse |
.It Fn man_endparse |
Signals that the parse is complete. |
Signals that the parse is complete. |
Note that if |
|
.Fn man_endparse |
|
is called subsequent to |
|
.Fn man_node , |
|
the resulting tree is incomplete. |
|
Returns 0 on failure, 1 on success. |
Returns 0 on failure, 1 on success. |
.It Fn man_node |
.It Fn man_node |
Returns the first node of the parse. |
Returns the first node of the parse. |
Note that if |
|
.Fn man_parseln |
|
or |
|
.Fn man_endparse |
|
return 0, the tree will be incomplete. |
|
.It Fn man_meta |
.It Fn man_meta |
Returns the document's parsed meta-data. |
Returns the document's parsed meta-data. |
If this information has not yet been supplied or |
|
.Fn man_parseln |
|
or |
|
.Fn man_endparse |
|
return 0, the data will be incomplete. |
|
.El |
.El |
.Ss Variables |
.Ss Variables |
The following variables are also defined: |
The following variables are also defined: |
|
|
.Pp |
.Pp |
To compile this, execute |
To compile this, execute |
.Pp |
.Pp |
.D1 % cc main.c libman.a libmandoc.a |
.Dl % cc main.c libman.a libmandoc.a |
.Pp |
.Pp |
where |
where |
.Pa main.c |
.Pa main.c |