xref: /netbsd-src/usr.sbin/rtsold/rtsold.8 (revision a5847cc334d9a7029f6352b847e9e8d71a0f9e0c)
1.\"	$NetBSD: rtsold.8,v 1.30 2010/01/11 14:30:02 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 January 11, 2010
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, which is on the order of 10
106minutes, is slightly long for mobile stations.
107This feature is provided
108for such stations so that they can find new routers as soon as possible
109when they attach to another link.
110.El
111.Pp
112Once
113.Nm
114has sent a Router Solicitation, and has received a valid Router Advertisement,
115it refrains from sending additional solicitations on that interface, until
116the next time one of the above events occurs.
117.Pp
118When sending a Router Solicitation on an interface,
119.Nm
120includes a Source Link-layer address option if the interface
121has a link-layer address.
122.Pp
123Upon receipt of signal
124.Dv SIGUSR1 ,
125.Nm
126will dump the current internal state into
127.Pa /var/run/rtsold.dump .
128Also note that
129.Nm
130will not be able to update the kernel routing tables unless
131.Xr sysctl 8
132reports that
133net.inet6.ip6.accept_rtadv=1.
134.\"
135.Pp
136The options are as follows:
137.Bl -tag -width indent
138.It Fl 1
139Perform only one probe.
140Transmit Router Solicitation packets until at least one valid Router
141Advertisement packet has arrived on each
142.Ar interface ,
143then exit.
144.It Fl a
145Autoprobe outgoing interface.
146.Nm
147will try to find a non-loopback, non-point-to-point, IPv6-capable interface.
148If
149.Nm
150finds multiple interfaces,
151.Nm
152will exit with an error.
153.It Fl D
154Enable more debugging (than that offered by the
155.Fl d
156option) including the printing of internal timer information.
157.It Fl d
158Enable debugging.
159.It Fl f
160This option prevents
161.Nm
162from becoming a daemon (foreground mode).
163Warning messages are generated to standard error
164instead of
165.Xr syslog 3 .
166.It Fl m
167Enable mobility support.
168If this option is specified,
169.Nm
170sends probing packets to default routers that have advertised Router
171Advertisements
172when the node (re)attaches to an interface.
173Moreover, if the option is specified,
174.Nm
175periodically sends Router Solicitation on an interface that does not support
176the
177.Dv SIOCGIFMEDIA
178ioctl.
179.El
180.\"
181.Sh EXIT STATUS
182.Ex -std rtsold
183.\"
184.Sh FILES
185.Bl -tag -width /var/run/rtsold.dumpXX -compact
186.It Pa /var/run/rtsold.pid
187The PID of the currently running
188.Nm rtsold .
189.It Pa /var/run/rtsold.dump
190Internal state dump file.
191.El
192.\"
193.Sh SEE ALSO
194.Xr rtadvd 8 ,
195.Xr sysctl 8
196.\"
197.Sh HISTORY
198The
199.Nm
200command is based on the
201.Nm rtsol
202command, which first appeared in the WIDE/KAME IPv6 protocol stack kit.
203.Nm rtsol
204is now integrated into
205.Nm .
206.\"
207.Sh BUGS
208In some operating systems, when a PCMCIA network card is removed
209and reinserted, the corresponding interface index is changed.
210However,
211.Nm
212assumes such changes will not occur, and always uses the index that
213it got at invocation.
214As a result,
215.Nm
216may not work if you reinsert a network card.
217In such a case,
218.Nm
219should be killed and restarted.
220.Pp
221You may see kernel error messages if you try to autoconfigure a host with
222multiple interfaces.
223