Annotation of embedaddon/arping/doc/arping.yodl, revision 1.1.1.3

1.1       misho       1: manpage(arping)(8)(21th June, 2003)(arping)()
                      2: 
                      3: manpagename(arping)(sends arp and/or ip pings to a given host)
                      4: 
                      5: manpagesynopsis()
1.1.1.2   misho       6:     bf(arping) [-0aAbBdDeFhpqrRuUv] [-S em(host/ip)] [-T em(host/ip)] [-s em(MAC)]    \
1.1       misho       7: [-t em(MAC)] [-c em(count)] [-i em(interface)] [ -w em(us) ] <em(host) | -B>
                      8: 
                      9:     bf(arping) --help
                     10: 
                     11: manpagedescription()
                     12:     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.
                     13: 
                     14:     One request is sent each second.
                     15: 
                     16:     When pinging an IP an ARP who-has query is sent. When pinging a MAC
                     17:     address a directed broadcast ICMP Echo request is sent. For more
                     18:     technical explaination and an FAQ, see the README file.
                     19: 
                     20:     em(Note on timing)
                     21: 
                     22:     ARP packets are usually replied to (on a LAN) so fast that the OS task
                     23:     scheduler can't keep up to get exact enough timing.
                     24:     On an idle system the roundtrip times will be pretty much accurate, but
                     25:     with more load the timing gets less exact.
                     26: 
                     27:     To get more exact timing on a non-idle system, re-nice arping to -15 or so.
                     28: 
                     29:     # nice -n -15 arping foobar
                     30: 
                     31:     This is not just an issue with arping, it is with normal ping also
                     32:     (at least it is on my system). But it doesn't show up as much with ping
                     33:     since arping packets (when pinging IP) doesn't traverse the IP stack when
                     34:     received and are therefore replied to faster.
                     35: 
                     36: manpageoptions()
                     37: 
                     38: startdit()
                     39:     dit(--help) Show extended help. Not quite as extensive as this manpage,
                     40:         but more than -h.
                     41:     dit(-0) Use this option to ping with source IP address 0.0.0.0. Use this
                     42:        when you haven't configured your interface yet.
                     43:        Note that this may get the MAC-ping unanswered.
                     44:        This is an alias for -S 0.0.0.0.
                     45:     dit(-a) Audible ping.
                     46:     dit(-A) Only count addresses matching requested address (This *WILL*
                     47:        break most things you do. Only useful if you are arpinging many
                     48:        hosts at once. See arping-scan-net.sh for an example).
                     49:     dit(-b) Like -0 but source broadcast source address (255.255.255.255).
                     50: Note that this may get the arping unanswered since it's not normal behavior
                     51: for a host.
                     52:     dit(-B) Use instead of host if you want to address 255.255.255.255.
                     53:     dit(-c em(count)) Only send em(count) requests.
1.1.1.3 ! misho      54:     dit(-C em(count)) Only wait for em(count) replies, regardless of -c and -w.
1.1       misho      55:     dit(-d) Find duplicate replies. Exit with 1 if there are answers from
                     56:         two different MAC addresses.
1.1.1.2   misho      57:     dit(-D) Display answers as exclamation points and missing packets as dots.
1.1       misho      58:         Like flood ping on a Cisco.
                     59:     dit(-e) Like -a but beep when there is no reply.
                     60:     dit(-F) Don't try to be smart about the interface name. Even if this
                     61: switch is not given, -i disables this smartness.
                     62:     dit(-h) Displays a help message and exits.
                     63:     dit(-i em(interface)) Don't guess, use the specified interface.
1.1.1.3 ! misho      64:     dit(-m em(type)) Type of timestamp to use for incoming packets.
        !            65:         Use -vv when pinging to list available ones.
1.1       misho      66:     dit(-p) Turn on promiscious mode on interface, use this if you don't
                     67:             "own" the MAC address you are using.
