summaryrefslogtreecommitdiff
path: root/doc/arping.yodl
diff options
context:
space:
mode:
Diffstat (limited to 'doc/arping.yodl')
-rw-r--r--doc/arping.yodl128
1 files changed, 128 insertions, 0 deletions
diff --git a/doc/arping.yodl b/doc/arping.yodl
new file mode 100644
index 0000000..d2ead76
--- /dev/null
+++ b/doc/arping.yodl
@@ -0,0 +1,128 @@
+manpage(arping)(8)(21th June, 2003)(arping)()
+
+manpagename(arping)(sends arp and/or ip pings to a given host)
+
+manpagesynopsis()
+ bf(arping) [-abdDFhpqrRd0uv] [-S em(host/ip)] [-T em(host/ip)] [-s em(MAC)] \
+[-t em(MAC)] [-c em(count)] [-i em(interface)] [ -w em(us) ] <em(host) | -B>
+
+ bf(arping) --help
+
+manpagedescription()
+ The em(arping) utility sends bf(ARP) and/or bf(ICMP) requests to the specified em(host) and displays the replies. The em(host) may be specified by its bf(hostname), its bf(IP) address, or its bf(MAC) address.
+
+ One request is sent each second.
+
+ When pinging an IP an ARP who-has query is sent. When pinging a MAC
+ address a directed broadcast ICMP Echo request is sent. For more
+ technical explaination and an FAQ, see the README file.
+
+ em(Note on timing)
+
+ ARP packets are usually replied to (on a LAN) so fast that the OS task
+ scheduler can't keep up to get exact enough timing.
+ On an idle system the roundtrip times will be pretty much accurate, but
+ with more load the timing gets less exact.
+
+ To get more exact timing on a non-idle system, re-nice arping to -15 or so.
+
+ # nice -n -15 arping foobar
+
+ This is not just an issue with arping, it is with normal ping also
+ (at least it is on my system). But it doesn't show up as much with ping
+ since arping packets (when pinging IP) doesn't traverse the IP stack when
+ received and are therefore replied to faster.
+
+manpageoptions()
+
+startdit()
+ dit(--help) Show extended help. Not quite as extensive as this manpage,
+ but more than -h.
+ dit(-0) Use this option to ping with source IP address 0.0.0.0. Use this
+ when you haven't configured your interface yet.
+ Note that this may get the MAC-ping unanswered.
+ This is an alias for -S 0.0.0.0.
+ dit(-a) Audible ping.
+ dit(-A) Only count addresses matching requested address (This *WILL*
+ break most things you do. Only useful if you are arpinging many
+ hosts at once. See arping-scan-net.sh for an example).
+ dit(-b) Like -0 but source broadcast source address (255.255.255.255).
+Note that this may get the arping unanswered since it's not normal behavior
+for a host.
+ dit(-B) Use instead of host if you want to address 255.255.255.255.
+ dit(-c em(count)) Only send em(count) requests.
+ dit(-d) Find duplicate replies.
+ dit(-D) Display answers as dots and missing packets as exclamation points.
+ Like flood ping on a Cisco.
+ dit(-F) Don't try to be smart about the interface name. Even if this
+switch is not given, -i disables this smartness.
+ dit(-h) Displays a help message and exits.
+ dit(-i em(interface)) Don't guess, use the specified interface.
+ dit(-p) Turn on promiscious mode on interface, use this if you don't
+ "own" the MAC address you are using.
+ dit(-q) Does not display messages, except error messages.
+ dit(-r) Raw output: only the MAC/IP address is displayed for each reply.
+ dit(-R) Raw output: Like -r but shows "the other one", can be combined with
+-r.
+ dit(-s em(MAC)) Set source MAC address. You may need to use -p with this.
+ dit(-S em(IP)) Like -b and -0 but with set source address.
+Note that this may get the arping unanswered if the target does not have
+routing to the IP. If you don't own the IP you are using, you may need to turn
+on promiscious mode on the interface (with -p). With this switch you can find
+out what IP-address a host has without taking an IP-address yourself.
+ dit(-t em(MAC)) Set target MAC address to use when pinging IP address.
+ dit(-T em(IP)) Use -T as target address when pinging MACs that won't
+respond to a broadcast ping but perhaps to a directed broadcast.
+
+em(Example): \
+ To check the address of MAC-A, use knowledge of MAC-B and IP-B.
+
+ $ arping -S <IP-B> -s <MAC-B> -p <MAC-A>
+ dit(-u) Show index=received/sent instead of just index=received when
+ pinging MACs.
+ dit(-v) Verbose output. Use twice for more messages.
+ dit(-w) Time to wait between pings, in microseconds.
+enddit()
+
+
+manpagesection(EXAMPLES)
+mancommand(.nf)
+mancommand(.sp)
+ # bf(arping -c 3 88.123.180.225)
+ ARPING 88.123.180.225
+ 60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=0 time=13.910 msec
+ 60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=1 time=13.935 msec
+ 60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=2 time=13.944 msec
+
+ --- 88.123.180.225 statistics ---
+ 3 packets transmitted, 3 packets received, 0% unanswered
+
+ # bf(arping -c 3 00:11:85:4c:01:01)
+ ARPING 00:11:85:4c:01:01
+ 60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=0 time=13.367 msec
+ 60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=1 time=13.929 msec
+ 60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=2 time=13.929 msec
+
+ --- 00:11:85:4c:01:01 statistics ---
+ 3 packets transmitted, 3 packets received, 0% unanswered
+
+mancommand(.fi)
+mancommand(.in)
+
+
+manpagebugs()
+
+ You have to use -B instead of arpinging 255.255.255.255, and -b
+ instead of -S 255.255.255.255. This is libnets fault.
+
+manpageseealso()
+
+ bf(ping(8)), bf(arp(8)), bf(rarp(8))
+
+manpageauthor()
+
+ Arping was written by Thomas Habets <thomas@habets.pp.se>.
+
+ http://www.habets.pp.se/synscan/
+
+ git clone http://github.com/ThomasHabets/arping.git