xref: /freebsd/usr.sbin/rtsold/rtsold.8 (revision b601c69bdbe8755d26570261d7fd4c02ee4eff74)
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.9 2000/07/04 14:44:38 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
49is the daemon program to send ICMPv6 Router Solicitation messages
50on the specified interfaces.
51If a node (re)attaches to a link,
52.Nm
53sends some Router Solicitations on the link destined to the link-local scope
54all-routers multicast address to discover new routers
55and to get non link-local addresses.
56.Pp
57If you invoke the program as
58.Nm rtsol ,
59it will transmit probes from the specified
60.Ar interface ,
61without becoming a daemon.
62In other words,
63.Nm rtsol
64behaves as
65.Do
66.Nm
67.Fl f1
68.Ar interfaces
69.Dc .
70.Pp
71Specifically,
72.Nm
73sends at most 3 Router Solicitations on an interface
74after one of the following events:
75.Pp
76.Bl -bullet -compact
77.It
78Just after invocation of
79.Nm
80daemon.
81.It
82The interface is up after a temporary interface failure.
83.Nm Rtsold
84detects such failures by periodically probing to see if the status
85of the interface is active or not.
86Note that some network cards and drivers do not allow the extraction
87of link state.
88In such cases,
89.Nm
90cannot detect the change of the interface status.
91.It
92Every 60 seconds if the
93.Fl m
94option is specified and the
95.Nm
96daemon cannot get the interface status.
97This feature does not conform to IPv6 neighbor discovery
98specification, but is provided for mobile stations.
99Default interval for router advertisements, which is on the order of 10
100minutes, is slightly long for mobile stations.
101This feature is provided
102for such stations so that they can find new routers as soon as possible
103when they attach to another link.
104.El
105.Lp
106Once
107.Nm
108sends a Router Solicitation, and receives a valid Router Advertisement,
109it refrains from sending additional solicitations on that interface, until
110the next time one of the above events occurs.
111.Lp
112When sending a Router Solicitation on an interface,
113.Nm
114includes a Source Link-layer address option if the interface
115has its link-layer address.
116.Pp
117Upon receipt of signal
118.Dv SIGUSR1 ,
119.Nm
120will dump the current internal state into
121.Pa /var/run/rtsold.dump.
122.\"
123.Sh OPTIONS
124.Bl -tag -width indent
125.\"
126.It Fl d
127Enable debugging.
128.It Fl D
129Enable more debugging including to print internal timer information.
130.It Fl f
131.Fl f
132prevents
133.Nm
134from becoming a daemon (foreground mode).
135Warning messages are generated to standard error output,
136instead of
137.Xr syslog 3 .
138.It Fl m
139Enable mobility support.
140If this option is specified,
141.Nm
142sends probing packets to default routers that have advertised Router
143Advertisements
144when the node (re)attaches to an interface.
145Moreover, if the option is specified,
146.Nm
147periodically sends Router Solicitation on an interface that does not support
148.Dv SIOCGIFMEDIA
149ioctl.
150.It Fl 1
151Perform only one probe.
152Transmit Router Solicitation packet until valid Router Advertisement packet
153arrives all the interfaces more than once, then exit.
154.El
155.Sh RETURN VALUES
156The program exits with 0 on success, non-zero on failures.
157.\"
158.Sh FILES
159.Bl -tag -width /var/run/rtsold.dump -compact
160.It Pa /var/run/rtsold.pid
161the pid of the currently running
162.Nm rtsold .
163.It Pa /var/run/rtsold.dump
164dumps internal state on.
165.El
166.\"
167.Sh SEE ALSO
168.Xr rtadvd 8 ,
169.Xr sysctl 8
170.\"
171.Sh HISTORY
172The
173.Nm
174command is based on the
175.Nm rtsol
176command, which first appeared in WIDE/KAME IPv6 protocol stack kit.
177.Nm rtsol
178is now integrated into
179.Xr rtsold 8 .
180.\"
181.Sh BUGS
182In some operating systems, when a PCMCIA network card is removed
183and reinserted, the corresponding interface index is changed.
184However,
185.Nm
186does not assume such changes, and always uses the index that
187it got at invocation. As a result,
188.Nm
189may not work if you reinsert a network card.
190In such a case,
191.Nm
192should be killed and restarted.
193