]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sbin/ping/ping.8
This commit was generated by cvs2svn to compensate for changes in r125505,
[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 October 2, 2002
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 AaDdfnoQqRrv
46 .Op Fl c Ar count
47 .Op Fl i Ar wait
48 .Op Fl l Ar preload
49 .Op Fl M Cm mask | time
50 .Op Fl m Ar ttl
51 .Op Fl P Ar policy
52 .Op Fl p Ar pattern
53 .Op Fl S Ar src_addr
54 .Op Fl s Ar packetsize
55 .Op Fl t Ar timeout
56 .Op Fl z Ar tos
57 .Ar host
58 .Nm
59 .Op Fl AaDdfLnoQqRrv
60 .Op Fl c Ar count
61 .Op Fl I Ar iface
62 .Op Fl i Ar wait
63 .Op Fl l Ar preload
64 .Op Fl M Cm mask | time
65 .Op Fl m Ar ttl
66 .Op Fl P Ar policy
67 .Op Fl p Ar pattern
68 .Op Fl S Ar src_addr
69 .Op Fl s Ar packetsize
70 .Op Fl T Ar ttl
71 .Op Fl t Ar timeout
72 .Op Fl z Ar tos
73 .Ar mcast-group
74 .Sh DESCRIPTION
75 The
76 .Nm
77 utility uses the
78 .Tn ICMP
79 .No protocol Ap s mandatory
80 .Tn ECHO_REQUEST
81 datagram to elicit an
82 .Tn ICMP ECHO_RESPONSE
83 from a host or gateway.
84 .Tn ECHO_REQUEST
85 datagrams
86 .Pq Dq pings
87 have an IP and
88 .Tn ICMP
89 header, followed by a
90 .Dq struct timeval
91 and then an arbitrary number of
92 .Dq pad
93 bytes used to fill out the packet.
94 The options are as follows:
95 .Bl -tag -width indent
96 .It Fl A
97 Audible.
98 Output a bell
99 .Tn ( ASCII
100 0x07)
101 character when no packet is received before the next packet
102 is transmitted.
103 To cater for round-trip times that are longer than the interval
104 between transmissions, further missing packets cause a bell only
105 if the maximum number of unreceived packets has increased.
106 .It Fl a
107 Audible.
108 Include a bell
109 .Tn ( ASCII
110 0x07)
111 character in the output when any packet is received.
112 This option is ignored
113 if other format options are present.
114 .It Fl c Ar count
115 Stop after sending
116 (and receiving)
117 .Ar count
118 .Tn ECHO_RESPONSE
119 packets.
120 If this option is not specified,
121 .Nm
122 will operate until interrupted.
123 .It Fl D
124 Set the Don't Fragment bit.
125 .It Fl d
126 Set the
127 .Dv SO_DEBUG
128 option on the socket being used.
129 .It Fl f
130 Flood ping.
131 Outputs packets as fast as they come back or one hundred times per second,
132 whichever is more.
133 For every
134 .Tn ECHO_REQUEST
135 sent a period
136 .Dq .\&
137 is printed, while for every
138 .Tn ECHO_REPLY
139 received a backspace is printed.
140 This provides a rapid display of how many packets are being dropped.
141 Only the super-user may use this option.
142 .Bf -emphasis
143 This can be very hard on a network and should be used with caution.
144 .Ef
145 .It Fl I Ar iface
146 Source multicast packets with the given interface address.
147 This flag only applies if the ping destination is a multicast address.
148 .It Fl i Ar wait
149 Wait
150 .Ar wait
151 seconds
152 .Em between sending each packet .
153 The default is to wait for one second between each packet.
154 The wait time may be fractional, but only the super-user may specify
155 values less than 1 second.
156 This option is incompatible with the
157 .Fl f
158 option.
159 .It Fl L
160 Suppress loopback of multicast packets.
161 This flag only applies if the ping destination is a multicast address.
162 .It Fl l Ar preload
163 If
164 .Ar preload
165 is specified,
166 .Nm
167 sends that many packets as fast as possible before falling into its normal
168 mode of behavior.
169 Only the super-user may use this option.
170 .It Fl M Cm mask | time
171 Use
172 .Dv ICMP_MASKREQ
173 or
174 .Dv ICMP_TSTAMP
175 instead of
176 .Dv ICMP_ECHO .
177 For
178 .Cm mask ,
179 print the netmask of the remote machine.
180 Set the
181 .Va net.inet.icmp.maskrepl
182 MIB variable to enable
183 .Dv ICMP_MASKREPLY .
184 For
185 .Cm time ,
186 print the origination, reception and transmission timestamps.
187 .It Fl m Ar ttl
188 Set the IP Time To Live for outgoing packets.
189 If not specified, the kernel uses the value of the
190 .Va net.inet.ip.ttl
191 MIB variable.
192 .It Fl n
193 Numeric output only.
194 No attempt will be made to lookup symbolic names for host addresses.
195 .It Fl o
196 Exit successfully after receiving one reply packet.
197 .It Fl P Ar policy
198 .Ar policy
199 specifies IPsec policy for the ping session.
200 For details please refer to
201 .Xr ipsec 4
202 and
203 .Xr ipsec_set_policy 3 .
204 .It Fl p Ar pattern
205 You may specify up to 16
206 .Dq pad
207 bytes to fill out the packet you send.
208 This is useful for diagnosing data-dependent problems in a network.
209 For example,
210 .Dq Li \-p ff
211 will cause the sent packet to be filled with all
212 ones.
213 .It Fl Q
214 Somewhat quiet output.
215 .No Don Ap t
216 display ICMP error messages that are in response to our query messages.
217 Originally, the
218 .Fl v
219 flag was required to display such errors, but
220 .Fl v
221 displays all ICMP error messages.
222 On a busy machine, this output can be overbearing.
223 Without the
224 .Fl Q
225 flag,
226 .Nm
227 prints out any ICMP error messages caused by its own ECHO_REQUEST
228 messages.
229 .It Fl q
230 Quiet output.
231 Nothing is displayed except the summary lines at startup time and
232 when finished.
233 .It Fl R
234 Record route.
235 Includes the
236 .Tn RECORD_ROUTE
237 option in the
238 .Tn ECHO_REQUEST
239 packet and displays
240 the route buffer on returned packets.
241 Note that the IP header is only large enough for nine such routes;
242 the
243 .Xr traceroute 8
244 command is usually better at determining the route packets take to a
245 particular destination.
246 If more routes come back than should, such as due to an illegal spoofed
247 packet, ping will print the route list and then truncate it at the correct
248 spot.
249 Many hosts ignore or discard the
250 .Tn RECORD_ROUTE
251 option.
252 .It Fl r
253 Bypass the normal routing tables and send directly to a host on an attached
254 network.
255 If the host is not on a directly-attached network, an error is returned.
256 This option can be used to ping a local host through an interface
257 that has no route through it
258 (e.g., after the interface was dropped by
259 .Xr routed 8 ) .
260 .It Fl S Ar src_addr
261 Use the following IP address as the source address in outgoing packets.
262 On hosts with more than one IP address, this option can be used to
263 force the source address to be something other than the IP address
264 of the interface the probe packet is sent on.
265 If the IP address
266 is not one of this machine's interface addresses, an error is
267 returned and nothing is sent.
268 .It Fl s Ar packetsize
269 Specify the number of data bytes to be sent.
270 The default is 56, which translates into 64
271 .Tn ICMP
272 data bytes when combined
273 with the 8 bytes of
274 .Tn ICMP
275 header data.
276 Only the super-user may specify values more than default.
277 .It Fl T Ar ttl
278 Set the IP Time To Live for multicasted packets.
279 This flag only applies if the ping destination is a multicast address.
280 .It Fl t Ar timeout
281 Specify a timeout, in seconds, before ping exits regardless of how
282 many packets have been received.
283 .It Fl v
284 Verbose output.
285 .Tn ICMP
286 packets other than
287 .Tn ECHO_RESPONSE
288 that are received are listed.
289 .It Fl z Ar tos
290 Use the specified type of service.
291 .El
292 .Pp
293 When using
294 .Nm
295 for fault isolation, it should first be run on the local host, to verify
296 that the local network interface is up and running.
297 Then, hosts and gateways further and further away should be
298 .Dq pinged .
299 Round-trip times and packet loss statistics are computed.
300 If duplicate packets are received, they are not included in the packet
301 loss calculation, although the round trip time of these packets is used
302 in calculating the round-trip time statistics.
303 When the specified number of packets have been sent
304 (and received)
305 or if the program is terminated with a
306 .Dv SIGINT ,
307 a brief summary is displayed, showing the number of packets sent and
308 received, and the minimum, mean, maximum, and standard deviation of
309 the round-trip times.
310 .Pp
311 If
312 .Nm
313 receives a
314 .Dv SIGINFO
315 (see the
316 .Cm status
317 argument for
318 .Xr stty 1 )
319 signal, the current number of packets sent and received, and the
320 minimum, mean, and maximum of the round-trip times will be written to
321 the standard error output.
322 .Pp
323 This program is intended for use in network testing, measurement and
324 management.
325 Because of the load it can impose on the network, it is unwise to use
326 .Nm
327 during normal operations or from automated scripts.
328 .Sh ICMP PACKET DETAILS
329 An IP header without options is 20 bytes.
330 An
331 .Tn ICMP
332 .Tn ECHO_REQUEST
333 packet contains an additional 8 bytes worth of
334 .Tn ICMP
335 header followed by an arbitrary amount of data.
336 When a
337 .Ar packetsize
338 is given, this indicated the size of this extra piece of data
339 (the default is 56).
340 Thus the amount of data received inside of an IP packet of type
341 .Tn ICMP
342 .Tn ECHO_REPLY
343 will always be 8 bytes more than the requested data space
344 (the
345 .Tn ICMP
346 header).
347 .Pp
348 If the data space is at least eight bytes large,
349 .Nm
350 uses the first eight bytes of this space to include a timestamp which
351 it uses in the computation of round trip times.
352 If less than eight bytes of pad are specified, no round trip times are
353 given.
354 .Sh DUPLICATE AND DAMAGED PACKETS
355 The
356 .Nm
357 utility will report duplicate and damaged packets.
358 Duplicate packets should never occur when pinging a unicast address,
359 and seem to be caused by
360 inappropriate link-level retransmissions.
361 Duplicates may occur in many situations and are rarely
362 (if ever)
363 a good sign, although the presence of low levels of duplicates may not
364 always be cause for alarm.
365 Duplicates are expected when pinging a broadcast or multicast address,
366 since they are not really duplicates but replies from different hosts
367 to the same request.
368 .Pp
369 Damaged packets are obviously serious cause for alarm and often
370 indicate broken hardware somewhere in the
371 .Nm
372 packet's path (in the network or in the hosts).
373 .Sh TRYING DIFFERENT DATA PATTERNS
374 The
375 (inter)network
376 layer should never treat packets differently depending on the data
377 contained in the data portion.
378 Unfortunately, data-dependent problems have been known to sneak into
379 networks and remain undetected for long periods of time.
380 In many cases the particular pattern that will have problems is something
381 that does not have sufficient
382 .Dq transitions ,
383 such as all ones or all zeros, or a pattern right at the edge, such as
384 almost all zeros.
385 It is not
386 necessarily enough to specify a data pattern of all zeros (for example)
387 on the command line because the pattern that is of interest is
388 at the data link level, and the relationship between what you type and
389 what the controllers transmit can be complicated.
390 .Pp
391 This means that if you have a data-dependent problem you will probably
392 have to do a lot of testing to find it.
393 If you are lucky, you may manage to find a file that either
394 cannot
395 be sent across your network or that takes much longer to transfer than
396 other similar length files.
397 You can then examine this file for repeated patterns that you can test
398 using the
399 .Fl p
400 option of
401 .Nm .
402 .Sh TTL DETAILS
403 The
404 .Tn TTL
405 value of an IP packet represents the maximum number of IP routers
406 that the packet can go through before being thrown away.
407 In current practice you can expect each router in the Internet to decrement
408 the
409 .Tn TTL
410 field by exactly one.
411 .Pp
412 The
413 .Tn TCP/IP
414 specification recommends setting the
415 .Tn TTL
416 field for
417 .Tn IP
418 packets to 64, but many systems use smaller values
419 .No ( Bx 4.3
420 uses 30,
421 .Bx 4.2
422 used 15).
423 .Pp
424 The maximum possible value of this field is 255, and most
425 .Ux
426 systems set
427 the
428 .Tn TTL
429 field of
430 .Tn ICMP ECHO_REQUEST
431 packets to 255.
432 This is why you will find you can
433 .Dq ping
434 some hosts, but not reach them with
435 .Xr telnet 1
436 or
437 .Xr ftp 1 .
438 .Pp
439 In normal operation
440 .Nm
441 prints the ttl value from the packet it receives.
442 When a remote system receives a ping packet, it can do one of three things
443 with the
444 .Tn TTL
445 field in its response:
446 .Bl -bullet
447 .It
448 Not change it; this is what
449 .Bx
450 systems did before the
451 .Bx 4.3 tahoe
452 release.
453 In this case the
454 .Tn TTL
455 value in the received packet will be 255 minus the
456 number of routers in the round-trip path.
457 .It
458 Set it to 255; this is what current
459 .Bx
460 systems do.
461 In this case the
462 .Tn TTL
463 value in the received packet will be 255 minus the
464 number of routers in the path
465 .Em from
466 the remote system
467 .Em to
468 the
469 .Nm Ns Em ing
470 host.
471 .It
472 Set it to some other value.
473 Some machines use the same value for
474 .Tn ICMP
475 packets that they use for
476 .Tn TCP
477 packets, for example either 30 or 60.
478 Others may use completely wild values.
479 .El
480 .Sh RETURN VALUES
481 The
482 .Nm
483 utility returns an exit status of zero if at least one response was
484 heard from the specified
485 .Ar host ;
486 a status of two if the transmission was successful but no responses
487 were received; or another value
488 (from
489 .In sysexits.h )
490 if an error occurred.
491 .Sh SEE ALSO
492 .Xr netstat 1 ,
493 .Xr ifconfig 8 ,
494 .Xr routed 8 ,
495 .Xr traceroute 8
496 .Sh HISTORY
497 The
498 .Nm
499 utility appeared in
500 .Bx 4.3 .
501 .Sh AUTHORS
502 The original
503 .Nm
504 utility was written by
505 .An Mike Muuss
506 while at the US Army Ballistics
507 Research Laboratory.
508 .Sh BUGS
509 Many Hosts and Gateways ignore the
510 .Tn RECORD_ROUTE
511 option.
512 .Pp
513 The maximum IP header length is too small for options like
514 .Tn RECORD_ROUTE
515 to be completely useful.
516 .No There Ap s
517 not much that can be done about this, however.
518 .Pp
519 Flood pinging is not recommended in general, and flood pinging the
520 broadcast address should only be done under very controlled conditions.
521 .Pp
522 The
523 .Fl v
524 option is not worth much on busy hosts.