usr.sbin/rtsold/rtsold.8

   1 .\"     $KAME: rtsold.8,v 1.20 2003/04/11 12:46:12 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 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 dDfFm1
  43 .Op Fl O Ar script-name
  44 .Ar interface ...
  45 .Nm
  46 .Op Fl dDfFm1
  47 .Op Fl O Ar script-name
  48 .Fl a
  49 .Nm rtsol
  50 .Op Fl dDF
  51 .Op Fl O Ar script-name
  52 .Ar interface ...
  53 .Nm rtsol
  54 .Op Fl dD
  55 .Op Fl O Ar script-name
  56 .Fl a
  57 .\"
  58 .Sh DESCRIPTION
  59 .Nm
  60 is the daemon program to send ICMPv6 Router Solicitation messages
  61 on the specified interfaces.
  62 If a node (re)attaches to a link,
  63 .Nm
  64 sends some Router Solicitations on the link destined to the link-local scope
  65 all-routers multicast address to discover new routers
  66 and to get non link-local addresses.
  67 .Pp
  68 .Nm
  69 should be used on IPv6 hosts
  70 .Pq non-router nodes
  71 only.
  72 .Pp
  73 If you invoke the program as
  74 .Nm rtsol ,
  75 it will transmit probes from the specified
  76 .Ar interface ,
  77 without becoming a daemon.
  78 In other words,
  79 .Nm rtsol
  80 behaves as
  81 .Do
  82 .Nm
  83 .Fl f1
  84 .Ar interfaces
  85 .Dc .
  86 .Pp
  87 Specifically,
  88 .Nm
  89 sends at most 3 Router Solicitations on an interface
  90 after one of the following events:
  91 .Pp
  92 .Bl -bullet -compact
  93 .It
  94 Just after invocation of
  95 .Nm
  96 daemon.
  97 .It
  98 The interface is up after a temporary interface failure.
  99 .Nm
 100 detects such failures by periodically probing to see if the status
 101 of the interface is active or not.
 102 Note that some network cards and drivers do not allow the extraction
 103 of link state.
 104 In such cases,
 105 .Nm
 106 cannot detect the change of the interface status.
 107 .It
 108 Every 60 seconds if the
 109 .Fl m
 110 option is specified and the
 111 .Nm
 112 daemon cannot get the interface status.
 113 This feature does not conform to the IPv6 neighbor discovery
 114 specification, but is provided for mobile stations.
 115 The default interval for router advertisements, which is on the order of 10
 116 minutes, is slightly long for mobile stations.
 117 This feature is provided
 118 for such stations so that they can find new routers as soon as possible
 119 when they attach to another link.
 120 .El
 121 .Lp
 122 Once
 123 .Nm
 124 has sent a Router Solicitation, and has received a valid Router Advertisement,
 125 it refrains from sending additional solicitations on that interface, until
 126 the next time one of the above events occurs.
 127 .Lp
 128 When sending a Router Solicitation on an interface,
 129 .Nm
 130 includes a Source Link-layer address option if the interface
 131 has a link-layer address.
 132 .Lp
 133 .Nm
 134 manages a per-interface parameter to detect if a separate protocol is
 135 needed for configuration parameters other than host's addresses.
 136 At the invocation time, the flag is FALSE, and becomes TRUE when
 137 the daemon receives a router advertisement with the OtherConfig flag
 138 being set.
 139 A script file can be specified to deal with the case
 140 .Pq see below .
 141 When
 142 .Nm
 143 start resending router solicitation messages by one of the conditions
 144 events,
 145 the daemon resets the parameter because the event may indicate a
 146 change on the attached link.
 147 .Pp
 148 Upon receipt of signal
 149 .Dv SIGUSR1 ,
 150 .Nm
 151 will dump the current internal state into
 152 .Pa /var/run/rtsold.dump .
 153 .\"
 154 .Pp
 155 The options are as follows:
 156 .Bl -tag -width indent
 157 .It Fl a
 158 Autoprobe outgoing interface.
 159 .Nm
 160 will try to find a non-loopback, non-point-to-point, IPv6-capable interface.
 161 If
 162 .Nm
 163 finds multiple interfaces,
 164 .Nm
 165 will exit with error.
 166 .\"
 167 .It Fl d
 168 Enable debugging.
 169 .It Fl D
 170 Enable more debugging including the printing of internal timer information.
 171 .It Fl f
 172 .Fl f
 173 prevents
 174 .Nm
 175 from becoming a daemon (foreground mode).
 176 Warning messages are generated to standard error
 177 instead of
 178 .Xr syslog 3 .
 179 .It Fl F
 180 Configure
 181 .Xr sysctl 8
 182 variable related to
 183 .Nm
 184 by itself.
 185 Without
 186 .Fl F ,
 187 .Nm
 188 will not alter and obey the current
 189 .Xr sysctl 8
 190 settings.
 191 .It Fl m
 192 Enable mobility support.
 193 If this option is specified,
 194 .Nm
 195 sends probing packets to default routers that have advertised Router
 196 Advertisements
 197 when the node (re)attaches to an interface.
 198 Moreover, if the option is specified,
 199 .Nm
 200 periodically sends Router Solicitation on an interface that does not support
 201 .Dv SIOCGIFMEDIA
 202 ioctl.
 203 .It Fl 1
 204 Perform only one probe.
 205 Transmit Router Solicitation packets until at least one valid Router
 206 Advertisement packet has arrived on each
 207 .Ar interface ,
 208 then exit.
 209 .It Fl O Ar script-name
 210 Specifies a supplement script file to handle the Other Configuration
 211 flag of the router advertisement.
 212 When the flag changes from FALSE to TRUE,
 213 .Nm
 214 will invoke
 215 .Ar script-name
 216 with a single argument of the receiving interface name,
 217 expecting the script will then start a protocol for the other
 218 configuration.
 219 .Ar script-name
 220 must be the absolute path from root to the script file, be a regular
 221 file, and be created by the same owner who runs
 222 .Nm .
 223 .El
 224 .Sh RETURN VALUES
 225 The
 226 .Nm
 227 program exits 0 on success, and >0 on failures.
 228 .\"
 229 .Sh FILES
 230 .Bl -tag -width /var/run/rtsold.dump -compact
 231 .It Pa /var/run/rtsold.pid
 232 the pid of the currently running
 233 .Nm .
 234 .It Pa /var/run/rtsold.dump
 235 dumps internal state on.
 236 .El
 237 .\"
 238 .Sh SEE ALSO
 239 .Xr rtadvd 8 ,
 240 .Xr sysctl 8
 241 .\"
 242 .Sh HISTORY
 243 The
 244 .Nm
 245 command is based on the
 246 .Nm rtsol
 247 command, which first appeared in WIDE/KAME IPv6 protocol stack kit.
 248 .Nm rtsol
 249 is now integrated into
 250 .Xr rtsold 8 .
 251 .\"
 252 .Sh BUGS
 253 In some operating systems, when a PCMCIA network card is removed
 254 and reinserted, the corresponding interface index is changed.
 255 However,
 256 .Nm
 257 assumes such changes will not occur, and always uses the index that
 258 it got at invocation.
 259 As a result,
 260 .Nm
 261 may not work if you reinsert a network card.
 262 In such a case,
 263 .Nm
 264 should be killed and restarted.
 265 .Pp
 266 The IPv6 autoconfiguration specification assumes a single-interface host.
 267 You may see kernel error messages if you try to autoconfigure a host with
 268 multiple interfaces.
 269 Also, it seems contradictory for
 270 .Nm
 271 to accept multiple
 272 .Ar interface
 273 arguments.