@@@ much mess, mostly manpages

[mLib] / hash / crc-mktab.1.in

diff --git a/hash/crc-mktab.1 b/hash/crc-mktab.1.in
similarity index 69%
rename from hash/crc-mktab.1
rename to hash/crc-mktab.1.in
index d2d75e3..4b1e266 100644 (file)
--- a/hash/crc-mktab.1
+++ b/hash/crc-mktab.1.in
@@ -1,16 +1,42 @@
 .\" nroff
-.ie t \{\
-.  ds ss \s8\u
-.  ds se \d\s0
-.\}
-.el \{\
-.  ds ss ^
-.  ds se
-.\}
+.\"
+.\" Manual for CRC table generator
+.\"
+.\" (c) 2003, 2005, 2007, 2009, 2019, 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 crc-mktab 1 "9 November 2003" "Straylight/Edgeware" "mLib utilities library"
+.
+.\"--------------------------------------------------------------------------
 .SH NAME
 crc-mktab \- construct CRC tables for efficient computation
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .B crc-mktab
 .RB [ \-Ccr ]
 .RB [ \-s
@@ -33,7 +59,10 @@ crc-mktab \- construct CRC tables for efficient computation
        \c
 .RB [ \-o
 .IR filename ]
+.
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The
 .B crc-mktab
 program constructs tables for efficient computation of CRC (cyclic
@@ -86,37 +115,36 @@ otherwise.  This option does nothing without the
 option.
 .TP
 .BI "\-i, \-\-include=" header
+.RS
 Request that generated C source include the named
 .I header
 file.  Inserts a
 line of the form
-.PP
-.nf
-.BI "          #include """ header """"
-.fi
 .IP
+.BI "#include """ header """"
+.PP
 at the top of the generated C source.  The default is not to include a
 header file.  This option does nothing without the
 .B \-c
 option.
+.RE
 .TP
 .BI "\-g, \-\-guard=" macro
+.RS
 Use the named
 .I macro
 as a guard against multiple inclusion of the generated header file.
 Inserts a pair of lines of the form
-.PP
-.nf
-.BI "          #ifndef " macro
-.BI "          #define " macro
-.fi
 .IP
-at the top of the generated header, and a line
-.PP
 .nf
-.BI "          #endif"
+.BI "#ifndef " macro
+.BI "#define " macro
 .fi
+.PP
+at the top of the generated header, and a line
 .IP
+.BI "#endif"
+.PP
 at the end.  The default guard macro name is built from the output file
 name specified with
 .B \-o
@@ -126,6 +154,7 @@ nonalphanumeric characters by underscores
 This option does nothing with the
 .B \-c
 option.
+.RE
 .TP
 .BI "\-b, \-\-bits=" bits
 Specifies the degree of the CRC polynomial or, equivalently, the length
@@ -162,10 +191,18 @@ output CRC.
 Describing in detail the contents of the table would take too long.  For
 an example of use, see the header file
 .BR crc32.h .
+.
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR crc32 (3).
 .PP
 .I A painless guide to CRC error detection algorithms
 by Ross N. Williams.
+.
+.\"--------------------------------------------------------------------------
 .SH "AUTHOR"
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------