CI: Add silent cmake SonarCloud scan

[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..aedd6b3 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.
 
+      * - **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
@@ -305,6 +312,17 @@ variables are used if found.
           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