Subject: bin/3624: typos and inconsistences in the man pages from the ipf package
To: None <gnats-bugs@gnats.netbsd.org>
From: None <frueauf@NetBSD.ORG>
List: netbsd-bugs
Date: 05/14/1997 21:02:02
>Number:         3624
>Category:       bin
>Synopsis:       typos and inconsistences in the man pages from the ipf package
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people (Utility Bug People)
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Wed May 14 12:35:01 1997
>Last-Modified:
>Originator:     Thorsten Frueauf
>Organization:
private
>Release:        <NetBSD-current source date> NetBSD current 13.05.1997
>Environment:
	
System: NetBSD di_frueauf 1.2E NetBSD 1.2E (CYBERDYNE) #0: Wed May 14 18:16:34 CEST 1997 milano@di_frueauf:/usr/src/sys/arch/amiga/compile/CYBERDYNE amiga


>Description:
	
There are some minore typos in the man pages for the ipf package:
	- vmunix -> netbsd
	- false number in the .TH rule

and the "SEE ALSO" field is inconsistent and refers to false man sections.

>How-To-Repeat:
	
read all man pages from the ipf package in /src/usr.sbin/ipf

>Fix:
	
Apply the following patch to the proper files:


*** /src/usr.sbin/ipf/ipf/ipf.4	Mon Apr 14 17:25:01 1997
--- ipf.4	Wed May 14 20:39:31 1997
***************
*** 180,183 ****
  };
  .fi
  .SH SEE ALSO
! ipfstat(1), ipf(1), ipf(5)
--- 180,183 ----
  };
  .fi
  .SH SEE ALSO
! ipl(4), ipnat(4), ipf(5), ipnat(5), ipf(8), ipfstat(8), ipmon(8), ipnat(8)
*** /src/usr.sbin/ipf/ipf/ipf.5	Mon Apr 14 17:25:01 1997
--- ipf.5	Wed May 14 20:41:46 1997
***************
*** 430,433 ****
  .br
  /etc/hosts
  .SH SEE ALSO
! ipf(1), ipftest(1)
--- 430,433 ----
  .br
  /etc/hosts
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipnat(5), ipf(8), ipfstat(8), ipmon(8), ipnat(8)
*** /src/usr.sbin/ipf/ipf/ipf.8	Mon Apr 14 17:25:01 1997
--- ipf.8	Wed May 14 20:42:56 1997
***************
*** 1,4 ****
! .TH IPF 1
  .SH NAME
  ipf \- alters packet filtering lists for IP packet input and ouput
  .SH SYNOPSIS
--- 1,4 ----
! .TH IPF 8
  .SH NAME
  ipf \- alters packet filtering lists for IP packet input and ouput
  .SH SYNOPSIS
***************
*** 99,105 ****
  affect fragment or state statistics).
  .DT
  .SH SEE ALSO
! ipfstat(1), ipftest(1), ipf(5)
  .SH DIAGNOSTICS
  .PP
  Needs to be run as root for the packet filtering lists to actually
--- 99,105 ----
  affect fragment or state statistics).
  .DT
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipf(5), ipnat(5), ipfstat(8), ipmon(8), ipnat(8)
  .SH DIAGNOSTICS
  .PP
  Needs to be run as root for the packet filtering lists to actually
*** /src/usr.sbin/ipf/ipf/ipl.4	Mon Apr 14 17:25:02 1997
--- ipl.4	Wed May 14 20:44:50 1997
***************
*** 112,118 ****
  .Pp
  This pseudo-device includes the PFIL_HOOKS option.
  .Sh SEE ALSO
! .Xr ipf 4
  .Sh BUGS
  Packet headers are dropped when the internal buffer (static size) fills.
  .Sh FILES
--- 112,125 ----
  .Pp
  This pseudo-device includes the PFIL_HOOKS option.
  .Sh SEE ALSO
! .Xr ipf 4 ,
! .Xr ipnat 4 ,
! .Xr ipf 5 ,
! .Xr ipnat 5 ,
! .Xr ipf 8 ,
! .Xr ipfstat 8 ,
! .Xr ipmon 8 ,
! .Xr ipnat 8
  .Sh BUGS
  Packet headers are dropped when the internal buffer (static size) fills.
  .Sh FILES