1.1.1.3 ! misho      68:     dit(-P) Send ARP replies instead of requests. Useful with -U.
1.1       misho      69:     dit(-q) Does not display messages, except error messages.
                     70:     dit(-r) Raw output: only the MAC/IP address is displayed for each reply.
                     71:     dit(-R) Raw output: Like -r but shows "the other one", can be combined with
                     72: -r.
                     73:     dit(-s em(MAC)) Set source MAC address. You may need to use -p with this.
                     74:     dit(-S em(IP)) Like -b and -0 but with set source address.
                     75: Note that this may get the arping unanswered if the target does not have
                     76: routing to the IP. If you don't own the IP you are using, you may need to turn
                     77: on promiscious mode on the interface (with -p). With this switch you can find
                     78: out what IP-address a host has without taking an IP-address yourself.
                     79:     dit(-t em(MAC)) Set target MAC address to use when pinging IP address.
                     80:     dit(-T em(IP)) Use -T as target address when pinging MACs that won't
                     81: respond to a broadcast ping but perhaps to a directed broadcast.
                     82: 
1.1.1.2   misho      83: em(Example):
                     84: mancommand(.nf)
                     85: mancommand(.sp)
1.1       misho      86:        To check the address of MAC-A, use knowledge of MAC-B and IP-B.
                     87: 
                     88:        $ arping -S <IP-B> -s <MAC-B> -p <MAC-A>
                     89:     dit(-u) Show index=received/sent instead of just index=received when
                     90:        pinging MACs.
1.1.1.2   misho      91:     dit(-U) Send unsolicited ARP. This sets the destination MAC address in
                     92:     the ARP frame to the broadcast address. Unsolicited ARP is used
                     93:     to update the neighbours' ARP caches.
                     94: 
                     95:        em(Example):
                     96:         mancommand(.nf)
                     97:         mancommand(.sp)
                     98:        $ arping -i <interface> -U <interface IP>
1.1       misho      99:     dit(-v) Verbose output. Use twice for more messages.
1.1.1.3 ! misho     100:     dit(-w em(usec)) Time to wait between pings, in microseconds.
        !           101:     dit(-W em(sec)) Same as -w, but in floating point seconds.
1.1       misho     102: enddit()
                    103: 
                    104: 
                    105: manpagesection(EXAMPLES)
                    106: mancommand(.nf)
                    107: mancommand(.sp)
1.1.1.2   misho     108:   # bf(arping -c 3 88.1.180.225)
                    109:   ARPING 88.1.180.225
                    110:   60 bytes from 00:11:85:4c:01:01 (88.1.180.225): index=0 time=13.910 msec
                    111:   60 bytes from 00:11:85:4c:01:01 (88.1.180.225): index=1 time=13.935 msec
                    112:   60 bytes from 00:11:85:4c:01:01 (88.1.180.225): index=2 time=13.944 msec
1.1       misho     113: 
1.1.1.2   misho     114:   --- 88.1.180.225 statistics ---
1.1       misho     115:   3 packets transmitted, 3 packets received,   0% unanswered
                    116: 
                    117:   # bf(arping -c 3 00:11:85:4c:01:01)
                    118:   ARPING 00:11:85:4c:01:01
1.1.1.2   misho     119:   60 bytes from 88.1.180.225 (00:11:85:4c:01:01): icmp_seq=0 time=13.367 msec
                    120:   60 bytes from 88.1.180.225 (00:11:85:4c:01:01): icmp_seq=1 time=13.929 msec
                    121:   60 bytes from 88.1.180.225 (00:11:85:4c:01:01): icmp_seq=2 time=13.929 msec
1.1       misho     122: 
                    123:   --- 00:11:85:4c:01:01 statistics ---
                    124:   3 packets transmitted, 3 packets received,   0% unanswered
1.1.1.3 ! misho     125: 
        !           126:   # bf(arping -C 2 -c 10 -r 88.1.180.225)
        !           127:   00:11:85:4c:01:01
        !           128:   00:11:85:4c:01:01
1.1       misho     129: 
                    130: mancommand(.fi)
                    131: mancommand(.in)
                    132: 
                    133: 
                    134: manpagebugs()
                    135: 
                    136:        You have to use -B instead of arpinging 255.255.255.255, and -b
                    137:        instead of -S 255.255.255.255. This is libnets fault.
                    138: 
                    139: manpageseealso()
                    140: 
                    141:     bf(ping(8)), bf(arp(8)), bf(rarp(8))
                    142: 
                    143: manpageauthor()
                    144: 
1.1.1.2   misho     145:     Arping was written by Thomas Habets <thomas@habets.se>.
1.1       misho     146: 
                    147:     http://www.habets.pp.se/synscan/
                    148: 
                    149:     git clone http://github.com/ThomasHabets/arping.git

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>