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