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