usr.sbin/rtsold/rtsold.8

   1 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: rtsold.8,v 1.4 1999/09/30 00:57:15 jinmei Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd May 17, 1998
  32 .Dt RTSOLD 8
  33 .Os KAME
  34 .\"
  35 .Sh NAME
  36 .Nm rtsold
  37 .Nd router solicitation daemon
  38 .\"
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl dDfm1
  42 .Ar interface ...
  43 .Nm rtsol
  44 .Op Fl dD
  45 .Ar interface ...
  46 .\"
  47 .Sh DESCRIPTION
  48 .Nm Rtsold
  49 is the daemon program to send ICMPv6 Router Solicitation messages
  50 on the specified interfaces.
  51 If a node (re)attaches to a link,
  52 .Nm
  53 sends some Router Solicitations on the link destined to the link-local scope
  54 all-routers multicast address to discover new routers
  55 and to get non link-local addresses.
  56 .Lp
  57 Specifically,
  58 .Nm
  59 sends at most 3 Router Solicitations on an interface
  60 after one of the following events:
  61 .Bl -bullet -compact
  62 .It
  63 Just after invocation of
  64 .Nm
  65 daemon.
  66 .It
  67 The interface is up after a temporary interface failure.
  68 .Nm Rtsold
  69 detects it by periodically probing if the status of the
  70 interface is active or not.
  71 Note that some network cards and drivers do not allow users
  72 to extract link state.
  73 In such cases,
  74 .Nm
  75 cannot detect the change of the interface status.
  76 .It
  77 Every one minute if
  78 .Fl m
  79 option is specified and
  80 .Nm
  81 daemon cannot get the interface status.
  82 This feature does not conform to IPv6 neighbor discovery
  83 specification, but is provided for mobile stations.
  84 Default interval of router advertisements, which is on the order of 10
  85 minutes, is slightly long for mobile stations.
  86 This feature is provided
  87 for such stations so that they can find new routers as soon as possible
  88 when they attach another link.
  89 .El
  90 .Lp
  91 Once
  92 .Nm
  93 sends a Router Solicitation, and receives a valid Router Advertisement,
  94 it desists from sending additional solicitations on that interface, until
  95 the next time one of the above events occurs.
  96 .Lp
  97 When sending a Router Solicitation on an interface,
  98 .Nm
  99 includes a Source Link-layer address option if the interface
 100 has its link-layer address.
 101 .Pp
 102 Upon receipt of signal
 103 .Dv SIGUSR1 ,
 104 .Nm
 105 will dump the current internal state into
 106 .Pa /var/tmp/rtsold.dump.
 107 .\"
 108 .Sh OPTIONS
 109 .Bl -tag -width indent
 110 .\"
 111 .It Fl d
 112 Enable debugging.
 113 .It Fl D
 114 Enable more debugging including to print internal timer information.
 115 .It Fl f
 116 .Fl f
 117 prevents
 118 .Nm
 119 from becoming a daemon (foreground mode).
 120 Warning messages are generated to standard error output,
 121 instead of
 122 .Xr syslog 3 .
 123 .It Fl m
 124 Enable mobility support.
 125 If this option is specified,
 126 .Nm
 127 sends probing packets to default routers that have advertised Router
 128 Advertisements
 129 when the node (re)attaches to an interface.
 130 Moreover, if the option is specified,
 131 .Nm
 132 periodically sends Router Solicitation on an interface that does not support
 133 .Dv SIOCGIFMEDIA
 134 ioctl.
 135 .It Fl 1
 136 Perform only one probe.
 137 Transmit Router Solcitation packet until valid Router Advertisement packet
 138 arrives all the interfaces more than once, then exit.
 139 .El
 140 .Pp
 141 If you invoke the program as
 142 .Nm rtsol ,
 143 it will behave as
 144 .Do
 145 .Nm
 146 .Fl f1
 147 .Ar interfaces
 148 .Dc .
 149 .Sh RETURN VALUES
 150 The program exits with 0 on success, non-zero on failures.
 151 .\"
 152 .Sh FILES
 153 .Bl -tag -width /var/run/rtsold.dump -compact
 154 .It Pa /var/run/rtsold.pid
 155 the pid of the currently running
 156 .Nm rtsold .
 157 .It Pa /var/tmp/rtsold.dump
 158 dumps internal state on.
 159 .El
 160 .\"
 161 .Sh SEE ALSO
 162 .Xr rtadvd 8 ,
 163 .Xr sysctl 8
 164 .\"
 165 .Sh HISTORY
 166 The
 167 .Nm
 168 command is based on
 169 .Nm rtsol
 170 command, which first appeared in WIDE/KAME IPv6 protocol stack kit.
 171 .Nm rtsol
 172 is now integrated into
 173 .Xr rtsold 8 .
 174 .\" .Sh BUGS
 175 .\" (to be written)