doc: replace tools guide license with SPDX tag
[dpdk.git] / doc / guides / tools / pmdinfo.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2016 Canonical Limited. All rights reserved.
3
4
5 dpdk-pmdinfo Application
6 ========================
7
8 The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) utility that
9 can dump a PMDs hardware support info.
10
11
12 Running the Application
13 -----------------------
14
15 The tool has a number of command line options:
16
17 .. code-block:: console
18
19    dpdk-pmdinfo [-hrtp] [-d <pci id file] <elf-file>
20
21    -h, --help            Show a short help message and exit
22    -r, --raw             Dump as raw json strings
23    -d FILE, --pcidb=FILE Specify a pci database to get vendor names from
24    -t, --table           Output information on hw support as a hex table
25    -p, --plugindir       Scan dpdk for autoload plugins
26
27 .. Note::
28
29    * Parameters inside the square brackets represents optional parameters.