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