Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 4 Jun 2014 04:18:33 +0000 (UTC)
From:      Allan Jude <allanjude@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r267037 - head/usr.bin/netstat
Message-ID:  <201406040418.s544IXXU039950@svn.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: allanjude (doc committer)
Date: Wed Jun  4 04:18:33 2014
New Revision: 267037
URL: http://svnweb.freebsd.org/changeset/base/267037

Log:
  Further updates to the netstat(1) man page and usage message
  
  - Reformat the entire man page
  - Create a proper synopsis section
  - Use itemized-lists to describe each flag, rather than paragraphs
  - Cross-reference common flags to a 'general flags' sub-section with short
  inline description of the flag
  - Label 'general flags' sub-section
  - Apply additional fixes suggested by wblock, brueffer, and bdrewery
  - Update .Dd that got undone previously
  - Change the order of the .Op Fl to be alphabetical
  - Add the -i | -I interface flags to the description of 'interface
  display mode'
  - Fix missing parameters in man page
  - Fix missing parameters in usage()
  - Sync man page and usage()
  
  MFC Note: stable/9 and stable/10 do not have -R, will need to be removed
  when merged
  
  CR:		D58
  Reviewed by:	brueffer, bcr
  Approved by:	wblock (mentor)
  MFC after:	7 days
  Sponsored by:	ScaleEngine Inc.

Modified:
  head/usr.bin/netstat/main.c
  head/usr.bin/netstat/netstat.1

Modified: head/usr.bin/netstat/main.c
==============================================================================
--- head/usr.bin/netstat/main.c	Wed Jun  4 03:03:34 2014	(r267036)
+++ head/usr.bin/netstat/main.c	Wed Jun  4 04:18:33 2014	(r267037)
@@ -828,14 +828,16 @@ usage(void)
 "               [-M core] [-N system]",
 "       netstat -i | -I interface [-46abdhnW] [-f address_family]\n"
 "               [-M core] [-N system]",
-"       netstat -w wait [-I interface] [-46d] [-M core] [-N system] [-q howmany]",
-"       netstat -s [-s] [-46z] [-f protocol_family | -p protocol]\n"
-"               [-M core] [-N system]",
-"       netstat -i | -I interface [-46s] [-f protocol_family | -p protocol]\n"
+"       netstat -w wait [-I interface] [-46d] [-M core] [-N system]\n"
+"               [-q howmany]",
+"       netstat -s [-46sz] [-f protocol_family | -p protocol]\n"
 "               [-M core] [-N system]",
+"       netstat -i | -I interface -s [-46s]\n"
+"               [-f protocol_family | -p protocol] [-M core] [-N system]",
 "       netstat -m [-M core] [-N system]",
-"       netstat -B [-I interface]",
-"       netstat -r [-46AanW] [-f address_family] [-M core] [-N system]",
+"       netstat -B [-z] [-I interface]",
+"       netstat -r [-46AnW] [-F fibnum] [-f address_family]\n"
+"               [-M core] [-N system]",
 "       netstat -rs [-s] [-M core] [-N system]",
 "       netstat -g [-46W] [-f address_family] [-M core] [-N system]",
 "       netstat -gs [-46s] [-f address_family] [-M core] [-N system]",

Modified: head/usr.bin/netstat/netstat.1
==============================================================================
--- head/usr.bin/netstat/netstat.1	Wed Jun  4 03:03:34 2014	(r267036)
+++ head/usr.bin/netstat/netstat.1	Wed Jun  4 04:18:33 2014	(r267037)
@@ -28,12 +28,70 @@
 .\"	@(#)netstat.1	8.8 (Berkeley) 4/18/94
 .\" $FreeBSD$
 .\"
-.Dd January 11, 2014
+.Dd July 4, 2014
 .Dt NETSTAT 1
 .Os
 .Sh NAME
 .Nm netstat
