xref: /netbsd-src/usr.sbin/rtsold/rtsold.8 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\"	$NetBSD: rtsold.8,v 1.33 2013/05/26 17:25:53 wiz 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 May 24, 2013
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
55is the daemon program to send ICMPv6 Router Solicitation messages
56on the specified interfaces.
57If a node (re)attaches to a link,
58.Nm
59sends some Router Solicitations on the link destined to the link-local scope
60all-routers multicast address to discover new routers
61and to get non link-local addresses.
62.Pp
63.Nm
64should be used on IPv6 hosts
65.Pq non-router nodes
66only.
67.Pp
68If you invoke the program as
69.Nm rtsol ,
70it will transmit probes from the specified
71.Ar interface ,
72without becoming a daemon.
73In other words,
74.Nm rtsol
75behaves as
76.Dq rtsold -f1 interface ... .
77.Pp
78Specifically,
79.Nm
80sends at most 3 Router Solicitations on an interface
81after one of the following events:
82.Bl -bullet
83.It
84Just after invocation of the
85.Nm
86daemon.
87.It
88The interface is up after a temporary interface failure.
89.Nm
90detects such failures by periodically probing to see if the status
91of the interface is active or not.
92Note that some network cards and drivers do not allow the extraction
93of link state.
94In such cases,
95.Nm
96cannot detect the change of the interface status.
97.It
98Every 60 seconds if the
99.Fl m
100option is specified and the
101.Nm
102daemon cannot get the interface status.
103This feature does not conform to the IPv6 neighbor discovery
104specification, but is provided for mobile stations.
105The default interval for router advertisements,
106which is approximately 10 minutes,
107is slightly long for mobile stations.
108This feature is provided
109for such stations so that they can find new routers as soon as possible
110when they attach to another link.
111.El
112.Pp
113Once
114.Nm
115has sent a Router Solicitation, and has received a valid Router Advertisement,
116it refrains from sending additional solicitations on that interface, until
117the next time one of the above events occurs.
118.Pp
119When sending a Router Solicitation on an interface,
120.Nm
121includes a Source Link-layer address option if the interface
122has a link-layer address.
123.Pp
124Upon receipt of signal
125.Dv SIGUSR1 ,
126.Nm
127will dump the current internal state into
128.Pa /var/run/rtsold.dump .
129Also note that
130.Nm
131will not be able to update the kernel routing tables unless
132.Xr sysctl 8
133reports that
134net.inet6.ip6.accept_rtadv=1.
135.\"
136.Pp
137The options are as follows:
138.Bl -tag -width indent
139.It Fl 1
140Perform only one probe.
141Transmit Router Solicitation packets until at least one valid Router
142Advertisement packet has arrived on each
143.Ar interface ,
144then exit.
145.It Fl a
146Autoprobe outgoing interfaces.
147.Nm
148will try to find a non-loopback, non-point-to-point, IPv6-capable interfaces,
149and send router solicitation messages on all of them.
150.It Fl D
151Enable more debugging (than that offered by the
152.Fl d
153option) including the printing of internal timer information.
154.It Fl d
155Enable debugging.
156.It Fl f
157This option prevents
158.Nm
159from becoming a daemon (foreground mode).
160Warning messages are generated to standard error
161instead of
162.Xr syslog 3 .
163.It Fl m
164Enable mobility support.
165If this option is specified,
166.Nm
167sends probing packets to default routers that have advertised Router
168Advertisements
169when the node (re)attaches to an interface.
170Moreover, if the option is specified,
171.Nm
172periodically sends Router Solicitation on an interface that does not support
173the
174.Dv SIOCGIFMEDIA
175ioctl.
176.El
177.\"
178.Sh EXIT STATUS
179.Ex -std rtsold
180.\"
181.Sh FILES
182.Bl -tag -width /var/run/rtsold.dumpXX -compact
183.It Pa /var/run/rtsold.pid
184The PID of the currently running
185.Nm rtsold .
186.It Pa /var/run/rtsold.dump
187Internal state dump file.
188.El
189.\"
190.Sh SEE ALSO
191.Xr rtadvd 8 ,
192.Xr sysctl 8
193.\"
194.Sh HISTORY
195The
196.Nm
197command is based on the
198.Nm rtsol
199command, which first appeared in the WIDE/KAME IPv6 protocol stack kit.
200.Nm rtsol
201is now integrated into
202.Nm .
203.\"
204.Sh BUGS
205In some operating systems, when a PCMCIA network card is removed
206and reinserted, the corresponding interface index is changed.
207However,
208.Nm
209assumes such changes will not occur, and always uses the index that
210it got at invocation.
211As a result,
212.Nm
213may not work if you reinsert a network card.
214In such a case,
215.Nm
216should be killed and restarted.
217.Pp
218You may see kernel error messages if you try to autoconfigure a host with
219multiple interfaces.
220