File: arping.sgml

package info (click to toggle)
iputils 3%3A20100418-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 836 kB
  • ctags: 1,040
  • sloc: ansic: 8,452; perl: 585; makefile: 169; sh: 37
file content (222 lines) | stat: -rw-r--r-- 6,044 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<refentry id="arping">

<refmeta>
<refentrytitle>arping</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>iputils-&snapshot;</refmiscinfo>
</refmeta>


<refnamediv>
<refname>arping</refname>
<refpurpose>send ARP REQUEST to a neighbour host</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>arping</command>
<arg choice="opt"><option>-AbDfhqUV</option></arg>
<arg choice="opt">-c <replaceable/count/</arg>
<arg choice="opt">-w <replaceable/deadline/</arg>
<arg choice="opt">-s <replaceable/source/</arg>
<arg choice="req">-I <replaceable/interface/</arg>
<arg choice="req"><replaceable/destination/</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>DESCRIPTION</title>
<para>
Ping <replaceable/destination/ on device <replaceable/interface/ by ARP packets,
using source address <replaceable/source/.
</para>
</refsect1>

<refsect1><title>OPTIONS</title>

<variablelist>

 <varlistentry>
  <term><option/-A/</term>
  <listitem><para>
The same as <option/-U/, but ARP REPLY packets used instead
of ARP REQUEST.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option>-b</option></term>
  <listitem><para>
Send only MAC level broadcasts. Normally <command/arping/ starts
from sending broadcast, and switch to unicast after reply received.
  </para></listitem>
 </varlistentry>


 <varlistentry>
  <term><option><anchor id="arping.count">-c <replaceable/count/</option></term>
  <listitem><para>
Stop after sending <replaceable/count/ ARP REQUEST
packets. With 
<link linkend="arping.deadline"><replaceable/deadline/</link>
option, <command/arping/ waits for
<replaceable/count/ ARP REPLY packets, until the timeout expires.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option/-D/</term>
  <listitem><para>
Duplicate address detection mode (DAD). See 
<ulink url="ftp://ftp.isi.edu/in-notes/rfc2131.txt">RFC2131, 4.4.1</ulink>.
Returns 0, if DAD succeeded i.e. no replies are received
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option>-f</option></term>
  <listitem><para>
Finish after the first reply confirming that target is alive.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option><anchor id="opt.interface">-I <replaceable/interface/</option></term>
  <listitem><para>
Name of network device where to send ARP REQUEST packets. This option
is required.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option>-h</option></term>
  <listitem><para>
Print help page and exit.
  </para></listitem>
 </varlistentry>


 <varlistentry>
  <term><option/-q/</term>
  <listitem><para>
Quiet output. Nothing is displayed.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option><anchor id="opt.source">-s <replaceable/source/</option></term>
  <listitem><para>
IP source address to use in ARP packets.
If this option is absent, source address is:
   <itemizedlist>
    <listitem><para>
In DAD mode (with option <option/-D/) set to 0.0.0.0.
    </para></listitem>
    <listitem><para>
In Unsolicited ARP mode (with options <option/-U/ or <option/-A/)
set to <replaceable/destination/.
    </para></listitem>
    <listitem><para>
Otherwise, it is calculated from routing tables.
    </para></listitem>
   </itemizedlist>
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option/-U/</term>
  <listitem><para>
Unsolicited ARP mode to update neighbours' ARP caches.
No replies are expected.
  </para></listitem>
 </varlistentry>

 <varlistentry>
  <term><option>-V</option></term>
  <listitem><para>
Print version of the program and exit.
  </para></listitem>
 </varlistentry>


 <varlistentry>
  <term><option><anchor id="arping.deadline">-w <replaceable/deadline/</option></term>
  <listitem><para>
Specify a timeout, in seconds, before
<command/arping/
exits regardless of how many
packets have been sent or received. In this case
<command/arping/
does not stop after
<link linkend="arping.count"><replaceable/count/</link>
packet are sent, it waits either for
<link linkend="arping.deadline"><replaceable/deadline/</link>
expire or until
<link linkend="arping.count"><replaceable/count/</link>
probes are answered.
  </para></listitem>
 </varlistentry>
</variablelist>
</refsect1>

<refsect1><title>SEE ALSO</title>
<para>
<link linkend="ping">
<citerefentry><refentrytitle/ping/<manvolnum/8/</citerefentry></link>,
<link linkend="clockdiff">
<citerefentry><refentrytitle/clockdiff/<manvolnum/8/</citerefentry></link>,
<link linkend="tracepath">
<citerefentry><refentrytitle/tracepath/<manvolnum/8/</citerefentry></link>.
</para>
</refsect1>

<refsect1><title>AUTHOR</title>
<para>
<command/arping/ was written by
<ulink url="mailto:kuznet@ms2.inr.ac.ru">Alexey Kuznetsov
&lt;kuznet@ms2.inr.ac.ru&gt;</ulink>.
It is now maintained by
<ulink url="mailto:yoshfuji@skbuff.net">YOSHIFUJI Hideaki
&lt;yoshfuji@skbuff.net&gt;</ulink>.
</para>
</refsect1>

<refsect1><title>SECURITY</title>
<para>
<command/arping/ requires <constant/CAP_NET_RAWIO/ capability
to be executed. It is not recommended to be used as set-uid root,
because it allows user to modify ARP caches of neighbour hosts.
</para>
</refsect1>

<refsect1><title>AVAILABILITY</title>
<para>
<command/arping/ is part of <filename/iputils/ package
and the latest versions are  available in source form at
<ulink url="http://www.skbuff.net/iputils/iputils-current.tar.bz2">
http://www.skbuff.net/iputils/iputils-current.tar.bz2</ulink>.
</para>
</refsect1>

<![IGNORE[
<refsect1><title>COPYING</title>
<para>
<literallayout>
This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public
License Version 2.

This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
 
For more details see the file COPYING in the source
distribution of Linux kernel of version 2.4.
</literallayout>
</para>
</refsect1>
]]>



</refentry>