xref: /dragonfly/usr.sbin/rtsold/rtsold.8 (revision 91dc43dd)
1.\"	$KAME: rtsold.8,v 1.16 2000/10/15 13:19:05 itojun 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: src/usr.sbin/rtsold/rtsold.8,v 1.1.2.7 2003/03/11 22:31:33 trhodes Exp $
31.\"	$DragonFly: src/usr.sbin/rtsold/rtsold.8,v 1.4 2006/02/17 19:40:26 swildner Exp $
32.\"
33.Dd May 17, 1998
34.Dt RTSOLD 8
35.Os
36.\"
37.Sh NAME
38.Nm rtsold ,
39.Nm rtsol
40.Nd router solicitation daemon
41.\"
42.Sh SYNOPSIS
43.Nm
44.Op Fl dDfm1
45.Ar interface ...
46.Nm
47.Op Fl dDfm1
48.Fl a
49.Nm rtsol
50.Op Fl dD
51.Ar interface ...
52.Nm rtsol
53.Op Fl dD
54.Fl a
55.\"
56.Sh DESCRIPTION
57The
58.Nm
59utility is the daemon program to send ICMPv6 Router Solicitation messages
60on the specified interfaces.
61If a node (re)attaches to a link,
62.Nm
63sends some Router Solicitations on the link destined to the link-local scope
64all-routers multicast address to discover new routers
65and to get non link-local addresses.
66.Pp
67The
68.Nm
69utility should be used on IPv6 hosts
70(non-router nodes)
71only.
72.Pp
73If you invoke the program as
74.Nm rtsol ,
75it will transmit probes from the specified
76.Ar interface ,
77without becoming a daemon.
78In other words,
79.Nm rtsol
80behaves as
81.Do
82.Nm
83.Fl f1
84.Ar interfaces
85.Dc .
86.Pp
87Specifically,
88.Nm
89sends at most 3 Router Solicitations on an interface
90after one of the following events:
91.Pp
92.Bl -bullet -compact
93.It
94Just after invocation of
95.Nm
96daemon.
97.It
98The interface is up after a temporary interface failure.
99The
100.Nm
101utility detects such failures by periodically probing to see if the status
102of the interface is active or not.
103Note that some network cards and drivers do not allow the extraction
104of link state.
105In such cases,
106.Nm
107cannot detect the change of the interface status.
108.It
109Every 60 seconds if the
110.Fl m
111option is specified and the
112.Nm
113daemon cannot get the interface status.
114This feature does not conform to the IPv6 neighbor discovery
115specification, but is provided for mobile stations.
116The default interval for router advertisements, which is on the order of 10
117minutes, is slightly long for mobile stations.
118This feature is provided
119for such stations so that they can find new routers as soon as possible
120when they attach to another link.
121.El
122.Lp
123Once
124.Nm
125has sent a Router Solicitation, and has received a valid Router Advertisement,
126it refrains from sending additional solicitations on that interface, until
127the next time one of the above events occurs.
128.Lp
129When sending a Router Solicitation on an interface,
130.Nm
131includes a Source Link-layer address option if the interface
132has a link-layer address.
133.Pp
134Upon receipt of signal
135.Dv SIGUSR1 ,
136.Nm
137will dump the current internal state into
138.Pa /var/run/rtsold.dump .
139.\"
140.Sh OPTIONS
141.Bl -tag -width indent
142.It Fl a
143Autoprobe outgoing interface.
144The
145.Nm
146utility
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 error.
153.\"
154.It Fl d
155Enable debugging.
156.It Fl D
157Enable more debugging including the printing of internal timer information.
158.It Fl f
159Prevent
160.Nm
161from becoming a daemon (foreground mode).
162Warning messages are generated to standard error
163instead of
164.Xr syslog 3 .
165.It Fl m
166Enable mobility support.
167If this option is specified,
168.Nm
169sends probing packets to default routers that have advertised Router
170Advertisements
171when the node (re)attaches to an interface.
172Moreover, if the option is specified,
173.Nm
174periodically sends Router Solicitation on an interface that does not support
175.Dv SIOCGIFMEDIA
176ioctl.
177.It Fl 1
178Perform only one probe.
179Transmit Router Solicitation packets until at least one valid Router
180Advertisement packet has arrived on each
181.Ar interface ,
182then exit.
183.El
184.Sh FILES
185.Bl -tag -width /var/run/rtsold.dump -compact
186.It Pa /var/run/rtsold.pid
187the pid of the currently running
188.Nm .
189.It Pa /var/run/rtsold.dump
190dumps internal state on.
191.El
192.\"
193.Sh EXIT STATUS
194.Ex -std rtsold rtsol
195.\"
196.Sh SEE ALSO
197.Xr rtadvd 8 ,
198.Xr sysctl 8
199.\"
200.Sh HISTORY
201The
202.Nm
203utility is based on the
204.Nm rtsol
205utility, which first appeared in WIDE/KAME IPv6 protocol stack kit.
206The
207.Nm rtsol
208utility is now integrated into
209.Nm .
210.\"
211.Sh BUGS
212In some operating systems, when a PCMCIA network card is removed
213and reinserted, the corresponding interface index is changed.
214However,
215.Nm
216assumes such changes will not occur, and always uses the index that
217it got at invocation. As a result,
218.Nm
219may not work if you reinsert a network card.
220In such a case,
221.Nm
222should be killed and restarted.
223.Pp
224The IPv6 autoconfiguration specification assumes a single-interface host.
225You may see kernel error messages if you try to autoconfigure a host with
226multiple interfaces.
227Also, it seems contradictory for
228.Nm
229to accept multiple
230.Ar interface
231arguments.
232