- Sync with latest manpage of rtadvd.

- Ripped MIP6 related description out.  MIP6 is not merged, yet.

Obtained from:	KAME Project

2 files changed, 70 insertions, 55 deletions

diff --git a/usr.sbin/rtadvd/rtadvd.8 b/usr.sbin/rtadvd/rtadvd.8
index 5f1f91b..a0c7bf2 100644
--- a/usr.sbin/rtadvd/rtadvd.8
+++ b/usr.sbin/rtadvd/rtadvd.8
@@ -1,4 +1,4 @@
-.\"	$KAME: rtadvd.8,v 1.8 2000/05/22 22:12:11 itojun Exp $
+.\"	$KAME: rtadvd.8,v 1.9 2000/05/27 13:37:01 jinmei Exp $
 .\"
 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 .\" All rights reserved.
@@ -38,22 +38,22 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl c Ar configfile
-.Op Fl dDfmRs
+.Op Fl dDfRs
 .Ar interface ...
 .Sh DESCRIPTION
 .Nm
-advertises router advertisement packet to the specified
+sends router advertisement packets to the specified
 .Ar interfaces .
 .Pp
 The program will daemonize itself on invocation.
-It will then periodically send router advertisement packets, as well
+It will then send router advertisement packets periodically, as well
 as in response to router solicitation messages sent by end hosts.
 .Pp
 Router advertisements can be configured on a per-interface basis, as
 described in
 .Xr rtadvd.conf 5 .
 .Pp
-In the event of no configuration file entry for an interface,
+If there is no configuration file entry for an interface,
 or if the configuration file does not exist altogether,
 .Nm
 sets all the parameters to their default values.
@@ -71,8 +71,8 @@ specified by the configuration file,
 adds/deletes the corresponding prefix to/from its advertising list,
 respectively.
 The
-.Ic Fl s
-may be used to disable this behavior.
+.Fl s
+option may be used to disable this behavior.
 Moreover, if the status of an advertising interface changes,
 .Nm
 will start or stop sending router advertisements according
@@ -94,10 +94,10 @@ Print debugging information.
 Even more debugging information is printed.
 .It Fl f
 Foreground mode (useful when debugging).
-.It Fl m
-Enables mobile IPv6 support.
-This changes the content of router advertisement option, as well as
-permitted configuration directives.
+.\".It Fl m
+.\"Enables mobile IPv6 support.
+.\"This changes the content of router advertisement option, as well as
+.\"permitted configuration directives.
 .It Fl R
 Accept router renumbering requests.
 If you enable it, certain IPsec setup is suggested for security reasons.
@@ -110,7 +110,7 @@ Upon receipt of signal
 .Dv SIGUSR1 ,
 .Nm
 will dump the current internal state into
-.Pa /var/run/rtadvd.dump.
+.Pa /var/run/rtadvd.dump .
 .Pp
 Use
 .Dv SIGTERM
@@ -121,18 +121,20 @@ In this case,
 .Nm
 will transmit router advertisement with router lifetime 0
 to all the interfaces
-.Pq according to RFC2461 6.2.5 .
+.Pq in accordance with RFC2461 6.2.5 .
 .Sh RETURN VALUES
-The program exits with 0 on success, and non-zero on failures.
+The
+.Nm
+program exits 0 on success, and >0 on failures.
 .Sh FILES
-.Bl -tag -width /etc/rtadvd.conf -compact
+.Bl -tag -width Pa -compact
 .It Pa /etc/rtadvd.conf
 The default configuration file.
 .It Pa /var/run/rtadvd.pid
-contains pid of the currently running
+contains the pid of the currently running
 .Nm rtadvd .
 .It Pa /var/run/rtadvd.dump
-on which
+in which
 .Nm
 dumps its internal state.
 .El
diff --git a/usr.sbin/rtadvd/rtadvd.conf.5 b/usr.sbin/rtadvd/rtadvd.conf.5
index cc0b63d..53eb0ff 100644
--- a/usr.sbin/rtadvd/rtadvd.conf.5
+++ b/usr.sbin/rtadvd/rtadvd.conf.5
@@ -1,4 +1,4 @@
-.\"	$KAME: rtadvd.conf.5,v 1.5 2000/05/22 22:22:56 itojun Exp $
+.\"	$KAME: rtadvd.conf.5,v 1.8 2000/10/25 05:37:43 jinmei Exp $
 .\"
 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 .\" All rights reserved.
@@ -38,6 +38,14 @@
 .Sh DESCRIPTION
 This file describes how the router advertisement packet 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
@@ -58,13 +66,16 @@ 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
+You are therefore 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.
+As explained above, 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
@@ -86,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.
@@ -120,6 +134,10 @@ 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 \&addrs
 (num) Number of prefixes.
@@ -175,8 +193,11 @@ The default value is 2592000(30 days).
 The default value is 604800(7 days).
 .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.
@@ -190,6 +211,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
@@ -207,26 +231,6 @@ 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.
@@ -238,21 +242,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