X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr.7.xfm;h=2f2e47d47670a8c47f10cc2a3944a9dced6dd21c;hb=c5de5c7413901b8de1da928b084a3ca2e88d490a;hp=affdf244be64efc2ea36a18b63b83972ed530e3f;hpb=68d09fa5028e47e763c44c30647da31e77eda64a;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr.7.xfm b/doc/src/man/rmr.7.xfm index affdf24..2f2e47d 100644 --- a/doc/src/man/rmr.7.xfm +++ b/doc/src/man/rmr.7.xfm @@ -23,22 +23,8 @@ Date 29 January 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** and rst.im will cause rst to be generated depending on OUTPUT_TYPE env -.** var. -.** if formatting with pfm, then pretty postscript will be generated - .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) @@ -63,7 +49,7 @@ applications. &space RMr functions do provide for the ability to respond to the specific source instance of a message allowing for either a request response, or call -response relationship when needed. +response relationship when needed. &h3(The Route Table) @@ -83,31 +69,12 @@ by RMr and used for mapping messages to end points. &h3(Environment) To enable configuration of the library behaviour outside of direct user application control, RMr supports a number of environment variables which provide information -to the library. +to the library. The following is a list of the various environment variables, what they control and the defaults which RMr uses if undefined. -&beg_dlist(.75i : ^&bold_font ) -&di(RMR_BIND_IF) This provides the interface that RMr will bind listen ports to allowing - for a single interface to be used rather than listening across all interfaces. - This should be the IP address assigned to the interface that RMr should listen - on, and if not defined RMr will listen on all interfaces. - -&di(RMR_RTG_SVC) RMr opens a TCP listen socket using the port defined by this - environment variable and expects that the route table generator process - will connect to this port. - If not supplied the port 4561 is used. - -&di(RMR_RTG_ISRAW) Is set to 1 if the route table generator is sending "plain" messages - (not using RMr to send messages, 0 if the rtg is using RMr to send. The default - is 1 as we don't expect the rtg to use RMr. - -&di(RMR_SEED_RT) This is used to supply a static route table which can be used for - debugging, testing, or if no route table generator process is being used to - supply the route table. - If not defined, no static table is used and RMr will not report &ital(ready) - until a table is received. -&end_dlist +.** the list of environment vars supported +.im &{lib}/man/env_var_list.im &h2(SEE ALSO ) @@ -118,10 +85,12 @@ rmr_call(3), rmr_free_msg(3), rmr_init(3), rmr_init_trace(3), +rmr_get_meid(3), rmr_get_src(3), rmr_get_srcip(3), rmr_get_trace(3), rmr_get_trlen(3), +rmr_get_xact(3), rmr_payload_size(3), rmr_rcv_msg(3), rmr_rcv_specific(3), @@ -131,6 +100,7 @@ rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), +rmr_realloc_payload(3), rmr_ring_free(3), rmr_set_trace(3), rmr_torcv_msg(3), @@ -139,4 +109,3 @@ rmr_wh_send_msg(3) .ju on -.qu