diff options
| author | David M. Syzdek <david.syzdek@acsalaska.com> | 2022-07-22 12:32:40 -0800 |
|---|---|---|
| committer | David M. Syzdek <david.syzdek@acsalaska.com> | 2022-07-22 12:32:40 -0800 |
| commit | 01eb6398c572fe34f98be8ececa0fcc4f19937fa (patch) | |
| tree | 99c9e6003dceb0326c40f7a14741710ea735e78e | |
| parent | a8e3c0234ec9fd0bcfe5b6a4b2853ff9973bc84a (diff) | |
| download | akcom-udpecho-01eb6398c572fe34f98be8ececa0fcc4f19937fa.tar.gz akcom-udpecho-01eb6398c572fe34f98be8ececa0fcc4f19937fa.tar.bz2 akcom-udpecho-01eb6398c572fe34f98be8ececa0fcc4f19937fa.tar.xz akcom-udpecho-01eb6398c572fe34f98be8ececa0fcc4f19937fa.zip | |
docs: adding usage information to README
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
| @@ -76,6 +76,24 @@ attempt to determine the variant by examining the __TestRespSN__, | |||
| 76 | __TestRespRecvTimeStamp__, and __TestRespReplyTimeStamp__ fields of the | 76 | __TestRespRecvTimeStamp__, and __TestRespReplyTimeStamp__ fields of the |
| 77 | UDPEchoPlus packet for non-zero values. | 77 | UDPEchoPlus packet for non-zero values. |
| 78 | 78 | ||
| 79 | _akcom-udpecho_ usage: | ||
| 80 | |||
| 81 | Usage: akcom-udpecho [options] host [port] | ||
| 82 | OPTIONS: | ||
| 83 | -4 connect via IPv4 only | ||
| 84 | -6 connect via IPv6 only | ||
| 85 | -c count stop after sending count packets | ||
| 86 | -d, --debug print packet debugging information | ||
| 87 | -e, --echoplus expect echo plus response (default: auto detect) | ||
| 88 | -h, --help print this help and exit | ||
| 89 | -i interval interval between packet (default: 1 sec) | ||
| 90 | -r, --rfc expect RFC compliant response (default: auto detect) | ||
| 91 | -q, --quiet, --silent do not print messages | ||
| 92 | -s packetsize size of data bytes to be sent. (default: 40 bytes) | ||
| 93 | -t sec response timeout (default: 5 sec) | ||
| 94 | -v, --verbose enable verbose output | ||
| 95 | -V, --version print version number and exit | ||
| 96 | |||
| 79 | Example usage (RFC 862 compliant): | 97 | Example usage (RFC 862 compliant): |
| 80 | 98 | ||
| 81 | $ akcom-udpecho -c 5 --rfc udpecho.example.com 30006 | 99 | $ akcom-udpecho -c 5 --rfc udpecho.example.com 30006 |
| @@ -116,6 +134,25 @@ _akcom-udpechod_ processes each packet sequentially which causes all packets | |||
| 116 | received before previous packets have been processed to be skewed when using | 134 | received before previous packets have been processed to be skewed when using |
| 117 | the __drop__ and __delay__ features. | 135 | the __drop__ and __delay__ features. |
| 118 | 136 | ||
| 137 | _akcom-udpechod_ usage: | ||
| 138 | |||
| 139 | Usage: akcom-udpechod [options] | ||
| 140 | OPTIONS: | ||
| 141 | -d num, --drop=num set packet drop probability [0-99] (default: 0%) | ||
| 142 | -D usec, --delay=usec set echo delay range to microseconds (default: 0 us) | ||
| 143 | -e, --echoplus enable echo plus, not RFC compliant | ||
| 144 | -f str, --facility=str set syslog facility (default: daemon) | ||
| 145 | -g gid, --group=gid setgid to gid (default: none) | ||
| 146 | -h, --help print this help and exit | ||
| 147 | -l addr, --listen=addr bind to IP address (default: all) | ||
| 148 | -n, --foreground do not fork | ||
| 149 | -p port, --port=port list on port number (default: 30006) | ||
| 150 | -P file, --pidfile=file PID file (default: /var/run/akcom-udpechod.pid) | ||
| 151 | -r, --rfc RFC compliant echo protocol (default) | ||
| 152 | -u uid, --user=uid setuid to uid (default: none) | ||
| 153 | -v, --verbose enable verbose output | ||
| 154 | -V, --version print version number and exit | ||
| 155 | |||
| 119 | Example usage (RFC 862 compliant): | 156 | Example usage (RFC 862 compliant): |
| 120 | 157 | ||
| 121 | akcom-udpechod \ | 158 | akcom-udpechod \ |
