From yugawa@orleans.rim.or.jp  Thu May 29 06:17:29 1997
Received: from rayearth.rim.or.jp (uucp@rayearth.rim.or.jp [202.247.130.242])
          by hub.freebsd.org (8.8.5/8.8.5) with ESMTP id GAA12216
          for <FreeBSD-gnats-submit@freebsd.org>; Thu, 29 May 1997 06:17:18 -0700 (PDT)
Received: (from uucp@localhost) by rayearth.rim.or.jp (8.8.5/3.5Wpl2-uucp1/RIMNET) with UUCP
	id WAA29333 for FreeBSD-gnats-submit@freebsd.org; Thu, 29 May 1997 22:17:14 +0900 (JST)
Received: (from uucp@localhost) by orleans.rim.or.jp (8.8.5/3.5W-darwin.1) with UUCP id VAA23286; Thu, 29 May 1997 21:47:39 +0900 (JST)
Received: (from yugawa@localhost) by oleo.orleans.rim.or.jp (8.8.5/3.5W-oleo.1) id PAA01754; Thu, 29 May 1997 15:44:45 +0900 (JST)
Message-Id: <199705290644.PAA01754@oleo.orleans.rim.or.jp>
Date: Thu, 29 May 1997 15:44:45 +0900 (JST)
From: Takahiro Yugawa <yugawa@orleans.rim.or.jp>
Reply-To: yugawa@orleans.rim.or.jp
To: FreeBSD-gnats-submit@freebsd.org
Cc: yugawa@orleans.rim.or.jp
Subject: manpage vmstat.8 has some problems
X-Send-Pr-Version: 3.2

>Number:         3709
>Category:       docs
>Synopsis:       manpage vmstat.8 has some problems
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    steve
>State:          closed
>Quarter:
>Keywords:
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu May 29 06:20:01 PDT 1997
>Closed-Date:    Sat Aug 23 14:43:15 PDT 1997
>Last-Modified:  Sat Aug 23 14:44:34 PDT 1997
>Originator:     Takahiro Yugawa
>Release:        FreeBSD 2.2.1-RELEASE i386
>Organization:
personal FreeBSD user in Japan
>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
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: steve 
State-Changed-When: Sat Aug 23 14:43:15 PDT 1997 
State-Changed-Why:  
Suggested patch applied in revision 1.8 of vmstat.8.  Thanks! 

>Unformatted:
