docs: adding initial manpages

4 files changed, 234 insertions, 1 deletions

diff --git a/ChangeLog.md b/ChangeLog.md
index abb8bf8..c9ccb6a 100644
--- a/ChangeLog.md
+++ b/ChangeLog.md
@@ -12,6 +12,7 @@ All rights reserved.
    - akcom-udpecho: fixing misc portability issues (syzdek)
    - akcom-udpechod: fixing misc portability issues (syzdek)
    - autotools: removing GNU libtool from manual build (syzdek)
+   - docs: adding initial man pages (syzdek)
 
 0.2.0
 -----
diff --git a/Makefile.am b/Makefile.am
index c716c5c..814eaf4 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -72,7 +72,8 @@ lib_LIBRARIES				=
 lib_LTLIBRARIES                         =
 EXTRA_LIBRARIES                         =
 EXTRA_LTLIBRARIES                       =
-man_MANS                                =
+man_MANS                                = docs/akcom-udpecho.8 \
+                                          docs/akcom-udpechod.8
 noinst_HEADERS                          =
 noinst_PROGRAMS                         =
 noinst_LIBRARIES                        =
@@ -85,6 +86,8 @@ TESTS					=
 XFAIL_TESTS                             =
 EXTRA_MANS                              =
 EXTRA_DIST                              = $(noinst_HEADERS) \
+                                          docs/akcom-udpecho.8.in \
+                                          docs/akcom-udpechod.8.in \
                                           docs/TR-143.pdf \
                                           docs/rfc862.txt \
                                           ChangeLog.md \
@@ -129,6 +132,13 @@ include contrib/bindletools/build-aux/makefile-version.am
 # custom targets
 .PHONY:
 
+docs/akcom-udpecho.8: Makefile $(srcdir)/docs/akcom-udpecho.8.in
+        @$(do_subst_dt)
+
+
+docs/akcom-udpechod.8: Makefile $(srcdir)/docs/akcom-udpechod.8.in
+        @$(do_subst_dt)
+
 
 # local targets
 install-exec-local:
