rtadvd.conf.5 (251c176f415c9dc57b7c8c063aec4208bfc2efa6) rtadvd.conf.5 (a336d37d0f7d5d95145d1594a7dd6732519cdae8)
1.\" $KAME: rtadvd.conf.5,v 1.8 2000/10/25 05:37:43 jinmei Exp $
1.\" $FreeBSD$
2.\" $KAME: rtadvd.conf.5,v 1.32 2001/01/19 05:32:05 jinmei Exp $
2.\"
3.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright

--- 12 unchanged lines hidden (view full) ---

22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
3.\"
4.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright

--- 12 unchanged lines hidden (view full) ---

23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
30.\" $FreeBSD$
31.\"
32.Dd May 17, 1998
33.Dt RTADVD.CONF 5
34.Os
35.Sh NAME
36.Nm rtadvd.conf
37.Nd config file for router advertisement daemon
38.Sh DESCRIPTION
31.Dd May 17, 1998
32.Dt RTADVD.CONF 5
33.Os
34.Sh NAME
35.Nm rtadvd.conf
36.Nd config file for router advertisement daemon
37.Sh DESCRIPTION
39This file describes how the router advertisement packet must be constructed
38This file describes how the router advertisement packets must be constructed
40for each of the interfaces.
39for each of the interfaces.
40.Pp
41As described in
42.Xr rtadvd 8 ,
43you do not have to set this configuration file up at all,
44unless you need some special configurations.
41As described in
42.Xr rtadvd 8 ,
43you do not have to set this configuration file up at all,
44unless you need some special configurations.
45You may even omit to create this file. In such cases, the
45You may even omit the file as a whole.
46In such cases, the
46.Nm rtadvd
47daemon will automatically configure itself using default values
48specified in the specification.
49.Pp
50It obeys the famous
51.Xr termcap 5
52file format.
53Each line in the file describes a network interface.
54Fields are separated by a colon
55.Pq Sq \&: ,
56and each field contains one capability description.
47.Nm rtadvd
48daemon will automatically configure itself using default values
49specified in the specification.
50.Pp
51It obeys the famous
52.Xr termcap 5
53file format.
54Each line in the file describes a network interface.
55Fields are separated by a colon
56.Pq Sq \&: ,
57and each field contains one capability description.
57Lines may be concatenated by
58Lines may be concatenated by the
58.Sq \e
59character.
60The comment marker is the
59.Sq \e
60character.
61The comment marker is the
61.Sq \#
62.Sq \&#
62character.
63.Pp
64.Sh CAPABILITIES
65Capabilities describe the value to be filled into ICMPv6 router
66advertisement messages and to control
67.Xr rtadvd 8
68behavior.
63character.
64.Pp
65.Sh CAPABILITIES
66Capabilities describe the value to be filled into ICMPv6 router
67advertisement messages and to control
68.Xr rtadvd 8
69behavior.
69You are therefore encouraged to read IETF neighbor discovery documents
70Therefore, you are encouraged to read IETF neighbor discovery documents
70if you would like to modify the sample configuration file.
71.Pp
71if you would like to modify the sample configuration file.
72.Pp
72As explained above, note that almost all items have default values.
73Note that almost all items have default values.
73If you omit an item, the default value of the item will be used.
74.Pp
75There are two items which control the interval of sending router advertisements.
76These items can be omitted, then
77.Nm rtadvd
78will use the default values.
79.Bl -tag -width indent
80.It Cm \&maxinterval
81(num) The maximum time allowed between sending unsolicited
82multicast router advertisements
83.Pq unit: seconds .
84The default value is 600.
85Its value must be no less than 4 seconds
86and no greater than 1800 seconds.
87.It Cm \&mininterval
88(num) The minimum time allowed between sending unsolicited multicast
89router advertisements
90.Pq unit: seconds .
91The default value is the one third of value of
74If you omit an item, the default value of the item will be used.
75.Pp
76There are two items which control the interval of sending router advertisements.
77These items can be omitted, then
78.Nm rtadvd
79will use the default values.
80.Bl -tag -width indent
81.It Cm \&maxinterval
82(num) The maximum time allowed between sending unsolicited
83multicast router advertisements
84.Pq unit: seconds .
85The default value is 600.
86Its value must be no less than 4 seconds
87and no greater than 1800 seconds.
88.It Cm \&mininterval
89(num) The minimum time allowed between sending unsolicited multicast
90router advertisements
91.Pq unit: seconds .
92The default value is the one third of value of
92.Ic maxinterval.
93.Cm maxinterval .
93Its value must be no less than 3 seconds and no greater than .75 *
94the value of
94Its value must be no less than 3 seconds and no greater than .75 *
95the value of
95.Ic maxinterval.
96.Cm maxinterval .
96.El
97.Pp
98The following items are for ICMPv6 router advertisement message
99header.
100These items can be omitted, then
101.Nm rtadvd
102will use the default values.
103.Bl -tag -width indent

