Add manual pages to RTD as individual files

[ric-plt/lib/rmr.git] / doc / src / man / rmr.7.xfm

diff --git a/doc/src/man/rmr.7.xfm b/doc/src/man/rmr.7.xfm
index 70f55af..e372571 100644 (file)
--- a/doc/src/man/rmr.7.xfm
+++ b/doc/src/man/rmr.7.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia
-       Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019 Nokia
+   Copyright (c) 2018-2019 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -17,10 +17,10 @@
 ==================================================================================
 .fi
 .if false
-       Mnemonic        rmr.7.xfm
-       Abstract        The manual page for the whole RMr library
-       Author          E. Scott Daniels
-       Date            29 January 2019
+    Mnemonic    rmr.7.xfm
+    Abstract    The manual page for the whole RMR library
+    Author      E. Scott Daniels
+    Date        29 January 2019
 .fi
 
 .gv e LIB lib
@@ -28,17 +28,17 @@
 
 &line_len(6i)
 
-&h1(RMr Library)
+&h1(RMR Library)
 &h2(NAME)
-       RMr -- Ric Message Router Library
+    RMR -- Ric Message Router Library
 
 &h2(DESCRIPTION)
-RMr is a library which provides  a user application with the ability
-to send and receive messages to/from  other RMr based applications
-without having to understand the underlying messaging transport environment (e.g. Nanomsg)
+RMR is a library which provides  a user application with the ability
+to send and receive messages to/from  other RMR based applications
+without having to understand the underlying messaging transport environment (e.g., SI95)
 and without needing to know which other endpoint applications are currently
 available and accepting messages.
-To do this, RMr depends on a routing table generated by an external source.
+To do this, RMR depends on a routing table generated by an external source.
 This table is used to determine the destination endpoint of each message sent by mapping the
 message type T (supplied by the user application) to an endpoint entry.
 Once determined, the message is sent directly to the endpoint.
@@ -47,7 +47,7 @@ message, and in some cases whether that message was sent to multiple
 applications.
 
 &space
-RMr functions do provide for the ability to respond to the specific source
+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.
 
@@ -64,7 +64,7 @@ logger1.
 It is the responsibility of the route table generator to know which endpoints
 belong to which groups, and which groups accept which message types.
 Once understood, the route table generator publishes a table that is ingested
-by RMr and used for mapping messages to end points.
+by RMR and used for mapping messages to end points.
 
 .sp
 The following is a simple route table which causes message types 0 through 9 to
@@ -99,7 +99,7 @@ meid_map | end | 2
 &ex_end
 
 This table indicates that the application (endpoint) &ital(control1) "owns" 6 MEIDs
-and &ital(control2) owns 4. 
+and &ital(control2) owns 4.
 When message type 0 is sent, the MEID in the message will be used to select the
 endpoint via this table.
 
@@ -167,10 +167,10 @@ route manager transmitted them.
 
 &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
+control, RMR supports a number of environment variables which provide information
 to the library.
 The following is a list of the various environment variables, what they control
-and the defaults which RMr uses if undefined.
+and the defaults which RMR uses if undefined.
 
 &space
 .** the list of environment vars supported