Annotation of cci/usr/src/etc/nstat/nstat.8c, revision 1.1.1.1

1.1       root        1: .TH NSTAT 8C "18 November 1984"
                      2: .UC 4
                      3: .SH NAME
                      4: nstat \- show network status
                      5: .SH SYNOPSIS
                      6: .B nstat
                      7: [ 
                      8: .B \-HchimnrstEA
                      9: .] [
                     10: .B \-d
                     11: .I device-name
                     12: ] [
                     13: .B \-p
                     14: .I protocol 
                     15: ] [
                     16: .B  \-a
                     17: .I interval
                     18: ] [
                     19: .I system
                     20: ] [
                     21: .I core
                     22: ]
                     23: .SH DESCRIPTION
                     24: .I Nstat 
                     25: displays the snapshot of networking subsystem status. The user can use the
                     26: statistics collected at the network interfaces, at each
                     27: protocol layer, and at network memory pool to monitor the workload,
                     28: reliability and throughput of data communication.
                     29: .PP
                     30: Displayed address formats are of the form ``host.port'' or ``network.port''
                     31: if a socket's address specifies a network but no specific host address.
                     32: When known the host and network addresses are displayed symbolically
                     33: according to the data bases
                     34: .I /etc/hosts
                     35: and
                     36: .IR /etc/networks ,
                     37: respectively. If a symbolic name for an address is unknown, or if
                     38: the 
                     39: .B \-n
                     40: option is specified, the address is printed in the Internet ``dot format'';
                     41: refer to 
                     42: .IR inet (3N)
                     43: for more information regarding this format.
                     44: Unspecified,
                     45: or 
                     46: .I wildcard, 
                     47: addresses and ports appear as ``*''.  
                     48: .PP
                     49: The user can choose certain status or statistics, or a different display 
                     50: format by specifying a combination of the following options:
                     51: .TP 
                     52: .B \-H
                     53: is the HELP function.  It shows users all the available options in nstat
                     54: together with brief explaination.
                     55: .TP 
                     56: .B \-A
                     57: show the address of protocol control blocks of all connections; used mainly
                     58: for debugging the networking subsystem.
                     59: .TP
                     60: .B \-a interval
                     61: specify
                     62: .I nstat
                     63: to continuously display the selected status, pausing for
                     64: .I interval
                     65: seconds before between each display.
                     66: .TP
                     67: .B \-c
                     68: show all connections in the system.
                     69: There are a number of display formats, depending on the information
                     70: presented.  The default display, for active sockets, shows the local
                     71: and remote addresses, send and receive queue sizes (in bytes), protocol,
                     72: and, optionally, the internal state of the protocol.
                     73: .TP
                     74: .B \-d "device-name"
                     75: show statistics collected at the network interface device;
                     76: .I ace, ace0 or ace1
                     77: is valid device name for ACC Ethernet interface, and
                     78: .I enp, enp0 or enp1
                     79: is valid device name for CMC Ethernet interface.  When a device name is
                     80: specified without device unit number (ace or enp),  the statistics of
                     81: all the devices of that type are displayed.
                     82: .TP
                     83: .B \-h
                     84: show the state of the IMP host table.
                     85: .TP
                     86: .B \-i
                     87: show the state of interfaces which have been auto-configured
                     88: (interfaces statically configured into a system, but not
                     89: located at boot time are not shown).
                     90: The display provides a table of cumulative
                     91: statistics regarding packets transferred, errors, and collisions.
                     92: The network address (currently Internet specific) of the interface
                     93: and the maximum transmission unit (``mtu'') are also displayed.
                     94: .TP
                     95: .B \-m
                     96: show statistics recorded by the 
                     97: .I mbuf
                     98: memory management routines
                     99: (the network manages a ``private share'' of memory)
                    100: .TP
                    101: .B \-n
                    102: show network addresses as numbers (normally 
                    103: .I nstat
                    104: interprets addresses and attempts to display them
                    105: symbolically)
                    106: .TP
                    107: .BI \-p " proto"
                    108: show only connections or statistics relating to the protocol
                    109: .IR proto ;
                    110: the protocol is specified symbolically, and may be any
                    111: protocol listed in the file
                    112: .IR /etc/protocols .
                    113: If this option is not given,
                    114: .I nstat
                    115: displays connections or statistics of all protocols.
                    116: .TP
                    117: .B \-r
                    118: show the routing tables.
                    119: The routing table display indicates the available routes and
                    120: their status.  Each route consists of a destination host or network
                    121: and a gateway to use in forwarding packets.  The flags field shows
                    122: the state of the route (``U'' if ``up''), and whether the route
                    123: is to a gateway (``G'').  Direct routes are created for each
                    124: interface attached to the local host.  The refcnt field gives the
                    125: current number of active uses of the route.  Connection oriented
                    126: protocols normally hold on to a single route for the duration of
                    127: a connection while connectionless protocols obtain a route then
                    128: discard it.  The use field provides a count of the number of packets
                    129: sent using that route.  The interface entry indicates the network
                    130: interface utilized for the route.
                    131: .TP
                    132: .B \-s
                    133: show statistics of routing and all protocols.
                    134: .TP
                    135: .B \-t
                    136: show the information regarding packet traffic on the configured
                    137: network interfaces, pausing every 1 second. The user can change the pause 
                    138: interval with the option
                    139: .I -a.
                    140: .I Nstat
                    141: displays a running count of statistics related to
                    142: network interfaces.  This display consists of a column summarizing
                    143: information for all interfaces, and a column for the interface with
                    144: the most traffic since the system was last rebooted.  The first
                    145: line of each screen of information contains a summary since the
                    146: system was last rebooted.  Subsequent lines of output show values
                    147: accumulated over the preceding interval.
                    148: .TP
                    149: .B \-E
                    150: displays the Internet address and Ethernet address of all the hosts that
                    151: is currently up in the local network.
                    152: 
                    153: .PP
                    154: The arguments
                    155: .I system,
                    156: and
                    157: .I core
                    158: are 
                    159: .I positional
                    160: driven.
                    161: .I System
                    162: and
                    163: .I core
                    164: allow substitutes for the defaults ``/vmunix'' and ``/dev/kmem''.
                    165: The
                    166: .I core
                    167: file must be read with physical addresses rather than virtual addresses.
                    168: .PP
                    169: .SH SEE ALSO
                    170: iostat(1),
                    171: vmstat(1),
                    172: hosts(5),
                    173: networks(5),
                    174: protocols(5),
                    175: services(5),
                    176: trpt(8C)
                    177: .SH BUGS
                    178: The notion of errors is ill-defined.  Collisions mean
                    179: something else for the IMP.
                    180: .PP
                    181: If a host has two or more interfaces to the same local network, the E option 
                    182: displays the Internet/Ethernet address pair of only one interface of which
                    183: Ethernet address is maintained in the local host ARPA table at that time.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.