BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / vmstat / vmstat.8

diff --git a/usr/src/usr.bin/vmstat/vmstat.8 b/usr/src/usr.bin/vmstat/vmstat.8
index eed5b6d..f2e15a7 100644 (file)
--- a/usr/src/usr.bin/vmstat/vmstat.8
+++ b/usr/src/usr.bin/vmstat/vmstat.8
@@ -1,117 +1,141 @@
-.\" Copyright (c) 1980 The Regents of the University of California.
+.\" Copyright (c) 1986 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not 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.
+.\" 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.

 .\"
 .\"

-.\"    @(#)vmstat.8    6.5 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH VMSTAT 1 ""
+.\"    @(#)vmstat.8    6.8 (Berkeley) 6/20/91
+.\"
+.TH VMSTAT 1 "June 20, 1991"

 .UC 4
 .UC 4

-.de s1
-.if n .sp
-.if t .sp .1i
-..
-.de t1
-.if n .ta 5n
-.if t .ta 1i
-..

 .SH NAME
 vmstat \- report virtual memory statistics
 .SH SYNOPSIS
 .SH NAME
 vmstat \- report virtual memory statistics
 .SH SYNOPSIS

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

 .SH DESCRIPTION
 .I Vmstat
 .SH DESCRIPTION
 .I Vmstat

-delves into the system and normally reports certain statistics kept about
-process, virtual memory, disk, trap and cpu activity.
-If given a
-.B \-f
-argument, it instead reports on the number of
-.I forks
+reports certain kernel statistics kept about process, virtual memory,
+disk, trap and cpu activity.
+.PP
+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
+\-f
+Report on the number
+.IR fork (2)

 and
 and

-.I vforks
-since system startup and the number of pages of virtual memory involved in each
-kind of fork.
-If given a
-.B \-s
-argument, it instead prints the contents
-of the
+.IR vfork (2)
+system calls since system startup, and the number of pages of virtual memory
+involved in each.
+.TP
+\-i
+Report on the number of interrupts taken by each device since system
+startup.
+.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
+\-m
+Report on the usage of kernel dynamic memory listed first by size of
+allocation and then by type of usage.
+.TP
+\-s
+Display the contents of the

 .I sum
 structure, giving the total number of several kinds of paging related
 .I sum
 structure, giving the total number of several kinds of paging related

-events which have occurred since boot.
-If given a
-.B \-i
-argument, it instead reports on the number of
-.I interrupts
-taken by each device since system startup.
-If given a
-.B \-m
-argument, it instead reports on the usage of
-kernel dynamic memory listed first by 
-.I size
-of allocation and then by
-.I type
-of usage.
+events which have occurred since system startup.
+.TP
+\-t
+Report on the number of page in and page reclaims since system startup,
+and the amount of time required by each.
+.TP
+\-w
+Pause
+.I wait
+seconds between each display.
+If no repeat
+.I count
+is specified, the default is infinity.

 .PP
 .PP

-If none of these options are given,
+By default,

 .I vmstat
 .I vmstat

-will report in the first line a summary of the virtual memory activity 
-since the system has been booted.
-If
-.I interval
-is specified, then successive lines are summaries over the last
-.I interval
-seconds.
-``vmstat 5'' will print what the system is doing every five seconds;
-this is a good choice of printing interval since this is how often
-some of the statistics are sampled in the system; others vary every
-second, running the output for a while will make it apparent which
-are recomputed every second.
-If a
-.I count
-is given, the statistics are repeated
-.I count
-times.
-The format fields are:
+displays the following information:

 .PP
 .PP

-Procs: information about numbers of processes in various states.
-.s1
-.t1
+.TP
+procs
+Information about the numbers of processes in various states.
+.sp
+.RS

 .nf
 r      in run queue
 b      blocked for resources (i/o, paging, etc.)
 w      runnable or short sleeper (< 20 secs) but swapped
 .fi
 .nf
 r      in run queue
 b      blocked for resources (i/o, paging, etc.)
 w      runnable or short sleeper (< 20 secs) but swapped
 .fi

