usr.sbin/rtsold/rtsold.8

   1 .\"     $NetBSD: rtsold.8,v 1.26 2006/10/08 19:36:05 elad Exp $
   2 .\"     $KAME: rtsold.8,v 1.17 2001/07/09 22:30:37 itojun Exp $
   3 .\"
   4 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the project nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .Dd October 8, 2006
  32 .Dt RTSOLD 8
  33 .Os
  34 .\"
  35 .Sh NAME
  36 .Nm rtsold
  37 .Nd router solicitation daemon
  38 .\"
  39 .Sh SYNOPSIS
  40 .Nm rtsold
  41 .Op Fl 1Ddfm
  42 .Ar interface ...
  43 .Nm rtsold
  44 .Op Fl 1Ddfm
  45 .Fl a
  46 .Nm rtsol
  47 .Op Fl Dd
  48 .Ar interface ...
  49 .Nm rtsol
  50 .Op Fl Dd
  51 .Fl a
  52 .\"
  53 .Sh DESCRIPTION
  54 .Nm
  55 is the daemon program to send ICMPv6 Router Solicitation messages
  56 on the specified interfaces.
  57 If a node (re)attaches to a link,
  58 .Nm
  59 sends some Router Solicitations on the link destined to the link-local scope
  60 all-routers multicast address to discover new routers
  61 and to get non link-local addresses.
  62 .Pp
  63 .Nm
  64 should be used on IPv6 hosts
  65 .Pq non-router nodes
  66 only.
  67 .Pp
  68 If you invoke the program as
  69 .Nm rtsol ,
  70 it will transmit probes from the specified
  71 .Ar interface ,
  72 without becoming a daemon.
  73 In other words,
  74 .Nm rtsol
  75 behaves as
  76 .Dq rtsold -f1 interface ... .
  77 .Pp
  78 Specifically,
  79 .Nm
  80 sends at most 3 Router Solicitations on an interface
  81 after one of the following events:
  82 .Bl -bullet
  83 .It
  84 Just after invocation of
  85 .Nm
  86 daemon.
  87 .It
  88 The interface is up after a temporary interface failure.
  89 .Nm
  90 detects such failures by periodically probing to see if the status
  91 of the interface is active or not.
  92 Note that some network cards and drivers do not allow the extraction
  93 of link state.
  94 In such cases,
  95 .Nm
  96 cannot detect the change of the interface status.
  97 .It
  98 Every 60 seconds if the
  99 .Fl m
 100 option is specified and the
 101 .Nm
 102 daemon cannot get the interface status.
 103 This feature does not conform to the IPv6 neighbor discovery
 104 specification, but is provided for mobile stations.
 105 The default interval for router advertisements, which is on the order of 10
 106 minutes, is slightly long for mobile stations.
 107 This feature is provided
 108 for such stations so that they can find new routers as soon as possible
 109 when they attach to another link.
 110 .El
 111 .Pp
 112 Once
 113 .Nm
 114 has sent a Router Solicitation, and has received a valid Router Advertisement,
 115 it refrains from sending additional solicitations on that interface, until
 116 the next time one of the above events occurs.
 117 .Pp
 118 When sending a Router Solicitation on an interface,
 119 .Nm
 120 includes a Source Link-layer address option if the interface
 121 has a link-layer address.
 122 .Pp
 123 Upon receipt of signal
 124 .Dv SIGUSR1 ,
 125 .Nm
 126 will dump the current internal state into
 127 .Pa /var/run/rtsold.dump .
 128 Also note that
 129 .Nm
 130 will not be able to update the kernel routing tables unless
 131 .Xr sysctl 8
 132 reports that
 133 net.inet6.ip6.accept_rtadv=1.
 134 .\"
 135 .Pp
 136 The options are as follows:
 137 .Bl -tag -width indent
 138 .It Fl 1
 139 Perform only one probe.
 140 Transmit Router Solicitation packets until at least one valid Router
 141 Advertisement packet has arrived on each
 142 .Ar interface ,
 143 then exit.
 144 .It Fl a
 145 Autoprobe outgoing interface.
 146 .Nm
 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 .It Fl D
 154 Enable more debugging (than that offered by the
 155 .Fl d
 156 option) including the printing of internal timer information.
 157 .It Fl d
 158 Enable debugging.
 159 .It Fl f
 160 This option prevents
 161 .Nm
 162 from becoming a daemon (foreground mode).
 163 Warning messages are generated to standard error
 164 instead of
 165 .Xr syslog 3 .
 166 .It Fl m
 167 Enable mobility support.
 168 If this option is specified,
 169 .Nm
 170 sends probing packets to default routers that have advertised Router
 171 Advertisements
 172 when the node (re)attaches to an interface.
 173 Moreover, if the option is specified,
 174 .Nm
 175 periodically sends Router Solicitation on an interface that does not support
 176 .Dv SIOCGIFMEDIA
 177 ioctl.
 178 .El
 179 .\"
 180 .Sh EXIT STATUS
 181 .Ex -std rtsold
 182 .\"
 183 .Sh FILES
 184 .Bl -tag -width /var/run/rtsold.dumpXX -compact
 185 .It Pa /var/run/rtsold.pid
 186 The PID of the currently running
 187 .Nm rtsold .
 188 .It Pa /var/run/rtsold.dump
 189 Internal state dump file.
 190 .El
 191 .\"
 192 .Sh SEE ALSO
 193 .Xr rtadvd 8 ,
 194 .Xr sysctl 8
 195 .\"
 196 .Sh HISTORY
 197 The
 198 .Nm
 199 command is based on the
 200 .Nm rtsol
 201 command, which first appeared in WIDE/KAME IPv6 protocol stack kit.
 202 .Nm rtsol
 203 is now integrated into
 204 .Nm .
 205 .\"
 206 .Sh BUGS
 207 In some operating systems, when a PCMCIA network card is removed
 208 and reinserted, the corresponding interface index is changed.
 209 However,
 210 .Nm
 211 assumes such changes will not occur, and always uses the index that
 212 it got at invocation. As a result,
 213 .Nm
 214 may not work if you reinsert a network card.
 215 In such a case,
 216 .Nm
 217 should be killed and restarted.
 218 .Pp
 219 You may see kernel error messages if you try to autoconfigure a host with
 220 multiple interfaces.