aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/akcom-udpecho.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'docs/akcom-udpecho.8.in')
-rw-r--r--docs/akcom-udpecho.8.in108
1 files changed, 108 insertions, 0 deletions
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 @@
1.\"
2.\" Alaska Communications UDP Echo Tools
3.\" Copyright (C) 2022 Alaska Communications
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions are
7.\" met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer.
11.\"
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\"
16.\" 3. Neither the name of the copyright holder nor the names of its
17.\" contributors may be used to endorse or promote products derived from
18.\" this software without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21.\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22.\" THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
24.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27.\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.TH "AKCOM-UDPECHO" "8" "@RELEASE_MONTH@" "Alaska Communications" "Alaska Communications UDP Echo Tools"
33.SH NAME
34akcom-udpecho - a shell utility for testing UDP echo servers
35
36.SH SYNOPSIS
37\fBakcom-udpecho\fR [\fBOPTONS\fR] \fIhost\fR [\fIport\fR]
38
39.SH DESCRIPTION
40\fBakcom-udpecho\fR is a shell utility for testing UDP echo servers.
41\fBakcom-udpecho\fR supports for RFC 862 compliant servers and TR-143
42UDPEchoPlus compliant servers. If the UDP Echo variant is not specified,
43\fBakcom-udpecho\fR will attempt to determine the variant by examining the
44\fITestRespSN\fR, \fITestRespRecvTimeStamp\fR, and \fITestRespReplyTimeStamp\fR
45 fields of the UDPEchoPlus packet for non-zero values.
46
47.SH OPTIONS
48
49.TP 14
50\fB-4\fR
51connect via IPv4 only
52
53.TP 14
54\fB-6\fR
55connect via IPv6 only
56
57.TP 14
58\fB-c\fR \fIcount\fR
59stop after sending count packets
60
61.TP 14
62\fB-d\fR, \fB--debug\fR
63print headers of received packets. Useful for troubleshooting remote
64UDPEchoPlus servers.
65
66.TP 14
67\fB-e\fR, \fB--echoplus\fR
68expect responses from a TR-143 UDPEchoPlus compliant server. The default is to
69attempt to detect UDPEchoPlus responses.
70
71.TP 14
72\fB-h\fR, \fB--help\fR
73print usage information and exit.
74
75.TP 14
76\fB-i\fR \interval\fR
77interval in seconds between sending packets (default: 1 sec)
78
79.TP 14
80\fB-r\fR, \fB--rfc\fR
81expect responses from an RFC 862 compliant server . The default is to
82attempt to detect TR-143 UDPEchoPlus responses.
83
84.TP 14
85\fB-q\fR, \fB--quiet\fR, \fB--silent\fR
86do not print messages
87
88.TP 14
89\fB-s\fR \isize\fR
90size of data bytes to be sent. The minimum data size is 40 bytes.
91
92.TP 14
93\fB-t\fR \isec\fR
94response timeout (default: 5 sec)
95
96.TP 14
97\fB-V\fR, \fB--version\fR
98print version number and exit
99
100.TP 14
101\fB-v\fR, \fB--verbose\fR
102enable verbose output
103
104.SH SEE ALSO
105.BR akcom-udpechod (8)
106
107.SH AUTHOR
108David M. Syzdek <david.syzdek@acsalaska.com>