Annotation of src/usr.bin/netstat/netstat.1, Revision 1.80
1.80 ! jca 1: .\" $OpenBSD: netstat.1,v 1.79 2016/09/01 14:20:13 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.80 ! jca 33: .Dd $Mdocdate: September 1 2016 $
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
1.76 jmc 108: Show the address of any protocol control blocks associated with sockets;
109: useful for debugging e.g. with the
1.45 jaredy 110: .Fl P
111: flag.
1.75 claudio 112: When used with the
1.76 jmc 113: .Fl r
114: flag it shows the internal addresses of the routing table.
115: Only the super-user can see these addresses;
116: unprivileged users will see them as 0x0.
1.1 deraadt 117: .It Fl a
118: With the default display,
119: show the state of all sockets; normally sockets used by
120: server processes are not shown.
1.63 jsing 121: .It Fl B
122: With the default display,
123: show buffer sizes for TCP sockets.
124: This includes the send window size, receive window size and congestion
125: window size.
1.24 camield 126: .It Fl b
1.34 jmc 127: With the interface display (options
128: .Fl I
129: or
1.24 camield 130: .Fl i ) ,
131: show bytes in and out, instead of packet statistics.
1.57 tedu 132: .It Fl c Ar count
133: Display
134: .Ar count
135: updates, then exit.
136: This option has no effect unless
137: .Fl w
138: is specified as well.
1.1 deraadt 139: .It Fl d
1.34 jmc 140: With either the interface display (options
141: .Fl I
142: or
143: .Fl i )
144: or an interval (option
145: .Fl w ) ,
1.1 deraadt 146: show the number of dropped packets.
1.48 pyr 147: .It Fl F
148: When showing routes, only show routes whose gateway are in the
149: same address family as the destination.
1.16 aaron 150: .It Fl f Ar address_family
1.1 deraadt 151: Limit statistics or address control block reports to those
152: of the specified
1.12 aaron 153: .Ar address_family .
1.21 aaron 154: .Pp
155: The following address families are recognized:
1.65 jmc 156: .Bl -column "Address Family" "AF_APPLETA" "Description" -offset indent
1.21 aaron 157: .It Sy "Address Family" Ta Sy "Constant" Ta Sy "Description"
1.32 jmc 158: .It "inet" Ta Dv "AF_INET" Ta "IP Version 4"
159: .It "inet6" Ta Dv "AF_INET6" Ta "IP Version 6"
160: .It "local" Ta Dv "AF_LOCAL" Ta "Local to Host (i.e., pipes)"
1.55 mk 161: .It "mpls" Ta Dv "AF_MPLS" Ta "MPLS"
1.32 jmc 162: .It "unix" Ta Dv "AF_UNIX" Ta "Local to Host (i.e., pipes)"
1.21 aaron 163: .El
1.68 tedu 164: .It Fl h
165: Use unit suffixes to reduce the number of digits shown with the
166: .Fl b
167: and
168: .Fl w
169: options.
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
184: .Fl f Ar address_family
185: option (with the
186: .Fl s
1.30 jmc 187: option) is present, show per-interface
188: statistics on the given interface for the specified
189: .Ar address_family .
1.1 deraadt 190: .It Fl i
191: Show the state of interfaces which have been auto-configured
1.21 aaron 192: (interfaces statically configured into a system but not
193: located at boot-time are not shown).
194: .Pp
1.19 itojun 195: If the
196: .Fl f Ar address_family
197: option (with the
198: .Fl s
1.30 jmc 199: option) is present, show per-interface statistics on all interfaces
1.21 aaron 200: for the specified
1.30 jmc 201: .Ar address_family .
1.31 jmc 202: .It Fl l
203: With the
204: .Fl g
205: option, display wider fields for the IPv6 multicast routing table
206: .Qq Origin
207: and
208: .Qq Group
209: columns.
1.17 deraadt 210: .It Fl M Ar core
1.1 deraadt 211: Extract values associated with the name list from the specified core
1.27 miod 212: instead of the running kernel.
1.1 deraadt 213: .It Fl m
214: Show statistics recorded by the memory management routines
215: (the network manages a private pool of memory buffers).
1.17 deraadt 216: .It Fl N Ar system
1.27 miod 217: Extract the name list from the specified system instead of the running kernel.
1.1 deraadt 218: .It Fl n
219: Show network addresses as numbers (normally
1.21 aaron 220: .Nm
1.1 deraadt 221: interprets addresses and attempts to display them
222: symbolically).
223: This option may be used with any of the display formats.
1.45 jaredy 224: .It Fl P Ar pcbaddr
1.75 claudio 225: Display the contents of the protocol control block (PCB)
1.61 bluhm 226: located at the kernel virtual address
1.45 jaredy 227: .Ar pcbaddr .
228: PCB addresses can be obtained using the
229: .Fl A
230: flag.
1.61 bluhm 231: When used with the
232: .Fl v
233: option, also print socket, domain and protocol specific structures.
1.76 jmc 234: Only the super-user can use the
235: .Fl P
236: option.
1.80 ! jca 237: .Pp
! 238: The
! 239: .Fl P
! 240: option requires the ability to open
! 241: .Pa /dev/kmem
! 242: which may be restricted based upon the value of the
! 243: .Ar kern.allowkmem
! 244: .Xr sysctl 8 .
1.16 aaron 245: .It Fl p Ar protocol
1.35 markus 246: Restrict the output to
1.12 aaron 247: .Ar protocol ,
1.21 aaron 248: which is either a well-known name for a protocol or an alias for it.
249: Some protocol names and aliases are listed in the file
1.1 deraadt 250: .Pa /etc/protocols .
251: The program will complain if
252: .Ar protocol
1.35 markus 253: is unknown.
254: If the
255: .Fl s
256: option is specified, the per-protocol statistics are displayed.
257: Otherwise the states of the matching sockets are shown.
1.26 brian 258: .It Fl q
259: Only show interfaces that have seen packets (or bytes if
260: .Fl b
1.34 jmc 261: is specified).
1.1 deraadt 262: .It Fl r
263: Show the routing tables.
1.21 aaron 264: If the
1.1 deraadt 265: .Fl s
1.21 aaron 266: option is also specified, show routing statistics instead.
1.60 sobrado 267: When used with the
268: .Fl v
269: option, also print routing labels.
1.26 brian 270: .It Fl s
271: Show per-protocol statistics.
272: If this option is repeated, counters with a value of zero are suppressed.
1.51 claudio 273: .It Fl T Ar tableid
1.67 mikeb 274: Select an alternate routing table to query.
275: The default is to use the current routing table.
1.31 jmc 276: .It Fl t
277: With the
278: .Fl i
279: option, display the current value of the watchdog timer function.
280: .It Fl u
281: Limit statistics or address control block reports to the
282: .Dv AF_UNIX
283: address family.
1.10 peter 284: .It Fl v
1.60 sobrado 285: Show extra (verbose) detail for the routing tables
286: .Pq Fl r ,
287: or avoid truncation of long addresses.
1.61 bluhm 288: When used with the
289: .Fl P
290: option, also print socket, domain and protocol specific structures.
1.42 reyk 291: .It Fl W Ar interface
292: (IEEE 802.11 devices only)
293: Show per-interface IEEE 802.11 wireless statistics.
1.1 deraadt 294: .It Fl w Ar wait
295: Show network interface statistics at intervals of
296: .Ar wait
297: seconds.
298: .El
299: .Pp
300: The default display, for active sockets, shows the local
301: and remote addresses, send and receive queue sizes (in bytes), protocol,
302: and the internal state of the protocol.
1.21 aaron 303: .Pp
304: Address formats are of the form
305: .Dq host.port
306: or
307: .Dq network.port
1.1 deraadt 308: if a socket's address specifies a network but no specific host address.
1.72 schwarze 309: When known, the host addresses are displayed symbolically
310: according to the
311: .Xr hosts 5
312: database.
1.21 aaron 313: If a symbolic name for an address is unknown, or if the
1.1 deraadt 314: .Fl n
315: option is specified, the address is printed numerically, according
316: to the address family.
1.21 aaron 317: .Pp
318: For more information regarding the Internet
319: .Dq dot format ,
1.1 deraadt 320: refer to
1.71 jmc 321: .Xr inet_ntop 3 .
1.34 jmc 322: Unspecified or
1.21 aaron 323: .Dq wildcard
324: addresses and ports appear as a single
1.34 jmc 325: .Sq * .
1.6 deraadt 326: If a local port number is registered as being in use for RPC by
1.12 aaron 327: .Xr portmap 8 ,
1.11 aaron 328: its RPC service name or RPC service number will be printed in
1.21 aaron 329: .Dq []
330: immediately after the port number.
1.1 deraadt 331: .Pp
332: The interface display provides a table of cumulative
333: statistics regarding packets transferred, errors, and collisions.
334: The network addresses of the interface
1.21 aaron 335: and the maximum transmission unit (MTU) are also displayed.
1.1 deraadt 336: .Pp
1.21 aaron 337: The routing table display indicates the available routes and their status.
338: Each route consists of a destination host or network and
339: a gateway to use in forwarding packets.
340: If the destination is a
341: network in numeric format, the netmask (in /24 style format) is appended.
342: The flags field shows a collection of information about
343: the route stored as binary choices.
344: The individual flags are discussed in more detail in the
1.1 deraadt 345: .Xr route 8
346: and
347: .Xr route 4
348: manual pages.
1.21 aaron 349: .Pp
1.1 deraadt 350: The mapping between letters and flags is:
1.66 jmc 351: .Bl -column "1" "RTF_BLACKHOLE" "Protocol specific routing flag #1."
352: .It 1 Ta RTF_PROTO1 Ta "Protocol specific routing flag #1."
353: .It 2 Ta RTF_PROTO2 Ta "Protocol specific routing flag #2."
354: .It 3 Ta RTF_PROTO3 Ta "Protocol specific routing flag #3."
355: .It B Ta RTF_BLACKHOLE Ta "Just discard pkts (during updates)."
1.70 mpi 356: .It b Ta RTF_BROADCAST Ta "Correspond to a local broadcast address."
1.66 jmc 357: .It C Ta RTF_CLONING Ta "Generate new routes on use."
358: .It c Ta RTF_CLONED Ta "Cloned routes (generated from RTF_CLONING)."
359: .It D Ta RTF_DYNAMIC Ta "Created dynamically (by redirect)."
1.79 bluhm 360: .It d Ta RTF_DONE Ta "Completed (for routing messages only)."
1.66 jmc 361: .It G Ta RTF_GATEWAY Ta "Destination requires forwarding by intermediary."
362: .It H Ta RTF_HOST Ta "Host entry (net otherwise)."
1.79 bluhm 363: .It h Ta RTF_CACHED Ta "Referenced by gateway route."
1.66 jmc 364: .It L Ta RTF_LLINFO Ta "Valid protocol to link address translation."
1.70 mpi 365: .It l Ta RTF_LOCAL Ta "Correspond to a local address."
1.66 jmc 366: .It M Ta RTF_MODIFIED Ta "Modified dynamically (by redirect)."
1.78 mpi 367: .It m Ta RTF_MULTICAST Ta "Correspond to a multicast address."
1.79 bluhm 368: .It n Ta RTF_CONNECTED Ta "Interface route."
1.66 jmc 369: .It P Ta RTF_MPATH Ta "Multipath route."
370: .It R Ta RTF_REJECT Ta "Host or net unreachable."
371: .It S Ta RTF_STATIC Ta "Manually added."
372: .It T Ta RTF_MPLS Ta "MPLS route."
373: .It U Ta RTF_UP Ta "Route usable."
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.71 jmc 421: .Xr inet_ntop 3 ,
1.21 aaron 422: .Xr netintro 4 ,
1.34 jmc 423: .Xr route 4 ,
1.1 deraadt 424: .Xr hosts 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