doc/src/man/env_var_list.im

   1 .** vim: ts=4 noet sw=4:
   2 .if false
   3 ==================================================================================
   4         Copyright (c) 2019 Nokia
   5         Copyright (c) 2018-2019 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 .fi
  20
  21 .if false
  22         Mnemonic:       env_list_vars.im
  23         Abstract:       This is a list of environment variables which are recognised
  24                                 by RMR. This is an embed file as it is referenced by both
  25                                 manual pages and the 'read the docs' source (allowing a single
  26                                 point of maintenence).
  27
  28         Date:           6 November 2019 (broken from the main manual page)
  29         Author:         E. Scott Daniels
  30 .fi
  31
  32
  33 &beg_dlist(.75i : ^&bold_font )
  34 &ditem(RMR_ASYNC_CONN) Allows the asynch connection mode to be turned off (by setting the
  35         value to 0. When set to 1, or missing from the environment, RMR will invoke the
  36         connection interface in the transport mechanism using the non-blocking (asynch)
  37         mode.  This will likely result in many "soft failures" (retry) until the connection
  38         is established, but allows the application to continue unimpeeded should the
  39         connection be slow to set up.
  40         &half_space
  41
  42 &ditem(RMR_BIND_IF) This provides the interface that RMr will bind listen ports to allowing
  43         for a single interface to be used rather than listening across all interfaces.
  44         This should be the IP address assigned to the interface that RMr should listen
  45         on, and if not defined RMr will listen on all interfaces.
  46         &half_space
  47
  48 &ditem(RMR_RTG_SVC) RMr opens a TCP listen socket using the port defined by this
  49         environment variable and expects that the route table generator process
  50         will connect to this port.
  51         If not supplied the port 4561 is used.
  52         &half_space
  53
  54 &ditem(RMR_HR_LOG)
  55         By default RMR writes messages to standard error (incorrectly referred to as log messages)
  56         in human readable format.
  57         If this environment variable is set to 0, the format of standard error messages might
  58         be written in some format not easily read by humans.
  59         If missing, a value of 1 is assumed.
  60         &half_space
  61
  62 &ditem(RMR_LOG_VLEVEL)
  63         This is a numeric value which corresponds to the verbosity level used to limit messages
  64         written to standard error.
  65         The lower the number the less chatty RMR functions are during execution.
  66         The following is the current relationship between the value set on this variable and
  67         the messages written:
  68
  69         &beg_dlist(.25i : &bold_font )
  70                 &ditem(0)       Off; no messages of any sort are written.
  71                 &half_space
  72                 &ditem(1)       Only critical messages are written (default if this variable does not exist)
  73                 &half_space
  74                 &ditem(2)       Errors and all messages written with a lower value.
  75                 &half_space
  76                 &ditem(3)       Warnings and all messages written with a lower value.
  77                 &half_space
  78                 &ditem(4)       Informationional and all messages written with a lower value.
  79                 &half_space
  80                 &ditem(5)       Debugging mode -- all messages written, however this requires RMR to have been compiled with debugging support enabled.
  81         &end_dlist
  82         &half_space
  83
  84 &ditem(RMR_RTG_ISRAW) Is set to 1 if the route table generator is sending "plain" messages
  85         (not using RMr to send messages, 0 if the rtg is using RMr to send. The default
  86         is 1 as we don't expect the rtg to use RMr.
  87
  88 &ditem(RMR_SEED_RT) This is used to supply a static route table which can be used for
  89         debugging, testing, or if no route table generator process is being used to
  90         supply the route table.
  91         If not defined, no static table is used and RMr will not report &ital(ready)
  92         until a table is received.
  93         The static route table may contain both the route table (between newrt start
  94         and end records), and the MEID map (between meid_map start and end records)
  95
  96 &ditem(RMR_SRC_ID) This is either the name or IP address which is placed into outbound
  97         messages as the message source. This will used when an RMR based application uses
  98         the rmr_rts_msg() function to return a response to the sender. If not supplied
  99         RMR will use the hostname which in some container environments might not be
 100         routable.
 101
 102 &ditem(RMR_VCTL_FILE) This supplies the name of a verbosity control file. The core
 103         RMR functions do not produce messages unless there is a critical failure. However,
 104         the route table collection thread, not a part of the main message processing
 105         component, can write additional messages to standard error.  If this variable is
 106         set, RMR will extract the verbosity level for these messages (0 is silent) from
 107         the first line of the file. Changes to the file are detected and thus the level
 108         can be changed dynamically, however RMR will only suss out this variable during
 109         initialisation, so it is impossible to enable verbosity after startup.
 110
 111 &ditem(RMR_WARNINGS) If set to 1, RMR will write some warnings which are non-performance
 112         impacting. If the variable is not defined, or set to 0, RMR will not write these
 113         additional warnings.
 114
 115 &end_dlist