*** /src/usr.sbin/ipf/ipfstat/ipfstat.8	Thu Jan  9 15:31:35 1997
--- ipfstat.8	Wed May 14 20:43:55 1997
***************
*** 14,20 ****
  \fBipfstat\fP examines /dev/kmem using the symbols \fB_fr_flags\fP,
  \fB_frstats\fP, \fB_filterin\fP, and \fB_filterout\fP.
  To run and work, it needs to be able to read both /dev/kmem and the
! kernel itself.  The kernel name defaults to \fB/vmunix\fP.
  .PP
  The default behaviour of \fBipfstat\fP
  is to retrieve and display the accumulated statistics which have been
--- 14,20 ----
  \fBipfstat\fP examines /dev/kmem using the symbols \fB_fr_flags\fP,
  \fB_frstats\fP, \fB_filterin\fP, and \fB_filterout\fP.
  To run and work, it needs to be able to read both /dev/kmem and the
! kernel itself.  The kernel name defaults to \fB/netbsd\fP.
  .PP
  The default behaviour of \fBipfstat\fP
  is to retrieve and display the accumulated statistics which have been
***************
*** 66,73 ****
  .SH FILES
  /dev/kmem
  .br
! /vmunix
  .SH SEE ALSO
! ipf(1), ipfstat(1)
  .SH BUGS
  none known.
--- 66,73 ----
  .SH FILES
  /dev/kmem
  .br
! /netbsd
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipf(5), ipnat(5), ipf(8), ipmon(8), ipnat(8)
  .SH BUGS
  none known.
*** /src/usr.sbin/ipf/ipmon/ipmon.8	Thu Jan  9 15:31:37 1997
--- ipmon.8	Wed May 14 20:46:24 1997
***************
*** 52,56 ****
  .SH FILES
  /dev/ipl
  .SH SEE ALSO
! ipf(1), ipfstat(1)
  .SH BUGS
--- 52,56 ----
  .SH FILES
  /dev/ipl
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipf(5), ipnat(5), ipf(8), ipfstat(8), ipnat(8)
  .SH BUGS
*** /src/usr.sbin/ipf/ipnat/ipnat.4	Thu Jan  9 15:31:38 1997
--- ipnat.4	Wed May 14 20:38:16 1997
***************
*** 85,88 ****
  It would be nice if there were more flexibility when adding and deleting
  filter rules.
  .SH SEE ALSO
! ipfstat(1), ipf(1), ipf(4), ipnat(5)
--- 85,88 ----
  It would be nice if there were more flexibility when adding and deleting
  filter rules.
  .SH SEE ALSO
! ipf(4), ipl(4), ipf(5), ipnat(5), ipf(8), ipfstat(8), ipmon(8), ipnat(8)
*** /src/usr.sbin/ipf/ipnat/ipnat.5	Thu Jan  9 15:31:38 1997
--- ipnat.5	Wed May 14 20:48:12 1997
***************
*** 67,70 ****
  .br
  /etc/hosts
  .SH SEE ALSO
! ipnat(1), ipf(5), ipnat(4)
--- 67,70 ----
  .br
  /etc/hosts
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipf(5), ipf(8), ipfstat(8), ipmon(8), ipnat(8)
*** /src/usr.sbin/ipf/ipnat/ipnat.8	Tue Apr  1 15:50:19 1997
--- ipnat.8	Wed May 14 20:49:22 1997
***************
*** 1,4 ****
! .TH IPNAT 1
  .SH NAME
  ipnat \- user interface to the NAT
  .SH SYNOPSIS
--- 1,4 ----
! .TH IPNAT 8
  .SH NAME
  ipnat \- user interface to the NAT
  .SH SYNOPSIS
***************
*** 42,45 ****
  Turn verbose mode on.  Displays information relating to rule processing.
  .DT
  .SH SEE ALSO
! ipfstat(1), ipftest(1), ipf(1), ipnat(5)
--- 42,45 ----
  Turn verbose mode on.  Displays information relating to rule processing.
  .DT
  .SH SEE ALSO
! ipf(4), ipl(4), ipnat(4), ipf(5), ipnat(5), ipf(8), ipstat(8), ipmon(8)
>Audit-Trail:
>Unformatted:
typos and inconsistences in the man pages from the ipf package