summaryrefslogtreecommitdiffstats
path: root/usr.sbin/rtadvd/rtadvd.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/rtadvd/rtadvd.conf.5')
-rw-r--r--usr.sbin/rtadvd/rtadvd.conf.5427
1 files changed, 0 insertions, 427 deletions
diff --git a/usr.sbin/rtadvd/rtadvd.conf.5 b/usr.sbin/rtadvd/rtadvd.conf.5
deleted file mode 100644
index dcc73cc..0000000
--- a/usr.sbin/rtadvd/rtadvd.conf.5
+++ /dev/null
@@ -1,427 +0,0 @@
-.\" $KAME: rtadvd.conf.5,v 1.50 2005/01/14 05:30:59 jinmei Exp $
-.\"
-.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\" 3. Neither the name of the project nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" $FreeBSD$
-.\"
-.Dd May 17, 1998
-.Dt RTADVD.CONF 5
-.Os
-.Sh NAME
-.Nm rtadvd.conf
-.Nd config file for router advertisement daemon
-.Sh DESCRIPTION
-This file describes how the router advertisement packets must be constructed
-for each of the interfaces.
-.Pp
-As described in
-.Xr rtadvd 8 ,
-you do not have to set this configuration file up at all,
-unless you need some special configurations.
-You may even omit the file as a whole.
-In such cases, the
-.Nm rtadvd
-daemon will automatically configure itself using default values
-specified in the specification.
-.Pp
-It obeys the famous
-.Xr termcap 5
-file format.
-Each line in the file describes a network interface.
-Fields are separated by a colon
-.Pq Sq \&: ,
-and each field contains one capability description.
-Lines may be concatenated by the
-.Sq \e
-character.
-The comment marker is the
-.Sq \&#
-character.
-.Sh CAPABILITIES
-Capabilities describe the value to be filled into ICMPv6 router
-advertisement messages and to control
-.Xr rtadvd 8
-behavior.
-Therefore, you are encouraged to read IETF neighbor discovery documents
-if you would like to modify the sample configuration file.
-.Pp
-Note that almost all items have default values.
-If you omit an item, the default value of the item will be used.
-.Pp
-There are two items which control the interval of sending router advertisements.
-These items can be omitted, then
-.Nm rtadvd
-will use the default values.
-.Bl -tag -width indent
-.It Cm \&maxinterval
-(num) The maximum time allowed between sending unsolicited
-multicast router advertisements
-.Pq unit: seconds .
-The default value is 600.
-Its value must be no less than 4 seconds
-and no greater than 1800 seconds.
-.It Cm \&mininterval
-(num) The minimum time allowed between sending unsolicited multicast
-router advertisements
-.Pq unit: seconds .
-The default value is the one third of value of
-.Cm maxinterval .
-Its value must be no less than 3 seconds and no greater than .75 *
-the value of
-.Cm maxinterval .
-.El
-.Pp
-The following items are for ICMPv6 router advertisement message
-header.
-These items can be omitted, then
-.Nm rtadvd
-will use the default values.
-.Bl -tag -width indent
-.It Cm \&chlim
-(num) The value for Cur Hop Limit field.
-The default value is 64.
-.It Cm \&raflags
-(str or num) A 8-bit flags field in router advertisement message header.
-This field can be specified either as a case-sensitive string or as an
-integer.
-A sting consists of characters each of which corresponds to a
-particular flag bit(s).
-An integer should be the logical OR of all enabled bits.
-Bit 7
-.Po
-.Li 'm' or 0x80
-.Pc
-means Managed address configuration flag bit,
-and Bit 6
-.Po
-.Li 'o' or 0x40
-.Pc
-means Other stateful configuration flag bit.
-Bit 4
-.Po
-.Li 0x10
-.Pc
-and Bit 3
-.Po
-.Li 0x08
-.Pc
-are used to encode router preference.
-Bits 01
-.Po
-or 'h'
-.Pc
-means high, 00 means medium, and 11
-.Po
-or 'l'
-.Pc
-means low.
-Bits 10 is reserved, and must not be specified.
-There is no character to specify the medium preference explicitly.
-The default value of the entire flag is 0
-.Po
-or a null string,
-.Pc
-which means no additional
-configuration methods, and the medium router preference.
-.It Cm \&rltime
-(num) Router lifetime field
-.Pq unit: seconds .
-The value must be either zero or between
-the value of
-.Cm maxinterval
-and 9000.
-When
-.Nm rtadvd
-runs on a host, this value must explicitly set 0 on all the
-advertising interfaces as described in
-.Xr rtadvd 8 .
-The default value is 1800.
-.It Cm \&rtime
-(num) Reachable time field
-.Pq unit: milliseconds .
-The default value is 0, which means unspecified by this router.
-.It Cm \&retrans
-(num) Retrans Timer field
-.Pq unit: milliseconds .
-The default value is 0, which means unspecified by this router.
-.El
-.Pp
-The following items are for ICMPv6 prefix information option,
-which will be attached to router advertisement header.
-These items can be omitted, then
-.Nm rtadvd
-will automatically get appropriate prefixes from the kernel's routing table,
-and advertise the prefixes with the default parameters.
-Keywords other than
-.Cm clockskew
-can be augmented with a number, like
-.Dq Li prefix2 ,
-to specify multiple prefixes.
-.Bl -tag -width indent
-.It Cm \&clockskew
-(num) Time skew to adjust link propagation delays and clock skews
-between routers on the link
-.Pq unit: seconds .
-This value is used in consistency check for locally-configured and
-advertised prefix lifetimes, and has its meaning when the local router
-configures a prefix on the link with a lifetime that decrements in
-real time.
-If the value is 0, it means the consistency check will be skipped
-for such prefixes.
-The default value is 0.
-.It Cm \&prefixlen
-(num) Prefix length field.
-The default value is 64.
-.It Cm \&pinfoflags
-(str or num) A 8-bit flags field in prefix information option.
-This field can be specified either as a case-sensitive string or as an
-integer.
-A sting consists of characters each of which corresponds to a
-particular flag bit(s).
-An integer should be the logical OR of all enabled bits.
-Bit 7
-.Po
-.Li 'l' or 0x80
-.Pc
-means On-link flag bit,
-and Bit 6
-.Po
-.Li 'a' or 0x40
-.Pc
-means Autonomous address-configuration flag bit.
-The default value is "la" or 0xc0, i.e., both bits are set.
-.It Cm \&addr
-(str) The address filled into Prefix field.
-Since
-.Dq \&:
-is used for
-.Xr termcap 5
-file format as well as IPv6 numeric address, the field MUST be quoted by
-doublequote character.
-.It Cm \&vltime
-(num) Valid lifetime field
-.Pq unit: seconds .
-The default value is 2592000 (30 days).
-.It Cm \&vltimedecr
-(bool) This item means the advertised valid lifetime will decrement
-in real time, which is disabled by default.
-.It Cm \&pltime
-(num) Preferred lifetime field
-.Pq unit: seconds .
-The default value is 604800 (7 days).
-.It Cm \&pltimedecr
-(bool) This item means the advertised preferred lifetime will decrement
-in real time, which is disabled by default.
-.El
-.Pp
-The following item is for ICMPv6 MTU option,
-which will be attached to router advertisement header.
-This item can be omitted, then
-.Nm rtadvd
-will use the default value.
-.Bl -tag -width indent
-.It Cm \&mtu
-(num or str) MTU (maximum transmission unit) field.
-If 0 is specified, it means that the option will not be included.
-The default value is 0.
-If the special string
-.Dq auto
-is specified for this item, MTU option will be included and its value
-will be set to the interface MTU automatically.
-.El
-.Pp
-The following item controls ICMPv6 source link-layer address option,
-which will be attached to router advertisement header.
-As noted above, you can just omit the item, then
-.Nm rtadvd
-will use the default value.
-.Bl -tag -width indent
-.It Cm \&nolladdr
-(bool) By default
-.Po
-if
-.Cm \&nolladdr
-is not specified
-.Pc ,
-.Xr rtadvd 8
-will try to get link-layer address for the interface from the kernel,
-and attach that in source link-layer address option.
-If this capability exists,
-.Xr rtadvd 8
-will not attach source link-layer address option to
-router advertisement packets.
-.El
-.Pp
-The following item controls ICMPv6 home agent information option,
-which was defined with mobile IPv6 support.
-It will be attached to router advertisement header just like other options do.
-.Bl -tag -width indent
-.It Cm \&hapref
-(num) Specifies home agent preference.
-If set to non-zero,
-.Cm \&hatime
-must be present as well.
-.It Cm \&hatime
-(num) Specifies home agent lifetime.
-.El
-.Pp
-When mobile IPv6 support is turned on for
-.Xr rtadvd 8 ,
-advertisement interval option will be attached to router advertisement
-packet, by configuring
-.Cm \&maxinterval
-explicitly.
-.Pp
-The following items are for ICMPv6 route information option,
-which will be attached to router advertisement header.
-These items are optional.
-Each items can be augmented with number, like
-.Dq Li rtplen2 ,
-to specify multiple routes.
-.Bl -tag -width indent
-.It Cm \&rtprefix
-(str) The prefix filled into the Prefix field of route information option.
-Since
-.Dq \&:
-is used for
-.Xr termcap 5
-file format as well as IPv6 numeric address, the field MUST be quoted by
-doublequote character.
-.It Cm \&rtplen
-(num) Prefix length field in route information option.
-The default value is 64.
-.It Cm \&rtflags
-(str or num) A 8-bit flags field in route information option.
-Currently only the preference values are defined.
-The notation is same as that of the raflags field.
-Bit 4
-.Po
-.Li 0x10
-.Pc
-and
-Bit 3
-.Po
-.Li 0x08
-.Pc
-are used to encode the route preference for the route.
-The default value is 0x00, i.e., medium preference.
-.It Cm \&rtltime
-(num) route lifetime field in route information option.
-.Pq unit: seconds .
-Since the specification does not define the default value of this
-item, the value for this item should be specified by hand.
-However,
-.Nm rtadvd
-allows this item to be unspecified, and uses the router lifetime
-as the default value in such a case, just for compatibility with an
-old version of the program.
-.El
-.Pp
-In the above list, each keyword beginning with
-.Dq Li rt
-could be replaced with the one beginning with
-.Dq Li rtr
-for backward compatibility reason.
-For example,
-.Cm rtrplen
-is accepted instead of
-.Cm rtplen .
-However, keywords that start with
-.Dq Li rtr
-have basically been obsoleted, and should not be used any more.
-.Pp
-You can also refer one line from another by using
-.Cm tc
-capability.
-See
-.Xr termcap 5
-for details on the capability.
-.Sh EXAMPLES
-As presented above, all of the advertised parameters have default values
-defined in specifications, and hence you usually do not have to set them
-by hand, unless you need special non-default values.
-It can cause interoperability problem if you use an ill-configured
-parameter.
-.Pp
-To override a configuration parameter, you can specify the parameter alone.
-With the following configuration,
-.Xr rtadvd 8
-overrides the router lifetime parameter for the
-.Li ne0
-interface.
-.Bd -literal -offset
-ne0:\\
- :rltime#0:
-.Ed
-.Pp
-The following example manually configures prefixes advertised from the
-.Li ef0
-interface.
-The configuration must be used with the
-.Fl s
-option to
-.Xr rtadvd 8 .
-.Bd -literal -offset
-ef0:\\
- :addr="3ffe:501:ffff:1000::":prefixlen#64:
-.Ed
-.Pp
-The following example presents the default values in an explicit manner.
-The configuration is provided just for reference purposes;
-YOU DO NOT NEED TO HAVE IT AT ALL.
-.Bd -literal -offset
-default:\\
- :chlim#64:raflags#0:rltime#1800:rtime#0:retrans#0:\\
- :pinfoflags="la":vltime#2592000:pltime#604800:mtu#0:
-ef0:\\
- :addr="3ffe:501:ffff:1000::":prefixlen#64:tc=default:
-.Ed
-.Sh SEE ALSO
-.Xr termcap 5 ,
-.Xr rtadvd 8 ,
-.Xr rtsol 8
-.Rs
-.%A Thomas Narten
-.%A Erik Nordmark
-.%A W. A. Simpson
-.%T Neighbor Discovery for IP version 6 (IPv6)
-.%R RFC 2461
-.Re
-.Rs
-.%A Richard Draves
-.%T Default Router Preferences and More-Specific Routes
-.%R draft-ietf-ipngwg-router-selection-xx.txt
-.Re
-.Sh HISTORY
-The
-.Xr rtadvd 8
-and the configuration file
-.Nm
-first appeared in WIDE Hydrangea IPv6 protocol stack kit.
-.\" .Sh BUGS
-.\" (to be written)
OpenPOWER on IntegriCloud