docs: mention long options in man vmstat.8

This commit includes generic manual clean ups as well.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
Sami Kerola 2011-09-28 22:54:05 +02:00
parent 1ddb5a3ae4
commit 5e0306f042

179
vmstat.8
View File

@ -1,79 +1,86 @@
.\" This page Copyright (C) 1994 Henry Ware <al172@yfn.ysu.edu> .\" This page Copyright (C) 1994 Henry Ware <al172@yfn.ysu.edu>
.\" Distributed under the GPL, Copyleft 1994. .\" Distributed under the GPL, Copyleft 1994.
.TH VMSTAT 8 "2009 Jan 9" "Throatwobbler Ginkgo Labs" "Linux Administrator's Manual" .TH VMSTAT 8 "September 2011" "procps-ng" "System Administration"
.SH NAME .SH NAME
vmstat \- Report virtual memory statistics vmstat \- Report virtual memory statistics
.SH SYNOPSIS .SH SYNOPSIS
.ft B
.B vmstat .B vmstat
.RB [ "\-a" ] [options]
.RB [ "\-n" ]
.RI [ delay " [" count ]] .RI [ delay " [" count ]]
.br
.B vmstat
.RB [ "\-f" ]
.RB [ "\-s" ]
.RB [ "\-m" ]
.br
.B vmstat
.RB [ "\-S unit"]
.br
.B vmstat
.RB [ "\-d"]
.br
.B vmstat
.RB [ "\-D"]
.br
.B vmstat
.RB [ "\-p disk partition"]
.br
.B vmstat
.RB [ "\-V" ]
.SH DESCRIPTION .SH DESCRIPTION
\fBvmstat\fP reports information about processes, memory, paging, .B vmstat
block IO, traps, disks and cpu activity. reports information about processes, memory, paging, block IO, traps, disks
and cpu activity.
.PP
The first report produced gives averages since the last reboot. Additional The first report produced gives averages since the last reboot. Additional
reports give information on a sampling period of length \fIdelay\fP. reports give information on a sampling period of length
.IR delay .
The process and memory reports are instantaneous in either case. The process and memory reports are instantaneous in either case.
.SH OPTIONS
.SS Options .TP
The \fB\-a\fP switch displays active/inactive memory, given a 2.5.41 kernel or better.
.PP
The \fB\-f\fP switch displays the number of forks since boot.
This includes the fork, vfork, and clone system calls, and is
equivalent to the total number of tasks created. Each process
is represented by one or more tasks, depending on thread usage.
This display does not repeat.
.PP
The \fB\-m\fP displays slabinfo.
.PP
The \fB\-n\fP switch causes the header to be displayed only once rather than periodically.
.PP
The \fB\-s\fP switch displays a table of various event counters
and memory statistics. This display does not repeat.
.PP
.I delay .I delay
is the delay between updates in seconds. If no delay is specified, The
only one report is printed with the average values since boot. .I delay
.PP between updates in seconds. If no
.I delay
is specified, only one report is printed with the average values since boot.
.TP
.I count .I count
is the number of updates. If no count is specified and delay is Number of updates. In absense of
defined, \fIcount\fP defaults to infinity. .IR count ,
.PP when
The \fB\-d\fP reports disk statistics (2.5.70 or above required) .I delay
.PP is defined, default is infinite.
The \fB-D\fP reports some summary statistics about disk activity. .TP
.PP \fB\-a\fR, \fB\-\-active\fR
The \fB\-p\fP followed by some partition name for detailed statistics (2.5.70 or above required) Display active and inactive memory, given a 2.5.41 kernel or better.
.PP .TP
The \fB\-S\fP followed by k or K or m or M switches outputs between \fB\-f\fR, \fB\-\-forks\fR
1000, 1024, 1000000, or 1048576 bytes. Note this does not change the The
swap (si/so) or block (bi/bo) fields. .B \-f
.PP switch displays the number of forks since boot. This includes the fork,
The \fB\-V\fP switch results in displaying version information. vfork, and clone system calls, and is equivalent to the total number of tasks
.PP created. Each process is represented by one or more tasks, depending on
.SH FIELD DESCRIPTION FOR VM MODE thread usage. This display does not repeat.
.TP
\fB\-m\fR, \fB\-\-slabs\fR
Displays slabinfo.
.TP
\fB\-n\fR, \fB\-\-one-header\fR
Display the header only once rather than periodically.
.TP
\fB\-s\fR, \fB\-\-stats\fR
Displays a table of various event counters and memory statistics. This
display does not repeat.
.TP
\fB\-d\fR, \fB\-\-disk\fR
Report disk statistics (2.5.70 or above required).
.TP
\fB\-D\fR, \fB\-\-disk-sum\fR
Report some summary statistics about disk activity.
.TP
\fB\-p\fR, \fB\-\-partition\fR \fIdevice\fR
Detailed statistics about partition (2.5.70 or above required).
.TP
\fB\-S\fR, \fB\-\-unit\fR \fIcharacter\fR
Switches outputs between 1000
.RI ( k ),
1024
.RI ( K ),
1000000
.RI ( m ),
or 1048576
.RI ( M )
bytes. Note this does not change the swap (si/so) or block (bi/bo)
fields.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help and exit.
.PD
.SH "FIELD DESCRIPTION FOR VM MODE"
.SS .SS
.B "Procs" .B "Procs"
.nf .nf
@ -124,7 +131,7 @@ wa: Time spent waiting for IO. Prior to Linux 2.5.41, included in idle.
st: Time stolen from a virtual machine. Prior to Linux 2.6.11, unknown. st: Time stolen from a virtual machine. Prior to Linux 2.6.11, unknown.
.fi .fi
.PP .PP
.SH FIELD DESCRIPTION FOR DISK MODE .SH "FIELD DESCRIPTION FOR DISK MODE"
.SS .SS
.B "Reads" .B "Reads"
.nf .nf
@ -149,19 +156,16 @@ ms: milliseconds spent writing
cur: I/O in progress cur: I/O in progress
s: seconds spent for I/O s: seconds spent for I/O
.fi .fi
.PP .PP
.SH FIELD DESCRIPTION FOR DISK PARTITION MODE .SH "FIELD DESCRIPTION FOR DISK PARTITION MODE"
.nf .nf
reads: Total number of reads issued to this partition reads: Total number of reads issued to this partition
read sectors: Total read sectors for partition read sectors: Total read sectors for partition
writes : Total number of writes issued to this partition writes : Total number of writes issued to this partition
requested writes: Total number of write requests made for partition requested writes: Total number of write requests made for partition
.fi .fi
.PP .PP
.SH FIELD DESCRIPTION FOR SLAB MODE .SH "FIELD DESCRIPTION FOR SLAB MODE"
.nf .nf
cache: Cache name cache: Cache name
num: Number of currently active objects num: Number of currently active objects
@ -169,21 +173,21 @@ total: Total number of available objects
size: Size of each object size: Size of each object
pages: Number of pages with at least one active object pages: Number of pages with at least one active object
.fi .fi
.SH NOTES .SH NOTES
.B "vmstat " .B "vmstat "
does not require special permissions. does not require special permissions.
.PP .PP
These reports are intended to help identify system bottlenecks. Linux These reports are intended to help identify system bottlenecks. Linux
.B "vmstat " .B vmstat
does not count itself as a running process. does not count itself as a running process.
.PP .PP
All linux blocks are currently 1024 bytes. Old kernels may report All linux blocks are currently 1024 bytes. Old kernels may report blocks as
blocks as 512 bytes, 2048 bytes, or 4096 bytes. 512 bytes, 2048 bytes, or 4096 bytes.
.PP .PP
Since procps 3.1.9, vmstat lets you choose units (k, K, m, M) default is K (1024 bytes) in the default mode Since procps 3.1.9, vmstat lets you choose units (k, K, m, M). Default is K
(1024 bytes) in the default mode.
.PP .PP
vmstat uses slabinfo 1.1 FIXME vmstat uses slabinfo 1.1
.SH FILES .SH FILES
.ta .ta
.nf .nf
@ -191,18 +195,27 @@ vmstat uses slabinfo 1.1 FIXME
/proc/stat /proc/stat
/proc/*/stat /proc/*/stat
.fi .fi
.SH "SEE ALSO" .SH "SEE ALSO"
.BR free (1),
.BR iostat (1), .BR iostat (1),
.BR sar (1),
.BR mpstat (1), .BR mpstat (1),
.BR ps (1), .BR ps (1),
.BR top (1), .BR sar (1),
.BR free (1) .BR top (1)
.PP .PP
.SH BUGS .SH BUGS
Does not tabulate the block io per device or count the number of system calls. Does not tabulate the block io per device or count the number of system calls.
.SH AUTHORS .SH AUTHORS
.nf Written by
Written by Henry Ware <al172@yfn.ysu.edu>. .UR al172\@yfn.\:ysu.\:edu
Fabian Fr\('ed\('erick <ffrederick@users.sourceforge.net> (diskstat, slab, partitions...) Henry Ware
.UE .
.br
.UR ffrederick\@users.\:sourceforge.\:net
Fabian Fr\('ed\('erick
.UE
(diskstat, slab, partitions...)
.SH "REPORTING BUGS"
Please send bug reports to
.UR procps\@freelists.org
.UE