usr.sbin/rtadvd/rtadvd.conf.5

   1 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: rtadvd.conf.5,v 1.1.1.1 1999/08/08 23:31:42 itojun Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd May 17, 1998
  32 .Dt RTADVD.CONF 5
  33 .Os KAME
  34 .Sh NAME
  35 .Nm rtadvd.conf
  36 .Nd config file for router advertisement daemon
  37 .Sh DESCRIPTION
  38 The file describes how the router advertisement packet must be constructed
  39 for each of the interfaces.
  40 .Pp
  41 It obeys famous
  42 .Xr termcap 5
  43 file format.
  44 Each line in the file describes a network interface.
  45 Fields are separated by a colon
  46 .Po
  47 .Dq \&:
  48 .Pc ,
  49 and each field contains one capability description.
  50 Lines may be concatenated by \e character.
  51 The comment marker is `#' character.
  52 .Pp
  53 .Sh CAPABILITIES
  54 Capabilities describe the value to be filled into ICMPv6 router
  55 advertisement message and to control
  56 .Xr rtadvd 8
  57 behavior.
  58 Therefore, you are encouraged to read IETF neighbor discovery documents
  59 if you would like to modify sample configuration file.
  60 .Pp
  61 Note that almost all items have default values.
  62 If you omit an item, the default value of the item will be used.
  63 .Pp
  64 There are two items to control interval of sending router advertisements.
  65 .Bl -tag -width indent
  66 .It Cm \&maxinterval
  67 (num) The maximum time allowed between sending unsolicited
  68 multicast router advertisements
  69 .Pq unit: seconds .
  70 The default value is 600. Its value must be no less than 4 seconds
  71 and no greater than 1800 seconds.
  72 .It Cm \&mininterval
  73 (num) The minimum time allowed between sending unsolicited multicast
  74 router advertisements
  75 .Pq unit: seconds .
  76 The default value is the one third of value of
  77 .Ic maxinterval.
  78 Its value must be no less than 3 seconds and no greater than .75 *
  79 the value of
  80 .Ic maxinterval.
  81 .El
  82 .Pp
  83 The following items are for ICMPv6 router advertisement message
  84 header.
  85 .Bl -tag -width indent
  86 .It Cm \&chlim
  87 (num) The value for Cur Hop Limit field.
  88 The default value is 64.
  89 .It Cm \&raflags
  90 (num) Flags field in router advertisement message header.
  91 Bit 7
  92 .Po
  93 .Li 0x80
  94 .Pc
  95 means Managed address configuration flag bit,
  96 and Bit 6
  97 .Po
  98 .Li 0x40
  99 .Pc
 100 means Other stateful configuration flag bit.
 101 The default value is 0.
 102 .It Cm \&rltime
 103 (num) Router lifetime field
 104 .Pq unit: seconds .
 105 Its value must be no greater than 3600000.
 106 The default value is 1800.
 107 .It Cm \&rtime
 108 (num) Reachable time field
 109 .Pq unit: milliseconds .
 110 The default value is 0, which means unspecified by this router.
 111 .It Cm \&retrans
 112 (num) Retrans Timer field
 113 .Pq unit: milliseconds .
 114 The default value is 0, which means unspecified by this router.
 115 .El
 116 .Pp
 117 The following items are for ICMPv6 prefix information option,
 118 which will be attached to router advertisement header.
 119 .Bl -tag -width indent
 120 .It Cm \&addrs
 121 (num) Number of prefixes.
 122 Its default is 0, so it must explicitly be set to positve values
 123 if you want to specify any prefix information option.
 124 If its value is 0,
 125 .Xr rtadvd 8
 126 looks up the system routing table and
 127 advertise the prefixes corresponding to interface routes
 128 on the interface.
 129 If its value is more than 1, you must specify the index of the prefix
 130 for each item below.
 131 Indices vary from 0 to N-1, where N is the
 132 value of
 133 .Ic addrs.
 134 Each index shall follows the name of each item, e.g.
 135 .Dq prefixlen2 .
 136 .It Cm \&prefixlen
 137 (num) Prefix length field.
 138 The default value is 64.
 139 .It Cm \&pinfoflags
 140 (num) Flags field in prefix information option.
 141 Bit 7
 142 .Po
 143 .Li 0x80
 144 .Pc
 145 means On-link flag bit,
 146 and Bit 6
 147 .Po
 148 .Li 0x40
 149 .Pc
 150 means Autonomous address-configuration flag bit.
 151 The default value is 0xc0, i.e. both bits are set.
 152 .It Cm \&addr
 153 (str) The address filled into Prefix field.
 154 Since
 155 .Dq \&:
 156 is used for
 157 .Xr termcap 5
 158 file format as well as IPv6 numeric address, the field MUST be quoted by
 159 doublequote character.
 160 This field cannot be
 161 omitted if the value of
 162 .Ic addrs
 163 is more than 0.
 164 .It Cm \&vltime
 165 (num) Valid lifetime field
 166 .Pq unit: seconds .
 167 The default value is 2592000(30 days).
 168 .It Cm \&pltime
 169 (num) Preferred lifetime field
 170 .Pq unit: seconds .
 171 The default value is 604800(7 days).
 172 .El
 173 .Pp
 174 The following items are for ICMPv6 MTU option,
 175 which will be attached to router advertisement header.
 176 .Bl -tag -width indent
 177 .It Cm \&mtu
 178 (num or str) MTU (maximum transmission unit) field.
 179 If 0 is specified, it means that the option will not be included.
 180 The default value is 0. If the special string
 181 .Dq auto
 182 is specified for this item, MTU option will be included and its value
 183 will be set to the interface MTU automatically.
 184 .El
 185 .Pp
 186 The following item controls ICMPv6 source link-layer address option,
 187 which will be attached to router advertisement header.
 188 .Bl -tag -width indent
 189 .It Cm \&nolladdr
 190 (bool) By default
 191 .Po
 192 if
 193 .Cm \&nolladdr
 194 is not specified
 195 .Pc ,
 196 .Xr rtadvd 8
 197 will try to get link-layer address for the interface from the kernel,
 198 and attach that in source link-layer address option.
 199 If this capability exists,
 200 .Xr rtadvd 8
 201 will not attach source link-layer address option to
 202 router advertisement packets.
 203 .El
 204 .Pp
 205 You can also refer one line from another by using
 206 .Cm tc
 207 capability.
 208 See
 209 .Xr termcap 5
 210 for details on the capability.
 211 .Sh EXAMPLE
 212 .Bd -literal -offset
 213 #
 214 # common definitions.
 215 #
 216 default:\\
 217         :raflags#0:rltime#3600:\\
 218         :pinfoflags#64:vltime#360000:pltime#360000:mtu#1500:
 219 ether:\\
 220         :mtu#1280:tc=default:
 221
 222 #
 223 # interfaces.
 224 #
 225 ef0:\\
 226         :addrs#1:\\
 227         :addr="3ffe:501:4819:1000::":tc=ether:
 228 ef1:\\
 229         :addrs#2:addr0="3ffe:501:4819:2000::":\\
 230         :addr1="3ffe:501:4819:3000::":tc=ether:
 231
 232 .Ed
 233 .Sh SEE ALSO
 234 .Xr termcap 5 ,
 235 .Xr rtadvd 8 ,
 236 .Xr rtsol 8
 237 .Pp
 238 Thomas Narten, Erik Nordmark and W. A. Simpson,
 239 .Do
 240 Neighbor Discovery for IP version 6 (IPv6)
 241 .Dc ,
 242 RFC 2461
 243 .Sh HISTORY
 244 The
 245 .Xr rtadvd 8
 246 and the configuration file
 247 .Nm
 248 first appeared in WIDE Hydrangea IPv6 protocol stack kit.
 249 .\" .Sh BUGS
 250 .\" (to be written)