fw: rename n-silent-timeouts to max-timeouts in AsfStrategy
Change-Id: Ie2790a4e1fd545aacf8b297d7ec33b204f2cdbfc
diff --git a/docs/manpages/nfd-asf-strategy.rst b/docs/manpages/nfd-asf-strategy.rst
index 7d84607..d168b2a 100644
--- a/docs/manpages/nfd-asf-strategy.rst
+++ b/docs/manpages/nfd-asf-strategy.rst
@@ -1,46 +1,54 @@
nfd-asf-strategy
================
-SYNOPSIS
+Synopsis
--------
-| nfdc strategy set prefix <PREFIX> strategy /localhost/nfd/strategy/asf[/v=4][/probing-interval~<PROBING-INTERVAL>][/n-silent-timeouts~<N-SILENT-TIMEOUTS>]
-DESCRIPTION
+**nfdc strategy set** **prefix** *NAME* **strategy**
+/localhost/nfd/strategy/asf[/v=4][/**probing-interval**\ ~\ *INTERVAL*][/**max-timeouts**\ ~\ *TIMEOUTS*]
+
+Description
-----------
-ASF is an Adaptive Smoothed RTT-based Forwarding Strategy that chooses the best next hop based on SRTT measurement, and also periodically probes other next hops to learn their RTTs.
+**ASF** is an Adaptive Smoothed RTT-based Forwarding Strategy that chooses the
+best next hop based on SRTT measurements, and also periodically probes other
+next hops to learn their RTTs.
-OPTIONS
+Options
-------
-<PROBING-INTERVAL>
- Tells ASF how often to send a probe to determine alternative paths.
- The value is specified in milliseconds (non-negative integer)
- Lower value means high overhead but faster reaction.
- Default value is 1 minute and minimum value is 1 second.
- It is optional to specify probing-interval.
-<N-SILENT-TIMEOUTS>
- ASF switches immediately to another appropriate face (if available) upon timeout.
- This behavior may be too sensitive for application use and appropriate only for link
- failures and not transient timeouts. So this parameter makes ASF switch paths
- only after it has encountered the specified number of timeouts (non-negative integer).
- Default and minimum value is 0, i.e., switch immediately.
- It is optional to specify n-silent-timeouts.
+.. option:: probing-interval
-EXAMPLES
+ This optional parameter tells ASF how often to send a probe to determine
+ alternative paths. The value is specified in milliseconds (non-negative
+ integer). Smaller values will result in higher overhead but faster reaction.
+ The default value is 1 minute and the minimum value is 1 second.
+
+.. option:: max-timeouts
+
+ This optional parameter makes ASF switch to another appropriate face (if available)
+ after it has encountered the specified number of timeouts. The value is a positive
+ integer and defaults to 3, i.e., switch to another face after 3 timeouts. Smaller
+ values make ASF more sensitive to timeouts and will switch paths more frequently,
+ which should provide a faster reaction to link failures. Larger values may be better
+ suited when transient timeouts are common and for certain application uses.
+
+Examples
--------
+
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf
- Use the default values.
+ Use the default values for all parameters.
nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000
- Set probing interval as 30 seconds.
+ Set probing interval to 30 seconds.
-nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/n-silent-timeouts~5
- Set n-silent-timeouts as 5.
+nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/max-timeouts~5
+ Set max timeouts to 5.
-nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000/n-silent-timeouts~5
- Set probing interval as 30 seconds and n-silent-timeouts as 5.
+nfdc strategy set prefix /ndn strategy /localhost/nfd/strategy/asf/v=4/probing-interval~30000/max-timeouts~2
+ Set probing interval to 30 seconds and max timeouts to 2.
-SEE ALSO
+See also
--------
+
nfdc(1), nfdc-strategy(1)