feat(doc): Add trace man pages

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

diff --git a/doc/src/man/rmr_alloc_msg.3.xfm b/doc/src/man/rmr_alloc_msg.3.xfm
index 04b908b..a9dad95 100644 (file)
--- a/doc/src/man/rmr_alloc_msg.3.xfm
+++ b/doc/src/man/rmr_alloc_msg.3.xfm
@@ -48,7 +48,7 @@
 &ex_start
 #include <rmr/rmr.h>
 
-rmr_mbuf_t* rmr_alloc_msg( void* a, int size );
+rmr_mbuf_t* rmr_alloc_msg( void* ctx, int size );
 &ex_end
 &uindent
 
@@ -59,7 +59,7 @@ The buffer is allocated such that sending it requires no additional copying
 out of the buffer. 
 If the value passed in &cw(size) is 0, then the default size supplied on the
 &ital(rmr_init) call will be used. 
-The &ital(a) parameter is the void context pointer that was returned by
+The &ital(ctx) parameter is the void context pointer that was returned by
 the &ital(rmr_init) function.
 
 &space
@@ -74,7 +74,7 @@ typedef struct {
     int mtype;
     int len;
     unsigned char* payload;
-    unsigned char* a;
+    unsigned char* xaction;
 } rmr_mbuf_t;
 &ex_end
 
@@ -113,12 +113,12 @@ should &bold(NOT) make use of the payload pointer.
 
 
 &half_space
-&ditem(a ) The &ital(a) field is a pointer to a fixed sized area in 
+&ditem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in 
 the message into which the user may write a transaction ID.  
 The ID is optional with the exception of when the user application uses the &cw(rmr_call)
 function to send a message and wait for the reply; the underlying RMR processing
 expects that the matching reply message will also contain the same data in the
-&ital(a) field.
+&ital(xaction) field.
 &end_dlist
 
 &h2(RETURN VALUE)
@@ -132,10 +132,13 @@ The function returns a pointer to a &cw(rmr_mbuf) structure, or NULL on error.
 .** &h2(EXAMPLE)
 
 &h2(SEE ALSO )
-rmr_mbuf(3)
+rmr_tralloc_msg(3),
 rmr_call(3),
 rmr_free_msg(3),
 rmr_init(3),
+rmr_init_trace(3),
+rmr_get_trace(3),
+rmr_get_trlen(3),
 rmr_payload_size(3),
 rmr_send_msg(3),
 rmr_rcv_msg(3),
@@ -146,8 +149,8 @@ rmr_fib(3),
 rmr_has_str(3),
 rmr_tokenise(3),
 rmr_mk_ring(3),
-rmr_ring_free(3)
-
+rmr_ring_free(3),
+rmr_set_trace(3)
 
 .qu