summaryrefslogtreecommitdiff
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.592
1 files changed, 73 insertions, 19 deletions
diff --git a/usr.sbin/rtadvd/rtadvd.conf.5 b/usr.sbin/rtadvd/rtadvd.conf.5
index 9db54596a8f..533defa7e7f 100644
--- a/usr.sbin/rtadvd/rtadvd.conf.5
+++ b/usr.sbin/rtadvd/rtadvd.conf.5
@@ -1,5 +1,5 @@
-.\" $OpenBSD: rtadvd.conf.5,v 1.11 2000/12/15 14:31:18 aaron Exp $
-.\" $KAME: rtadvd.conf.5,v 1.6 2000/05/26 10:54:58 jinmei Exp $
+.\" $OpenBSD: rtadvd.conf.5,v 1.12 2001/01/15 11:06:30 itojun Exp $
+.\" $KAME: rtadvd.conf.5,v 1.19 2001/01/15 11:02:26 itojun Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
@@ -37,6 +37,15 @@
.Sh DESCRIPTION
This file describes how the router advertisement packets must be constructed
for each of the interfaces.
+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 to create this file.
+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
@@ -49,7 +58,7 @@ Lines may be concatenated by the
.Sq \e
character.
The comment marker is the
-.Sq \#
+.Sq \&#
character.
.Pp
.Sh CAPABILITIES
@@ -64,6 +73,9 @@ 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
@@ -85,6 +97,9 @@ the value of
.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.
@@ -106,6 +121,11 @@ The default value is 0.
(num) Router lifetime field
.Pq unit: seconds .
Its value must be no greater than 3600000.
+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
@@ -119,7 +139,20 @@ The default value is 0, which means unspecified by this router.
.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.
.Bl -tag -width indent
+.It Cm \&clockskew
+(num) Time skew to adjust link propagation delays and clock skews
+betwen 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 \&addrs
(num) Number of prefixes.
Its default is 0, so it must explicitly be set to positve values
@@ -162,20 +195,29 @@ file format as well as IPv6 numeric address, the field MUST be quoted by
doublequote character.
This field cannot be
omitted if the value of
-.Ic addrs
+.Cm addrs
is more than 0.
.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 decrements
+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 decrements
+in real time, which is disabled by default.
.El
.Pp
-The following items are for ICMPv6 MTU option,
+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.
@@ -189,6 +231,9 @@ will be set to the interface MTU automatically.
.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
@@ -217,21 +262,30 @@ for details on the capability.
#
# common definitions.
#
-default:\\
- :raflags#0:rltime#3600:\\
- :pinfoflags#64:vltime#360000:pltime#360000:mtu#1500:
-ether:\\
- :mtu#1280:tc=default:
-
-#
-# interfaces.
+# Note: All of the following 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.
#
-ef0:\\
- :addrs#1:\\
- :addr="3ffe:501:4819:1000::":tc=ether:
-ef1:\\
- :addrs#2:addr0="3ffe:501:4819:2000::":\\
- :addr1="3ffe:501:4819:3000::":tc=ether:
+# You even do not need to create the configuration file. rtadvd
+# would usually work well without a configuration file.
+# See also: rtadvd(8)
+
+#default:\\
+# :chlim#64:raflags#0:rltime#1800:rtime#30000:retrans#1000:\\
+# :pinfoflags#192:vltime#3600000:pltime#3600000:mtu#1500:
+#ether:\\
+# :mtu#1500:tc=default:
+
+# per-interface definitions.
+# Mainly IPv6 prefixes are configured in this part. However, rtadvd
+# automatically learns appropriate prefixes from the kernel's routing
+# table, and advertises the prefixes, so you don't have to configure
+# this part, either.
+# If you don't want the automatic advertisement, invoke rtadvd with
+# the -s option and configure this part by hand.
+
+#ef0:\\
+# :addrs#1:addr="3ffe:501:4819:1000::":prefixlen#64:tc=ether:
.Ed
.Sh SEE ALSO