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>
29Ping <replaceable/destination/ on device <replaceable/interface/ by ARP packets,
30using 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>
41The same as <option/-U/, but ARP REPLY packets used instead
42of ARP REQUEST.
43  </para></listitem>
44 </varlistentry>
45
46 <varlistentry>
47  <term><option>-b</option></term>
48  <listitem><para>
49Send only MAC level broadcasts. Normally <command/arping/ starts
50from 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>
58Stop after sending <replaceable/count/ ARP REQUEST
59packets. With 
60<link linkend="arping.deadline"><replaceable/deadline/</link>
61option, <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>
69Duplicate address detection mode (DAD). See 
70<ulink url="ftp://ftp.isi.edu/in-notes/rfc2131.txt">RFC2131, 4.4.1</ulink>.
71Returns 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>
78Finish 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>
85Name of network device where to send ARP REQUEST packets. This option
86is required.
87  </para></listitem>
88 </varlistentry>
89
90 <varlistentry>
91  <term><option>-h</option></term>
92  <listitem><para>
93Print help page and exit.
94  </para></listitem>
95 </varlistentry>
96
97
98 <varlistentry>
99  <term><option/-q/</term>
100  <listitem><para>
101Quiet output. Nothing is displayed.
102  </para></listitem>
103 </varlistentry>
104
105 <varlistentry>
106  <term><option><anchor id="opt.source">-s <replaceable/source/</option></term>
107  <listitem><para>
108IP source address to use in ARP packets.
109If this option is absent, source address is:
110   <itemizedlist>
111    <listitem><para>
112In DAD mode (with option <option/-D/) set to 0.0.0.0.
113    </para></listitem>
114    <listitem><para>
115In Unsolicited ARP mode (with options <option/-U/ or <option/-A/)
116set to <replaceable/destination/.
117    </para></listitem>
118    <listitem><para>
119Otherwise, it is calculated from routing tables.
120    </para></listitem>
121   </itemizedlist>
122  </para></listitem>
123 </varlistentry>
124
125 <varlistentry>
126  <term><option/-U/</term>
127  <listitem><para>
128Unsolicited ARP mode to update neighbours' ARP caches.
129No replies are expected.
130  </para></listitem>
131 </varlistentry>
132
133 <varlistentry>
134  <term><option>-V</option></term>
135  <listitem><para>
136Print version of the program and exit.
137  </para></listitem>
138 </varlistentry>
139
140
141 <varlistentry>
142  <term><option><anchor id="arping.deadline">-w <replaceable/deadline/</option></term>
143  <listitem><para>
144Specify a timeout, in seconds, before
145<command/arping/
146exits regardless of how many
147packets have been sent or received. In this case
148<command/arping/
149does not stop after
150<link linkend="arping.count"><replaceable/count/</link>
151packet are sent, it waits either for
152<link linkend="arping.deadline"><replaceable/deadline/</link>
153expire or until
154<link linkend="arping.count"><replaceable/count/</link>
155probes are answered.
156  </para></listitem>
157 </varlistentry>
158</variablelist>
159</refsect1>
160
161<refsect1><title>SEE ALSO</title>
162<para>
163<link linkend="ping">
164<citerefentry><refentrytitle/ping/<manvolnum/8/</citerefentry></link>,
165<link linkend="clockdiff">
166<citerefentry><refentrytitle/clockdiff/<manvolnum/8/</citerefentry></link>,
167<link linkend="tracepath">
168<citerefentry><refentrytitle/tracepath/<manvolnum/8/</citerefentry></link>.
169</para>
170</refsect1>
171
172<refsect1><title>AUTHOR</title>
173<para>
174<command/arping/ was written by
175<ulink url="mailto:kuznet@ms2.inr.ac.ru">Alexey Kuznetsov
176&lt;kuznet@ms2.inr.ac.ru&gt;</ulink>.
177</para>
178</refsect1>
179
180<refsect1><title>SECURITY</title>
181<para>
182<command/arping/ requires <constant/CAP_NET_RAWIO/ capability
183to be executed. It is not recommended to be used as set-uid root,
184because it allows user to modify ARP caches of neighbour hosts.
185</para>
186</refsect1>
187
188<refsect1><title>AVAILABILITY</title>
189<para>
190<command/arping/ is part of <filename/iputils/ package
191and the latest versions are  available in source form for anonymous ftp
192<ulink url="ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz">
193ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz</ulink>.
194</para>
195</refsect1>
196
197<![IGNORE[
198<refsect1><title>COPYING</title>
199<para>
200<literallayout>
201This documentation is free software; you can redistribute
202it and/or modify it under the terms of the GNU General Public
203License Version 2.
204
205This program is distributed in the hope that it will be
206useful, but WITHOUT ANY WARRANTY; without even the implied
207warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
208See the GNU General Public License for more details.
209 
210For more details see the file COPYING in the source
211distribution of Linux kernel of version 2.4.
212</literallayout>
213</para>
214</refsect1>
215]]>
216
217
218
219</refentry>
220