X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_init.3.xfm;h=5413beb3856887019cb312a7dee4f5e78e706b3b;hb=b7a4b52f73d51db6077d2c0b56be262c36f472f7;hp=83a0f188b6433fc261d9027d605ea7b18c09b05c;hpb=412d53dfa2f9b5b56a448797d0dfec3b0f11f666;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_init.3.xfm b/doc/src/man/rmr_init.3.xfm index 83a0f18..5413beb 100644 --- a/doc/src/man/rmr_init.3.xfm +++ b/doc/src/man/rmr_init.3.xfm @@ -24,19 +24,8 @@ Date 28 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) @@ -68,21 +57,21 @@ a specific message. &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 +These are set by ORing &cw(RMRFL) constants from the RMr header file. Currently the following flags are supported: &half_space &beg_dlist(1i : &bold_font ) -&ditem(RMRFL_NONE) +&diitem(RMRFL_NONE) No flags are set. &half_space -&ditem(RMRFL_NOTHREAD) +&diitem(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. &half_space -&ditem(RMRFL_MTCALL) +&diitem(RMRFL_MTCALL) Enable multi-threaded call support. &end_dlist @@ -94,7 +83,7 @@ Further, timeouts were message count based and not time unit based. Multi-threaded call support adds the ability for a user application with multiple threads to invoke a blocking call function with the guarentee that the correct response message is delivered to the thread. -The additional support is implemented with the &ital( rmr_mt_call() ) and &ital( rmr_mt_rcv() ) +The additional support is implemented with the &ital(rmr_mt_call()) and &ital(rmr_mt_rcv()) function calls. &space @@ -114,7 +103,7 @@ The following variables will be used when found. &half_space &beg_dlist(1i : &bold_font ) -&ditem(RMR_SEED_RT) +&diitem(RMR_SEED_RT) Assumes this is the filename of the seed route table file to use. In normal situations, the library will wait for an update from the route table generator (expected within a few seconds of initialisation) before being able to send messages. @@ -122,7 +111,7 @@ However, in some situations where a bootstrap table is necessary, this is the me supply it to the library. &half_space -&ditem(RMR_RTG_SVC) +&diitem(RMR_RTG_SVC) The route table generator assumes that RMr is listening on a well known port (4561) by default, but this environment variable can be used to change the listening port if needed. @@ -153,6 +142,7 @@ error message of a system call is propagated up, and thus this list might be inc &ex_end &h2(SEE ALSO ) +.ju off rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), @@ -170,7 +160,5 @@ rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3) - - -.qu +.ju on