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