doc/src/user/user_guide.xfm

   1 .if false
   2 ==================================================================================
   3     Copyright (c) 2020 Nokia
   4     Copyright (c) 2020 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic:       user_guide.xfm
  22         Abstract:       Source for the user guide. Use {X}fm to generate one of several
  23                                 output types:
  24                                         - postscript
  25                                         - roff
  26                                         - markdown
  27                                         - rst
  28                                         - ascii text
  29
  30         Date:           21 April  2020
  31         Author:         E. Scott Daniels
  32 .fi
  33
  34
  35 .dv col_width 6.5i
  36 .dv fname_base user_guide
  37 .if pfm
  38         .dv doc_title RIC xAPP C++ Framework
  39         .dv doc_subtitle User's Guide
  40 .ei
  41         .dv doc_title User's Guide
  42 .fi
  43 .dv orig_date 21 April 2020
  44
  45 .dv textfont Helvetica
  46 .dv ditemtext Helvetica-bold
  47
  48 .in .5i
  49 .ll 6i
  50 .hn off
  51
  52 .im ../lib/setup.im
  53 .im &{lib}/front_junk.im
  54
  55 .**  ------ major sections --------
  56 .im cpp_frame.im
  57 .im jhash.im
  58 .im alarm.im
  59 .im metrics.im
  60 .im config.im
  61
  62 &h1(Example Programmes)
  63 The following sections contain several example programmes which are written on
  64 top of the C++ framework.
  65 All of these examples are available in the code repository RIC xAPP C++ framework available via
  66 the following URL:
  67 &space
  68
  69 .** indent gets round a space bug in RST
  70 &center_start
  71 &indent
  72 &cw( https^://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-cpp )
  73 &uindent
  74 &center_end
  75
  76 .im example1.im
  77 .im example2.im
  78 .im example3.im
  79 .im example4.im
  80 .im example5.im