OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / roff.3

diff --git a/roff.3 b/roff.3
index 6c8ccd085ac07230bcad1667621710cfc970e9d4..d41deee065d8ec066596cbb73baac243ab0b38c7 100644 (file)
--- a/roff.3
+++ b/roff.3
@@ -1,4 +1,4 @@
-.\"    $Id: roff.3,v 1.4 2010/07/03 16:02:12 schwarze Exp $
+.\"    $Id: roff.3,v 1.7 2010/07/13 23:53:20 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: July 3 2010 $
+.Dd $Mdocdate: July 13 2010 $

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


@@ -27,7 +27,6 @@
 .Nd roff macro compiler library
 .Sh SYNOPSIS
 .In mandoc.h
 .Nd roff macro compiler library
 .Sh SYNOPSIS
 .In mandoc.h

-.In regs.h

 .In roff.h
 .Ft "struct roff *"
 .Fo roff_alloc
 .In roff.h
 .Ft "struct roff *"
 .Fo roff_alloc


@@ -50,15 +49,6 @@
 .Fc
 .Ft void
 .Fn roff_reset "struct roff *roff"
 .Fc
 .Ft void
 .Fn roff_reset "struct roff *roff"

-.In regs.h
-.Ft "char *"
-.Fn roff_setstr "const char *name" "const char *string"
-.Ft "char *"
-.Fn roff_getstr "const char *name"
-.Ft "char *"
-.Fn roff_getstrn "const char *name" "size_t len"
-.Ft void
-.Fn roff_freestr void

 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm


@@ -154,52 +144,6 @@ Returns 0 on failure, 1 on success.
 Signals that the parse is complete.
 Returns 0 on failure, 1 on success.
 .El
 Signals that the parse is complete.
 Returns 0 on failure, 1 on success.
 .El

-.Sh USER-DEFINED STRINGS
-Strings defined by the
-.Xr roff 7
-.Sx \&ds
-instruction are saved using the
-.Fn roff_setstr
-function and retrieved using the
-.Fn roff_getstr
-and
-.Fn roff_getstrn
-functions.
-.Pp
-These functions take the name of the string to be accessed
-as their first argument.
-While
-.Fn roff_getstr
-requires the name to be null-terminated,
-.Fn roff_getstrn
-accepts non-terminated strings, but requires the length of the name
-to be specified.
-.Pp
-The second argument to
-.Fn roff_setstr
-is the new value of the string.
-It will be copied to internal storage, so both pointers to constant
-strings and pointers to volatile storage are acceptable.
-.Pp
-All of these functions return a pointer to the new value of the string
-in internal storage, which should be considered read-only, so use
-.Xr strdup 3
-on it as appropriate.
-The read functions return NULL when a string of the specified name
-is not available or empty, and
-.Fn roff_setstr
-returns NULL when memory allocation fails.
-In the latter case, the string will remain unset.
-.Pp
-The function
-.Fn roff_freestr
-clears all user-defined strings.
-It always succeeds.
-Both
-.Fn roff_reset
-and
-.Fn roff_free
-call it.

 .Sh EXAMPLES
 See
 .Pa main.c
 .Sh EXAMPLES
 See
 .Pa main.c