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