--- 12 unchanged lines hidden (view full) ---

116.Li 0x40
117.Pc
118means Other stateful configuration flag bit.
119The default value is 0.
120.It Cm \&rltime
121(num) Router lifetime field
122.Pq unit: seconds .
123Its value must be no greater than 3600000.
97.El
98.Pp
99The following items are for ICMPv6 router advertisement message
100header.
101These items can be omitted, then
102.Nm rtadvd
103will use the default values.
104.Bl -tag -width indent

--- 12 unchanged lines hidden (view full) ---

117.Li 0x40
118.Pc
119means Other stateful configuration flag bit.
120The default value is 0.
121.It Cm \&rltime
122(num) Router lifetime field
123.Pq unit: seconds .
124Its value must be no greater than 3600000.
125When
126.Nm rtadvd
127runs on a host, this value must explicitly set 0 on all the
128advertising interfaces as described in
129.Xr rtadvd 8 .
124The default value is 1800.
125.It Cm \&rtime
126(num) Reachable time field
127.Pq unit: milliseconds .
128The default value is 0, which means unspecified by this router.
129.It Cm \&retrans
130(num) Retrans Timer field
131.Pq unit: milliseconds .

--- 15 unchanged lines hidden (view full) ---

147.Xr rtadvd 8
148looks up the system routing table and
149advertise the prefixes corresponding to interface routes
150on the interface.
151If its value is more than 1, you must specify the index of the prefix
152for each item below.
153Indices vary from 0 to N-1, where N is the
154value of
130The default value is 1800.
131.It Cm \&rtime
132(num) Reachable time field
133.Pq unit: milliseconds .
134The default value is 0, which means unspecified by this router.
135.It Cm \&retrans
136(num) Retrans Timer field
137.Pq unit: milliseconds .

--- 15 unchanged lines hidden (view full) ---

153.Xr rtadvd 8
154looks up the system routing table and
155advertise the prefixes corresponding to interface routes
156on the interface.
157If its value is more than 1, you must specify the index of the prefix
158for each item below.
159Indices vary from 0 to N-1, where N is the
160value of
155.Ic addrs .
161.Cm addrs .
156Each index shall follow the name of each item, e.g.,
157.Dq prefixlen2 .
158.It Cm \&prefixlen
159(num) Prefix length field.
160The default value is 64.
161.It Cm \&pinfoflags
162(num) Flags field in prefix information option.
163Bit 7

--- 12 unchanged lines hidden (view full) ---

176Since
177.Dq \&:
178is used for
179.Xr termcap 5
180file format as well as IPv6 numeric address, the field MUST be quoted by
181doublequote character.
182This field cannot be
183omitted if the value of
162Each index shall follow the name of each item, e.g.,
163.Dq prefixlen2 .
164.It Cm \&prefixlen
165(num) Prefix length field.
166The default value is 64.
167.It Cm \&pinfoflags
168(num) Flags field in prefix information option.
169Bit 7

--- 12 unchanged lines hidden (view full) ---

182Since
183.Dq \&:
184is used for
185.Xr termcap 5
186file format as well as IPv6 numeric address, the field MUST be quoted by
187doublequote character.
188This field cannot be
189omitted if the value of
184.Ic addrs
190.Cm addrs
185is more than 0.
186.It Cm \&vltime
187(num) Valid lifetime field
188.Pq unit: seconds .
191is more than 0.
192.It Cm \&vltime
193(num) Valid lifetime field
194.Pq unit: seconds .
189The default value is 2592000(30 days).
195The default value is 2592000 (30 days).
190.It Cm \&pltime
191(num) Preferred lifetime field
192.Pq unit: seconds .
196.It Cm \&pltime
197(num) Preferred lifetime field
198.Pq unit: seconds .
193The default value is 604800(7 days).
199The default value is 604800 (7 days).
194.El
195.Pp
196The following item is for ICMPv6 MTU option,
197which will be attached to router advertisement header.
198This item can be omitted, then
199.Nm rtadvd
200will use the default value.
201.Bl -tag -width indent

