usr.sbin/rtsold/rtsold.8

   1 .\"     $KAME: rtsold.8,v 1.16 2000/10/15 13:19:05 itojun 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 RTSOLD 8
  34 .Os
  35 .\"
  36 .Sh NAME
  37 .Nm rtsold , rtsol
  38 .Nd router solicitation daemon
  39 .\"
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl dDfm1
  43 .Ar interface ...
  44 .Nm
  45 .Op Fl dDfm1
  46 .Fl a
  47 .Nm rtsol
  48 .Op Fl dD
  49 .Ar interface ...
  50 .Nm rtsol
  51 .Op Fl dD
  52 .Fl a
  53 .\"
  54 .Sh DESCRIPTION
  55 .Nm
  56 is the daemon program to send ICMPv6 Router Solicitation messages
  57 on the specified interfaces.
  58 If a node (re)attaches to a link,
  59 .Nm
  60 sends some Router Solicitations on the link destined to the link-local scope
  61 all-routers multicast address to discover new routers
  62 and to get non link-local addresses.
  63 .Pp
  64 .Nm
  65 should be used on IPv6 hosts
  66 (non-router nodes)
  67 only.
  68 .Pp
  69 If you invoke the program as
  70 .Nm rtsol ,
  71 it will transmit probes from the specified
  72 .Ar interface ,
  73 without becoming a daemon.
  74 In other words,
  75 .Nm rtsol
  76 behaves as
  77 .Do
  78 .Nm
  79 .Fl f1
  80 .Ar interfaces
  81 .Dc .
  82 .Pp
  83 Specifically,
  84 .Nm
  85 sends at most 3 Router Solicitations on an interface
  86 after one of the following events:
  87 .Pp
  88 .Bl -bullet -compact
  89 .It
  90 Just after invocation of
  91 .Nm
  92 daemon.
  93 .It
  94 The interface is up after a temporary interface failure.
  95 .Nm
  96 detects such failures by periodically probing to see if the status
  97 of the interface is active or not.
  98 Note that some network cards and drivers do not allow the extraction
  99 of link state.
 100 In such cases,
 101 .Nm
 102 cannot detect the change of the interface status.
 103 .It
 104 Every 60 seconds if the
 105 .Fl m
 106 option is specified and the
 107 .Nm
 108 daemon cannot get the interface status.
 109 This feature does not conform to the IPv6 neighbor discovery
 110 specification, but is provided for mobile stations.
 111 The default interval for router advertisements, which is on the order of 10
 112 minutes, is slightly long for mobile stations.
 113 This feature is provided
 114 for such stations so that they can find new routers as soon as possible
 115 when they attach to another link.
 116 .El
 117 .Lp
 118 Once
 119 .Nm
 120 has sent a Router Solicitation, and has received a valid Router Advertisement,
 121 it refrains from sending additional solicitations on that interface, until
 122 the next time one of the above events occurs.
 123 .Lp
 124 When sending a Router Solicitation on an interface,
 125 .Nm
 126 includes a Source Link-layer address option if the interface
 127 has a link-layer address.
 128 .Pp
 129 Upon receipt of signal
 130 .Dv SIGUSR1 ,
 131 .Nm
 132 will dump the current internal state into
 133 .Pa /var/run/rtsold.dump .
 134 .\"
 135 .Sh OPTIONS
 136 .Bl -tag -width indent
 137 .It Fl a
 138 Autoprobe outgoing interface.
 139 .Nm
 140 will try to find a non-loopback, non-point-to-point, IPv6-capable interface.
 141 If
 142 .Nm
 143 finds multiple interfaces,
 144 .Nm
 145 will exit with error.
 146 .\"
 147 .It Fl d
 148 Enable debugging.
 149 .It Fl D
 150 Enable more debugging including the printing of internal timer information.
 151 .It Fl f
 152 .Fl f
 153 prevents
 154 .Nm
 155 from becoming a daemon (foreground mode).
 156 Warning messages are generated to standard error
 157 instead of
 158 .Xr syslog 3 .
 159 .It Fl m
 160 Enable mobility support.
 161 If this option is specified,
 162 .Nm
 163 sends probing packets to default routers that have advertised Router
 164 Advertisements
 165 when the node (re)attaches to an interface.
 166 Moreover, if the option is specified,
 167 .Nm
 168 periodically sends Router Solicitation on an interface that does not support
 169 .Dv SIOCGIFMEDIA
 170 ioctl.
 171 .It Fl 1
 172 Perform only one probe.
 173 Transmit Router Solicitation packets until at least one valid Router
 174 Advertisement packet has arrived on each
 175 .Ar interface ,
 176 then exit.
 177 .El
 178 .Sh DIAGNOSTICS
 179 .Ex -std rtsold rtsol
 180 .\"
 181 .Sh FILES
 182 .Bl -tag -width /var/run/rtsold.dump -compact
 183 .It Pa /var/run/rtsold.pid
 184 the pid of the currently running
 185 .Nm .
 186 .It Pa /var/run/rtsold.dump
 187 dumps internal state on.
 188 .El
 189 .\"
 190 .Sh SEE ALSO
 191 .Xr rtadvd 8 ,
 192 .Xr sysctl 8
 193 .\"
 194 .Sh HISTORY
 195 The
 196 .Nm
 197 command is based on the
 198 .Nm rtsol
 199 command, which first appeared in WIDE/KAME IPv6 protocol stack kit.
 200 .Nm rtsol
 201 is now integrated into
 202 .Xr rtsold 8 .
 203 .\"
 204 .Sh BUGS
 205 In some operating systems, when a PCMCIA network card is removed
 206 and reinserted, the corresponding interface index is changed.
 207 However,
 208 .Nm
 209 assumes such changes will not occur, and always uses the index that
 210 it got at invocation. As a result,
 211 .Nm
 212 may not work if you reinsert a network card.
 213 In such a case,
 214 .Nm
 215 should be killed and restarted.
 216 .Pp
 217 The IPv6 autoconfiguration specification assumes a single-interface host.
 218 You may see kernel error messages if you try to autoconfigure a host with
 219 multiple interfaces.
 220 Also, it seems contradictory for
 221 .Nm
 222 to accept multiple
 223 .Ar interface
 224 arguments.