]> CyberLeo.Net >> Repos - FreeBSD/stable/8.git/blob - usr.bin/netstat/netstat.1
MFC: 215434, 215724
[FreeBSD/stable/8.git] / usr.bin / netstat / netstat.1
1 .\" Copyright (c) 1983, 1990, 1992, 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 .\"     @(#)netstat.1   8.8 (Berkeley) 4/18/94
33 .\" $FreeBSD$
34 .\"
35 .Dd January 10, 2010
36 .Dt NETSTAT 1
37 .Os
38 .Sh NAME
39 .Nm netstat
40 .Nd show network status
41 .Sh DESCRIPTION
42 The
43 .Nm
44 command symbolically displays the contents of various network-related
45 data structures.
46 There are a number of output formats,
47 depending on the options for the information presented.
48 .Bl -tag -width indent
49 .It Xo
50 .Bk -words
51 .Nm
52 .Op Fl AaLnSTWx
53 .Op Fl f Ar protocol_family | Fl p Ar protocol
54 .Op Fl M Ar core
55 .Op Fl N Ar system
56 .Ek
57 .Xc
58 Display a list of active sockets
59 (protocol control blocks)
60 for each network protocol,
61 for a particular
62 .Ar protocol_family ,
63 or for a single
64 .Ar protocol .
65 If
66 .Fl A
67 is also present,
68 show the address of a protocol control block (PCB)
69 associated with a socket; used for debugging.
70 If
71 .Fl a
72 is also present,
73 show the state of all sockets;
74 normally sockets used by server processes are not shown.
75 If
76 .Fl L
77 is also present,
78 show the size of the various listen queues.
79 The first count shows the number of unaccepted connections,
80 the second count shows the amount of unaccepted incomplete connections,
81 and the third count is the maximum number of queued connections.
82 If
83 .Fl S
84 is also present,
85 show network addresses as numbers (as with
86 .Fl n )
87 but show ports symbolically.
88 If
89 .Fl x
90 is present display full socket buffer statistics for each internet socket.
91 When
92 .Fl T
93 is present, display information from the TCP control block, including
94 retransmits, out-of-order packets received, and zero-sized windows advertised.
95 .It Xo
96 .Bk -words
97 .Nm
98 .Fl i | I Ar interface
99 .Op Fl abdhntW
100 .Op Fl f Ar address_family
101 .Op Fl M Ar core
102 .Op Fl N Ar system
103 .Ek
104 .Xc
105 Show the state of all network interfaces or a single
106 .Ar interface
107 which have been auto-configured
108 (interfaces statically configured into a system, but not
109 located at boot time are not shown).
110 An asterisk
111 .Pq Dq Li *
112 after an interface name indicates that the interface is
113 .Dq down .
114 If
115 .Fl a
116 is also present, multicast addresses currently in use are shown
117 for each Ethernet interface and for each IP interface address.
118 Multicast addresses are shown on separate lines following the interface
119 address with which they are associated.
120 If
121 .Fl b
122 is also present, show the number of bytes in and out.
123 If
124 .Fl d
125 is also present, show the number of dropped packets.
126 If
127 .Fl h
128 is also present, print all counters in human readable form.
129 If
130 .Fl t
131 is also present, show the contents of watchdog timers.
132 If
133 .Fl W
134 is also present, print interface names using a wider field size.
135 .It Xo
136 .Bk -words
137 .Nm
138 .Fl w Ar wait
139 .Op Fl I Ar interface
140 .Op Fl d
141 .Op Fl M Ar core
142 .Op Fl N Ar system
143 .Op Fl q Ar howmany
144 .Ek
145 .Xc
146 At intervals of
147 .Ar wait
148 seconds,
149 display the information regarding packet
150 traffic on all configured network interfaces
151 or a single
152 .Ar interface .
153 If
154 .Fl q
155 is also present, exit after
156 .Ar howmany
157 outputs.
158 If
159 .Fl d
160 is also present, show the number of dropped packets.
161 .It Xo
162 .Bk -words
163 .Nm
164 .Fl s Op Fl s
165 .Op Fl z
166 .Op Fl f Ar protocol_family | Fl p Ar protocol
167 .Op Fl M Ar core
168 .Op Fl N Ar system
169 .Ek
170 .Xc
171 Display system-wide statistics for each network protocol,
172 for a particular
173 .Ar protocol_family ,
174 or for a single
175 .Ar protocol .
176 If
177 .Fl s
178 is repeated, counters with a value of zero are suppressed.
179 If
180 .Fl z
181 is also present, reset statistic counters after displaying them.
182 .It Xo
183 .Bk -words
184 .Nm
185 .Fl i | I Ar interface Fl s
186 .Op Fl f Ar protocol_family | Fl p Ar protocol
187 .Op Fl M Ar core
188 .Op Fl N Ar system
189 .Ek
190 .Xc
191 Display per-interface statistics for each network protocol,
192 for a particular
193 .Ar protocol_family ,
194 or for a single
195 .Ar protocol .
196 .It Xo
197 .Bk -words
198 .Nm
199 .Fl m
200 .Op Fl M Ar core
201 .Op Fl N Ar system
202 .Ek
203 .Xc
204 Show statistics recorded by the memory management routines
205 .Pq Xr mbuf 9 .
206 The network manages a private pool of memory buffers.
207 .It Xo
208 .Bk -words
209 .Nm
210 .Fl B
211 .Op Fl z
212 .Op Fl I Ar interface
213 .Ek
214 .Xc
215 Show statistics about
216 .Xr bpf 4
217 peers.
218 This includes information like
219 how many packets have been matched, dropped and received by the
220 bpf device, also information about current buffer sizes and device
221 states.
222 .It Xo
223 .Bk -words
224 .Nm
225 .Fl r
226 .Op Fl AanW
227 .Op Fl f Ar address_family
228 .Op Fl M Ar core
229 .Op Fl N Ar system
230 .Ek
231 .Xc
232 Display the contents of all routing tables,
233 or a routing table for a particular
234 .Ar address_family .
235 If
236 .Fl A
237 is also present,
238 show the contents of the internal Patricia tree
239 structures; used for debugging.
240 If
241 .Fl a
242 is also present,
243 show protocol-cloned routes
244 (routes generated by an
245 .Dv RTF_PRCLONING
246 parent route);
247 normally these routes are not shown.
248 When
249 .Fl W
250 is also present,
251 show the path MTU
252 for each route,
253 and print interface
254 names with a wider
255 field size.
256 .It Xo
257 .Bk -words
258 .Nm
259 .Fl rs
260 .Op Fl s
261 .Op Fl M Ar core
262 .Op Fl N Ar system
263 .Ek
264 .Xc
265 Display routing statistics.
266 If
267 .Fl s
268 is repeated, counters with a value of zero are suppressed.
269 .It Xo
270 .Bk -words
271 .Nm
272 .Fl g
273 .Op Fl W
274 .Op Fl f Ar address_family
275 .Op Fl M Ar core
276 .Op Fl N Ar system
277 .Ek
278 .Xc
279 Display the contents of the multicast virtual interface tables,
280 and multicast forwarding caches.
281 Entries in these tables will appear only when the kernel is
282 actively forwarding multicast sessions.
283 This option is applicable only to the
284 .Cm inet
285 and
286 .Cm inet6
287 address families.
288 .It Xo
289 .Bk -words
290 .Nm
291 .Fl gs
292 .Op Fl s
293 .Op Fl f Ar address_family
294 .Op Fl M Ar core
295 .Op Fl N Ar system
296 .Ek
297 .Xc
298 Show multicast routing statistics.
299 If
300 .Fl s
301 is repeated, counters with a value of zero are suppressed.
302 .El
303 .Pp
304 Some options have the general meaning:
305 .Bl -tag -width flag
306 .It Fl f Ar address_family , Fl p Ar protocol
307 Limit display to those records
308 of the specified
309 .Ar address_family
310 or a single
311 .Ar protocol .
312 The following address families and protocols are recognized:
313 .Pp
314 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
315 .It Em Family
316 .Em Protocols
317 .It Cm inet Pq Dv AF_INET
318 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
319 .It Cm inet6 Pq Dv AF_INET6
320 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
321 .It Cm pfkey Pq Dv PF_KEY
322 .Cm pfkey
323 .It Cm atalk Pq Dv AF_APPLETALK
324 .Cm ddp
325 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
326 .Cm ctrl , data
327 .It Cm ipx Pq Dv AF_IPX
328 .Cm ipx , spx
329 .\".It Cm ns Pq Dv AF_NS
330 .\".Cm idp , ns_err , spp
331 .\".It Cm iso Pq Dv AF_ISO
332 .\".Cm clnp , cltp , esis , tp
333 .It Cm unix Pq Dv AF_UNIX
334 .It Cm link Pq Dv AF_LINK
335 .El
336 .Pp
337 The program will complain if
338 .Ar protocol
339 is unknown or if there is no statistics routine for it.
340 .It Fl M
341 Extract values associated with the name list from the specified core
342 instead of the default
343 .Pa /dev/kmem .
344 .It Fl N
345 Extract the name list from the specified system instead of the default,
346 which is the kernel image the system has booted from.
347 .It Fl n
348 Show network addresses and ports as numbers.
349 Normally
350 .Nm
351 attempts to resolve addresses and ports,
352 and display them symbolically.
353 .It Fl W
354 In certain displays, avoid truncating addresses even if this causes
355 some fields to overflow.
356 .El
357 .Pp
358 The default display, for active sockets, shows the local
359 and remote addresses, send and receive queue sizes (in bytes), protocol,
360 and the internal state of the protocol.
361 Address formats are of the form
362 .Dq host.port
363 or
364 .Dq network.port
365 if a socket's address specifies a network but no specific host address.
366 When known, the host and network addresses are displayed symbolically
367 according to the databases
368 .Xr hosts 5
369 and
370 .Xr networks 5 ,
371 respectively.
372 If a symbolic name for an address is unknown, or if
373 the
374 .Fl n
375 option is specified, the address is printed numerically, according
376 to the address family.
377 For more information regarding
378 the Internet IPv4
379 .Dq dot format ,
380 refer to
381 .Xr inet 3 .
382 Unspecified,
383 or
384 .Dq wildcard ,
385 addresses and ports appear as
386 .Dq Li * .
387 .Pp
388 The interface display provides a table of cumulative
389 statistics regarding packets transferred, errors, and collisions.
390 The network addresses of the interface
391 and the maximum transmission unit
392 .Pq Dq mtu
393 are also displayed.
394 .Pp
395 The routing table display indicates the available routes and their status.
396 Each route consists of a destination host or network, and a gateway to use
397 in forwarding packets.
398 The flags field shows a collection of information about the route stored
399 as binary choices.
400 The individual flags are discussed in more detail in the
401 .Xr route 8
402 and
403 .Xr route 4
404 manual pages.
405 The mapping between letters and flags is:
406 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
407 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
408 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
409 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
410 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
411 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
412 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
413 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
414 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
415 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
416 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
417 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
418 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
419 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
420 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
421 .It Li U Ta Dv RTF_UP Ta "Route usable"
422 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
423 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
424 .El
425 .Pp
426 Direct routes are created for each
427 interface attached to the local host;
428 the gateway field for such entries shows the address of the outgoing interface.
429 The refcnt field gives the
430 current number of active uses of the route.
431 Connection oriented
432 protocols normally hold on to a single route for the duration of
433 a connection while connectionless protocols obtain a route while sending
434 to the same destination.
435 The use field provides a count of the number of packets
436 sent using that route.
437 The interface entry indicates the network interface utilized for the route.
438 .Pp
439 When
440 .Nm
441 is invoked with the
442 .Fl w
443 option and a
444 .Ar wait
445 interval argument, it displays a running count of statistics related to
446 network interfaces.
447 An obsolescent version of this option used a numeric parameter
448 with no option, and is currently supported for backward compatibility.
449 By default, this display summarizes information for all interfaces.
450 Information for a specific interface may be displayed with the
451 .Fl I
452 option.
453 .Pp
454 The
455 .Xr bpf 4
456 flags displayed when
457 .Nm
458 is invoked with the
459 .Fl B
460 option represent the underlying parameters of the bpf peer.
461 Each flag is
462 represented as a single lower case letter.
463 The mapping between the letters and flags in order of appearance are:
464 .Bl -column ".Li i"
465 .It Li p Ta Set if listening promiscuously
466 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
467 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
468 filled automatically
469 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
470 remotely on the interface.
471 .It Li a Ta Packet reception generates a signal
472 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
473 .El
474 .Pp
475 For more information about these flags, please refer to
476 .Xr bpf 4 .
477 .Pp
478 The
479 .Fl x
480 flag causes
481 .Nm
482 to output all the information recorded about data
483 stored in the socket buffers.
484 The fields are:
485 .Bl -column ".Li R-MBUF"
486 .It Li R-MBUF Ta Number of mbufs in the receive queue.
487 .It Li S-MBUF Ta Number of mbufs in the send queue.
488 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
489 queue.
490 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
491 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
492 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
493 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
494 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
495 .It Li R-BCNT Ta Receive buffer byte count.
496 .It Li S-BCNT Ta Send buffer byte count.
497 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
498 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
499 .El
500 .Sh SEE ALSO
501 .Xr fstat 1 ,
502 .Xr nfsstat 1 ,
503 .Xr procstat 1 ,
504 .Xr ps 1 ,
505 .Xr sockstat 1 ,
506 .Xr bpf 4 ,
507 .Xr inet 4 ,
508 .Xr route 4 ,
509 .Xr unix 4 ,
510 .Xr hosts 5 ,
511 .Xr networks 5 ,
512 .Xr protocols 5 ,
513 .Xr services 5 ,
514 .Xr iostat 8 ,
515 .Xr route 8 ,
516 .Xr trpt 8 ,
517 .Xr vmstat 8 ,
518 .Xr mbuf 9
519 .Sh HISTORY
520 The
521 .Nm
522 command appeared in
523 .Bx 4.2 .
524 .Pp
525 IPv6 support was added by WIDE/KAME project.
526 .Sh BUGS
527 The notion of errors is ill-defined.