diff options
| author |   Kristaps Dzonsons <kristaps@bsd.lv> | 2009-03-20 15:14:01 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-03-20 15:14:01 +0000 |
| commit | c77635473d2482e2462a6d24ba39e43e5ea6ed64 (patch) | |
| tree | 27fdbb70907287167ccf1c7366ff0a668e882c8d /mdoc.3 | |
| parent | b4ee9d6b1b8964750454bb66e67aa323b06752a9 (diff) | |
| download | mandoc-c77635473d2482e2462a6d24ba39e43e5ea6ed64.tar.gz mandoc-c77635473d2482e2462a6d24ba39e43e5ea6ed64.tar.zst mandoc-c77635473d2482e2462a6d24ba39e43e5ea6ed64.zip | |
Support for `Bd' of all types (see mdoc.7 for newline/tab rules).VERSION_1_6_2
Renamed term.c and terminal.c functions to be term_.
Some bugfixes to lists.
Diffstat (limited to 'mdoc.3')
| -rw-r--r-- | mdoc.3 | 33 |
1 files changed, 23 insertions, 10 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.3,v 1.19 2009/03/16 23:37:28 kristaps Exp $ +.\" $Id: mdoc.3,v 1.20 2009/03/20 15:14:01 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> .\" @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 16 2009 $ +.Dd $Mdocdate: March 20 2009 $ .Dt mdoc 3 .Os .\" SECTION @@ -26,7 +26,8 @@ .Nm mdoc_endparse , .Nm mdoc_node , .Nm mdoc_meta , -.Nm mdoc_free +.Nm mdoc_free , +.Nm mdoc_reset .Nd mdoc macro compiler library .\" SECTION .Sh SYNOPSIS @@ -34,7 +35,9 @@ .Vt extern const char * const * mdoc_macronames; .Vt extern const char * const * mdoc_argnames; .Ft "struct mdoc *" -.Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb" +.Fn mdoc_alloc "void *data" "int pflags" "const struct mdoc_cb *cb" +.Ft void +.Fn mdoc_reset "struct mdoc *mdoc" .Ft void .Fn mdoc_free "struct mdoc *mdoc" .Ft int @@ -75,7 +78,10 @@ and .Fn mdoc_meta , then free all allocated memory with .Fn mdoc_free . -See the +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 full example. .\" PARAGRAPH @@ -123,10 +129,19 @@ Allocates a parsing structure. The .Fa data pointer is passed to callbacks in .Fa cb , -which are documented further in the header file. Returns NULL on -failure. If non-NULL, the pointer must be freed with +which are documented further in the header file. +The +.Fa pflags +arguments are defined in +.Pa mdoc.h . +Returns NULL on failure. If non-NULL, the pointer must be freed with .Fn mdoc_free . .\" LIST-ITEM +.It Fn mdoc_reset +Reset the parser for another parse routine. After its use, +.Fn mdoc_parseln +behaves as if invoked for the first time. +.\" LIST-ITEM .It Fn mdoc_free Free all resources of a parser. The pointer is no longer valid after invocation. @@ -285,9 +300,7 @@ mdoc_free(mdoc); .Ed .\" SECTION .Sh SEE ALSO -.Xr mdocterm 1 , -.Xr mdoclint 1 , -.Xr mdoctree 1 , +.Xr mandoc 1 , .Xr mdoc 7 .\" SECTION .Sh AUTHORS |