summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-id-ctrl.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-id-ctrl.1')
-rw-r--r--Documentation/nvme-id-ctrl.122
1 files changed, 14 insertions, 8 deletions
diff --git a/Documentation/nvme-id-ctrl.1 b/Documentation/nvme-id-ctrl.1
index 0e4c7bc..f8acb1c 100644
--- a/Documentation/nvme-id-ctrl.1
+++ b/Documentation/nvme-id-ctrl.1
@@ -2,12 +2,12 @@
.\" Title: nvme-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/21/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-CTRL" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -32,8 +32,8 @@ nvme-id-ctrl \- Send NVMe Identify Controller, return result and structure
.SH "SYNOPSIS"
.sp
.nf
-\fInvme id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme id\-ctrl\fR <device> [\-\-vendor\-specific | \-V] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
@@ -49,7 +49,7 @@ On success, the structure may be returned in one of several ways depending on th
Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&.
.RE
.PP
-\-v, \-\-vendor\-specific
+\-V, \-\-vendor\-specific
.RS 4
In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii interpretation\&.
.RE
@@ -59,13 +59,19 @@ In addition to parsing known fields, this option will dump the vendor specific r
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
@@ -104,7 +110,7 @@ In addition to showing the known fields, has the program to display the vendor u
.\}
.nf
# nvme id\-ctrl /dev/nvme0 \-\-vendor\-specific
-# nvme id\-ctrl /dev/nvme0 \-v
+# nvme id\-ctrl /dev/nvme0 \-V
.fi
.if n \{\
.RE