Blame doc/arping.xml

Packit Service 6f2e62
Packit Service 6f2e62
Packit Service 6f2e62
                   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
Packit Service 6f2e62
Packit Service 6f2e62
<refentry id='arping8'>
Packit Service 6f2e62
<refmeta>
Packit Service 6f2e62
  <refentrytitle>ARPING</refentrytitle>
Packit Service 6f2e62
  <manvolnum>8</manvolnum>
Packit Service 6f2e62
  <refmiscinfo class='manual'>iputils</refmiscinfo>
Packit Service 6f2e62
</refmeta>
Packit Service 6f2e62
<refnamediv>
Packit Service 6f2e62
  <refname>arping</refname>
Packit Service 6f2e62
  <refpurpose>send ARP REQUEST to a neighbour host</refpurpose>
Packit Service 6f2e62
</refnamediv>
Packit Service 6f2e62
Packit Service 6f2e62
<refsynopsisdiv id='synopsis'>
Packit Service 6f2e62
  <cmdsynopsis>
Packit Service 6f2e62
    <command>arping</command>
Packit Service 6f2e62
    <arg choice='opt'>-AbDfhqUV </arg>
Packit Service 6f2e62
    <arg choice='opt'>-c <replaceable>count</replaceable></arg>
Packit Service 6f2e62
    <arg choice='opt'>-w <replaceable>deadline</replaceable></arg>
Packit Service 6f2e62
    <arg choice='opt'>-s <replaceable>source</replaceable></arg>
Packit Service 6f2e62
    <arg choice='opt'>-I <replaceable>interface</replaceable></arg>
Packit Service 6f2e62
    <arg choice='plain'><replaceable>destination</replaceable></arg>
Packit Service 6f2e62
    <sbr/>
Packit Service 6f2e62
  </cmdsynopsis>
Packit Service 6f2e62
</refsynopsisdiv>
Packit Service 6f2e62
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='description'>
Packit Service 6f2e62
  <title>DESCRIPTION</title>
Packit Service 6f2e62
  <para>Ping <emphasis remap='I'>destination</emphasis> on device <emphasis remap='I'>interface</emphasis> by ARP packets,
Packit Service 6f2e62
using source address <emphasis remap='I'>source</emphasis>.</para>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='options'><title>OPTIONS</title>
Packit Service 6f2e62
<variablelist remap='TP'>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
    <term><option>-A</option></term>
Packit Service 6f2e62
    <listitem>
Packit Service 6f2e62
      <para>The same as <option>-U</option>, but ARP REPLY packets used instead
Packit Service 6f2e62
of ARP REQUEST.</para>
Packit Service 6f2e62
    </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
    <term><option>-b</option></term>
Packit Service 6f2e62
    <listitem>
Packit Service 6f2e62
      <para>Send only MAC level broadcasts. Normally <command>arping</command> starts
Packit Service 6f2e62
from sending broadcast, and switch to unicast after reply received.</para>
Packit Service 6f2e62
    </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
    <term><option>-c </option><emphasis remap='I'>count</emphasis></term>
Packit Service 6f2e62
    <listitem>
Packit Service 6f2e62
      <para>Stop after sending <emphasis remap='I'>count</emphasis> ARP REQUEST
Packit Service 6f2e62
packets. With <emphasis remap='I'>deadline</emphasis> option, instead wait for
Packit Service 6f2e62
<emphasis remap='I'>count</emphasis> ARP REPLY packets, or until the timeout expires.</para>
Packit Service 6f2e62
    </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-D</option></term>
Packit Service 6f2e62
  <listitem><para>Duplicate address detection mode (DAD). See RFC2131, 4.4.1. Returns 0, if DAD succeeded i.e. no replies are received</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-f</option></term>
Packit Service 6f2e62
  <listitem><para>Finish after the first reply confirming that target is alive.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-I </option><emphasis remap='I'>interface</emphasis></term>
Packit Service 6f2e62
  <listitem><para>Name of network device where to send ARP REQUEST packets.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-h</option></term>
