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 .\"     $DragonFly: src/usr.sbin/rtsold/rtsold.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
  32 .\"
  33 .Dd May 17, 1998
  34 .Dt RTSOLD 8
  35 .Os
  36 .\"
  37 .Sh NAME
  38 .Nm rtsold , rtsol
  39 .Nd router solicitation daemon
  40 .\"
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl dDfm1
  44 .Ar interface ...
  45 .Nm
  46 .Op Fl dDfm1
  47 .Fl a
  48 .Nm rtsol
  49 .Op Fl dD
  50 .Ar interface ...
  51 .Nm rtsol
  52 .Op Fl dD
  53 .Fl a
  54 .\"
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility is the daemon program to send ICMPv6 Router Solicitation messages
  59 on the specified interfaces.
  60 If a node (re)attaches to a link,
  61 .Nm
  62 sends some Router Solicitations on the link destined to the link-local scope
  63 all-routers multicast address to discover new routers
  64 and to get non link-local addresses.
  65 .Pp
  66 The
  67 .Nm
  68 utility should be used on IPv6 hosts
  69 (non-router nodes)
  70 only.
  71 .Pp
  72 If you invoke the program as
  73 .Nm rtsol ,
  74 it will transmit probes from the specified
  75 .Ar interface ,
  76 without becoming a daemon.
  77 In other words,
  78 .Nm rtsol
  79 behaves as
  80 .Do
  81 .Nm
  82 .Fl f1
  83 .Ar interfaces
  84 .Dc .
  85 .Pp
  86 Specifically,
  87 .Nm
  88 sends at most 3 Router Solicitations on an interface
  89 after one of the following events:
  90 .Pp
  91 .Bl -bullet -compact
  92 .It
  93 Just after invocation of
  94 .Nm
  95 daemon.
  96 .It
  97 The interface is up after a temporary interface failure.
  98 The
  99 .Nm
 100 utility 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 .Pp
 133 Upon receipt of signal
 134 .Dv SIGUSR1 ,
 135 .Nm
 136 will dump the current internal state into
 137 .Pa /var/run/rtsold.dump .
 138 .\"
 139 .Sh OPTIONS
 140 .Bl -tag -width indent
 141 .It Fl a
 142 Autoprobe outgoing interface.
 143 The
 144 .Nm
 145 utility
 146 will try to find a non-loopback, non-point-to-point, IPv6-capable interface.
 147 If
 148 .Nm
 149 finds multiple interfaces,
 150 .Nm
 151 will exit with error.
 152 .\"
 153 .It Fl d
 154 Enable debugging.
 155 .It Fl D
 156 Enable more debugging including the printing of internal timer information.
 157 .It Fl f
 158 Prevent
 159 .Nm
 160 from becoming a daemon (foreground mode).
 161 Warning messages are generated to standard error
 162 instead of
 163 .Xr syslog 3 .
 164 .It Fl m
 165 Enable mobility support.
 166 If this option is specified,
 167 .Nm
 168 sends probing packets to default routers that have advertised Router
 169 Advertisements
 170 when the node (re)attaches to an interface.
 171 Moreover, if the option is specified,
 172 .Nm
 173 periodically sends Router Solicitation on an interface that does not support
 174 .Dv SIOCGIFMEDIA
 175 ioctl.
 176 .It Fl 1
 177 Perform only one probe.
 178 Transmit Router Solicitation packets until at least one valid Router
 179 Advertisement packet has arrived on each
 180 .Ar interface ,
 181 then exit.
 182 .El
 183 .Sh DIAGNOSTICS
 184 .Ex -std rtsold rtsol
 185 .\"
 186 .Sh FILES
 187 .Bl -tag -width /var/run/rtsold.dump -compact
 188 .It Pa /var/run/rtsold.pid
 189 the pid of the currently running
 190 .Nm .
 191 .It Pa /var/run/rtsold.dump
 192 dumps internal state on.
 193 .El
 194 .\"
 195 .Sh SEE ALSO
 196 .Xr rtadvd 8 ,
 197 .Xr sysctl 8
 198 .\"
 199 .Sh HISTORY
 200 The
 201 .Nm
 202 utility is based on the
 203 .Nm rtsol
 204 utility, which first appeared in WIDE/KAME IPv6 protocol stack kit.
 205 The
 206 .Nm rtsol
 207 utility is now integrated into
 208 .Nm .
 209 .\"
 210 .Sh BUGS
 211 In some operating systems, when a PCMCIA network card is removed
 212 and reinserted, the corresponding interface index is changed.
 213 However,
 214 .Nm
 215 assumes such changes will not occur, and always uses the index that
 216 it got at invocation. As a result,
 217 .Nm
 218 may not work if you reinsert a network card.
 219 In such a case,
 220 .Nm
 221 should be killed and restarted.
 222 .Pp
 223 The IPv6 autoconfiguration specification assumes a single-interface host.
 224 You may see kernel error messages if you try to autoconfigure a host with
 225 multiple interfaces.
 226 Also, it seems contradictory for
 227 .Nm
 228 to accept multiple
 229 .Ar interface
 230 arguments.