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