BSD 4_3_Reno release

[unix-history] / usr / src / usr.bin / netstat / netstat.1

diff --git a/usr/src/usr.bin/netstat/netstat.1 b/usr/src/usr.bin/netstat/netstat.1
index d6a16f0..683a0ca 100644 (file)
--- a/usr/src/usr.bin/netstat/netstat.1
+++ b/usr/src/usr.bin/netstat/netstat.1
@@ -1,155 +1,229 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1990 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)netstat.1   6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms are permitted provided
+.\" that: (1) source distributions retain this entire copyright notice and
+.\" comment, and (2) distributions including binaries display the following
+.\" acknowledgement:  ``This product includes software developed by the
+.\" University of California, Berkeley and its contributors'' in the
+.\" documentation or other materials provided with the distribution and in
+.\" all advertising materials mentioning features or use of this software.
+.\" Neither the name of the University nor the names of its contributors may
+.\" be used to endorse or promote products derived from this software without
+.\" specific prior written permission.
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
+.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

 .\"
 .\"

-.TH NETSTAT 1 ""
-.UC 5
-.SH NAME
-netstat \- show network status
-.SH SYNOPSIS
-.B netstat
-[ 
-.B \-Aahimnrs
-] [
-.B \-I
-.I interface
-] [
-.B \-p
-.I protocol
-] [
-.I interval
-] [
-.I system
-] [
-.I core
-]
-.SH DESCRIPTION
+.\"     @(#)netstat.1  6.11 (Berkeley) 7/24/90
+.\"
+.Dd July 24, 1990
+.Dt NETSTAT 1
+.Os BSD 4.2
+.Sh NAME
+.Nm netstat
+.Nd show network status
+.Sh SYNOPSIS
+.Nm netstat
+.Op Fl Aan
+.Op Fl f Ar address_family
+.Op Ar system
+.Op Ar core
+.Nm netstat
+.Op Fl himnrs
+.Op Fl f Ar address_family
+.Op Ar system
+.Op Ar core
+.Nm netstat
+.Op Fl n
+.Op Fl I Op Ar interface
+.Ar interval
+.Op Ar system
+.Op Ar core
+.Nm netstat
+.Op Fl p Ar protocol
+.Op Ar system
+.Op Ar core
+.Sh DESCRIPTION

 The
 The

-.I netstat 
+.Nm netstat

 command symbolically displays the contents of various network-related
 command symbolically displays the contents of various network-related

-data structures.  The options have the following meaning:
-.TP 
-.B \-A
-show the address of any associated protocol control blocks; used
-for debugging
-.TP
-.B \-a
+data structures.
+There are a number of output formats,
+depending on the options for the information presented.
+The first form of the command displays a list of active sockets for
+each protocol.
+The second form presents the contents of one of the other network
+data structures according to the option selected.
+Using the third form, with an
+.Ar interval
+specified,
+.Nm netstat
+will continuously display the information regarding packet
+traffic on the configured network interfaces.
+The fourth form displays statistics about the named protocol.
+.Pp
+The options have the following meaning:
+.Tw Fl
+.Tp Fl A
+With the default display,
+show the address of any protocol control blocks associated with sockets; used
+for debugging.
+.Tp Fl a
+With the default display,

 show the state of all sockets; normally sockets used by
 show the state of all sockets; normally sockets used by

-server processes are not shown
-.TP
-.B \-h
-show the state of the IMP host table
-.TP
-.B \-i
-show the state of interfaces which have been auto-configured
+server processes are not shown.
+.Tp Fl d
+With either interface display (option
+.Fl i
+or an interval, as described below),
+show the number of dropped packets.
+.Tp Fl h
+Show the state of the IMP host table.
+.Tp Fl i
+Show the state of interfaces which have been auto-configured

 (interfaces statically configured into a system, but not
 (interfaces statically configured into a system, but not

-located at boot time are not shown)
-.TP
-.BI \-I " interface"
-show information only about this interface
-(see also
-.I interval
-below)
-.TP
-.B \-m
-show statistics recorded by the memory management routines
-(the network manages a ``private share'' of memory)
-.TP
-.B \-n
-show network addresses as numbers (normally 
-.I netstat
+located at boot time are not shown).
+.Tp Cx Fl I
+.Ws
+.Ar interface
+.Cx
+Show information only about this interface;
+used with an
+.Ar interval
+as described below.
+.Tp Fl m
+Show statistics recorded by the memory management routines
+(the network manages a private pool of memory buffers).
+.Tp Fl n
+Show network addresses as numbers (normally
+.Nm netstat

 interprets addresses and attempts to display them
 interprets addresses and attempts to display them

-symbolically)
-.TP
-.BI \-p " proto"
-show the state of sockets utilizing protocol
-.IR proto ;
-the protocol is specified symbolically, and may be any
-protocol listed in the file
-.IR /etc/protocols .
-.TP
-.B \-s
-show per-protocol statistics
-.TP
-.B \-r
-show the routing tables
-.PP
-The arguments, 
-.I system
+symbolically).
+This option may be used with any of the display formats.
+.Tp Cx Fl p
+.Ws
+.Ar protocol
+.Cx
+Show statistics about
+.Ar protocol  ,
+which is either a well-known name for a protocol or an alias for it.  Some
+protocol names and aliases are listed in the file
+.Pa /etc/protocols .
+A null response typically means that there are no interesting numbers to
+report.
+The program will complain if
+.Ar protocol
+is unknown or if there is no statistics routine for it.
+.Tp Fl s
+Show per-protocol statistics.
+.Tp Fl r
+Show the routing tables.
+When
+.Fl s
+is also present, show routing statistics instead.
+.Tp Cx Fl f
+.Ws
+.Ar address_family
+.Cx
+Limit statistics or address control block reports to those
+of the specified
+.Ar address family  .
+The following address families
+are recognized:
+.Ar inet  ,
+for
+.Li AF_INET  ,
+.Ar ns ,
+for
+.Li AF_NS  ,

 and
 and

