Annotation of src/usr.bin/vmstat/vmstat.8, Revision 1.7
1.6 deraadt 1: .\" $OpenBSD: vmstat.8,v 1.5 1996/07/04 20:16:02 deraadt Exp $
1.3 deraadt 2: .\" $NetBSD: vmstat.8,v 1.12 1996/05/10 23:19:30 thorpej Exp $
1.1 deraadt 3: .\"
4: .\" Copyright (c) 1986, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)vmstat.8 8.1 (Berkeley) 6/6/93
36: .\"
37: .TH VMSTAT 8 "June 6, 1993"
38: .UC 4
39: .SH NAME
40: vmstat \- report virtual memory statistics
41: .SH SYNOPSIS
42: .nf
43: .ft B
44: vmstat [ \-fimst ] [ \-c count ] [ \-M core ] [ \-N system ]
45: .ti +5
46: [ \-w wait ] [ disks ]
47: .ft R
48: .fi
49: .SH DESCRIPTION
50: .I Vmstat
51: reports certain kernel statistics kept about process, virtual memory,
52: disk, trap and cpu activity.
53: .PP
54: The options are as follows:
55: .TP
56: \-c
57: Repeat the display
58: .I count
59: times.
60: The first display is for the time since a reboot and each subsequent report
61: is for the time period since the last display.
62: If no
63: .I wait
64: interval is specified, the default is 1 second.
65: .TP
66: \-f
67: Report on the number
1.7 ! kstailey 68: .IR fork (2) ,
! 69: .IR vfork (2)
1.1 deraadt 70: and
1.7 ! kstailey 71: .IR rfork (2)
1.1 deraadt 72: system calls since system startup, and the number of pages of virtual memory
73: involved in each.
74: .TP
75: \-i
76: Report on the number of interrupts taken by each device since system
77: startup.
78: .TP
79: \-M
80: Extract values associated with the name list from the specified core
1.2 tholo 81: instead of the default ``/dev/mem''.
1.1 deraadt 82: .TP
83: \-N
84: Extract the name list from the specified system instead of the default
1.5 deraadt 85: ``/bsd''.
1.1 deraadt 86: .TP
87: \-m
88: Report on the usage of kernel dynamic memory listed first by size of
89: allocation and then by type of usage.
90: .TP
91: \-s
92: Display the contents of the
93: .I sum
94: structure, giving the total number of several kinds of paging related
95: events which have occurred since system startup.
96: .TP
97: \-t
98: Report on the number of page in and page reclaims since system startup,
99: and the amount of time required by each.
100: .TP
101: \-w
102: Pause
103: .I wait
104: seconds between each display.
105: If no repeat
106: .I count
107: is specified, the default is infinity.
108: .PP
109: By default,
110: .I vmstat
111: displays the following information:
112: .PP
113: .TP
114: procs
115: Information about the numbers of processes in various states.
116: .sp
117: .RS
118: .nf
119: r in run queue
120: b blocked for resources (i/o, paging, etc.)
121: w runnable or short sleeper (< 20 secs) but swapped
122: .fi
123: .RE
124: .TP
125: memory
126: Information about the usage of virtual and real memory.
127: Virtual pages (reported in units of 1024 bytes) are considered active if
128: they belong to processes which are running or have run in the last 20
129: seconds.
130: .sp
131: .RS
132: .nf
133: avm active virtual pages
134: fre size of the free list
135: .fi
136: .RE
137: .TP
138: page
139: Information about page faults and paging activity.
140: These are averaged each five seconds, and given in units per second.
141: .sp
142: .RS
143: .nf
144: re page reclaims (simulating reference bits)
145: at pages attached (found in free list)
146: pi pages paged in
147: po pages paged out
148: fr pages freed per second
149: de anticipated short term memory shortfall
150: sr pages scanned by clock algorithm, per-second
151: .fi
152: .RE
153: .TP
154: disks
1.2 tholo 155: Disk transfers per second.
1.1 deraadt 156: Typically paging will be split across the available drives.
157: The header of the field is the first character of the disk name and
158: the unit number.
159: If more than four disk drives are configured in the system,
160: .I vmstat
161: displays only the first four drives.
162: To force
163: .I vmstat
164: to display specific drives, their names may be supplied on the command line.
165: .TP
166: faults
167: Trap/interrupt rate averages per second over last 5 seconds.
168: .sp
169: .RS
170: .nf
171: in device interrupts per interval (including clock interrupts)
172: sy system calls per interval
173: cs cpu context switch rate (switches/interval)
174: .fi
175: .RE
176: .TP
177: cpu
178: Breakdown of percentage usage of CPU time.
179: .sp
180: .RS
181: .nf
182: us user time for normal and low priority processes
183: sy system time
184: id cpu idle
185: .fi
186: .RE
187: .SH EXAMPLES
1.6 deraadt 188: The command ``vmstat -w 5'' will print what the system is doing every five
1.1 deraadt 189: seconds; this is a good choice of printing interval since this is how often
190: some of the statistics are sampled in the system.
191: Others vary every second and running the output for a while will make it
192: apparent which are recomputed every second.
193: .SH FILES
1.2 tholo 194: .ta \w'/dev/mem 'u
1.5 deraadt 195: /bsd default kernel namelist
1.1 deraadt 196: .br
1.2 tholo 197: /dev/mem default memory file
1.1 deraadt 198: .SH SEE ALSO
199: .IR fstat (1),
200: .IR netstat (1),
201: .IR nfsstat (1),
202: .IR ps (1),
203: .IR systat (1),
204: .IR iostat (8),
205: .IR pstat (8)
206: .sp
207: The sections starting with ``Interpreting system activity'' in
208: .IR "Installing and Operating 4.3BSD" .
209: .SH BUGS
210: The \-c and \-w options are only available with the default output.