xref: /freebsd/usr.sbin/rtadvd/rtadvd.8 (revision 77a0943ded95b9e6438f7db70c4a28e4d93946d4)
1.\"	$KAME: rtadvd.8,v 1.9 2000/05/27 13:37:01 jinmei Exp $
2.\"
3.\" Copyright (C) 1995, 1996, 1997, and 1998 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 May 17, 1998
33.Dt RTADVD 8
34.Os
35.Sh NAME
36.Nm rtadvd
37.Nd router advertisement daemon
38.Sh SYNOPSIS
39.Nm
40.Op Fl c Ar configfile
41.Op Fl dDfRs
42.Ar interface ...
43.Sh DESCRIPTION
44.Nm
45sends router advertisement packets to the specified
46.Ar interfaces .
47.Pp
48The program will daemonize itself on invocation.
49It will then send router advertisement packets periodically, as well
50as in response to router solicitation messages sent by end hosts.
51.Pp
52Router advertisements can be configured on a per-interface basis, as
53described in
54.Xr rtadvd.conf 5 .
55.Pp
56If there is no configuration file entry for an interface,
57or if the configuration file does not exist altogether,
58.Nm
59sets all the parameters to their default values.
60In particular,
61.Nm
62reads all the interface routes from the routing table and advertises
63them as on-link prefixes.
64.Pp
65.Nm
66also watches the routing table.
67By default, if an interface direct route is
68added/deleted on an advertising interface and no static prefixes are
69specified by the configuration file,
70.Nm
71adds/deletes the corresponding prefix to/from its advertising list,
72respectively.
73The
74.Fl s
75option may be used to disable this behavior.
76Moreover, if the status of an advertising interface changes,
77.Nm
78will start or stop sending router advertisements according
79to the latest status.
80.Pp
81The command line options are:
82.Bl -tag -width indent
83.\"
84.It Fl c
85Specify an alternate location,
86.Ar configfile ,
87for the configuration file.
88By default,
89.Pa /etc/rtadvd.conf
90is used.
91.It Fl d
92Print debugging information.
93.It Fl D
94Even more debugging information is printed.
95.It Fl f
96Foreground mode (useful when debugging).
97.\".It Fl m
98.\"Enables mobile IPv6 support.
99.\"This changes the content of router advertisement option, as well as
100.\"permitted configuration directives.
101.It Fl R
102Accept router renumbering requests.
103If you enable it, certain IPsec setup is suggested for security reasons.
104.It Fl s
105Do not add or delete prefixes dynamically.
106Only statically configured prefixes, if any, will be advertised.
107.El
108.Pp
109Upon receipt of signal
110.Dv SIGUSR1 ,
111.Nm
112will dump the current internal state into
113.Pa /var/run/rtadvd.dump .
114.Pp
115Use
116.Dv SIGTERM
117to kill
118.Nm
119gracefully.
120In this case,
121.Nm
122will transmit router advertisement with router lifetime 0
123to all the interfaces
124.Pq in accordance with RFC2461 6.2.5 .
125.Sh RETURN VALUES
126The
127.Nm
128program exits 0 on success, and >0 on failures.
129.Sh FILES
130.Bl -tag -width Pa -compact
131.It Pa /etc/rtadvd.conf
132The default configuration file.
133.It Pa /var/run/rtadvd.pid
134contains the pid of the currently running
135.Nm .
136.It Pa /var/run/rtadvd.dump
137in which
138.Nm
139dumps its internal state.
140.El
141.Sh SEE ALSO
142.Xr daemon 3 ,
143.Xr rtadvd.conf 5 ,
144.Xr rtsol 8
145.Sh HISTORY
146The
147.Nm
148command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
149.Sh CAVEAT
150Router advertisements should only be performed downstream.
151Erroneous upstream advertisements will cause
152.Xr icmp6 4
153redirect packet storms in the subnet, as (per the specification) the
154advertising router is assumed to become the default router for
155end hosts in the subnet.
156