-.I core
-allow substitutes for the defaults ``/vmunix'' and ``/dev/kmem''.
-.PP
-If an 
-.I interval
-is specified,
-.I netstat
-will continuously display the information regarding packet
-traffic on the configured network interfaces, pausing
-.I interval
-seconds before refreshing the screen.
-.PP
-There are a number of display formats, depending on the information
-presented.  The default display, for active sockets, shows the local
+.Ar unix  ,
+for
+.Li AF_UNIX  .
+.Tp
+.Pp
+The arguments,
+.Ar system
+and
+.Ar core
+allow substitutes for the defaults
+.Dq Pa vmunix
+and
+.Dq Pa /dev/kmem .
+.Pp
+The default display, for active sockets, shows the local

 and remote addresses, send and receive queue sizes (in bytes), protocol,
 and remote addresses, send and receive queue sizes (in bytes), protocol,

-and, optionally, the internal state of the protocol.
-.PP
+and the internal state of the protocol.

 Address formats are of the form ``host.port'' or ``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 data bases
 Address formats are of the form ``host.port'' or ``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 data bases

-.I /etc/hosts
+.Pa /etc/hosts

 and
 and

-.IR /etc/networks ,
+.Pa /etc/networks ,

 respectively.  If a symbolic name for an address is unknown, or if
 respectively.  If a symbolic name for an address is unknown, or if

-the 
-.B \-n
-option is specified, the address is printed in the Internet ``dot format'';
-refer to 
-.IR inet (3N)
-for more information regarding this format.
+the
+.Fl n
+option is specified, the address is printed numerically, according
+to the address family.
+For more information regarding
+the Internet ``dot format,''
+refer to
+.Xr inet 3 ) .

 Unspecified,
 Unspecified,

-or ``wildcard'', addresses and ports appear as ``*''.  
-.PP
+or ``wildcard'', addresses and ports appear as ``*''.
+.Pp

 The interface display provides a table of cumulative
 statistics regarding packets transferred, errors, and collisions.
 The interface display provides a table of cumulative
 statistics regarding packets transferred, errors, and collisions.

-The network address (currently Internet specific) of the interface
+The network addresses of the interface

 and the maximum transmission unit (``mtu'') are also displayed.
 and the maximum transmission unit (``mtu'') are also displayed.

-.PP
+.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
 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

-the state of the route (``U'' if ``up''), and whether the route
-is to a gateway (``G'').  Direct routes are created for each
-interface attached to the local host.  The refcnt field gives the
+the state of the route (``U'' if ``up''), whether the route
+is to a gateway (``G''), whether the route was created dynamically
+by a redirect (``D''), and whether the route has been modified
+by a redirect (``M'').  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
 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 then
-discard it.  The use field provides a count of the number of packets
+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.
 sent using that route.  The interface entry indicates the network
 interface utilized for the route.

-.PP
-When 
-.I netstat
+.Pp
+When
+.Nm netstat

 is invoked with an
 is invoked with an

-.I interval
+.Ar interval

 argument, it displays a running count of statistics related to
 argument, it displays a running count of statistics related to

-network interfaces.  This display consists of a column summarizing
-information for all interfaces, and a column for the interface with
-the most traffic since the system was last rebooted.  The first
-line of each screen of information contains a summary since the
+network interfaces.  This display consists of a
+column for the primary interface
+(the first interface found during autoconfiguration)
+and a column summarizing
+information for all interfaces.
+The primary interface may be replaced with another interface with the
+.Fl I
+option.
+The first line of each screen of information contains a summary since the

 system was last rebooted.  Subsequent lines of output show values
 accumulated over the preceding interval.
 system was last rebooted.  Subsequent lines of output show values
 accumulated over the preceding interval.

-.SH SEE ALSO
-iostat(1),
-vmstat(1),
-hosts(5),
-networks(5),
-protocols(5),
-services(5),
-trpt(8C)
-.SH BUGS
+.Sh SEE ALSO
+.Xr iostat 1 ,
+.Xr vmstat 1 ,
+.Xr hosts 5 ,
+.Xr networks 5 ,
+.Xr protocols 5 ,
+.Xr services 5 ,
+.Xr trpt 8
+.Sh HISTORY
+.Nm Netstat
+appeared in 4.2 BSD.
+.Sh BUGS

 The notion of errors is ill-defined.  Collisions mean
 something else for the IMP.
 The notion of errors is ill-defined.  Collisions mean
 something else for the IMP.