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