1.\" $KAME: rtsold.8,v 1.20 2003/04/11 12:46:12 jinmei 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$ 31.\" 32.Dd June 14, 2011 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 dDfFmu1 43.Op Fl O Ar script-name 44.Op Fl p Ar pidfile 45.Op Fl R Ar script-name 46.Ar interface ... 47.Nm 48.Op Fl dDfFmu1 49.Op Fl O Ar script-name 50.Op Fl p Ar pidfile 51.Op Fl R Ar script-name 52.Fl a 53.Nm rtsol 54.Op Fl dDu 55.Op Fl O Ar script-name 56.Op Fl R Ar script-name 57.Ar interface ... 58.Nm rtsol 59.Op Fl dDu 60.Op Fl O Ar script-name 61.Op Fl R Ar script-name 62.Fl a 63.\" 64.Sh DESCRIPTION 65.Nm 66is the daemon program to send ICMPv6 Router Solicitation messages 67on the specified interfaces. 68If a node (re)attaches to a link, 69.Nm 70sends some Router Solicitations on the link destined to the link-local scope 71all-routers multicast address to discover new routers 72and to get non link-local addresses. 73.Pp 74.Nm 75should be used on IPv6 hosts 76.Pq non-router nodes 77only. 78.Pp 79If you invoke the program as 80.Nm rtsol , 81it will transmit probes from the specified 82.Ar interface , 83without becoming a daemon. 84In other words, 85.Nm rtsol 86behaves as 87.Do 88.Nm 89.Fl f1 90.Ar interfaces 91.Dc . 92.Pp 93Specifically, 94.Nm 95sends at most 3 Router Solicitations on an interface 96after one of the following events: 97.Pp 98.Bl -bullet -compact 99.It 100Just after invocation of 101.Nm 102daemon. 103.It 104The interface is up after a temporary interface failure. 105.Nm 106detects such failures by periodically probing to see if the status 107of the interface is active or not. 108Note that some network cards and drivers do not allow the extraction 109of link state. 110In such cases, 111.Nm 112cannot detect the change of the interface status. 113.It 114Every 60 seconds if the 115.Fl m 116option is specified and the 117.Nm 118daemon cannot get the interface status. 119This feature does not conform to the IPv6 neighbor discovery 120specification, but is provided for mobile stations. 121The default interval for router advertisements, which is on the order of 10 122minutes, is slightly long for mobile stations. 123This feature is provided 124for such stations so that they can find new routers as soon as possible 125when they attach to another link. 126.El 127.Lp 128Once 129.Nm 130has sent a Router Solicitation, and has received a valid Router Advertisement, 131it refrains from sending additional solicitations on that interface, until 132the next time one of the above events occurs. 133.Lp 134When sending a Router Solicitation on an interface, 135.Nm 136includes a Source Link-layer address option if the interface 137has a link-layer address. 138.Lp 139.Nm 140manages a per-interface parameter to detect if a separate protocol is 141needed for configuration parameters other than host's addresses. 142At the invocation time, the flag is FALSE, and becomes TRUE when 143the daemon receives a router advertisement with the OtherConfig flag 144being set. 145A script file can be specified to deal with the case 146.Pq see below . 147When 148.Nm 149start resending router solicitation messages by one of the conditions 150events, 151the daemon resets the parameter because the event may indicate a 152change on the attached link. 153.Pp 154Upon receipt of signal 155.Dv SIGUSR1 , 156.Nm 157will dump the current internal state into 158.Pa /var/run/rtsold.dump . 159.\" 160.Pp 161The options are as follows: 162.Bl -tag -width indent 163.It Fl a 164Autoprobe outgoing interfaces. 165.Nm 166will try to find any non-loopback, non-point-to-point, IPv6-capable interfaces 167and send router solicitation messages on all of them. 168.It Fl d 169Enable debugging. 170.It Fl D 171Enable more debugging including the printing of internal timer information. 172.It Fl f 173Prevent 174.Nm 175from becoming a daemon (foreground mode). 176Warning messages are generated to standard error 177instead of 178.Xr syslog 3 . 179.It Fl F 180Explicitly configure the kernel to accept Router Advertisements and 181disable IPv6 forwarding. 182These settings are required for proper 183.Nm 184operation. 185Without this option, the current settings will be obeyed; 186if they are incompatible with proper operation, 187warning messages will be generated, 188but Router Solicitations will still be sent. 189The settings may be changed manually with 190.Xr sysctl 8 191and 192.Xr ifconfig 8 . 193.It Fl m 194Enable mobility support. 195If this option is specified, 196.Nm 197sends probing packets to default routers that have advertised Router 198Advertisements 199when the node (re)attaches to an interface. 200Moreover, if the option is specified, 201.Nm 202periodically sends Router Solicitation on an interface that does not support 203.Dv SIOCGIFMEDIA 204ioctl. 205.It Fl 1 206Perform only one probe. 207Transmit Router Solicitation packets until at least one valid Router 208Advertisement packet has arrived on each 209.Ar interface , 210then exit. 211.It Fl O Ar script-name 212Specifies a supplement script file to handle the Other Configuration 213flag of the router advertisement. 214When the flag changes from FALSE to TRUE, 215.Nm 216will invoke 217.Ar script-name 218with a single argument of the receiving interface name, 219expecting the script will then start a protocol for the other 220configuration. 221.Ar script-name 222must be the absolute path from root to the script file, be a regular 223file, and be created by the same owner who runs 224.Nm . 225.It Fl p Ar pidfile 226Writes the process ID of 227.Nm 228to 229.Pa pidfile 230instead of the default PID file 231.Pa /var/run/rtsold.pid . 232.It Fl R Ar script-name 233Specifies a script to run when router advertisement options 234.Dv RDNSS Pq Recursive DNS Server 235or 236.Dv DNSSL Pq DNS Search List 237are encountered. 238The information of DNS servers and DNS search domains will be sent to 239standard input of this script. 240The 241.Xr resolvconf 8 242script is used by default. 243.It Fl u 244Specifies whether adding the source address of Router Advertisement 245messages to the interface name in an argument of the RDNSS and DNSSL 246script. 247.Pp 248If 249.Fl u 250is specified, the interface name in the script argument will be 251.Ql ifname:slaac:[RA-source-address] . 252.Pp 253If not, it will be 254.Ql ifname:slaac . 255.El 256.Sh FILES 257.Bl -tag -width /var/run/rtsold.dump -compact 258.It Pa /var/run/rtsold.pid 259The PID of the currently running 260.Nm . 261.It Pa /var/run/rtsold.dump 262Internal state dump file. 263.El 264.\" 265.Sh EXIT STATUS 266.Ex -std 267.\" 268.Sh SEE ALSO 269.Xr resolvconf 8 , 270.Xr rtadvd 8 , 271.Xr sysctl 8 272.\" 273.Sh HISTORY 274The 275.Nm 276command is based on the 277.Nm rtsol 278command, which first appeared in WIDE/KAME IPv6 protocol stack kit. 279.Nm rtsol 280is now integrated into 281.Xr rtsold 8 . 282.\" 283.Sh BUGS 284In some operating systems, when a PCMCIA network card is removed 285and reinserted, the corresponding interface index is changed. 286However, 287.Nm 288assumes such changes will not occur, and always uses the index that 289it got at invocation. 290As a result, 291.Nm 292may not work if you reinsert a network card. 293In such a case, 294.Nm 295should be killed and restarted. 296.Pp 297The IPv6 autoconfiguration specification assumes a single-interface host. 298You may see kernel error messages if you try to autoconfigure a host with 299multiple interfaces. 300Also, it seems contradictory for 301.Nm 302to accept multiple 303.Ar interface 304arguments. 305