X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Frtd%2Fuser-guide.xfm;h=ddfdab51dd96e739e1bc09fe95f59289bb46171a;hb=fe6a856df463a0d7e06b28aac8590ac9c0f08dd6;hp=8a29b02aa040aa3933e0e9dd0721b23086b9eb2a;hpb=d961525e9eb23e3dee4a16960a1772782c3b8b36;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/rtd/user-guide.xfm b/doc/src/rtd/user-guide.xfm index 8a29b02..ddfdab5 100644 --- a/doc/src/rtd/user-guide.xfm +++ b/doc/src/rtd/user-guide.xfm @@ -31,23 +31,24 @@ &h1(RMR User's Guide) -The RIC Message Router (RMR) is a library which applications use to send and receive -messages where the message routing, endpoint selection, is based on the message type -rather than on traditional DNS names or IP addresses. -Because the user documentation for RMR is a collection of UNIX manpages (included -in the development package, and available via the &cw(man) command when installed), -there is no separate "User's Guide." -To provide something for the document scrapers to find, this is a collection of -the RMR manual pages formatted directly from their source which might be a bit -ragged when combined into a single markup document. -Read the manual pages :) +The RIC Message Router (RMR) is a library for peer-to-peer +communication. Applications use the library to send and receive +messages where the message routing and endpoint selection is based on +the message type rather than DNS host name-IP port combinations. +&space +This document contains information that developers need to know to use +the RMR library. Because the primary documentation for the RMR +library is a collection of UNIX manpages (included in the development +package, and available via the &cw(man) command when installed), there +is no separate "User's Guide." To provide something for the document +scrapers to find, this is a collection of the RMR manual pages +formatted directly from their source, which might be a bit ragged when +combined into a single markup document. Read the manual pages :) &space -.** turn of header 1 so that the rmr library header isn't generated for each page +.** turn off header 1 so that the rmr library header isn't generated for each page .dv h1 .** CAUTION: man_list.im is generated by a script when make is used! .im man_list.im - -