Documentation fixes and revamp user guide

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

diff --git a/doc/src/man/rmr_get_src.3.xfm b/doc/src/man/rmr_get_src.3.xfm
index 98ec5a5..eade6d1 100644 (file)
--- a/doc/src/man/rmr_get_src.3.xfm
+++ b/doc/src/man/rmr_get_src.3.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.
@@ -18,20 +18,20 @@
 .fi
 
 .if false
-       Mnemonic        rmr_get_src.xfm
-       Abstract        The manual page for the rmr_get_src function.
-       Author          E. Scott Daniels
-       Date            8 March 2019
+    Mnemonic    rmr_get_src.xfm
+    Abstract    The manual page for the rmr_get_src function.
+    Author      E. Scott Daniels
+    Date        8 March 2019
 .fi
 
 .gv e LIB lib
-.im &{lib}/man/setup.im 
+.im &{lib}/man/setup.im
 
 &line_len(6i)
 
 &h1(RMR Library Functions)
 &h2(NAME)
-       rmr_get_src
+    rmr_get_src
 
 &h2(SYNOPSIS)
 &indent
@@ -46,14 +46,14 @@ unsigned char* rmr_get_src( rmr_mbuf_t* mbuf, unsigned char* dest )
 &h2(DESCRIPTION)
 The &cw(rmr_get_src) function will copy the &ital(source) information from the message to a buffer
 (dest) supplied by the user.
-In an RMr message, the source is the sender's information that is used for return to sender
+In an RMR message, the source is the sender's information that is used for return to sender
 function calls, and is generally the hostname and port in the form &ital(name:port).
 The source might be an IP address port combination; the data is populated by the sending process
 and the only requirement is that it be capable of being used to start a TCP session with the
 sender.
 .sp
 
-The maximum size allowed by RMr is 64 bytes (including the nil string terminator), so the user
+The maximum size allowed by RMR is 64 bytes (including the nil string terminator), so the user
 must ensure that the destination buffer given is at least 64 bytes.
 
 &h2(RETURN VALUE)
@@ -61,7 +61,7 @@ On success, a pointer to the destination buffer is given as a convenience to the
 On failure, a nil pointer is returned and the value of errno is set.
 
 &h2(ERRORS)
-If an error occurs, the value of the global variable &cw( errno ) will be set to one of
+If an error occurs, the value of the global variable &cw(errno) will be set to one of
 the following with the indicated meaning.
 
 &beg_dlist(.75i : ^&bold_font )
@@ -97,6 +97,3 @@ rmr_wh_open(3),
 rmr_wh_send_msg(3)
 .ju on
 
-
-.qu
-