.sp 1
.fi
..
-.TH dspool 3mLib "20 June 1999" mLib
+.TH dspool 3 "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
.SH NAME
dspool \- pools of preallocated dynamic strings
+.\" @dspool_create
+.\" @dspool_destroy
+.\" @dspool_get
+.\" @dspool_put
+.\"
+.\" @DSGET
+.\" @DSPUT
+.\"
.SH SYNOPSIS
.nf
-.B "#include <mLib/dspool.h>
+.B "#include <mLib/dspool.h>"
.BI "void dspool_create(dspool *" p ", size_t " isz );
.BI "void dspool_destroy(dspool *" p );
.BI "dstr *dspool_get(dspool *" p );
.BI "void dspool_put(dspool *" p ", dstr *" d );
-.BI "dstr *DSGET(dspool *" p ", d );
+.BI "void DSGET(dspool *" p ", " d );
.BI "void DSPUT(dspool *" p ", dstr *" d );
.fi
.SH DESCRIPTION
It is passed the address of a pool structure
.I p
and the initial size
-.I izs
+.I isz
to allocate for new dynamic strings obtained from the pool. A newly
created pool contains no strings. Once a pool is no longer required,
the function
except for improved performance.
.SH CAVEATS
The string pool allocator requires the suballocator (see
-.BR sub (3mLib)
+.BR sub (3)
for details). You must ensure that
.B sub_init
is called before any strings are allocated from a string pool.
.SH SEE ALSO
-.BR dstr (3mLib),
-.BR sub (3mLib).
+.BR dstr (3),
+.BR sub (3),
+.BR mLib (3).
.SH AUTHOR
-Mark Wooding, <mdw@nsict.org>
+Mark Wooding, <mdw@distorted.org.uk>