X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Frtd%2Fconfig-deploy.xfm;h=6e4f9864639095482fade85fae1dbc1dcbd6dc61;hb=fe6a856df463a0d7e06b28aac8590ac9c0f08dd6;hp=654225fea7c847e49084cb922d95f314121a27e8;hpb=d961525e9eb23e3dee4a16960a1772782c3b8b36;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/rtd/config-deploy.xfm b/doc/src/rtd/config-deploy.xfm index 654225f..6e4f986 100644 --- a/doc/src/rtd/config-deploy.xfm +++ b/doc/src/rtd/config-deploy.xfm @@ -28,23 +28,27 @@ .im setup.im -&h1(RMR Configuration and Delpoyment) +&h1(RMR Configuration and Deployment) -The RIC Message Router (RMR) is a library which applications use to send and receive -messages where the message routing, endpoint selection, is based on the message type -rather than on traditional DNS names or IP addresses. -This document contains information regarding the configuration of RMR when it is -embedded by a &ital(user application). -RMR itself is not a deployable entity. +The RIC Message Router (RMR) is a library for peer-to-peer +communication. Applications use the library to send and receive +messages where the message routing and endpoint selection is based on +the message type rather than DNS host name-IP port combinations. +&space +This document contains information regarding the configuration of RMR +when it is embedded by a &ital(user application). RMR itself is a +library, not a deployable entity. &h2(Configuration) -Several aspects of RMR behaviour is controlled via environment variables which are -set at the time that a user application invokes the RMR initialisation function. -This allows these variables to be set before the application is started as a -function of the true environment, or set by the application as a means for the -application to influence RMR's behaviour. -The following is a list of RMR variables which RMR recognises (see the main -RMR manual page in the development package for more details). + +Many aspects of RMR behavior are controlled via environment variables. +These values are read when a user application invokes the RMR +initialization function. This allows these variables to be set before +the application is started as a function of the true environment, or +set by the application as a means for the application to influence +RMR's behaviour. The following is a list of environment variables +which RMR recognizes. Also see the main RMR manual page in the +development package for more details. .** use the same list which is used in the manual pages