[dragonfly.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. 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 .\"
27 .\"
28 .\"     @(#)ping.8      8.2 (Berkeley) 12/11/93
29 .\" $FreeBSD: src/sbin/ping/ping.8,v 1.54 2006/04/05 12:30:42 glebius Exp $
30 .\"
31 .Dd April 21, 2018
32 .Dt PING 8
33 .Os
34 .Sh NAME
35 .Nm ping
36 .Nd send
38 packets to network hosts
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 pattern
51 .Op Fl S Ar src_addr
52 .Op Fl s Ar packetsize
53 .Op Fl t Ar timeout
54 .Op Fl W Ar waittime
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 pattern
66 .Op Fl S Ar src_addr
67 .Op Fl s Ar packetsize
68 .Op Fl T Ar ttl
69 .Op Fl t Ar timeout
70 .Op Fl W Ar waittime
71 .Op Fl z Ar tos
72 .Ar mcast-group
74 The
75 .Nm
76 utility uses the
77 .Tn ICMP
78 .No protocol Ap s mandatory
80 datagram to elicit an
82 from a host or gateway.
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
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
138 sent a period
139 .Dq .\&
140 is printed, while for every
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.
163 The default value is 1.
164 .It Fl I Ar iface
165 Source multicast packets with the given interface address.
166 This flag only applies if the ping destination is a multicast address.
167 .It Fl i Ar wait
168 Wait
169 .Ar wait
170 seconds
171 .Em between sending each packet .
172 The default is to wait for one second between each packet.
173 The wait time may be fractional, but only the super-user may specify
174 values less than 1 second.
175 This option is incompatible with the
176 .Fl f
177 option.
178 .It Fl L
179 Suppress loopback of multicast packets.
180 This flag only applies if the ping destination is a multicast address.
181 .It Fl l Ar preload
182 If
183 .Ar preload
184 is specified,
185 .Nm
186 sends that many packets as fast as possible before falling into its normal
187 mode of behavior.
188 Only the super-user may use this option.
189 .It Fl M Cm mask | time
190 Use
192 or
194 instead of
195 .Dv ICMP_ECHO .
196 For
197 .Cm mask ,
198 print the netmask of the remote machine.
199 Set the
200 .Va net.inet.icmp.maskrepl
201 MIB variable to enable
203 For
204 .Cm time ,
205 print the origination, reception and transmission timestamps.
206 .It Fl m Ar ttl
207 Set the IP Time To Live for outgoing packets.
208 If not specified, the kernel uses the value of the
209 .Va net.inet.ip.ttl
210 MIB variable.
211 .It Fl n
212 Numeric output only.
213 No attempt will be made to lookup symbolic names for host addresses.
214 .It Fl o
215 Exit successfully after receiving one reply packet.
216 .It Fl p Ar pattern
217 You may specify up to 16
218 .Dq pad
219 bytes to fill out the packet you send.
220 This is useful for diagnosing data-dependent problems in a network.
221 For example,
222 .Dq Li \-p ff
223 will cause the sent packet to be filled with all
224 ones.
225 .It Fl Q
226 Somewhat quiet output.
227 .No Don Ap t
228 display ICMP error messages that are in response to our query messages.
229 Originally, the
230 .Fl v
231 flag was required to display such errors, but
232 .Fl v
233 displays all ICMP error messages.
234 On a busy machine, this output can be overbearing.
235 Without the
236 .Fl Q
237 flag,
238 .Nm
239 prints out any ICMP error messages caused by its own ECHO_REQUEST
240 messages.
241 .It Fl q
242 Quiet output.
243 Nothing is displayed except the summary lines at startup time and
244 when finished.
245 .It Fl R
246 Record route.
247 Includes the
249 option in the
251 packet and displays
252 the route buffer on returned packets.
253 Note that the IP header is only large enough for nine such routes;
254 the
255 .Xr traceroute 8
256 command is usually better at determining the route packets take to a
257 particular destination.
258 If more routes come back than should, such as due to an illegal spoofed
259 packet, ping will print the route list and then truncate it at the correct
260 spot.
261 Many hosts ignore or discard the
263 option.
264 .It Fl r
265 Bypass the normal routing tables and send directly to a host on an attached
266 network.
267 If the host is not on a directly-attached network, an error is returned.
268 This option can be used to ping a local host through an interface
269 that has no route through it
270 (e.g., after the interface was dropped by
271 .Xr routed 8 ) .
272 .It Fl S Ar src_addr
273 Use the following IP address as the source address in outgoing packets.
274 On hosts with more than one IP address, this option can be used to
275 force the source address to be something other than the IP address
276 of the interface the probe packet is sent on.
277 If the IP address
278 is not one of this machine's interface addresses, an error is
279 returned and nothing is sent.
280 .It Fl s Ar packetsize
281 Specify the number of data bytes to be sent.
282 The default is 56, which translates into 64
283 .Tn ICMP
284 data bytes when combined
285 with the 8 bytes of
286 .Tn ICMP
287 header data.
288 Only the super-user may specify values more than default.
289 This option cannot be used with ping sweeps.
290 .It Fl T Ar ttl
291 Set the IP Time To Live for multicasted packets.
292 This flag only applies if the ping destination is a multicast address.
293 .It Fl t Ar timeout
294 Specify a timeout, in seconds, before ping exits regardless of how
295 many packets have been received.
296 .It Fl v
297 Verbose output.
298 .Tn ICMP
299 packets other than
301 that are received are listed.
302 .It Fl W Ar waittime
303 Time in milliseconds to wait for a reply for each packet sent.
304 If a reply arrives later, the packet is not printed as replied, but
305 considered as replied when calculating statistics.
306 .It Fl z Ar tos
307 Use the specified type of service.
308 .El
309 .Pp
310 When using
311 .Nm
312 for fault isolation, it should first be run on the local host, to verify
313 that the local network interface is up and running.
314 Then, hosts and gateways further and further away should be
315 .Dq pinged .
316 Round-trip times and packet loss statistics are computed.
317 If duplicate packets are received, they are not included in the packet
318 loss calculation, although the round trip time of these packets is used
319 in calculating the round-trip time statistics.
320 When the specified number of packets have been sent
321 (and received)
322 or if the program is terminated with a
323 .Dv SIGINT ,
324 a brief summary is displayed, showing the number of packets sent and
325 received, and the minimum, mean, maximum, and standard deviation of
326 the round-trip times.
327 .Pp
328 If
329 .Nm
330 receives a
332 (see the
333 .Cm status
334 argument for
335 .Xr stty 1 )
336 signal, the current number of packets sent and received, and the
337 minimum, mean, and maximum of the round-trip times will be written to
338 the standard error output.
339 .Pp
340 This program is intended for use in network testing, measurement and
341 management.
342 Because of the load it can impose on the network, it is unwise to use
343 .Nm
344 during normal operations or from automated scripts.
346 An IP header without options is 20 bytes.
347 An
348 .Tn ICMP
350 packet contains an additional 8 bytes worth of
351 .Tn ICMP
352 header followed by an arbitrary amount of data.
353 When a
354 .Ar packetsize
355 is given, this indicated the size of this extra piece of data
356 (the default is 56).
357 Thus the amount of data received inside of an IP packet of type
358 .Tn ICMP
360 will always be 8 bytes more than the requested data space
361 (the
362 .Tn ICMP
363 header).
364 .Pp
365 If the data space is at least eight bytes large,
366 .Nm
367 uses the first eight bytes of this space to include a timestamp which
368 it uses in the computation of round trip times.
369 If less than eight bytes of pad are specified, no round trip times are
370 given.
372 The
373 .Nm
374 utility will report duplicate and damaged packets.
375 Duplicate packets should never occur when pinging a unicast address,
376 and seem to be caused by
377 inappropriate link-level retransmissions.
378 Duplicates may occur in many situations and are rarely
379 (if ever)
380 a good sign, although the presence of low levels of duplicates may not
381 always be cause for alarm.
382 Duplicates are expected when pinging a broadcast or multicast address,
383 since they are not really duplicates but replies from different hosts
384 to the same request.
385 .Pp
386 Damaged packets are obviously serious cause for alarm and often
387 indicate broken hardware somewhere in the
388 .Nm
389 packet's path (in the network or in the hosts).
391 The
392 (inter)network
393 layer should never treat packets differently depending on the data
394 contained in the data portion.
395 Unfortunately, data-dependent problems have been known to sneak into
396 networks and remain undetected for long periods of time.
397 In many cases the particular pattern that will have problems is something
398 that does not have sufficient
399 .Dq transitions ,
400 such as all ones or all zeros, or a pattern right at the edge, such as
401 almost all zeros.
402 It is not
403 necessarily enough to specify a data pattern of all zeros (for example)
404 on the command line because the pattern that is of interest is
405 at the data link level, and the relationship between what you type and
406 what the controllers transmit can be complicated.
407 .Pp
408 This means that if you have a data-dependent problem you will probably
409 have to do a lot of testing to find it.
410 If you are lucky, you may manage to find a file that either
411 cannot
412 be sent across your network or that takes much longer to transfer than
413 other similar length files.
414 You can then examine this file for repeated patterns that you can test
415 using the
416 .Fl p
417 option of
418 .Nm .
420 The
421 .Tn TTL
422 value of an IP packet represents the maximum number of IP routers
423 that the packet can go through before being thrown away.
424 In current practice you can expect each router in the Internet to decrement
425 the
426 .Tn TTL
427 field by exactly one.
428 .Pp
429 The
430 .Tn TCP/IP
431 specification recommends setting the
432 .Tn TTL
433 field for
434 .Tn IP
435 packets to 64, but many systems use smaller values
436 .No ( Bx 4.3
437 uses 30,
438 .Bx 4.2
439 used 15).
440 .Pp
441 The maximum possible value of this field is 255, and most
442 .Ux
443 systems set
444 the
445 .Tn TTL
446 field of
448 packets to 255.
449 This is why you will find you can
450 .Dq ping
451 some hosts, but not reach them with
452 .Xr telnet 1
453 or
454 .Xr ftp 1 .
455 .Pp
456 In normal operation
457 .Nm
458 prints the ttl value from the packet it receives.
459 When a remote system receives a ping packet, it can do one of three things
460 with the
461 .Tn TTL
462 field in its response:
463 .Bl -bullet
464 .It
465 Not change it; this is what
466 .Bx
467 systems did before the
468 .Bx 4.3 tahoe
469 release.
470 In this case the
471 .Tn TTL
472 value in the received packet will be 255 minus the
473 number of routers in the round-trip path.
474 .It
475 Set it to 255; this is what current
476 .Bx
477 systems do.
478 In this case the
479 .Tn TTL
480 value in the received packet will be 255 minus the
481 number of routers in the path
482 .Em from
483 the remote system
484 .Em to
485 the
486 .Nm Ns Em ing
487 host.
488 .It
489 Set it to some other value.
490 Some machines use the same value for
491 .Tn ICMP
492 packets that they use for
493 .Tn TCP
494 packets, for example either 30 or 60.
495 Others may use completely wild values.
496 .El
498 The
499 .Nm
500 utility returns an exit status of zero if at least one response was
501 heard from the specified
502 .Ar host ;
503 a status of two if the transmission was successful but no responses
504 were received; or another value
505 (from
506 .In sysexits.h )
507 if an error occurred.
508 .Sh SEE ALSO
509 .Xr netstat 1 ,
510 .Xr ifconfig 8 ,
511 .Xr routed 8 ,
512 .Xr traceroute 8
514 The
515 .Nm
516 utility appeared in
517 .Bx 4.3 .
519 The original
520 .Nm
521 utility was written by
522 .An Mike Muuss
523 while at the US Army Ballistics
524 Research Laboratory.
525 .Sh BUGS
526 Many Hosts and Gateways ignore the
528 option.
529 .Pp
530 The maximum IP header length is too small for options like
532 to be completely useful.
533 .No There Ap s
534 not much that can be done about this, however.
535 .Pp
536 Flood pinging is not recommended in general, and flood pinging the
537 broadcast address should only be done under very controlled conditions.
538 .Pp
539 The
540 .Fl v
541 option is not worth much on busy hosts.