Home | History | Annotate | Download | only in doc
      1 <refentry id="arping">
      2 
      3 <refmeta>
      4 <refentrytitle>arping</refentrytitle>
      5 <manvolnum>8</manvolnum>
      6 <refmiscinfo>iputils-&snapshot;</refmiscinfo>
      7 </refmeta>
      8 
      9 
     10 <refnamediv>
     11 <refname>arping</refname>
     12 <refpurpose>send ARP REQUEST to a neighbour host</refpurpose>
     13 </refnamediv>
     14 
     15 <refsynopsisdiv>
     16 <cmdsynopsis>
     17 <command>arping</command>
     18 <arg choice="opt"><option>-AbDfhqUV</option></arg>
     19 <arg choice="opt">-c <replaceable/count/</arg>
     20 <arg choice="opt">-w <replaceable/deadline/</arg>
     21 <arg choice="opt">-s <replaceable/source/</arg>
     22 <arg choice="req">-I <replaceable/interface/</arg>
     23 <arg choice="req"><replaceable/destination/</arg>
     24 </cmdsynopsis>
     25 </refsynopsisdiv>
     26 
     27 <refsect1><title>DESCRIPTION</title>
     28 <para>
     29 Ping <replaceable/destination/ on device <replaceable/interface/ by ARP packets,
     30 using source address <replaceable/source/.
     31 </para>
     32 </refsect1>
     33 
     34 <refsect1><title>OPTIONS</title>
     35 
     36 <variablelist>
     37 
     38  <varlistentry>
     39   <term><option/-A/</term>
     40   <listitem><para>
     41 The same as <option/-U/, but ARP REPLY packets used instead
     42 of ARP REQUEST.
     43   </para></listitem>
     44  </varlistentry>
     45 
     46  <varlistentry>
     47   <term><option>-b</option></term>
     48   <listitem><para>
     49 Send only MAC level broadcasts. Normally <command/arping/ starts
     50 from sending broadcast, and switch to unicast after reply received.
     51   </para></listitem>
     52  </varlistentry>
     53 
     54 
     55  <varlistentry>
     56   <term><option><anchor id="arping.count">-c <replaceable/count/</option></term>
     57   <listitem><para>
     58 Stop after sending <replaceable/count/ ARP REQUEST
     59 packets. With 
     60 <link linkend="arping.deadline"><replaceable/deadline/</link>
     61 option, <command/arping/ waits for
     62 <replaceable/count/ ARP REPLY packets, until the timeout expires.
     63   </para></listitem>
     64  </varlistentry>
     65 
     66  <varlistentry>
     67   <term><option/-D/</term>
     68   <listitem><para>
     69 Duplicate address detection mode (DAD). See 
     70 <ulink url="http://tools.ietf.org/rfc/rfc2131.txt">RFC2131, 4.4.1</ulink>.
     71 Returns 0, if DAD succeeded i.e. no replies are received
     72   </para></listitem>
     73  </varlistentry>
     74 
     75  <varlistentry>
     76   <term><option>-f</option></term>
     77   <listitem><para>
     78 Finish after the first reply confirming that target is alive.
     79   </para></listitem>
     80  </varlistentry>
     81 
     82  <varlistentry>
     83   <term><option><anchor id="opt.interface">-I <replaceable/interface/</option></term>
     84   <listitem><para>
     85 Name of network device where to send ARP REQUEST packets.
     86   </para></listitem>
     87  </varlistentry>
     88 
     89  <varlistentry>
     90   <term><option>-h</option></term>
     91   <listitem><para>
     92 Print help page and exit.
     93   </para></listitem>
     94  </varlistentry>
     95 
     96 
     97  <varlistentry>
     98   <term><option/-q/</term>
     99   <listitem><para>
    100 Quiet output. Nothing is displayed.
    101   </para></listitem>
    102  </varlistentry>
    103 
    104  <varlistentry>
    105   <term><option><anchor id="opt.source">-s <replaceable/source/</option></term>
    106   <listitem><para>
    107 IP source address to use in ARP packets.
    108 If this option is absent, source address is:
    109    <itemizedlist>
    110     <listitem><para>
    111 In DAD mode (with option <option/-D/) set to 0.0.0.0.
    112     </para></listitem>
    113     <listitem><para>
    114 In Unsolicited ARP mode (with options <option/-U/ or <option/-A/)
    115 set to <replaceable/destination/.
    116     </para></listitem>
    117     <listitem><para>
    118 Otherwise, it is calculated from routing tables.
    119     </para></listitem>
    120    </itemizedlist>
    121   </para></listitem>
    122  </varlistentry>
    123 
    124  <varlistentry>
    125   <term><option/-U/</term>
    126   <listitem><para>
    127 Unsolicited ARP mode to update neighbours' ARP caches.
    128 No replies are expected.
    129   </para></listitem>
    130  </varlistentry>
    131 
    132  <varlistentry>
    133   <term><option>-V</option></term>
    134   <listitem><para>
    135 Print version of the program and exit.
    136   </para></listitem>
    137  </varlistentry>
    138 
    139 
    140  <varlistentry>
    141   <term><option><anchor id="arping.deadline">-w <replaceable/deadline/</option></term>
    142   <listitem><para>
    143 Specify a timeout, in seconds, before
    144 <command/arping/
    145 exits regardless of how many
    146 packets have been sent or received. In this case
    147 <command/arping/
    148 does not stop after
    149 <link linkend="arping.count"><replaceable/count/</link>
    150 packet are sent, it waits either for
    151 <link linkend="arping.deadline"><replaceable/deadline/</link>
    152 expire or until
    153 <link linkend="arping.count"><replaceable/count/</link>
    154 probes are answered.
    155   </para></listitem>
    156  </varlistentry>
    157 </variablelist>
    158 </refsect1>
    159 
    160 <refsect1><title>SEE ALSO</title>
    161 <para>
    162 <link linkend="ping">
    163 <citerefentry><refentrytitle/ping/<manvolnum/8/</citerefentry></link>,
    164 <link linkend="clockdiff">
    165 <citerefentry><refentrytitle/clockdiff/<manvolnum/8/</citerefentry></link>,
    166 <link linkend="tracepath">
    167 <citerefentry><refentrytitle/tracepath/<manvolnum/8/</citerefentry></link>.
    168 </para>
    169 </refsect1>
    170 
    171 <refsect1><title>AUTHOR</title>
    172 <para>
    173 <command/arping/ was written by
    174 <ulink url="mailto:kuznet (a] ms2.inr.ac.ru">Alexey Kuznetsov
    175 &lt;kuznet (a] ms2.inr.ac.ru&gt;</ulink>.
    176 It is now maintained by
    177 <ulink url="mailto:yoshfuji (a] skbuff.net">YOSHIFUJI Hideaki
    178 &lt;yoshfuji (a] skbuff.net&gt;</ulink>.
    179 </para>
    180 </refsect1>
    181 
    182 <refsect1><title>SECURITY</title>
    183 <para>
    184 <command/arping/ requires <constant/CAP_NET_RAW/ capability
    185 to be executed. It is not recommended to be used as set-uid root,
    186 because it allows user to modify ARP caches of neighbour hosts.
    187 </para>
    188 </refsect1>
    189 
    190 <refsect1><title>AVAILABILITY</title>
    191 <para>
    192 <command/arping/ is part of <filename/iputils/ package
    193 and the latest versions are  available in source form at
    194 <ulink url="http://www.skbuff.net/iputils/iputils-current.tar.bz2">
    195 http://www.skbuff.net/iputils/iputils-current.tar.bz2</ulink>.
    196 </para>
    197 </refsect1>
    198 
    199 <![IGNORE[
    200 <refsect1><title>COPYING</title>
    201 <para>
    202 <literallayout>
    203 This documentation is free software; you can redistribute
    204 it and/or modify it under the terms of the GNU General Public
    205 License Version 2.
    206 
    207 This program is distributed in the hope that it will be
    208 useful, but WITHOUT ANY WARRANTY; without even the implied
    209 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    210 See the GNU General Public License for more details.
    211  
    212 For more details see the file COPYING in the source
    213 distribution of Linux kernel of version 2.4.
    214 </literallayout>
    215 </para>
    216 </refsect1>
    217 ]]>
    218 
    219 
    220 
    221 </refentry>
    222