@@@ much mess, mostly manpages

[mLib] / test / bench.3.in

diff --git a/test/bench.3 b/test/bench.3.in
similarity index 86%
rename from test/bench.3
rename to test/bench.3.in
index 2a9e60f..d5953ad 100644 (file)
--- a/test/bench.3
+++ b/test/bench.3.in
@@ -1,14 +1,47 @@
 .\" -*-nroff-*-
-.ie t .ds , \h'\w'\ 'u/2u'
-.el .ds , \ \"
-.TH bench 3 "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
+.\"
+.\" Manual for benchmarking core
+.\"
+.\" (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 bench 3mLib "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
 .\" @bench_createtimer
 .\" @bench_init
 .\" @bench_destroy
 .\" @bench_calibrate
 .\" @bench_measure
 .
+.\"--------------------------------------------------------------------------
+.SH NAME
+bench \- low-level benchmarking tools
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .nf
 .B "#include <mLib/bench.h>"
 .PP
@@ -59,7 +92,9 @@
 .BI "  double " base ", bench_fn *" fn ", void *" ctx );
 .fi
 .
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The header file
 .B "<mLib/bench.h>"
 provides declarations and defintions
@@ -488,8 +523,15 @@ Only valid if
 is set in
 .BR f .
 .
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
+.BR tvec-bench (3),
 .BR mLib (3).
 .
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------