1.\" $KAME: rtadvd.conf.5,v 1.5 2000/05/22 22:22:56 itojun 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. 41.Pp 42It obeys the famous 43.Xr termcap 5 44file format. 45Each line in the file describes a network interface. 46Fields are separated by a colon 47.Pq Sq \&: , 48and each field contains one capability description. 49Lines may be concatenated by 50.Sq \e 51character. 52The comment marker is the 53.Sq \# 54character. 55.Pp 56.Sh CAPABILITIES 57Capabilities describe the value to be filled into ICMPv6 router 58advertisement messages and to control 59.Xr rtadvd 8 60behavior. 61Therefore, you are encouraged to read IETF neighbor discovery documents 62if you would like to modify the sample configuration file. 63.Pp 64Note that almost all items have default values. 65If you omit an item, the default value of the item will be used. 66.Pp 67There are two items which control the interval of sending router advertisements. 68.Bl -tag -width indent 69.It Cm \&maxinterval 70(num) The maximum time allowed between sending unsolicited 71multicast router advertisements 72.Pq unit: seconds . 73The default value is 600. 74Its value must be no less than 4 seconds 75and no greater than 1800 seconds. 76.It Cm \&mininterval 77(num) The minimum time allowed between sending unsolicited multicast 78router advertisements 79.Pq unit: seconds . 80The default value is the one third of value of 81.Ic maxinterval. 82Its value must be no less than 3 seconds and no greater than .75 * 83the value of 84.Ic maxinterval. 85.El 86.Pp 87The following items are for ICMPv6 router advertisement message 88header. 89.Bl -tag -width indent 90.It Cm \&chlim 91(num) The value for Cur Hop Limit field. 92The default value is 64. 93.It Cm \&raflags 94(num) Flags field in router advertisement message header. 95Bit 7 96.Po 97.Li 0x80 98.Pc 99means Managed address configuration flag bit, 100and Bit 6 101.Po 102.Li 0x40 103.Pc 104means Other stateful configuration flag bit. 105The default value is 0. 106.It Cm \&rltime 107(num) Router lifetime field 108.Pq unit: seconds . 109Its value must be no greater than 3600000. 110The default value is 1800. 111.It Cm \&rtime 112(num) Reachable time field 113.Pq unit: milliseconds . 114The default value is 0, which means unspecified by this router. 115.It Cm \&retrans 116(num) Retrans Timer field 117.Pq unit: milliseconds . 118The default value is 0, which means unspecified by this router. 119.El 120.Pp 121The following items are for ICMPv6 prefix information option, 122which will be attached to router advertisement header. 123.Bl -tag -width indent 124.It Cm \&addrs 125(num) Number of prefixes. 126Its default is 0, so it must explicitly be set to positve values 127if you want to specify any prefix information option. 128If its value is 0, 129.Xr rtadvd 8 130looks up the system routing table and 131advertise the prefixes corresponding to interface routes 132on the interface. 133If its value is more than 1, you must specify the index of the prefix 134for each item below. 135Indices vary from 0 to N-1, where N is the 136value of 137.Ic addrs . 138Each index shall follow the name of each item, e.g., 139.Dq prefixlen2 . 140.It Cm \&prefixlen 141(num) Prefix length field. 142The default value is 64. 143.It Cm \&pinfoflags 144(num) Flags field in prefix information option. 145Bit 7 146.Po 147.Li 0x80 148.Pc 149means On-link flag bit, 150and Bit 6 151.Po 152.Li 0x40 153.Pc 154means Autonomous address-configuration flag bit. 155The default value is 0xc0, i.e., both bits are set. 156.It Cm \&addr 157(str) The address filled into Prefix field. 158Since 159.Dq \&: 160is used for 161.Xr termcap 5 162file format as well as IPv6 numeric address, the field MUST be quoted by 163doublequote character. 164This field cannot be 165omitted if the value of 166.Ic addrs 167is more than 0. 168.It Cm \&vltime 169(num) Valid lifetime field 170.Pq unit: seconds . 171The default value is 2592000(30 days). 172.It Cm \&pltime 173(num) Preferred lifetime field 174.Pq unit: seconds . 175The default value is 604800(7 days). 176.El 177.Pp 178The following items are for ICMPv6 MTU option, 179which will be attached to router advertisement header. 180.Bl -tag -width indent 181.It Cm \&mtu 182(num or str) MTU (maximum transmission unit) field. 183If 0 is specified, it means that the option will not be included. 184The default value is 0. 185If the special string 186.Dq auto 187is specified for this item, MTU option will be included and its value 188will be set to the interface MTU automatically. 189.El 190.Pp 191The following item controls ICMPv6 source link-layer address option, 192which will be attached to router advertisement header. 193.Bl -tag -width indent 194.It Cm \&nolladdr 195(bool) By default 196.Po 197if 198.Cm \&nolladdr 199is not specified 200.Pc , 201.Xr rtadvd 8 202will try to get link-layer address for the interface from the kernel, 203and attach that in source link-layer address option. 204If this capability exists, 205.Xr rtadvd 8 206will not attach source link-layer address option to 207router advertisement packets. 208.El 209.Pp 210The following item controls ICMPV6 home agent information option, 211which was defined with mobile IPv6 support. 212It will be attached to router advertisement header just like other options do. 213.Bl -tag -width indent 214.It Cm \&hapref 215(num) Specifies home agent preference. 216If set to non-zero, 217.Cm \&hatime 218must be present as well. 219.It Cm \&hatime 220(num) Specifies home agent lifetime. 221.El 222.Pp 223When mobile IPv6 support is turned on for 224.Xr rtadvd 8 , 225advertisement interval option will be attached to router advertisement 226packet, by configuring 227.Cm \&maxinterval 228explicitly. 229.Pp 230You can also refer one line from another by using 231.Cm tc 232capability. 233See 234.Xr termcap 5 235for details on the capability. 236.Sh EXAMPLE 237.Bd -literal -offset 238# 239# common definitions. 240# 241default:\\ 242 :raflags#0:rltime#3600:\\ 243 :pinfoflags#64:vltime#360000:pltime#360000:mtu#1500: 244ether:\\ 245 :mtu#1280:tc=default: 246 247# 248# interfaces. 249# 250ef0:\\ 251 :addrs#1:\\ 252 :addr="3ffe:501:4819:1000::":tc=ether: 253ef1:\\ 254 :addrs#2:addr0="3ffe:501:4819:2000::":\\ 255 :addr1="3ffe:501:4819:3000::":tc=ether: 256 257.Ed 258.Sh SEE ALSO 259.Xr termcap 5 , 260.Xr rtadvd 8 , 261.Xr rtsol 8 262.Pp 263Thomas Narten, Erik Nordmark and W. A. Simpson, 264.Do 265Neighbor Discovery for IP version 6 (IPv6) 266.Dc , 267RFC 2461 268.Sh HISTORY 269The 270.Xr rtadvd 8 271and the configuration file 272.Nm 273first appeared in WIDE Hydrangea IPv6 protocol stack kit. 274.\" .Sh BUGS 275.\" (to be written) 276