-.s1
-Memory: information about the usage of virtual and real memory.
-Virtual pages are considered active if they belong to processes which
-are running or have run in the last 20 seconds.
-A ``page'' here is 1024 bytes.
-.s1
-.t1
+.RE
+.TP
+memory
+Information about the usage of virtual and real memory.
+Virtual pages (reported in units of 1024 bytes) are considered active if
+they belong to processes which are running or have run in the last 20
+seconds.
+.sp
+.RS

 .nf
 avm    active virtual pages
 fre    size of the free list
 .fi
 .nf
 avm    active virtual pages
 fre    size of the free list
 .fi

-.s1
-Page: information about page faults and paging activity.
+.RE
+.TP
+page
+Information about page faults and paging activity.

 These are averaged each five seconds, and given in units per second.
 These are averaged each five seconds, and given in units per second.

-.s1
-.t1
+.sp
+.RS

 .nf
 re     page reclaims (simulating reference bits)
 at     pages attached (found in free list)
 .nf
 re     page reclaims (simulating reference bits)
 at     pages attached (found in free list)


@@ -121,43 +145,62 @@ fr        pages freed per second
 de     anticipated short term memory shortfall
 sr     pages scanned by clock algorithm, per-second
 .fi
 de     anticipated short term memory shortfall
 sr     pages scanned by clock algorithm, per-second
 .fi

-.s1
-up/hp/rk/ra: Disk operations per second (this field is system dependent).
-Typically paging will be split across several of the available drives.
-The number under each of these is the unit number.
-.s1
-Faults: trap/interrupt rate averages per second over last 5 seconds.
-.s1
-.t1
+.RE
+.TP
+disks
+Disk operations per second (this field is system dependent).
+Typically paging will be split across the available drives.
+The header of the field is the first character of the disk name and
+the unit number.
+If more than four disk drives are configured in the system,
+.I vmstat
+displays only the first four drives.
+To force
+.I vmstat
+to display specific drives, their names may be supplied on the command line.
+.TP
+faults
+Trap/interrupt rate averages per second over last 5 seconds.
+.sp
+.RS

 .nf
 .nf

-in     (non clock) device interrupts per second
-sy     system calls per second
-cs     cpu context switch rate (switches/sec)
+in     device interrupts per interval (including clock interrupts)
+sy     system calls per interval
+cs     cpu context switch rate (switches/interval)

 .fi
 .fi

-.s1
-Cpu: breakdown of percentage usage of CPU time
-.s1
+.RE
+.TP
+cpu
+Breakdown of percentage usage of CPU time.
+.sp
+.RS

 .nf
 us     user time for normal and low priority processes
 sy     system time
 id     cpu idle
 .fi
 .nf
 us     user time for normal and low priority processes
 sy     system time
 id     cpu idle
 .fi

-.PP
-If more than 4 disk drives are configured in the system,
-.I vmstat
-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
-.I vmstat
-to display specific drives, their names may be supplied on
-the command line.
+.RE
+.SH EXAMPLES
+The command ``vmstat -i 5'' will print what the system is doing every five
+seconds; this is a good choice of printing interval since this is how often
+some of the statistics are sampled in the system.
+Others vary every second and running the output for a while will make it
+apparent which are recomputed every second.

 .SH FILES
 .SH FILES

-/dev/kmem, /vmunix
+.ta \w'/dev/kmem  'u
+/vmunix        default kernel namelist
+.br
+/dev/kmem      default memory file

 .SH SEE ALSO
 .SH SEE ALSO

+.IR fstat (1),
+.IR netstat (1),
+.IR nfsstat (1),
+.IR ps (1),

 .IR systat (1),
 .IR systat (1),

-.IR iostat (1)
-.PP
+.IR iostat (8),
+.IR pstat (8)
+.sp

 The sections starting with ``Interpreting system activity'' in
 The sections starting with ``Interpreting system activity'' in

-.IR "Installing and Operating 4.2bsd" .
+.IR "Installing and Operating 4.3BSD" .
+.SH BUGS
+The \-c and \-w options are only available with the default output.