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.561
1 files changed, 43 insertions, 18 deletions
diff --git a/usr.sbin/rtadvd/rtadvd.conf.5 b/usr.sbin/rtadvd/rtadvd.conf.5
index 5d1fed2..cc0b63d 100644
--- a/usr.sbin/rtadvd/rtadvd.conf.5
+++ b/usr.sbin/rtadvd/rtadvd.conf.5
@@ -1,3 +1,5 @@
+.\" $KAME: rtadvd.conf.5,v 1.5 2000/05/22 22:22:56 itojun Exp $
+.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
.\"
@@ -25,49 +27,51 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: rtadvd.conf.5,v 1.1.1.1 1999/08/08 23:31:42 itojun Exp $
-.\" $FreeBSD$
+.\" $FreeBSD$
.\"
.Dd May 17, 1998
.Dt RTADVD.CONF 5
-.Os KAME
+.Os
.Sh NAME
.Nm rtadvd.conf
.Nd config file for router advertisement daemon
.Sh DESCRIPTION
-The file describes how the router advertisement packet must be constructed
+This file describes how the router advertisement packet must be constructed
for each of the interfaces.
.Pp
-It obeys famous
+It obeys the famous
.Xr termcap 5
file format.
Each line in the file describes a network interface.
Fields are separated by a colon
-.Po
-.Dq \&:
-.Pc ,
+.Pq Sq \&: ,
and each field contains one capability description.
-Lines may be concatenated by \e character.
-The comment marker is `#' character.
+Lines may be concatenated by
+.Sq \e
+character.
+The comment marker is the
+.Sq \#
+character.
.Pp
.Sh CAPABILITIES
Capabilities describe the value to be filled into ICMPv6 router
-advertisement message and to control
+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 sample configuration file.
+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 to control interval of sending router advertisements.
+There are two items which control the interval of sending router advertisements.
.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
+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
@@ -130,8 +134,8 @@ If its value is more than 1, you must specify the index of the prefix
for each item below.
Indices vary from 0 to N-1, where N is the
value of
-.Ic addrs.
-Each index shall follows the name of each item, e.g.
+.Ic addrs .
+Each index shall follow the name of each item, e.g.,
.Dq prefixlen2 .
.It Cm \&prefixlen
(num) Prefix length field.
@@ -148,7 +152,7 @@ and Bit 6
.Li 0x40
.Pc
means Autonomous address-configuration flag bit.
-The default value is 0xc0, i.e. both bits are set.
+The default value is 0xc0, i.e., both bits are set.
.It Cm \&addr
(str) The address filled into Prefix field.
Since
@@ -177,7 +181,8 @@ which will be attached to router advertisement header.
.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
+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.
@@ -202,6 +207,26 @@ 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
You can also refer one line from another by using
.Cm tc
capability.
OpenPOWER on IntegriCloud