Added some new manuals (mdoc.3 mandoc_char.7).

[mandoc.git] / mdoc.3

diff --git a/mdoc.3 b/mdoc.3
index b0ab387d98bb58293d396c4fba941df33f289146..a7ab956ae6e88591e7a33cb2c9852d964f388815 100644 (file)
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.19 2009/03/16 23:37:28 kristaps Exp $
+.\" $Id: mdoc.3,v 1.25 2009/03/27 14:56:15 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 27 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
@@ -53,14 +56,7 @@ library parses lines of
 .Xr mdoc 7
 input (and
 .Em only
-mdoc) into an abstract syntax tree that generalises the semantic
-annotation of its input.  Common front-ends for 
-.Nm
-are
-.Xr mdocterm 1 ,
-.Xr mdoclint 1 
-and
-.Xr mdoctree 1 .
+mdoc) into an abstract syntax tree (AST).
 .\" PARAGRAPH
 .Pp
 In general, applications initiate a parsing sequence with
@@ -75,7 +71,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 +122,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.
@@ -212,9 +220,7 @@ fields), its position in the tree (the
 .Va next 
 and
 .Va prev 
-fields) and type-specific data (the
-.Va data
-field).
+fields) and some type-specific data.
 .\" PARAGRAPH
 .Pp
 The tree itself is arranged according to the following normal form,
@@ -266,7 +272,7 @@ size_t len;
 int line;
 
 line = 1;
-mdoc = mdoc_alloc(NULL, NULL);
+mdoc = mdoc_alloc(NULL, 0, NULL);
 
 while ((buf = fgetln(fp, &len))) {
        buf[len - 1] = '\\0';
@@ -285,9 +291,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
@@ -301,15 +305,41 @@ utility was written by
 .\" LIST-ITEM
 .It
 The 
-.Sq \&Xc
+.Sq \&.Xc
 and
-.Sq \&Xo
+.Sq \&.Xo
 macros aren't handled when used to span lines for the
-.Sq \&It
+.Sq \&.It
 macro. 
 .\" LIST-ITEM
 .It
 The 
-.Sq \&Bsx
-macro doesn't yet understand version arguments.
+.Sq \&.Bsx
+macro family doesn't yet understand version arguments.
+.\" LIST-ITEM
+.It
+If not given a value, the \-offset argument to
+.Sq \&.Bd
+and
+.Sq \&.Bl
+should be the width of 
+.Qq <string> ;
+instead, a value of 
+.Li 10n
+is provided.
+.\" LIST-ITEM
+.It
+Columns widths in
+.Sq \&.Bl \-column
+should default to width
+.Qq <stringx>
+if not included.
+.\" LIST-ITEM
+.It
+List-width suffix
+.Qq m
+isn't handled.
+.\" LIST-ITEM
+.It
+Contents of the SYNOPSIS section aren't checked.
 .El