Remove NNG libraries from packages
[ric-plt/lib/rmr.git] / doc / src / rtd / config-deploy.xfm
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
22 .if false
23         Mnemonic:       config-deploy.xfm
24         Abstract:       Source to generate a configuration delployment guide.
25         Date:           6 November 2019
26         Author:         E. Scott Daniels
27 .fi
28
29 .im setup.im
30
31 &h1(RMR Configuration and Deployment)
32
33 The RIC Message Router (RMR) is a library for peer-to-peer
34 communication.  Applications use the library to send and receive
35 messages where the message routing and endpoint selection is based on
36 the message type rather than DNS host name-IP port combinations.
37 &space
38 This document contains information regarding the configuration of RMR
39 when it is embedded by a &ital(user application).  RMR itself is a
40 library, not a deployable entity.
41
42 &h2(Configuration)
43
44 Many aspects of RMR behavior are controlled via environment variables.
45 These values are read when a user application invokes the RMR
46 initialization function.  This allows these variables to be set before
47 the application is started as a function of the true environment, or
48 set by the application as a means for the application to influence
49 RMR's behaviour.  The following is a list of environment variables
50 which RMR recognizes. Also see the main RMR manual page in the
51 development package for more details.
52
53
54 .** use the same list which is used in the manual pages
55 .im &{lib}/man/env_var_list.im