chiark / gitweb /
@@@ much mess, mostly manpages
[mLib] / codec / base64.3.in
similarity index 70%
rename from codec/base64.3
rename to codec/base64.3.in
index 4d3a51a3e14d9a24f3ba449d5703fac7d329be49..14b79b45ff36f76d13396f81e25c57585119ec1f 100644 (file)
@@ -1,7 +1,34 @@
 .\" -*-nroff-*-
-.TH base64 3 "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
-.SH NAME
-base64, base32, hex \- obsolete binary encoding functions
+.\"
+.\" Manual for old-fashioned binary encoding and decoding
+.\"
+.\" (c) 1999, 2001, 2004, 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 base64 3mLib "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
 .\" @base64_encode
 .\" @base64_decode
 .\" @base64_init
@@ -11,7 +38,14 @@ base64, base32, hex \- obsolete binary encoding functions
 .\" @hex_encode
 .\" @hex_decode
 .\" @hex_init
+.
+.\"--------------------------------------------------------------------------
+.SH NAME
+base64, base32, hex \- obsolete binary encoding functions
+.
+.\"--------------------------------------------------------------------------
 .SH SYNOPSIS
+.
 .nf
 .B "#include <mLib/base64.h>"
 .B "#include <mLib/base32.h>"
@@ -65,7 +99,10 @@ base64, base32, hex \- obsolete binary encoding functions
 .BI "  dstr *" d );
 .BI "void hex_init(hex_ctx *" ctx );
 .fi
+.
+.\"--------------------------------------------------------------------------
 .SH DESCRIPTION
+.
 The
 .BR base64 ,
 .BR base32 ,
@@ -149,9 +186,17 @@ Decoding ignores all errors.  In particular, whitespace is ignored, and
 in the case of Base64 and Base32 encodings, it also ignores
 .RB ` = '
 characters in the string.
+.
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR codec (3),
 .BR dstr (3),
 .BR mLib (3).
+.
+.\"--------------------------------------------------------------------------
 .SH AUTHOR
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------