1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2019 Intel Corporation. 3 4NTB Sample Application 5====================== 6 7The ntb sample application shows how to use ntb rawdev driver. 8This sample provides interactive mode to transmit file between 9two hosts. 10 11Compiling the Application 12------------------------- 13 14To compile the sample application see :doc:`compiling`. 15 16The application is located in the ``ntb`` sub-directory. 17 18Running the Application 19----------------------- 20 21The application requires an available core for each port, plus one. 22The only available options are the standard ones for the EAL: 23 24.. code-block:: console 25 26 ./build/ntb_fwd -c 0xf -n 6 -- -i 27 28Refer to the *DPDK Getting Started Guide* for general information on 29running applications and the Environment Abstraction Layer (EAL) 30options. 31 32Using the application 33--------------------- 34 35The application is console-driven using the cmdline DPDK interface: 36 37.. code-block:: console 38 39 ntb> 40 41From this interface the available commands and descriptions of what 42they do as as follows: 43 44* ``send [filepath]``: Send file to the peer host. 45* ``receive [filepath]``: Receive file to [filepath]. Need the peer 46 to send file successfully first. 47* ``quit``: Exit program 48