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