Add ability to control route table req frequency

[ric-plt/lib/rmr.git] / docs / rmr_init.3.rst

diff --git a/docs/rmr_init.3.rst b/docs/rmr_init.3.rst
index d229a2a..7ca0de7 100644 (file)
--- a/docs/rmr_init.3.rst
+++ b/docs/rmr_init.3.rst
@@ -198,6 +198,13 @@ variables are used if found.
           case where both variables are defined, RMR will behave
           exactly as is communicated with the variable's values.
 
           case where both variables are defined, RMR will behave
           exactly as is communicated with the variable's values.
 

+      * - **RMR_RTREQ_FREQ**
+        -
+          When RMR needs a new route table it will send a request once
+          every ``n`` seconds. The default value for ``n`` is 5, but
+          can be changed if this variable is set prior to invoking the
+          process. Accepted values are between 1 and 300 inclusive.
+

       * - **RMR_RTG_SVC**
         -
           The value of this variable depends on the Route Manager in
       * - **RMR_RTG_SVC**
         -
           The value of this variable depends on the Route Manager in