Adding initial options processing (not hooked into parse yet). This is

[mandoc.git] / roff.3

diff --git a/roff.3 b/roff.3
index fcc47395b9cea7cacbdf8179ce32b99c57c8197a..bd0d98f8edc8c6840a125016401b47a10322e058 100644 (file)
--- a/roff.3
+++ b/roff.3
@@ -1,4 +1,4 @@
-.\"    $Id: roff.3,v 1.1 2010/05/25 22:16:59 kristaps Exp $
+.\"    $Id: roff.3,v 1.8 2010/08/20 01:02:07 schwarze Exp $

 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" 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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: May 25 2010 $
+.Dd $Mdocdate: August 20 2010 $

 .Dt ROFF 3
 .Os
 .Sh NAME
 .Dt ROFF 3
 .Os
 .Sh NAME


@@ -29,7 +29,11 @@
 .In mandoc.h
 .In roff.h
 .Ft "struct roff *"
 .In mandoc.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
 .Ft int
 .Fn roff_endparse "struct roff *roff"
 .Ft void


@@ -107,10 +111,6 @@ The
 .Fa data
 pointer is passed to
 .Fa msgs .
 .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 .
 Returns NULL on failure.
 If non-NULL, the pointer must be freed with
 .Fn roff_free .


@@ -154,3 +154,15 @@ The
 .Nm
 library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .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