xref: /freebsd/usr.sbin/route6d/route6d.8 (revision 4b7cdb5a420f518fbe1968a6916b6d017f54025d)
1.\"	$KAME: route6d.8,v 1.10 2000/11/24 11:57:18 itojun Exp $
2.\"
3.\" Copyright (c) 1996 WIDE Project. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modifications, are permitted provided that the above copyright notice
7.\" and this paragraph are duplicated in all such forms and that any
8.\" documentation, advertising materials, and other materials related to
9.\" such distribution and use acknowledge that the software was developed
10.\" by the WIDE Project, Japan. The name of the Project may not be used to
11.\" endorse or promote products derived from this software without
12.\" specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
13.\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
14.\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15.\" A PARTICULAR PURPOSE.
16.\"
17.Dd May 20, 2025
18.Dt ROUTE6D 8
19.Os
20.Sh NAME
21.Nm route6d
22.Nd RIP6 Routing Daemon
23.Sh DEPRECATION NOTICE
24The
25.Nm
26utility is deprecated and will be removed in
27.Fx 16.0 .
28.Sh SYNOPSIS
29.Nm
30.Op Fl adDhlnqsS
31.Bk -words
32.Op Fl R Ar routelog
33.Ek
34.Bk -words
35.Op Fl A Ar prefix/preflen,if1[,if2...\&]
36.Ek
37.Bk -words
38.Op Fl L Ar prefix/preflen,if1[,if2...\&]
39.Ek
40.Bk -words
41.Op Fl N Ar if1[,if2...\&]
42.Ek
43.Bk -words
44.Op Fl O Ar prefix/preflen,if1[,if2...\&]
45.Ek
46.Bk -words
47.Op Fl P Ar number
48.Ek
49.Bk -words
50.Op Fl p Ar pidfile
51.Ek
52.Bk -words
53.Op Fl Q Ar number
54.Ek
55.Bk -words
56.Op Fl T Ar if1[,if2...\&]
57.Ek
58.Bk -words
59.Op Fl t Ar tag
60.Ek
61.\"
62.Sh DESCRIPTION
63The
64.Nm
65utility is a routing daemon which supports RIP over IPv6.
66.Pp
67Options are:
68.Bl -tag -width indent
69.\"
70.It Fl a
71Enables aging of the statically defined routes.
72With this option, any
73statically defined routes will be removed unless corresponding updates
74arrive as if the routes are received at the startup of
75.Nm .
76.\"
77.It Fl R Ar routelog
78This option makes the
79.Nm
80to log the route change (add/delete) to the file
81.Ar routelog .
82.\"
83.It Fl A Ar prefix/preflen,if1[,if2...]
84This option is used for aggregating routes.
85.Ar prefix/preflen
86specifies the prefix and the prefix length of the
87aggregated route.
88When advertising routes,
89.Nm
90filters specific routes covered by the aggregate,
91and advertises the aggregated route
92.Ar prefix/preflen ,
93to the interfaces specified in the comma-separated interface list,
94.Ar if1[,if2...] .
95The characters
96.Qq Li * ,
97.Qq Li \&? ,
98and
99.Qq Li \&[
100in the interface list will be interpreted as shell-style pattern.
101The
102.Nm
103utility creates a static route to
104.Ar prefix/preflen
105with
106.Dv RTF_REJECT
107flag, into the kernel routing table.
108.\"
109.It Fl d
110Enables output of debugging message.
111This option also instructs
112.Nm
113to run in foreground mode
114(does not become daemon).
115.\"
116.It Fl D
117Enables extensive output of debugging message.
118This option also instructs
119.Nm
120to run in foreground mode
121(does not become daemon).
122.\"
123.It Fl h
124Disables the split horizon processing.
125.\"
126.It Fl l
127By default,
128.Nm
129will not exchange site local routes for safety reasons.
130This is because semantics of site local address space is rather vague
131(specification is still in being worked),
132and there is no good way to define site local boundary.
133With
134.Fl l
135option,
136.Nm
137will exchange site local routes as well.
138It must not be used on site boundary routers,
139since
140.Fl l
141option assumes that all interfaces are in the same site.
142.\"
143.It Fl L Ar prefix/preflen,if1[,if2...]
144Filter incoming routes from interfaces
145.Ar if1,[if2...] .
146The
147.Nm
148utility will accept incoming routes that are in
149.Ar prefix/preflen .
150If multiple
151.Fl L
152options are specified, any routes that match one of the options is accepted.
153.Li ::/0
154is treated specially as default route, not
155.Do
156any route that has longer prefix length than, or equal to 0
157.Dc .
158If you would like to accept any route, specify no
159.Fl L
160option.
161For example, with
162.Do
163.Fl L
164.Li 2001:db8::/16,if1
165.Fl L
166.Li ::/0,if1
167.Dc
168.Nm
169will accept default route and routes in 6bone test address, but no others.
170.\"
171.It Fl n
172Do not update the kernel routing table.
173.\"
174.It Fl N Ar if1[,if2...]
175Do not listen to, or advertise, route from/to interfaces specified by
176.Ar if1,[if2...] .
177.\"
178.It Fl O Ar prefix/preflen,if1[,if2...]
179Restrict route advertisement toward interfaces specified by
180.Ar if1,[if2...] .
181With this option
182.Nm
183will only advertise routes that matches
184.Ar prefix/preflen .
185.It Fl P Ar number
186Specifies routes to be ignored in calculation of expiration timer.
187The
188.Ar number
189must be
190.Li 1 ,
191.Li 2 ,
192or
193.Li 3
194and it means route flags of
195.Li RTF_PROTO1 ,
196.Li RTF_PROTO2 ,
197or
198.Li RTF_PROTO3 .
199When
200.Li 1
201is specified, routes with
202.Li RTF_PROTO1
203will never expire.
204.It Fl p Ar pidfile
205Specifies an alternative file in which to store the process ID.
206The default is
207.Pa /var/run/route6d.pid .
208.It Fl Q Ar number
209Specifies flag which will be used for routes added by RIP protocol.
210The default is
211.Li 2 Pq Li RTF_PROTO2 .
212.\"
213.It Fl q
214Makes
215.Nm
216in listen-only mode.
217No advertisement is sent.
218.\"
219.It Fl s
220Makes
221.Nm
222to advertise the statically defined routes which exist in the kernel routing
223table when
224.Nm
225invoked.
226Announcements obey the regular split horizon rule.
227.\"
228.It Fl S
229This option is the same as
230.Fl s
231option except that no split horizon rule does apply.
232.\"
233.It Fl T Ar if1[,if2...]
234Advertise only default route, toward
235.Ar if1,[if2...] .
236.\"
237.It Fl t Ar tag
238Attach route tag
239.Ar tag
240to originated route entries.
241.Ar tag
242can be decimal, octal prefixed by
243.Li 0 ,
244or hexadecimal prefixed by
245.Li 0x .
246.\"
247.El
248.Pp
249Upon receipt of signal
250.Dv SIGINT
251or
252.Dv SIGUSR1 ,
253.Nm
254will dump the current internal state into
255.Pa /var/run/route6d_dump .
256.\"
257.Sh FILES
258.Bl -tag -width /var/run/route6d_dump -compact
259.It Pa /var/run/route6d_dump
260dumps internal state on
261.Dv SIGINT
262or
263.Dv SIGUSR1
264.El
265.\"
266.Sh SEE ALSO
267.Rs
268.%A G. Malkin
269.%A R. Minnear
270.%T RIPng for IPv6
271.%R RFC2080
272.%D January 1997
273.Re
274.\"
275.Sh NOTE
276The
277.Nm
278utility uses IPv6 advanced API,
279defined in RFC2292,
280for communicating with peers using link-local addresses.
281.Pp
282Internally
283.Nm
284embeds interface identifier into bit 32 to 63 of link-local addresses
285.Li ( fe80::xx
286and
287.Li ff02::xx )
288so they will be visible on internal state dump file
289.Pq Pa /var/run/route6d_dump .
290.Pp
291Routing table manipulation differs from IPv6 implementation to implementation.
292Currently
293.Nm
294obeys WIDE Hydrangea/KAME IPv6 kernel,
295and will not be able to run on other platforms.
296.Pp
297Current
298.Nm
299does not reduce the rate of the triggered updates when consecutive updates
300arrive.
301