extras/libmemif/docs/buildinstructions_doc.md

   1 ## Build Instructions    {#libmemif_build_doc}
   2
   3 Install dependencies
   4 ```
   5 # sudo apt-get install -y git autoconf pkg_config libtool check
   6 ```
   7
   8 Clone repository to your local machine.
   9 ```
  10 # git clone https://github.com/JakubGrajciar/libmemif.git
  11 ```
  12
  13 From root directory execute:
  14 For debug build:
  15 ```
  16 # ./bootstrap
  17 # ./configure
  18 # make
  19 # make install
  20 ```
  21
  22 For release build:
  23 ```
  24 # ./bootstrap
  25 # ./configure
  26 # make release
  27 # make install
  28 ```
  29 Verify installation:
  30 ```
  31 # ./.libs/icmpr-epoll
  32 ```
  33 > Make sure to run the binary file from ./.libs. File ./icmp\_responder in libmemif root directory is script that links the library, so it only verifies successful build. Default install path is /usr/lib.
  34 Use _help_ command to display build information and commands:
  35 ```
  36 ICMP_Responder:add_epoll_fd:204: fd 0 added to epoll
  37 MEMIF_DEBUG:src/main.c:memif_init:383: app name: ICMP_Responder
  38 ICMP_Responder:add_epoll_fd:204: fd 4 added to epoll
  39 LIBMEMIF EXAMPLE APP: ICMP_Responder (debug)
  40 ==============================
  41 libmemif version: 1.0 (debug)
  42 memif version: 256
  43 commands:
  44         help - prints this help
  45         exit - exit app
  46         conn <index> - create memif (slave-mode)
  47         del  <index> - delete memif
  48         show - show connection details
  49         ip-set <index> <ip-addr> - set interface ip address
  50         rx-mode <index> <qid> <polling|interrupt> - set queue rx mode
  51 ```
  52
  53 #### Examples
  54
  55 Once the library is built/installed, refer to @ref libmemif_examples_doc and @ref libmemif_gettingstarted_doc for additional information on basic use cases and API usage.