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