@@@ much mess, mostly manpages

[mLib] / struct / dspool.3.in

diff --git a/struct/dspool.3 b/struct/dspool.3.in
similarity index 55%
rename from struct/dspool.3
rename to struct/dspool.3.in
index dd6dbd9..fd58166 100644 (file)
--- a/struct/dspool.3
+++ b/struct/dspool.3.in
@@ -1,28 +1,49 @@
 .\" -*-nroff-*-
-.de VS
-.sp 1
-.in +5n
-.ft B
-.nf
-..
-.de VE
-.ft R
-.in -5n
-.sp 1
-.fi
-..
-.TH dspool 3 "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
-.SH NAME
-dspool \- pools of preallocated dynamic strings
+.\"
+.\" Manual for string pools
+.\"
+.\" (c) 1999, 2001, 2005, 2009, 2023, 2024 Straylight/Edgeware
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of the mLib utilities library.
+.\"
+.\" mLib is free software: you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or (at
+.\" your option) any later version.
+.\"
+.\" mLib is distributed in the hope that it will be useful, but WITHOUT
+.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
+.\" License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with mLib.  If not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
+.\" USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../defs.man \" @@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
+.TH dspool 3mLib "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
 .\" @dspool_create
 .\" @dspool_destroy
 .\" @dspool_get
 .\" @dspool_put
-.\"
+.
 .\" @DSGET
 .\" @DSPUT
-.\"
+.
+.\"--------------------------------------------------------------------------
+.SH NAME
+dspool \- pools of preallocated dynamic strings
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .nf
 .B "#include <mLib/dspool.h>"
 .PP
@@ -36,7 +57,10 @@ dspool \- pools of preallocated dynamic strings
 .BI "void DSGET(dspool *" p ", " d );
 .BI "void DSPUT(dspool *" p ", dstr *" d );
 .fi
+.
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 A dynamic string pool maintains a collection of `spare' dynamic
 strings.  Some pieces of code require high turnover of strings, and
 allocating and freeing them entails a large amount of overhead.  A
@@ -82,15 +106,26 @@ d = dspool_get(p);
 is entirely equivalent to the function
 .B dspool_put
 except for improved performance.
+.
+.\"--------------------------------------------------------------------------
 .SH CAVEATS
+.
 The string pool allocator requires the suballocator (see
 .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 (3),
 .BR sub (3),
 .BR mLib (3).
+.
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------