usr.sbin/rtadvd/rtadvd.8

   1 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: rtadvd.8,v 1.1.1.1 1999/08/08 23:31:42 itojun Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd May 17, 1998
  32 .Dt RTADVD 8
  33 .Os KAME
  34 .Sh NAME
  35 .Nm rtadvd
  36 .Nd router advertisement daemon
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl c Ar configfile
  40 .Op Fl P Ar policy
  41 .Op Fl dDfs
  42 .Ar interface ...
  43 .Sh DESCRIPTION
  44 .Nm Rtadvd
  45 advertises router advertisement packet to the specified
  46 .Ar interfaces .
  47 .Pp
  48 The program will daemonize itself on invocation.
  49 Then, it will voluntarily send router advertisement packet periodically.
  50 If a router solicitation packet from host has reached the program,
  51 the program will respond by router advertisement packet.
  52 .Pp
  53 For each interface, which is called advertising interface,
  54 content of router advertisement can be described in
  55 .Xr rtadvd.conf 5 .
  56 .Pp
  57 If there is no description for the interface in the configuration file
  58 or if the configuration file does not exist,
  59 .Nm
  60 sets all the parameters to their default values.
  61 In particular,
  62 .Nm
  63 gets all the interface routes from the routing table and advertises
  64 them as on-link prefixes.
  65 .Pp
  66 .Nm Rtadvd
  67 watches the routing table.
  68 By default, if an interface direct route is
  69 added/deleted on an advertising interface,
  70 .Nm
  71 adds/deletes the corresponding prefix to/from its advertising list,
  72 respectively.
  73 If you do not want to enable this feature, you should specify the
  74 .Ic Fl s
  75 command line option when advocation.
  76 .Pp
  77 .Nm Rtadvd
  78 can also receive router renumbering packets, and can do router
  79 renumbering for the system it runs on, as the contents of those
  80 packets.
  81 .Bl -tag -width indent
  82 .\"
  83 .It Fl c
  84 Specify an alternate location,
  85 .Ar configfile ,
  86 for the configuration file.
  87 By default,
  88 .Pa /etc/rtadvd.conf
  89 is used.
  90 .It Fl P
  91 Specifies that
  92 .Nm
  93 receives router renumbering messages.
  94 Also, specifies IPsec policy for
  95 rrenumd sessions.
  96 Because router renumbering can change the system's
  97 IPv6 prefix, its messages must be protected by IPsec.
  98 For details about
  99 .Ar policy ,
 100 please refer to
 101 .Xr ipsec 4
 102 and
 103 .Xr ipsec_set_policy 3 .
 104 .It Fl d
 105 Debug.
 106 .It Fl D
 107 More debug.
 108 .It Fl f
 109 Foreground mode.
 110 Do not become daemon.
 111 .It Fl s
 112 Static prefix.
 113 Do not watch the routing table.
 114 .El
 115 .Sh RETURN VALUES
 116 The program exits with 0 on success, and non-zero on failures.
 117 .Sh FILES
 118 .Bl -tag -width /etc/rtadvd.conf -compact
 119 .It Pa /etc/rtadvd.conf
 120 The default configuration file.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr daemon 3 ,
 124 .Xr rtadvd.conf 5 ,
 125 .Xr rtsol 8
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
 130 .Sh CAVEAT
 131 Do not perform router advertisement toward upstream direction,
 132 you should only advertise to downstream direction.
 133 If you advertise toward upstream by mistake,
 134 you will see icmp6 redirect storm on that subnet.
 135 This is because of the specification,
 136 which says that advertising router is assumed to become
 137 the default outgoing router for end hosts in the subnet.