NetBSD Problem Report #46140

From www@NetBSD.org  Sun Mar  4 04:38:30 2012
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [149.20.53.66])
	by www.NetBSD.org (Postfix) with ESMTP id 3BABC63E032
	for <gnats-bugs@gnats.NetBSD.org>; Sun,  4 Mar 2012 04:38:30 +0000 (UTC)
Message-Id: <20120304043829.341E063E02F@www.NetBSD.org>
Date: Sun,  4 Mar 2012 04:38:29 +0000 (UTC)
From: dhgutteridge@sympatico.ca
Reply-To: dhgutteridge@sympatico.ca
To: gnats-bugs@NetBSD.org
Subject: Patch to update the documentation for pf(4) on the website
X-Send-Pr-Version: www-1.0

>Number:         46140
>Category:       misc
>Synopsis:       Patch to update the documentation for pf(4) on the website
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    www
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Mar 04 04:40:00 +0000 2012
>Closed-Date:    Fri Mar 29 01:14:11 +0000 2013
>Last-Modified:  Fri Mar 29 01:14:11 +0000 2013
>Originator:     David H. Gutteridge
>Release:        Many
>Organization:
>Environment:
>Description:
Below I've attached a patch to update the pf(4) documentation on the
website[1] to reflect changes made since NetBSD 4.  I'm not sure if
it's complete, but it's based on everything I could find.

According to pf.conf(5), the "group" keyword is not supported, so I
assume that's still the case.  It does not state that route labels
are not supported; however, neither did the previous version of the
man page associated with version 3.7 of pf(4)...

1. http://www.netbsd.org/docs/network/pf.html
>How-To-Repeat:

>Fix:
--- pf.xml~	2008-05-02 21:22:51.000000000 -0500
+++ pf.xml	2012-03-03 23:32:34.000000000 -0500
@@ -9,7 +9,7 @@
 <config param="rcsdate" value="$Date: 2008/05/02 21:22:51 $"/>

 <head>
-<!-- Copyright (c) 1994-2006
+<!-- Copyright (c) 1994-2012
 The NetBSD Foundation, Inc.  ALL RIGHTS RESERVED. -->
 <title>NetBSD Packet Filter information</title>
 </head>
@@ -34,6 +34,11 @@
 <title>Availability</title>

 <para>
+NetBSD 5.0 includes PF from OpenBSD 4.2.  NetBSD 6.0 includes this same
+version, but also provides &man.pfsync.4; and &man.pfs.8;.
+</para>
+
+<para>
 NetBSD 4.0 includes PF from OpenBSD 3.7 with patches from the 3.7 branch.
 </para>

@@ -47,13 +52,22 @@
 <sect3 id="kernel">
 <title>Kernel options</title>
 <para>
-To use PF, you don't need to compile your own kernel, you can use the LKM
-<filename>/usr/lkm/pf.o</filename>. Use &man.modload.8; to load the LKM:
+To use PF, you don't need to compile your own kernel.  In versions of
+NetBSD prior to 6.0, you can use the LKM <filename>/usr/lkm/pf.o
+</filename>. Use &man.modload.8; to load the LKM:
 <screen>
 # modload /usr/lkm/pf.o
 </screen>
-But if you prefer to use PF in the kernel, then you need least the
-following option enabled:
+To use PF with NetBSD 6.0 (on architectures that support modules), you
+can use the module
+<filename>/stand/&lt;arch&gt;/&lt;release&gt;/modules/pf/pf.kmod</filename>.
+Use &man.modload.8; to load the module (if it was not loaded at boot
+time):
+<screen>
+# modload pf
+</screen>
+But if you prefer to use PF in the base kernel, then you need at least
+the following option enabled:
 <screen>
 options 	PFIL_HOOKS	# &man.pfil.9; packet filter hooks
 </screen>
@@ -95,12 +109,16 @@
 </para>

 <para>
-To load the LKM at boot-time, you need to set <userinput>lkm=YES</userinput>
+On NetBSD versions older than 6.0, to load the LKM at boot-time, you
+need to set <userinput>lkm=YES</userinput>
 in <filename>/etc/rc.conf</filename> and add the following line to
 <filename>/etc/lkm.conf</filename>:
 <screen>
 /usr/lkm/pf.o - - - - BEFORENET
 </screen>
+Beginning with NetBSD 6.0, to load the module at boot-time (on
+architectures that support modules), you simply need to edit
+<filename>/etc/rc.conf</filename> as noted above.
 </para>

 <para>
@@ -190,16 +208,16 @@

 <itemizedlist>
 <listitem>
