[src/trunk]: src/usr.bin/vmstat - mdocify

[ad <ad%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/a5c7e2bbb5a6
branches:  trunk
changeset: 499149:a5c7e2bbb5a6
user:      ad <ad%NetBSD.org@localhost>
date:      Mon Nov 13 12:16:28 2000 +0000

description:
- mdocify
- misc clean ups

diffstat:

 usr.bin/vmstat/vmstat.8 |  283 ++++++++++++++++++++++++-----------------------
 1 files changed, 146 insertions(+), 137 deletions(-)

diffs (truncated from 341 to 300 lines):

diff -r 568991d2ced3 -r a5c7e2bbb5a6 usr.bin/vmstat/vmstat.8
--- a/usr.bin/vmstat/vmstat.8   Mon Nov 13 11:52:41 2000 +0000
+++ b/usr.bin/vmstat/vmstat.8   Mon Nov 13 12:16:28 2000 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: vmstat.8,v 1.19 2000/09/28 14:51:15 sommerfeld Exp $
+.\"    $NetBSD: vmstat.8,v 1.20 2000/11/13 12:16:28 ad Exp $
 .\"
 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -64,186 +64,195 @@
 .\"
 .\"    @(#)vmstat.8    8.1 (Berkeley) 6/6/93
 .\"
-.TH VMSTAT 8 "February 12, 1998"
-.UC 4
-.SH NAME
-vmstat \- report virtual memory statistics
-.SH SYNOPSIS
-.nf
-.ft B
-vmstat [ \-efHilmsv ] [ \-h histname ] [ \-c count ] [ \-M core ]
-.ti +5
-[ \-N system ] [ \-w wait ] [ disks ]
-.ft R
-.fi
-.SH DESCRIPTION
-.I Vmstat
+.Dd Feburary 12, 1998
+.Dt VMSTAT 1
+.Os
+.Sh NAME
+.Nm vmstat
+.Nd report virtual memory statistics
+.Sh SYNOPSIS
+.Nm
+.Op Fl Hefilmsv
+.Op Fl M Ar core
+.Op Fl N Ar system
+.Op Fl c Ar count
+.Op Fl h Ar histname
+.Op Fl w Ar wait
+.Op Ar disks
+.Sh DESCRIPTION
+.Nm
 reports certain kernel statistics kept about process, virtual memory,
 disk, trap and cpu activity.
-.PP
+.Pp
 The options are as follows:
-.TP
-\-c
+.Bl -tag -width indent
+.It Fl H
+Dump all UVM histories.
+.It Fl M Ar core
+Extract values associated with the name list from the specified core 
+instead of the default
+.Pa /dev/mem .
+.It Fl N Ar system
+Extract the name list from the specified system instead of the default
+.Pa /netbsd .
+.It Fl c Ar count
 Repeat the display
-.I count
+.Ar 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
+.Ar wait
 interval is specified, the default is 1 second.
-.TP
-\-e
+.It Fl e
 Report the values of system event counters.
-.TP
-\-f
+.It Fl f
 Report fork statistics.
-.TP
-\-i
+.It Fl h Ar histname
+Dump the specified UVM history.
+.It Fl i
 Report the values of system interrupt counters.
-.TP
-\-M
-Extract values associated with the name list from the specified core 
-instead of the default ``/dev/mem''.
-.TP
-\-N
-Extract the name list from the specified system instead of the default
-``/netbsd''.
-.TP
-\-m
+.It Fl l
+List the UVM histories being maintained by the kernel.
+.It Fl m
 Report on the usage of kernel dynamic memory listed first by size of
 allocation and then by type of usage.
-.TP
-\-s
+.It Fl s
 Display the contents of the
-.I sum
+.Dv sum
 structure, giving the total number of several kinds of paging related
 events which have occurred since system startup.
-.TP
-\-v
+.It Fl v
 Print more verbose information.  When used with the
-\-i or \-e flags, prints out all interrupts or event counters,
-not just those with non-zero values.
-.TP
-\-w
+.Fl i
+or
+.Fl e
+options, prints out all interrupts or event counters, not just those with
+non-zero values.
+.It Fl w Ar wait
 Pause
-.I wait
+.Ar wait
 seconds between each display.
 If no repeat
-.I count
+.Ar count
 is specified, the default is infinity.
-.PP
-The following options only apply if
-.I vmstat
-was built with support for UVM:
-.TP
-\-l
-List the UVM histories being maintained by the kernel.
-.TP
-\-h
-Dump the specified UVM history.
-.TP
-\-H
-Dump all UVM histories.
-.PP
+.El
+.Pp
 By default,
-.I vmstat
+.Nm
 displays the following information:
-.PP
-.TP
-procs
+.Pp
+.Bl -tag -width memory
+.It 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
-.RE
-.TP
-memory
+.Pp
+.Bl -tag -width abcd -compact
+.It r
+in run queue
+.It b
+blocked for resources (i/o, paging, etc.)
+.It w
+runnable or short sleeper (< 20 secs) but swapped
+.El
+.It 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
-.RE
-.TP
-page
+.Pp
+.Bl -tag -width abcd -compact
+.It avm
+active virtual pages
+.It fre
+size of the free list
+.El
+.It page
 Information about page faults and paging activity.
 These are averaged each five seconds, and given in units per second.
-.sp
-.RS
-.nf
-flt    total page faults
-re     page reclaims (simulating reference bits)
-pi     pages paged in
-po     pages paged out
-fr     pages freed per second
-sr     pages scanned by clock algorithm, per-second
-.fi
-.RE
-.TP
-disks
+.Pp
+.Bl -tag -width abcd -compact
+.It flt
+total page faults
+.It re
+page reclaims (simulating reference bits)
+.It pi
+pages paged in
+.It po
+pages paged out
+.It fr
+pages freed per second
+.It sr
+pages scanned by clock algorithm, per-second
+.El
+.It disks
 Disk transfers per second.
 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
+.Nm
 displays only the first four drives.
 To force
-.I vmstat
+.Nm
 to display specific drives, their names may be supplied on the command line.
-.TP
-faults
+.It faults
 Trap/interrupt rate averages per second over last 5 seconds.
-.sp
-.RS
-.nf
-in     device interrupts per interval (including clock interrupts)
-sy     system calls per interval
-cs     cpu context switch rate (switches/interval)
-.fi
-.RE
-.TP
-cpu
+.Pp
+.Bl -tag -width abcd -compact
+.It in
+device interrupts per interval (including clock interrupts)
+.It sy
+system calls per interval
+.It cs
+cpu context switch rate (switches/interval)
+.El
+.It 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
-.RE
-.SH EXAMPLES
+.Pp
+.Bl -tag -width abcd -compact
+.It us
+user time for normal and low priority processes
+.It sy
+system time
+.It id
+cpu idle
+.El
+.El
+.Sh EXAMPLES
 The command ``vmstat -w 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
-.ta \w'/dev/mem  'u
-/netbsd        default kernel namelist
-.br
-/dev/mem       default memory file
-.SH SEE ALSO
-.IR fstat (1),
-.IR netstat (1),