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
144 display the information regarding packet
145 traffic on all configured network interfaces
150 is also present, show the number of dropped packets.
156 .Op Fl f Ar protocol_family | Fl p Ar protocol
161 Display system-wide statistics for each network protocol,
163 .Ar protocol_family ,
168 is repeated, counters with a value of zero are suppressed.
171 is also present, reset statistic counters after displaying them.
175 .Fl i | I Ar interface Fl s
176 .Op Fl f Ar protocol_family | Fl p Ar protocol
181 Display per-interface statistics for each network protocol,
183 .Ar protocol_family ,
194 Show statistics recorded by the memory management routines
196 The network manages a private pool of memory buffers.
202 .Op Fl I Ar interface
205 Show statistics about
208 This includes information like
209 how many packets have been matched, dropped and received by the
210 bpf device, also information about current buffer sizes and device
217 .Op Fl f Ar address_family
222 Display the contents of all routing tables,
223 or a routing table for a particular
228 show the contents of the internal Patricia tree
229 structures; used for debugging.
233 show protocol-cloned routes
234 (routes generated by an
237 normally these routes are not shown.
255 Display routing statistics.
258 is repeated, counters with a value of zero are suppressed.
264 .Op Fl f Ar address_family
269 Display the contents of the multicast virtual interface tables,
270 and multicast forwarding caches.
271 Entries in these tables will appear only when the kernel is
272 actively forwarding multicast sessions.
273 This option is applicable only to the
283 .Op Fl f Ar address_family
288 Show multicast routing statistics.
291 is repeated, counters with a value of zero are suppressed.
294 Some options have the general meaning:
296 .It Fl f Ar address_family , Fl p Ar protocol
297 Limit display to those records
302 The following address families and protocols are recognized:
304 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
307 .It Cm inet Pq Dv AF_INET
308 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
309 .It Cm inet6 Pq Dv AF_INET6
310 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
311 .It Cm pfkey Pq Dv PF_KEY
313 .It Cm atalk Pq Dv AF_APPLETALK
315 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
317 .It Cm ipx Pq Dv AF_IPX
319 .\".It Cm ns Pq Dv AF_NS
320 .\".Cm idp , ns_err , spp
321 .\".It Cm iso Pq Dv AF_ISO
322 .\".Cm clnp , cltp , esis , tp
323 .It Cm unix Pq Dv AF_UNIX
324 .It Cm link Pq Dv AF_LINK
327 The program will complain if
329 is unknown or if there is no statistics routine for it.
331 Extract values associated with the name list from the specified core
332 instead of the default
335 Extract the name list from the specified system instead of the default,
336 which is the kernel image the system has booted from.
338 Show network addresses and ports as numbers.
341 attempts to resolve addresses and ports,
342 and display them symbolically.
344 In certain displays, avoid truncating addresses even if this causes
345 some fields to overflow.
348 The default display, for active sockets, shows the local
349 and remote addresses, send and receive queue sizes (in bytes), protocol,
350 and the internal state of the protocol.
351 Address formats are of the form
355 if a socket's address specifies a network but no specific host address.
356 When known, the host and network addresses are displayed symbolically
357 according to the databases
362 If a symbolic name for an address is unknown, or if
365 option is specified, the address is printed numerically, according
366 to the address family.
367 For more information regarding
375 addresses and ports appear as
378 The interface display provides a table of cumulative
379 statistics regarding packets transferred, errors, and collisions.
380 The network addresses of the interface
381 and the maximum transmission unit
385 The routing table display indicates the available routes and their status.
386 Each route consists of a destination host or network, and a gateway to use
387 in forwarding packets.
388 The flags field shows a collection of information about the route stored
390 The individual flags are discussed in more detail in the
395 The mapping between letters and flags is:
396 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
397 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
398 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
399 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
400 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
401 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
402 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
403 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
404 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
405 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
406 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
407 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
408 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
409 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
410 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
411 .It Li U Ta Dv RTF_UP Ta "Route usable"
412 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
413 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
416 Direct routes are created for each
417 interface attached to the local host;
418 the gateway field for such entries shows the address of the outgoing interface.
419 The refcnt field gives the
420 current number of active uses of the route.
422 protocols normally hold on to a single route for the duration of
423 a connection while connectionless protocols obtain a route while sending
424 to the same destination.
425 The use field provides a count of the number of packets
426 sent using that route.
427 The interface entry indicates the network interface utilized for the route.
435 interval argument, it displays a running count of statistics related to
437 An obsolescent version of this option used a numeric parameter
438 with no option, and is currently supported for backward compatibility.
439 By default, this display summarizes information for all interfaces.
440 Information for a specific interface may be displayed with the
450 option represent the underlying parameters of the bpf peer.
452 represented as a single lower case letter.
453 The mapping between the letters and flags in order of appearance are:
455 .It Li p Ta Set if listening promiscuously
456 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
457 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
459 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
460 remotely on the interface.
461 .It Li a Ta Packet reception generates a signal
462 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
465 For more information about these flags, please refer to
472 to output all the information recorded about data
473 stored in the socket buffers.
475 .Bl -column ".Li R-MBUF"
476 .It Li R-MBUF Ta Number of mbufs in the receive queue.
477 .It Li S-MBUF Ta Number of mbufs in the send queue.
478 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
480 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
481 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
482 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
483 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
484 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
485 .It Li R-BCNT Ta Receive buffer byte count.
486 .It Li S-BCNT Ta Send buffer byte count.
487 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
488 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
515 IPv6 support was added by WIDE/KAME project.
517 The notion of errors is ill-defined.
projects / FreeBSD / releng / 8.0.git / blob