Sync usage with man page.
[netbsd-mini2440.git] / dist / ipf / man / ipnat.8
blob57492e62cca806ac9252cd98a6f72a3e5a2c69dc
1 .\"     $NetBSD: ipnat.8,v 1.9 2006/04/04 16:17:18 martti Exp $
2 .\"
3 .TH IPNAT 8
4 .SH NAME
5 ipnat \- user interface to the NAT subsystem
6 .SH SYNOPSIS
7 .B ipnat
9 .B \-dhlnrsvCF
12 .B \-M core
15 .B \-N system
17 .B \-f <\fIfilename\fP>
18 .SH DESCRIPTION
19 .PP
20 \fBipnat\fP opens the filename given (treating "\-" as stdin) and parses the
21 file for a set of rules which are to be added or removed from the IP NAT.
22 .PP
23 Each rule processed by \fBipnat\fP
24 is added to the kernels internal lists if there are no parsing problems.
25 Rules are added to the end of the internal lists, matching the order in
26 which they appear when given to \fBipnat\fP.
27 .PP
28 Note that
29 \fBipf(8)\fP
30 must be enabled (with \fBipf -E\fP) before NAT is configured,
31 as the same kernel facilities are used for
32 NAT functionality.  In addition, packet forwarding must be
33 enabled.
34 These details may be handled automatically when \fBipnat\fP is
35 run by \fBrc\fP at normal system startup.
36 See
37 \fBoptions(4)\fP,
38 \fBsysctl(8)\fP,
39 and
40 \fBrc.conf(5)\fP
41 for more information.
42 .SH OPTIONS
43 .TP
44 .B \-C
45 delete all entries in the current NAT rule listing (NAT rules)
46 .TP
47 .B \-d
48 Enable printing of some extra debugging information.
49 .TP
50 .B \-F
51 delete all active entries in the current NAT translation table (currently
52 active NAT mappings)
53 .TP
54 .B \-h
55 Print number of hits for each MAP/Redirect filter.
56 .TP
57 .B \-l
58 Show the list of current NAT table entry mappings.
59 .TP
60 .B \-n
61 This flag (no-change) prevents \fBipf\fP from actually making any ioctl
62 calls or doing anything which would alter the currently running kernel.
63 .TP
64 .B \-r
65 Remove matching NAT rules rather than add them to the internal lists.
66 .TP
67 .B \-s
68 Retrieve and display NAT statistics.
69 .TP
70 .B \-v
71 Turn verbose mode on.  Displays information relating to rule processing
72 and active rules/table entries.
73 .DT
74 .SH FILES
75 /dev/ipnat
76 .br
77 /usr/share/examples/ipf  Directory with examples.
78 .SH DIAGNOSTICS
79 \fBioctl(SIOCGNATS): Input/output error\fP Ensure that the necessary kernel
80 functionality is present and \fBipf\fP enabled with \fBipf -E\fP.
81 .SH SEE ALSO
82 ipnat(5), rc.conf(5), ipf(8), ipfstat(8)