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