Annotation of src/usr.bin/netstat/netstat.1, Revision 1.63
1.62 schwarze 1: .\" $OpenBSD: netstat.1,v 1.61 2010/10/30 23:06:05 bluhm Exp $
1.1 deraadt 2: .\" $NetBSD: netstat.1,v 1.11 1995/10/03 21:42:43 thorpej Exp $
3: .\"
4: .\" Copyright (c) 1983, 1990, 1992, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
1.29 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" from: @(#)netstat.1 8.8 (Berkeley) 4/18/94
32: .\"
1.62 schwarze 33: .Dd $Mdocdate: October 30 2010 $
1.1 deraadt 34: .Dt NETSTAT 1
1.16 aaron 35: .Os
1.1 deraadt 36: .Sh NAME
37: .Nm netstat
38: .Nd show network status
39: .Sh SYNOPSIS
40: .Nm netstat
1.63 ! jsing 41: .Op Fl AaBn
1.1 deraadt 42: .Op Fl f Ar address_family
1.59 blambert 43: .Op Fl p Ar protocol
1.1 deraadt 44: .Op Fl M Ar core
45: .Op Fl N Ar system
46: .Nm netstat
1.52 claudio 47: .Bk -words
1.48 pyr 48: .Op Fl bdFgilmnqrstu
1.1 deraadt 49: .Op Fl f Ar address_family
1.59 blambert 50: .Op Fl p Ar protocol
1.1 deraadt 51: .Op Fl M Ar core
52: .Op Fl N Ar system
1.52 claudio 53: .Op Fl T Ar tableid
54: .Ek
1.1 deraadt 55: .Nm netstat
1.24 camield 56: .Op Fl bdn
1.57 tedu 57: .Op Fl c Ar count
1.1 deraadt 58: .Op Fl I Ar interface
59: .Op Fl M Ar core
60: .Op Fl N Ar system
61: .Op Fl w Ar wait
62: .Nm netstat
1.61 bluhm 63: .Op Fl v
1.45 jaredy 64: .Op Fl M Ar core
65: .Op Fl N Ar system
66: .Fl P Ar pcbaddr
67: .Nm netstat
1.35 markus 68: .Op Fl s
1.1 deraadt 69: .Op Fl M Ar core
70: .Op Fl N Ar system
1.31 jmc 71: .Op Fl p Ar protocol
1.19 itojun 72: .Nm netstat
1.34 jmc 73: .Op Fl a
1.19 itojun 74: .Op Fl f Ar address_family
1.59 blambert 75: .Op Fl p Ar protocol
1.34 jmc 76: .Op Fl i | I Ar interface
1.42 reyk 77: .Nm netstat
78: .Op Fl W Ar interface
1.1 deraadt 79: .Sh DESCRIPTION
80: The
1.21 aaron 81: .Nm
1.1 deraadt 82: command symbolically displays the contents of various network-related
83: data structures.
84: There are a number of output formats,
85: depending on the options for the information presented.
1.21 aaron 86: .Pp
1.1 deraadt 87: The first form of the command displays a list of active sockets for
88: each protocol.
89: The second form presents the contents of one of the other network
90: data structures according to the option selected.
91: Using the third form, with a
92: .Ar wait
93: interval specified,
1.21 aaron 94: .Nm
1.1 deraadt 95: will continuously display the information regarding packet
96: traffic on the configured network interfaces.
1.61 bluhm 97: The fourth form displays internals of the protocol control block (PCB)
98: and the socket structure.
1.46 jmc 99: The fifth form displays statistics about the named protocol.
100: The sixth form displays per interface statistics for
1.30 jmc 101: the specified address family.
1.43 jmc 102: The final form displays per interface statistics for
103: the specified wireless (802.11) device.
1.1 deraadt 104: .Pp
1.12 aaron 105: The options are as follows:
1.22 aaron 106: .Bl -tag -width Ds
1.1 deraadt 107: .It Fl A
108: With the default display,
109: show the address of any protocol control blocks associated with sockets; used
1.45 jaredy 110: for debugging, e.g. with the
111: .Fl P
112: flag.
1.1 deraadt 113: .It Fl a
114: With the default display,
115: show the state of all sockets; normally sockets used by
116: server processes are not shown.
1.34 jmc 117: With the interface display (options
118: .Fl I
119: or
120: .Fl i ) ,
121: show multicast addresses.
1.63 ! jsing 122: .It Fl B
! 123: With the default display,
! 124: show buffer sizes for TCP sockets.
! 125: This includes the send window size, receive window size and congestion
! 126: window size.
1.24 camield 127: .It Fl b
1.34 jmc 128: With the interface display (options
129: .Fl I
130: or
1.24 camield 131: .Fl i ) ,
132: show bytes in and out, instead of packet statistics.
1.57 tedu 133: .It Fl c Ar count
134: Display
135: .Ar count
136: updates, then exit.
137: This option has no effect unless
138: .Fl w
139: is specified as well.
1.1 deraadt 140: .It Fl d
1.34 jmc 141: With either the interface display (options
142: .Fl I
143: or
144: .Fl i )
145: or an interval (option
146: .Fl w ) ,
1.1 deraadt 147: show the number of dropped packets.
1.48 pyr 148: .It Fl F
149: When showing routes, only show routes whose gateway are in the
150: same address family as the destination.
1.16 aaron 151: .It Fl f Ar address_family
1.1 deraadt 152: Limit statistics or address control block reports to those
153: of the specified
1.12 aaron 154: .Ar address_family .
1.21 aaron 155: .Pp
156: The following address families are recognized:
157: .Pp
158: .Bl -column "Address Family" "AF_APPLETA" "Description" -offset indent -compact
159: .It Sy "Address Family" Ta Sy "Constant" Ta Sy "Description"
1.55 mk 160: .It "atalk" Ta Dv "AF_APPLETALK" Ta "AppleTalk"
161: .It "encap" Ta Dv "PF_KEY" Ta "IPsec"
1.32 jmc 162: .It "inet" Ta Dv "AF_INET" Ta "IP Version 4"
163: .It "inet6" Ta Dv "AF_INET6" Ta "IP Version 6"
164: .It "local" Ta Dv "AF_LOCAL" Ta "Local to Host (i.e., pipes)"
1.55 mk 165: .It "mpls" Ta Dv "AF_MPLS" Ta "MPLS"
166: .It "pflow" Ta Dv "PF_FLOW" Ta "pflow data export"
1.32 jmc 167: .It "unix" Ta Dv "AF_UNIX" Ta "Local to Host (i.e., pipes)"
1.21 aaron 168: .El
169: .Pp
1.1 deraadt 170: .It Fl g
171: Show information related to multicast (group address) routing.
1.34 jmc 172: By default, show the IP multicast virtual-interface and routing tables.
1.1 deraadt 173: If the
174: .Fl s
175: option is also present, show multicast routing statistics.
1.16 aaron 176: .It Fl I Ar interface
1.21 aaron 177: Show information about the specified
178: .Ar interface ;
1.1 deraadt 179: used with a
180: .Ar wait
181: interval as described below.
1.21 aaron 182: .Pp
1.19 itojun 183: If the
1.34 jmc 184: .Fl a
185: option is also present, multicast addresses currently in use are shown
186: for the given interface and for each IP interface address.
187: Multicast addresses are shown on separate lines following the interface
188: address with which they are associated.
189: .Pp
190: If the
1.19 itojun 191: .Fl f Ar address_family
192: option (with the
193: .Fl s
1.30 jmc 194: option) is present, show per-interface
195: statistics on the given interface for the specified
196: .Ar address_family .
1.1 deraadt 197: .It Fl i
198: Show the state of interfaces which have been auto-configured
1.21 aaron 199: (interfaces statically configured into a system but not
200: located at boot-time are not shown).
201: .Pp
1.1 deraadt 202: If the
203: .Fl a
1.21 aaron 204: option is also present, multicast addresses currently in use are shown
1.1 deraadt 205: for each Ethernet interface and for each IP interface address.
206: Multicast addresses are shown on separate lines following the interface
207: address with which they are associated.
1.21 aaron 208: .Pp
1.19 itojun 209: If the
210: .Fl f Ar address_family
211: option (with the
212: .Fl s
1.30 jmc 213: option) is present, show per-interface statistics on all interfaces
1.21 aaron 214: for the specified
1.30 jmc 215: .Ar address_family .
1.31 jmc 216: .It Fl l
217: With the
218: .Fl g
219: option, display wider fields for the IPv6 multicast routing table
220: .Qq Origin
221: and
222: .Qq Group
223: columns.
1.17 deraadt 224: .It Fl M Ar core
1.1 deraadt 225: Extract values associated with the name list from the specified core
1.27 miod 226: instead of the running kernel.
1.1 deraadt 227: .It Fl m
228: Show statistics recorded by the memory management routines
229: (the network manages a private pool of memory buffers).
1.17 deraadt 230: .It Fl N Ar system
1.27 miod 231: Extract the name list from the specified system instead of the running kernel.
1.1 deraadt 232: .It Fl n
233: Show network addresses as numbers (normally
1.21 aaron 234: .Nm
1.1 deraadt 235: interprets addresses and attempts to display them
236: symbolically).
237: This option may be used with any of the display formats.
1.45 jaredy 238: .It Fl P Ar pcbaddr
1.61 bluhm 239: Display the contents of the socket or protocol control block (PCB)
240: located at the kernel virtual address
1.45 jaredy 241: .Ar pcbaddr .
242: PCB addresses can be obtained using the
243: .Fl A
244: flag.
1.61 bluhm 245: When used with the
246: .Fl v
247: option, also print socket, domain and protocol specific structures.
1.16 aaron 248: .It Fl p Ar protocol
1.35 markus 249: Restrict the output to
1.12 aaron 250: .Ar protocol ,
1.21 aaron 251: which is either a well-known name for a protocol or an alias for it.
252: Some protocol names and aliases are listed in the file
1.1 deraadt 253: .Pa /etc/protocols .
254: The program will complain if
255: .Ar protocol
1.35 markus 256: is unknown.
257: If the
258: .Fl s
259: option is specified, the per-protocol statistics are displayed.
260: Otherwise the states of the matching sockets are shown.
1.26 brian 261: .It Fl q
262: Only show interfaces that have seen packets (or bytes if
263: .Fl b
1.34 jmc 264: is specified).
1.1 deraadt 265: .It Fl r
266: Show the routing tables.
1.21 aaron 267: If the
1.1 deraadt 268: .Fl s
1.21 aaron 269: option is also specified, show routing statistics instead.
1.60 sobrado 270: When used with the
271: .Fl v
272: option, also print routing labels.
1.26 brian 273: .It Fl s
274: Show per-protocol statistics.
275: If this option is repeated, counters with a value of zero are suppressed.
1.51 claudio 276: .It Fl T Ar tableid
277: Select an alternate routing table to modify or query.
278: Table 0 is the default table.
1.31 jmc 279: .It Fl t
280: With the
281: .Fl i
282: option, display the current value of the watchdog timer function.
283: .It Fl u
284: Limit statistics or address control block reports to the
285: .Dv AF_UNIX
286: address family.
1.10 peter 287: .It Fl v
1.60 sobrado 288: Show extra (verbose) detail for the routing tables
289: .Pq Fl r ,
290: or avoid truncation of long addresses.
1.61 bluhm 291: When used with the
292: .Fl P
293: option, also print socket, domain and protocol specific structures.
1.42 reyk 294: .It Fl W Ar interface
295: (IEEE 802.11 devices only)
296: Show per-interface IEEE 802.11 wireless statistics.
1.1 deraadt 297: .It Fl w Ar wait
298: Show network interface statistics at intervals of
299: .Ar wait
300: seconds.
301: .El
302: .Pp
303: The default display, for active sockets, shows the local
304: and remote addresses, send and receive queue sizes (in bytes), protocol,
305: and the internal state of the protocol.
1.21 aaron 306: .Pp
307: Address formats are of the form
308: .Dq host.port
309: or
310: .Dq network.port
1.1 deraadt 311: if a socket's address specifies a network but no specific host address.
1.21 aaron 312: When known, the host and network addresses are displayed symbolically
313: according to the databases
1.1 deraadt 314: .Pa /etc/hosts
315: and
316: .Pa /etc/networks ,
1.21 aaron 317: respectively.
318: If a symbolic name for an address is unknown, or if the
1.1 deraadt 319: .Fl n
320: option is specified, the address is printed numerically, according
321: to the address family.
1.21 aaron 322: .Pp
323: For more information regarding the Internet
324: .Dq dot format ,
1.1 deraadt 325: refer to
1.12 aaron 326: .Xr inet 3 .
1.34 jmc 327: Unspecified or
1.21 aaron 328: .Dq wildcard
329: addresses and ports appear as a single
1.34 jmc 330: .Sq * .
1.6 deraadt 331: If a local port number is registered as being in use for RPC by
1.12 aaron 332: .Xr portmap 8 ,
1.11 aaron 333: its RPC service name or RPC service number will be printed in
1.21 aaron 334: .Dq []
335: immediately after the port number.
1.1 deraadt 336: .Pp
337: The interface display provides a table of cumulative
338: statistics regarding packets transferred, errors, and collisions.
339: The network addresses of the interface
1.21 aaron 340: and the maximum transmission unit (MTU) are also displayed.
1.1 deraadt 341: .Pp
1.21 aaron 342: The routing table display indicates the available routes and their status.
343: Each route consists of a destination host or network and
344: a gateway to use in forwarding packets.
345: If the destination is a
346: network in numeric format, the netmask (in /24 style format) is appended.
347: The flags field shows a collection of information about
348: the route stored as binary choices.
349: The individual flags are discussed in more detail in the
1.1 deraadt 350: .Xr route 8
351: and
352: .Xr route 4
353: manual pages.
1.21 aaron 354: .Pp
1.1 deraadt 355: The mapping between letters and flags is:
356: .Bl -column XXXX RTF_BLACKHOLE
1.58 schwarze 357: .It 1 RTF_PROTO1 Protocol specific routing flag #1.
358: .It 2 RTF_PROTO2 Protocol specific routing flag #2.
359: .It 3 RTF_PROTO3 Protocol specific routing flag #3.
360: .It B RTF_BLACKHOLE Just discard pkts (during updates).
361: .It C RTF_CLONING Generate new routes on use.
362: .It c RTF_CLONED Cloned routes (generated from RTF_CLONING).
363: .It D RTF_DYNAMIC Created dynamically (by redirect).
364: .It G RTF_GATEWAY Destination requires forwarding by intermediary.
365: .It H RTF_HOST Host entry (net otherwise).
366: .It L RTF_LLINFO Valid protocol to link address translation.
367: .It M RTF_MODIFIED Modified dynamically (by redirect).
368: .It P RTF_MPATH Multipath route.
369: .It R RTF_REJECT Host or net unreachable.
370: .It S RTF_STATIC Manually added.
371: .It T RTF_MPLS MPLS route.
372: .It U RTF_UP Route usable.
373: .It X RTF_XRESOLVE External daemon translates proto to link address.
1.1 deraadt 374: .El
375: .Pp
1.21 aaron 376: Direct routes are created for each interface attached to the local host;
1.1 deraadt 377: the gateway field for such entries shows the address of the outgoing interface.
1.21 aaron 378: The refcnt field gives the current number of active uses of the route.
379: Connection oriented protocols normally hold on to a single route for the
380: duration of a connection while connectionless protocols obtain a route while
381: sending to the same destination.
382: The use field provides a count of the number of packets sent using that route.
383: The MTU entry shows the MTU associated with that route.
384: This MTU value is used as the basis for the TCP maximum segment size (MSS).
1.34 jmc 385: The
386: .Sq L
387: flag appended to the MTU value indicates that the value is
388: locked, and that path MTU discovery is turned off for that route.
1.21 aaron 389: A
1.1 deraadt 390: .Sq -
1.12 aaron 391: indicates that the MTU for this route has not been set, and a default
1.21 aaron 392: TCP maximum segment size will be used.
393: The interface entry indicates the network interface utilized for the route.
1.1 deraadt 394: .Pp
395: When
1.21 aaron 396: .Nm
1.1 deraadt 397: is invoked with the
398: .Fl w
399: option and a
400: .Ar wait
401: interval argument, it displays a running count of statistics related to
402: network interfaces.
403: An obsolescent version of this option used a numeric parameter
404: with no option, and is currently supported for backward compatibility.
405: This display consists of a column for the primary interface (the first
406: interface found during autoconfiguration) and a column summarizing
407: information for all interfaces.
408: The primary interface may be replaced with another interface with the
409: .Fl I
410: option.
411: The first line of each screen of information contains a summary since the
1.21 aaron 412: system was last rebooted.
413: Subsequent lines of output show values accumulated over the preceding interval.
1.1 deraadt 414: .Sh SEE ALSO
1.47 jmc 415: .Xr fstat 1 ,
1.1 deraadt 416: .Xr nfsstat 1 ,
417: .Xr ps 1 ,
1.47 jmc 418: .Xr systat 1 ,
1.53 jmc 419: .Xr tcpbench 1 ,
1.47 jmc 420: .Xr top 1 ,
1.34 jmc 421: .Xr inet 3 ,
1.21 aaron 422: .Xr netintro 4 ,
1.34 jmc 423: .Xr route 4 ,
1.1 deraadt 424: .Xr hosts 5 ,
425: .Xr networks 5 ,
426: .Xr protocols 5 ,
427: .Xr services 5 ,
1.15 alex 428: .Xr iostat 8 ,
1.34 jmc 429: .Xr portmap 8 ,
1.47 jmc 430: .Xr pstat 8 ,
1.34 jmc 431: .Xr route 8 ,
1.40 jmc 432: .Xr tcpdrop 8 ,
1.1 deraadt 433: .Xr trpt 8 ,
434: .Xr vmstat 8
435: .Sh HISTORY
436: The
1.21 aaron 437: .Nm
1.1 deraadt 438: command appeared in
439: .Bx 4.2 .
1.62 schwarze 440: IPv6 support was added by the WIDE/KAME project.
1.1 deraadt 441: .Sh BUGS
442: The notion of errors is ill-defined.
![[BACK]](/icons/back.gif){kind=icon}
Return to netstat.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / netstat