chiark / gitweb /
@@@ much mess, mostly manpages
[mLib] / mem / growbuf.3.in
similarity index 56%
rename from mem/growbuf.3
rename to mem/growbuf.3.in
index bb964a91770ff589da21dc08e6c98cffd0f37883..bd3904ac5874b06766c82cccbb8f1808c41c00a4 100644 (file)
@@ -1,13 +1,45 @@
 .\" -*-nroff-*-
-.TH growbuf 3 "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
+.\"
+.\" Manual for buffer extension
+.\"
+.\" (c) 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 growbuf 3mLib "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
 .\" @GROWBUF_SIZE
 .\" @GROWBUF_EXTEND
 .\" @GROWBUF_REPLACE
 .
+.\"--------------------------------------------------------------------------
 .SH NAME
 growbuf \- extend buffers efficiently
 .
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .nf
 .B "#include <mLib/growbuf.h>"
 .PP
@@ -22,7 +54,9 @@ growbuf \- extend buffers efficiently
 .BI "\h'\w'\*(mT'u'size_t " init ", size_t " granule ");"
 .fi
 .
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The
 .B "<mLib/growbuf.h>"
 header file defines macros useful for dynamically resizing buffers.
@@ -90,9 +124,15 @@ macro is similar, except that it
 .I discards
 the existing buffer contents if the buffer needs to be adjusted.
 .
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR arena (3),
 .BR mLib (3).
 .
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------