1.\" $KAME: rtadvd.conf.5,v 1.8 2000/10/25 05:37:43 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 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the project nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 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.\" 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 39This file describes how the router advertisement packet must be constructed 40for each of the interfaces. 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 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. 57Lines may be concatenated by 58.Sq \e 59character. 60The comment marker is the 61.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. 69You are therefore encouraged to read IETF neighbor discovery documents 70if you would like to modify the sample configuration file. 71.Pp 72As explained above, note 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 92.Ic maxinterval. 93Its value must be no less than 3 seconds and no greater than .75 * 94the value of 95.Ic 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 104.It Cm \&chlim 105(num) The value for Cur Hop Limit field. 106The default value is 64. 107.It Cm \&raflags 108(num) Flags field in router advertisement message header. 109Bit 7 110.Po 111.Li 0x80 112.Pc 113means Managed address configuration flag bit, 114and Bit 6 115.Po 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. 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 . 132The default value is 0, which means unspecified by this router. 133.El 134.Pp 135The following items are for ICMPv6 prefix information option, 136which will be attached to router advertisement header. 137These items can be omitted, then 138.Nm rtadvd 139will automatically get appropriate prefixes from the kernel's routing table, 140and advertise the prefixes with the default parameters. 141.Bl -tag -width indent 142.It Cm \&addrs 143(num) Number of prefixes. 144Its default is 0, so it must explicitly be set to positve values 145if you want to specify any prefix information option. 146If its value is 0, 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 155.Ic 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 164.Po 165.Li 0x80 166.Pc 167means On-link flag bit, 168and Bit 6 169.Po 170.Li 0x40 171.Pc 172means Autonomous address-configuration flag bit. 173The default value is 0xc0, i.e., both bits are set. 174.It Cm \&addr 175(str) The address filled into Prefix field. 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 184.Ic addrs 185is more than 0. 186.It Cm \&vltime 187(num) Valid lifetime field 188.Pq unit: seconds . 189The default value is 2592000(30 days). 190.It Cm \&pltime 191(num) Preferred lifetime field 192.Pq unit: seconds . 193The 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 202.It Cm \&mtu 203(num or str) MTU (maximum transmission unit) field. 204If 0 is specified, it means that the option will not be included. 205The default value is 0. 206If the special string 207.Dq auto 208is specified for this item, MTU option will be included and its value 209will be set to the interface MTU automatically. 210.El 211.Pp 212The following item controls ICMPv6 source link-layer address option, 213which will be attached to router advertisement header. 214As noted above, you can just omit the item, then 215.Nm rtadvd 216will use the default value. 217.Bl -tag -width indent 218.It Cm \&nolladdr 219(bool) By default 220.Po 221if 222.Cm \&nolladdr 223is not specified 224.Pc , 225.Xr rtadvd 8 226will try to get link-layer address for the interface from the kernel, 227and attach that in source link-layer address option. 228If this capability exists, 229.Xr rtadvd 8 230will not attach source link-layer address option to 231router advertisement packets. 232.El 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 241.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 270.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) 289