chiark / gitweb /
Actually implement the right transformation!
[mLib] / man / dspool.3
index 72465dc868c53c757993eac57eef13a3de68d894..59e91b445798165f331b2ad7bc1d2bd8a62cff28 100644 (file)
 .sp 1
 .fi
 ..
 .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
 .SH NAME
 dspool \- pools of preallocated dynamic strings
+.\" @dspool_create
+.\" @dspool_destroy
+.\" @dspool_get
+.\" @dspool_put
+.\"
+.\" @DSGET
+.\" @DSPUT
+.\"
 .SH SYNOPSIS
 .nf
 .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 "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
 .BI "void DSPUT(dspool *" p ", dstr *" d );
 .fi
 .SH DESCRIPTION
@@ -38,7 +46,7 @@ A pool is created by the function
 It is passed the address of a pool structure
 .I p
 and the initial size
 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
 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
@@ -74,12 +82,13 @@ is entirely equivalent to the function
 except for improved performance.
 .SH CAVEATS
 The string pool allocator requires the suballocator (see
 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
 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
 .SH AUTHOR
-Mark Wooding, <mdw@nsict.org>
+Mark Wooding, <mdw@distorted.org.uk>