Annotation of src/usr.bin/netstat/netstat.1, Revision 1.64
1.64 ! deraadt 1: .\" $OpenBSD: netstat.1,v 1.63 2011/03/15 13:10:31 jsing 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.64 ! deraadt 33: .Dd $Mdocdate: March 15 2011 $
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 "encap" Ta Dv "PF_KEY" Ta "IPsec"
1.32 jmc 161: .It "inet" Ta Dv "AF_INET" Ta "IP Version 4"
162: .It "inet6" Ta Dv "AF_INET6" Ta "IP Version 6"
163: .It "local" Ta Dv "AF_LOCAL" Ta "Local to Host (i.e., pipes)"
1.55 mk 164: .It "mpls" Ta Dv "AF_MPLS" Ta "MPLS"
165: .It "pflow" Ta Dv "PF_FLOW" Ta "pflow data export"
1.32 jmc 166: .It "unix" Ta Dv "AF_UNIX" Ta "Local to Host (i.e., pipes)"
1.21 aaron 167: .El
168: .Pp
1.1 deraadt 169: .It Fl g
170: Show information related to multicast (group address) routing.
1.34 jmc 171: By default, show the IP multicast virtual-interface and routing tables.
1.1 deraadt 172: If the
173: .Fl s
174: option is also present, show multicast routing statistics.
1.16 aaron 175: .It Fl I Ar interface
1.21 aaron 176: Show information about the specified
177: .Ar interface ;
1.1 deraadt 178: used with a
179: .Ar wait
180: interval as described below.
1.21 aaron 181: .Pp
1.19 itojun 182: If the
1.34 jmc 183: .Fl a
184: option is also present, multicast addresses currently in use are shown
185: for the given interface and for each IP interface address.
186: Multicast addresses are shown on separate lines following the interface
187: address with which they are associated.
188: .Pp
189: If the
1.19 itojun 190: .Fl f Ar address_family
191: option (with the
192: .Fl s
1.30 jmc 193: option) is present, show per-interface
194: statistics on the given interface for the specified
195: .Ar address_family .
1.1 deraadt 196: .It Fl i
197: Show the state of interfaces which have been auto-configured
1.21 aaron 198: (interfaces statically configured into a system but not
199: located at boot-time are not shown).
200: .Pp
1.1 deraadt 201: If the
202: .Fl a
1.21 aaron 203: option is also present, multicast addresses currently in use are shown
1.1 deraadt 204: for each Ethernet interface and for each IP interface address.
205: Multicast addresses are shown on separate lines following the interface
206: address with which they are associated.
1.21 aaron 207: .Pp
1.19 itojun 208: If the
209: .Fl f Ar address_family
210: option (with the
211: .Fl s
1.30 jmc 212: option) is present, show per-interface statistics on all interfaces
1.21 aaron 213: for the specified
1.30 jmc 214: .Ar address_family .
1.31 jmc 215: .It Fl l
216: With the
217: .Fl g
218: option, display wider fields for the IPv6 multicast routing table
219: .Qq Origin
220: and
221: .Qq Group
222: columns.
1.17 deraadt 223: .It Fl M Ar core
1.1 deraadt 224: Extract values associated with the name list from the specified core
1.27 miod 225: instead of the running kernel.
1.1 deraadt 226: .It Fl m
227: Show statistics recorded by the memory management routines
228: (the network manages a private pool of memory buffers).
1.17 deraadt 229: .It Fl N Ar system
1.27 miod 230: Extract the name list from the specified system instead of the running kernel.
1.1 deraadt 231: .It Fl n
232: Show network addresses as numbers (normally
1.21 aaron 233: .Nm
1.1 deraadt 234: interprets addresses and attempts to display them
235: symbolically).
236: This option may be used with any of the display formats.
1.45 jaredy 237: .It Fl P Ar pcbaddr
1.61 bluhm 238: Display the contents of the socket or protocol control block (PCB)
239: located at the kernel virtual address
1.45 jaredy 240: .Ar pcbaddr .
241: PCB addresses can be obtained using the
242: .Fl A
243: flag.
1.61 bluhm 244: When used with the
245: .Fl v
246: option, also print socket, domain and protocol specific structures.
1.16 aaron 247: .It Fl p Ar protocol
1.35 markus 248: Restrict the output to
1.12 aaron 249: .Ar protocol ,
1.21 aaron 250: which is either a well-known name for a protocol or an alias for it.
251: Some protocol names and aliases are listed in the file
1.1 deraadt 252: .Pa /etc/protocols .
253: The program will complain if
254: .Ar protocol
1.35 markus 255: is unknown.
256: If the
257: .Fl s
258: option is specified, the per-protocol statistics are displayed.
259: Otherwise the states of the matching sockets are shown.
1.26 brian 260: .It Fl q
261: Only show interfaces that have seen packets (or bytes if
262: .Fl b
1.34 jmc 263: is specified).
1.1 deraadt 264: .It Fl r
265: Show the routing tables.
1.21 aaron 266: If the
1.1 deraadt 267: .Fl s
1.21 aaron 268: option is also specified, show routing statistics instead.
1.60 sobrado 269: When used with the
270: .Fl v
271: option, also print routing labels.
1.26 brian 272: .It Fl s
273: Show per-protocol statistics.
274: If this option is repeated, counters with a value of zero are suppressed.
1.51 claudio 275: .It Fl T Ar tableid
276: Select an alternate routing table to modify or query.
277: Table 0 is the default table.
1.31 jmc 278: .It Fl t
279: With the
280: .Fl i
281: option, display the current value of the watchdog timer function.
282: .It Fl u
283: Limit statistics or address control block reports to the
284: .Dv AF_UNIX
285: address family.
1.10 peter 286: .It Fl v
1.60 sobrado 287: Show extra (verbose) detail for the routing tables
288: .Pq Fl r ,
289: or avoid truncation of long addresses.
1.61 bluhm 290: When used with the
291: .Fl P
292: option, also print socket, domain and protocol specific structures.
1.42 reyk 293: .It Fl W Ar interface
294: (IEEE 802.11 devices only)
295: Show per-interface IEEE 802.11 wireless statistics.
1.1 deraadt 296: .It Fl w Ar wait
297: Show network interface statistics at intervals of
298: .Ar wait
299: seconds.
300: .El
301: .Pp
302: The default display, for active sockets, shows the local
303: and remote addresses, send and receive queue sizes (in bytes), protocol,
304: and the internal state of the protocol.
1.21 aaron 305: .Pp
306: Address formats are of the form
307: .Dq host.port
308: or
309: .Dq network.port
1.1 deraadt 310: if a socket's address specifies a network but no specific host address.
1.21 aaron 311: When known, the host and network addresses are displayed symbolically
312: according to the databases
1.1 deraadt 313: .Pa /etc/hosts
314: and
315: .Pa /etc/networks ,
1.21 aaron 316: respectively.
317: If a symbolic name for an address is unknown, or if the
1.1 deraadt 318: .Fl n
319: option is specified, the address is printed numerically, according
320: to the address family.
1.21 aaron 321: .Pp
322: For more information regarding the Internet
323: .Dq dot format ,
1.1 deraadt 324: refer to
1.12 aaron 325: .Xr inet 3 .
1.34 jmc 326: Unspecified or
1.21 aaron 327: .Dq wildcard
328: addresses and ports appear as a single
1.34 jmc 329: .Sq * .
1.6 deraadt 330: If a local port number is registered as being in use for RPC by
1.12 aaron 331: .Xr portmap 8 ,
1.11 aaron 332: its RPC service name or RPC service number will be printed in
1.21 aaron 333: .Dq []
334: immediately after the port number.
1.1 deraadt 335: .Pp
336: The interface display provides a table of cumulative
337: statistics regarding packets transferred, errors, and collisions.
338: The network addresses of the interface
1.21 aaron 339: and the maximum transmission unit (MTU) are also displayed.
1.1 deraadt 340: .Pp
1.21 aaron 341: The routing table display indicates the available routes and their status.
342: Each route consists of a destination host or network and
343: a gateway to use in forwarding packets.
344: If the destination is a
345: network in numeric format, the netmask (in /24 style format) is appended.
346: The flags field shows a collection of information about
347: the route stored as binary choices.
348: The individual flags are discussed in more detail in the
1.1 deraadt 349: .Xr route 8
350: and
351: .Xr route 4
352: manual pages.
1.21 aaron 353: .Pp
1.1 deraadt 354: The mapping between letters and flags is:
355: .Bl -column XXXX RTF_BLACKHOLE
1.58 schwarze 356: .It 1 RTF_PROTO1 Protocol specific routing flag #1.
357: .It 2 RTF_PROTO2 Protocol specific routing flag #2.
358: .It 3 RTF_PROTO3 Protocol specific routing flag #3.
359: .It B RTF_BLACKHOLE Just discard pkts (during updates).
360: .It C RTF_CLONING Generate new routes on use.
361: .It c RTF_CLONED Cloned routes (generated from RTF_CLONING).
362: .It D RTF_DYNAMIC Created dynamically (by redirect).
363: .It G RTF_GATEWAY Destination requires forwarding by intermediary.
364: .It H RTF_HOST Host entry (net otherwise).
365: .It L RTF_LLINFO Valid protocol to link address translation.
366: .It M RTF_MODIFIED Modified dynamically (by redirect).
367: .It P RTF_MPATH Multipath route.
368: .It R RTF_REJECT Host or net unreachable.
369: .It S RTF_STATIC Manually added.
370: .It T RTF_MPLS MPLS route.
371: .It U RTF_UP Route usable.
372: .It X RTF_XRESOLVE External daemon translates proto to link address.
1.1 deraadt 373: .El
374: .Pp
1.21 aaron 375: Direct routes are created for each interface attached to the local host;
1.1 deraadt 376: the gateway field for such entries shows the address of the outgoing interface.
1.21 aaron 377: The refcnt field gives the current number of active uses of the route.
378: Connection oriented protocols normally hold on to a single route for the
379: duration of a connection while connectionless protocols obtain a route while
380: sending to the same destination.
381: The use field provides a count of the number of packets sent using that route.
382: The MTU entry shows the MTU associated with that route.
383: This MTU value is used as the basis for the TCP maximum segment size (MSS).
1.34 jmc 384: The
385: .Sq L
386: flag appended to the MTU value indicates that the value is
387: locked, and that path MTU discovery is turned off for that route.
1.21 aaron 388: A
1.1 deraadt 389: .Sq -
1.12 aaron 390: indicates that the MTU for this route has not been set, and a default
1.21 aaron 391: TCP maximum segment size will be used.
392: The interface entry indicates the network interface utilized for the route.
1.1 deraadt 393: .Pp
394: When
1.21 aaron 395: .Nm
1.1 deraadt 396: is invoked with the
397: .Fl w
398: option and a
399: .Ar wait
400: interval argument, it displays a running count of statistics related to
401: network interfaces.
402: An obsolescent version of this option used a numeric parameter
403: with no option, and is currently supported for backward compatibility.
404: This display consists of a column for the primary interface (the first
405: interface found during autoconfiguration) and a column summarizing
406: information for all interfaces.
407: The primary interface may be replaced with another interface with the
408: .Fl I
409: option.
410: The first line of each screen of information contains a summary since the
1.21 aaron 411: system was last rebooted.
412: Subsequent lines of output show values accumulated over the preceding interval.
1.1 deraadt 413: .Sh SEE ALSO
1.47 jmc 414: .Xr fstat 1 ,
1.1 deraadt 415: .Xr nfsstat 1 ,
416: .Xr ps 1 ,
1.47 jmc 417: .Xr systat 1 ,
1.53 jmc 418: .Xr tcpbench 1 ,
1.47 jmc 419: .Xr top 1 ,
1.34 jmc 420: .Xr inet 3 ,
1.21 aaron 421: .Xr netintro 4 ,
1.34 jmc 422: .Xr route 4 ,
1.1 deraadt 423: .Xr hosts 5 ,
424: .Xr networks 5 ,
425: .Xr protocols 5 ,
426: .Xr services 5 ,
1.15 alex 427: .Xr iostat 8 ,
1.34 jmc 428: .Xr portmap 8 ,
1.47 jmc 429: .Xr pstat 8 ,
1.34 jmc 430: .Xr route 8 ,
1.40 jmc 431: .Xr tcpdrop 8 ,
1.1 deraadt 432: .Xr trpt 8 ,
433: .Xr vmstat 8
434: .Sh HISTORY
435: The
1.21 aaron 436: .Nm
1.1 deraadt 437: command appeared in
438: .Bx 4.2 .
1.62 schwarze 439: IPv6 support was added by the WIDE/KAME project.
1.1 deraadt 440: .Sh BUGS
441: 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