summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-id-ctrl.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-id-ctrl.txt
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-id-ctrl.txt20
1 files changed, 12 insertions, 8 deletions
diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt
index b9fcffc..3667c63 100644
--- a/Documentation/nvme-id-ctrl.txt
+++ b/Documentation/nvme-id-ctrl.txt
@@ -8,8 +8,8 @@ nvme-id-ctrl - Send NVMe Identify Controller, return result and structure
SYNOPSIS
--------
[verse]
-'nvme id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]
+'nvme id-ctrl' <device> [--vendor-specific | -V] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
@@ -30,7 +30,7 @@ OPTIONS
Print the raw buffer to stdout. Structure is not parsed by
program. This overrides the vendor specific and human readable options.
--v::
+-V::
--vendor-specific::
In addition to parsing known fields, this option will dump
the vendor specific region of the structure in hex with ascii
@@ -41,10 +41,14 @@ OPTIONS
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
@@ -61,7 +65,7 @@ the vendor unique field:
+
------------
# nvme id-ctrl /dev/nvme0 --vendor-specific
-# nvme id-ctrl /dev/nvme0 -v
+# nvme id-ctrl /dev/nvme0 -V
------------
+
The above will dump the 'vs' buffer in hex since it doesn't know how to