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