/
RMR Manual Pages

RMR Manual Pages

Owned by Scott Daniels
Last updated: Apr 13, 2020Version comment

As of 2020 April 13, the RMR manual pages are maintaind as separate document files on the Read The Docs (RTD) site. It is no longer necessary to build them if they are needed just for reference. The RTD link: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/latest/index.html


The manual (man) pages for RMR are maintained as a part of the RMR source, and are available via several different avenues:

  • Install the RMR development package (RPM or .deb) and use the man command (e.g. man rmr_send_msg). (See the prebuilt wiki page for details.)
  • Pull the RMR code and build directly
  • Download the .tgz attachment which contains RMR man pages in PDF, troff, and RTS format

Building The Man Pages

To build the man pages, assuming that the RMR repo has been cloned/pulled and is in the current working directory, run the following commands:


mkdir -p .build
cd .build
cmake .. -DBUILD_DOC=1
make package


After running these commands, the man pages (in various output formats) will remain in the .build directory; the user is free to move/use them as desired. The man pages have file names with the following syntax so that they can be easily referenced by the man command:   <command_name>.<section>.<suffix> (e.g. rmr_tralloc_msg.3.gz).    The list below describes each of the file "types" generated and identified by the suffix:

  • .gz  These are troff files in zipped format which is the expected format for the UNIX man command. These files are placed into the RMR packages and installed with the development package. These are likely of little use to the end user in the 'raw' .gz format.
  • .ps  These are postscript files which can be displayed by any postscript viewer, or converted to PDF with utilities like ghostscript. It is up to the end user to convert .ps files as is needed.
  • .rst  These files contain ReStructured Text versions of the man pages.
  • .md These files contain markdown versions of the man pages.
  • .txt  These files contain plain ASCII rendering of the man pages.


Attachments

At least one file is attached to this page.  The file rmr_manpages.tgz contains a complete set of all output formats (postscript, troff, markdown, plain ascii and rst).