summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-get-dev-capabilities-log.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:28:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-16 15:12:07 +0000
commit589986012c4b3ab68e299a2eadca18f90080113b (patch)
treef29a53b04a1950cdddae69344bccb3f0146fa728 /Documentation/nvme-wdc-get-dev-capabilities-log.txt
parentReleasing debian version 1.16-4. (diff)
downloadnvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.tar.xz
nvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.zip
Merging upstream version 2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-wdc-get-dev-capabilities-log.txt')
-rw-r--r--Documentation/nvme-wdc-get-dev-capabilities-log.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.txt b/Documentation/nvme-wdc-get-dev-capabilities-log.txt
new file mode 100644
index 0000000..0621881
--- /dev/null
+++ b/Documentation/nvme-wdc-get-dev-capabilities-log.txt
@@ -0,0 +1,48 @@
+nvme-wdc-get-dev-capabilities-log(1)
+====================================
+
+NAME
+----
+nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log
+ plugin command, return parsed log output
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc get-dev-capabilities-log' <device> [--output-format=<normal|json>
+-o <normal|json>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a WDC plugin get-dev-capabilities-log command
+and output the device capabilities log data. The --output-format option will
+format the output as specified.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0).
+
+This will only work on WDC devices supporting this log page.
+Results for any other device are undefined.
+
+On success it returns the parsed device capabilities log page data, error
+code otherwise.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+ Set the reporting format to 'normal', or
+ 'json'. Only one output format can be used at a time.
+ Default is normal.
+
+EXAMPLES
+--------
+* Has the program issue WDC get-dev-capabilities-log plugin command :
++
+------------
+# nvme wdc get-dev-capabilities-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.