=================================================================== RCS file: /cvs/mandoc/Attic/mdoc.3,v retrieving revision 1.46 retrieving revision 1.51 diff -u -p -r1.46 -r1.51 --- mandoc/Attic/mdoc.3 2010/07/01 09:33:39 1.46 +++ mandoc/Attic/mdoc.3 2010/12/17 11:41:45 1.51 @@ -1,6 +1,7 @@ -.\" $Id: mdoc.3,v 1.46 2010/07/01 09:33:39 kristaps Exp $ +.\" $Id: mdoc.3,v 1.51 2010/12/17 11:41:45 kristaps Exp $ .\" -.\" Copyright (c) 2009-2010 Kristaps Dzonsons +.\" Copyright (c) 2009, 2010 Kristaps Dzonsons +.\" Copyright (c) 2010 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -14,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: July 1 2010 $ +.Dd $Mdocdate: December 17 2010 $ .Dt MDOC 3 .Os .Sh NAME @@ -29,7 +30,6 @@ .Nd mdoc macro compiler library .Sh SYNOPSIS .In mandoc.h -.In regs.h .In mdoc.h .Vt extern const char * const * mdoc_macronames; .Vt extern const char * const * mdoc_argnames; @@ -37,7 +37,6 @@ .Fo mdoc_alloc .Fa "struct regset *regs" .Fa "void *data" -.Fa "int pflags" .Fa "mandocmsg msgs" .Fc .Ft int @@ -80,43 +79,18 @@ 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 simple example. -.Pp -This section further defines the -.Sx Types , -.Sx Functions -and -.Sx Variables -available to programmers. -Following that, the -.Sx Abstract Syntax Tree -section documents the output tree. .Ss Types -Both functions (see -.Sx Functions ) -and variables (see -.Sx Variables ) -may use the following types: .Bl -ohang .It Vt struct mdoc -An opaque type defined in -.Pa mdoc.c . +An opaque type. Its values are only used privately within the library. .It Vt struct mdoc_node A parsed node. -Defined in -.Pa mdoc.h . See .Sx Abstract Syntax Tree for details. -.It Vt mandocmsg -A function callback type defined in -.Pa mandoc.h . .El .Ss Functions -Function descriptions follow: .Bl -ohang .It Fn mdoc_alloc Allocates a parsing structure. @@ -124,10 +98,6 @@ The .Fa data pointer is passed to .Fa msgs . -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 . @@ -171,7 +141,6 @@ or return 0, the data will be incomplete. .El .Ss Variables -The following variables are also defined: .Bl -ohang .It Va mdoc_macronames An array of string-ified token names. @@ -338,7 +307,7 @@ int line; bzero(®s, sizeof(struct regset)); line = 1; -mdoc = mdoc_alloc(®s, NULL, 0, NULL); +mdoc = mdoc_alloc(®s, NULL, NULL); buf = NULL; alloc_len = 0; @@ -359,9 +328,13 @@ parsed(mdoc, node); mdoc_free(mdoc); .Ed .Pp -Please see +To compile this, execute +.Pp +.Dl % cc main.c libmdoc.a libmandoc.a +.Pp +where .Pa main.c -in the source archive for a rigorous reference. +is the example file. .Sh SEE ALSO .Xr mandoc 1 , .Xr mdoc 7