summaryrefslogtreecommitdiffstats
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-03-20 15:14:01 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-03-20 15:14:01 +0000
commit00aebf138812dfbbad4079310459c4a98d262466 (patch)
tree3813b36b1d67ea89983a0d62631f94c74e9c2c65 /mdoc.3
parente594e9b96619e9def1bb676274977cb0d37fdd1b (diff)
downloadmandoc-00aebf138812dfbbad4079310459c4a98d262466.tar.gz
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.329
1 files changed, 21 insertions, 8 deletions
diff --git a/mdoc.3 b/mdoc.3
index 89cfbbf0..10f05937 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -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