@@@ much mess, mostly manpages

[mLib] / utils / linreg.3.in

diff --git a/utils/linreg.3 b/utils/linreg.3.in
similarity index 50%
rename from utils/linreg.3
rename to utils/linreg.3.in
index 422adae..5cca457 100644 (file)
--- a/utils/linreg.3
+++ b/utils/linreg.3.in
@@ -1,10 +1,44 @@
 .\" -*-nroff-*-
-.TH linreg 3 "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
+.\"
+.\" Manual for linear regression
+.\"
+.\" (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 linreg 3mLib "9 March 2024" "Straylight/Edgeware" "mLib utilities library"
 .\" @linreg_init
 .\" @linreg_update
 .\" @linreg_fit
 .\" @LINREG_INIT
 .
+.\"--------------------------------------------------------------------------
+.SH NAME
+lineag \- linear regression
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
 .nf
 .B "#include <mLib/linreg.h>"
@@ -19,7 +53,9 @@
 .BI "  double *" m_out ", double *" c_out ", double *" r_out );
 .fi
 .
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The functions declared in the
 .B <mLib/linreg.h>
 header perform simple linear regression.
@@ -69,5 +105,14 @@ it holds no external resources.
 .PP
 Any half-decent introduction to statistics will explain these concepts.
 .
+.\"--------------------------------------------------------------------------
+.SH SEE ALSO
+.
+.BR mLib (3).
+.
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------