X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Fpdump.rst;h=9da65424089bf0e587ba6f7feb0c63a70cbafb1f;hb=a5f51527b3157c32a7ac10f7f3ce147fa0211b5d;hp=96c8709e5fb5f8b52a2746777c682024fa3e4e35;hpb=e4ffa2d3dc7fcb2318db78ee963f5a3726a094b7;p=dpdk.git diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst index 96c8709e5f..9da6542408 100644 --- a/doc/guides/sample_app_ug/pdump.rst +++ b/doc/guides/sample_app_ug/pdump.rst @@ -40,7 +40,7 @@ is capable of enabling packet capture on dpdk ports. Running the Application ----------------------- -The application has a ``--pdump`` command line option with various sub arguments: +The application has a number of command line options: .. code-block:: console @@ -52,18 +52,31 @@ The application has a ``--pdump`` command line option with various sub arguments [ring-size=], [mbuf-size=], [total-num-mbufs=]' + [--server-socket-path=] + [--client-socket-path=] -Note: +The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in +below section. -* Parameters inside the parentheses represents mandatory parameters. + .. Note:: + + * Parameters inside the parentheses represents mandatory parameters. + + * Parameters inside the square brackets represents optional parameters. + + * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations. -* Parameters inside the square brackets represents optional parameters. +The ``--server-socket-path`` command line option is optional. This represents the server socket directory. +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` +for non root users. -Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations. +The ``--client-socket-path`` command line option is optional. This represents the client socket directory. +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` +for non root users. -Parameters -~~~~~~~~~~ +The ``--pdump`` parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~ ``port``: Port id of the eth device on which packets should be captured.