summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas Habets <habets@google.com>2016-11-23 13:51:02 +0000
committerThomas Habets <habets@google.com>2016-11-23 13:51:02 +0000
commit53087762c69291ab56d8fdbc46925613312a5f83 (patch)
treea9180dfd99e9172783208b98e684be32ad86d17c /doc
parent0ca1d6002d51abfcfd3eb9b09d607392acb21b59 (diff)
downloadarping-53087762c69291ab56d8fdbc46925613312a5f83.tar.gz
Make `arping` -w/-W behave like `ping` and `iputils-arping`
I think I did it in microseconds in the past because the ping I was looking at did that. But that was over 16 years ago so I could be wrong or it could have changed. Fixes #22
Diffstat (limited to 'doc')
-rw-r--r--doc/arping.88
-rw-r--r--doc/arping.yodl6
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/arping.8 b/doc/arping.8
index d2f96fd..7860dcf 100644
--- a/doc/arping.8
+++ b/doc/arping.8
@@ -5,7 +5,7 @@
arping \- sends arp and/or ip pings to a given host
.PP
.SH "SYNOPSIS"
-\fBarping\fP [\-0aAbBdDeFhpqrRuUv] [\-S \fIhost/ip\fP] [\-T \fIhost/ip\fP] [\-s \fIMAC\fP] [\-t \fIMAC\fP] [\-c \fIcount\fP] [\-i \fIinterface\fP] [ \-w \fIus\fP ] [ \-V \fIvlan\fP ] [ \-Q \fIpriority\fP ] <\fIhost\fP | \-B>
+\fBarping\fP [\-0aAbBdDeFhpqrRuUv] [\-S \fIhost/ip\fP] [\-T \fIhost/ip\fP] [\-s \fIMAC\fP] [\-t \fIMAC\fP] [\-c \fIcount\fP] [\-i \fIinterface\fP] [ \-w \fIseconds\fP ] [ \-W \fIseconds\fP ] [ \-V \fIvlan\fP ] [ \-Q \fIpriority\fP ] <\fIhost\fP | \-B>
.PP
\fBarping\fP \-\-help
.PP
@@ -130,10 +130,10 @@ $ arping \-i <interface> \-U <interface IP>
Verbose output\&. Use twice for more messages\&.
.IP "\-V \fIvlan\fP"
VLAN tag to set\&. Defaults to no VLAN tag\&.
-.IP "\-w \fIusec\fP"
-Time to wait between pings, in microseconds\&.
+.IP "\-w \fIsec\fP"
+Specify a timeout before ping exits regardless of how many packets have been sent or received\&.
.IP "\-W \fIsec\fP"
-Same as \-w, but in floating point seconds\&.
+Time to wait between pings\&.
.PP
.SH "EXAMPLES"
diff --git a/doc/arping.yodl b/doc/arping.yodl
index 67b81dd..7be341c 100644
--- a/doc/arping.yodl
+++ b/doc/arping.yodl
@@ -4,7 +4,7 @@ manpagename(arping)(sends arp and/or ip pings to a given host)
manpagesynopsis()
bf(arping) [-0aAbBdDeFhpqrRuUv] [-S em(host/ip)] [-T em(host/ip)] [-s em(MAC)] \
-[-t em(MAC)] [-c em(count)] [-i em(interface)] [ -w em(us) ] [ -V em(vlan) ] [ -Q em(priority) ] <em(host) | -B>
+[-t em(MAC)] [-c em(count)] [-i em(interface)] [ -w em(seconds) ] [ -W em(seconds) ] [ -V em(vlan) ] [ -Q em(priority) ] <em(host) | -B>
bf(arping) --help
@@ -100,8 +100,8 @@ mancommand(.sp)
$ arping -i <interface> -U <interface IP>
dit(-v) Verbose output. Use twice for more messages.
dit(-V em(vlan)) VLAN tag to set. Defaults to no VLAN tag.
- dit(-w em(usec)) Time to wait between pings, in microseconds.
- dit(-W em(sec)) Same as -w, but in floating point seconds.
+ dit(-w em(sec)) Specify a timeout before ping exits regardless of how many packets have been sent or received.
+ dit(-W em(sec)) Time to wait between pings.
enddit()