]> git.saurik.com Git - apple/network_cmds.git/blob - netstat.tproj/netstat.1
network_cmds-329.2.2.tar.gz
[apple/network_cmds.git] / netstat.tproj / netstat.1
1 .\" Copyright (c) 1983, 1990, 1992, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" @(#)netstat.1 8.8 (Berkeley) 4/18/94
33 .\" $FreeBSD: src/usr.bin/netstat/netstat.1,v 1.22.2.7 2001/08/10 09:07:09 ru Exp $
34 .\"
35 .Dd June 15, 2001
36 .Dt NETSTAT 1
37 .Os Darwin
38 .Sh NAME
39 .Nm netstat
40 .Nd show network status
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl AaLlnW
44 .Op Fl f Ar address_family | Fl p Ar protocol
45 .Nm
46 .Op Fl gilns
47 .Op Fl f Ar address_family
48 .Nm
49 .Fl i | I Ar interface
50 .Op Fl w Ar wait
51 .Op Fl abdgt
52 .Nm
53 .Fl s Op Fl s
54 .Op Fl f Ar address_family | Fl p Ar protocol
55 .Op Fl w Ar wait
56 .Nm
57 .Fl i | I Ar interface Fl s
58 .Op Fl f Ar address_family | Fl p Ar protocol
59 .Nm
60 .Fl m
61 .Op Fl m
62 .Nm
63 .Fl r
64 .Op Fl Aaln
65 .Op Fl f Ar address_family
66 .Nm
67 .Fl rs
68 .Op Fl s
69 .\"-----------------------------------------------------------------------------------------
70 .Sh DESCRIPTION
71 .\"-----------------------------------------------------------------------------------------
72 The
73 .Nm
74 command symbolically displays the contents of various network-related data structures.
75 There are a number of output formats, depending on the options for the information presented.
76 The first form of the command displays a list of active sockets for each protocol.
77 The second form presents the contents of one of the other network data structures according
78 to the option selected. Using the third form, with a
79 .Ar wait
80 interval specified,
81 .Nm
82 will continuously display the information regarding packet traffic on the configured network
83 interfaces. The fourth form displays statistics for the specified protocol or address family. If a
84 .Ar wait
85 interval is specified, the protocol information over the last interval seconds will be displayed.
86 The fifth form displays per-interface statistics for the specified protocol or address family.
87 The sixth form displays
88 .Xr mbuf 9
89 statistics. The seventh form displays routing table for the specified address family. The
90 eighth form displays routing statistics.
91 .Pp
92 The options have the following meaning:
93 .Bl -tag -width flag
94 .It Fl A
95 With the default display, show the address of any protocol control blocks associated with
96 sockets; used for debugging.
97 .It Fl a
98 With the default display, show the state of all sockets; normally sockets used by server
99 processes are not shown. With the routing table display (option
100 .Fl r ,
101 as described below), show protocol-cloned routes (routes generated by a
102 .Dv RTF_PRCLONING
103 parent route); normally these routes are not shown.
104 .It Fl b
105 With the interface display (option
106 .Fl i ,
107 as described below), show the number of bytes in and out.
108 .It Fl d
109 With either interface display (option
110 .Fl i
111 or an interval, as described below), show the number of dropped packets.
112 .It Fl f Ar address_family
113 Limit statistics or address control block reports to those of the specified
114 .Ar address family .
115 The following address families are recognized:
116 .Ar inet ,
117 for
118 .Dv AF_INET ,
119 .Ar inet6 ,
120 for
121 .Dv AF_INET6
122 and
123 .Ar unix ,
124 for
125 .Dv AF_UNIX .
126 .It Fl g
127 Show information related to multicast (group address) routing. By default, show the
128 IP Multicast virtual-interface and routing tables. If the
129 .Fl s
130 option is also present, show multicast routing statistics.
131 .It Fl I Ar interface
132 Show information about the specified interface; used with a
133 .Ar wait
134 interval as described below.
135 If the
136 .Fl s
137 option is present, show per-interface protocol statistics on the
138 .Ar interface
139 for the specified
140 .Ar address_family
141 or
142 .Ar protocol ,
143 or for all protocol families.
144 .It Fl i
145 Show the state of interfaces which have been auto-configured (interfaces statically
146 configured into a system, but not located at boot time are not shown). If the
147 .Fl a
148 options is also present, multicast addresses currently in use are shown for each
149 Ethernet interface and for each IP interface address. Multicast addresses are shown
150 on separate lines following the interface address with which they are associated.
151 If the
152 .Fl s
153 option is present, show per-interface statistics on all interfaces for the specified
154 .Ar address_family
155 or
156 .Ar protocol ,
157 or for all protocol families.
158 .It Fl L
159 Show the size of the various listen queues. The first count shows the number of
160 unaccepted connections. The second count shows the amount of unaccepted incomplete
161 connections. The third count is the maximum number of queued connections.
162 .It Fl l
163 Print full IPv6 address.
164 .It Fl m
165 Show statistics recorded by the memory management routines (the network stack manages a private pool of memory buffers). More detailed information about the buffers, which includes their cache related statistics, can be obtained by using
166 .Fl mm
167 or
168 .Fl m
169 .Fl m
170 option.
171 .It Fl n
172 Show network addresses as numbers (normally
173 .Nm
174 interprets addresses and attempts to display them symbolically). This option may be
175 used with any of the display formats.
176 .It Fl p Ar protocol
177 Show statistics about
178 .Ar protocol ,
179 which is either a well-known name for a protocol or an alias for it. Some protocol
180 names and aliases are listed in the file
181 .Pa /etc/protocols .
182 The special protocol name
183 .Dq bdg
184 is used to show bridging statistics. A null response typically means that there are
185 no interesting numbers to report. The program will complain if
186 .Ar protocol
187 is unknown or if there is no statistics routine for it.
188 .It Fl r
189 Show the routing tables. Use with
190 .Fl a
191 to show protocol-cloned routes. When
192 .Fl s
193 is also present, show routing statistics instead. When
194 .Fl l
195 is also present,
196 .Nm
197 assumes more columns are there and the maximum transmission unit
198 .Pq Dq mtu
199 are also displayed.
200 .It Fl s
201 Show per-protocol statistics. If this option is repeated, counters with a value of
202 zero are suppressed.
203 .It Fl W
204 In certain displays, avoid truncating addresses even if this causes some fields to
205 overflow.
206 .It Fl w Ar wait
207 Show network interface or protocol statistics at intervals of
208 .Ar wait
209 seconds.
210 .El
211 .Pp
212 .\"-------------------------------------------------------------------------------
213 .Sh OUTPUT
214 .\"-------------------------------------------------------------------------------
215 The default display, for active sockets, shows the local and remote addresses,
216 send and receive queue sizes (in bytes), protocol, and the internal state of
217 the protocol. Address formats are of the form
218 .Dq host.port
219 or
220 .Dq network.port
221 if a socket's address specifies a network but no specific host address.
222 If known, the host and network addresses are displayed symbolically
223 according to the databases
224 .Pa /etc/hosts
225 and
226 .Pa /etc/networks ,
227 respectively. If a symbolic name for an address is unknown, or if the
228 .Fl n
229 option is specified, the address is printed numerically, according to the
230 address family. For more information regarding the Internet
231 .Dq dot format ,
232 refer to
233 .Xr inet 3 ) .
234 Unspecified,
235 or
236 .Dq wildcard ,
237 addresses and ports appear as
238 .Dq * .
239 .Pp
240 Internet domain socket states:
241 .Bl -column X LISTEN
242 CLOSED: The socket is not in use.
243 .Pp
244 LISTEN: The socket is listening for incoming connections. Unconnected
245 listening sockets like these are only displayed when using the -a option.
246 .Pp
247 SYN_SENT: The socket is actively trying to establish a connection to a
248 remote peer.
249 .Pp
250 SYN_RCVD: The socket has passively received a connection request from a
251 remote peer.
252 .Pp
253 ESTABLISHED: The socket has an established connection between a local
254 application and a remote peer.
255 .Pp
256 CLOSE_WAIT: The socket connection has been closed by the remote peer,
257 and the system is waiting for the local application to close its half of
258 the connection.
259 .Pp
260 LAST_ACK: The socket connection has been closed by the remote peer, the
261 local application has closed its half of the connection, and the system
262 is waiting for the remote peer to acknowledge the close.
263 .Pp
264 FIN_WAIT_1: The socket connection has been closed by the local
265 application, the remote peer has not yet acknowledged the close, and the
266 system is waiting for it to close its half of the connection.
267 .Pp
268 FIN_WAIT_2: The socket connection has been closed by the local
269 application, the remote peer has acknowledged the close, and the system
270 is waiting for it to close its half of the connection.
271 .Pp
272 CLOSING: The socket connection has been closed by the local application
273 and the remote peer simultaneously, and the remote peer has not yet
274 acknowledged the close attempt of the local application.
275 .Pp
276 TIME_WAIT: The socket connection has been closed by the local
277 application, the remote peer has closed its half of the connection, and
278 the system is waiting to be sure that the remote peer received the last
279 acknowledgement.
280 .El
281 .Pp
282 The interface display provides a table of cumulative statistics regarding
283 packets transferred, errors, and collisions. The network addresses of the
284 interface and the maximum transmission unit
285 .Pq Dq mtu
286 are also displayed.
287 .Pp
288 The routing table display indicates the available routes and their status.
289 Each route consists of a destination host or network and a gateway to use
290 in forwarding packets. The flags field shows a collection of information
291 about the route stored as binary choices. The individual flags are discussed
292 in more detail in the
293 .Xr route 8
294 and
295 .Xr route 4
296 manual pages. The mapping between letters and flags is:
297 .Bl -column XXXX RTF_BLACKHOLE
298 1 RTF_PROTO1 Protocol specific routing flag #1
299 2 RTF_PROTO2 Protocol specific routing flag #2
300 3 RTF_PROTO3 Protocol specific routing flag #3
301 B RTF_BLACKHOLE Just discard packets (during updates)
302 b RTF_BROADCAST The route represents a broadcast address
303 C RTF_CLONING Generate new routes on use
304 c RTF_PRCLONING Protocol-specified generate new routes on use
305 D RTF_DYNAMIC Created dynamically (by redirect)
306 G RTF_GATEWAY Destination requires forwarding by intermediary
307 H RTF_HOST Host entry (net otherwise)
308 I RTF_IFSCOPE Route is associated with an interface scope
309 i RTF_IFREF Route is holding a reference to the interface
310 L RTF_LLINFO Valid protocol to link address translation
311 M RTF_MODIFIED Modified dynamically (by redirect)
312 m RTF_MULTICAST The route represents a multicast address
313 R RTF_REJECT Host or net unreachable
314 S RTF_STATIC Manually added
315 U RTF_UP Route usable
316 W RTF_WASCLONED Route was generated as a result of cloning
317 X RTF_XRESOLVE External daemon translates proto to link address
318 .El
319 .Pp
320 Direct routes are created for each interface attached to the local host;
321 the gateway field for such entries shows the address of the outgoing
322 interface. The refcnt field gives the current number of active uses of
323 the route. Connection oriented protocols normally hold on to a single
324 route for the duration of a connection while connectionless protocols
325 obtain a route while sending to the same destination. The use field
326 provides a count of the number of packets sent using that route. The
327 interface entry indicates the network interface utilized for the route.
328 A route which is marked with the RTF_IFSCOPE flag is instantiated for
329 the corresponding interface.
330 .Pp
331 When
332 .Nm netstat
333 is invoked with the
334 .Fl w
335 option and a
336 .Ar wait
337 interval argument, it displays a running count of statistics related to
338 network interfaces or protocols. An obsolete version of this option used a numeric
339 parameter with no option, and is currently supported for backward
340 compatibility. By default, this display summarizes information for all
341 interfaces. Information for a specific interface may be displayed with the
342 .Fl I
343 option.
344 .Sh SEE ALSO
345 .Xr fstat 1 ,
346 .Xr nfsstat 1 ,
347 .Xr ps 1 ,
348 .Xr sockstat 1 ,
349 .Xr inet 4 ,
350 .Xr unix 4 ,
351 .Xr hosts 5 ,
352 .Xr networks 5 ,
353 .Xr protocols 5 ,
354 .Xr route 8 ,
355 .Xr services 5 ,
356 .Xr iostat 8 ,
357 .Xr trpt 8 ,
358 .Xr vmstat 8
359 .Sh HISTORY
360 The
361 .Nm netstat
362 command appeared in
363 .Bx 4.2 .
364 .Pp
365 IPv6 support was added by WIDE/KAME project.
366 .Sh BUGS
367 The notion of errors is ill-defined.