Add ability to save route table updates to disk

[ric-plt/lib/rmr.git] / doc / src / man / env_var_list.im

diff --git a/doc/src/man/env_var_list.im b/doc/src/man/env_var_list.im
index a0b69ee..a19cb22 100644 (file)
--- a/doc/src/man/env_var_list.im
+++ b/doc/src/man/env_var_list.im
@@ -79,6 +79,12 @@
     In the case where both variables are defined, RMR will behave exactly as is
     communicated with the variable's values.
 
+&ditem(RMR_RTREQ_FREQ)
+       When RMR needs a new route table it will send a request once every &cw(n) seconds.
+       The default value for &cw(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.
+
 &ditem(RMR_RTG_SVC)
     The value of this variable depends on the Route Manager in use.
     &space
@@ -158,6 +164,14 @@
     The value of this variable is also used for Route Manager messages which are
     sent via an RMR connection.
 
+&ditem(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 &cw(RMR_SEED_RT) variable
+       value and adding a &cw(.stash) suffix to the filename so as not to overwrite
+       the static table.
+
 &ditem(RMR_VCTL_FILE) This supplies the name of a verbosity control file. The core
     RMR functions do not produce messages unless there is a critical failure. However,
     the route table collection thread, not a part of the main message processing