diff --git a/docs/akcom-udpecho.8.in b/docs/akcom-udpecho.8.in
new file mode 100644
index 0000000..5bfbeb2
--- /dev/null
+++ b/docs/akcom-udpecho.8.in
@@ -0,0 +1,108 @@
+.\"
+.\" Alaska Communications UDP Echo Tools
+.\" Copyright (C) 2022 Alaska Communications
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are
+.\" met:
+.\"
+.\"    1. Redistributions of source code must retain the above copyright
+.\"       notice, this list of conditions and the following disclaimer.
+.\"
+.\"    2. 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.
+.\"
+.\"    3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDER OR
+.\" CONTRIBUTORS 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 "AKCOM-UDPECHO" "8" "@RELEASE_MONTH@" "Alaska Communications" "Alaska Communications UDP Echo Tools"
+.SH NAME
+akcom-udpecho - a shell utility for testing UDP echo servers
+
+.SH SYNOPSIS
+\fBakcom-udpecho\fR [\fBOPTONS\fR] \fIhost\fR [\fIport\fR]
+
+.SH DESCRIPTION
+\fBakcom-udpecho\fR is a shell utility for testing UDP echo servers.
+\fBakcom-udpecho\fR supports for RFC 862 compliant servers and TR-143
+UDPEchoPlus compliant servers.  If the UDP Echo variant is not specified,
+\fBakcom-udpecho\fR will attempt to determine the variant by examining the
+\fITestRespSN\fR, \fITestRespRecvTimeStamp\fR, and \fITestRespReplyTimeStamp\fR
+ fields of the UDPEchoPlus packet for non-zero values.
+
+.SH OPTIONS
+
+.TP 14
+\fB-4\fR
+connect via IPv4 only
+
+.TP 14
+\fB-6\fR
+connect via IPv6 only
+
+.TP 14
+\fB-c\fR \fIcount\fR
+stop after sending count packets
+
+.TP 14
+\fB-d\fR, \fB--debug\fR
+print headers of received packets. Useful for troubleshooting remote
+UDPEchoPlus servers.
+
+.TP 14
+\fB-e\fR, \fB--echoplus\fR
+expect responses from a TR-143 UDPEchoPlus compliant server. The default is to
+attempt to detect UDPEchoPlus responses.
+
+.TP 14
+\fB-h\fR, \fB--help\fR
+print usage information and exit.
+
+.TP 14
+\fB-i\fR \interval\fR
+interval in seconds between sending packets (default: 1 sec)
+
+.TP 14
+\fB-r\fR, \fB--rfc\fR
+expect responses from an RFC 862 compliant server . The default is to
+attempt to detect TR-143 UDPEchoPlus responses.
+
+.TP 14
+\fB-q\fR, \fB--quiet\fR, \fB--silent\fR
+do not print messages
+
+.TP 14
+\fB-s\fR \isize\fR
+size of data bytes to be sent. The minimum data size is 40 bytes.
+
+.TP 14
+\fB-t\fR \isec\fR
+response timeout (default: 5 sec)
+
+.TP 14
+\fB-V\fR, \fB--version\fR
+print version number and exit
+
+.TP 14
+\fB-v\fR, \fB--verbose\fR
+enable verbose output
+
+.SH SEE ALSO
+.BR akcom-udpechod (8)
+
+.SH AUTHOR
+David M. Syzdek <david.syzdek@acsalaska.com>
diff --git a/docs/akcom-udpechod.8.in b/docs/akcom-udpechod.8.in
new file mode 100644
index 0000000..78876ab
--- /dev/null
+++ b/docs/akcom-udpechod.8.in
@@ -0,0 +1,114 @@
+.\"
+.\" Alaska Communications UDP Echo Tools
+.\" Copyright (C) 2022 Alaska Communications
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are
+.\" met:
+.\"
+.\"    1. Redistributions of source code must retain the above copyright
+.\"       notice, this list of conditions and the following disclaimer.
+.\"
+.\"    2. 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.
+.\"
+.\"    3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDER OR
+.\" CONTRIBUTORS 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 "AKCOM-UDPECHOD" "8" "@RELEASE_MONTH@" "Alaska Communications" "Alaska Communications UDP Echo Tools"
+.SH NAME
+akcom-udpechod - a simple UDP echo server
+
+.SH SYNOPSIS
+\fBakcom-udpechod\fR [\fBOPTONS\fR]
+
+.SH DESCRIPTION
+\fBakcom-udpechod\fR is simple UDP echo server. Currently \fBakcom-udpechod\fR
+processes each packet sequentially which causes all packets received before
+previous packets have been processed to be skewed when using either the
+\fB-D\fR or \fB-d\fR options.
+
+.SH OPTIONS
+
+.TP 10
+\fB-d\fR \fInum\fR, \fB--drop\fR=\fInum\fR,
+set the packet drop probability [0-99]. This option should not be used if
+multiple clients will be using the same UDP echo server instance.
+(default: 0%)
+
+.TP 10
+\fB-D\fR \fIusec\fR, \fB--delay\fR=\fIusec\fR
+set echo delay range to microseconds. This option should not be used if
+multiple clients will be using the same UDP echo server instance.
+(default: 0 us)
+
+.TP 10
+\fB-e\fB, \fB--echoplus\fR
+run as a TR-143 UDPEchoPlus server. This option is not compatible with
+RFC 862 UDP echo clients.
+
+.TP 10
+\fB-f\fR \fIstr\fR, \fB--facility\fR=\fIstr\fR
+set syslog facility (default: daemon)
+
+.TP 10
+\fB-g\fR \fIgid\fR, \fB--group\fR=\fIgid\fR
+setgid to gid (default: none)
+
+.TP 10
+\fB-h\fR, \fB--help\fR
+print this help and exit
+
+.TP 10
+\fB-l\fR \fIaddr\fR, \fB--listen\fR=\fIaddr\fR
+bind to IP address (default: all)
+
+.TP 10
+\fB-n\fR, \fB--foreground\fR
+do not fork
+
+.TP 10
+\fB-p\fR \fIport\fR, \fB--port\fR=\fIport\fR
+list on port number (default: 30006)
+
+.TP 10
+\fB-P\fR \fIfile\fR, \fB--pidfile\fR=\fIfile\fR
+PID file (default: /var/run/akcom-udpechod.pid)
+
+.TP 10
+\fB-r\fR, \fB--rfc\fR
+run as an RFC 862 compliant echo protocol. This option may be incompatible
+with TR-143 UDPEchoPlus clients.  This option is compatible with the TR-143
+UDPEchoPlus mode of \fBakcom-udpecho\fR (8). (default)
+
+.TP 10
+\fB-u\fR \fIuid\fR,  \fB--user\fR=\fUuid\fR
+setuid to uid (default: none)
+
+.TP 10
+\fB-v\fR, \fB--verbose\fR
+enable verbose output
+
+.TP 10
+\fB-V\fR, \fB--version\fR
+print version number and exit
+
+.SH SEE ALSO
+.BR akcom-udpecho (8)
+
+.SH AUTHOR
+David M. Syzdek <david.syzdek@acsalaska.com>