Add root level docs control files
[ric-plt/lib/rmr.git] / doc / src / man / README
1
2 Various RMr man pages. These are maintained in {X}fm format which allows
3 them to be rendered into one of these formats:
4         Postscript
5         troff
6         rst
7         markdown
8         html
9
10
11 Troff is generated and installed into deb packages such that 'man rmr_call'
12 and the like generate expected man page output.  The rst output is likely
13 copied to some other directory and snarfed for automatic conversion to 
14 html ({X}fm could do that without the extra layer) as a part of the CICD
15 gizmo.   Postscript is a benefit for pretty printing, and markdown is 
16 available if someone adds a markdown macro file in the parent directory.