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