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

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()
        !             6:     bf(arping) [-abdDeFhpqrRd0uv] [-S em(host/ip)] [-T em(host/ip)] [-s em(MAC)]    \
        !             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.
        !            54:     dit(-d) Find duplicate replies. Exit with 1 if there are answers from
        !            55:         two different MAC addresses.
        !            56:     dit(-D) Display answers as dots and missing packets as exclamation points.
        !            57:         Like flood ping on a Cisco.
        !            58:     dit(-e) Like -a but beep when there is no reply.
        !            59:     dit(-F) Don't try to be smart about the interface name. Even if this
        !            60: switch is not given, -i disables this smartness.
        !            61:     dit(-h) Displays a help message and exits.
        !            62:     dit(-i em(interface)) Don't guess, use the specified interface.
        !            63:     dit(-p) Turn on promiscious mode on interface, use this if you don't
        !            64:             "own" the MAC address you are using.
        !            65:     dit(-q) Does not display messages, except error messages.
        !            66:     dit(-r) Raw output: only the MAC/IP address is displayed for each reply.
        !            67:     dit(-R) Raw output: Like -r but shows "the other one", can be combined with
        !            68: -r.
        !            69:     dit(-s em(MAC)) Set source MAC address. You may need to use -p with this.
        !            70:     dit(-S em(IP)) Like -b and -0 but with set source address.
        !            71: Note that this may get the arping unanswered if the target does not have
        !            72: routing to the IP. If you don't own the IP you are using, you may need to turn
        !            73: on promiscious mode on the interface (with -p). With this switch you can find
        !            74: out what IP-address a host has without taking an IP-address yourself.
        !            75:     dit(-t em(MAC)) Set target MAC address to use when pinging IP address.
        !            76:     dit(-T em(IP)) Use -T as target address when pinging MACs that won't
        !            77: respond to a broadcast ping but perhaps to a directed broadcast.
        !            78: 
        !            79: em(Example):                                                                \
        !            80:        To check the address of MAC-A, use knowledge of MAC-B and IP-B.
        !            81: 
        !            82:        $ arping -S <IP-B> -s <MAC-B> -p <MAC-A>
        !            83:     dit(-u) Show index=received/sent instead of just index=received when
        !            84:        pinging MACs.
        !            85:     dit(-v) Verbose output. Use twice for more messages.
        !            86:     dit(-w) Time to wait between pings, in microseconds.
        !            87: enddit()
        !            88: 
        !            89: 
        !            90: manpagesection(EXAMPLES)
        !            91: mancommand(.nf)
        !            92: mancommand(.sp)
        !            93:   # bf(arping -c 3 88.123.180.225)
        !            94:   ARPING 88.123.180.225
        !            95:   60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=0 time=13.910 msec
        !            96:   60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=1 time=13.935 msec
        !            97:   60 bytes from 00:11:85:4c:01:01 (88.123.180.225): index=2 time=13.944 msec
        !            98: 
        !            99:   --- 88.123.180.225 statistics ---
        !           100:   3 packets transmitted, 3 packets received,   0% unanswered
        !           101: 
        !           102:   # bf(arping -c 3 00:11:85:4c:01:01)
        !           103:   ARPING 00:11:85:4c:01:01
        !           104:   60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=0 time=13.367 msec
        !           105:   60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=1 time=13.929 msec
        !           106:   60 bytes from 88.123.180.225 (00:11:85:4c:01:01): icmp_seq=2 time=13.929 msec
        !           107: 
        !           108:   --- 00:11:85:4c:01:01 statistics ---
        !           109:   3 packets transmitted, 3 packets received,   0% unanswered
        !           110: 
        !           111: mancommand(.fi)
        !           112: mancommand(.in)
        !           113: 
        !           114: 
        !           115: manpagebugs()
        !           116: 
        !           117:        You have to use -B instead of arpinging 255.255.255.255, and -b
        !           118:        instead of -S 255.255.255.255. This is libnets fault.
        !           119: 
        !           120: manpageseealso()
        !           121: 
        !           122:     bf(ping(8)), bf(arp(8)), bf(rarp(8))
        !           123: 
        !           124: manpageauthor()
        !           125: 
        !           126:     Arping was written by Thomas Habets <thomas@habets.pp.se>.
        !           127: 
        !           128:     http://www.habets.pp.se/synscan/
        !           129: 
        !           130:     git clone http://github.com/ThomasHabets/arping.git

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