<?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 ping.8.dbk
-->
<refentry id="ping">
    <refentryinfo>
        <productname>Linux</productname>
        <title>System Administration</title>
        <date>27 September 2002</date>
    </refentryinfo>
	<refmeta>
		<refentrytitle>ping</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>
	<refnamediv>
		<refname>ping</refname>
		<refname>ping6</refname>
		<refpurpose>send ICMP ECHO_REQUEST to network hosts</refpurpose>
	</refnamediv>
	<refsynopsisdiv>
		<cmdsynopsis>
			<command>ping</command>
			<group>
				<arg choice="plain"><option>-L</option></arg>
				<arg choice="plain"><option>-R</option></arg>
				<arg choice="plain"><option>-U</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>-n</option></arg>
				<arg choice="plain"><option>-q</option></arg>
				<arg choice="plain"><option>-r</option></arg>
				<arg choice="plain"><option>-v</option></arg>
				<arg choice="plain"><option>-V</option></arg>
				<arg choice="plain"><option>-a</option></arg>
				<arg choice="plain"><option>-A</option></arg>
				<arg choice="plain"><option>-B</option></arg>
			</group>
			<group>
				<arg choice="plain"><option>-c</option> <replaceable
					>count</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-i</option> <replaceable
					>interval</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-l</option> <replaceable
					>preload</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-p</option> <replaceable
					>pattern</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-s</option> <replaceable
					>packetsize</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-t</option> <replaceable
					>ttl</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-w</option> <replaceable
					>deadline</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-F</option> <replaceable
					>flowlabel</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-I</option> <replaceable
					>interface</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-M</option> <replaceable
					>hint</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-Q</option> <replaceable
					>tos</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-S</option> <replaceable
					>sndbuf</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-T</option> <replaceable
					>timestamp option</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="plain"><option>-W</option> <replaceable
					>timeout</replaceable>
				</arg>
			</group>
			<group>
				<arg choice="opt" rep="repeat">
					<replaceable>hop</replaceable>
				</arg>
			</group>
			<arg choice="plain">
				<replaceable>destination</replaceable>
			</arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsection>
		
		<title>DESCRIPTION</title>
		
<para><command>ping</command> uses the ICMP protocol's mandatory 
ECHO_REQUEST datagram to elicit an ICMP ECHO_RESPONSE from a host or 
gateway. ECHO_REQUEST datagrams ("pings") have an IP and ICMP header,
followed by a <structname>struct timeval</structname> and then an 
arbitrary number of "pad" bytes used to fill out the packet.</para>
	</refsection>
	
	<refsection>
		
		<title>OPTIONS</title>
		
		<variablelist>
			<varlistentry>
				<term>
					<option>-a</option>
				</term>
				<listitem>
<para>Audible ping.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-A</option>
				</term>
				<listitem>
<para>Adaptive ping. Interpacket interval adapts to
round-trip time, so that effectively not more than one
(or more, if preload is set) unanswered probes present
in the network. Minimal interval is 200&nbsp;msec for not
super-user. On networks with low rtt this mode is
essentially equivalent to flood mode.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-b</option>
				</term>
				<listitem>
<para>Allow pinging a broadcast address.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-B</option>
				</term>
				<listitem>
<para>Do not allow <command>ping</command> to change source address
of probes. The address is bound to one selected when
<command>ping</command> starts.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option id="ping.count">-c</option> <replaceable
						>count</replaceable>
				</term>
				<listitem>
<para>Stop after sending <replaceable>count</replaceable> ECHO_REQUEST
packets. With <link linkend="ping.deadline">
<replaceable>deadline</replaceable>
</link> option, <command>ping</command> waits
for <replaceable>count</replaceable> ECHO_REPLY packets,
until the timeout expires.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-d</option>
				</term>
				<listitem>
<para>Set the <constant>SO_DEBUG</constant> option on the socket
being used. Essentially, this socket option is not
used by Linux kernel.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-F</option> <replaceable
						>flow label</replaceable>
				</term>
				<listitem>
<para>Allocate and set 20 bit flow label on echo request
packets. (Only <command>ping6</command>). If value is zero,
kernel allocates random flow label.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-f</option>
				</term>
				<listitem>