Packit Service 6f2e62
  <listitem><para>Print help page and exit.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-q</option></term>
Packit Service 6f2e62
  <listitem><para>Quiet output. Nothing is displayed.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-s </option><emphasis remap='I'>source</emphasis></term>
Packit Service 6f2e62
  <listitem><para>IP source address to use in ARP packets. If this option is absent, source address is:</para>
Packit Service 6f2e62
    <variablelist remap='TP'>
Packit Service 6f2e62
      <varlistentry>
Packit Service 6f2e62
      <listitem><para>• In DAD mode (with option <option>-D</option>) set to 0.0.0.0.</para>
Packit Service 6f2e62
      </listitem>
Packit Service 6f2e62
      </varlistentry>
Packit Service 6f2e62
      <varlistentry>
Packit Service 6f2e62
      <listitem><para>• In Unsolicited ARP mode (with options <option>-U</option> or <option>-A</option>)
Packit Service 6f2e62
set to <emphasis remap='I'>destination</emphasis>.</para>
Packit Service 6f2e62
      </listitem>
Packit Service 6f2e62
      </varlistentry>
Packit Service 6f2e62
      <varlistentry>
Packit Service 6f2e62
      <listitem><para>• Otherwise, it is calculated from routing tables.</para>
Packit Service 6f2e62
      </listitem>
Packit Service 6f2e62
      </varlistentry>
Packit Service 6f2e62
    </variablelist>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-U</option></term>
Packit Service 6f2e62
  <listitem><para>Unsolicited ARP mode to update neighbours' ARP caches.
Packit Service 6f2e62
No replies are expected.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-V</option></term>
Packit Service 6f2e62
  <listitem><para>Print version of the program and exit.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
  <varlistentry>
Packit Service 6f2e62
  <term><option>-w </option><emphasis remap='I'>deadline</emphasis></term>
Packit Service 6f2e62
  <listitem><para>Specify a timeout, in seconds, before
Packit Service 6f2e62
<command>arping</command>
Packit Service 6f2e62
exits regardless of how many
Packit Service 6f2e62
packets have been sent or received. In this case
Packit Service 6f2e62
<command>arping</command>
Packit Service 6f2e62
does not stop after
Packit Service 6f2e62
<emphasis remap='I'>count</emphasis>
Packit Service 6f2e62
packet are sent, it waits either for
Packit Service 6f2e62
<emphasis remap='I'>deadline</emphasis>
Packit Service 6f2e62
expire or until
Packit Service 6f2e62
<emphasis remap='I'>count</emphasis>
Packit Service 6f2e62
probes are answered.</para>
Packit Service 6f2e62
  </listitem>
Packit Service 6f2e62
  </varlistentry>
Packit Service 6f2e62
</variablelist>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='see_also'>
Packit Service 6f2e62
  <title>SEE ALSO</title>
Packit Service 6f2e62
  <para><citerefentry><refentrytitle>ping</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
Packit Service 6f2e62
<citerefentry><refentrytitle>clockdiff</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
Packit Service 6f2e62
<citerefentry><refentrytitle>tracepath</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='author'>
Packit Service 6f2e62
  <title>AUTHOR</title>
Packit Service 6f2e62
  <para><command>arping</command> was written by Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>.</para>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='security'>
Packit Service 6f2e62
  <title>SECURITY</title>
Packit Service 6f2e62
  <para><command>arping</command> requires CAP_NET_RAW capability
Packit Service 6f2e62
to be executed. It is not recommended to be used as set-uid root,
Packit Service 6f2e62
because it allows user to modify ARP caches of neighbour hosts.</para>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
Packit Service 6f2e62
<refsect1 id='availability'>
Packit Service 6f2e62
  <title>AVAILABILITY</title>
Packit Service 6f2e62
  <para><command>arping</command> is part of <emphasis remap='I'>iputils</emphasis> package.</para>
Packit Service 6f2e62
</refsect1>
Packit Service 6f2e62
</refentry>
Packit Service 6f2e62