Annotation of src/usr.bin/netstat/netstat.1, Revision 1.6
1.6 ! deraadt 1: .\" $OpenBSD: netstat.1,v 1.5 1997/02/01 17:31:20 kstailey 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.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" from: @(#)netstat.1 8.8 (Berkeley) 4/18/94
36: .\"
37: .Dd April 18, 1994
38: .Dt NETSTAT 1
39: .Os BSD 4.2
40: .Sh NAME
41: .Nm netstat
42: .Nd show network status
43: .Sh SYNOPSIS
44: .Nm netstat
45: .Op Fl Aan
46: .Op Fl f Ar address_family
47: .Op Fl M Ar core
48: .Op Fl N Ar system
49: .Nm netstat
50: .Op Fl dghimnrs
51: .Op Fl f Ar address_family
52: .Op Fl M Ar core
53: .Op Fl N Ar system
54: .Nm netstat
55: .Op Fl dn
56: .Op Fl I Ar interface
57: .Op Fl M Ar core
58: .Op Fl N Ar system
59: .Op Fl w Ar wait
60: .Nm netstat
61: .Op Fl p Ar protocol
62: .Op Fl M Ar core
63: .Op Fl N Ar system
64: .Sh DESCRIPTION
65: The
66: .Nm netstat
67: command symbolically displays the contents of various network-related
68: data structures.
69: There are a number of output formats,
70: depending on the options for the information presented.
71: The first form of the command displays a list of active sockets for
72: each protocol.
73: The second form presents the contents of one of the other network
74: data structures according to the option selected.
75: Using the third form, with a
76: .Ar wait
77: interval specified,
78: .Nm netstat
79: will continuously display the information regarding packet
80: traffic on the configured network interfaces.
81: The fourth form displays statistics about the named protocol.
82: .Pp
83: The options have the following meaning:
84: .Bl -tag -width flag
85: .It Fl A
86: With the default display,
87: show the address of any protocol control blocks associated with sockets; used
88: for debugging.
89: .It Fl a
90: With the default display,
91: show the state of all sockets; normally sockets used by
92: server processes are not shown.
93: .It Fl d
94: With either interface display (option
95: .Fl i
96: or an interval, as described below),
97: show the number of dropped packets.
98: .It Fl f Ar address_family
99: Limit statistics or address control block reports to those
100: of the specified
101: .Ar address family .
102: The following address families
103: are recognized:
104: .Ar inet ,
105: for
106: .Dv AF_INET ,
1.4 mickey 107: .Ar ipx ,
108: for
109: .Dv AF_IPX ,
1.1 deraadt 110: .Ar ns ,
111: for
112: .Dv AF_NS ,
113: .Ar iso ,
114: for
115: .Dv AF_ISO ,
1.5 kstailey 116: .Ar local ,
117: for
118: .Dv AF_LOCAL ,
1.1 deraadt 119: and
120: .Ar unix ,
121: for
122: .Dv AF_UNIX .
123: .It Fl g
124: Show information related to multicast (group address) routing.
125: By default, show the IP Multicast virtual-interface and routing tables.
126: If the
127: .Fl s
128: option is also present, show multicast routing statistics.
129: .It Fl h
130: Show the state of the
131: .Tn IMP
132: host table (obsolete).
133: .It Fl I Ar interface
134: Show information about the specified interface;
135: used with a
136: .Ar wait
137: interval as described below.
138: .It Fl i
139: Show the state of interfaces which have been auto-configured
140: (interfaces statically configured into a system, but not
141: located at boot time are not shown).
142: If the
143: .Fl a
144: options is also present, multicast addresses currently in use are shown
145: for each Ethernet interface and for each IP interface address.
146: Multicast addresses are shown on separate lines following the interface
147: address with which they are associated.
148: .It Fl M
149: Extract values associated with the name list from the specified core
150: instead of the default
151: .Pa /dev/kmem .
152: .It Fl m
153: Show statistics recorded by the memory management routines
154: (the network manages a private pool of memory buffers).
155: .It Fl N
156: Extract the name list from the specified system instead of the default
1.3 ccappuc 157: .Pa /bsd .
1.1 deraadt 158: .It Fl n
159: Show network addresses as numbers (normally
160: .Nm netstat
161: interprets addresses and attempts to display them
162: symbolically).
163: This option may be used with any of the display formats.
164: .It Fl p Ar protocol
165: Show statistics about
166: .Ar protocol ,
167: which is either a well-known name for a protocol or an alias for it. Some
168: protocol names and aliases are listed in the file
169: .Pa /etc/protocols .
170: A null response typically means that there are no interesting numbers to
171: report.
172: The program will complain if
173: .Ar protocol
174: is unknown or if there is no statistics routine for it.
175: .It Fl s
176: Show per-protocol statistics.
177: If this option is repeated, counters with a value of zero are suppressed.
178: .It Fl r
179: Show the routing tables.
180: When
181: .Fl s
182: is also present, show routing statistics instead.
183: .It Fl w Ar wait
184: Show network interface statistics at intervals of
185: .Ar wait
186: seconds.
187: .El
188: .Pp
189: The default display, for active sockets, shows the local
190: and remote addresses, send and receive queue sizes (in bytes), protocol,
191: and the internal state of the protocol.
192: Address formats are of the form ``host.port'' or ``network.port''
193: if a socket's address specifies a network but no specific host address.
194: When known the host and network addresses are displayed symbolically
195: according to the data bases
196: .Pa /etc/hosts
197: and
198: .Pa /etc/networks ,
199: respectively. If a symbolic name for an address is unknown, or if
200: the
201: .Fl n
202: option is specified, the address is printed numerically, according
203: to the address family.
204: For more information regarding
205: the Internet ``dot format,''
206: refer to
207: .Xr inet 3 ) .
208: Unspecified,
209: or ``wildcard'', addresses and ports appear as ``*''.
1.6 ! deraadt 210: If a local port number is registered as being in use for RPC by
! 211: .Xr portmap 8
! 212: it's RPC service name or RPC service number will be printed in
! 213: [ ] immediately after the port number.
1.1 deraadt 214: .Pp
215: The interface display provides a table of cumulative
216: statistics regarding packets transferred, errors, and collisions.
217: The network addresses of the interface
218: and the maximum transmission unit (``mtu'') are also displayed.
219: .Pp
220: The routing table display indicates the available routes and
221: their status. Each route consists of a destination host or network
222: and a gateway to use in forwarding packets. The flags field shows
223: a collection of information about the route stored as
224: binary choices. The individual flags are discussed in more
225: detail in the
226: .Xr route 8
227: and
228: .Xr route 4
229: manual pages.
230: The mapping between letters and flags is:
231: .Bl -column XXXX RTF_BLACKHOLE
232: 1 RTF_PROTO2 Protocol specific routing flag #1
233: 2 RTF_PROTO1 Protocol specific routing flag #2
234: B RTF_BLACKHOLE Just discard pkts (during updates)
235: C RTF_CLONING Generate new routes on use
236: D RTF_DYNAMIC Created dynamically (by redirect)
237: G RTF_GATEWAY Destination requires forwarding by intermediary
238: H RTF_HOST Host entry (net otherwise)
239: L RTF_LLINFO Valid protocol to link address translation.
240: M RTF_MODIFIED Modified dynamically (by redirect)
241: R RTF_REJECT Host or net unreachable
242: S RTF_STATIC Manually added
243: U RTF_UP Route usable
244: X RTF_XRESOLVE External daemon translates proto to link address
245: .El
246: .Pp
247: Direct routes are created for each
248: interface attached to the local host;
249: the gateway field for such entries shows the address of the outgoing interface.
250: The refcnt field gives the
251: current number of active uses of the route. Connection oriented
252: protocols normally hold on to a single route for the duration of
253: a connection while connectionless protocols obtain a route while sending
254: to the same destination.
255: The use field provides a count of the number of packets
256: sent using that route. The mtu entry shows the mtu associated with
257: that route. This mtu value is used as the basis for the TCP maximum
258: segment size. A
259: .Sq -
260: indicates that the mtu for this route has not been set, and a default
261: TCP maximum segment size will be used. The interface entry indicates
262: the network interface utilized for the route.
263: .Pp
264: When
265: .Nm netstat
266: is invoked with the
267: .Fl w
268: option and a
269: .Ar wait
270: interval argument, it displays a running count of statistics related to
271: network interfaces.
272: An obsolescent version of this option used a numeric parameter
273: with no option, and is currently supported for backward compatibility.
274: This display consists of a column for the primary interface (the first
275: interface found during autoconfiguration) and a column summarizing
276: information for all interfaces.
277: The primary interface may be replaced with another interface with the
278: .Fl I
279: option.
280: The first line of each screen of information contains a summary since the
281: system was last rebooted. Subsequent lines of output show values
282: accumulated over the preceding interval.
283: .Sh SEE ALSO
284: .Xr nfsstat 1 ,
285: .Xr ps 1 ,
286: .Xr hosts 5 ,
287: .Xr networks 5 ,
288: .Xr protocols 5 ,
289: .Xr services 5 ,
290: .Xr trpt 8 ,
291: .Xr trsp 8 ,
292: .Xr iostat 8 ,
293: .Xr vmstat 8
294: .Sh HISTORY
295: The
296: .Nm netstat
297: command appeared in
298: .Bx 4.2 .
299: .\" .Sh FILES
300: .\" .Bl -tag -width /dev/kmem -compact
1.3 ccappuc 301: .\" .It Pa /bsd
1.1 deraadt 302: .\" default kernel namelist
303: .\" .It Pa /dev/kmem
304: .\" default memory file
305: .\" .El
306: .Sh BUGS
307: 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