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