<para>Flood ping. For every ECHO_REQUEST sent a period
"." is printed, while for ever ECHO_REPLY received a
backspace is printed. This provides a rapid display of
how many packets are being dropped. If interval is not
given, it sets interval to zero and outputs packets as
fast as they come back or one hundred times per second,
whichever is more. Only the super-user may use this
option with zero interval.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-i</option> <replaceable>interval</replaceable>
				</term>
				<listitem>
<para>Wait <replaceable>interval</replaceable> seconds between sending
each packet. The default is to wait for one second
between each packet normally, or not to wait in
flood mode. Only super-user may set interval to
values less 0.2 seconds.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-I</option> <replaceable
						>interface address</replaceable>
				</term>
				<listitem>
<para>Set source address to specified interface address.
Argument may be numeric IP address or name of device.
When pinging IPv6 link-local address this option is
required.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-l</option> <replaceable>preload</replaceable>
				</term>
				<listitem>
<para>If <replaceable>preload</replaceable> is 
specified, <command>ping</command> sends that many packets not waiting 
for reply. Only the super-user may select preload more than 3.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-L</option>
				</term>
				<listitem>
<para>Suppress loopback of multicast packets. This flag
only applies if the ping destination is a multicast
address.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-n</option>
				</term>
				<listitem>
<para>Numeric output only. No attempt will be made to
lookup symbolic names for host addresses.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-p</option> <replaceable>pattern</replaceable>
				</term>
				<listitem>
<para>You may specify up to 16 "pad" bytes to fill out
the packet you send. This is useful for diagnosing
data-dependent problems in a network. For example,
<option>-p</option> <replaceable>ff</replaceable> will cause the sent 
packet to be filled with all ones.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-Q</option> <replaceable>tos</replaceable>
				</term>
				<listitem>
<para>Set Quality of Service-related bits in ICMP
datagrams. <replaceable>tos</replaceable> can be either decimal or
hex number. Traditionally (RFC1349), these have been
interpreted as: 
0 for reserved (currently being redefined as congestion control), 
1-4 for Type of Service and 
5-7 for Precedence. Possible settings for Type of Service are: 
minimal cost: 0x02,
reliability: 0x04, 
throughput: 0x08, 
low delay: 0x10. 
Multiple TOS bits should not be set simultaneously. Possible settings for 
special Precedence range from priority (0x20) to net control
(0xe0). You must be root (<constant>CAP_NET_ADMIN</constant> capability) 
to use Critical or higher precedence value. You cannot set bit 0x01 
(reserved) unless ECN has been enabled in the kernel. In RFC2474,
these fields has been redefined as 8-bit Differentiated Services (DS), 
consisting of: bits 0-1 of separate data (ECN will be used,
here), and bits 2-7 of Differentiated Services Codepoint (DSCP).</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-q</option>
				</term>
				<listitem>
<para>Quiet output. Nothing is displayed except the summary
lines at startup time and when finished.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-R</option>
				</term>
				<listitem>
<para>Record route. (IPv4 only) Includes the RECORD_ROUTE
option in the ECHO_REQUEST packet and displays the route
buffer on returned packets. Note that the IP header is
only large enough for nine such routes. Many hosts
ignore or discard this option.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-r</option>
				</term>
				<listitem>
<para>Bypass the normal routing tables and send directly to
a host on an attached interface. If the host is not on a
directly-attached network, an error is returned. This
option can be used to ping a local host through an
interface that has no route through it provided the
option <option>-I</option> is also used.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-s</option> <replaceable>packetsize</replaceable>
				</term>
				<listitem>
<para>Specifies the number of data bytes to be sent. The
default is 56, which translates into 64 ICMP data bytes
when combined with the 8 bytes of ICMP header data.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-S</option> <replaceable>sndbuf</replaceable>
				</term>
				<listitem>
<para>Set socket sndbuf. If not specified, it is selected
to buffer not more than one packet.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-t</option> <replaceable>ttl</replaceable>
				</term>
				<listitem>
<para>Set the IP Time to Live.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-T</option> <replaceable
						>timestamp option</replaceable>
				</term>
				<listitem>
<para>Set special IP timestamp
options. <replaceable>timestamp option</replaceable> may be
either <constant>tsonly</constant> (only
timestamps), <constant>tsandaddr</constant> (timestamps and addresses)
or <constant>tsprespec</constant> <replaceable>host1 
[host2 [host3 [host4]]]</replaceable> (timestamp prespecified hops).</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-M</option> <replaceable>hint</replaceable>
				</term>
				<listitem>
