diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-10-12 14:00:25 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 15:30:03 +0000 |
| commit | 8acc5ee9079d0b03229a72e72a5308e7de0a359a (patch) | |
| tree | ba3e5789abc2c3cd4edd9806fc44991c45d705f1 /extras/libmemif/docs/buildinstructions_doc.rst | |
| parent | 87e90830b8931b4c55526bf7cb5a148a10df061f (diff) | |
libmemif: docs md->rst
Type: improvement
Change-Id: Ibebd2d47a4268189f11601d004073e4858548f25
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'extras/libmemif/docs/buildinstructions_doc.rst')
| -rw-r--r-- | extras/libmemif/docs/buildinstructions_doc.rst | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/extras/libmemif/docs/buildinstructions_doc.rst b/extras/libmemif/docs/buildinstructions_doc.rst new file mode 100644 index 00000000000..090b9d6ff75 --- /dev/null +++ b/extras/libmemif/docs/buildinstructions_doc.rst @@ -0,0 +1,61 @@ +.. _libmemif_build_doc: + +Build Instructions +================== + +Install dependencies +-------------------- + +:: + + # sudo apt-get install -y git cmake autoconf pkg_config libtool + +Libmemif is now part of VPP repository. Follow fd.io wiki to pull source +code from VPP repository. +https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code#Pushing_Patches + +Libmemif is located under extras/libmemif. From extras/libmemif: + +:: + + # mkdir build + # cd build + # cmake .. + # make install + +Verify installation: +-------------------- + +:: + + build# ./examples/icmp_responder -? + +Use ``-?`` flag to display help: + +:: + + LIBMEMIF EXAMPLE APP: icmp_responder_example + ============================== + libmemif version: 4.0, memif version: 2.0 + ============================== + In this example, memif endpoint connects to an external application. + The example application can resolve ARP and reply to ICMPv4 packets. + The program will exit once the interface is disconnected. + ============================== + Usage: icmp_responder [OPTIONS] + + Options: + -r Interface role <slave|master>. Default: slave + -s Socket path. Supports abstract socket using @ before the path. Default: /run/vpp/memif.sock + -i Interface id. Default: 0 + -a IPv4 address. Default: 192.168.1.1 + -h Mac address. Default: aa:aa:aa:aa:aa:aa + -? Show help and exit. + -v Show libmemif and memif version information and exit. + +Examples +-------- + +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. |