/
natptconfig.8
226 lines (226 loc) · 6.02 KB
/
natptconfig.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
.\" $KAME: natptconfig.8,v 1.11 2001/09/30 21:04:49 fujisawa Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000 and 2001 WIDE Project.
.\" All rights reserved.
.\"
.\" 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.
.\" 3. Neither the name of the project nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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.
.\"
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
.Dd December 25, 1999
.Dt NATPTCONFIG 8
.\" Note: Only specify the operating system when the command
.\" is FreeBSD specific, otherwise use the .Os macro with no
.\" arguments.
.Os KAME
.\"
.Sh NAME
.Nm natptconfig
.Nd configure IPv6-to-IPv4 translator
.\"
.Sh SYNOPSIS
.Nm
.Op Fl d Ar debuglevel
.Fl f Ar configfile
.Nm
.Op Fl d Ar debuglevel
subcommand
.Op Ar args ...
.\"
.Sh DESCRIPTION
.Nm
configures and control the IPv6-to-IPv4 translator implemented in the
kernel.
.Pp
.Nm
takes the following command line options.
.Bl -tag witdh Ds
.It Fl d Ar debuglevel
Set debug level to
.Ar debuglevel .
This option is for debug.
.It Fl f Ar configfile
Evaluate the contents of file specified as configfile. By specifying
.Ql -
as a file name, standard input is used.
.El
.Pp
The first form
.Pq with Fl f
takes directives from the specified configuration file. The second
form is to give single directive directly from the command line.
.\"
.Sh DIRECTIVES
Keywords and special characters that the parser expects exactly are
displayed using
.Sy this
font. Parameters are specified with
.Em this
font. Square brackets (
.Ql \&[
and
.Ql \&]
) are used to show optional keywords and parameters. Parentheses(
.Ql \&(
and
.Ql \&)
) are used to group keywords and parameters when necessary. The
vertical bar
.Pq Ql \&|
is used to indicate a choice between optional
parameters.
.Pp
The following directives are available in interactive use.
.Bl -tag -width Ds -offset indent
.\"
.It Xo Sy \&?
.Xc
Show available actions on each stage.
.Pp
Value can use decimal or hexadecimal (begin with 0x) notation.
.\"
.It Xo Sy show Ar subcommand
.Op Ar args ...
.Xc
Show various useful information.
.Nm
read this information from kernel, so you must have read permission of
/dev/kmem. Available subcommands are listed below.
.Bl -tag -width XXX
.It Xo Sy \&?
.Xc
Show available subcommands on this stage.
.It Xo Sy prefix
.Xc
Show NAT-PT prefix and prefix mask.
.It Xo Sy rules
.Xc
Show NAT-PT rules
.It Xo Sy xlate
.Op Sy long
.Op Ar interval
.Xc
Show NAT-PT current translation table entry. An entry of this table
is empty at first. Kernel forms an entry that packet flows, 1 entry
per 1 TCP session, 1 entry per 1 UDP/ICMP packet.
.Bl -bullet -offset indent
.It
.Qq long
shows with long format.
.It
.Ql interval
is a number, and this option specified,
.Nm
will continuously display the information which is shown with xlate
subcommand in specified second interval.
.El
.Pp
By default, this command display IPv6 as short format (22 columns per
address), when
.Qq long
specified, this command display IPv6 address
without omitting it.
.Pp
It is useful to see this
table entry when this translator seems not to work. See
.Em TABLE FORMAT
section below for more detail.
.It Xo Sy variables
.Xc
Show variables set with set subcommand.
.It Xo Sy mapping
.Xc
Show current mapping status. Status is displayed as "enable" or
"disable".
.El
.It Xo Sy test Ar subcommand
.Op Ar args ...
.Xc
Test the log system. You must run natptlog command. When only log
specified, send LOGTESTPATTERN to translator, and translator send this
pattern to log system. When you running natptlog command, this
command display LOGTESTPATTERN. Current available subcommands are
shown.
.Bl -tag -width XXX
.It Xo Sy \&?
.Xc
Show available subcommands on this stage.
.It Xo Sy log
.Xc
Send predefined pattern LOGTESTPATTERN to the log system.
.It Xo Sy log Li name
.Xc
Send one word to the log system.
.It Xo Sy log Qq string
.Xc
Send double quoted string to the log system.
.El
.Pp
This is for log sysgem debug.
.El
.\"
.Sh FILES
.Bl -tag -width /dev/kmemxxx -compact
.It Pa /kernel
default kernel namelist
.It Pa /dev/kmem
default memory file
.El
.\"
.Sh TABLE FORMAT
This section describes a table format indicated with
.Dl # natptconfig show xlate
command.
.Pp
.Pq to be written
.\"
.Sh SEE ALSO
.Xr natpt.conf 5 ,
.Xr natptlog 8
.Rs
.%A Eric Nordmark
.%R RFC
.%N 2765
.%D February 2000
.%T Stateless IP/ICMP Translation Algorithm (SIIT)
.Re
.Rs
.%A George Tsirtsis
.%R RFC
.%N 2766
.%D February 2000
.%T Network Address Translation - Protocol Translation (NAT-PT)
.Re
.\"
.Sh HISTORY
The
.Nm
command first appeared in WIDE/KAME IPv6 protocol stack kit.
.\"
.Sh BUGS
The
.Nm
command is now under development. It's user interface and overall
functionality are subjects to future improvements and changes.