<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
  
<!-- conversion to man: 
  xsltproc  /usr/apps/docbook/xsl/1.67.2/manpages/docbook.xsl arping.8.dbk
-->
<refentry id="arping">
	
	<refentryinfo>
		<productname>Linux</productname>
		<title>System Administration</title>
		<date>27 September 2002</date>
	</refentryinfo>
	
	<refmeta>
		<refentrytitle>arping</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>
	
	<refnamediv>
		<refname>arping</refname>
		<refpurpose>send ARP REQUEST to a neighbour host</refpurpose>
	</refnamediv>
	
	<refsynopsisdiv>
		<cmdsynopsis>
			<command>arping</command>
			<group>
				<arg choice="plain">
					<option>-A</option>
				</arg>
				<arg choice="plain">
					<option>-b</option>
				</arg>
				<arg choice="plain">
					<option>-D</option>
				</arg>
				<arg choice="plain">
					<option>-f</option>
				</arg>
				<arg choice="plain">
					<option>-h</option>
				</arg>
				<arg choice="plain">
					<option>-q</option>
				</arg>
				<arg choice="plain">
					<option>-U</option>
				</arg>
				<arg choice="plain">
					<option>-V</option>
				</arg>
			</group>
			<group>
				<arg choice="plain">
					<option>-c</option>&nbsp;<replaceable>count</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain">
					<option>-w</option>&nbsp;<replaceable
						>deadline</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain">
					<option>-s</option>&nbsp;<replaceable>source</replaceable>
				</arg>
			</group>
			<arg choice="plain">
				<option>-I</option>&nbsp;<replaceable>interface</replaceable>
			</arg>
			<arg choice="plain">
				<replaceable>destination</replaceable>
			</arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsection>

		<title>DESCRIPTION</title>
		
<para>Ping <replaceable>destination</replaceable> on 
device <replaceable>interface</replaceable> by ARP packets, using source
address <replaceable>source</replaceable>.</para>
	</refsection>
	
	<refsection>
		
		<title>OPTIONS</title>
		
		<variablelist>
			<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 id="arping.count">
				<term>
					<option>-c</option> <replaceable>count</replaceable>
				</term>
				<listitem>
<para> Stop after sending <replaceable>count</replaceable> ARP 
REQUEST packets. 
With <option>-w</option>&nbsp;<replaceable>deadline</replaceable> option, 
<command>arping</command> waits for <replaceable>count</replaceable> ARP REPLY 
packets, until the timeout expires.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-D</option>
				</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 id="opt.interface">-I</option> <replaceable
					>interface</replaceable>
				</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</option>
				</term>
				<listitem>
<para> Quiet output. Nothing is displayed.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option id="opt.source">-s</option> <replaceable
					>source</replaceable>
				</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</option>) set to 0.0.0.0.</para>
			</listitem>
			<listitem>
<para> In Unsolicited ARP mode (with options <option
>-U</option> or <option>-A</option>) set to <replaceable
>destination</replaceable>.</para>
			</listitem>
			<listitem>
<para> Otherwise, it is calculated from routing tables. </para>
			</listitem>
		</itemizedlist></para>
				</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 id="arping.deadline">-w</option> <replaceable
					>deadline</replaceable>
				</term>
				<listitem>
<para> Specify a timeout, in seconds, before <command>arping</command> exits 
regardless of how many packets have been sent or received. In this
case <command>arping</command> does not stop after <link 
linkend="arping.count"><replaceable>count</replaceable></link> packet are 
sent, it waits either for <link 
linkend="arping.deadline"><replaceable>deadline</replaceable></link> expire or 
until <link 
linkend="arping.count"><replaceable>count</replaceable></link> probes 
are answered.</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsection>
	
	<refsection>
		
		<title>SEE ALSO</title>
		
		<para>
			<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>
	</refsection>
	
	<refsection>
		
		<title>AUTHOR</title>
		
<para><command>arping</command> was written by <address>
<firstname>Alexey</firstname> <surname>Kuznetsov</surname><email
>kuznet@ms2.inr.ac.ru</email></address>.</para>
	</refsection>
	
	<refsection>
		
		<title>SECURITY</title>
		
<para><command>arping</command> requires <constant
>CAP_NET_RAWIO</constant> 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>
	</refsection>
	
	<refsection>
		
		<title>AVAILABILITY</title>
		
<para><command>arping</command> is part 
of <application>iputils</application> package and the latest versions are 
available in source form for anonymous via <ulink
url="ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz"/>.</para>
	</refsection>
</refentry>

