=================================================================== RCS file: /cvs/mandoc/mandoc.3,v retrieving revision 1.1 retrieving revision 1.3 diff -u -p -r1.1 -r1.3 --- mandoc/mandoc.3 2011/03/22 10:02:50 1.1 +++ mandoc/mandoc.3 2011/04/09 15:53:48 1.3 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.3,v 1.1 2011/03/22 10:02:50 kristaps Exp $ +.\" $Id: mandoc.3,v 1.3 2011/04/09 15:53:48 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2010 Ingo Schwarze @@ -15,11 +15,12 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 22 2011 $ +.Dd $Mdocdate: April 9 2011 $ .Dt MANDOC 3 .Os .Sh NAME .Nm mandoc , +.Nm mandoc_escape , .Nm man_meta , .Nm man_node , .Nm mdoc_meta , @@ -28,12 +29,20 @@ .Nm mparse_free , .Nm mparse_readfd , .Nm mparse_reset , -.Nm mparse_result +.Nm mparse_result , +.Nm mparse_strerror , +.Nm mparse_strlevel .Nd mandoc macro compiler library .Sh SYNOPSIS .In man.h .In mdoc.h .In mandoc.h +.Ft "enum mandoc_esc" +.Fo mandoc_escape +.Fa "const char **in" +.Fa "const char **seq" +.Fa "int *len" +.Fc .Ft "const struct man_meta *" .Fo man_meta .Fa "const struct man *man" @@ -77,6 +86,14 @@ .Fa "struct mdoc **mdoc" .Fa "struct man **man" .Fc +.Ft "const char *" +.Fo mparse_strerror +.Fa "enum mandocerr" +.Fc +.Ft "const char *" +.Fo mparse_strlevel +.Fa "enum mandoclevel" +.Fc .Vt extern const char * const * man_macronames; .Vt extern const char * const * mdoc_argnames; .Vt extern const char * const * mdoc_macronames; @@ -120,6 +137,40 @@ free all allocated memory with or invoke .Fn mparse_reset and parse new files. +.El +.Sh REFERENCE +This section documents the functions, types, and variables available +via +.In mandoc.h . +.Ss Types +.Bl -ohang +.It Vt "enum mandoc_esc" +.It Vt "enum mandocerr" +.It Vt "enum mandoclevel" +.It Vt "enum mparset" +.It Vt "struct mparse" +.It Vt "mandocmsg" +.El +.Ss Functions +.Bl -ohang +.It Fn mandoc_escape +.It Fn man_meta +.It Fn man_node +.It Fn mdoc_meta +.It Fn mdoc_node +.It Fn mparse_alloc +.It Fn mparse_free +.It Fn mparse_readfd +.It Fn mparse_reset +.It Fn mparse_result +.It Fn mparse_strerror +.It Fn mparse_strlevel +.El +.Ss Variables +.Bl -ohang +.It Va man_macronames +.It Va mdoc_argnames +.It Va mdoc_macronames .El .Sh IMPLEMENTATION NOTES This section consists of structural documentation for