Fixes some stability issues seen during route table update.

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

diff --git a/docs/rmr.7.rst b/docs/rmr.7.rst
index 05c1cd4..91730c3 100644 (file)
--- a/docs/rmr.7.rst
+++ b/docs/rmr.7.rst
@@ -269,6 +269,13 @@ if undefined.
           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


@@ -376,6 +383,17 @@ if undefined.
           The value of this variable is also used for Route Manager
           messages which are sent via an RMR connection.
 
           The value of this variable is also used for Route Manager
           messages which are sent via an RMR connection.
 

+      * - **RMR_STASH_RT**
+        -
+          Names the file where RMR should write the latest update it
+          receives from the source of route tables (generally Route
+          Manager). This is meant to assist with debugging and/or
+          troubleshooting when it is suspected that route information
+          isn't being sent and/or received correctly. If this variable
+          is not given, RMR will save the last update using the
+          ``RMR_SEED_RT`` variable value and adding a ``.stash`` suffix
+          to the filename so as not to overwrite the static table.
+

       * - **RMR_VCTL_FILE**
         -
           This supplies the name of a verbosity control file. The core
       * - **RMR_VCTL_FILE**
         -
           This supplies the name of a verbosity control file. The core