Back out lorder, which doesn't seem necessary (?). I think this means all

[mandoc.git] / mandoc.3

diff --git a/mandoc.3 b/mandoc.3
index 1adb1d0b6aad75aa34fba6575bffaeccdd21a8d4..81c40151c320c0f404327c24c859ef4828fc787d 100644 (file)
--- a/mandoc.3
+++ b/mandoc.3
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.3,v 1.13 2011/08/18 08:58:44 kristaps Exp $
+.\"    $Id: mandoc.3,v 1.16 2011/11/08 00:15:23 kristaps Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>


@@ -15,13 +15,14 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: August 18 2011 $
+.Dd $Mdocdate: November 8 2011 $

 .Dt MANDOC 3
 .Os
 .Sh NAME
 .Nm mandoc ,
 .Nm mandoc_escape ,
 .Nm man_meta ,
 .Dt MANDOC 3
 .Os
 .Sh NAME
 .Nm mandoc ,
 .Nm mandoc_escape ,
 .Nm man_meta ,

+.Nm man_mparse ,

 .Nm man_node ,
 .Nm mchars_alloc ,
 .Nm mchars_free ,
 .Nm man_node ,
 .Nm mchars_alloc ,
 .Nm mchars_free ,


@@ -33,6 +34,8 @@
 .Nm mdoc_node ,
 .Nm mparse_alloc ,
 .Nm mparse_free ,
 .Nm mdoc_node ,
 .Nm mparse_alloc ,
 .Nm mparse_free ,

+.Nm mparse_getkeep ,
+.Nm mparse_keep ,

 .Nm mparse_readfd ,
 .Nm mparse_reset ,
 .Nm mparse_result ,
 .Nm mparse_readfd ,
 .Nm mparse_reset ,
 .Nm mparse_result ,


@@ -47,14 +50,18 @@
 .In mandoc.h
 .Ft "enum mandoc_esc"
 .Fo mandoc_escape
 .In mandoc.h
 .Ft "enum mandoc_esc"
 .Fo mandoc_escape

-.Fa "const char **in"
-.Fa "const char **seq"
-.Fa "int *len"
+.Fa "const char **end"
+.Fa "const char **start"
+.Fa "int *sz"

 .Fc
 .Ft "const struct man_meta *"
 .Fo man_meta
 .Fa "const struct man *man"
 .Fc
 .Fc
 .Ft "const struct man_meta *"
 .Fo man_meta
 .Fa "const struct man *man"
 .Fc

+.Ft "const struct mparse *"
+.Fo man_mparse
+.Fa "const struct man *man"
+.Fc

 .Ft "const struct man_node *"
 .Fo man_node
 .Fa "const struct man *man"
 .Ft "const struct man_node *"
 .Fo man_node
 .Fa "const struct man *man"


@@ -69,14 +76,14 @@
 .Fn mchars_num2uc "const char *cp" "size_t sz"
 .Ft "const char *"
 .Fo mchars_spec2str
 .Fn mchars_num2uc "const char *cp" "size_t sz"
 .Ft "const char *"
 .Fo mchars_spec2str

-.Fa "struct mchars *p"
+.Fa "const struct mchars *p"

 .Fa "const char *cp"
 .Fa "size_t sz"
 .Fa "size_t *rsz"
 .Fc
 .Ft int
 .Fo mchars_spec2cp
 .Fa "const char *cp"
 .Fa "size_t sz"
 .Fa "size_t *rsz"
 .Fc
 .Ft int
 .Fo mchars_spec2cp

-.Fa "struct mchars *p"
+.Fa "const struct mchars *p"

 .Fa "const char *cp"
 .Fa "size_t sz"
 .Ft "const char *"
 .Fa "const char *cp"
 .Fa "size_t sz"
 .Ft "const char *"


@@ -100,6 +107,14 @@
 .Fo mparse_free
 .Fa "struct mparse *parse"
 .Fc
 .Fo mparse_free
 .Fa "struct mparse *parse"
 .Fc

+.Ft void
+.Fo mparse_getkeep
+.Fa "const struct mparse *parse"
+.Fc
+.Ft void
+.Fo mparse_keep
+.Fa "struct mparse *parse"
+.Fc

 .Ft "enum mandoclevel"
 .Fo mparse_readfd
 .Fa "struct mparse *parse"
 .Ft "enum mandoclevel"
 .Fo mparse_readfd
 .Fa "struct mparse *parse"


@@ -244,6 +259,8 @@ may be
 Obtain the meta-data of a successful parse.
 This may only be used on a pointer returned by
 .Fn mparse_result .
 Obtain the meta-data of a successful parse.
 This may only be used on a pointer returned by
 .Fn mparse_result .

+.It Fn man_mparse
+Get the parser used for the current output.

 .It Fn man_node
 Obtain the root node of a successful parse.
 This may only be used on a pointer returned by
 .It Fn man_node
 Obtain the root node of a successful parse.
 This may only be used on a pointer returned by


@@ -294,6 +311,15 @@ must be called to free the memory allocated by this function.
 .It Fn mparse_free
 Free all memory allocated by
 .Fn mparse_alloc .
 .It Fn mparse_free
 Free all memory allocated by
 .Fn mparse_alloc .

+.It Fn mparse_getkeep
+Acquire the keep buffer.
+Must follow a call of
+.Fn mparse_keep .
+.It Fn mparse_keep
+Instruct the parser to retain a copy of its parsed input.
+This can be acquired with subsequent
+.Fn mparse_getkeep
+calls.

 .It Fn mparse_readfd
 Parse a file or file descriptor.
 If
 .It Fn mparse_readfd
 Parse a file or file descriptor.
 If