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