-.Nd show network status
+.Nd show network status and statistics
+.Sh SYNOPSIS
+.Bk -words
+.Bl -tag -width "netstat"
+.It Nm
+.Op Fl 46AaLnRSTWx
+.Op Fl f Ar protocol_family | Fl p Ar protocol
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl i | I Ar interface
+.Op Fl 46abdhnW
+.Op Fl f Ar address_family
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl w Ar wait
+.Op Fl I Ar interface
+.Op Fl 46d
+.Op Fl M Ar core
+.Op Fl N Ar system
+.Op Fl q Ar howmany
+.It Nm Fl s
+.Op Fl 46sz
+.Op Fl f Ar protocol_family | Fl p Ar protocol
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl i | I Ar interface Fl s
+.Op Fl 46s
+.Op Fl f Ar protocol_family | Fl p Ar protocol
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl m
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl B
+.Op Fl z
+.Op Fl I Ar interface
+.It Nm Fl r
+.Op Fl 46AnW
+.Op Fl F Ar fibnum
+.Op Fl f Ar address_family
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl rs
+.Op Fl s
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl g
+.Op Fl 46W
+.Op Fl f Ar address_family
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl gs
+.Op Fl 46s
+.Op Fl f Ar address_family
+.Op Fl M Ar core
+.Op Fl N Ar system
+.It Nm Fl Q
+.Ek
+.El
 .Sh DESCRIPTION
 The
 .Nm
@@ -45,7 +103,7 @@ depending on the options for the informa
 .It Xo
 .Bk -words
 .Nm
-.Op Fl 46AaLnSTWxR
+.Op Fl 46AaLnRSTWx
 .Op Fl f Ar protocol_family | Fl p Ar protocol
 .Op Fl M Ar core
 .Op Fl N Ar system
@@ -53,50 +111,132 @@ depending on the options for the informa
 .Xc
 Display a list of active sockets
 (protocol control blocks)
-for each network protocol,
-for a particular
-.Ar protocol_family ,
-or for a single
-.Ar protocol .
-If
-.Fl A
-is also present,
-show the address of a protocol control block (PCB)
+for each network protocol.
+.Pp
+The default display for active sockets shows the local
+and remote addresses, send and receive queue sizes (in bytes), protocol,
+and the internal state of the protocol.
+Address formats are of the form
+.Dq host.port
+or
+.Dq network.port
+if a socket's address specifies a network but no specific host address.
+When known, the host and network addresses are displayed symbolically
+according to the databases
+.Xr hosts 5
+and
+.Xr networks 5 ,
+respectively.
+If a symbolic name for an address is unknown, or if
+the
+.Fl n
+option is specified, the address is printed numerically, according
+to the address family.
+For more information regarding
+the Internet IPv4
+.Dq dot format ,
+refer to
+.Xr inet 3 .
+Unspecified,
+or
+.Dq wildcard ,
+addresses and ports appear as
+.Dq Li * .
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl A
+Show the address of a protocol control block (PCB)
 associated with a socket; used for debugging.
-If
-.Fl a
-is also present,
-show the state of all sockets;
+.It Fl a
+Show the state of all sockets;
 normally sockets used by server processes are not shown.
-If
-.Fl L
-is also present,
-show the size of the various listen queues.
+.It Fl L
+Show the size of the various listen queues.
 The first count shows the number of unaccepted connections,
 the second count shows the amount of unaccepted incomplete connections,
 and the third count is the maximum number of queued connections.