<para>Select Path MTU Discovery strategy. <replaceable
>hint</replaceable> may be either <constant>do</constant> (prohibit 
fragmentation, even local one), <constant>want</constant> (do PMTU 
discovery, fragment locally when packet size is large), 
or <constant>dont</constant> (do not set DF flag).</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-U</option>
				</term>
				<listitem>
<para>Print full user-to-user latency (the old behaviour).
Normally <command>ping</command> prints network round trip
time, which can be different e.g. due to DNS failures.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-v</option>
				</term>
				<listitem>
<para>Verbose output.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-V</option>
				</term>
				<listitem>
<para>Show version and exit.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option id="ping.deadline">-w</option> <replaceable
						>deadline</replaceable>
				</term>
				<listitem>
<para>Specify a timeout, in seconds, before <command>ping</command> exits 
regardless of how many packets have been sent or received. In this 
case <command>ping</command> does not stop after <link 
linkend="ping.count"><replaceable>count</replaceable>
</link> packet are sent, it waits either for <link 
linkend="ping.deadline"><replaceable>deadline</replaceable>
</link> expire or until <link 
linkend="ping.count"><replaceable>count</replaceable>
</link> probes are answered or for some error 
notification from network.</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term>
					<option>-W</option> <replaceable>timeout</replaceable>
				</term>
				<listitem>
<para>Time to wait for a response, in seconds. The option
affects only timeout in absense of any responses,
otherwise <command>ping</command> waits for two RTTs.</para>
				</listitem>
			</varlistentry>
		</variablelist>
		
<para>When using <command>ping</command> for fault isolation, it should 
first be run on the local host, to verify that the local network
interface is up and running. Then, hosts and gateways further
and further away should be "pinged". Round-trip times and
packet loss statistics are computed. If duplicate packets are
received, they are not included in the packet loss calculation,
although the round trip time of these packets is used in
calculating the minimum/average/maximum round-trip time numbers.
When the specified number of packets have been sent (and
received) or if the program is terminated with
a <constant>SIGINT</constant>, a brief summary is displayed. Shorter
current statistics can be obtained without termination of
process with signal <constant>SIGQUIT</constant>.</para>

<para>If <command>ping</command> does not receive any reply packets at 
all it will exit with code 1. If a packet <link 
linkend="ping.count"><replaceable>count</replaceable></link> and <link 
linkend="ping.deadline"><replaceable>deadline</replaceable></link> are 
both specified, and fewer than <link 
linkend="ping.count"><replaceable>count</replaceable></link> packets are 
received by the time the <link 
linkend="ping.deadline"><replaceable>deadline</replaceable></link> has 
arrived, it will also exit with code 1. On other
error it exits with code 2. Otherwise it exits with code 0. This makes it 
possible to use the exit code to see if a host is alive or not.</para>

<para>This program is intended for use in network testing, measurement
and management. Because of the load it can impose on the network, it
is unwise to use <command>ping</command> during normal operations or from
automated scripts.</para>
	</refsection>
	
	<refsection>
		
		<title>ICMP PACKET DETAILS</title>
		
<para>An IP header without options is 20 bytes. An ICMP ECHO_REQUEST
packet contains an additional 8 bytes worth of ICMP header followed
by an arbitrary amount of data. When a <replaceable
>packetsize</replaceable> is given, this indicated the size of this extra 
piece of data (the default is 56). Thus the amount of data received inside 
of an IP packet of type ICMP ECHO_REPLY will always be 8 bytes more than
the requested data space (the ICMP header).</para>

<para>If the data space is at least of size 
of <structname>struct timeval</structname> <command>ping</command> uses the 
beginning bytes of this space to include a timestamp which it uses in the
computation of round trip times. If the data space is
shorter, no round trip times are given.</para>
	</refsection>

	<refsection>

		<title>DUPLICATE AND DAMAGED PACKETS</title>

<para><command>ping</command> will report duplicate and damaged packets. 
Duplicate packets should never occur, and seem to be caused by
inappropriate link-level retransmissions. Duplicates may occur
in many situations and are rarely (if ever) a good sign,
although the presence of low levels of duplicates may not always
be cause for alarm.</para>

