NetBSD/dist/ipf/man/ipnat.8

85 lines
1.9 KiB
Groff

.\" $NetBSD: ipnat.8,v 1.2 2000/05/06 15:39:02 veego Exp $
.\"
.TH IPNAT 8
.SH NAME
ipnat \- user interface to the NAT
.SH SYNOPSIS
.Nm ipnat
.B ipnat
[
.B \-lnrsvCF
]
.B \-f <\fIfilename\fP>
.SH DESCRIPTION
.PP
\fBipnat\fP opens the filename given (treating "\-" as stdin) and parses the
file for a set of rules which are to be added or removed from the IP NAT.
.PP
Each rule processed by \fBipnat\fP
is added to the kernels internal lists if there are no parsing problems.
Rules are added to the end of the internal lists, matching the order in
which they appear when given to \fBipnat\fP.
.PP
\fBPlease Note\fP
that
\fBipnat\fP
is not functional without
\fBipf(8)\fP
running. In addition, the following kernel options need to be turned on
in order to use
\fBipnat\fP:
\fIIPFORWARDING\fP
and
\fIPFIL_HOOKS\fP.
The
\fIGATEWAY\fP
kernel option includes the
\fIIPFORWARDING\fP
option.
The sysctl command:
.LP
.nf
sysctl net.inet.ip.forwarding
.fi
.PP
will inform you if
\fIIPFORWARDING\fP
is currently turned on in your kernel.
Please see
\fBoptions(4)\fP
and
\fBsysctl(8)\fP
for more information on turning these parameters on.
.SH OPTIONS
.TP
.B \-C
delete all entries in the current NAT rule listing (NAT rules)
.TP
.B \-F
delete all active entries in the current NAT translation table (currently
active NAT mappings)
.TP
.B \-l
Show the list of current NAT table entry mappings.
.TP
.B \-n
This flag (no-change) prevents \fBipf\fP from actually making any ioctl
calls or doing anything which would alter the currently running kernel.
.TP
.B \-s
Retrieve and display NAT statistics
.TP
.B \-r
Remove matching NAT rules rather than add them to the internal lists
.TP
.B \-v
Turn verbose mode on. Displays information relating to rule processing
and active rules/table entries.
.DT
.SH FILES
/dev/ipnat
.br
/usr/share/examples/ipf Directory with examples.
.SH SEE ALSO
ipnat(5), ipf(8), ipfstat(8)