--- 31 unchanged lines hidden (view full) ---

233.Pp
234You can also refer one line from another by using
235.Cm tc
236capability.
237See
238.Xr termcap 5
239for details on the capability.
240.Sh EXAMPLES
200.El
201.Pp
202The following item is for ICMPv6 MTU option,
203which will be attached to router advertisement header.
204This item can be omitted, then
205.Nm rtadvd
206will use the default value.
207.Bl -tag -width indent

--- 31 unchanged lines hidden (view full) ---

239.Pp
240You can also refer one line from another by using
241.Cm tc
242capability.
243See
244.Xr termcap 5
245for details on the capability.
246.Sh EXAMPLES
247As presented above, all of the advertised parameters have default values
248defined in specifications, and hence you usually do not have to set them
249by hand, unless you need special non-default values.
250It can cause interoperability problem if you use an ill-configured
251parameter.
252.Pp
253To override a configuration parameter, you can specify the parameter alone.
254With the following configuration,
255.Xr rtadvd 8
256overrides the router lifetime parameter for the
257.Li ne0
258interface.
241.Bd -literal -offset
259.Bd -literal -offset
242#
243# common definitions.
244#
245# Note: All of the following parameters have default values defined
246# in specifications, and hence you usually do not have to set them
247# by hand unless you need special non-default values.
248#
249# You even do not need to create the configuration file. rtadvd
250# would usually work well without a configuration file.
251# See also: rtadvd(8)
252
253#default:\\
254# :chlim#64:raflags#0:rltime#1800:rtime#30000:retrans#1000:\\
255# :pinfoflags#192:vltime#3600000:pltime#3600000:mtu#1500:
256#ether:\\
257# :mtu#1500:tc=default:
258
259# per-interface definitions.
260# Mainly IPv6 prefixes are configured in this part. However, rtadvd
261# automatically learns appropriate prefixes from the kernel's routing
262# table, and advertises the prefixes, so you don't have to configure
263# this part, either.
264# If you don't want the automatic advertisement, invoke rtadvd with
265# the -s option and configure this part by hand.
266
267#ef0:\\
268# :addrs#1:addr="3ffe:501:4819:1000::":prefixlen#64:tc=ether:
269
260ne0:\\
261 :rltime#0:
270.Ed
262.Ed
263.Pp
264The following example manually configures prefixes advertised from the
265.Li ef0
266interface.
267The configuration must be used with the
268.Fl s
269option to
270.Xr rtadvd 8 .
271.Bd -literal -offset
272ef0:\\
273 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64:
274.Ed
275.Pp
276The following example presents the default values in an explicit manner.
277The configuration is provided just for reference purposes;
278YOU DO NOT NEED TO HAVE IT AT ALL.
279.Bd -literal -offset
280default:\\
281 :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\
282 :pinfoflags#192:vltime#2592000:pltime#604800:mtu#0:
283ef0:\\
284 :addrs#1:addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default:
285.Ed
271.Sh SEE ALSO
272.Xr termcap 5 ,
273.Xr rtadvd 8 ,
274.Xr rtsol 8
275.Pp
276Thomas Narten, Erik Nordmark and W. A. Simpson,
277.Do
278Neighbor Discovery for IP version 6 (IPv6)
279.Dc ,
280RFC 2461
281.Sh HISTORY
282The
283.Xr rtadvd 8
284and the configuration file
285.Nm
286first appeared in WIDE Hydrangea IPv6 protocol stack kit.
287.\" .Sh BUGS
288.\" (to be written)
286.Sh SEE ALSO
287.Xr termcap 5 ,
288.Xr rtadvd 8 ,
289.Xr rtsol 8
290.Pp
291Thomas Narten, Erik Nordmark and W. A. Simpson,
292.Do
293Neighbor Discovery for IP version 6 (IPv6)
294.Dc ,
295RFC 2461
296.Sh HISTORY
297The
298.Xr rtadvd 8
299and the configuration file
300.Nm
301first appeared in WIDE Hydrangea IPv6 protocol stack kit.
302.\" .Sh BUGS
303.\" (to be written)