Add route table guide and formatting tweaks

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

diff --git a/doc/src/man/rmr_bytes2xact.3.xfm b/doc/src/man/rmr_bytes2xact.3.xfm
index 2f62a5f..c6ace27 100644 (file)
--- a/doc/src/man/rmr_bytes2xact.3.xfm
+++ b/doc/src/man/rmr_bytes2xact.3.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia 
-       Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019-2020 Nokia
+   Copyright (c) 2018-2020 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_bytes2xact.xfm
-       Abstract        The manual page for the rmr_bytes2xact function.
-       Author          E. Scott Daniels
-       Date            8 March 2019
+    Mnemonic    rmr_bytes2xact.xfm
+    Abstract    The manual page for the rmr_bytes2xact 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_bytes2xact
+    rmr_bytes2xact
 
 &h2(SYNOPSIS)
 &indent
@@ -44,12 +44,11 @@ int rmr_bytes2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
 &uindent
 
 &h2(DESCRIPTION)
-The &cw(rmr_bytes2xact) function will copy up to &ital(len) butes from &ital(src) to the 
-transaction ID (xaction) field in the message.  
+The &cw(rmr_bytes2xact) function will copy up to &ital(len) bytes from &ital(src) to the
+transaction ID (xaction) field in the message.
 The field is a fixed length, gated by the constant &cw(RMR_MAX_XID) and if len is larger
-than this value, only RMR_MAX_XID bytes will actually be copied.
+than this value, only &cw(RMR_MAX_XID) bytes will actually be copied.
 
-&beg_dlist(.75i : ^&bold_font )
 &h2(RETURN VALUE)
 On success, the actual number of bytes copied is returned, or -1 to indicate a hard error.
 If the length is less than 0, or not the same as length passed in, &cw(errno) is set
@@ -59,11 +58,10 @@ to one of the errors described in the &ital(Errors) section.
 If the returned length does not match the length passed in, &cw(errno) will be set to one
 of the following constants with the meaning listed below.
 
-&half_space
-&di(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
+&beg_dlist(1i : &bold_font )
+       &ditem(EINVAL) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
 
-&half_space
-&di(EOVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of
+       &ditem(EOVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of
        the source bytes were copied.
 &end_dlist
 
@@ -92,8 +90,3 @@ rmr_ring_free(3),
 rmr_str2meid(3),
 rmr_wh_open(3),
 rmr_wh_send_msg(3)
-
-
-
-.qu
-