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