Add route table guide and formatting tweaks
[ric-plt/lib/rmr.git] / doc / src / man / rmr_init.3.xfm
index acace5a..05c9603 100644 (file)
@@ -73,8 +73,8 @@ Similarly, the only penality to the application for over specifying the normal b
 size might be a larger memory footprint.
 
 &space
-&ital(Flags) allows for selection of some RMr options at the time of initialisation.
-These are set by ORing &cw(RMRFL) constants from the RMr header file. Currently the
+&ital(Flags) allows for selection of some RMR options at the time of initialisation.
+These are set by ORing &cw(RMRFL) constants from the RMR header file. Currently the
 following flags are supported:
 
 &half_space
@@ -85,7 +85,7 @@ following flags are supported:
 &half_space
 &ditem(RMRFL_NOTHREAD)
     The route table collector thread is not to be started. This should only be used
-    by the route table generator application if it is based on RMr.
+    by the route table generator application if it is based on RMR.
 
 &half_space
 &ditem(RMRFL_MTCALL)
@@ -114,10 +114,10 @@ function calls.
 &space
 
 Multi-threaded call support requires the user application to specifically enable it
-when RMr is initialised.
+when RMR is initialised.
 This is necessary because a second, dedicated, receiver thread  must be started, and
 requires all messages to be examined and queued by this thread.
-The additional overhead is minimal, queuing information is all in the RMr message
+The additional overhead is minimal, queuing information is all in the RMR message
 header, but as an additional process is necessary the user application must "opt in"
 to this approach.
 
@@ -132,7 +132,7 @@ The following variables are used if found.
 .im &{lib}/man/env_var_list.im
 
 &h2(RETURN VALUE)
-The &cw(rmr_init) function returns a void pointer (a contex if you will) that is passed
+The &cw(rmr_init) function returns a void pointer (a context if you will) that is passed
 as the first parameter to nearly all other RMR functions.
 If &cw(rmr_init) is unable to properly initialise the environment, NULL is returned and
 errno is set to an appropriate value.
@@ -142,7 +142,7 @@ The following error values are specifically set by this RMR function. In some ca
 error message of a system call is propagated up, and thus this list might be incomplete.
 
 &beg_dlist(.75i : ^&bold_font )
-&di(ENOMEM) Unable to allocate memory.
+&ditem(ENOMEM) Unable to allocate memory.
 &end_dlist
 
 &h2(EXAMPLE)