1 .\" Copyright (c) 1983, 1990, 1992, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" @(#)netstat.1 8.8 (Berkeley) 4/18/94
40 .Nd show network status
44 command symbolically displays the contents of various network-related
46 There are a number of output formats,
47 depending on the options for the information presented.
48 .Bl -tag -width indent
53 .Op Fl f Ar protocol_family | Fl p Ar protocol
58 Display a list of active sockets
59 (protocol control blocks)
60 for each network protocol,
68 show the address of a protocol control block (PCB)
69 associated with a socket; used for debugging.
73 show the state of all sockets;
74 normally sockets used by server processes are not shown.
78 show the size of the various listen queues.
79 The first count shows the number of unaccepted connections,
80 the second count shows the amount of unaccepted incomplete connections,
81 and the third count is the maximum number of queued connections.
85 show network addresses as numbers (as with
87 but show ports symbolically.
90 is present display full socket buffer statistics for each internet socket.
94 .Fl i | I Ar interface
96 .Op Fl f Ar address_family
101 Show the state of all network interfaces or a single
103 which have been auto-configured
104 (interfaces statically configured into a system, but not
105 located at boot time are not shown).
108 after an interface name indicates that the interface is
112 is also present, multicast addresses currently in use are shown
113 for each Ethernet interface and for each IP interface address.
114 Multicast addresses are shown on separate lines following the interface
115 address with which they are associated.
118 is also present, show the number of bytes in and out.
121 is also present, show the number of dropped packets.
124 is also present, print all counters in human readable form.
127 is also present, show the contents of watchdog timers.
130 is also present, print interface names using a wider field size.
135 .Op Fl I Ar interface
145 display the information regarding packet
146 traffic on all configured network interfaces
151 is also present, exit after
156 is also present, show the number of dropped packets.
162 .Op Fl f Ar protocol_family | Fl p Ar protocol
167 Display system-wide statistics for each network protocol,
169 .Ar protocol_family ,
174 is repeated, counters with a value of zero are suppressed.
177 is also present, reset statistic counters after displaying them.
181 .Fl i | I Ar interface Fl s
182 .Op Fl f Ar protocol_family | Fl p Ar protocol
187 Display per-interface statistics for each network protocol,
189 .Ar protocol_family ,
200 Show statistics recorded by the memory management routines
202 The network manages a private pool of memory buffers.
208 .Op Fl I Ar interface
211 Show statistics about
214 This includes information like
215 how many packets have been matched, dropped and received by the
216 bpf device, also information about current buffer sizes and device
223 .Op Fl f Ar address_family
228 Display the contents of all routing tables,
229 or a routing table for a particular
234 show the contents of the internal Patricia tree
235 structures; used for debugging.
239 show protocol-cloned routes
240 (routes generated by an
243 normally these routes are not shown.
261 Display routing statistics.
264 is repeated, counters with a value of zero are suppressed.
270 .Op Fl f Ar address_family
275 Display the contents of the multicast virtual interface tables,
276 and multicast forwarding caches.
277 Entries in these tables will appear only when the kernel is
278 actively forwarding multicast sessions.
279 This option is applicable only to the
289 .Op Fl f Ar address_family
294 Show multicast routing statistics.
297 is repeated, counters with a value of zero are suppressed.
300 Some options have the general meaning:
302 .It Fl f Ar address_family , Fl p Ar protocol
303 Limit display to those records
308 The following address families and protocols are recognized:
310 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
313 .It Cm inet Pq Dv AF_INET
314 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
315 .It Cm inet6 Pq Dv AF_INET6
316 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
317 .It Cm pfkey Pq Dv PF_KEY
319 .It Cm atalk Pq Dv AF_APPLETALK
321 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
323 .It Cm ipx Pq Dv AF_IPX
325 .\".It Cm ns Pq Dv AF_NS
326 .\".Cm idp , ns_err , spp
327 .\".It Cm iso Pq Dv AF_ISO
328 .\".Cm clnp , cltp , esis , tp
329 .It Cm unix Pq Dv AF_UNIX
330 .It Cm link Pq Dv AF_LINK
333 The program will complain if
335 is unknown or if there is no statistics routine for it.
337 Extract values associated with the name list from the specified core
338 instead of the default
341 Extract the name list from the specified system instead of the default,
342 which is the kernel image the system has booted from.
344 Show network addresses and ports as numbers.
347 attempts to resolve addresses and ports,
348 and display them symbolically.
350 In certain displays, avoid truncating addresses even if this causes
351 some fields to overflow.
354 The default display, for active sockets, shows the local
355 and remote addresses, send and receive queue sizes (in bytes), protocol,
356 and the internal state of the protocol.
357 Address formats are of the form
361 if a socket's address specifies a network but no specific host address.
362 When known, the host and network addresses are displayed symbolically
363 according to the databases
368 If a symbolic name for an address is unknown, or if
371 option is specified, the address is printed numerically, according
372 to the address family.
373 For more information regarding
381 addresses and ports appear as
384 The interface display provides a table of cumulative
385 statistics regarding packets transferred, errors, and collisions.
386 The network addresses of the interface
387 and the maximum transmission unit
391 The routing table display indicates the available routes and their status.
392 Each route consists of a destination host or network, and a gateway to use
393 in forwarding packets.
394 The flags field shows a collection of information about the route stored
396 The individual flags are discussed in more detail in the
401 The mapping between letters and flags is:
402 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
403 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
404 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
405 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
406 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
407 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
408 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
409 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
410 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
411 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
412 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
413 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
414 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
415 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
416 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
417 .It Li U Ta Dv RTF_UP Ta "Route usable"
418 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
419 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
422 Direct routes are created for each
423 interface attached to the local host;
424 the gateway field for such entries shows the address of the outgoing interface.
425 The refcnt field gives the
426 current number of active uses of the route.
428 protocols normally hold on to a single route for the duration of
429 a connection while connectionless protocols obtain a route while sending
430 to the same destination.
431 The use field provides a count of the number of packets
432 sent using that route.
433 The interface entry indicates the network interface utilized for the route.
441 interval argument, it displays a running count of statistics related to
443 An obsolescent version of this option used a numeric parameter
444 with no option, and is currently supported for backward compatibility.
445 By default, this display summarizes information for all interfaces.
446 Information for a specific interface may be displayed with the
456 option represent the underlying parameters of the bpf peer.
458 represented as a single lower case letter.
459 The mapping between the letters and flags in order of appearance are:
461 .It Li p Ta Set if listening promiscuously
462 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
463 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
465 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
466 remotely on the interface.
467 .It Li a Ta Packet reception generates a signal
468 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
471 For more information about these flags, please refer to
478 to output all the information recorded about data
479 stored in the socket buffers.
481 .Bl -column ".Li R-MBUF"
482 .It Li R-MBUF Ta Number of mbufs in the receive queue.
483 .It Li S-MBUF Ta Number of mbufs in the send queue.
484 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
486 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
487 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
488 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
489 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
490 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
491 .It Li R-BCNT Ta Receive buffer byte count.
492 .It Li S-BCNT Ta Send buffer byte count.
493 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
494 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
521 IPv6 support was added by WIDE/KAME project.
523 The notion of errors is ill-defined.
projects / FreeBSD / releng / 8.1.git / blob