]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sbin/ping/ping.8
This commit was generated by cvs2svn to compensate for changes in r88237,
[FreeBSD/FreeBSD.git] / sbin / ping / ping.8
1 .\" Copyright (c) 1985, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)ping.8      8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD$
34 .\"
35 .Dd September 25, 2001
36 .Dt PING 8
37 .Os
38 .Sh NAME
39 .Nm ping
40 .Nd send
41 .Tn ICMP ECHO_REQUEST
42 packets to network hosts
43 .Sh SYNOPSIS
44 .Nm
45 .Op Fl AQRadfnqrv
46 .Op Fl c Ar count
47 .Op Fl i Ar wait
48 .Op Fl l Ar preload
49 .Op Fl m Ar ttl
50 .Op Fl p Ar pattern
51 .Op Fl P Ar policy
52 .Op Fl s Ar packetsize
53 .Op Fl S Ar src_addr
54 .Op Fl t Ar timeout
55 .Bo
56 .Ar host |
57 .Op Fl L
58 .Op Fl I Ar interface
59 .Op Fl T Ar ttl
60 .Ar mcast-group
61 .Bc
62 .Sh DESCRIPTION
63 .Nm Ping
64 uses the
65 .Tn ICMP
66 .No protocol Ap s mandatory
67 .Tn ECHO_REQUEST
68 datagram to elicit an
69 .Tn ICMP ECHO_RESPONSE
70 from a host or gateway.
71 .Tn ECHO_REQUEST
72 datagrams
73 .Pq Dq pings
74 have an IP and
75 .Tn ICMP
76 header, followed by a
77 .Dq struct timeval
78 and then an arbitrary number of
79 .Dq pad
80 bytes used to fill out the packet.  The options are as follows:
81 .Bl -tag -width indent
82 .It Fl A
83 Audible.
84 Output a bell
85 .Tn ( ASCII
86 0x07)
87 character when no packet is received before the next packet
88 is transmitted.
89 To cater for round-trip times that are longer than the interval
90 between transmissions, further missing packets cause a bell only
91 if the maximum number of unreceived packets has increased.
92 .It Fl a
93 Audible.
94 Include a bell
95 .Tn ( ASCII
96 0x07)
97 character in the output when any packet is received.
98 This option is ignored
99 if other format options are present.
100 .It Fl c Ar count
101 Stop after sending
102 (and receiving)
103 .Ar count
104 .Tn ECHO_RESPONSE
105 packets.
106 If this option is not specified,
107 .Nm
108 will operate until interrupted.
109 .It Fl d
110 Set the
111 .Dv SO_DEBUG
112 option on the socket being used.
113 .It Fl f
114 Flood ping.
115 Outputs packets as fast as they come back or one hundred times per second,
116 whichever is more.
117 For every
118 .Tn ECHO_REQUEST
119 sent a period
120 .Dq .\&
121 is printed, while for every
122 .Tn ECHO_REPLY
123 received a backspace is printed.
124 This provides a rapid display of how many packets are being dropped.
125 Only the super-user may use this option.
126 .Bf -emphasis
127 This can be very hard on a network and should be used with caution.
128 .Ef
129 .It Fl i Ar wait
130 Wait
131 .Ar wait
132 seconds
133 .Em between sending each packet .
134 The default is to wait for one second between each packet.
135 The wait time may be fractional, but only the super-user may specify
136 values less then 1 second.
137 This option is incompatible with the
138 .Fl f
139 option.
140 .It Fl I Ar interface
141 Source multicast packets with the given interface address.
142 This flag only applies if the ping destination is a multicast address.
143 .It Fl l Ar preload
144 If
145 .Ar preload
146 is specified,
147 .Nm
148 sends that many packets as fast as possible before falling into its normal
149 mode of behavior.
150 Only the super-user may use this option.
151 .It Fl m Ar ttl
152 Set the IP Time To Live for outgoing packets.
153 If not specified, the kernel uses the value of the
154 .Va net.inet.ip.ttl
155 MIB variable.
156 .It Fl L
157 Suppress loopback of multicast packets.
158 This flag only applies if the ping destination is a multicast address.
159 .It Fl n
160 Numeric output only.
161 No attempt will be made to lookup symbolic names for host addresses.
162 .It Fl p Ar pattern
163 You may specify up to 16
164 .Dq pad
165 bytes to fill out the packet you send.
166 This is useful for diagnosing data-dependent problems in a network.
167 For example,
168 .Dq Li \-p ff
169 will cause the sent packet to be filled with all
170 ones.
171 .It Fl P Ar policy
172 .Ar policy
173 specifies IPsec policy for the ping session.
174 For details please refer to
175 .Xr ipsec 4
176 and
177 .Xr ipsec_set_policy 3 .
178 .It Fl Q
179 Somewhat quiet output.
180 .No Don Ap t
181 display ICMP error messages that are in response to our query messages.
182 Originally, the
183 .Fl v
184 flag was required to display such errors, but
185 .Fl v
186 displays all ICMP error messages.  On a busy machine, this output can
187 be overbearing.  Without the
188 .Fl Q
189 flag,
190 .Nm
191 prints out any ICMP error messages caused by its own ECHO_REQUEST
192 messages.
193 .It Fl q
194 Quiet output.
195 Nothing is displayed except the summary lines at startup time and
196 when finished.
197 .It Fl R
198 Record route.
199 Includes the
200 .Tn RECORD_ROUTE
201 option in the
202 .Tn ECHO_REQUEST
203 packet and displays
204 the route buffer on returned packets.
205 Note that the IP header is only large enough for nine such routes;
206 the
207 .Xr traceroute 8
208 command is usually better at determining the route packets take to a
209 particular destination.
210 If more routes come back than should, such as due to an illegal spoofed
211 packet, ping will print the route list and then truncate it at the correct
212 spot.
213 Many hosts ignore or discard the
214 .Tn RECORD_ROUTE
215 option.
216 .It Fl r
217 Bypass the normal routing tables and send directly to a host on an attached
218 network.
219 If the host is not on a directly-attached network, an error is returned.
220 This option can be used to ping a local host through an interface
221 that has no route through it
222 (e.g., after the interface was dropped by
223 .Xr routed 8 ) .
224 .It Fl s Ar packetsize
225 Specify the number of data bytes to be sent.
226 The default is 56, which translates into 64
227 .Tn ICMP
228 data bytes when combined
229 with the 8 bytes of
230 .Tn ICMP
231 header data.
232 Only the super-user may use this option.
233 .It Fl S Ar src_addr
234 Use the following IP address as the source address in outgoing packets.
235 On hosts with more than one IP address, this option can be used to
236 force the source address to be something other than the IP address
237 of the interface the probe packet is sent on.  If the IP address
238 is not one of this machine's interface addresses, an error is
239 returned and nothing is sent.
240 .It Fl t Ar timeout
241 Specify a timeout, in seconds, before ping exits regardless of how
242 many packets have been recieved.
243 .It Fl T Ar ttl
244 Set the IP Time To Live for multicasted packets.
245 This flag only applies if the ping destination is a multicast address.
246 .It Fl v
247 Verbose output.
248 .Tn ICMP
249 packets other than
250 .Tn ECHO_RESPONSE
251 that are received are listed.
252 .El
253 .Pp
254 When using
255 .Nm
256 for fault isolation, it should first be run on the local host, to verify
257 that the local network interface is up and running.
258 Then, hosts and gateways further and further away should be
259 .Dq pinged .
260 Round-trip times and packet loss statistics are computed.
261 If duplicate packets are received, they are not included in the packet
262 loss calculation, although the round trip time of these packets is used
263 in calculating the round-trip time statistics.
264 When the specified number of packets have been sent
265 (and received)
266 or if the program is terminated with a
267 .Dv SIGINT ,
268 a brief summary is displayed, showing the number of packets sent and
269 received, and the minimum, maximum, mean, and standard deviation of
270 the round-trip times.
271 .Pp
272 This program is intended for use in network testing, measurement and
273 management.
274 Because of the load it can impose on the network, it is unwise to use
275 .Nm
276 during normal operations or from automated scripts.
277 .Sh ICMP PACKET DETAILS
278 An IP header without options is 20 bytes.
279 An
280 .Tn ICMP
281 .Tn ECHO_REQUEST
282 packet contains an additional 8 bytes worth of
283 .Tn ICMP
284 header followed by an arbitrary amount of data.
285 When a
286 .Ar packetsize
287 is given, this indicated the size of this extra piece of data
288 (the default is 56).
289 Thus the amount of data received inside of an IP packet of type
290 .Tn ICMP
291 .Tn ECHO_REPLY
292 will always be 8 bytes more than the requested data space
293 (the
294 .Tn ICMP
295 header).
296 .Pp
297 If the data space is at least eight bytes large,
298 .Nm
299 uses the first eight bytes of this space to include a timestamp which
300 it uses in the computation of round trip times.
301 If less than eight bytes of pad are specified, no round trip times are
302 given.
303 .Sh DUPLICATE AND DAMAGED PACKETS
304 .Nm Ping
305 will report duplicate and damaged packets.
306 Duplicate packets should never occur when pinging a unicast address,
307 and seem to be caused by
308 inappropriate link-level retransmissions.
309 Duplicates may occur in many situations and are rarely
310 (if ever)
311 a good sign, although the presence of low levels of duplicates may not
312 always be cause for alarm.
313 Duplicates are expected when pinging a broadcast or multicast address,
314 since they are not really duplicates but replies from different hosts
315 to the same request.
316 .Pp
317 Damaged packets are obviously serious cause for alarm and often
318 indicate broken hardware somewhere in the
319 .Nm
320 packet's path (in the network or in the hosts).
321 .Sh TRYING DIFFERENT DATA PATTERNS
322 The
323 (inter)network
324 layer should never treat packets differently depending on the data
325 contained in the data portion.
326 Unfortunately, data-dependent problems have been known to sneak into
327 networks and remain undetected for long periods of time.
328 In many cases the particular pattern that will have problems is something
329 that does not have sufficient
330 .Dq transitions ,
331 such as all ones or all zeros, or a pattern right at the edge, such as
332 almost all zeros.
333 It is not
334 necessarily enough to specify a data pattern of all zeros (for example)
335 on the command line because the pattern that is of interest is
336 at the data link level, and the relationship between what you type and
337 what the controllers transmit can be complicated.
338 .Pp
339 This means that if you have a data-dependent problem you will probably
340 have to do a lot of testing to find it.
341 If you are lucky, you may manage to find a file that either
342 cannot
343 be sent across your network or that takes much longer to transfer than
344 other similar length files.
345 You can then examine this file for repeated patterns that you can test
346 using the
347 .Fl p
348 option of
349 .Nm .
350 .Sh TTL DETAILS
351 The
352 .Tn TTL
353 value of an IP packet represents the maximum number of IP routers
354 that the packet can go through before being thrown away.
355 In current practice you can expect each router in the Internet to decrement
356 the
357 .Tn TTL
358 field by exactly one.
359 .Pp
360 The
361 .Tn TCP/IP
362 specification states that the
363 .Tn TTL
364 field for
365 .Tn TCP
366 packets should be set to 60, but many systems use smaller values
367 .No ( Bx 4.3
368 uses 30,
369 .Bx 4.2
370 used 15).
371 .Pp
372 The maximum possible value of this field is 255, and most
373 .Ux
374 systems set
375 the
376 .Tn TTL
377 field of
378 .Tn ICMP ECHO_REQUEST
379 packets to 255.
380 This is why you will find you can
381 .Dq ping
382 some hosts, but not reach them with
383 .Xr telnet 1
384 or
385 .Xr ftp 1 .
386 .Pp
387 In normal operation
388 .Nm
389 prints the ttl value from the packet it receives.
390 When a remote system receives a ping packet, it can do one of three things
391 with the
392 .Tn TTL
393 field in its response:
394 .Bl -bullet
395 .It
396 Not change it; this is what
397 .Bx
398 systems did before the
399 .Bx 4.3 tahoe
400 release.
401 In this case the
402 .Tn TTL
403 value in the received packet will be 255 minus the
404 number of routers in the round-trip path.
405 .It
406 Set it to 255; this is what current
407 .Bx
408 systems do.
409 In this case the
410 .Tn TTL
411 value in the received packet will be 255 minus the
412 number of routers in the path
413 .Em from
414 the remote system
415 .Em to
416 the
417 .Nm Ns Em ing
418 host.
419 .It
420 Set it to some other value.
421 Some machines use the same value for
422 .Tn ICMP
423 packets that they use for
424 .Tn TCP
425 packets, for example either 30 or 60.
426 Others may use completely wild values.
427 .El
428 .Sh RETURN VALUES
429 The
430 .Nm
431 command returns an exit status of zero if at least one response was
432 heard from the specified
433 .Ar host ;
434 a status of two if the transmission was successful but no responses
435 were received; or another value
436 (from
437 .Aq Pa sysexits.h )
438 if an error occurred.
439 .Sh SEE ALSO
440 .Xr netstat 1 ,
441 .Xr ifconfig 8 ,
442 .Xr routed 8 ,
443 .Xr traceroute 8
444 .Sh HISTORY
445 The
446 .Nm
447 command appeared in
448 .Bx 4.3 .
449 .Sh AUTHORS
450 The original
451 .Nm
452 command was written by
453 .An Mike Muuss
454 while at the US Army Ballistics
455 Research Laboratory.
456 .Sh BUGS
457 Many Hosts and Gateways ignore the
458 .Tn RECORD_ROUTE
459 option.
460 .Pp
461 The maximum IP header length is too small for options like
462 .Tn RECORD_ROUTE
463 to be completely useful.
464 .No There Ap s
465 not much that can be done about this, however.
466 .Pp
467 Flood pinging is not recommended in general, and flood pinging the
468 broadcast address should only be done under very controlled conditions.
469 .Pp
470 The
471 .Fl v
472 option is not worth much on busy hosts.