-If
-.Fl S
-is also present,
-show network addresses as numbers (as with
+.It Fl n
+Do not resolve numeric addresses and port numbers to names.
+See
+.Sx GENERAL OPTIONS .
+.It Fl R
+Display the flowid and flowtype for each socket.
+flowid is a 32 bit hardware specific identifier for each flow.
+flowtype defines which protocol fields are hashed to produce the id.
+A complete listing is available in
+.Pa sys/mbuf.h
+under
+.Dv M_HASHTYPE_* .
+.It Fl S
+Show network addresses as numbers (as with
 .Fl n )
 but show ports symbolically.
-If
+.It Fl T
+Display diagnostic information from the TCP control block.
+Fields include the number of packets requiring retransmission,
+received out-of-order, and those advertising a zero-sized window.
+.It Fl W
+Avoid truncating addresses even if this causes some fields to overflow.
+.It Fl x
+Display socket buffer and TCP timer statistics for each
+internet socket.
+.Pp
+The
 .Fl x
-is present, display socket buffer and tcp timer statistics for each internet socket.
-If
-.Fl R
-is present, display the flowid and flowtype for each internet socket.
-When
-.Fl T
-is present, display information from the TCP control block, including
-retransmits, out-of-order packets received, and zero-sized windows advertised.
+flag causes
+.Nm
+to output all the information recorded about data
+stored in the socket buffers.
+The fields are:
+.Bl -column ".Li R-MBUF"
+.It Li R-MBUF Ta Number of mbufs in the receive queue.
+.It Li S-MBUF Ta Number of mbufs in the send queue.
+.It Li R-CLUS Ta Number of clusters, of any type, in the receive
+queue.
+.It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
+.It Li R-HIWA Ta Receive buffer high water mark, in bytes.
+.It Li S-HIWA Ta Send buffer high water mark, in bytes.
+.It Li R-LOWA Ta Receive buffer low water mark, in bytes.
+.It Li S-LOWA Ta Send buffer low water mark, in bytes.
+.It Li R-BCNT Ta Receive buffer byte count.
+.It Li S-BCNT Ta Send buffer byte count.
+.It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
+.It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
+.El
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.It Fl p Ar protocol
+Filter by
+.Ar protocol .
+See
+.Sx GENERAL OPTIONS .
+.It Fl M
+Use an alternative core.
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image.
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
 .Fl i | I Ar interface
 .Op Fl 46abdhnW
 .Op Fl f Ar address_family
+.Op Fl M Ar core
+.Op Fl N Ar system
 .Ek
 .Xc
 Show the state of all network interfaces or a single
@@ -108,30 +248,59 @@ An asterisk
 .Pq Dq Li *
 after an interface name indicates that the interface is
 .Dq down .
-If
-.Fl a
-is also present, multicast addresses currently in use are shown
+.Pp
+When
+.Nm
+is invoked with
+.Fl i
+.Pq all interfaces
+or
+.Fl I Ar interface ,
+it provides a table of cumulative
+statistics regarding packets transferred, errors, and collisions.
+The network addresses of the interface
+and the maximum transmission unit
+.Pq Dq mtu
+are also displayed.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl a
+Multicast addresses currently in use are shown
 for each Ethernet interface and for each IP interface address.
 Multicast addresses are shown on separate lines following the interface
 address with which they are associated.
-If
-.Fl b
-is also present, show the number of bytes in and out.
-If
-.Fl d
-is also present, show the number of dropped packets.
-If
-.Fl h
-is also present, print all counters in human readable form.
-If
-.Fl W
-is also present, print interface names using a wider field size.
+.It Fl b
+Show the number of bytes in and out.
+.It Fl d
+Show the number of dropped packets.
+.It Fl h
+Print all counters in human readable form.
+.It Fl n
+Do not resolve numeric addresses and port numbers to names.
+See
+.Sx GENERAL OPTIONS .
+.It Fl W
+Avoid truncating interface names even if this causes some fields to overflow.
+.Sx GENERAL OPTIONS .
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
 .Fl w Ar wait
 .Op Fl I Ar interface
-.Op Fl d
+.Op Fl 46d
 .Op Fl M Ar core
 .Op Fl N Ar system
 .Op Fl q Ar howmany
@@ -139,55 +308,139 @@ is also present, print interface names u
 .Xc
 At intervals of
 .Ar wait
-seconds,
-display the information regarding packet
-traffic on all configured network interfaces
-or a single
+seconds, display the information regarding packet traffic on all
+configured network interfaces or a single
 .Ar interface .
-If
-.Fl q
-is also present, exit after
+.Pp
+When
+.Nm
+is invoked with the
+.Fl w
+option and a
+.Ar wait
+interval argument, it displays a running count of statistics related to
+network interfaces.
+An obsolescent version of this option used a numeric parameter
+with no option, and is currently supported for backward compatibility.
+By default, this display summarizes information for all interfaces.
+Information for a specific interface may be displayed with the
+.Fl I Ar interface
+option.
+.Bl -tag -width indent
+.It Fl I Ar interface
+Only show information regarding
+.Ar interface
+.It Fl 4
+Show IPv4 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl d
+Show the number of dropped packets.
+.It Fl M
+Use an alternative core.
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image.
+See
+.Sx GENERAL OPTIONS .
+.It Fl q
+Exit after
 .Ar howmany
 outputs.
-If
-.Fl d
-is also present, show the number of dropped packets.
+.El
 .It Xo
 .Bk -words
 .Nm
-.Fl s Op Fl s
-.Op Fl 46z
+.Fl s
+.Op Fl 46sz
 .Op Fl f Ar protocol_family | Fl p Ar protocol
 .Op Fl M Ar core
 .Op Fl N Ar system
 .Ek
 .Xc
-Display system-wide statistics for each network protocol,
-for a particular
-.Ar protocol_family ,
-or for a single
-.Ar protocol .
+Display system-wide statistics for each network protocol.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl s
 If
 .Fl s
 is repeated, counters with a value of zero are suppressed.
-If
-.Fl z
-is also present, reset statistic counters after displaying them.
+.It Fl z
+Reset statistic counters after displaying them.
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.It Fl p Ar protocol
+Filter by
+.Ar protocol .
+See
+.Sx GENERAL OPTIONS .
+.It Fl M
+Use an alternative core.
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
 .Fl i | I Ar interface Fl s
-.Op Fl 46
+.Op Fl 46s
 .Op Fl f Ar protocol_family | Fl p Ar protocol
 .Op Fl M Ar core
 .Op Fl N Ar system
 .Ek
 .Xc
-Display per-interface statistics for each network protocol,
-for a particular
-.Ar protocol_family ,
-or for a single
+Display per-interface statistics for each network protocol.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl s
+If
+.Fl s
+is repeated, counters with a value of zero are suppressed.
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.It Fl p Ar protocol
+Filter by
 .Ar protocol .
+See
+.Sx GENERAL OPTIONS .
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -199,6 +452,16 @@ or for a single
 Show statistics recorded by the memory management routines
 .Pq Xr mbuf 9 .
 The network manages a private pool of memory buffers.
+.Bl -tag -width indent
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -214,11 +477,39 @@ This includes information like
 how many packets have been matched, dropped and received by the
 bpf device, also information about current buffer sizes and device
 states.
+.Pp
+The
+.Xr bpf 4
+flags displayed when
+.Nm
+is invoked with the
+.Fl B
+option represent the underlying parameters of the bpf peer.
+Each flag is
+represented as a single lower case letter.
+The mapping between the letters and flags in order of appearance are:
+.Bl -column ".Li i"
+.It Li p Ta Set if listening promiscuously
+.It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
+.It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
+filled automatically
+.It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
+remotely on the interface.
+.It Li a Ta Packet reception generates a signal
+.It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
+.El
+.Pp
+For more information about these flags, please refer to
+.Xr bpf 4 .
+.Bl -tag -width indent
+.It Fl z
+Reset statistic counters after displaying them.
+.El
 .It Xo
 .Bk -words
 .Nm
 .Fl r
-.Op Fl 46AanW
+.Op Fl 46AnW
 .Op Fl F Ar fibnum
 .Op Fl f Ar address_family
 .Op Fl M Ar core
@@ -226,35 +517,91 @@ states.
 .Ek
 .Xc
 Display the contents of routing tables.
+.Pp
 When
-.Fl f
-is specified, a routing table for a particular
-.Ar address_family
-is displayed.
-When
-.Fl F
-is specified, a routing table with the number
-.Ar fibnum
-is displayed.
+.Nm
+is invoked with the routing table option
+.Fl r ,
+it lists the available routes and their status.
+Each route consists of a destination host or network, and a gateway to use
+in forwarding packets.
+The flags field shows a collection of information about the route stored
+as binary choices.
+The individual flags are discussed in more detail in the
+.Xr route 8
+and
+.Xr route 4
+manual pages.
+The mapping between letters and flags is:
+.Bl -column ".Li W" ".Dv RTF_WASCLONED"
+.It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
+.It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
+.It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
+.It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
+.It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
+.It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
+.It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
+.It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
+.It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
+.It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
+.It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
+.It Li S Ta Dv RTF_STATIC Ta "Manually added"
+.It Li U Ta Dv RTF_UP Ta "Route usable"
+.It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
+.El
+.Pp
+Direct routes are created for each
+interface attached to the local host;
+the gateway field for such entries shows the address of the outgoing interface.
+The refcnt field gives the
+current number of active uses of the route.
+Connection oriented
+protocols normally hold on to a single route for the duration of
+a connection while connectionless protocols obtain a route while sending
+to the same destination.
+The use field provides a count of the number of packets
+sent using that route.
+The interface entry indicates the network interface utilized for the route.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only.
+See
+.Sx GENERAL OPTIONS .
+.It Fl A
+Show the contents of the internal Patricia tree
+structures; used for debugging.
+.It Fl n
+Do not resolve numeric addresses and port numbers to names.
+See
+.Sx GENERAL OPTIONS .
+.It Fl W
+Show the path MTU for each route, and print interface names with a
+wider field size.
+.It Fl F
+Display the routing table with the number
+.Ar fibnum .
 If the specified
 .Ar fibnum
 is -1 or
 .Fl F
 is not specified,
 the default routing table is displayed.
-If
-.Fl A
-is also present,
-show the contents of the internal Patricia tree
-structures; used for debugging.
-When
-.Fl W
-is also present,
-show the path MTU
-for each route,
-and print interface
-names with a wider
-field size.
+.It Fl f
+Display the routing table for a particular
+.Ar address_family .
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -265,9 +612,20 @@ field size.
 .Ek
 .Xc
 Display routing statistics.
+.Bl -tag -width indent
+.It Fl s
 If
 .Fl s
 is repeated, counters with a value of zero are suppressed.
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -287,6 +645,31 @@ This option is applicable only to the
 and
 .Cm inet6
 address families.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl W
+Avoid truncating addresses even if this causes some fields to overflow.
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -298,9 +681,33 @@ address families.
 .Ek
 .Xc
 Show multicast routing statistics.
+.Bl -tag -width indent
+.It Fl 4
+Show IPv4 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl 6
+Show IPv6 only
+See
+.Sx GENERAL OPTIONS .
+.It Fl s
 If
 .Fl s
 is repeated, counters with a value of zero are suppressed.
+.It Fl f Ar protocol_family
+Filter by
+.Ar protocol_family .
+See
+.Sx GENERAL OPTIONS .
+.It Fl M
+Use an alternative core
+See
+.Sx GENERAL OPTIONS .
+.It Fl N
+Use an alternative kernel image
+See
+.Sx GENERAL OPTIONS .
+.El
 .It Xo
 .Bk -words
 .Nm
@@ -318,16 +725,19 @@ The flags field shows available ISR hand
 .El
 .El
 .Pp
+.Ss GENERAL OPTIONS
 Some options have the general meaning:
 .Bl -tag -width flag
 .It Fl 4
 Is shorthand for
 .Fl f
 .Ar inet
+.Pq Show only IPv4
 .It Fl 6
 Is shorthand for
 .Fl f
 .Ar inet6
+.Pq Show only IPv6
 .It Fl f Ar address_family , Fl p Ar protocol
 Limit display to those records
 of the specified
@@ -367,156 +777,6 @@ Normally
 .Nm
 attempts to resolve addresses and ports,
 and display them symbolically.
-.It Fl W
-In certain displays, avoid truncating addresses even if this causes
-some fields to overflow.
-.It Fl R
-Display the flowid and flowtype for each socket.
-flowid is a 32 bit hardware specific identifier for each flow.
-flowtype defines which protocol fields are hashed to produce the id.
-A complete listing is available in
-.Pa sys/mbuf.h
-under M_HASHTYPE_*
-.El
-.Pp
-The default display, for active sockets, shows the local
-and remote addresses, send and receive queue sizes (in bytes), protocol,
-and the internal state of the protocol.
-Address formats are of the form
-.Dq host.port
-or
-.Dq network.port
-if a socket's address specifies a network but no specific host address.
-When known, the host and network addresses are displayed symbolically
-according to the databases
-.Xr hosts 5
-and
-.Xr networks 5 ,
-respectively.
-If a symbolic name for an address is unknown, or if
-the
-.Fl n
-option is specified, the address is printed numerically, according
-to the address family.
-For more information regarding
-the Internet IPv4
-.Dq dot format ,
-refer to
-.Xr inet 3 .
-Unspecified,
-or
-.Dq wildcard ,
-addresses and ports appear as
-.Dq Li * .
-.Pp
-The interface display provides a table of cumulative
-statistics regarding packets transferred, errors, and collisions.
-The network addresses of the interface
-and the maximum transmission unit
-.Pq Dq mtu
-are also displayed.
-.Pp
-The routing table display indicates the available routes and their status.
-Each route consists of a destination host or network, and a gateway to use
-in forwarding packets.
-The flags field shows a collection of information about the route stored
-as binary choices.
-The individual flags are discussed in more detail in the
-.Xr route 8
-and
-.Xr route 4
-manual pages.
-The mapping between letters and flags is:
-.Bl -column ".Li W" ".Dv RTF_WASCLONED"
-.It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
-.It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
-.It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
-.It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
-.It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
-.It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
-.It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
-.It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
-.It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
-.It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
-.It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
-.It Li S Ta Dv RTF_STATIC Ta "Manually added"
-.It Li U Ta Dv RTF_UP Ta "Route usable"
-.It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
-.El
-.Pp
-Direct routes are created for each
-interface attached to the local host;
-the gateway field for such entries shows the address of the outgoing interface.
-The refcnt field gives the
-current number of active uses of the route.
-Connection oriented
-protocols normally hold on to a single route for the duration of
-a connection while connectionless protocols obtain a route while sending
-to the same destination.
-The use field provides a count of the number of packets
-sent using that route.
-The interface entry indicates the network interface utilized for the route.
-.Pp
-When
-.Nm
-is invoked with the
-.Fl w
-option and a
-.Ar wait
-interval argument, it displays a running count of statistics related to
-network interfaces.
-An obsolescent version of this option used a numeric parameter
-with no option, and is currently supported for backward compatibility.
-By default, this display summarizes information for all interfaces.
-Information for a specific interface may be displayed with the
-.Fl I
-option.
-.Pp
-The
-.Xr bpf 4
-flags displayed when
-.Nm
-is invoked with the
-.Fl B
-option represent the underlying parameters of the bpf peer.
-Each flag is
-represented as a single lower case letter.
-The mapping between the letters and flags in order of appearance are:
-.Bl -column ".Li i"
-.It Li p Ta Set if listening promiscuously
-.It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
-.It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
-filled automatically
-.It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
-remotely on the interface.
-.It Li a Ta Packet reception generates a signal
-.It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
-.El
-.Pp
-For more information about these flags, please refer to
-.Xr bpf 4 .
-.Pp
-The
-.Fl x
-flag causes
-.Nm
-to output all the information recorded about data
-stored in the socket buffers.
-The fields are:
-.Bl -column ".Li R-MBUF"
-.It Li R-MBUF Ta Number of mbufs in the receive queue.
-.It Li S-MBUF Ta Number of mbufs in the send queue.
-.It Li R-CLUS Ta Number of clusters, of any type, in the receive
-queue.
-.It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
-.It Li R-HIWA Ta Receive buffer high water mark, in bytes.
-.It Li S-HIWA Ta Send buffer high water mark, in bytes.
-.It Li R-LOWA Ta Receive buffer low water mark, in bytes.
-.It Li S-LOWA Ta Send buffer low water mark, in bytes.
-.It Li R-BCNT Ta Receive buffer byte count.
-.It Li S-BCNT Ta Send buffer byte count.
-.It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
-.It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
 .El
 .Sh SEE ALSO
 .Xr fstat 1 ,



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201406040418.s544IXXU039950>