=================================================================== RCS file: /cvs/mandoc/Attic/mdoc.3,v retrieving revision 1.17 retrieving revision 1.20 diff -u -p -r1.17 -r1.20 --- mandoc/Attic/mdoc.3 2009/03/14 05:21:58 1.17 +++ mandoc/Attic/mdoc.3 2009/03/20 15:14:01 1.20 @@ -1,6 +1,6 @@ -.\" $Id: mdoc.3,v 1.17 2009/03/14 05:21:58 kristaps Exp $ +.\" $Id: mdoc.3,v 1.20 2009/03/20 15:14:01 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 14 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,8 +35,10 @@ .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 .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" @@ -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. @@ -182,7 +197,10 @@ or after .Fn mdoc_endparse or .Fn mdoc_parseln -fail, it may be incomplete. This AST is governed by the ontological +fail, it may be incomplete. +.\" PARAGRAPH +.Pp +This AST is governed by the ontological rules dictated in .Xr mdoc 7 and derives its terminology accordingly. @@ -282,16 +300,14 @@ 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 The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@openbsd.org . .\" SECTION .Sh CAVEATS .Bl -dash -compact