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