doc: adding stub for tinyrad.conf.5

2 files changed, 115 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 00c1662..612de70 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -135,6 +135,7 @@ EXTRA_MANS				=
 EXTRA_DIST                              = DeveloperNotes.md \
                                           $(doc_DATA) \
                                           doc/mans/tinyrad.3.in \
+                                          doc/mans/tinyrad.conf.5.in \
                                           doc/mans/tinyrad_array.3.in \
                                           doc/mans/tinyrad_error.3.in \
                                           doc/mans/tinyrad_options.3.in \
@@ -219,6 +220,7 @@ if ENABLE_TINYRADPROXY
 endif
 if ENABLE_TINYRAD_COMMON
    doc_DATA                             += doc/tinyrad.conf-example
+   man_MANS                             += doc/mans/tinyrad.conf.5
    man_MANS                             += doc/mans/tinyrad-strings.5
 endif
 
@@ -443,6 +445,9 @@ include $(srcdir)/@bindletools_srcdir@/build-aux/makefile-version.am
 doc/mans/tinyrad.3: Makefile $(srcdir)/doc/mans/tinyrad.3.in
         @$(do_subst_dt)
 
+doc/mans/tinyrad.conf.5: Makefile $(srcdir)/doc/mans/tinyrad.conf.5.in
+        @$(do_subst_dt)
+
 doc/mans/tinyrad_array.3: Makefile $(srcdir)/doc/mans/tinyrad_array.3.in
         @$(do_subst_dt)
 
diff --git a/doc/mans/tinyrad.conf.5.in b/doc/mans/tinyrad.conf.5.in
new file mode 100644
index 0000000..eaf1405
--- /dev/null
+++ b/doc/mans/tinyrad.conf.5.in
@@ -0,0 +1,110 @@
+.\"
+.\" Tiny RADIUS Client Library
+.\" Copyright (C) 2022 David M. Syzdek <david@syzdek.net>.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are
+.\" met:
+.\"
+.\"    * Redistributions of source code must retain the above copyright
+.\"      notice, this list of conditions and the following disclaimer.
+.\"    * Redistributions in binary form must reproduce the above copyright
+.\"      notice, this list of conditions and the following disclaimer in the
+.\"      documentation and/or other materials provided with the distribution.
+.\"    * Neither the name of David M. Syzdek nor the
+.\"      names of its contributors may be used to endorse or promote products
+.\"      derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+.\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+.\" THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID M. SYZDEK BE LIABLE FOR
+.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.TH "TINYRAD.CONF" "5" "@RELEASE_MONTH@" "@PACKAGE_NAME@" "Library Functions Manual"
+.SH NAME
+tinyrad.conf - Tiny RADIUS configuration file/environment variables
+.PP
+.SH DESCRIPTION
+If the environment variable \fBTINYRADNOINIT\fR is defined, all defaulting is
+disabled.  System-wide defaults for TinyRad clients are set in
+\fItinyrad.conf\fR.  User specific defaults are set in \fItinyradrc\fR
+or \fI.tinyradrc\fR.  Directory specific defaults are set in the
+\fItinyradrc\fR in the current working directory.
+.PP
+.SH OPTIONS
+.TP
+\fBBIND_ADDRESS\fR \fI<string>\fR
+To be written.
+.TP
+\fBNETWORK_TIMEOUT\fR \fI<integer>\fR
+To be written.
+.TP
+\fBSECRET\fR \fI<string>\fR
+To be written.
+.TP
+\fBSECRET_FILE\fR \fI<file>\fR
+To be written.
+.TP
+\fBTIMEOUT\fR \fI<integer>\fR
+To be written.
+.TP
+\fBURI\fR \fI<uri>\fR
+To be written.
+.PP
+.SH DICTIONARY OPTIONS
+.TP
+\fBBUILTIN_DICTIONARY\fR {\fIyes\fR|\fIno\fR}
+To be written.
+.TP
+\fBDICTIONARY\fR \fI<file>\fR
+To be written.
+.TP
+\fBPATHS\fR \fI<paths>\fR
+To be written.
+.SH ENVIRONMENT VARIABLES
+.TP
+.I TINYRADNOINIT
+disable all defaulting
+.TP
+.I TINYRADCONF
+path to system-wide configuration file
+.TP
+.I TINYRADRC
+basename f the tinyrc file in $HOME or $CWD
+.TP
+.I TINYRAD_<option-name>
+Set <option-name> as if set in tinyrad.conf
+.SH FILES
+The configuration files have the following precedence.
+.TP
+.I $CWD/tinyradrc
+Directory specific defaults for TinyRad clients
+.TP
+.I $HOME/tinyradrc, $HOME/.tinyradrc
+User specific defaults for TinyRad clients
+.TP
+.I @sysconfdir@/tinyrad.conf
+System-wide defaults for TinyRad clients
+.PP
+.SH SEE ALSO
+.BR tinyrad (1),
+.BR tinyrad (3),
+.BR tinyrad-dict (1),
+.BR tinyrad-strings (5),
+.PP
+.SH AUTHOR
+David M. Syzdek <david@syzdek.net>
+.PP
+.SH ACKNOWLEDGEMENTS
+\fB@PACKAGE_NAME@\fR is developed and maintained by David M. Syzdek
+<david@syzdek.net>.
+
+.\" end of man page