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 .** .im &{lib}/man/rmr.7.xfm
  50 .ju off &space
  51 .im &{lib}/man/rmr_alloc_msg.3.xfm
  52 .ju off &space
  53 .im &{lib}/man/rmr_bytes2meid.3.xfm
  54 .ju off &space
  55 .im &{lib}/man/rmr_bytes2payload.3.xfm
  56 .ju off &space
  57 .im &{lib}/man/rmr_bytes2xact.3.xfm
  58 .ju off &space
  59 .im &{lib}/man/rmr_call.3.xfm
  60 .ju off &space
  61 .im &{lib}/man/rmr_close.3.xfm
  62 .ju off &space
  63 .im &{lib}/man/rmr_free_msg.3.xfm
  64 .ju off &space
  65 .im &{lib}/man/rmr_get_meid.3.xfm
  66 .ju off &space
  67 .im &{lib}/man/rmr_get_rcvfd.3.xfm
  68 .ju off &space
  69 .im &{lib}/man/rmr_get_src.3.xfm
  70 .ju off &space
  71 .im &{lib}/man/rmr_get_srcip.3.xfm
  72 .ju off &space
  73 .im &{lib}/man/rmr_get_trace.3.xfm
  74 .ju off &space
  75 .im &{lib}/man/rmr_get_trlen.3.xfm
  76 .ju off &space
  77 .im &{lib}/man/rmr_get_xact.3.xfm
  78 .ju off &space
  79 .im &{lib}/man/rmr_init.3.xfm
  80 .ju off &space
  81 .im &{lib}/man/rmr_init_trace.3.xfm
  82 .ju off &space
  83 .im &{lib}/man/rmr_mt_call.3.xfm
  84 .ju off &space
  85 .im &{lib}/man/rmr_mt_rcv.3.xfm
  86 .ju off &space
  87 .im &{lib}/man/rmr_payload_size.3.xfm
  88 .ju off &space
  89 .im &{lib}/man/rmr_rcv_msg.3.xfm
  90 .ju off &space
  91 .im &{lib}/man/rmr_ready.3.xfm
  92 .ju off &space
  93 .im &{lib}/man/rmr_realloc_payload.3.xfm
  94 .ju off &space
  95 .im &{lib}/man/rmr_rts_msg.3.xfm
  96 .ju off &space
  97 .im &{lib}/man/rmr_send_msg.3.xfm
  98 .ju off &space
  99 .im &{lib}/man/rmr_set_stimeout.3.xfm
 100 .ju off &space
 101 .im &{lib}/man/rmr_set_trace.3.xfm
 102 .ju off &space
 103 .im &{lib}/man/rmr_str2meid.3.xfm
 104 .ju off &space
 105 .im &{lib}/man/rmr_str2xact.3.xfm
 106 .ju off &space
 107 .im &{lib}/man/rmr_support.3.xfm
 108 .ju off &space
 109 .im &{lib}/man/rmr_torcv_msg.3.xfm
 110 .ju off &space
 111 .im &{lib}/man/rmr_trace_ref.3.xfm
 112 .ju off &space
 113 .im &{lib}/man/rmr_tralloc_msg.3.xfm
 114 .ju off &space
 115 .im &{lib}/man/rmr_wh_close.3.xfm
 116 .ju off &space
 117 .im &{lib}/man/rmr_wh_open.3.xfm
 118 .ju off &space
 119 .im &{lib}/man/rmr_wh_send_msg.3.xfm
 120 .ju off &space
 121