Date: Thu, 29 May 1997 15:44:45 +0900 (JST) From: Takahiro Yugawa <yugawa@orleans.rim.or.jp> To: FreeBSD-gnats-submit@FreeBSD.ORG Cc: yugawa@orleans.rim.or.jp Subject: docs/3709: manpage vmstat.8 has some problems Message-ID: <199705290644.PAA01754@oleo.orleans.rim.or.jp> Resent-Message-ID: <199705291320.GAA12369@hub.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 3709
>Category: docs
>Synopsis: manpage vmstat.8 has some problems
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-bugs
>State: open
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Thu May 29 06:20:01 PDT 1997
>Last-Modified:
>Originator: Takahiro Yugawa
>Organization:
personal FreeBSD user in Japan
>Release: FreeBSD 2.2.1-RELEASE i386
>Environment:
FreeBSD oleo 2.2.1-RELEASE FreeBSD 2.2.1-RELEASE #0: Sat May 10 13:56:54 JST 1997 root@oleo:/usr/src/sys/compile/OLEO i386
>Description:
There are 3 problems in vmstat.8 manual page.
1. The -f and -t flags of vmstat have been obsoleted and
'.Sh DESCRIPTION' for these options are commented out.
But '.Sh SYNOPSIS' still has these options.
2. '.Sh SYNOPSIS' part is formatted like
-----
SYNOPSIS
vmstat [-fimst] [-c count] [-M -core] [-N -system] [-w -wait] [disks]
-----
but it should be
-----
SYNOPSIS
vmstat [-fimst] [-c count] [-M core] [-N system] [-w wait] [disks]
-----
There should be no leading ``-'' for core, system, and wait.
3. The last part of vmstat.8 has '.SH BUGS' but it must be
'.Sh BUGS'
>How-To-Repeat:
% man vmstat
>Fix:
Here's an unified diff for /usr/src/usr.bin/vmstat/vmstat.8.
--- vmstat.8.orig Thu Jan 9 15:50:34 1997
+++ vmstat.8 Thu May 29 10:17:02 1997
@@ -39,11 +39,12 @@
.Nd report virtual memory statistics
.Sh SYNOPSIS
.Nm vmstat
-.Op Fl fimst
+.\" .Op Fl fimst
+.Op Fl ims
.Op Fl c Ar count
-.Op Fl M core
-.Op Fl N system
-.Op Fl w wait
+.Op Fl M Ar core
+.Op Fl N Ar system
+.Op Fl w Ar wait
.Op Ar disks
.Sh DESCRIPTION
.Nm Vmstat
@@ -211,7 +212,7 @@
.Pp
The sections starting with ``Interpreting system activity'' in
.%T "Installing and Operating 4.3BSD" .
-.SH BUGS
+.Sh BUGS
The
.Fl c
and
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199705290644.PAA01754>