Skip to content
Browse files

- documented default values of each parameter

- more documented how each parameter works
  • Loading branch information...
1 parent e34fe37 commit 3889380ca23a2093046fd46797466e1570ce5a9c jinmei committed
Showing with 52 additions and 3 deletions.
  1. +52 −3 kame/kame/pim6sd/pim6sd.conf.5
View
55 kame/kame/pim6sd/pim6sd.conf.5
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: pim6sd.conf.5,v 1.4 1999/10/29 12:12:26 jinmei Exp $
+.\" $Id: pim6sd.conf.5,v 1.5 1999/11/11 22:46:25 jinmei Exp $
.\"
.Dd Oct 6, 1999
.Dt PIM6SD.CONF 5
@@ -116,9 +116,10 @@ assert message on the interface.
Specifies a default preference value when sending a PIM assert message.
Preferences are used by assert elections to determine upstream routers.
Currently
-.Nm
+.Nm pim6sd
cannot reliably obtain preferences and metrics from the
unicast routing protocols, so a default value may be configured.
+The default preference is 1024.
.\"
.It Ic default_source_metric Ar metric;
Specifies a default metric value when sending a PIM assert message.
@@ -130,6 +131,7 @@ consulted. However, default metrics may also be set and will default to
.Ic granularity Ar second;
.Xc
Specifies timer granularity in seconds.
+The default value is 5.
.\"
.It Xo
.Ic hello_period Ar period Ar coef;
@@ -142,6 +144,8 @@ the holdtime will be
.Ar period
*
.Ar coef .
+The default values of the period and the timer are 30 and 105,
+respectively.
.\"
.It Xo
.Ic join_prune_period Ar period Ar coef;
@@ -154,11 +158,15 @@ the holdtime will be
.Ar period
*
.Ar coef .
+The default values of the period and the timer are 60 and 210,
+respectively.
.\"
.It Xo
.Ic data_timeout Ar timer;
.Xc
-Specifies the time after which (S,G) state for a silent source will be deleted.
+Specifies the time after which (S,G) state for a silent source will be
+deleted.
+The default value is 210.
.\"
.It Xo
.Ic register_suppression_timeout Ar interval;
@@ -166,6 +174,7 @@ Specifies the time after which (S,G) state for a silent source will be deleted.
.Ar Interval
specifies the interval between receiving a Register-Stop and allowing
PIM Register to be send again.
+The default value is 60.
.\"
.It Xo
.Ic probe_time Ar timer;
@@ -174,6 +183,7 @@ PIM Register to be send again.
specifies the time between sending a null Register and the
Register-Suppression-Timer expiring unless it is restarted by
receiving a Register-Stop.
+The default value is 5.
.\"
.It Xo
.Ic assert_timeout Ar interval;
@@ -181,6 +191,7 @@ receiving a Register-Stop.
.Ar Interval
specifies the interval between the last time an Assert is received and
the time at which the assert is timeout.
+The default value is 180.
.\"
.It Xo
.Ic cand_rp
@@ -194,6 +205,20 @@ It is recommended to specify
.Ic cand_rp
only in typical usage.
All other parameters are optional and will be set automatically.
+If an
+.Ar interface
+is specified,
+.Nm pim6sd
+will search for a global address on the specified interface
+and set the address in Candidate RP Advertisements.
+An optional parameter
+.Ic time
+specifies the interval of two succeeding advertisements in seconds.
+Its default value is 60.
+Another optional parameter
+.Ic priority
+specifies the priority of the RP.
+The default value is 0, which means the highest priority.
.\"
.It Xo
.Ic group_prefix Ar prefix;
@@ -214,18 +239,42 @@ It is recommended to specify
.Ic cand_bootstrap_router
only in typical usage.
All other parameters are optional and will be set automatically.
+If an
+.Ar interface
+is specified,
+.Nm pim6sd
+will search for a global address on the specified interface
+and set the address in Bootstrap messages.
+An optional parameter
+.Ic time
+specifies the interval of two succeeding bootstraps in seconds.
+Its default value is 60.
+Another optional parameter
+.Ic priority
+specifies the priority of the RP.
+The default value is 0, which means the lowest priority.
.\"
.It Xo
.Ic switch_register_threshold Ic rate Ar rate Ic interval Ar interval;
.Xc
Specifies the threshold that a Rendezvous Point(RP) switches to a shortest
path tree, which is valid only when acting as an RP.
+.Ic rate
+specifies the threshold in bits per second, and
+.Ic interval
+specifies the interval of checking the rate in seconds.
+The default values are 50000 and 20, respectively.
\"
.It Xo
.Ic switch_data_threshold Ic rate Ar rate Ic interval Ar interval;
.Xc
Specifies the threshold that a last hop router switches to a shortest
path tree.
+.Ic rate
+specifies the threshold in bits per second, and
+.Ic interval
+specifies the interval of checking the rate in seconds.
+The default values are 50000 and 20, respectively.
.El
.\"
.Sh EXAMPLE

0 comments on commit 3889380

Please sign in to comment.
Something went wrong with that request. Please try again.