-<ulink url="http://www.openbsd.org/cgi-bin/man.cgi?query=pfsync">pfsync(4)</ulink>
-is not supported (due to protocol # assignment issues).
-This will hopefully be solved in a future release.
+&man.pfsync.4; is supported since NetBSD 6.0.
+</listitem>
+<listitem>
+&man.pfs.8; is supported since NetBSD 6.0.
 </listitem>
 <listitem>
-ALTQ is supported since NetBSD 4.0.
+&man.altq.4; is supported since NetBSD 4.0.
 </listitem>
 <listitem>
-<ulink url="http://www.openbsd.org/cgi-bin/man.cgi?query=carp">carp(4)</ulink>
-is supported since NetBSD 4.0.
+&man.carp.4; is supported since NetBSD 4.0.
 </listitem>
 <listitem>
 The 'group' keyword does nothing, because NetBSD doesn't keep the GID
@@ -250,15 +268,23 @@
 <sect3 id="manpages">
 <title>Manual pages</title>
 <itemizedlist>
+<listitem>&man.altq.4; - alternate queuing framework</listitem>
+<listitem>&man.carp.4; - Common Address Redundancy Protocol</listitem>
 <listitem>&man.pf.4; - packet filter</listitem>
 <listitem>&man.pflog.4; - packet filter logging interface</listitem>
+<listitem>&man.pfsync.4; - packet filter state table logging interface
+</listitem>
+<listitem>&man.altq.conf.5; - ALTQ configuration file</listitem>
 <listitem>&man.pf.boot.conf.5; - initial configuration for packet filter</listitem>
 <listitem>&man.pf.conf.5; - packet filter configuration file</listitem>
 <listitem>&man.pf.os.5; - format of the operating system fingerprints file</listitem>
+<listitem>&man.altqd.8; - ALTQ daemon</listitem>
 <listitem>&man.authpf.8; - authenticating gateway user shell</listitem>
 <listitem>&man.ftp-proxy.8; - Internet File Transfer Protocol proxy server</listitem>
 <listitem>&man.pfctl.8; - control the packet filter (PF) and network address translation (NAT) device</listitem>
 <listitem>&man.pflogd.8; - packet filter logging daemon</listitem>
+<listitem>&man.pfs.8; - save and restore information for NAT and state
+tables</listitem>
 </itemizedlist>
 </sect3>


>Release-Note:

>Audit-Trail:

Responsible-Changed-From-To: misc-bug-people->www
Responsible-Changed-By: wiz@NetBSD.org
Responsible-Changed-When: Sun, 04 Mar 2012 12:24:17 +0000
Responsible-Changed-Why:
website bug report


From: matthew sporleder <mspo@mspo.com>
To: gnats-bugs@netbsd.org
Cc: www@netbsd.org, misc-bug-people@netbsd.org, netbsd-bugs@netbsd.org, 
	gnats-admin@netbsd.org, wiz@netbsd.org, dhgutteridge@sympatico.ca
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Sun, 4 Mar 2012 08:19:35 -0500

 I can't apply this change because my system doesn't have the necessary
 man pages, resulting in blanks.

 Does someone with -current want to try?

 On Sun, Mar 4, 2012 at 7:24 AM,  <wiz@netbsd.org> wrote:
 > Synopsis: Patch to update the documentation for pf(4) on the website
 >
 > Responsible-Changed-From-To: misc-bug-people->www
 > Responsible-Changed-By: wiz@NetBSD.org
 > Responsible-Changed-When: Sun, 04 Mar 2012 12:24:17 +0000
 > Responsible-Changed-Why:
 > website bug report
 >
 >
 >

From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
To: gnats-bugs@netbsd.org
Cc: 
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Tue, 24 Apr 2012 21:11:55 -0400

 On 2012-03-04, at 8:19 AM, matthew sporleder wrote:
 > I can't apply this change because my system doesn't have the necessary
 > man pages, resulting in blanks.
 > 
 > Does someone with -current want to try?

 I can generate the HTML file at my end, but I guess that doesn't
 cover off independent validation...

 (As an aside, the DTD URL at the top of the XML document doesn't
 actually resolve...
 http://www.NetBSD.org/XML/htdocs/lang/share/xml/website-netbsd.dtd
 isn't valid.)

 Regards,

 Dave

From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
To: gnats-bugs@netbsd.org
Cc: 
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Tue, 26 Mar 2013 23:20:03 -0400

 Is anyone in the "www" group now using NetBSD >= 6 and could give this a try?

 Dave

From: "Matthew Sporleder (mspo.com)" <mspo@mspo.com>
To: gnats-bugs@NetBSD.org
Cc: www@netbsd.org, gnats-admin@netbsd.org, netbsd-bugs@netbsd.org,
	dhgutteridge@sympatico.ca
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the
 website)
Date: Wed, 27 Mar 2013 22:34:43 -0400

 On Wed, Mar 27, 2013 at 04:25:05AM +0000, David H. Gutteridge wrote:
 > The following reply was made to PR misc/46140; it has been noted by GNATS.
 > 
 > From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
 > To: gnats-bugs@netbsd.org
 > Cc: 
 > Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
 > Date: Tue, 26 Mar 2013 23:20:03 -0400
 > 
 >  Is anyone in the "www" group now using NetBSD >= 6 and could give this a try?
 >  
 >  Dave
 >  

 Is this still a problem?  I think your patch is applied.
 http://www.netbsd.org/docs/network/pf.html

 <quote>
  To use PF, you don't need to compile your own kernel. In versions of
  NetBSD prior to 6.0, you can use the LKM /usr/lkm/pf.o . Use modload(8)
  to load the LKM: 
 </quote>

From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
To: gnats-bugs@NetBSD.org
Cc: mspo@mspo.com
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Wed, 27 Mar 2013 23:04:26 -0400

 On 2013-03-27, at 10:35 PM, Matthew Sporleder (mspo.com) wrote:
 > 
 > Is this still a problem?  I think your patch is applied.
 > http://www.netbsd.org/docs/network/pf.html
 > 
 > <quote>
 >  To use PF, you don't need to compile your own kernel. In versions of
 >  NetBSD prior to 6.0, you can use the LKM /usr/lkm/pf.o . Use modload(8)
 >  to load the LKM: 
 > </quote>

 Ah, it looks like it was applied, except whoever applied it didn't
 have all the man pages that were referenced in the XML source, so
 there are empty spots where the links should be.  (Or something
 else has changed so that the man page reference insertion doesn't
 work.)

 Dave

From: matthew sporleder <mspo@mspo.com>
To: gnats-bugs@netbsd.org
Cc: www@netbsd.org, gnats-admin@netbsd.org, netbsd-bugs@netbsd.org, 
	dhgutteridge@sympatico.ca
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Thu, 28 Mar 2013 08:22:27 -0400

 Do you have time to make a new patch?

From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
To: matthew sporleder <mspo@mspo.com>
Cc: gnats-bugs@netbsd.org
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Thu, 28 Mar 2013 09:44:18 -0400

 On 2013-03-28, at 8:22 AM, matthew sporleder wrote:

 > Do you have time to make a new patch?
 > 

 The existing XML file doesn't need to be patched as far as I know;
 it has the correct references in it as committed, it's just that the
 HTML generated from it is incomplete, presumably because it was done
 on a machine that didn't have all the current man pages installed,
 so those entity references failed to generate the links.  (This is
 what you'd warned could happen a year ago.)

 Dave

From: matthew sporleder <mspo@mspo.com>
To: gnats-bugs@netbsd.org
Cc: www@netbsd.org, gnats-admin@netbsd.org, netbsd-bugs@netbsd.org, 
	dhgutteridge@sympatico.ca
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Thu, 28 Mar 2013 11:26:47 -0400

 On Thu, Mar 28, 2013 at 9:45 AM, David H. Gutteridge
 <dhgutteridge@sympatico.ca> wrote:
 > The following reply was made to PR misc/46140; it has been noted by GNATS.
 >
 > From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
 > To: matthew sporleder <mspo@mspo.com>
 > Cc: gnats-bugs@netbsd.org
 > Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
 > Date: Thu, 28 Mar 2013 09:44:18 -0400
 >
 >  On 2013-03-28, at 8:22 AM, matthew sporleder wrote:
 >
 >  > Do you have time to make a new patch?
 >  >
 >
 >  The existing XML file doesn't need to be patched as far as I know;
 >  it has the correct references in it as committed, it's just that the
 >  HTML generated from it is incomplete, presumably because it was done
 >  on a machine that didn't have all the current man pages installed,
 >  so those entity references failed to generate the links.  (This is
 >  what you'd warned could happen a year ago.)
 >
 >  Dave
 >


 Cool.  I just regen-ed and committed.

From: "David H. Gutteridge" <dhgutteridge@sympatico.ca>
To: matthew sporleder <mspo@mspo.com>
Cc: gnats-bugs@netbsd.org
Subject: Re: misc/46140 (Patch to update the documentation for pf(4) on the website)
Date: Thu, 28 Mar 2013 11:34:03 -0400

 On 2013-03-28, at 11:26 AM, matthew sporleder wrote:
 > 
 > Cool.  I just regen-ed and committed.

 Looks good, this PR can be closed, thanks!

 Dave

State-Changed-From-To: open->closed
State-Changed-By: mspo@NetBSD.org
State-Changed-When: Fri, 29 Mar 2013 01:14:11 +0000
State-Changed-Why:
regen-ed the page; looks good


>Unformatted:

NetBSD Home
NetBSD PR Database Search

(Contact us) $NetBSD: query-full-pr,v 1.39 2013/11/01 18:47:49 spz Exp $
$NetBSD: gnats_config.sh,v 1.8 2006/05/07 09:23:38 tsutsui Exp $
Copyright © 1994-2007 The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.