Annotation of src/usr.bin/vmstat/vmstat.8, Revision 1.5
1.5 ! deraadt 1: .\" $OpenBSD: vmstat.8,v 1.4 1996/06/26 05:42:41 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
68: .IR fork (2)
69: and
70: .IR vfork (2)
71: system calls since system startup, and the number of pages of virtual memory
72: involved in each.
73: .TP
74: \-i
75: Report on the number of interrupts taken by each device since system
76: startup.
77: .TP
78: \-M
79: Extract values associated with the name list from the specified core
1.2 tholo 80: instead of the default ``/dev/mem''.
1.1 deraadt 81: .TP
82: \-N
83: Extract the name list from the specified system instead of the default
1.5 ! deraadt 84: ``/bsd''.
1.1 deraadt 85: .TP
86: \-m
87: Report on the usage of kernel dynamic memory listed first by size of
88: allocation and then by type of usage.
89: .TP
90: \-s
91: Display the contents of the
92: .I sum
93: structure, giving the total number of several kinds of paging related
94: events which have occurred since system startup.
95: .TP
96: \-t
97: Report on the number of page in and page reclaims since system startup,
98: and the amount of time required by each.
99: .TP
100: \-w
101: Pause
102: .I wait
103: seconds between each display.
104: If no repeat
105: .I count
106: is specified, the default is infinity.
107: .PP
108: By default,
109: .I vmstat
110: displays the following information:
111: .PP
112: .TP
113: procs
114: Information about the numbers of processes in various states.
115: .sp
116: .RS
117: .nf
118: r in run queue
119: b blocked for resources (i/o, paging, etc.)
120: w runnable or short sleeper (< 20 secs) but swapped
121: .fi
122: .RE
123: .TP
124: memory
125: Information about the usage of virtual and real memory.
126: Virtual pages (reported in units of 1024 bytes) are considered active if
127: they belong to processes which are running or have run in the last 20
128: seconds.
129: .sp
130: .RS
131: .nf
132: avm active virtual pages
133: fre size of the free list
134: .fi
135: .RE
136: .TP
137: page
138: Information about page faults and paging activity.
139: These are averaged each five seconds, and given in units per second.
140: .sp
141: .RS
142: .nf
143: re page reclaims (simulating reference bits)
144: at pages attached (found in free list)
145: pi pages paged in
146: po pages paged out
147: fr pages freed per second
148: de anticipated short term memory shortfall
149: sr pages scanned by clock algorithm, per-second
150: .fi
151: .RE
152: .TP
153: disks
1.2 tholo 154: Disk transfers per second.
1.1 deraadt 155: Typically paging will be split across the available drives.
156: The header of the field is the first character of the disk name and
157: the unit number.
158: If more than four disk drives are configured in the system,
159: .I vmstat
160: displays only the first four drives.
161: To force
162: .I vmstat
163: to display specific drives, their names may be supplied on the command line.
164: .TP
165: faults
166: Trap/interrupt rate averages per second over last 5 seconds.
167: .sp
168: .RS
169: .nf
170: in device interrupts per interval (including clock interrupts)
171: sy system calls per interval
172: cs cpu context switch rate (switches/interval)
173: .fi
174: .RE
175: .TP
176: cpu
177: Breakdown of percentage usage of CPU time.
178: .sp
179: .RS
180: .nf
181: us user time for normal and low priority processes
182: sy system time
183: id cpu idle
184: .fi
185: .RE
186: .SH EXAMPLES
187: The command ``vmstat -i 5'' will print what the system is doing every five
188: seconds; this is a good choice of printing interval since this is how often
189: some of the statistics are sampled in the system.
190: Others vary every second and running the output for a while will make it
191: apparent which are recomputed every second.
192: .SH FILES
1.2 tholo 193: .ta \w'/dev/mem 'u
1.5 ! deraadt 194: /bsd default kernel namelist
1.1 deraadt 195: .br
1.2 tholo 196: /dev/mem default memory file
1.1 deraadt 197: .SH SEE ALSO
198: .IR fstat (1),
199: .IR netstat (1),
200: .IR nfsstat (1),
201: .IR ps (1),
202: .IR systat (1),
203: .IR iostat (8),
204: .IR pstat (8)
205: .sp
206: The sections starting with ``Interpreting system activity'' in
207: .IR "Installing and Operating 4.3BSD" .
208: .SH BUGS
209: The \-c and \-w options are only available with the default output.