summaryrefslogtreecommitdiffstats
path: root/usr.sbin/rtadvd/rtadvd.8
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/rtadvd/rtadvd.8')
-rw-r--r--usr.sbin/rtadvd/rtadvd.8116
1 files changed, 66 insertions, 50 deletions
diff --git a/usr.sbin/rtadvd/rtadvd.8 b/usr.sbin/rtadvd/rtadvd.8
index 2c56bae..5f1f91b 100644
--- a/usr.sbin/rtadvd/rtadvd.8
+++ b/usr.sbin/rtadvd/rtadvd.8
@@ -1,3 +1,5 @@
+.\" $KAME: rtadvd.8,v 1.8 2000/05/22 22:12:11 itojun Exp $
+.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
.\"
@@ -25,59 +27,58 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: rtadvd.8,v 1.1.1.1 1999/08/08 23:31:42 itojun Exp $
-.\" $FreeBSD$
+.\" $FreeBSD$
.\"
.Dd May 17, 1998
.Dt RTADVD 8
-.Os KAME
+.Os
.Sh NAME
.Nm rtadvd
.Nd router advertisement daemon
.Sh SYNOPSIS
.Nm
.Op Fl c Ar configfile
-.Op Fl P Ar policy
-.Op Fl dDfs
+.Op Fl dDfmRs
.Ar interface ...
.Sh DESCRIPTION
-.Nm Rtadvd
+.Nm
advertises router advertisement packet to the specified
.Ar interfaces .
.Pp
The program will daemonize itself on invocation.
-Then, it will voluntarily send router advertisement packet periodically.
-If a router solicitation packet from host has reached the program,
-the program will respond by router advertisement packet.
+It will then periodically send router advertisement packets, as well
+as in response to router solicitation messages sent by end hosts.
.Pp
-For each interface, which is called advertising interface,
-content of router advertisement can be described in
+Router advertisements can be configured on a per-interface basis, as
+described in
.Xr rtadvd.conf 5 .
.Pp
-If there is no description for the interface in the configuration file
-or if the configuration file does not exist,
+In the event of no configuration file entry for an interface,
+or if the configuration file does not exist altogether,
.Nm
sets all the parameters to their default values.
In particular,
.Nm
-gets all the interface routes from the routing table and advertises
+reads all the interface routes from the routing table and advertises
them as on-link prefixes.
.Pp
-.Nm Rtadvd
-watches the routing table.
+.Nm
+also watches the routing table.
By default, if an interface direct route is
-added/deleted on an advertising interface,
+added/deleted on an advertising interface and no static prefixes are
+specified by the configuration file,
.Nm
adds/deletes the corresponding prefix to/from its advertising list,
respectively.
-If you do not want to enable this feature, you should specify the
+The
.Ic Fl s
-command line option when advocation.
+may be used to disable this behavior.
+Moreover, if the status of an advertising interface changes,
+.Nm
+will start or stop sending router advertisements according
+to the latest status.
.Pp
-.Nm Rtadvd
-can also receive router renumbering packets, and can do router
-renumbering for the system it runs on, as the contents of those
-packets.
+The command line options are:
.Bl -tag -width indent
.\"
.It Fl c
@@ -87,37 +88,53 @@ for the configuration file.
By default,
.Pa /etc/rtadvd.conf
is used.
-.It Fl P
-Specifies that
-.Nm
-receives router renumbering messages.
-Also, specifies IPsec policy for
-rrenumd sessions.
-Because router renumbering can change the system's
-IPv6 prefix, its messages must be protected by IPsec.
-For details about
-.Ar policy ,
-please refer to
-.Xr ipsec 4
-and
-.Xr ipsec_set_policy 3 .
.It Fl d
-Debug.
+Print debugging information.
.It Fl D
-More debug.
+Even more debugging information is printed.
.It Fl f
-Foreground mode.
-Do not become daemon.
+Foreground mode (useful when debugging).
+.It Fl m
+Enables mobile IPv6 support.
+This changes the content of router advertisement option, as well as
+permitted configuration directives.
+.It Fl R
+Accept router renumbering requests.
+If you enable it, certain IPsec setup is suggested for security reasons.
.It Fl s
-Static prefix.
-Do not watch the routing table.
+Do not add or delete prefixes dynamically.
+Only statically configured prefixes, if any, will be advertised.
.El
+.Pp
+Upon receipt of signal
+.Dv SIGUSR1 ,
+.Nm
+will dump the current internal state into
+.Pa /var/run/rtadvd.dump.
+.Pp
+Use
+.Dv SIGTERM
+to kill
+.Nm
+gracefully.
+In this case,
+.Nm
+will transmit router advertisement with router lifetime 0
+to all the interfaces
+.Pq according to RFC2461 6.2.5 .
.Sh RETURN VALUES
The program exits with 0 on success, and non-zero on failures.
.Sh FILES
.Bl -tag -width /etc/rtadvd.conf -compact
.It Pa /etc/rtadvd.conf
The default configuration file.
+.It Pa /var/run/rtadvd.pid
+contains pid of the currently running
+.Nm rtadvd .
+.It Pa /var/run/rtadvd.dump
+on which
+.Nm
+dumps its internal state.
.El
.Sh SEE ALSO
.Xr daemon 3 ,
@@ -128,10 +145,9 @@ The
.Nm
command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
.Sh CAVEAT
-Do not perform router advertisement toward upstream direction,
-you should only advertise to downstream direction.
-If you advertise toward upstream by mistake,
-you will see icmp6 redirect storm on that subnet.
-This is because of the specification,
-which says that advertising router is assumed to become
-the default outgoing router for end hosts in the subnet.
+Router advertisements should only be performed downstream.
+Erroneous upstream advertisements will cause
+.Xr icmp6 4
+redirect packet storms in the subnet, as (per the specification) the
+advertising router is assumed to become the default router for
+end hosts in the subnet.
OpenPOWER on IntegriCloud