]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.3
Move clean-up of parsed tbl nodes into the tbl_clear() function, called
[mandoc.git] / roff.3
diff --git a/roff.3 b/roff.3
index 961daff5b92bc70fb566775161c4e0999c0c13a5..bd0d98f8edc8c6840a125016401b47a10322e058 100644 (file)
--- a/roff.3
+++ b/roff.3
@@ -1,4 +1,4 @@
-.\"    $Id: roff.3,v 1.2 2010/06/26 15:22:19 kristaps Exp $
+.\"    $Id: roff.3,v 1.8 2010/08/20 01:02:07 schwarze Exp $
 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,7 +14,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: June 26 2010 $
+.Dd $Mdocdate: August 20 2010 $
 .Dt ROFF 3
 .Os
 .Sh NAME
 .Nd roff macro compiler library
 .Sh SYNOPSIS
 .In mandoc.h
-.In regs.h
 .In roff.h
 .Ft "struct roff *"
-.Fn roff_alloc "mandocmsg msgs" "void *data"
+.Fo roff_alloc
+.Fa "struct regset *regs"
+.Fa "void *data"
+.Fa "mandocmsg msgs"
+.Fc
 .Ft int
 .Fn roff_endparse "struct roff *roff"
 .Ft void
@@ -108,10 +111,6 @@ The
 .Fa data
 pointer is passed to
 .Fa msgs .
-The
-.Fa pflags
-arguments are defined in
-.Pa roff.h .
 Returns NULL on failure.
 If non-NULL, the pointer must be freed with
 .Fn roff_free .
@@ -155,3 +154,15 @@ The
 .Nm
 library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.Sh BUGS
+The implementation of user-defined strings needs improvement:
+.Bl -dash
+.It
+String values are taken literally and are not interpreted.
+.It
+Parsing of quoted strings is incomplete.
+.It
+The stings are stored internally using a singly linked list,
+which is fine for small numbers of strings,
+but ineffient when handling many strings.
+.El