File: arping.xml

package info (click to toggle)
iputils 3%3A20240905-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,700 kB
  • sloc: ansic: 6,002; xml: 1,797; sh: 538; makefile: 28
file content (274 lines) | stat: -rw-r--r-- 8,106 bytes parent folder | download | duplicates (2)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:id="man.arping">

  <refentryinfo>
    <title>arping</title>
    <productname>iputils</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>
      <application>arping</application>
    </refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='manual'>iputils</refmiscinfo>
  </refmeta>

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

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

  <refsection xml:id="description">
    <info>
      <title>DESCRIPTION</title>
    </info>
    <para>Ping
    <emphasis remap="I">destination</emphasis> on device
    <emphasis remap="I">interface</emphasis> by ARP packets, using
    source address
    <emphasis remap="I">source</emphasis>.</para>
    <para>arping supports IPv4 addresses only. For IPv6, see
    <citerefentry>
      <refentrytitle>ndisc6</refentrytitle>
      <manvolnum>8</manvolnum>
    </citerefentry>.</para>
  </refsection>

  <refsection xml:id="options">
    <info>
      <title>OPTIONS</title>
    </info>
    <variablelist remap='TP'>
      <varlistentry>
        <term>
          <option>-A</option>
        </term>
        <listitem>
          <para>The same as
          <option>-U</option>, 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</command> starts from sending broadcast,
          and switch to unicast after reply received.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-c
          <replaceable>count</replaceable></option>
        </term>
        <listitem>
          <para>Stop after sending
          <emphasis remap="I">count</emphasis> ARP REQUEST packets.
          With
          <emphasis remap="I">deadline</emphasis> option, instead
          wait for
          <emphasis remap="I">count</emphasis> ARP REPLY packets, or
          until the timeout expires.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-D</option>
        </term>
        <listitem>
          <para>Duplicate address detection mode (DAD). See
          RFC2131, 4.4.1. 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>-I
          <replaceable>interface</replaceable></option>
        </term>
        <listitem>
          <para>Name of network device where to send ARP REQUEST
          packets.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-h</option>
        </term>
        <listitem>
          <para>Print help page and exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-q</option>
        </term>
        <listitem>
          <para>Quiet output. Nothing is displayed.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-s
          <replaceable>source</replaceable></option>
        </term>
        <listitem>
          <para>IP source address to use in ARP packets. If this
          option is absent, source address is:</para>
          <variablelist remap='TP'>
            <varlistentry>
              <listitem>
                <para>• In DAD mode (with option
                <option>-D</option>) set to 0.0.0.0.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <listitem>
                <para>• In Unsolicited ARP mode (with options
                <option>-U</option> or
                <option>-A</option>) set to
                <emphasis remap='I'>destination</emphasis>.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <listitem>
                <para>• Otherwise, it is calculated from routing
                tables.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-U</option>
        </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>-w
          <replaceable>deadline</replaceable></option>
        </term>
        <listitem>
          <para>Specify a timeout, in seconds, before
          <command>arping</command> exits regardless of how many
          packets have been sent or received.  If any replies are
          received, exit with status 0, otherwise status 1.  When
          combined with the <emphasis remap="I">count</emphasis>
          option, exit with status 0 if <emphasis
          remap="I">count</emphasis> replies are received before the
          deadline expiration, otherwise status 1.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-i
          <replaceable>interval</replaceable></option>
        </term>
        <listitem>
          <para>Specify an interval, in seconds, between
          packets.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
    <citerefentry>
      <refentrytitle>ndisc6</refentrytitle>
      <manvolnum>8</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>ping</refentrytitle>
      <manvolnum>8</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>clockdiff</refentrytitle>
      <manvolnum>8</manvolnum>
    </citerefentry>,
    <citerefentry>
      <refentrytitle>tracepath</refentrytitle>
      <manvolnum>8</manvolnum>
    </citerefentry>.</para>
  </refsect1>

  <refsect1 id='author'>
    <title>AUTHOR</title>
    <para>
    <command>arping</command> was written by Alexey Kuznetsov
    &lt;kuznet@ms2.inr.ac.ru&gt;.</para>
  </refsect1>

  <refsect1 id='security'>
    <title>SECURITY</title>
    <para>
    <command>arping</command> requires CAP_NET_RAW 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 id='availability'>
    <title>AVAILABILITY</title>
    <para>
    <command>arping</command> is part of
    <emphasis remap='I'>iputils</emphasis> package.</para>
  </refsect1>
</refentry>