Documentation changes needed to support RTD

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

diff --git a/doc/src/man/rmr_torcv_msg.3.xfm b/doc/src/man/rmr_torcv_msg.3.xfm
index 0482419..d160f53 100644 (file)
--- a/doc/src/man/rmr_torcv_msg.3.xfm
+++ b/doc/src/man/rmr_torcv_msg.3.xfm
@@ -23,19 +23,8 @@
        Date            29 January 2019
 .fi
 
-.** if formatting with tfm, the roff.im will cause roff output to be generated
-.** if formatting with pfm, then pretty postscript will be generated
 .gv e LIB lib
-.if pfm
-       .im &{lib}/generic_ps.im
-.ei
-       .gv e OUTPUT_RST use_rst
-       .if .ev &use_rst 1 = 
-               .im &{lib}/rst.im
-       .ei
-               .im &{lib}/roff.im
-       .fi
-.fi
+.im &{lib}/man/setup.im 
 
 &line_len(6i)
 
@@ -83,6 +72,12 @@ The &ital(state) field in the message buffer will be one of the following:
 &beg_dlist(.75i : ^&bold_font )
 &di(RMR_OK) The message buffer (payload) references the received data.
 
+&space
+&di(RMR_ERR_INITFAILED) The first call to this function must initialise an underlying
+       system notification mechanism. On failure, this error is returned and errno
+       will have the system error status set.  If this function fails to intialise,
+       the poll mechansim, it is likely that message receives will never be successful.
+
 &space
 &di(RMR_ERR_TIMEOUT) The timeout expired before a complete message was received.
        All other fields in the message buffer are not valid.
@@ -140,6 +135,3 @@ rmr_mk_ring(3),
 rmr_ring_free(3)
 .ju on
 
-
-.qu
-