xref: /freebsd/usr.sbin/ip6addrctl/ip6addrctl.8 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\"	$KAME: ip6addrctl.8,v 1.3 2003/03/22 05:56:41 jinmei Exp $
2.\"
3.\" Copyright (C) 2001 WIDE Project.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the project nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.\"
32.Dd September 25, 2001
33.Dt IP6ADDRCTL 8
34.Os
35.\"
36.Sh NAME
37.Nm ip6addrctl
38.Nd configure address selection policy for IPv6 and IPv4
39.\"
40.Sh SYNOPSIS
41.Nm
42.Op Cm show
43.Nm
44.Cm add
45.Ar prefix precedence label
46.Nm
47.Cm delete
48.Ar prefix
49.Nm
50.Cm flush
51.Nm
52.Cm install
53.Ar configfile
54.\"
55.Sh DESCRIPTION
56The
57.Nm
58utility manages the policy table of source and destination address
59selection for outgoing IPv4 and IPv6 packets.
60When
61.Nm
62is invoked without an argument or with a single argument
63.Cm show ,
64it prints the content of the policy table currently installed in the
65kernel.
66.Pp
67To modify the table, the following operations are available:
68.Bl -tag -width indent
69.It Cm add Ar prefix precedence label
70Add a policy entry.
71The
72.Ar prefix
73argument
74is an IPv6 prefix, which is a key for the entry.
75An IPv4 prefix should be specified with an IPv6 prefix using an
76IPv4-mapped IPv6 address.
77The
78.Ar precedence
79and
80.Ar label
81arguments
82are decimal numbers, which specify the precedence and label values
83for the entry, respectively.
84This operation should be performed without an existing entry for the
85prefix.
86.It Cm delete Ar prefix
87Delete a policy entry specified by
88.Ar prefix ,
89which should be an IPv6 prefix.
90A corresponding entry for the prefix should have already been
91installed.
92.It Cm flush
93Delete all existing policy entries in the kernel.
94.It Cm install Ar configfile
95Install policy entries from a configuration file named
96.Ar configfile .
97The configuration file should contain a set of policy entries.
98Each entry is specified in a single line which contains an IPv6 prefix,
99a decimal precedence value, and a decimal label value, separated with
100white space or tab characters.
101In the configuration file, lines beginning with the pound-sign
102.Pq Ql #
103are
104comments and are ignored.
105.El
106.\"
107.Sh EXIT STATUS
108.Ex -std
109.\"
110.Sh SEE ALSO
111.Rs
112.%A "Richard Draves"
113.%T "Default Address Selection for IPv6"
114.%N RFC 3484
115.Re
116.\"
117.Sh HISTORY
118The
119.Nm
120utility first appeared in the KAME IPv6 protocol stack kit.
121The original command name was
122.Nm addrselect ,
123but it was then renamed to the current one so that the name would
124describe its function well.
125.\" .Sh BUGS
126.\" (to be written)
127