<para>Damaged packets are obviously serious cause for alarm and often
indicate broken hardware somewhere in the <command>ping</command> packet's
path (in the network or in the hosts).</para>
	</refsection>

	<refsection>

		<title>TRYING DIFFERENT DATA PATTERNS</title>

<para>The (inter)network layer should never treat packets differently
depending on the data contained in the data portion. Unfortunately,
data-dependent problems have been known to sneak into networks and
remain undetected for long periods of time. In many cases the
particular pattern that will have problems is something that doesn't
have sufficient "transitions", such as all ones or all zeros, or a
pattern right at the edge, such as almost all zeros. It isn't
necessarily enough to specify a data pattern of all zeros (for
example) on the command line because the pattern that is of interest
is at the data link level, and the relationship between what you
type and what the controllers transmit can be complicated.</para>

<para>This means that if you have a data-dependent problem you will
probably have to do a lot of testing to find it. If you are lucky,
you may manage to find a file that either can't be sent across your
network or that takes much longer to transfer than other similar
length files. You can then examine this file for repeated patterns
that you can test using the <option>-p</option> option 
of <command>ping</command>.</para>
	</refsection>

	<refsection>

		<title>TTL DETAILS</title>

<para>The TTL value of an IP packet represents the maximum number of IP
routers that the packet can go through before being thrown away. In
current practice you can expect each router in the Internet to
decrement the TTL field by exactly one.</para>

<para>The TCP/IP specification states that the TTL field for TCP
packets should be set to 60, but many systems use smaller values
(4.3 BSD uses 30, 4.2 used 15).</para>

<para> The maximum possible value of this field is 255, and most Unix
systems set the TTL field of ICMP ECHO_REQUEST packets to 255. This
is why you will find you can "ping" some hosts, but not reach them 
with <citerefentry>
	<refentrytitle>telnet</refentrytitle>
	<manvolnum>1</manvolnum>
</citerefentry> or <citerefentry>
	<refentrytitle>ftp</refentrytitle>
	<manvolnum>1</manvolnum>
</citerefentry>.</para>
		
<para>In normal operation ping prints the ttl value from the packet it
receives. When a remote system receives a ping packet, it can do one
of three things with the TTL field in its response:</para>
		<itemizedlist>
			<listitem>
<para> Not change it; this is what Berkeley Unix systems did
before the 4.3BSD Tahoe release. In this case the TTL value
in the received packet will be 255 minus the number of
routers in the round-trip path.</para>
			</listitem>
			<listitem>
<para> Set it to 255; this is what current Berkeley Unix systems
do. In this case the TTL value in the received packet will
be 255 minus the number of routers in the path
<emphasis>from</emphasis> the remote system
<emphasis>to</emphasis> the <command>ping</command>ing host.</para>
			</listitem>
			<listitem>
<para> Set it to some other value. Some machines use the same
value for ICMP packets that they use for TCP packets, for
example either 30 or 60. Others may use completely wild values.</para>
			</listitem>
		</itemizedlist>
	</refsection>
	
	<refsection>

		<title>BUGS</title>

		<itemizedlist>
			<listitem>
<para> Many Hosts and Gateways ignore the RECORD_ROUTE option.</para>
			</listitem>
			<listitem>
<para> The maximum IP header length is too small for options
like RECORD_ROUTE to be completely useful. There's not much
that that can be done about this, however.</para>
			</listitem>
			<listitem>
<para> Flood pinging is not recommended in general, and flood
pinging the broadcast address should only be done under very
controlled conditions.</para>
			</listitem>
		</itemizedlist>
	</refsection>

	<refsection>

		<title>SEE ALSO</title>

		<para>
			<citerefentry>
				<refentrytitle>netstat</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>, <citerefentry>
				<refentrytitle>ifconfig</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>.</para>
	</refsection>

	<refsection>

		<title>HISTORY</title>

<para>The <command>ping</command> command appeared in 4.3BSD.</para>
<para>The version described here is its descendant specific to Linux.</para>
	</refsection>

	<refsection>

		<title>SECURITY</title>

<para><command>ping</command> requires <constant>CAP_NET_RAWIO</constant>
capability to be executed. It may be used as set-uid root.</para>
	</refsection>

	<refsection>
		
		<title>AVAILABILITY</title>
		
<para><command>ping</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>

