doc/src/rtd/user-guide.xfm

   1 .** vim: ts=4 noet sw=4:
   2 .if false
   3 ==================================================================================
   4         Copyright (c) 2019 Nokia
   5         Copyright (c) 2018-2019 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 .fi
  20
  21
  22 .if false
  23         Mnemonic:       user-guide.xfm
  24         Abstract:       Source for the user's guide (mostly just an import of all
  25                                 of the manual pages).
  26         Date:           6 November 2019
  27         Author:         E. Scott Daniels
  28 .fi
  29
  30 .im setup.im
  31
  32 &h1(RMR User's Guide)
  33
  34 The RIC Message Router (RMR) is a library which applications use to send and receive
  35 messages where the message routing, endpoint selection, is based on the message type
  36 rather than on traditional DNS names or IP addresses.
  37 Because the user documentation for RMR is a collection of UNIX manpages (included
  38 in the development package, and available via the &cw(man) command when installed),
  39 there is no separate "User's Guide."
  40 To provide something for the document scrapers to find, this is a collection of
  41 the RMR manual pages formatted directly from their source which might be a bit
  42 ragged when combined into a single markup document.
  43 Read the manual pages :)
  44 &space
  45
  46
  47 .** turn of header 1 so that the rmr library header isn't generated for each page
  48 .dv h1
  49
  50 .** CAUTION: man_list.im is generated by a script when make is used!
  51 .im man_list.im
  52
  53