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