[src/trunk]: src NPF: add a general npf(7) manual page. Improved by wiz@.

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

details:   https://anonhg.NetBSD.org/src/rev/31c426531ca7
branches:  trunk
changeset: 331138:31c426531ca7
user:      rmind <rmind%NetBSD.org@localhost>
date:      Sat Aug 02 23:57:40 2014 +0000

description:
NPF: add a general npf(7) manual page.  Improved by wiz@.

diffstat:

 distrib/sets/lists/man/mi |   5 ++-
 usr.sbin/npf/Makefile     |   5 ++-
 usr.sbin/npf/npf.7        |  91 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 99 insertions(+), 2 deletions(-)

diffs (145 lines):

diff -r 258c36ac6e6e -r 31c426531ca7 distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Sat Aug 02 19:35:13 2014 +0000
+++ b/distrib/sets/lists/man/mi Sat Aug 02 23:57:40 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1481 2014/08/01 14:08:47 christos Exp $
+# $NetBSD: mi,v 1.1482 2014/08/02 23:57:40 rmind Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -2224,6 +2224,7 @@
 ./usr/share/man/cat7/module.0                  man-reference-catman    .cat
 ./usr/share/man/cat7/msafer.0                  man-obsolete            obsolete
 ./usr/share/man/cat7/nls.0                     man-reference-catman    .cat
+./usr/share/man/cat7/npf.0                     man-npf-catman          .cat,npf
 ./usr/share/man/cat7/orders.0                  man-reference-catman    .cat
 ./usr/share/man/cat7/packages.0                        man-obsolete            obsolete
 ./usr/share/man/cat7/pcap-filter.0             man-netutil-catman      .cat
@@ -5167,6 +5168,7 @@
 ./usr/share/man/html7/mdoc.html                        man-groff-htmlman       html,groff
 ./usr/share/man/html7/module.html              man-reference-htmlman   html
 ./usr/share/man/html7/nls.html                 man-reference-htmlman   html
+./usr/share/man/html7/npf.html                 man-npf-htmlman         html,npf
 ./usr/share/man/html7/orders.html              man-reference-htmlman   html
 ./usr/share/man/html7/pcap-filter.html         man-netutil-htmlman     html
 ./usr/share/man/html7/pcap-linktype.html       man-netutil-htmlman     html
@@ -8084,6 +8086,7 @@
 ./usr/share/man/man7/module.7                  man-reference-man       .man
 ./usr/share/man/man7/msafer.7                  man-obsolete            obsolete
 ./usr/share/man/man7/nls.7                     man-reference-man       .man
+./usr/share/man/man7/npf.7                     man-npf-man             .man,npf
 ./usr/share/man/man7/orders.7                  man-reference-man       .man
 ./usr/share/man/man7/packages.7                        man-obsolete            obsolete
 ./usr/share/man/man7/pcap-filter.7             man-netutil-man         .man
diff -r 258c36ac6e6e -r 31c426531ca7 usr.sbin/npf/Makefile
--- a/usr.sbin/npf/Makefile     Sat Aug 02 19:35:13 2014 +0000
+++ b/usr.sbin/npf/Makefile     Sat Aug 02 23:57:40 2014 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.4 2012/09/13 21:02:50 martin Exp $
+# $NetBSD: Makefile,v 1.5 2014/08/02 23:57:40 rmind Exp $
 
 .include <bsd.own.mk>
 
@@ -8,4 +8,7 @@
 SUBDIR+=       npftest
 .endif
 
+MAN=           npf.7
+
+.include <bsd.man.mk>
 .include <bsd.subdir.mk>
diff -r 258c36ac6e6e -r 31c426531ca7 usr.sbin/npf/npf.7
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/usr.sbin/npf/npf.7        Sat Aug 02 23:57:40 2014 +0000
@@ -0,0 +1,91 @@
+.\"    $NetBSD: npf.7,v 1.1 2014/08/02 23:57:40 rmind Exp $
+.\"
+.\" Copyright (c) 2009-2014 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This material is based upon work partially supported by The
+.\" NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd August 2, 2014
+.Dt NPF 7
+.Os
+.Sh NAME
+.Nm NPF
+.Nd NetBSD packet filter
+.\" -----
+.Sh DESCRIPTION
+NPF is a layer 3 packet filter, supporting IPv4 and IPv6 as well as
+layer 4 protocols such as TCP, UDP, and ICMP.
+It was designed with a focus on high performance, scalability, and
+modularity.
+.Pp
+NPF was written from scratch in 2009 and is distributed under the
+2-clause BSD license.
+.\" -----
+.Sh FEATURES
+NPF offers the traditional set of features provided by packet filters.
+Some key features are:
+.Bl -bullet -offset indent
+.It
+Stateful inspection (connection tracking).
+.It
+Network address translation (NAT).
+This includes static (stateless) and dynamic (stateful) translation,
+port translation, bi-directional NAT, etc.
+.It
+IPv6-to-IPv6 network prefix translation (NPTv6).
+.It
+Tables for efficient IP sets.
+.It
+Application Level Gateways (e.g., to support traceroute).
+.It
+NPF uses BPF with just-in-time (JIT) compilation.
+.It
+Rule procedures and a framework for NPF extensions.
+.It
+Traffic normalization (extension).
+.It
+Packet logging (extension).
+.El
+.Pp
+For a full set features and their description, see the NPF
+documentation and other manual pages.
+.\" -----
+.Sh SEE ALSO
+.Xr libnpf 3 ,
+.Xr bpf 4 ,
+.Xr bpfjit 4 ,
+.Xr npf.conf 5 ,
+.Xr pcap-filter 7 ,
+.Xr npfctl 8
+.Pp
+.Lk http://www.netbsd.org/~rmind/npf/ "NPF documentation"
+.Sh HISTORY
+.Nm
+first appeared in
+.Nx 7.0 .
+.Sh AUTHORS
+.Nm
+was designed and implemented by
+.An Mindaugas Rasiukevicius .