BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / iostat / iostat.8

diff --git a/usr/src/usr.sbin/iostat/iostat.8 b/usr/src/usr.sbin/iostat/iostat.8
index 174cb6a..8e49fd5 100644 (file)
--- a/usr/src/usr.sbin/iostat/iostat.8
+++ b/usr/src/usr.sbin/iostat/iostat.8
@@ -1,66 +1,134 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1985, 1991 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)iostat.8    6.2 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. 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.

 .\"
 .\"

-.TH IOSTAT 8 ""
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)iostat.8    6.8 (Berkeley) 4/24/91
+.\"
+.TH IOSTAT 8 "April 24, 1991"

 .UC 4
 .SH NAME
 iostat \- report I/O statistics
 .SH SYNOPSIS
 .UC 4
 .SH NAME
 iostat \- report I/O statistics
 .SH SYNOPSIS

-.B iostat
-[ drives ]
-[ interval [ count ] ]
+.nf
+.ft B
+iostat [ \-c count ] [ \-M core ] [ \-N system ]
+.ti +5
+[ \-w wait ] [ drives ]
+.ft R
+.fi

 .SH DESCRIPTION
 .I Iostat
 .SH DESCRIPTION
 .I Iostat

-iteratively reports the number of characters read and written to terminals
-per second,
-and, for each disk, the number of transfers per second, kilobytes
-transferred per second,
-and the milliseconds per average seek.
-It also gives the percentage of time the system has
-spent in user mode, in user mode running low priority (niced) processes,
-in system mode, and idling.
+reports certain kernel statistics kept about terminal, disk and cpu
+activity.

 .PP
 .PP

-To compute this information, for each disk, seeks and data transfer completions
-and number of words transferred are counted;
-for terminals collectively, the number
-of input and output characters are counted.
-Also, each sixtieth of a second,
-the state of each disk is examined
-and a tally is made if the disk is active.
-From these numbers and given the transfer rates
-of the devices it is possible to determine
-average seek times for each device.
-.PP
-The optional
-.I interval
-argument causes
-.I iostat
-to report once each
-.I interval
-seconds.
-The first report is for  all time since a reboot and each
-subsequent report is for the last interval only.
-.PP
-The optional
+The options are as follows:
+.TP
+\-c
+Repeat the display
+.I count
+times.
+The first display is for the time since a reboot and each subsequent
+report is for the time period since the last display.
+If no
+.I wait
+interval is specified, the default is 1 second.
+.TP
+\-M
+Extract values associated with the name list from the specified core
+instead of the default ``/dev/kmem''.
+.TP
+\-N
+Extract the name list from the specified system instead of the default
+``/vmunix''.
+.TP
+\-w
+Pause
+.I wait
+seconds between each display.
+If no repeat

 .I count
 .I count

-argument restricts the number of reports.
+is specified, the default is infinity.

 .PP
 .PP

-If more than 4 disk drives are configured in the system,
+.I Iostat
+displays its information in the following format:
+.TP
+tty
+.nf
+.RS
+tin    characters read from terminals
+tout   characters written to terminals
+.RE
+.fi
+.TP
+disks
+Disk operations (this field is system dependent). 
+The header of the field is the disk name and unit number.
+If more than four disk drives are configured in the system,

 .I iostat
 .I iostat

-displays only the first 4 drives, with priority given
-to Massbus disk drives (i.e. if both Unibus and Massbus
-drives are present and the total number of drives exceeds
-4, then some number of Unibus drives will not be displayed
-in favor of the Massbus drives).  To force
+displays only the first four drives.
+To force

 .I iostat
 .I iostat

-to display specific drives, their names may be supplied on
-the command line.
+to display specific drives, their names may be supplied on the command
+line.
+.sp
+.nf
+.RS
+sps    sectors transferred per second
+tps    transfers per second
+msps   milliseconds per average seek (including implied
+       seeks and rotational latency)
+.RE
+.fi
+.TP
+cpu
+.nf
+.RS
+us     % of cpu time in user mode
+ni     % of cpu time in user mode running niced processes
+sy     % of cpu time in system mode
+id     % of cpu time in idle mode
+.RE
+.fi

 .SH FILES
 .SH FILES

-/dev/kmem
+.ta \w'/dev/kmem  'u
+/vmunix        default kernel namelist

 .br
 .br

-/vmunix
+/dev/kmem      default memory file

 .SH SEE ALSO
 .SH SEE ALSO

-vmstat(1)
+.IR fstat (1),
+.IR netstat (1),
+.IR nfsstat (1),
+.IR ps (1),
+.IR systat (1),
+.IR vmstat (1),
+.IR pstat (8)
+.sp
+The sections starting with ``Interpreting system activity'' in
+.IR "Installing and Operating 4.3BSD" .