From: Daniel Wagner Date: Tue, 19 Dec 2023 11:48:45 +0000 (+0100) Subject: doc: Regenerate all docs for v2.7 X-Git-Tag: v2.7^0 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=807a66cbdef368a9122c7de07837f4298249f5a7;p=users%2Fsagi%2Fnvme-cli.git doc: Regenerate all docs for v2.7 Signed-off-by: Daniel Wagner --- diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 4929a230..38d3e982 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -2,12 +2,12 @@ .\" Title: nvme-admin-passthru .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,23 +32,24 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results .SH "SYNOPSIS" .sp .nf -\fInvme\-admin\-passthru\fR [\-\-opcode= | \-o ] - [\-\-flags= | \-f ] [\-rsvd= | \-R ] - [\-\-namespace\-id= | \-n ] [\-\-cdw2= | \-2 ] - [\-\-cdw3= | \-3 ] [\-\-cdw10= | \-4 ] - [\-\-cdw11= | \-5 ] [\-\-cdw12= | \-6 ] - [\-\-cdw13= | \-7 ] [\-\-cdw14= | \-8 ] - [\-\-cdw15= | \-9 ] - [\-\-data\-len= | \-l ] - [\-\-metadata\-len= | \-m ] - [\-\-input\-file= | \-i ] - [\-\-read | \-r ] [\-\-write | \-w] - [\-\-timeout= | \-t ] - [\-\-show\-command | \-s] - [\-\-dry\-run | \-d] - [\-\-raw\-binary | \-b] - [\-\-prefill= | \-p ] - [\-\-latency | \-T] +\fInvme\-admin\-passthru\fR [\-\-opcode= | \-O ] + [\-\-flags= | \-f ] [\-rsvd= | \-R ] + [\-\-namespace\-id= | \-n ] [\-\-cdw2= | \-2 ] + [\-\-cdw3= | \-3 ] [\-\-cdw10= | \-4 ] + [\-\-cdw11= | \-5 ] [\-\-cdw12= | \-6 ] + [\-\-cdw13= | \-7 ] [\-\-cdw14= | \-8 ] + [\-\-cdw15= | \-9 ] + [\-\-data\-len= | \-l ] + [\-\-metadata\-len= | \-m ] + [\-\-input\-file= | \-i ] + [\-\-read | \-r] [\-\-write | \-w] + [\-\-timeout= | \-t ] + [\-\-show\-command | \-s] + [\-\-dry\-run | \-d] + [\-\-raw\-binary | \-b] + [\-\-prefill= | \-p ] + [\-\-latency | \-T] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -59,7 +60,7 @@ The parameter is mandatory and may be either the NVMe character device On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&. .SH "OPTIONS" .PP -\-o , \-\-opcode= +\-O , \-\-opcode= .RS 4 The NVMe opcode to send to the device in the command .RE @@ -131,6 +132,20 @@ Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may .RS 4 Print out the latency the IOCTL took (in us)\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index 59bc115d..8aa8b21b 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -749,23 +749,24 @@ nvme-admin-passthru(1) Manual Page

SYNOPSIS

-
nvme-admin-passthru <device> [--opcode=<opcode> | -o <opcode>]
-                [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
-                [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]
-                [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]
-                [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]
-                [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]
-                [--cdw15=<cdw15> | -9 <cdw9>]
-                [--data-len=<data-len> | -l <data-len>]
-                [--metadata-len=<len> | -m <len>]
-                [--input-file=<file> | -i <file>]
-                [--read | -r ] [--write | -w]
-                [--timeout=<to> | -t <to>]
-                [--show-command | -s]
-                [--dry-run | -d]
-                [--raw-binary | -b]
-                [--prefill=<prefill> | -p <prefill>]
-                [--latency | -T]
+
nvme-admin-passthru <device> [--opcode=<opcode> | -O <opcode>]
+                        [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
+                        [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]
+                        [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]
+                        [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]
+                        [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]
+                        [--cdw15=<cdw15> | -9 <cdw9>]
+                        [--data-len=<data-len> | -l <data-len>]
+                        [--metadata-len=<len> | -m <len>]
+                        [--input-file=<file> | -i <file>]
+                        [--read | -r] [--write | -w]
+                        [--timeout=<to> | -t <to>]
+                        [--show-command | -s]
+                        [--dry-run | -d]
+                        [--raw-binary | -b]
+                        [--prefill=<prefill> | -p <prefill>]
+                        [--latency | -T]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -790,7 +791,7 @@ printed to stdout for another program to parse.

--o <opcode> +-O <opcode>
--opcode=<opcode> @@ -961,6 +962,29 @@ printed to stdout for another program to parse.

Print out the latency the IOCTL took (in us).

+
+-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. +

+
@@ -1003,7 +1027,7 @@ Or if you want to save that structure to a file: diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1 index 28cbf41c..750acce0 100644 --- a/Documentation/nvme-ana-log.1 +++ b/Documentation/nvme-ana-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ana-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ANA\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ANA\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,8 @@ nvme-ana-log \- Send NVMe ANA log page request, returns result and log .SH "SYNOPSIS" .sp .nf -\fInvme ana\-log\fR [\-o | \-\-output\-format=] +\fInvme ana\-log\fR [\-\-groups | \-g] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -48,13 +49,19 @@ On success, the returned ANA log structure may be returned in one of several way Return the list of ANA groups without the namespace listing\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-ana-log.html b/Documentation/nvme-ana-log.html index db71a5c0..5eaad2fe 100644 --- a/Documentation/nvme-ana-log.html +++ b/Documentation/nvme-ana-log.html @@ -749,7 +749,8 @@ nvme-ana-log(1) Manual Page

SYNOPSIS

-
nvme ana-log <device> [-o <fmt> | --output-format=<fmt>]
+
nvme ana-log <device> [--groups | -g]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -778,19 +779,30 @@ printed to stdout for another program to parse.

- Return the list of ANA groups without the namespace listing. + Return the list of ANA groups without the namespace listing.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -823,7 +835,7 @@ Print the ANA log page in a human readable format: diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 68648692..16153aa1 100644 --- a/Documentation/nvme-attach-ns.1 +++ b/Documentation/nvme-attach-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-attach-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,6 +34,7 @@ nvme-attach-ns \- Send NVMe attach namespace, return result\&. .nf \fInvme attach\-ns\fR [\-\-namespace\-id= | \-n ] [\-\-controllers= | \-c ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,6 +50,20 @@ The namespace identifier to attach\&. .RS 4 The comma separated list of controller identifiers to attach the namespace too\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 .if n \{\ @@ -65,7 +80,7 @@ Attach namespace to the controller: .RS 4 .\} .nf -# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21 +# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21 .fi .if n \{\ .RE diff --git a/Documentation/nvme-attach-ns.html b/Documentation/nvme-attach-ns.html index 127aa335..5f3755e2 100644 --- a/Documentation/nvme-attach-ns.html +++ b/Documentation/nvme-attach-ns.html @@ -750,7 +750,8 @@ nvme-attach-ns(1) Manual Page 
nvme attach-ns <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--controllers=<ctrl-list,> | -c <ctrl-list,>]
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -790,6 +791,29 @@ controller identifiers.

the namespace too.

+
+-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. +

+
@@ -802,7 +826,7 @@ controller identifiers.

-
# nvme attach-ns /dev/nvme1  -n 0x2 -c 0x21
+
# nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
@@ -817,7 +841,7 @@ controller identifiers.

diff --git a/Documentation/nvme-boot-part-log.1 b/Documentation/nvme-boot-part-log.1 index 53b6dad7..01278930 100644 --- a/Documentation/nvme-boot-part-log.1 +++ b/Documentation/nvme-boot-part-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-boot-part-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-BOOT\-PART\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-BOOT\-PART\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,8 +33,8 @@ nvme-boot-part-log \- Retrieves a Boot Partition log page from an NVMe device .sp .nf \fInvme boot\-part\-log\fR [\-\-lsp= | \-s ] - [\-\-output\-file= | \-o ] - [\-\-output\-format= | \-o ] + [\-\-output\-file= | \-f ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -50,18 +50,24 @@ On success, the returned log structure will be in raw binary format \fIonly\fR w The log specified field of LID\&. .RE .PP -\-o , \-\-output\-file= +\-f , \-\-output\-file= .RS 4 File name to which raw binary data will be saved to\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-boot-part-log.html b/Documentation/nvme-boot-part-log.html index 02b0cdc7..5d32f219 100644 --- a/Documentation/nvme-boot-part-log.html +++ b/Documentation/nvme-boot-part-log.html @@ -750,8 +750,8 @@ nvme-boot-part-log(1) Manual Page 
nvme boot-part-log <device> [--lsp=<field> | -s <field>]
-                    [--output-file=<file> | -o <file>]
-                    [--output-format=<fmt> | -o <fmt>]
+ [--output-file=<file> | -f <file>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -783,7 +783,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <file> +-f <file>
--output-file=<file> @@ -794,15 +794,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -835,7 +846,7 @@ Retrieve Boot Partition data to boot_part_log.bin diff --git a/Documentation/nvme-capacity-mgmt.1 b/Documentation/nvme-capacity-mgmt.1 index c96ee58d..b01a58a3 100644 --- a/Documentation/nvme-capacity-mgmt.1 +++ b/Documentation/nvme-capacity-mgmt.1 @@ -2,12 +2,12 @@ .\" Title: nvme-capacity-mgmt .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CAPACITY\-MGMT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CAPACITY\-MGMT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,10 +32,11 @@ nvme-capacity-mgmt \- Send capacity management command to configure/create/delet .SH "SYNOPSIS" .sp .nf -\fInvme capacity\-mgmt\fR [\-\-operation= | \-o ] +\fInvme capacity\-mgmt\fR [\-\-operation= | \-O ] [\-\-element\-id= | \-i ] [\-\-cap\-lower= | \-l ] [\-\-cap\-upper= | \-u ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,7 +45,7 @@ For the NVMe device given, sends a capacity management command to configure/crea The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP -\-o , \-\-operation= +\-O , \-\-operation= .RS 4 Operation to be performed by the controller .RE @@ -63,6 +64,20 @@ Least significant 32 bits of the capacity in bytes of the Endurance Group or NVM .RS 4 Most significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples provided yet\&. diff --git a/Documentation/nvme-capacity-mgmt.html b/Documentation/nvme-capacity-mgmt.html index 3d17b8b0..a675f9d7 100644 --- a/Documentation/nvme-capacity-mgmt.html +++ b/Documentation/nvme-capacity-mgmt.html @@ -740,7 +740,7 @@ nvme-capacity-mgmt(1) Manual Page

NAME

nvme-capacity-mgmt - - Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results. + Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results.

@@ -749,10 +749,11 @@ nvme-capacity-mgmt(1) Manual Page

SYNOPSIS

-
nvme capacity-mgmt <device> [--operation=<operation> | -o <operation>]
+
nvme capacity-mgmt <device> [--operation=<operation> | -O <operation>]
                         [--element-id=<element-id> | -i <element-id>]
                         [--cap-lower=<cap-lower> | -l <cap-lower>]
-                        [--cap-upper=<cap-upper> | -u <cap-upper>]

+                        [--cap-upper=<cap-upper> | -u <cap-upper>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -774,14 +775,14 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <operation> +-O <operation>
--operation=<operation>

- Operation to be performed by the controller + Operation to be performed by the controller

@@ -792,7 +793,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

- Value specific to the value of the Operation field. + Value specific to the value of the Operation field.

@@ -804,7 +805,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Least significant 32 bits of the capacity in bytes of the Endurance Group or - NVM Set to be created + NVM Set to be created

@@ -816,7 +817,30 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Most significant 32 bits of the capacity in bytes of the Endurance Group or - NVM Set to be created + NVM Set to be created +

+ +
+-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.

@@ -839,7 +863,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Last updated - 2023-09-29 08:33:07 CEST + 2023-12-19 12:48:29 CET
diff --git a/Documentation/nvme-changed-ns-list-log.1 b/Documentation/nvme-changed-ns-list-log.1 index 5e39559c..154cc815 100644 --- a/Documentation/nvme-changed-ns-list-log.1 +++ b/Documentation/nvme-changed-ns-list-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-changed-ns-list-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CHANGED\-NS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CHANGED\-NS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-changed-ns-list-log \- Send NVMe Changed Namespace List log page request, r .sp .nf \fInvme changed\-ns\-list\-log\fR [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,13 +49,19 @@ On success, the returned Changed Namespace List log structure may be returned in Print the raw Changed Namespace List log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-changed-ns-list-log.html b/Documentation/nvme-changed-ns-list-log.html index 15ec1b97..2b3eac82 100644 --- a/Documentation/nvme-changed-ns-list-log.html +++ b/Documentation/nvme-changed-ns-list-log.html @@ -740,7 +740,7 @@ nvme-changed-ns-list-log(1) Manual Page

NAME

nvme-changed-ns-list-log - - Send NVMe Changed Namespace List log page request, returns result and log. + Send NVMe Changed Namespace List log page request, returns result and log.

@@ -750,7 +750,7 @@ nvme-changed-ns-list-log(1) Manual Page 
nvme changed-ns-list-log <device> [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -784,15 +784,26 @@ the raw buffer may be printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -835,7 +846,7 @@ Print the raw Changed Namespace List log to a file: diff --git a/Documentation/nvme-cmdset-ind-id-ns.1 b/Documentation/nvme-cmdset-ind-id-ns.1 index 09a2858a..55eacd3c 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.1 +++ b/Documentation/nvme-cmdset-ind-id-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-cmdset-ind-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CMDSET\-IND\-I" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CMDSET\-IND\-I" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,9 +33,8 @@ nvme-cmdset-ind-id-ns \- Send NVMe I/O Command Set Independent Identify Namespac .sp .nf \fInvme cmdset\-ind\-id\-ns\fR [\-\-namespace\-id= | \-n ] - [\-b | \-\-raw\-binary] - [\-\-human\-readable | \-H] - [\-\-output\-format= | \-o ] + [\-\-raw\-binary | \-b] [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -61,13 +60,19 @@ Print the raw buffer to stdout\&. Structure is not parsed by program\&. This ove This option will parse and format many of the bit fields into human\-readable formats\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-cmdset-ind-id-ns.html b/Documentation/nvme-cmdset-ind-id-ns.html index 387a375d..1e8b2a43 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.html +++ b/Documentation/nvme-cmdset-ind-id-ns.html @@ -750,9 +750,8 @@ nvme-cmdset-ind-id-ns(1) Manual Page 
nvme cmdset-ind-id-ns <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [-b | --raw-binary]
-                    [--human-readable | -H]
-                    [--output-format=<fmt> | -o <fmt>]
+ [--raw-binary | -b] [--human-readable | -H] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -815,15 +814,26 @@ raw buffer may be printed to stdout.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -879,7 +889,7 @@ Have the program return the raw structure in binary: diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index da550ce9..79d2f49a 100644 --- a/Documentation/nvme-compare.1 +++ b/Documentation/nvme-compare.1 @@ -2,12 +2,12 @@ .\" Title: nvme-compare .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -47,12 +47,13 @@ nvme-compare \- Send an NVMe Compare command, provide results [\-\-dir\-type= | \-T ] [\-\-dir\-spec= | \-S ] [\-\-dsm= | \-D ] - [\-\-show\-command | \-v] + [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t] [\-\-storage\-tag | \-g ] [\-\-storage\-tag\-check | \-C] [\-\-force] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -97,9 +98,6 @@ Metadata file\&. \-p , \-\-prinfo= .RS 4 Protection Information and check field\&. -.RE -.sp -+ .TS allbox tab(:); lt lt @@ -109,49 +107,38 @@ lt lt lt lt lt lt. T{ -.sp Bit T}:T{ -.sp Description T} T{ -.sp 3 T}:T{ -.sp PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&. T} T{ -.sp 2:0 T}:T{ -.sp PRCHK: Protection Information Check: T} T{ -.sp 2 T}:T{ -.sp Set to 1 enables checking the guard tag T} T{ -.sp 1 T}:T{ -.sp Set to 1 enables checking the application tag T} T{ -.sp 0 T}:T{ -.sp Set to 1 enables checking the reference tag T} .TE .sp 1 +.RE .PP \-m , \-\-app\-tag\-mask= .RS 4 @@ -188,7 +175,7 @@ Optional field for directive specifics\&. When used with write streams, this val The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&. .RE .PP -\-v, \-\-show\-cmd +\-V, \-\-show\-cmd .RS 4 Print out the command to be sent\&. .RE @@ -220,6 +207,20 @@ This flag enables Storage Tag field checking as part of end\-to\-end data protec .RS 4 Ignore namespace is currently busy and performed the operation even though\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-compare.html b/Documentation/nvme-compare.html index 9ee2c385..5da313ff 100644 --- a/Documentation/nvme-compare.html +++ b/Documentation/nvme-compare.html @@ -764,12 +764,13 @@ nvme-compare(1) Manual Page [--dir-type=<type> | -T <type>] [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>] - [--show-command | -v] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag<storage-tag> | -g <storage-tag>] [--storage-tag-check | -C] - [--force] + [--force] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -877,9 +878,6 @@ provided, then a comparison is also performed for the metadata.

Protection Information and check field.

- - -

+

-
+
-m <appmask>
@@ -1009,7 +1007,7 @@ metadata is passes.

--v +-V
--show-cmd @@ -1071,8 +1069,31 @@ metadata is passes.

- Ignore namespace is currently busy and performed the operation - even though. + Ignore namespace is currently busy and performed the operation + even though. +

+
+
+-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.

@@ -1095,7 +1116,7 @@ metadata is passes.

diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index 9e795f5d..81924087 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,37 +32,29 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&. .SH "SYNOPSIS" .sp .nf -\fInvme connect\-all\fR - [\-\-transport= | \-t ] - [\-\-nqn= | \-n ] - [\-\-traddr= | \-a ] - [\-\-trsvcid= | \-s ] - [\-\-host\-traddr= | \-w ] - [\-\-host\-iface= | \-f ] - [\-\-hostnqn= | \-q ] - [\-\-hostid= | \-I ] - [\-\-raw= | \-r ] - [\-\-device= | \-d ] - [\-\-cfg\-file= | \-C ] - [\-\-keep\-alive\-tmo= | \-k ] - [\-\-reconnect\-delay=<#> | \-c <#>] - [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] - [\-\-nr\-io\-queues=<#> | \-i <#>] - [\-\-nr\-write\-queues=<#> | \-W <#>] - [\-\-nr\-poll\-queues=<#> | \-P <#>] - [\-\-queue\-size=<#> | \-Q <#>] - [\-\-keyring=<#> ] - [\-\-tls_key=<#> ] - [\-\-hdr\-digest | \-g] - [\-\-data\-digest | \-G] - [\-\-persistent | \-p] - [\-\-tls ] - [\-\-quiet | \-S] - [\-\-dump\-config | \-O] - [\-\-nbft] - [\-\-no\-nbft] - [\-\-nbft\-path=] - [\-\-context=] +\fInvme connect\-all\fR [\-\-transport= | \-t ] + [\-\-nqn= | \-n ] + [\-\-traddr= | \-a ] + [\-\-trsvcid= | \-s ] + [\-\-host\-traddr= | \-w ] + [\-\-host\-iface= | \-f ] + [\-\-hostnqn= | \-q ] + [\-\-hostid= | \-I ] + [\-\-raw= | \-r ] + [\-\-device= | \-d ] + [\-\-cfg\-file= | \-C ] + [\-\-keep\-alive\-tmo= | \-k ] + [\-\-reconnect\-delay=<#> | \-c <#>] + [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] + [\-\-nr\-io\-queues=<#> | \-i <#>] + [\-\-nr\-write\-queues=<#> | \-W <#>] + [\-\-nr\-poll\-queues=<#> | \-P <#>] + [\-\-queue\-size=<#> | \-Q <#>] [\-\-keyring=<#>] + [\-\-tls_key=<#>] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] + [\-\-persistent | \-p] [\-\-tls] [\-\-quiet | \-S] + [\-\-dump\-config | \-O] [\-\-nbft] [\-\-no\-nbft] + [\-\-nbft\-path=] [\-\-context=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -266,6 +258,20 @@ Use a user\-defined path to the NBFT tables .RS 4 Set the execution context to \&. This allows to coordinate the management of the global resources\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 @@ -352,9 +358,9 @@ command using a /usr/local/etc/nvme/discovery\&.conf file: .RS 4 .\} .nf -# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the +# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the # Discovery Controller\*(Aqs two ports (some resources may only -# be accessible on a single port)\&. Note an official +# be accessible on a single port)\&. Note an official # nqn (Host) name defined in the NVMe specification is being used # in this example\&. \-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html index ced16c33..92e1dad8 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.html @@ -749,37 +749,29 @@ nvme-connect-all(1) Manual Page

SYNOPSIS

-
nvme connect-all
-                [--transport=<trtype>     | -t <trtype>]
-                [--nqn=<subnqn>           | -n <subnqn>]
-                [--traddr=<traddr>        | -a <traddr>]
-                [--trsvcid=<trsvcid>      | -s <trsvcid>]
-                [--host-traddr=<traddr>   | -w <traddr>]
-                [--host-iface=<iface>     | -f <iface>]
-                [--hostnqn=<hostnqn>      | -q <hostnqn>]
-                [--hostid=<hostid>        | -I <hostid>]
-                [--raw=<filename>         | -r <filename>]
-                [--device=<device>        | -d <device>]
-                [--cfg-file=<cfg>         | -C <cfg>]
-                [--keep-alive-tmo=<sec>   | -k <sec>]
-                [--reconnect-delay=<#>    | -c <#>]
-                [--ctrl-loss-tmo=<#>      | -l <#>]
-                [--nr-io-queues=<#>       | -i <#>]
-                [--nr-write-queues=<#>    | -W <#>]
-                [--nr-poll-queues=<#>     | -P <#>]
-                [--queue-size=<#>         | -Q <#>]
-                [--keyring=<#>                    ]
-                [--tls_key=<#>                    ]
-                [--hdr-digest             | -g]
-                [--data-digest            | -G]
-                [--persistent             | -p]
-                [--tls                        ]
-                [--quiet                  | -S]
-                [--dump-config            | -O]
-                [--nbft]
-                [--no-nbft]
-                [--nbft-path=<STR>]
-                [--context=<STR>]
+
nvme connect-all [--transport=<trtype> | -t <trtype>]
+                        [--nqn=<subnqn> | -n <subnqn>]
+                        [--traddr=<traddr> | -a <traddr>]
+                        [--trsvcid=<trsvcid> | -s <trsvcid>]
+                        [--host-traddr=<traddr> | -w <traddr>]
+                        [--host-iface=<iface> | -f <iface>]
+                        [--hostnqn=<hostnqn> | -q <hostnqn>]
+                        [--hostid=<hostid> | -I <hostid>]
+                        [--raw=<filename> | -r <filename>]
+                        [--device=<device> | -d <device>]
+                        [--cfg-file=<cfg> | -C <cfg>]
+                        [--keep-alive-tmo=<sec> | -k <sec>]
+                        [--reconnect-delay=<#> | -c <#>]
+                        [--ctrl-loss-tmo=<#>     | -l <#>]
+                        [--nr-io-queues=<#> | -i <#>]
+                        [--nr-write-queues=<#> | -W <#>]
+                        [--nr-poll-queues=<#> | -P <#>]
+                        [--queue-size=<#> | -Q <#>] [--keyring=<#>]
+                        [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]
+                        [--persistent | -p] [--tls] [--quiet | -S]
+                        [--dump-config | -O] [--nbft] [--no-nbft]
+                        [--nbft-path=<STR>] [--context=<STR>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -813,7 +805,7 @@ background.

This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include:

- This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420.

@@ -1178,6 +1170,29 @@ cellspacing="0" cellpadding="4"> the management of the global resources.

+
+-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. +

+
@@ -1221,9 +1236,9 @@ Issue a nvme connect-all command using a /usr/local/etc/nvme/discovery.

-
# Machine default 'nvme discover' commands.  Query the
+
# Machine default 'nvme discover' commands. Query the
 # Discovery Controller's two ports (some resources may only
-# be accessible on a single port).  Note an official
+# be accessible on a single port). Note an official
 # nqn (Host) name defined in the NVMe specification is being used
 # in this example.
 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@@ -1253,7 +1268,7 @@ nvme-connect(1)
diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 40527ac9..e8d461b5 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,36 +32,29 @@ nvme-connect \- Connect to a Fabrics controller\&. .SH "SYNOPSIS" .sp .nf -\fInvme connect\fR - [\-\-transport= | \-t ] - [\-\-nqn= | \-n ] - [\-\-traddr= | \-a ] - [\-\-trsvcid= | \-s ] - [\-\-host\-traddr= | \-w ] - [\-\-host\-iface= | \-f ] - [\-\-hostnqn= | \-q ] - [\-\-hostid= | \-I ] - [\-\-config\-file= | \-J ] - [\-\-dhchap\-secret= | \-S ] - [\-\-dhchap\-ctrl\-secret= | \-C ] - [\-\-nr\-io\-queues=<#> | \-i <#>] - [\-\-nr\-write\-queues=<#> | \-W <#>] - [\-\-nr\-poll\-queues=<#> | \-P <#>] - [\-\-queue\-size=<#> | \-Q <#>] - [\-\-keep\-alive\-tmo=<#> | \-k <#>] - [\-\-reconnect\-delay=<#> | \-c <#>] - [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] - [\-\-tos=<#> | \-T <#>] - [\-\-keyring=<#> ] - [\-\-tls_key=<#> ] - [\-\-duplicate\-connect | \-D] - [\-\-disable\-sqflow | \-d] - [\-\-hdr\-digest | \-g] - [\-\-data\-digest | \-G] - [\-\-tls ] - [\-\-dump\-config | \-O] - [\-\-output\-format= | \-o ] - [\-\-context= ] +\fInvme connect\fR [\-\-transport= | \-t ] + [\-\-nqn= | \-n ] + [\-\-traddr= | \-a ] + [\-\-trsvcid= | \-s ] + [\-\-host\-traddr= | \-w ] + [\-\-host\-iface= | \-f ] + [\-\-hostnqn= | \-q ] + [\-\-hostid= | \-I ] + [\-\-config\-file= | \-J ] + [\-\-dhchap\-secret= | \-S ] + [\-\-dhchap\-ctrl\-secret= | \-C ] + [\-\-nr\-io\-queues=<#> | \-i <#>] + [\-\-nr\-write\-queues=<#> | \-W <#>] + [\-\-nr\-poll\-queues=<#> | \-P <#>] + [\-\-queue\-size=<#> | \-Q <#>] + [\-\-keep\-alive\-tmo=<#> | \-k <#>] + [\-\-reconnect\-delay=<#> | \-c <#>] + [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-tos=<#> | \-T <#>] + [\-\-keyring=<#>] [\-\-tls_key=<#>] + [\-\-duplicate\-connect | \-D] [\-\-disable\-sqflow | \-d] + [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] [\-\-tls] + [\-\-dump\-config | \-O] [\-\-application=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -154,7 +147,7 @@ to not read in an existing configuration file\&. The JSON configuration file for \-S , \-\-dhchap\-secret= .RS 4 NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8 -\fISecret representation\fR\&. If this option is not specified, the default is read from /usr/local/etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&. +\fISecret representation\fR\&. .RE .PP \-C , \-\-dhchap\-ctrl\-secret= @@ -243,17 +236,23 @@ Enable TLS encryption (TCP)\&. Print out resulting JSON configuration file to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-\-context +.RS 4 +Set the execution context to \&. This allows to coordinate the management of the global resources\&. +.RE +.PP +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR +\fInormal\fR, +\fIjson\fR or -\fIjson\fR\&. Only one output format can be used at a time\&. When this option is specified, the device associated with the connection will be printed\&. Nothing is printed otherwise\&. +\fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP -\-\-context +\-v, \-\-verbose .RS 4 -Set the execution context to \&. This allows to coordinate the management of the global resources\&. +Increase the information detail in the output\&. .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index 7b0c2e63..a9c4cbdb 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -749,36 +749,29 @@ nvme-connect(1) Manual Page

SYNOPSIS

-
nvme connect
-                [--transport=<trtype>     | -t <trtype>]
-                [--nqn=<subnqn>           | -n <subnqn>]
-                [--traddr=<traddr>        | -a <traddr>]
-                [--trsvcid=<trsvcid>      | -s <trsvcid>]
-                [--host-traddr=<traddr>   | -w <traddr>]
-                [--host-iface=<iface>     | -f <iface>]
-                [--hostnqn=<hostnqn>      | -q <hostnqn>]
-                [--hostid=<hostid>        | -I <hostid>]
-                [--config-file=<cfg>      | -J <cfg> ]
-                [--dhchap-secret=<secret> | -S <secret>]
-                [--dhchap-ctrl-secret=<secret> | -C <secret>]
-                [--nr-io-queues=<#>       | -i <#>]
-                [--nr-write-queues=<#>    | -W <#>]
-                [--nr-poll-queues=<#>     | -P <#>]
-                [--queue-size=<#>         | -Q <#>]
-                [--keep-alive-tmo=<#>     | -k <#>]
-                [--reconnect-delay=<#>    | -c <#>]
-                [--ctrl-loss-tmo=<#>      | -l <#>]
-                [--tos=<#>                | -T <#>]
-                [--keyring=<#>                    ]
-                [--tls_key=<#>                    ]
-                [--duplicate-connect      | -D]
-                [--disable-sqflow         | -d]
-                [--hdr-digest             | -g]
-                [--data-digest            | -G]
-                [--tls                        ]
-                [--dump-config            | -O]
-                [--output-format=<fmt>    | -o <fmt>]
-                [--application=<id>                 ]
+
nvme connect [--transport=<trtype> | -t <trtype>]
+                        [--nqn=<subnqn> | -n <subnqn>]
+                        [--traddr=<traddr> | -a <traddr>]
+                        [--trsvcid=<trsvcid> | -s <trsvcid>]
+                        [--host-traddr=<traddr> | -w <traddr>]
+                        [--host-iface=<iface> | -f <iface>]
+                        [--hostnqn=<hostnqn> | -q <hostnqn>]
+                        [--hostid=<hostid> | -I <hostid>]
+                        [--config-file=<cfg> | -J <cfg>]
+                        [--dhchap-secret=<secret> | -S <secret>]
+                        [--dhchap-ctrl-secret=<secret> | -C <secret>]
+                        [--nr-io-queues=<#> | -i <#>]
+                        [--nr-write-queues=<#> | -W <#>]
+                        [--nr-poll-queues=<#> | -P <#>]
+                        [--queue-size=<#> | -Q <#>]
+                        [--keep-alive-tmo=<#> | -k <#>]
+                        [--reconnect-delay=<#> | -c <#>]
+                        [--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>]
+                        [--keyring=<#>] [--tls_key=<#>]
+                        [--duplicate-connect | -D] [--disable-sqflow | -d]
+                        [--hdr-digest | -g] [--data-digest | -G] [--tls]
+                        [--dump-config | -O] [--application=<id>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -804,7 +797,7 @@ specified by the --nqn option.

This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include:

- This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420.

@@ -953,9 +946,6 @@ cellspacing="0" cellpadding="4">

NVMe In-band authentication secret; needs to be in ASCII format as specified in NVMe 2.0 section 8.13.5.8 Secret representation. - If this option is not specified, the default is read from - /usr/local/etc/nvme/hostkey. If that does not exist no in-band authentication - is attempted.

@@ -1144,25 +1134,35 @@ cellspacing="0" cellpadding="4">

--o <format> +--context <STR>
+
+

+ Set the execution context to <STR>. This allows to coordinate + the management of the global resources. +

+
---output-format=<format> +-o <fmt> +
+
+--output-format=<fmt>

- Set the reporting format to normal or json. Only one output format can - be used at a time. When this option is specified, the device associated with - the connection will be printed. Nothing is printed otherwise. + Set the reporting format to normal, json or binary. Only one + output format can be used at a time.

---context <STR> +-v +
+
+--verbose

- Set the execution context to <STR>. This allows to coordinate - the management of the global resources. + Increase the information detail in the output.

@@ -1211,7 +1211,7 @@ and Christoph Hellwig

diff --git a/Documentation/nvme-copy.1 b/Documentation/nvme-copy.1 index 42284514..8c4a0878 100644 --- a/Documentation/nvme-copy.1 +++ b/Documentation/nvme-copy.1 @@ -2,12 +2,12 @@ .\" Title: nvme-copy .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COPY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-COPY" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -35,6 +35,8 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results \fInvme\-copy\fR [\-\-sdlba= | \-d ] [\-\-blocks= | \-b ] [\-\-slbs= | \-s ] + [\-\-snsids= | \-N ] + [\-\-sopts= | \-O ] [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-prinfow= | \-p ] @@ -48,91 +50,116 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results [\-\-dir\-type= | \-T ] [\-\-dir\-spec= | \-S ] [\-\-format= | \-F ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&. .SH "OPTIONS" .PP -\-\-sdlba=, \-d +\-d , \-\-sdlba= .RS 4 64\-bit addr of first destination logical block .RE .PP -\-\-blocks=, \-b +\-b , \-\-blocks= .RS 4 Comma separated list of the number of blocks in each range .RE .PP -\-\-slbs=, \-s +\-s , \-\-slbs= .RS 4 Comma separated list of the starting blocks in each range .RE .PP -\-\-limited\-retry, \-l +\-\-snsids=, \-N +.RS 4 +Comma separated list of the source namespace identifiers in each range +.RE +.PP +\-\-sopts=, \-O +.RS 4 +Comma separated list of the source options in each range +.RE +.PP +\-l, \-\-limited\-retry .RS 4 Sets the limited retry flag\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE .PP -\-\-prinfow=, \-p +\-p , \-\-prinfow= .RS 4 Protection Information field write definition\&. .RE .PP -\-\-prinfor=, \-P +\-P , \-\-prinfor= .RS 4 Protection Information field read definition\&. .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 initial lba reference tag\&. .RE .PP -\-\-expected\-ref\-tags=, \-R +\-R , \-\-expected\-ref\-tags= .RS 4 expected lba reference tags (comma\-separated list)\&. .RE .PP -\-\-app\-tag=, \-a +\-a , \-\-app\-tag= .RS 4 lba app tag .RE .PP -\-\-expected\-app\-tags=, \-A +\-A , \-\-expected\-app\-tags= .RS 4 expected lba app tags (comma\-separated list) .RE .PP -\-\-app\-mask=, \-m +\-m , \-\-app\-mask= .RS 4 lba tag mask .RE .PP -\-\-expected\-app\-masks=, \-M +\-M , \-\-expected\-app\-masks= .RS 4 expected lba tag masks (comma\-separated list) .RE .PP -\-\-dir\-type=, \-T +\-T , \-\-dir\-type= .RS 4 Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&. .RE .PP -\-\-dir\-spec=, \-S +\-S , \-\-dir\-spec= .RS 4 Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&. .RE .PP -\-\-format=, \-F +\-F , \-\-format= .RS 4 source range entry format .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-copy.html b/Documentation/nvme-copy.html index e9f7ee31..fb11b909 100644 --- a/Documentation/nvme-copy.html +++ b/Documentation/nvme-copy.html @@ -752,6 +752,8 @@ nvme-copy(1) Manual Page 
nvme-copy <device> [--sdlba=<sdlba> | -d <sdlba>]
                         [--blocks=<nlb-list,> | -b <nlb-list,>]
                         [--slbs=<slbas,> | -s <slbas,>]
+                        [--snsids=<snsids,> | -N <snsids,>]
+                        [--sopts=<sopts,> | -O <sopts,>]
                         [--limited-retry | -l]
                         [--force-unit-access | -f]
                         [--prinfow=<prinfow> | -p <prinfow>]
@@ -764,7 +766,8 @@ nvme-copy(1) Manual Page
                         [--expected-app-masks=<appmask,> | -M <appmask,>]
                         [--dir-type=<type> | -T <type>]
                         [--dir-spec=<spec> | -S <spec>]
-                        [--format=<entry-format> | -F <entry-format>]
+ [--format=<entry-format> | -F <entry-format>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -781,10 +784,10 @@ logical block ranges to a single consecutive destination logical block range.

---sdlba=<sdlba> +-d <sdlba>
--d <sdlba> +--sdlba=<sdlba>

@@ -792,10 +795,10 @@ logical block ranges to a single consecutive destination logical block range.

---blocks=<nlb-list,> +-b <nlb-list,>
--b <nlb-list,> +--blocks=<nlb-list,>

@@ -803,10 +806,10 @@ logical block ranges to a single consecutive destination logical block range.

---slbs=<slbas,> +-s <slbas,>
--s <slbas,> +--slbs=<slbas,>

@@ -814,21 +817,43 @@ logical block ranges to a single consecutive destination logical block range.

---limited-retry +--snsids=<snsids,> +
+
+-N <snsids,> +
+
+

+ Comma separated list of the source namespace identifiers in each range +

+
+
+--sopts=<sopts,>
+-O <sopts,> +
+
+

+ Comma separated list of the source options in each range +

+
+
-l
+
+--limited-retry +

Sets the limited retry flag.

---force-unit-access +-f
--f +--force-unit-access

@@ -836,10 +861,10 @@ logical block ranges to a single consecutive destination logical block range.

---prinfow=<prinfow> +-p <prinfow>
--p <prinfow> +--prinfow=<prinfow>

@@ -847,10 +872,10 @@ logical block ranges to a single consecutive destination logical block range.

---prinfor=<prinfor> +-P <prinfor>
--P <prinfor> +--prinfor=<prinfor>

@@ -858,10 +883,10 @@ logical block ranges to a single consecutive destination logical block range.

---ref-tag=<reftag> +-r <reftag>
--r <reftag> +--ref-tag=<reftag>

@@ -869,10 +894,10 @@ logical block ranges to a single consecutive destination logical block range.

---expected-ref-tags=<reftag,> +-R <reftag,>
--R <reftag,> +--expected-ref-tags=<reftag,>

@@ -880,10 +905,10 @@ logical block ranges to a single consecutive destination logical block range.

---app-tag=<apptag> +-a <apptag>
--a <apptag> +--app-tag=<apptag>

@@ -891,10 +916,10 @@ logical block ranges to a single consecutive destination logical block range.

---expected-app-tags=<apptag,> +-A <apptag,>
--A <apptag,> +--expected-app-tags=<apptag,>

@@ -902,10 +927,10 @@ logical block ranges to a single consecutive destination logical block range.

---app-mask=<appmask> +-m <appmask>
--m <appmask> +--app-mask=<appmask>

@@ -913,10 +938,10 @@ logical block ranges to a single consecutive destination logical block range.

---expected-app-masks=<appmask,> +-M <appmask,>
--M <appmask,> +--expected-app-masks=<appmask,>

@@ -924,10 +949,10 @@ logical block ranges to a single consecutive destination logical block range.

---dir-type=<type> +-T <type>
--T <type> +--dir-type=<type>

@@ -938,10 +963,10 @@ logical block ranges to a single consecutive destination logical block range.

---dir-spec=<spec> +-S <spec>
--S <spec> +--dir-spec=<spec>

@@ -952,16 +977,39 @@ logical block ranges to a single consecutive destination logical block range.

---format=<entry-format> +-F <entry-format>
--F <entry-format> +--format=<entry-format>

source range entry format

+
+-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. +

+
@@ -982,7 +1030,7 @@ logical block ranges to a single consecutive destination logical block range.

Last updated - 2023-09-29 08:33:07 CEST + 2023-12-19 12:48:29 CET
diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index a63aaadf..9fe02794 100644 --- a/Documentation/nvme-create-ns.1 +++ b/Documentation/nvme-create-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-create-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CREATE\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CREATE\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,6 +39,7 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re [\-\-nmic= | \-m ] [\-\-anagrp\-id= | \-a ] [\-\-nvmset\-id= | \-i ] + [\-\-endg\-id= | \-e ] [\-\-csi= | \-y ] [\-\-lbstm= | \-l ] [\-\-nphndls= | \-n ] @@ -48,9 +49,10 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re [\-\-ncap\-si= | \-C ] [\-\-azr | \-z] [\-\-rar= | \-r ] - [\-\-ror= | \-o ] + [\-\-ror= | \-O ] [\-\-rnumzrwa= | \-u ] [\-\-phndls= | \-p ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -94,6 +96,11 @@ ANA Group Identifier\&. If this value is 0h specifies that the controller determ This field specifies the identifier of the NVM Set\&. .RE .PP +\-e , \-\-endg\-id= +.RS 4 +This field specifies the identifier of the endurance group\&. +.RE +.PP \-y , \-\-csi= .RS 4 This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&. @@ -134,7 +141,7 @@ Allocate ZRWA Resources\&. If set to 1, then the namespace is to be created with Requested Active Resources\&. This field specifies the number of active resources to be allocated to the created namespace\&. .RE .PP -\-o , \-\-ror= +\-O , \-\-ror= .RS 4 Requested Open Resources\&. This field specifies the number of open resources to be allocated to the created namespace\&. .RE @@ -148,6 +155,20 @@ Requested Number of ZRWA Resources\&. This field specifies the number of ZRWA re .RS 4 The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-create-ns.html b/Documentation/nvme-create-ns.html index c36f5b04..4d5a1d23 100644 --- a/Documentation/nvme-create-ns.html +++ b/Documentation/nvme-create-ns.html @@ -766,9 +766,10 @@ nvme-create-ns(1) Manual Page [--ncap-si=<ncap-si> | -C <ncap-si>] [--azr | -z] [--rar=<rar> | -r <rar>] - [--ror=<ror> | -o <ror>] + [--ror=<ror> | -O <ror>] [--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>] - [--phndls=<placement-handle-list,> | -p <placement-handle-list,>] + [--phndls=<placement-handle-list,> | -p <placement-handle-list,>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -922,8 +923,8 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Target block size the new namespace should be formatted as. Potential FLBAS - values will be values will be scanned and the lowest numbered will be - selected for the create-ns operation. Conflicts with --flbas argument. + values will be values will be scanned and the lowest numbered will be + selected for the create-ns operation. Conflicts with --flbas argument.

@@ -979,7 +980,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <ror> +-O <ror>
--ror=<ror> @@ -1014,6 +1015,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+-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. +

+
@@ -1045,7 +1069,7 @@ Create a namespace: diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index d50ed5d5..3b181f44 100644 --- a/Documentation/nvme-delete-ns.1 +++ b/Documentation/nvme-delete-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ nvme-delete-ns \- Send NVMe Namespace Management delete namespace command, retur .sp .nf \fInvme delete\-ns\fR [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -45,6 +46,20 @@ The parameter is mandatory and may be either the NVMe character device .RS 4 The namespace identifier to delete\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-delete-ns.html b/Documentation/nvme-delete-ns.html index 7db9073f..78b03a43 100644 --- a/Documentation/nvme-delete-ns.html +++ b/Documentation/nvme-delete-ns.html @@ -749,7 +749,8 @@ nvme-id-ns(1) Manual Page

SYNOPSIS

-
nvme delete-ns <device> [--namespace-id=<nsid> | -n <nsid>]
+
nvme delete-ns <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -779,6 +780,29 @@ The '--namespace-id' option is mandatory.

The namespace identifier to delete.

+
+-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. +

+
@@ -799,7 +823,7 @@ The '--namespace-id' option is mandatory.

diff --git a/Documentation/nvme-dera-stat.1 b/Documentation/nvme-dera-stat.1 index 8a206ed9..8570ebdd 100644 --- a/Documentation/nvme-dera-stat.1 +++ b/Documentation/nvme-dera-stat.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dera-stat .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DERA\-STAT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DERA\-STAT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dera-stat.html b/Documentation/nvme-dera-stat.html index 0dee6a38..d0841afa 100644 --- a/Documentation/nvme-dera-stat.html +++ b/Documentation/nvme-dera-stat.html @@ -797,7 +797,7 @@ Print the Dera Device status and Additional SMART log page in a human readable f diff --git a/Documentation/nvme-detach-ns.1 b/Documentation/nvme-detach-ns.1 index 824166bd..53736d34 100644 --- a/Documentation/nvme-detach-ns.1 +++ b/Documentation/nvme-detach-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-detach-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DETACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DETACH\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,6 +34,7 @@ nvme-detach-ns \- Send NVMe detach namespace, return result\&. .nf \fInvme detach\-ns\fR [\-\-namespace\-id= | \-n ] [\-\-controllers= | \-c + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -45,10 +46,24 @@ For the NVMe device given, sends the nvme namespace detach command for the provi The namespace identifier to detach\&. .RE .PP -\-c , \-controllers= +\-c , \-\-controllers= .RS 4 The comma separated list of controller identifiers to detach the namespace from\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-detach-ns.html b/Documentation/nvme-detach-ns.html index 0b6e5839..9b9a497d 100644 --- a/Documentation/nvme-detach-ns.html +++ b/Documentation/nvme-detach-ns.html @@ -750,7 +750,8 @@ nvme-detach-ns(1) Manual Page 
nvme detach-ns <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--controllers=<ctrl-list,> | -c <ctrl-list,>
+ [--controllers=<ctrl-list,> | -c <ctrl-list,> + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -782,7 +783,7 @@ controller identifiers.

-c <ctrl-list,>
--controllers=<ctrl-list,> +--controllers=<ctrl-list,>

@@ -790,6 +791,29 @@ controller identifiers.

the namespace from.

+
+-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. +

+
@@ -810,7 +834,7 @@ controller identifiers.

diff --git a/Documentation/nvme-device-self-test.1 b/Documentation/nvme-device-self-test.1 index 393bd02b..0721413a 100644 --- a/Documentation/nvme-device-self-test.1 +++ b/Documentation/nvme-device-self-test.1 @@ -2,12 +2,12 @@ .\" Title: nvme-device-self-test .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DEVICE\-SELF\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DEVICE\-SELF\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,8 @@ nvme-device-self-test \- Perform the necessary tests to observe the performance .sp .nf \fInvme device\-self\-test\fR [\-\-namespace\-id= | \-n ] - [\-\-self\-test\-code= | \-s ] [\-\-wait | \-w] + [\-\-self\-test\-code= | \-s ] [\-\-wait | \-w] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -58,6 +59,20 @@ This field specifies the action taken by the device self\-test command : 0h: Sho .RS 4 Wait for the device self test to complete before exiting The device self\-test is aborted by SIGINT signal interrupt for the wait The option is ignored if the abort self\-test code option specified\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-device-self-test.html b/Documentation/nvme-device-self-test.html index f2180a94..a473ea55 100644 --- a/Documentation/nvme-device-self-test.html +++ b/Documentation/nvme-device-self-test.html @@ -750,7 +750,8 @@ nvme-device-self-test(1) Manual Page 
nvme device-self-test <device> [--namespace-id=<NUM> | -n <NUM>]
-                        [--self-test-code=<NUM> | -s <NUM>]  [--wait | -w]
+ [--self-test-code=<NUM> | -s <NUM>] [--wait | -w] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -809,6 +810,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+-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. +

+
@@ -848,7 +872,7 @@ Abort the device self-test operation in the namespace-id 1: diff --git a/Documentation/nvme-dim.1 b/Documentation/nvme-dim.1 index c417d2eb..c5d35996 100644 --- a/Documentation/nvme-dim.1 +++ b/Documentation/nvme-dim.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dim .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DIM" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,10 +32,9 @@ nvme-dim \- Send Discovery Information Management command to one or more Discove .SH "SYNOPSIS" .sp .nf -\fInvme dim\fR - [\-\-task= | \-t ] - [\-\-nqn= | \-n ] - [\-\-device= | \-d ] +\fInvme dim\fR [\-\-task= | \-t ] [\-\-nqn= | \-n ] + [\-\-device= | \-d ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -62,6 +61,20 @@ The DIM command will be sent to the Discovery Controller (DC) matching this NQN\ .RS 4 The DIM command will be sent to the Discovery Controllers (DC) associated with this NVMe device handle\&. A list of comma\-separated device handles can be supplied to apply the command to more than one DC\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-dim.html b/Documentation/nvme-dim.html index e31d59a3..612d67b5 100644 --- a/Documentation/nvme-dim.html +++ b/Documentation/nvme-dim.html @@ -749,10 +749,9 @@ nvme-dim(1) Manual Page

SYNOPSIS

-
nvme dim
-                [--task=<task>     | -t <task>]
-                [--nqn=<nqn>       | -n <nqn>]
-                [--device=<device> | -d <device>]
+
nvme dim [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]
+                        [--device=<device> | -d <device>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -817,6 +816,29 @@ with the nvme-discover(1) command using the --persistent option.

be supplied to apply the command to more than one DC.

+
+-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. +

+
@@ -863,7 +885,7 @@ Deregister from Central Discovery Controller (CDC) associated with nvme4 diff --git a/Documentation/nvme-dir-receive.1 b/Documentation/nvme-dir-receive.1 index f34b23ee..ccf83a72 100644 --- a/Documentation/nvme-dir-receive.1 +++ b/Documentation/nvme-dir-receive.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-receive .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-RECEIVE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-RECEIVE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,13 +33,13 @@ nvme-dir-receive \- Send a directive receive command, returns applicable results .sp .nf \fInvme dir\-receive\fR [\-\-namespace\-id= | \-n ] - [\-\-data\-len= | \-l ] - [\-\-dir\-type= | \-D ] - [\-\-dir\-spec= | \-S ] - [\-\-dir\-oper= | \-O ] - [\-\-req\-resource= | \-r ] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] + [\-\-data\-len= | \-l ] + [\-\-dir\-type= | \-D ] + [\-\-dir\-spec= | \-S ] + [\-\-dir\-oper= | \-O ] + [\-\-req\-resource= | \-r ] + [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -73,9 +73,6 @@ Directive operation \-r , \-\-req\-resource= .RS 4 Directive requested resource count -.RE -.sp -+ .TS allbox tab(:); lt lt @@ -85,49 +82,38 @@ lt lt lt lt lt lt. T{ -.sp Select T}:T{ -.sp Description T} T{ -.sp 0 T}:T{ -.sp Current T} T{ -.sp 1 T}:T{ -.sp Default T} T{ -.sp 2 T}:T{ -.sp Saved T} T{ -.sp 3 T}:T{ -.sp Supported capabilities T} T{ -.sp 4\(en7 T}:T{ -.sp Reserved T} .TE .sp 1 +.RE .PP \-l , \-\-data\-len= .RS 4 @@ -143,6 +129,20 @@ Print the raw receive buffer to stdout if the command returns a structure\&. .RS 4 Print the decoded receive buffer to stdout if the command returns a structure\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-dir-receive.html b/Documentation/nvme-dir-receive.html index 64ecda39..5d3d87d8 100644 --- a/Documentation/nvme-dir-receive.html +++ b/Documentation/nvme-dir-receive.html @@ -750,13 +750,13 @@ nvme-dir-receive(1) Manual Page 
nvme dir-receive <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--dir-type=<dtype> | -D <dtype>]
-                          [--dir-spec=<dspec> | -S <dspec>]
-                          [--dir-oper=<doper> | -O <doper>]
-                          [--req-resource=<nsr> | -r <nsr>]
-                          [--human-readable | -H]
-                          [--raw-binary | -b]
+ [--data-len=<data-len> | -l <data-len>] + [--dir-type=<dtype> | -D <dtype>] + [--dir-spec=<dspec> | -S <dspec>] + [--dir-oper=<doper> | -O <doper>] + [--req-resource=<nsr> | -r <nsr>] + [--human-readable | -H] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -835,9 +835,6 @@ printed to stdout for another program to parse.

Directive requested resource count

- - -

+

-
+
-l <data-len>
@@ -911,6 +908,29 @@ cellspacing="0" cellpadding="4"> a structure.

+
+-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. +

+
@@ -969,7 +989,7 @@ Get streams directive status : diff --git a/Documentation/nvme-dir-send.1 b/Documentation/nvme-dir-send.1 index 7476e8b9..41b1f781 100644 --- a/Documentation/nvme-dir-send.1 +++ b/Documentation/nvme-dir-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,14 +33,14 @@ nvme-dir-send \- Issue a directive send command, returns applicable results .sp .nf \fInvme dir\-send\fR [\-\-namespace\-id= | \-n ] - [\-\-data\-len= | \-l ] - [\-\-dir\-type= | \-D ] - [\-\-dir\-spec= | \-S ] - [\-\-dir\-oper= | \-O ] - [\-\-endir= | \-e ] - [\-\-target\-dir= | \-T ] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] + [\-\-data\-len= | \-l ] + [\-\-dir\-type= | \-D ] + [\-\-dir\-spec= | \-S ] + [\-\-dir\-oper= | \-O ] + [\-\-endir= | \-e ] + [\-\-target\-dir= | \-T ] + [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -79,9 +79,6 @@ Target directive of the operation \-e , \-\-endir= .RS 4 Target directive enable(1) or disable (0) operation -.RE -.sp -+ .TS allbox tab(:); lt lt @@ -91,49 +88,38 @@ lt lt lt lt lt lt. T{ -.sp Select T}:T{ -.sp Description T} T{ -.sp 0 T}:T{ -.sp Current T} T{ -.sp 1 T}:T{ -.sp Default T} T{ -.sp 2 T}:T{ -.sp Saved T} T{ -.sp 3 T}:T{ -.sp Supported capabilities T} T{ -.sp 4\(en7 T}:T{ -.sp Reserved T} .TE .sp 1 +.RE .PP \-l , \-\-data\-len= .RS 4 @@ -149,6 +135,20 @@ Print the raw receive buffer to stdout if the command returns a structure\&. .RS 4 Print the decoded receive buffer to stdout if the command returns a structure\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-dir-send.html b/Documentation/nvme-dir-send.html index 20d0c638..edad38ec 100644 --- a/Documentation/nvme-dir-send.html +++ b/Documentation/nvme-dir-send.html @@ -750,14 +750,14 @@ nvme-dir-send(1) Manual Page 
nvme dir-send <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--dir-type=<dtype> | -D <dtype>]
-                          [--dir-spec=<dspec> | -S <dspec>]
-                          [--dir-oper=<doper> | -O <doper>]
-                          [--endir=<endir> | -e <endir>]
-                          [--target-dir=<tdir> | -T <tdir>]
-                          [--human-readable | -H]
-                          [--raw-binary | -b]
+ [--data-len=<data-len> | -l <data-len>] + [--dir-type=<dtype> | -D <dtype>] + [--dir-spec=<dspec> | -S <dspec>] + [--dir-oper=<doper> | -O <doper>] + [--endir=<endir> | -e <endir>] + [--target-dir=<tdir> | -T <tdir>] + [--human-readable | -H] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -848,9 +848,6 @@ printed to stdout for another program to parse.

Target directive enable(1) or disable (0) operation

- - -

+

-
+
-l <data-len>
@@ -924,6 +921,29 @@ cellspacing="0" cellpadding="4"> a structure.

+
+-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. +

+
@@ -982,7 +1002,7 @@ Release stream ID 3 : diff --git a/Documentation/nvme-disconnect-all.1 b/Documentation/nvme-disconnect-all.1 index bee5db76..4bf49717 100644 --- a/Documentation/nvme-disconnect-all.1 +++ b/Documentation/nvme-disconnect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-disconnect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT\-AL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT\-AL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,13 +32,28 @@ nvme-disconnect-all \- Disconnect from all connected Fabrics controllers\&. .SH "SYNOPSIS" .sp .nf -\fInvme disconnect\-all\fR +\fInvme disconnect\-all\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Disconnects and removes all existing NVMe over Fabrics controllers\&. .sp See the documentation for the nvme\-disconnect(1) command for further background\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-disconnect-all.html b/Documentation/nvme-disconnect-all.html index d1a04022..affedcdc 100644 --- a/Documentation/nvme-disconnect-all.html +++ b/Documentation/nvme-disconnect-all.html @@ -749,7 +749,7 @@ nvme-disconnect-all(1) Manual Page

SYNOPSIS

-
nvme disconnect-all
+
nvme disconnect-all [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -763,6 +763,36 @@ background.

+

OPTIONS

+
+
+
+-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

    @@ -795,7 +825,7 @@ Disconnect all existing nvme controllers: diff --git a/Documentation/nvme-disconnect.1 b/Documentation/nvme-disconnect.1 index 58120ba6..0ebe834d 100644 --- a/Documentation/nvme-disconnect.1 +++ b/Documentation/nvme-disconnect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-disconnect .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,9 @@ nvme-disconnect \- Disconnect one or more Fabrics controller(s)\&. .SH "SYNOPSIS" .sp .nf -\fInvme disconnect\fR - [\-\-nqn= | \-n ] - [\-\-device= | \-d ] +\fInvme disconnect\fR [\-\-nqn= | \-n ] + [\-\-device= | \-d ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -50,6 +50,20 @@ Indicates that all controllers for the NVMe subsystems specified should be remov .RS 4 Indicates that the controller with the specified name should be removed\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-disconnect.html b/Documentation/nvme-disconnect.html index 8c80005b..ad6747c0 100644 --- a/Documentation/nvme-disconnect.html +++ b/Documentation/nvme-disconnect.html @@ -749,9 +749,9 @@ nvme-disconnect(1) Manual Page

    SYNOPSIS

    -
    nvme disconnect
-                [--nqn=<subnqn>           | -n <subnqn>]
-                [--device=<device>        | -d <device>]
    +
    nvme disconnect [--nqn=<subnqn> | -n <subnqn>]
+                        [--device=<device> | -d <device>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
    @@ -761,7 +761,7 @@ nvme-disconnect(1) Manual Page

    Disconnects and removes one or more existing NVMe over Fabrics controllers. If the --nqn option is specified all controllers connecting to the Subsystem -identified by subnqn will be removed. If the --device option is specified +identified by subnqn will be removed. If the --device option is specified the controller specified by the --device option will be removed.

@@ -793,6 +793,29 @@ the controller specified by the --device option will be removed.

removed.

+
+-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. +

+
@@ -839,7 +862,7 @@ Disconnect the controller nvme4 diff --git a/Documentation/nvme-discover.1 b/Documentation/nvme-discover.1 index fb940a5c..c1284b87 100644 --- a/Documentation/nvme-discover.1 +++ b/Documentation/nvme-discover.1 @@ -2,12 +2,12 @@ .\" Title: nvme-discover .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCOVER" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DISCOVER" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,39 +32,30 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&. .SH "SYNOPSIS" .sp .nf -\fInvme discover\fR - [\-\-transport= | \-t ] - [\-\-nqn= | \-n ] - [\-\-traddr= | \-a ] - [\-\-trsvcid= | \-s ] - [\-\-host\-traddr= | \-w ] - [\-\-host\-iface= | \-f ] - [\-\-hostnqn= | \-q ] - [\-\-hostid= | \-I ] - [\-\-raw= | \-r ] - [\-\-device= | \-d ] - [\-\-cfg\-file= | \-C ] - [\-\-keep\-alive\-tmo= | \-k ] - [\-\-reconnect\-delay=<#> | \-c <#>] - [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] - [\-\-nr\-io\-queues=<#> | \-i <#>] - [\-\-nr\-write\-queues=<#> | \-W <#>] - [\-\-nr\-poll\-queues=<#> | \-P <#>] - [\-\-queue\-size=<#> | \-Q <#>] - [\-\-keyring=<#> ] - [\-\-tls_key=<#> ] - [\-\-hdr\-digest | \-g] - [\-\-data\-digest | \-G] - [\-\-persistent | \-p] - [\-\-quiet | \-S] - [\-\-tls ] - [\-\-dump\-config | \-O] - [\-\-output\-format= | \-o ] - [\-\-force] - [\-\-nbft] - [\-\-no\-nbft] - [\-\-nbft\-path=] - [\-\-context=] +\fInvme discover\fR [\-\-transport= | \-t ] + [\-\-nqn= | \-n ] + [\-\-traddr= | \-a ] + [\-\-trsvcid= | \-s ] + [\-\-host\-traddr= | \-w ] + [\-\-host\-iface= | \-f ] + [\-\-hostnqn= | \-q ] + [\-\-hostid= | \-I ] + [\-\-raw= | \-r ] + [\-\-device= | \-d ] + [\-\-cfg\-file= | \-C ] + [\-\-keep\-alive\-tmo= | \-k ] + [\-\-reconnect\-delay=<#> | \-c <#>] + [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] + [\-\-nr\-io\-queues=<#> | \-i <#>] + [\-\-nr\-write\-queues=<#> | \-W <#>] + [\-\-nr\-poll\-queues=<#> | \-P <#>] + [\-\-queue\-size=<#> | \-Q <#>] [\-\-keyring=<#>] + [\-\-tls_key=<#>] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] + [\-\-persistent | \-p] [\-\-quiet | \-S] [\-\-tls] + [\-\-dump\-config | \-O] [\-\-output\-format= | \-o ] + [\-\-force] [\-\-nbft] [\-\-no\-nbft] [\-\-nbft\-path=] + [\-\-context=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -254,11 +245,12 @@ Suppress already connected errors\&. Print out resulting JSON configuration file to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 @@ -286,6 +278,20 @@ Use a user\-defined path to the NBFT tables .RS 4 Set the execution context to \&. This allows to coordinate the management of the global resources\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 @@ -372,9 +378,9 @@ command using a /usr/local/etc/nvme/discovery\&.conf file: .RS 4 .\} .nf -# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the +# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the # Discovery Controller\*(Aqs two ports (some resources may only -# be accessible on a single port)\&. Note an official +# be accessible on a single port)\&. Note an official # nqn (Host) name defined in the NVMe specification is being used # in this example\&. \-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 diff --git a/Documentation/nvme-discover.html b/Documentation/nvme-discover.html index dfd3b796..a941a24f 100644 --- a/Documentation/nvme-discover.html +++ b/Documentation/nvme-discover.html @@ -749,39 +749,30 @@ nvme-discover(1) Manual Page

SYNOPSIS

-
nvme discover
-                [--transport=<trtype>     | -t <trtype>]
-                [--nqn=<subnqn>           | -n <subnqn>]
-                [--traddr=<traddr>        | -a <traddr>]
-                [--trsvcid=<trsvcid>      | -s <trsvcid>]
-                [--host-traddr=<traddr>   | -w <traddr>]
-                [--host-iface=<iface>     | -f <iface>]
-                [--hostnqn=<hostnqn>      | -q <hostnqn>]
-                [--hostid=<hostid>        | -I <hostid>]
-                [--raw=<filename>         | -r <filename>]
-                [--device=<device>        | -d <device>]
-                [--cfg-file=<cfg>         | -C <cfg> ]
-                [--keep-alive-tmo=<sec>   | -k <sec>]
-                [--reconnect-delay=<#>    | -c <#>]
-                [--ctrl-loss-tmo=<#>      | -l <#>]
-                [--nr-io-queues=<#>       | -i <#>]
-                [--nr-write-queues=<#>    | -W <#>]
-                [--nr-poll-queues=<#>     | -P <#>]
-                [--queue-size=<#>         | -Q <#>]
-                [--keyring=<#>                    ]
-                [--tls_key=<#>                    ]
-                [--hdr-digest             | -g]
-                [--data-digest            | -G]
-                [--persistent             | -p]
-                [--quiet                  | -S]
-                [--tls                        ]
-                [--dump-config            | -O]
-                [--output-format=<fmt>    | -o <fmt>]
-                [--force]
-                [--nbft]
-                [--no-nbft]
-                [--nbft-path=<STR>]
-                [--context=<STR>]
+
nvme discover [--transport=<trtype> | -t <trtype>]
+                        [--nqn=<subnqn> | -n <subnqn>]
+                        [--traddr=<traddr> | -a <traddr>]
+                        [--trsvcid=<trsvcid> | -s <trsvcid>]
+                        [--host-traddr=<traddr> | -w <traddr>]
+                        [--host-iface=<iface> | -f <iface>]
+                        [--hostnqn=<hostnqn> | -q <hostnqn>]
+                        [--hostid=<hostid> | -I <hostid>]
+                        [--raw=<filename> | -r <filename>]
+                        [--device=<device> | -d <device>]
+                        [--cfg-file=<cfg> | -C <cfg>]
+                        [--keep-alive-tmo=<sec> | -k <sec>]
+                        [--reconnect-delay=<#> | -c <#>]
+                        [--ctrl-loss-tmo=<#> | -l <#>]
+                        [--nr-io-queues=<#> | -i <#>]
+                        [--nr-write-queues=<#> | -W <#>]
+                        [--nr-poll-queues=<#> | -P <#>]
+                        [--queue-size=<#> | -Q <#>] [--keyring=<#>]
+                        [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]
+                        [--persistent | -p] [--quiet | -S] [--tls]
+                        [--dump-config | -O] [--output-format=<fmt> | -o <fmt>]
+                        [--force] [--nbft] [--no-nbft] [--nbft-path=<STR>]
+                        [--context=<STR>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -793,7 +784,7 @@ nvme-discover(1) Manual Page Controller.

If no parameters are given, then nvme discover will attempt to find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of -Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file +Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file exists, the command will quit with an error.

Otherwise, a specific Discovery Controller should be specified using the --transport, --traddr, and if necessary the --trsvcid flags. A Discovery @@ -806,7 +797,7 @@ request will then be sent to the specified Discovery Controller.

The NVMe-over-Fabrics specification defines the concept of a Discovery Controller that an NVMe Host can query on a fabric network to discover NVMe subsystems contained in NVMe Targets -which it can connect to on the network. The Discovery Controller +which it can connect to on the network. The Discovery Controller will return Discovery Log Pages that provide the NVMe Host with specific information (such as network address and unique subsystem NQN) the NVMe Host can use to issue an @@ -819,7 +810,7 @@ In particular, the Host NQN uniquely identifies the NVMe Host, and may be used by the Discovery Controller to control what NVMe Target resources are allocated to the NVMe Host for a connection.

A Discovery Controller has it’s own NQN defined in the NVMe-over-Fabrics -specification, nqn.2014-08.org.nvmexpress.discovery. All Discovery +specification, nqn.2014-08.org.nvmexpress.discovery. All Discovery Controllers must use this NQN name. This NQN is used by default by nvme-cli for the discover command.

@@ -837,7 +828,7 @@ nvme-cli for the discover command.

This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include:

- This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420.

@@ -1168,15 +1159,15 @@ cellspacing="0" cellpadding="4">

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json or binary. Only one + output format can be used at a time.

@@ -1222,6 +1213,29 @@ cellspacing="0" cellpadding="4"> the management of the global resources.

+
+-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. +

+
@@ -1265,9 +1279,9 @@ Issue a nvme discover command using a /usr/local/etc/nvme/discovery.con

-
# Machine default 'nvme discover' commands.  Query the
+
# Machine default 'nvme discover' commands. Query the
 # Discovery Controller's two ports (some resources may only
-# be accessible on a single port).  Note an official
+# be accessible on a single port). Note an official
 # nqn (Host) name defined in the NVMe specification is being used
 # in this example.
 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@@ -1303,7 +1317,7 @@ nvme-connect-all(1)
diff --git a/Documentation/nvme-dsm.1 b/Documentation/nvme-dsm.1 index 1f228e6c..de10e7cf 100644 --- a/Documentation/nvme-dsm.1 +++ b/Documentation/nvme-dsm.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dsm .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DSM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DSM" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,12 +32,14 @@ nvme-dsm \- Send NVMe Data Set Management, return results .SH "SYNOPSIS" .sp .nf -\fInvme dsm\fR [ \-\-namespace\-id= | \-n ] - [ \-\-ctx\-attrs= | \-a ] - [ \-\-blocks= | \-b ] - [ \-\-slbs= | \-s ] - [ \-\-ad | \-d ] [ \-\-idw | \-w ] [ \-\-idr | \-r ] - [ \-\-cdw11= | \-c ] +\fInvme dsm\fR [\-\-namespace\-id= | \-n ] + [\-\-ctx\-attrs= | \-a ] + [\-\-blocks= | \-b ] + [\-\-slbs= | \-s ] + [\-\-ad= | \-d ] + [\-\-idw= | \-w ] [\-\-idr= | \-r ] + [\-\-cdw11= | \-c ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -89,6 +91,20 @@ Attribute Integral Dataset for Read\&. .RS 4 All the command command dword 11 attributes\&. Use exclusive from specifying individual attributes .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet diff --git a/Documentation/nvme-dsm.html b/Documentation/nvme-dsm.html index e6312a66..d4fe9594 100644 --- a/Documentation/nvme-dsm.html +++ b/Documentation/nvme-dsm.html @@ -749,12 +749,14 @@ nvme-dsm(1) Manual Page

SYNOPSIS

-
nvme dsm <device>  [ --namespace-id=<nsid> | -n <nsid> ]
-                        [ --ctx-attrs=<attribute-list,> | -a <attribute-list,> ]
-                        [ --blocks=<nlb-list,> | -b <nlb-list,> ]
-                        [ --slbs=<slba-list,> | -s <slba-list,> ]
-                        [ --ad | -d ] [ --idw | -w ] [ --idr | -r ]
-                        [ --cdw11=<cdw11> | -c <cdw11> ]
+
nvme dsm <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--ctx-attrs=<attribute-list,> | -a <attribute-list,>]
+                        [--blocks=<nlb-list,> | -b <nlb-list,>]
+                        [--slbs=<slba-list,> | -s <slba-list,>]
+                        [--ad=<deallocate> | -d <deallocate>]
+                        [--idw=<write> | -w <write>] [--idr=<read> | -r <read>]
+                        [--cdw11=<cdw11> | -c <cdw11>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -873,6 +875,29 @@ any settings from the flags may have provided.

specifying individual attributes

+
+-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. +

+
@@ -893,7 +918,7 @@ any settings from the flags may have provided.

diff --git a/Documentation/nvme-effects-log.1 b/Documentation/nvme-effects-log.1 index 66741c3e..4720395f 100644 --- a/Documentation/nvme-effects-log.1 +++ b/Documentation/nvme-effects-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-effects-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-EFFECTS\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-EFFECTS\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-effects-log \- Send NVMe Command Effects log page request, returns result a .SH "SYNOPSIS" .sp .nf -\fInvme effects\-log\fR [\-\-output\-format= | \-o ] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] +\fInvme effects\-log\fR [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -45,11 +44,6 @@ The parameter is mandatory and should be the NVMe character device (ex: On success, the returned command effects log structure will be printed for each command that is supported\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= -.RS 4 -This option will set the reporting format to normal, json, or binary\&. Only one output format can be used at a time\&. -.RE -.PP \-H, \-\-human\-readable .RS 4 This option will parse and format many of the bit fields into a human\-readable format\&. @@ -59,6 +53,20 @@ This option will parse and format many of the bit fields into a human\-readable .RS 4 This option will print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the human\-readable option\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-effects-log.html b/Documentation/nvme-effects-log.html index 8a082104..d1c2877a 100644 --- a/Documentation/nvme-effects-log.html +++ b/Documentation/nvme-effects-log.html @@ -749,9 +749,8 @@ nvme-effects-log(1) Manual Page

SYNOPSIS

-
nvme effects-log <device> [--output-format=<fmt> | -o <fmt>]
-                            [--human-readable | -H]
-                            [--raw-binary | -b]
+
nvme effects-log <device> [--human-readable | -H] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -772,39 +771,50 @@ for each command that is supported.

--o <format> +-H
---output-format=<format> +--human-readable

- This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + This option will parse and format many of the bit fields into a + human-readable format.

--H +-b
---human-readable +--raw-binary

- This option will parse and format many of the bit fields into a - human-readable format. + This option will print the raw buffer to stdout. Structure is not + parsed by program. This overrides the human-readable option.

--b +-o <fmt>
---raw-binary +--output-format=<fmt>

- This option will print the raw buffer to stdout. Structure is not - parsed by program. This overrides the human-readable option. + 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.

@@ -847,7 +857,7 @@ Have the program return the raw structure in binary: diff --git a/Documentation/nvme-endurance-event-agg-log.1 b/Documentation/nvme-endurance-event-agg-log.1 index c908d904..947e39f7 100644 --- a/Documentation/nvme-endurance-event-agg-log.1 +++ b/Documentation/nvme-endurance-event-agg-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-endurance-event-agg-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ENDURANCE\-EVE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ENDURANCE\-EVE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,7 +34,7 @@ nvme-endurance-event-agg-log \- Send NVMe Endurance log page request, returns re .nf \fInvme endurance\-event\-agg\-log\fR [\-\-log\-entries= | \-e ] [\-\-rae | \-r] [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,13 +55,19 @@ Retrieve the Endurance Group Event Aggregate Log pending entries\&. This argumen Retain an Asynchronous Event\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-endurance-event-agg-log.html b/Documentation/nvme-endurance-event-agg-log.html index f34dfa93..ccce6843 100644 --- a/Documentation/nvme-endurance-event-agg-log.html +++ b/Documentation/nvme-endurance-event-agg-log.html @@ -751,7 +751,7 @@ nvme-endurance-event-agg-log(1) Manual Page 
nvme endurance-event-agg-log <device> [--log-entries=<log_entries> | -e <log_entries>]
                         [--rae | -r] [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -781,11 +781,11 @@ printed to stdout for another program to parse, or reported in json format.

<

- Retrieve the Endurance Group Event Aggregate Log pending entries. - This argument is mandatory and its success may depend on the device’s - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.15. The maximum number of log entries supported is 2044 - for the device. + Retrieve the Endurance Group Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.15. The maximum number of log entries supported is 2044 + for the device.

@@ -800,15 +800,26 @@ printed to stdout for another program to parse, or reported in json format.

<

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -851,7 +862,7 @@ Print the raw Endurance log to a file: diff --git a/Documentation/nvme-endurance-log.1 b/Documentation/nvme-endurance-log.1 index ec34603d..5e786fe8 100644 --- a/Documentation/nvme-endurance-log.1 +++ b/Documentation/nvme-endurance-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-endurance-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ENDURANCE\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ENDURANCE\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-endurance-log \- Send NVMe Endurance log page request, returns result and l .sp .nf \fInvme endurance\-log\fR [\-\-group\-id= | \-g ] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,13 +49,19 @@ On success, the returned endurance log structure may be returned in one of sever The endurance group identifier\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-endurance-log.html b/Documentation/nvme-endurance-log.html index c286558b..11001935 100644 --- a/Documentation/nvme-endurance-log.html +++ b/Documentation/nvme-endurance-log.html @@ -750,7 +750,7 @@ nvme-endurance-log(1) Manual Page 
nvme endurance-log <device> [--group-id=<group> | -g <group>]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -783,15 +783,26 @@ printed to stdout for another program to parse, or reported in json format.

<

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -834,7 +845,7 @@ Print the raw Endurance log to a file: diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index 1666278e..dd07083f 100644 --- a/Documentation/nvme-error-log.1 +++ b/Documentation/nvme-error-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-error-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ERROR\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ERROR\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,9 @@ nvme-error-log \- Send NVME Error log page request, return result and log .SH "SYNOPSIS" .sp .nf -\fInvme error\-log\fR [\-\-log\-entries= | \-e ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme error\-log\fR [\-\-log\-entries= | \-e ] + [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,13 +55,19 @@ Specifies how many log entries the program should request from the device\&. Thi Print the raw error log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-error-log.html b/Documentation/nvme-error-log.html index 148f4af6..7107da80 100644 --- a/Documentation/nvme-error-log.html +++ b/Documentation/nvme-error-log.html @@ -749,9 +749,9 @@ nvme-error-log(1) Manual Page

SYNOPSIS

-
nvme error-log <device>  [--log-entries=<entries> | -e <entries>]
-                         [--raw-binary | -b]
-                         [--output-format=<fmt> | -o <fmt>]
+
nvme error-log <device> [--log-entries=<entries> | -e <entries>]
+                        [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -798,15 +798,26 @@ printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -849,7 +860,7 @@ Print the raw output to a file: diff --git a/Documentation/nvme-fdp-configs.1 b/Documentation/nvme-fdp-configs.1 index bafe7265..c143b783 100644 --- a/Documentation/nvme-fdp-configs.1 +++ b/Documentation/nvme-fdp-configs.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-configs .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-CONFIGS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-CONFIGS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,9 +33,8 @@ nvme-fdp-configs \- Get Flexible Data Placement Configurations .sp .nf \fInvme fdp configs\fR [\-\-endgrp\-id= | \-e ] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -57,7 +56,7 @@ Parse, print and describe individual parts of bitfields\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-configs.html b/Documentation/nvme-fdp-configs.html index 4ae6e1c7..d9f7c6d7 100644 --- a/Documentation/nvme-fdp-configs.html +++ b/Documentation/nvme-fdp-configs.html @@ -750,9 +750,8 @@ nvme-fdp-configs(1) Manual Page 
nvme fdp configs <device> [--endgrp-id=<NUM> | -e <NUM>]
-                            [--human-readable | -H]
-                            [--raw-binary | -b]
-                            [--output-format=<FMT> | -o <FMT>]
+ [--human-readable | -H] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>]
@@ -802,10 +801,10 @@ the possible configurations for Flexible Data Placement.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -827,7 +826,7 @@ the possible configurations for Flexible Data Placement.

diff --git a/Documentation/nvme-fdp-events.1 b/Documentation/nvme-fdp-events.1 index 6a1017ae..ed11bd3d 100644 --- a/Documentation/nvme-fdp-events.1 +++ b/Documentation/nvme-fdp-events.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-events .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-EVENTS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-EVENTS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,10 +32,8 @@ nvme-fdp-events \- Get Flexible Data Placement Events .SH "SYNOPSIS" .sp .nf -\fInvme fdp events\fR [\-\-endgrp\-id= | \-e ] - [\-\-host\-events | \-E] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme fdp events\fR [\-\-endgrp\-id= | \-e ] [\-\-host\-events | \-E] + [\-\-raw\-binary | \-b] [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -57,7 +55,7 @@ Request the controller to report host events\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-events.html b/Documentation/nvme-fdp-events.html index c7833d6d..fd06d6e2 100644 --- a/Documentation/nvme-fdp-events.html +++ b/Documentation/nvme-fdp-events.html @@ -749,10 +749,8 @@ nvme-fdp-events(1) Manual Page

SYNOPSIS

-
nvme fdp events <device> [--endgrp-id=<NUM> | -e <NUM>]
-                           [--host-events | -E]
-                           [--raw-binary | -b]
-                           [--output-format=<FMT> | -o <FMT>]
+
nvme fdp events <device> [--endgrp-id=<NUM> | -e <NUM>] [--host-events | -E]
+                        [--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]
@@ -802,10 +800,10 @@ Units and media usage in an Endurance Group.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -827,7 +825,7 @@ Units and media usage in an Endurance Group.

diff --git a/Documentation/nvme-fdp-set-events.1 b/Documentation/nvme-fdp-set-events.1 index 82be4a0c..9c9594b1 100644 --- a/Documentation/nvme-fdp-set-events.1 +++ b/Documentation/nvme-fdp-set-events.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-set-events .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-SET\-EVEN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-SET\-EVEN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,9 +33,8 @@ nvme-fdp-set-events \- Enable or disable FDP events .sp .nf \fInvme fdp set\-events\fR [\-\-namespace\-id= | \-n ] - [\-\-placement\-handle= | \-p ] - [\-\-enable | \-e] - [\-\-event\-types= | \-t ] + [\-\-placement\-handle= | \-p ] [\-\-enable | \-e] + [\-\-event\-types= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -52,7 +51,7 @@ Namespace identifier\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-set-events.html b/Documentation/nvme-fdp-set-events.html index accaae6a..b41118e7 100644 --- a/Documentation/nvme-fdp-set-events.html +++ b/Documentation/nvme-fdp-set-events.html @@ -750,9 +750,8 @@ nvme-fdp-set-events(1) Manual Page 
nvme fdp set-events <device> [--namespace-id=<NUM> | -n <NUM>]
-                               [--placement-handle=<NUM> | -p <NUM>]
-                               [--enable | -e]
-                               [--event-types=<NUM,> | -t <NUM,>]
+ [--placement-handle=<NUM> | -p <NUM>] [--enable | -e] + [--event-types=<NUM,> | -t <NUM,>]
@@ -792,10 +791,10 @@ Handle.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -817,7 +816,7 @@ Handle.

diff --git a/Documentation/nvme-fdp-stats.1 b/Documentation/nvme-fdp-stats.1 index 703382c9..7ee78b36 100644 --- a/Documentation/nvme-fdp-stats.1 +++ b/Documentation/nvme-fdp-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-STATS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-STATS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-fdp-stats \- Get Flexible Data Placement Statistics .SH "SYNOPSIS" .sp .nf -\fInvme fdp stats\fR [\-\-endgrp\-id= | \-e ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme fdp stats\fR [\-\-endgrp\-id= | \-e ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -51,7 +50,7 @@ The endurance group identifier to use when requesting the log page\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-stats.html b/Documentation/nvme-fdp-stats.html index d5c47621..4f5841f3 100644 --- a/Documentation/nvme-fdp-stats.html +++ b/Documentation/nvme-fdp-stats.html @@ -749,9 +749,8 @@ nvme-fdp-stats(1) Manual Page

SYNOPSIS

-
nvme fdp stats <device> [--endgrp-id=<NUM> | -e <NUM>]
-                          [--raw-binary | -b]
-                          [--output-format=<FMT> | -o <FMT>]
+
nvme fdp stats <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -790,10 +789,10 @@ the life of the FDP configuration in an Endurance Group.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -815,7 +814,7 @@ the life of the FDP configuration in an Endurance Group.

diff --git a/Documentation/nvme-fdp-status.1 b/Documentation/nvme-fdp-status.1 index 752b00e8..9d46edab 100644 --- a/Documentation/nvme-fdp-status.1 +++ b/Documentation/nvme-fdp-status.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-status .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-STATUS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-STATUS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-fdp-status \- Get Reclaim Unit Handle Status .SH "SYNOPSIS" .sp .nf -\fInvme fdp status\fR [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme fdp status\fR [\-\-namespace\-id= | \-n ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -51,7 +50,7 @@ Namespace identifier\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-status.html b/Documentation/nvme-fdp-status.html index 2ec10bf0..6d610171 100644 --- a/Documentation/nvme-fdp-status.html +++ b/Documentation/nvme-fdp-status.html @@ -749,9 +749,8 @@ nvme-fdp-status(1) Manual Page

SYNOPSIS

-
nvme fdp status <device> [--namespace-id=<NUM> | -n <NUM>]
-                           [--raw-binary | -b]
-                           [--output-format=<FMT> | -o <FMT>]
+
nvme fdp status <device> [--namespace-id=<NUM> | -n <NUM>] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -790,10 +789,10 @@ are accessible by the specified namespace.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -815,7 +814,7 @@ are accessible by the specified namespace.

diff --git a/Documentation/nvme-fdp-update.1 b/Documentation/nvme-fdp-update.1 index 5bb9528d..b9f2b36e 100644 --- a/Documentation/nvme-fdp-update.1 +++ b/Documentation/nvme-fdp-update.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-update .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-UPDATE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-UPDATE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-fdp-update \- Reclaim Unit Handle Update .sp .nf \fInvme fdp update\fR [\-\-namespace\-id= | \-n ] - [\-\-pids= | \-p ] + [\-\-pids= | \-p ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-fdp-update.html b/Documentation/nvme-fdp-update.html index 0bcdeb59..61a35a3d 100644 --- a/Documentation/nvme-fdp-update.html +++ b/Documentation/nvme-fdp-update.html @@ -750,7 +750,7 @@ nvme-fdp-update(1) Manual Page 
nvme fdp update <device> [--namespace-id=<NUM> | -n <NUM>]
-                           [--pids=<NUM,> | -p <NUM,>]
+ [--pids=<NUM,> | -p <NUM,>]
@@ -802,7 +802,7 @@ a different Reclaim Unit accessible by the specified namespace.

diff --git a/Documentation/nvme-fdp-usage.1 b/Documentation/nvme-fdp-usage.1 index 41873e41..0d43d109 100644 --- a/Documentation/nvme-fdp-usage.1 +++ b/Documentation/nvme-fdp-usage.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fdp-usage .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FDP\-USAGE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FDP\-USAGE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-fdp-usage \- Get Reclaim Unit Handle Usage .SH "SYNOPSIS" .sp .nf -\fInvme fdp usage\fR [\-\-endgrp\-id= | \-e ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme fdp usage\fR [\-\-endgrp\-id= | \-e ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -51,7 +50,7 @@ The endurance group identifier to use when requesting the log page\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-usage.html b/Documentation/nvme-fdp-usage.html index 40adfdcd..03bdbc24 100644 --- a/Documentation/nvme-fdp-usage.html +++ b/Documentation/nvme-fdp-usage.html @@ -749,9 +749,8 @@ nvme-fdp-usage(1) Manual Page

SYNOPSIS

-
nvme fdp usage <device> [--endgrp-id=<NUM> | -e <NUM>]
-                          [--raw-binary | -b]
-                          [--output-format=<FMT> | -o <FMT>]
+
nvme fdp usage <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -791,10 +790,10 @@ Endurance Group.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -816,7 +815,7 @@ Endurance Group.

diff --git a/Documentation/nvme-fid-support-effects-log.1 b/Documentation/nvme-fid-support-effects-log.1 index d833b377..23143cb9 100644 --- a/Documentation/nvme-fid-support-effects-log.1 +++ b/Documentation/nvme-fid-support-effects-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fid-support-effects-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FID\-SUPPORT\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FID\-SUPPORT\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-fid-support-effects-log \- Send NVMe FID Support and Effects log, return re .SH "SYNOPSIS" .sp .nf -\fInvme fid\-support\-effects\-log\fR [\-o | \-\-output\-format=] +\fInvme fid\-support\-effects\-log\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,17 +43,23 @@ The parameter is mandatory and may be either the NVMe character device On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o , \-\-output\-format= .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 -\-H, \-\-human\-readable +\-v, \-\-verbose .RS 4 -This option will parse and format many of the bit fields into human\-readable formats\&. +Increase the information detail in the output\&. .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-fid-support-effects-log.html b/Documentation/nvme-fid-support-effects-log.html index acd7e3bc..df104cf5 100644 --- a/Documentation/nvme-fid-support-effects-log.html +++ b/Documentation/nvme-fid-support-effects-log.html @@ -749,7 +749,7 @@ nvme-fid-support-effects-log(1) Manual Page

SYNOPSIS

-
nvme fid-support-effects-log <device> [-o <fmt> | --output-format=<fmt>]
+
nvme fid-support-effects-log <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -771,27 +771,38 @@ raw buffer may be printed to stdout.

--o <format> +-H
---output-format=<format> +--human-readable

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + This option will parse and format many of the bit fields + into human-readable formats.

--H +-o <fmt>
---human-readable +--output-format=<fmt>

- This option will parse and format many of the bit fields - into human-readable formats. + 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.

@@ -814,7 +825,7 @@ raw buffer may be printed to stdout.

diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index b21d3fb9..fb5519d9 100644 --- a/Documentation/nvme-flush.1 +++ b/Documentation/nvme-flush.1 @@ -2,12 +2,12 @@ .\" Title: nvme-flush .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FLUSH" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FLUSH" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ nvme-flush \- Flush command\&. .sp .nf \fInvme flush\fR [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,6 +44,20 @@ The Flush command shall commit data and metadata associated with the specified n .RS 4 Specify the optional namespace id for this command\&. Defaults to 0xffffffff, indicating flush for all namespaces\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-flush.html b/Documentation/nvme-flush.html index 50957617..c5beada1 100644 --- a/Documentation/nvme-flush.html +++ b/Documentation/nvme-flush.html @@ -749,7 +749,8 @@ nvme-flush(1) Manual Page

SYNOPSIS

-
nvme flush <device> [--namespace-id=<nsid> | -n <nsid>]
+
nvme flush <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -780,6 +781,29 @@ any namespace.

0xffffffff, indicating flush for all namespaces.

+
+-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. +

+
@@ -800,7 +824,7 @@ any namespace.

diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index 63a099c2..369e1ae6 100644 --- a/Documentation/nvme-format.1 +++ b/Documentation/nvme-format.1 @@ -2,12 +2,12 @@ .\" Title: nvme-format .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,15 +33,13 @@ nvme-format \- Format an NVMe device .sp .nf \fInvme format\fR [\-\-namespace\-id= | \-n ] - [\-\-lbaf= | \-l ] - [\-\-block\-size=] - [\-\-ses= | \-s ] - [\-\-pil= | \-p ] - [\-\-pi= | \-i ] - [\-\-ms= | \-m ] - [\-\-reset | \-r ] - [\-\-force ] - [\-\-timeout= | \-t ] + [\-\-lbaf= | \-l ] + [\-\-block\-size=] + [\-\-ses= | \-s ] [\-\-pil= | \-p ] + [\-\-pi= | \-i ] [\-\-ms= | \-m ] + [\-\-reset | \-r] [\-\-force] + [\-\-timeout= | \-t ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -177,6 +175,20 @@ Just send the command immediately without warning of the implications\&. .RS 4 Override default timeout value\&. In milliseconds\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-format.html b/Documentation/nvme-format.html index 6afcbc28..1f63a811 100644 --- a/Documentation/nvme-format.html +++ b/Documentation/nvme-format.html @@ -750,15 +750,13 @@ nvme-format(1) Manual Page 
nvme format <device> [--namespace-id=<nsid> | -n <nsid>]
-                    [--lbaf=<lbaf> | -l <lbaf>]
-                    [--block-size=<block size | -b <block size>]
-                    [--ses=<ses> | -s <ses>]
-                    [--pil=<pil> | -p <pil>]
-                    [--pi=<pi> | -i <pi>]
-                    [--ms=<ms> | -m <ms>]
-                    [--reset | -r ]
-                    [--force ]
-                    [--timeout=<timeout> | -t <timeout> ]
+ [--lbaf=<lbaf> | -l <lbaf>] + [--block-size=<block size | -b <block size>] + [--ses=<ses> | -s <ses>] [--pil=<pil> | -p <pil>] + [--pi=<pi> | -i <pi>] [--ms=<ms> | -m <ms>] + [--reset | -r] [--force] + [--timeout=<timeout> | -t <timeout>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -995,6 +993,29 @@ cellspacing="0" cellpadding="4"> Override default timeout value. In milliseconds.

+
+-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. +

+
@@ -1035,7 +1056,7 @@ information: diff --git a/Documentation/nvme-fw-commit.1 b/Documentation/nvme-fw-commit.1 index 748b9b0a..3d58ff3f 100644 --- a/Documentation/nvme-fw-commit.1 +++ b/Documentation/nvme-fw-commit.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-commit .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-COMMIT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-COMMIT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,8 +33,9 @@ nvme-fw-commit \- Used to verify and commit a firmware image\&. .sp .nf \fInvme fw\-commit\fR [\-\-slot= | \-s ] - [\-\-action= | \-a ] - [\-\-bpid= | \-b ] + [\-\-action= | \-a ] + [\-\-bpid= | \-b ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -117,6 +118,20 @@ Firmware Slot: Specifies the firmware slot that shall be used for the Commit Act .RS 4 Specifies the Boot partition that shall be used for the Commit Action, if applicable (default: 0) .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-fw-commit.html b/Documentation/nvme-fw-commit.html index a76b0e19..352e2ca6 100644 --- a/Documentation/nvme-fw-commit.html +++ b/Documentation/nvme-fw-commit.html @@ -750,8 +750,9 @@ nvme-fw-commit(1) Manual Page 
nvme fw-commit <device> [--slot=<slot> | -s <slot>]
-                    [--action=<action> | -a <action>]
-                    [--bpid=<boot-partid> | -b <boot-partid> ]
+ [--action=<action> | -a <action>] + [--bpid=<boot-partid> | -b <boot-partid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -869,6 +870,29 @@ BPINFO.ABPID.

if applicable (default: 0)

+
+-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. +

+
@@ -905,7 +929,7 @@ commit the last downloaded fw to slot 1. diff --git a/Documentation/nvme-fw-download.1 b/Documentation/nvme-fw-download.1 index 6839e725..e59d4517 100644 --- a/Documentation/nvme-fw-download.1 +++ b/Documentation/nvme-fw-download.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-download .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-DOWNLOAD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-DOWNLOAD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,8 +33,9 @@ nvme-fw-download \- Download all or a portion of an nvme firmware image\&. .sp .nf \fInvme fw\-download\fR [\-\-fw= | \-f ] - [\-\-xfer= | \-x ] - [\-\-offset= | \-o ] + [\-\-xfer= | \-x ] + [\-\-offset= | \-O ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,12 +56,26 @@ Required argument\&. This specifies the path to the device\(cqs firmware file on This specifies the size to split each transfer\&. This is useful if the device has a max transfer size requirement for firmware\&. It defaults to 4k\&. .RE .PP -\-o , \-\-offset= +\-O , \-\-offset= .RS 4 This specifies the starting offset in dwords\&. This is really only useful if your firmware is split in multiple files; otherwise the offset starts at zero and automatically adjusts based on the \fIxfer\fR size given\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-fw-download.html b/Documentation/nvme-fw-download.html index b4ff3a7d..9466d7f3 100644 --- a/Documentation/nvme-fw-download.html +++ b/Documentation/nvme-fw-download.html @@ -750,8 +750,9 @@ nvme-fw-download(1) Manual Page 
nvme fw-download <device> [--fw=<firmware-file> | -f <firmware-file>]
-                    [--xfer=<transfer-size> | -x <transfer-size>]
-                    [--offset=<offset> | -o <offset>]
+ [--xfer=<transfer-size> | -x <transfer-size>] + [--offset=<offset> | -O <offset>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -809,7 +810,7 @@ the Firmware Commit command (nvme fw-commit <args>).

--o <offset> +-O <offset>
--offset=<offset> @@ -822,6 +823,29 @@ the Firmware Commit command (nvme fw-commit <args>).

xfer size given.

+
+-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. +

+
@@ -852,7 +876,7 @@ Transfer a firmware size 128KiB at a time: diff --git a/Documentation/nvme-fw-log.1 b/Documentation/nvme-fw-log.1 index 09f9bddb..62a86c87 100644 --- a/Documentation/nvme-fw-log.1 +++ b/Documentation/nvme-fw-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-fw-log \- Send NVMe Firmware log page request, returns result and log .sp .nf \fInvme fw\-log\fR [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,13 +49,19 @@ On success, the returned f/w log structure may be returned in one of several way Print the raw fw log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-fw-log.html b/Documentation/nvme-fw-log.html index 83eafebc..b1481a90 100644 --- a/Documentation/nvme-fw-log.html +++ b/Documentation/nvme-fw-log.html @@ -750,7 +750,7 @@ nvme-fw-log(1) Manual Page 
nvme fw-log <device> [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -784,15 +784,26 @@ printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -835,7 +846,7 @@ Print the log firmware to a file: diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index 37e92294..de37c114 100644 --- a/Documentation/nvme-gen-hostnqn.1 +++ b/Documentation/nvme-gen-hostnqn.1 @@ -2,12 +2,12 @@ .\" Title: nvme-gen-hostnqn .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GEN\-HOSTNQN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GEN\-HOSTNQN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,26 @@ nvme-gen-hostnqn \- Generate a host NVMe Qualified Name .SH "SYNOPSIS" .sp .nf -\fInvme gen\-hostnqn\fR +\fInvme gen\-hostnqn\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Generate a random host NQN in the form: nqn\&.2014\-08\&.org\&.nvmexpress:uuid:1b4e28ba\-2fa1\-11d2\-883f\-0016d3cca427 and prints it to stdout\&. .SH "OPTIONS" -.sp -No options needed +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 nvme gen\-hostnqn diff --git a/Documentation/nvme-gen-hostnqn.html b/Documentation/nvme-gen-hostnqn.html index 4eedd6de..51d22c63 100644 --- a/Documentation/nvme-gen-hostnqn.html +++ b/Documentation/nvme-gen-hostnqn.html @@ -749,7 +749,7 @@ nvme-gen-hostnqn(1) Manual Page

SYNOPSIS

-
nvme gen-hostnqn
+
nvme gen-hostnqn [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -765,7 +765,31 @@ and prints it to stdout.

OPTIONS

-

No options needed

+
+
+-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. +

+
+
@@ -785,7 +809,7 @@ and prints it to stdout.

diff --git a/Documentation/nvme-get-feature.1 b/Documentation/nvme-get-feature.1 index 015d5c2c..9408c54e 100644 --- a/Documentation/nvme-get-feature.1 +++ b/Documentation/nvme-get-feature.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-feature .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-FEATURE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-FEATURE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,12 +33,13 @@ nvme-get-feature \- Gets an NVMe feature, returns applicable results .sp .nf \fInvme get\-feature\fR [\-\-namespace\-id= | \-n ] - [\-\-feature\-id= | \-f ] [\-\-cdw11=] - [\-\-uuid\-index= | \-U ] - [\-\-data\-len= | \-l ] - [\-\-sel=] - [\-\-raw\-binary | \-b] - [\-\-human\-readable | \-H] + [\-\-feature\-id= | \-f ] [\-\-cdw11=] + [\-\-uuid\-index= | \-U ] + [\-\-data\-len= | \-l ] + [\-\-sel=] + [\-\-raw\-binary | \-b] + [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -128,6 +129,20 @@ Print the raw feature buffer to stdout if the feature returns a structure\&. .RS 4 This option will parse and format many of the bit fields into human\-readable formats\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-get-feature.html b/Documentation/nvme-get-feature.html index fc34d165..126edf3e 100644 --- a/Documentation/nvme-get-feature.html +++ b/Documentation/nvme-get-feature.html @@ -750,12 +750,13 @@ nvme-get-feature(1) Manual Page 
nvme get-feature <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>]
-                          [--uuid-index=<uuid-index> | -U <uuid_index>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--sel=<select> | -s <select>]
-                          [--raw-binary | -b]
-                          [--human-readable | -H]
+ [--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>] + [--uuid-index=<uuid-index> | -U <uuid_index>] + [--data-len=<data-len> | -l <data-len>] + [--sel=<select> | -s <select>] + [--raw-binary | -b] + [--human-readable | -H] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -906,6 +907,29 @@ cellspacing="0" cellpadding="4"> into human-readable formats.

+
+-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. +

+
@@ -977,7 +1001,7 @@ format: diff --git a/Documentation/nvme-get-lba-status.1 b/Documentation/nvme-get-lba-status.1 index b42f2e50..59f7ff4b 100644 --- a/Documentation/nvme-get-lba-status.1 +++ b/Documentation/nvme-get-lba-status.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-lba-status .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LBA\-STAT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LBA\-STAT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,12 +33,12 @@ nvme-get-lba-status \- Get LBA Status from NVMe device .sp .nf \fInvme get\-lba\-status\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-max\-dw= | \-m ] - [\-\-action= | \-a ] - [\-\-range\-len= | \-l ] - [\-\-timeout= | \-t ] - [\-\-output\-format= | \-o ] + [\-\-start\-lba= | \-s ] + [\-\-max\-dw= | \-m ] + [\-\-action= | \-a ] + [\-\-range\-len= | \-l ] + [\-\-timeout= | \-t ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -79,13 +79,19 @@ Range Length(RL) specifies the length of the range of contiguous LBAs beginning Override default timeout value\&. In milliseconds\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-get-lba-status.html b/Documentation/nvme-get-lba-status.html index 58a06ef3..3f6d29bd 100644 --- a/Documentation/nvme-get-lba-status.html +++ b/Documentation/nvme-get-lba-status.html @@ -750,12 +750,12 @@ nvme-get-lba-status(1) Manual Page 
nvme get-lba-status <device> [--namespace-id=<nsid> | -n <nsid>]
-                    [--start-lba=<slba> | -s <slba>]
-                    [--max-dw=<max-dw> | -m <max-dw>]
-                    [--action=<action-type> | -a <action-type>]
-                    [--range-len=<range-len> | -l <range-len>]
-                    [--timeout=<timeout> | -t <timeout> ]
-                   [--output-format=<format> | -o <format>]
+ [--start-lba=<slba> | -s <slba>] + [--max-dw=<max-dw> | -m <max-dw>] + [--action=<action-type> | -a <action-type>] + [--range-len=<range-len> | -l <range-len>] + [--timeout=<timeout> | -t <timeout>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -846,15 +846,26 @@ printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -896,7 +907,7 @@ Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000 diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1 index 804e18c8..14040f90 100644 --- a/Documentation/nvme-get-log.1 +++ b/Documentation/nvme-get-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,17 +33,18 @@ nvme-get-log \- Retrieves a log page from an NVMe device .sp .nf \fInvme get\-log\fR [\-\-log\-id= | \-i ] - [\-\-log\-len= | \-l ] - [\-\-aen= | \-a ] - [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] - [\-\-lpo= | \-o ] - [\-\-lsp= | \-s ] - [\-\-lsi= | \-S ] - [\-\-rae | \-r] - [\-\-csi= | \-y ] - [\-\-ot= | \-O ] - [\-\-xfer\-len= | \-x ] + [\-\-log\-len= | \-l ] + [\-\-aen= | \-a ] + [\-\-namespace\-id= | \-n ] + [\-\-raw\-binary | \-b] + [\-\-lpo= | \-L ] + [\-\-lsp= | \-s ] + [\-\-lsi= | \-S ] + [\-\-rae | \-r] + [\-\-csi= | \-y ] + [\-\-ot= | \-O ] + [\-\-xfer\-len= | \-x ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -79,7 +80,7 @@ Sets the command\(cqs nsid value to the given nsid\&. Defaults to 0xffffffff if Print the raw log buffer to stdout\&. .RE .PP -\-o , \-\-lpo= +\-L , \-\-lpo= .RS 4 The log page offset specifies the location within a log page to start returning data from\&. It\(cqs Dword\-aligned and 64\-bits\&. .RE @@ -113,6 +114,20 @@ This field specifies the offset type\&. If set to false, the Log Page Offset Low .RS 4 \-\-xfer\-len : Specify the read chunk size\&. The length argument is expected to be a multiple of 4096\&. The default size is 4096\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-get-log.html b/Documentation/nvme-get-log.html index 1b4957cc..6b83c8cb 100644 --- a/Documentation/nvme-get-log.html +++ b/Documentation/nvme-get-log.html @@ -750,17 +750,18 @@ nvme-get-log(1) Manual Page 
nvme get-log <device> [--log-id=<log-id> | -i <log-id>]
-              [--log-len=<log-len> | -l <log-len>]
-              [--aen=<aen> | -a <aen>]
-              [--namespace-id=<nsid> | -n <nsid>]
-              [--raw-binary | -b]
-              [--lpo=<offset> | -o <offset>]
-              [--lsp=<field> | -s <field>]
-              [--lsi=<field> | -S <field>]
-              [--rae | -r]
-              [--csi=<command_set_identifier> | -y <command_set_identifier>]
-              [--ot=<offset_type> | -O <offset_type>]
-                    [--xfer-len=<length> | -x <length>]
+ [--log-len=<log-len> | -l <log-len>] + [--aen=<aen> | -a <aen>] + [--namespace-id=<nsid> | -n <nsid>] + [--raw-binary | -b] + [--lpo=<offset> | -L <offset>] + [--lsp=<field> | -s <field>] + [--lsi=<field> | -S <field>] + [--rae | -r] + [--csi=<command_set_identifier> | -y <command_set_identifier>] + [--ot=<offset_type> | -O <offset_type>] + [--xfer-len=<length> | -x <length>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -845,7 +846,7 @@ program to parse.

--o <offset> +-L <offset>
--lpo=<offset> @@ -929,6 +930,29 @@ program to parse.

a multiple of 4096. The default size is 4096.

+
+-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. +

+
@@ -973,7 +997,7 @@ Have the program return the raw log page in binary: diff --git a/Documentation/nvme-get-ns-id.1 b/Documentation/nvme-get-ns-id.1 index e42c26e3..904a1b3a 100644 --- a/Documentation/nvme-get-ns-id.1 +++ b/Documentation/nvme-get-ns-id.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-ns-id .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-NS\-ID" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-NS\-ID" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,26 @@ nvme-get-ns-id \- Retrieves the namespace ID for an NVMe block device .SH "SYNOPSIS" .sp .nf -\fInvme get\-ns\-id\fR +\fInvme get\-ns\-id\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Retrieves the namespace ID for an NVMe block device\&. The param is mandatory and must be an NVMe block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" -.sp -None +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-get-ns-id.html b/Documentation/nvme-get-ns-id.html index 37cfc2cc..0ea250ef 100644 --- a/Documentation/nvme-get-ns-id.html +++ b/Documentation/nvme-get-ns-id.html @@ -749,7 +749,7 @@ nvme-get-ns-id(1) Manual Page

SYNOPSIS

-
nvme get-ns-id <device>
+
nvme get-ns-id <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -764,7 +764,31 @@ is mandatory and must be an NVMe block device (ex: /dev/nvme0n1).

OPTIONS

-

None

+
+
+-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. +

+
+
@@ -794,7 +818,7 @@ Shows the namespace id for the given block device: diff --git a/Documentation/nvme-get-property.1 b/Documentation/nvme-get-property.1 index 6735f120..86acf865 100644 --- a/Documentation/nvme-get-property.1 +++ b/Documentation/nvme-get-property.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-property .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-PROPERTY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-PROPERTY" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,15 +32,16 @@ nvme-get-property \- Reads and shows the defined NVMe controller property for NV .SH "SYNOPSIS" .sp .nf -\fInvme get\-property\fR [\-\-offset= | \-o ] - [\-\-human\-readable | \-H ] +\fInvme get\-property\fR [\-\-offset= | \-O ] + [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Reads and shows the defined NVMe controller property for NVMe over Fabric\&. .SH "OPTIONS" .PP -\-o, \-\-offset +\-O, \-\-offset .RS 4 The offset of the property\&. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 .RE @@ -49,6 +50,20 @@ The offset of the property\&. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0 .RS 4 \-\-human\-readable: Show the fields packed in the property .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-get-property.html b/Documentation/nvme-get-property.html index 5f7cdd3a..9ae5860b 100644 --- a/Documentation/nvme-get-property.html +++ b/Documentation/nvme-get-property.html @@ -749,8 +749,9 @@ nvme-get-property(1) Manual Page

SYNOPSIS

-
nvme get-property <device> [--offset=<offset> | -o <offset>]
-                                [--human-readable | -H ]
+
nvme get-property <device> [--offset=<offset> | -O <offset>]
+                        [--human-readable | -H]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -766,7 +767,7 @@ nvme-get-property(1) Manual Page
--o +-O
--offset @@ -785,6 +786,29 @@ nvme-get-property(1) Manual Page Show the fields packed in the property

+
+-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. +

+
@@ -843,7 +867,7 @@ Then look for NVMe Fabrics command (0x7f) at trace diff --git a/Documentation/nvme-help.1 b/Documentation/nvme-help.1 index 4b68960a..c40a29c9 100644 --- a/Documentation/nvme-help.1 +++ b/Documentation/nvme-help.1 @@ -2,12 +2,12 @@ .\" Title: nvme-help .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-HELP" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-HELP" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-help.html b/Documentation/nvme-help.html index 2d939255..b86ab38c 100644 --- a/Documentation/nvme-help.html +++ b/Documentation/nvme-help.html @@ -794,7 +794,7 @@ Show help for nvme smart log: diff --git a/Documentation/nvme-huawei-id-ctrl.1 b/Documentation/nvme-huawei-id-ctrl.1 index 2d11b8bb..3af67b26 100644 --- a/Documentation/nvme-huawei-id-ctrl.1 +++ b/Documentation/nvme-huawei-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-huawei-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-HUAWEI\-ID\-CT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-HUAWEI\-ID\-CT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-huawei-id-ctrl \- Send NVMe Identify Controller, return result and structur .SH "SYNOPSIS" .sp .nf -\fInvme huawei id\-ctrl\fR [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o | \-\-output\-format=] +\fInvme huawei id\-ctrl\fR [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -63,7 +63,7 @@ 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 , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-huawei-id-ctrl.html b/Documentation/nvme-huawei-id-ctrl.html index 2a4e7cd0..be7432db 100644 --- a/Documentation/nvme-huawei-id-ctrl.html +++ b/Documentation/nvme-huawei-id-ctrl.html @@ -749,8 +749,8 @@ nvme-huawei-id-ctrl(1) Manual Page

SYNOPSIS

-
nvme huawei id-ctrl <device> [-v | --vendor-specific] [-b | --raw-binary]
-                        [-o <fmt> | --output-format=<fmt>]
+
nvme huawei id-ctrl <device> [--vendor-specific | -v] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -813,15 +813,15 @@ will decode Huawei vendor unique portions of the structure.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -855,7 +855,7 @@ fields in a human readable format: diff --git a/Documentation/nvme-huawei-list.1 b/Documentation/nvme-huawei-list.1 index f093e7e0..de24404e 100644 --- a/Documentation/nvme-huawei-list.1 +++ b/Documentation/nvme-huawei-list.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,14 @@ nvme-huawei-list \- List all recognized Huawei NVMe devices .SH "SYNOPSIS" .sp .nf -\fInvme huawei list\fR [\-o | \-\-output\-format=] +\fInvme huawei list\fR [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp Scan the sysfs tree for NVM Express devices and return the /dev node for those Huawei devices as well as some pertinent information about them\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR diff --git a/Documentation/nvme-huawei-list.html b/Documentation/nvme-huawei-list.html index 7c866d3d..f95bef95 100644 --- a/Documentation/nvme-huawei-list.html +++ b/Documentation/nvme-huawei-list.html @@ -749,7 +749,7 @@ nvme-list(1) Manual Page

SYNOPSIS

-
nvme huawei list [-o <fmt> | --output-format=<fmt>]
+
nvme huawei list [--output-format=<fmt> | -o <fmt>]
@@ -766,10 +766,10 @@ for those Huawei devices as well as some pertinent information about them.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -797,7 +797,7 @@ for those Huawei devices as well as some pertinent information about them.

Last updated - 2023-09-29 08:33:07 CEST + 2023-12-19 12:48:29 CET
diff --git a/Documentation/nvme-id-ctrl.1 b/Documentation/nvme-id-ctrl.1 index 0e4c7bc3..9037c387 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 -.\" Date: 06/30/2023 +.\" Date: 12/19/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/19/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 [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o | \-\-output\-format=] +\fInvme id\-ctrl\fR [\-\-vendor\-specific | \-V] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-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 , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-id-ctrl.html b/Documentation/nvme-id-ctrl.html index e845a2a2..b7656bfa 100644 --- a/Documentation/nvme-id-ctrl.html +++ b/Documentation/nvme-id-ctrl.html @@ -749,8 +749,8 @@ nvme-id-ctrl(1) Manual Page

SYNOPSIS

-
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]
@@ -784,7 +784,7 @@ raw buffer may be printed to stdout.

--v +-V
--vendor-specific @@ -809,15 +809,26 @@ raw buffer may be printed to stdout.

--o <format> +-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
---output-format=<format> +--verbose

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Increase the information detail in the output.

@@ -845,7 +856,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 interpret it.

@@ -910,7 +921,7 @@ int main(int argc, char **argv) diff --git a/Documentation/nvme-id-domain.1 b/Documentation/nvme-id-domain.1 index 67304a14..d7c479b3 100644 --- a/Documentation/nvme-id-domain.1 +++ b/Documentation/nvme-id-domain.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-domain .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-DOMAIN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-DOMAIN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-id-domain \- Send NVMe Identify Domain List, return result and structure .sp .nf \fInvme id\-domain\fR [\-\-dom\-id= | \-d ] - [\-o | \-\-output\-format=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,13 +47,19 @@ The parameter is mandatory and may be either the NVMe character device Retrieve the identify domain list data structure for the given domain id\&. If this value is not given, domain id will be 0xffff\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 No examples yet\&. diff --git a/Documentation/nvme-id-domain.html b/Documentation/nvme-id-domain.html index decc53a5..89bbbf77 100644 --- a/Documentation/nvme-id-domain.html +++ b/Documentation/nvme-id-domain.html @@ -750,7 +750,7 @@ nvme-id-domain(1) Manual Page 
nvme id-domain <device> [--dom-id=<domian_id> | -d <domian_id>]
-                        [-o <fmt> | --output-format=<fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -781,15 +781,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -812,7 +823,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Last updated - 2023-09-29 08:33:07 CEST + 2023-12-19 12:48:29 CET
diff --git a/Documentation/nvme-id-iocs.1 b/Documentation/nvme-id-iocs.1 index 58ae1116..b27852da 100644 --- a/Documentation/nvme-id-iocs.1 +++ b/Documentation/nvme-id-iocs.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-iocs .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-IOCS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-IOCS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-id-iocs \- Send NVMe Identify I/O Command Set, return result and structure .sp .nf \fInvme id\-iocs\fR [\-\-controller\-id= | \-c ] - [\-o | \-\-output\-format=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -52,13 +52,19 @@ Retrieve the identify I/O Command set data structure for the given cntid\&. If t This option will parse and format many of the bit fields into human\-readable formats\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-id-iocs.html b/Documentation/nvme-id-iocs.html index c3b2dc1c..4a85de62 100644 --- a/Documentation/nvme-id-iocs.html +++ b/Documentation/nvme-id-iocs.html @@ -750,7 +750,7 @@ nvme-id-iocs(1) Manual Page 
nvme id-iocs <device> [--controller-id=<cntid> | -c <cntid>]
-                        [-o <fmt> | --output-format=<fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -793,15 +793,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -844,7 +855,7 @@ show the fields in human readable format diff --git a/Documentation/nvme-id-ns.1 b/Documentation/nvme-id-ns.1 index 4bac15ef..37211497 100644 --- a/Documentation/nvme-id-ns.1 +++ b/Documentation/nvme-id-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,10 +32,10 @@ nvme-id-ns \- Send NVMe Identify Namespace, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme id\-ns\fR [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-\-namespace\-id= | \-n ] [\-\-force] - [\-\-human\-readable | \-H] - [\-\-output\-format= | \-o ] +\fInvme id\-ns\fR [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-namespace\-id= | \-n ] [\-\-force] + [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -61,7 +61,7 @@ Request controller return the identify namespace structure even if the namespace 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 @@ -71,13 +71,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 , \-\-output\-format= +\-o , \-\-output\-format= .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 @@ -139,7 +145,7 @@ In addition to showing the known fields, have the program to display the vendor .\} .nf # nvme id\-ns /dev/nvme0n1 \-\-vendor\-specific -# nvme id\-ns /dev/nvme0n1 \-v +# nvme id\-ns /dev/nvme0n1 \-V .fi .if n \{\ .RE diff --git a/Documentation/nvme-id-ns.html b/Documentation/nvme-id-ns.html index f28f9697..41d09be9 100644 --- a/Documentation/nvme-id-ns.html +++ b/Documentation/nvme-id-ns.html @@ -749,10 +749,10 @@ nvme-id-ns(1) Manual Page

SYNOPSIS

-
nvme id-ns <device> [-v | --vendor-specific] [-b | --raw-binary]
-                    [--namespace-id=<nsid> | -n <nsid>] [--force]
-                    [--human-readable | -H]
-                    [--output-format=<fmt> | -o <fmt>]
+
nvme id-ns <device> [--vendor-specific | -v] [--raw-binary | -b]
+                        [--namespace-id=<nsid> | -n <nsid>] [--force]
+                        [--human-readable | -H]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -817,7 +817,7 @@ raw buffer may be printed to stdout.

--v +-V
--vendor-specific @@ -842,15 +842,26 @@ raw buffer may be printed to stdout.

--o <format> +-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
---output-format=<format> +--verbose

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Increase the information detail in the output.

@@ -889,7 +900,7 @@ the vendor unique field: 
# nvme id-ns /dev/nvme0n1 --vendor-specific
-# nvme id-ns /dev/nvme0n1 -v
+# nvme id-ns /dev/nvme0n1 -V

The above will dump the 'vs' buffer in hex since it doesn’t know how to interpret it.

@@ -955,7 +966,7 @@ int main(int argc, char **argv) diff --git a/Documentation/nvme-id-nvmset.1 b/Documentation/nvme-id-nvmset.1 index fe06cc6b..51d70c77 100644 --- a/Documentation/nvme-id-nvmset.1 +++ b/Documentation/nvme-id-nvmset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-nvmset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NVMSET" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NVMSET" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-id-nvmset \- Send NVMe Identify NVM Set List, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme id\-nvmset\fR [\-i | \-\-nvmset_id= ] - [\-o | \-\-output\-format=] +\fInvme id\-nvmset\fR [\-\-nvmset_id= | \-i ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,13 +49,19 @@ On success, the structure may be returned in one of several ways depending on th This field specifies the identifier of the NVM Set\&. If given, NVM set identifier whose entry is to be in result data will be greater than or equal to this value\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-id-nvmset.html b/Documentation/nvme-id-nvmset.html index 4da3bf7c..730d0c5e 100644 --- a/Documentation/nvme-id-nvmset.html +++ b/Documentation/nvme-id-nvmset.html @@ -749,8 +749,8 @@ nvme-id-nvmset(1) Manual Page

SYNOPSIS

-
nvme id-nvmset <device> [-i <id> | --nvmset_id=<id> ]
-                        [-o <fmt> | --output-format=<fmt>]
+
nvme id-nvmset <device> [--nvmset_id=<id> | -i <id>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -779,21 +779,32 @@ raw buffer may be printed to stdout.

- This field specifies the identifier of the NVM Set. If given, NVM set + This field specifies the identifier of the NVM Set. If given, NVM set identifier whose entry is to be in result data will be greater than or equal to this value.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -851,7 +862,7 @@ as shown in the above example, or you can 'cat' a saved output buff diff --git a/Documentation/nvme-inspur-nvme-vendor-log.1 b/Documentation/nvme-inspur-nvme-vendor-log.1 index 63f338e7..45381f87 100644 --- a/Documentation/nvme-inspur-nvme-vendor-log.1 +++ b/Documentation/nvme-inspur-nvme-vendor-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-inspur-nvme-vendor-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INSPUR\-NVME\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INSPUR\-NVME\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-inspur-nvme-vendor-log.html b/Documentation/nvme-inspur-nvme-vendor-log.html index 99f8840e..989b25ff 100644 --- a/Documentation/nvme-inspur-nvme-vendor-log.html +++ b/Documentation/nvme-inspur-nvme-vendor-log.html @@ -796,7 +796,7 @@ Print the Inspur Device Vendor log page in a human readable format: diff --git a/Documentation/nvme-intel-id-ctrl.1 b/Documentation/nvme-intel-id-ctrl.1 index ab2c374b..9d642f7f 100644 --- a/Documentation/nvme-intel-id-ctrl.1 +++ b/Documentation/nvme-intel-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-ID\-CTR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-ID\-CTR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-intel-id-ctrl \- Send NVMe Identify Controller, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme intel id\-ctrl\fR [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o | \-\-output\-format=] +\fInvme intel id\-ctrl\fR [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -61,7 +61,7 @@ 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 , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-intel-id-ctrl.html b/Documentation/nvme-intel-id-ctrl.html index 30c9e1a0..3b268298 100644 --- a/Documentation/nvme-intel-id-ctrl.html +++ b/Documentation/nvme-intel-id-ctrl.html @@ -749,8 +749,8 @@ nvme-intel-id-ctrl(1) Manual Page

SYNOPSIS

-
nvme intel id-ctrl <device> [-v | --vendor-specific] [-b | --raw-binary]
-                        [-o <fmt> | --output-format=<fmt>]
+
nvme intel id-ctrl <device> [--vendor-specific | -v] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -811,15 +811,15 @@ will decode Intel vendor unique portions of the structure.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -853,7 +853,7 @@ fields in a human readable format: diff --git a/Documentation/nvme-intel-internal-log.1 b/Documentation/nvme-intel-internal-log.1 index 9649a14a..b08da170 100644 --- a/Documentation/nvme-intel-internal-log.1 +++ b/Documentation/nvme-intel-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-INTERNA" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-INTERNA" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-internal-log.html b/Documentation/nvme-intel-internal-log.html index 060b62d5..6893148d 100644 --- a/Documentation/nvme-intel-internal-log.html +++ b/Documentation/nvme-intel-internal-log.html @@ -873,7 +873,7 @@ Gets the event log from the device and saves to defined file: diff --git a/Documentation/nvme-intel-lat-stats.1 b/Documentation/nvme-intel-lat-stats.1 index 7e52cbb4..84219e73 100644 --- a/Documentation/nvme-intel-lat-stats.1 +++ b/Documentation/nvme-intel-lat-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-lat-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-LAT\-ST" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-LAT\-ST" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-lat-stats.html b/Documentation/nvme-intel-lat-stats.html index 3d72747d..8b3482d2 100644 --- a/Documentation/nvme-intel-lat-stats.html +++ b/Documentation/nvme-intel-lat-stats.html @@ -832,7 +832,7 @@ Get the write statistics diff --git a/Documentation/nvme-intel-market-name.1 b/Documentation/nvme-intel-market-name.1 index a7c45d49..e4dbc653 100644 --- a/Documentation/nvme-intel-market-name.1 +++ b/Documentation/nvme-intel-market-name.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-market-name .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-MARKET\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-MARKET\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-market-name.html b/Documentation/nvme-intel-market-name.html index 0e0e596a..d16ab566 100644 --- a/Documentation/nvme-intel-market-name.html +++ b/Documentation/nvme-intel-market-name.html @@ -813,7 +813,7 @@ Get the marketing name diff --git a/Documentation/nvme-intel-smart-log-add.1 b/Documentation/nvme-intel-smart-log-add.1 index cdcdaf34..495dd12e 100644 --- a/Documentation/nvme-intel-smart-log-add.1 +++ b/Documentation/nvme-intel-smart-log-add.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-smart-log-add .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-SMART\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-SMART\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,8 +33,7 @@ nvme-intel-smart-log-add \- Send NVMe Intel Additional SMART log page request, r .sp .nf \fInvme intel smart\-log\-add\fR [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] - [\-\-json | \-j] + [\-\-raw\-binary | \-b] [\-\-json | \-j] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-intel-smart-log-add.html b/Documentation/nvme-intel-smart-log-add.html index 0af652b4..2321f830 100644 --- a/Documentation/nvme-intel-smart-log-add.html +++ b/Documentation/nvme-intel-smart-log-add.html @@ -750,8 +750,7 @@ nvme-intel-smart-log-add(1) Manual Page 
nvme intel smart-log-add <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--raw-binary | -b]
-                        [--json | -j]
+ [--raw-binary | -b] [--json | -j]
@@ -807,7 +806,7 @@ printed to stdout for another program to parse.

- Dump output in json format. + Dump output in json format.

@@ -850,7 +849,7 @@ Print the raw Intel Additional SMART log to a file: diff --git a/Documentation/nvme-intel-temp-stats.1 b/Documentation/nvme-intel-temp-stats.1 index b47065c6..74d78986 100644 --- a/Documentation/nvme-intel-temp-stats.1 +++ b/Documentation/nvme-intel-temp-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-temp-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-TEMP\-S" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-TEMP\-S" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-temp-stats.html b/Documentation/nvme-intel-temp-stats.html index d485ae28..21cc0080 100644 --- a/Documentation/nvme-intel-temp-stats.html +++ b/Documentation/nvme-intel-temp-stats.html @@ -822,7 +822,7 @@ Print the raw SMART log to a file: diff --git a/Documentation/nvme-io-mgmt-recv.1 b/Documentation/nvme-io-mgmt-recv.1 index 22511259..959dbda4 100644 --- a/Documentation/nvme-io-mgmt-recv.1 +++ b/Documentation/nvme-io-mgmt-recv.1 @@ -2,12 +2,12 @@ .\" Title: nvme-io-mgmt-recv .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-IO\-MGMT\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-IO\-MGMT\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,10 @@ nvme-io-mgmt-recv \- I/O Management Receive command .sp .nf \fInvme io\-mgmt\-recv\fR [\-\-namespace\-id= | \-n ] - [\-\-mos= | \-s ] - [\-\-mo= | \-m ] - [\-\-data= | \-d ] - [\-\-data\-len= | \-l ] + [\-\-mos= | \-s ] [\-\-mo= | \-m ] + [\-\-data= | \-d ] + [\-\-data\-len= | \-l ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -67,6 +67,20 @@ Management Operation to perform\&. .RS 4 Management Operation Specific parameter\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 "NVME" .sp Part of nvme\-cli diff --git a/Documentation/nvme-io-mgmt-recv.html b/Documentation/nvme-io-mgmt-recv.html index 72ace1bd..1121139b 100644 --- a/Documentation/nvme-io-mgmt-recv.html +++ b/Documentation/nvme-io-mgmt-recv.html @@ -750,10 +750,10 @@ nvme-io-mgmt-recv(1) Manual Page 
nvme io-mgmt-recv <device> [--namespace-id=<NUM> | -n <NUM>]
-                             [--mos=<NUM> | -s <NUM>]
-                             [--mo=<NUM> | -m <NUM>]
-                             [--data=<FILE> | -d <FILE>]
-                             [--data-len=<NUM> | -l <NUM>]
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>] + [--data=<FILE> | -d <FILE>] + [--data-len=<NUM> | -l <NUM>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -832,6 +832,29 @@ a hex dump, or binary.

Management Operation Specific parameter.

+
+-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. +

+
@@ -846,7 +869,7 @@ a hex dump, or binary.

diff --git a/Documentation/nvme-io-mgmt-send.1 b/Documentation/nvme-io-mgmt-send.1 index 044cb770..c0638cfb 100644 --- a/Documentation/nvme-io-mgmt-send.1 +++ b/Documentation/nvme-io-mgmt-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-io-mgmt-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-IO\-MGMT\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-IO\-MGMT\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,10 @@ nvme-io-mgmt-send \- I/O Management Send command .sp .nf \fInvme io\-mgmt\-send\fR [\-\-namespace\-id= | \-n ] - [\-\-mos= | \-s ] - [\-\-mo= | \-m ] - [\-\-data= | \-d ] - [\-\-data\-len= | \-l ] + [\-\-mos= | \-s ] [\-\-mo= | \-m ] + [\-\-data= | \-d ] + [\-\-data\-len= | \-l ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -67,6 +67,20 @@ Management Operation to perform\&. .RS 4 Management Operation Specific parameter\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 "NVME" .sp Part of nvme\-cli diff --git a/Documentation/nvme-io-mgmt-send.html b/Documentation/nvme-io-mgmt-send.html index 7c455e10..c8466314 100644 --- a/Documentation/nvme-io-mgmt-send.html +++ b/Documentation/nvme-io-mgmt-send.html @@ -750,10 +750,10 @@ nvme-io-mgmt-send(1) Manual Page 
nvme io-mgmt-send <device> [--namespace-id=<NUM> | -n <NUM>]
-                             [--mos=<NUM> | -s <NUM>]
-                             [--mo=<NUM> | -m <NUM>]
-                             [--data=<FILE> | -d <FILE>]
-                             [--data-len=<NUM> | -l <NUM>]
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>] + [--data=<FILE> | -d <FILE>] + [--data-len=<NUM> | -l <NUM>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -831,6 +831,29 @@ convenience parameters to produce the binary payload.

Management Operation Specific parameter.

+
+-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. +

+
@@ -845,7 +868,7 @@ convenience parameters to produce the binary payload.

diff --git a/Documentation/nvme-io-passthru.1 b/Documentation/nvme-io-passthru.1 index da0e3011..f0042025 100644 --- a/Documentation/nvme-io-passthru.1 +++ b/Documentation/nvme-io-passthru.1 @@ -2,12 +2,12 @@ .\" Title: nvme-io-passthru .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-IO\-PASSTHRU" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-IO\-PASSTHRU" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,23 +32,22 @@ nvme-io-passthru \- Submit an arbitrary io command, return results .SH "SYNOPSIS" .sp .nf -\fInvme\-io\-passthru\fR [\-\-opcode= | \-o ] - [\-\-flags= | \-f ] [\-rsvd= | \-R ] - [\-\-namespace\-id= | \-nsid ] - [\-\-cdw2=] [\-\-cdw3=] [\-\-cdw10=] - [\-\-cdw11=] [\-\-cdw12=] [\-\-cdw13=] - [\-\-cdw14=] [\-\-cdw15=] - [\-\-data\-len= | \-l ] - [\-\-metadata\-len= | \-m ] - [\-\-read | \-r ] [\-\-write | \-w] - [\-\-input\-file= | \-i ] - [\-\-metadata= | \-M ] - [\-\-timeout= | \-t ] - [\-\-show\-command | \-s] - [\-\-dry\-run | \-d] - [\-\-raw\-binary | \-b] - [\-\-prefill= | \-p ] - [\-\-latency | \-T] +\fInvme\-io\-passthru\fR [\-\-opcode= | \-O ] + [\-\-flags= | \-f ] [\-rsvd= | \-R ] + [\-\-namespace\-id= | \-nsid ] + [\-\-cdw2=] [\-\-cdw3=] [\-\-cdw10=] + [\-\-cdw11=] [\-\-cdw12=] [\-\-cdw13=] + [\-\-cdw14=] [\-\-cdw15=] + [\-\-data\-len= | \-l ] + [\-\-metadata\-len= | \-m ] + [\-\-read | \-r] [\-\-write | \-w] + [\-\-input\-file= | \-i ] + [\-\-metadata= | \-M ] + [\-\-timeout= | \-t ] [\-\-show\-command | \-s] + [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] + [\-\-prefill= | \-p ] + [\-\-latency | \-T] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -59,7 +58,7 @@ The parameter is mandatory and may be either the NVMe character device On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&. .SH "OPTIONS" .PP -\-o , \-\-opcode= +\-O , \-\-opcode= .RS 4 The NVMe opcode to send to the device in the command .RE @@ -137,6 +136,20 @@ Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may .RS 4 Print out the latency the IOCTL took (in us)\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 nvme io\-passthru /dev/nvme0n1 \-\-opcode=2 \-\-namespace\-id=1 \-\-data\-len=4096 \-\-read \-\-cdw10=0 \-\-cdw11=0 \-\-cdw12=0x70000 \-\-raw\-binary diff --git a/Documentation/nvme-io-passthru.html b/Documentation/nvme-io-passthru.html index 09c58d86..38b44b86 100644 --- a/Documentation/nvme-io-passthru.html +++ b/Documentation/nvme-io-passthru.html @@ -749,23 +749,22 @@ nvme-io-passthru(1) Manual Page

SYNOPSIS

-
nvme-io-passthru <device> [--opcode=<opcode> | -o <opcode>]
-                [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
-                [--namespace-id=<nsid> | -nsid <nsid>]
-                [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]
-                [--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]
-                [--cdw14=<cdw14>] [--cdw15=<cdw15>]
-                [--data-len=<data-len> | -l <data-len>]
-                [--metadata-len=<len> | -m <len>]
-                [--read | -r ] [--write | -w]
-                [--input-file=<file> | -i <file>]
-                [--metadata=<file> | -M <file>]
-                [--timeout=<to> | -t <to>]
-                [--show-command | -s]
-                [--dry-run | -d]
-                [--raw-binary | -b]
-                [--prefill=<prefill> | -p <prefill>]
-                [--latency | -T]
+
nvme-io-passthru <device> [--opcode=<opcode> | -O <opcode>]
+                        [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
+                        [--namespace-id=<nsid> | -nsid <nsid>]
+                        [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]
+                        [--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]
+                        [--cdw14=<cdw14>] [--cdw15=<cdw15>]
+                        [--data-len=<data-len> | -l <data-len>]
+                        [--metadata-len=<len> | -m <len>]
+                        [--read | -r] [--write | -w]
+                        [--input-file=<file> | -i <file>]
+                        [--metadata=<file> | -M <file>]
+                        [--timeout=<to> | -t <to>] [--show-command | -s]
+                        [--dry-run | -d] [--raw-binary | -b]
+                        [--prefill=<prefill> | -p <prefill>]
+                        [--latency | -T]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -790,7 +789,7 @@ printed to stdout for another program to parse.

--o <opcode> +-O <opcode>
--opcode=<opcode> @@ -973,6 +972,29 @@ printed to stdout for another program to parse.

Print out the latency the IOCTL took (in us).

+
+-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. +

+
@@ -993,7 +1015,7 @@ printed to stdout for another program to parse.

diff --git a/Documentation/nvme-lba-status-log.1 b/Documentation/nvme-lba-status-log.1 index 2b273f72..2b11148f 100644 --- a/Documentation/nvme-lba-status-log.1 +++ b/Documentation/nvme-lba-status-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-lba-status-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LBA\-STATUS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LBA\-STATUS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,8 @@ nvme-lba-status-log \- Send LBA Status Log Page request returns result and log .SH "SYNOPSIS" .sp .nf -\fInvme lba\-status\-log\fR [\-\-rae | \-r] [\-\-output\-format= | \-o ] +\fInvme lba\-status\-log\fR [\-\-rae | \-r] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -48,13 +49,19 @@ On success, the returned LBA Status Log Page structure may be returned in one of Retain an Asynchronous Event\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-lba-status-log.html b/Documentation/nvme-lba-status-log.html index 72274ba7..caeee329 100644 --- a/Documentation/nvme-lba-status-log.html +++ b/Documentation/nvme-lba-status-log.html @@ -749,7 +749,8 @@ nvme-lba-status-log(1) Manual Page

SYNOPSIS

-
nvme lba-status-log <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
+
nvme lba-status-log <device> [--rae | -r]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -783,15 +784,26 @@ may be printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + 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.

@@ -831,7 +843,7 @@ NVME diff --git a/Documentation/nvme-list-ctrl.1 b/Documentation/nvme-list-ctrl.1 index 5d10cfbd..fb816afe 100644 --- a/Documentation/nvme-list-ctrl.1 +++ b/Documentation/nvme-list-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,25 +33,17 @@ nvme-list-ctrl \- Send NVMe Identify List Controllers, return result and structu .sp .nf \fInvme list\-ctrl\fR [\-\-cntid= | \-c ] - [\-\-namespace\-id= | \-n ] [\-o | \-\-output\-format=] -DESCRIPTION + [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi +.SH "DESCRIPTION" .sp -.nf -For the NVMe device given, sends an identify command for controller list -and provides the result and returned structure\&. This uses either mode -12h or 13h depending on the requested namespace identifier\&. - -The parameter is mandatory and may be either the NVMe character -device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. -The starting controller in the list always begins with 0 unless the -`\*(Aq\-\-cntid\*(Aq` option is given to override\&. - -On success, the controller array is printed for each index and controller -identifier\&. - -OPTIONS -.fi +For the NVMe device given, sends an identify command for controller list and provides the result and returned structure\&. This uses either mode 12h or 13h depending on the requested namespace identifier\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. The starting controller in the list always begins with 0 unless the \*(Aq\-\-cntid\*(Aq option is given to override\&. +.sp +On success, the controller array is printed for each index and controller identifier\&. +.SH "OPTIONS" .PP \-c , \-\-cntid= .RS 4 @@ -63,12 +55,18 @@ Retrieve the identify list structure starting with the given controller id\&. If provided, will request the controllers attached to the specified namespace\&. If no namespace is given, or set to 0, the command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s)\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR +\fInormal\fR, +\fIjson\fR or -\fIjson\fR\&. Only one output format can be used at a time\&. +\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 diff --git a/Documentation/nvme-list-ctrl.html b/Documentation/nvme-list-ctrl.html index 68d540fd..0f1a72bc 100644 --- a/Documentation/nvme-list-ctrl.html +++ b/Documentation/nvme-list-ctrl.html @@ -750,26 +750,29 @@ nvme-list-ctrl(1) Manual Page 
nvme list-ctrl <device> [--cntid=<cntid> | -c <cntid>]
-                        [--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>]
-DESCRIPTION
+ [--namespace-id=<nsid> | -n <nsid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
-
-
-
For the NVMe device given, sends an identify command for controller list
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends an identify command for controller list and provides the result and returned structure. This uses either mode -12h or 13h depending on the requested namespace identifier. - -The <device> parameter is mandatory and may be either the NVMe character +12h or 13h depending on the requested namespace identifier.

+

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). The starting controller in the list always begins with 0 unless the -`'--cntid'` option is given to override. - -On success, the controller array is printed for each index and controller -identifier. - -OPTIONS -

+'--cntid' option is given to override.

+

On success, the controller array is printed for each index and controller +identifier.

+
+ +
+

OPTIONS

+
-c <cntid> @@ -797,15 +800,26 @@ OPTIONS

--o <format> +-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
---output-format=<format> +--verbose

- Set the reporting format to normal or json. Only one output - format can be used at a time. + Increase the information detail in the output.

@@ -828,7 +842,7 @@ OPTIONS diff --git a/Documentation/nvme-list-endgrp.1 b/Documentation/nvme-list-endgrp.1 index be623aeb..fb2a124e 100644 --- a/Documentation/nvme-list-endgrp.1 +++ b/Documentation/nvme-list-endgrp.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list-endgrp .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST\-ENDGRP" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST\-ENDGRP" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-list-endgrp \- Send NVMe Identify Endurance Group List, return result and s .sp .nf \fInvme list\-endgrp\fR [\-\-endgrp\-id= | \-i ] - [\-o | \-\-output\-format=] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,12 +47,18 @@ The parameter is mandatory and may be either the NVMe character device Retrieve the identify endurance group list structure starting for the given endurance group id\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR +\fInormal\fR, +\fIjson\fR or -\fIjson\fR\&. Only one output format can be used at a time\&. +\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 diff --git a/Documentation/nvme-list-endgrp.html b/Documentation/nvme-list-endgrp.html index caa86f88..16171297 100644 --- a/Documentation/nvme-list-endgrp.html +++ b/Documentation/nvme-list-endgrp.html @@ -750,7 +750,7 @@ nvme-list-endgrp(1) Manual Page 
nvme list-endgrp <device> [--endgrp-id=<endgrp-id> | -i <endgrp-id>]
-                        [-o <fmt> | --output-format=<fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -779,20 +779,31 @@ than or equal to the value specified in the CDW11.ENDGID field.

- Retrieve the identify endurance group list structure starting for the given - endurance group id. + Retrieve the identify endurance group list structure starting for the + given endurance group id.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal or json. Only one output - format can be used at a time. + 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.

@@ -815,7 +826,7 @@ than or equal to the value specified in the CDW11.ENDGID field.

diff --git a/Documentation/nvme-list-ns.1 b/Documentation/nvme-list-ns.1 index da5f1ccb..f2c274ea 100644 --- a/Documentation/nvme-list-ns.1 +++ b/Documentation/nvme-list-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,7 +34,8 @@ nvme-list-ns \- Send NVMe Identify List Namespaces, return result and structure .nf \fInvme list\-ns\fR [\-\-namespace\-id= | \-n ] [\-\-csi= | \-y ] - [\-\-all | \-a] [\-\-output\-format= | \-o ] + [\-\-all | \-a] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -60,11 +61,18 @@ If this value is given, retrieve the identify list structure associated with the Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR, or -\fIjson\fR\&. Only one output format can be used at a time\&. +\fInormal\fR, +\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 diff --git a/Documentation/nvme-list-ns.html b/Documentation/nvme-list-ns.html index b6794209..d7c99949 100644 --- a/Documentation/nvme-list-ns.html +++ b/Documentation/nvme-list-ns.html @@ -751,7 +751,8 @@ nvme-id-ns(1) Manual Page 
nvme list-ns <device> [--namespace-id=<nsid> | -n <nsid>]
                         [--csi=<command_set_identifier> | -y <command_set_identifier>]
-                        [--all | -a] [--output-format=<fmt> | -o <fmt>]
+ [--all | -a] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -809,15 +810,26 @@ a valid nsid.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, or json. - Only one output format can be used at a time. + 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.

@@ -859,7 +871,7 @@ Print the namespaces present for NVM Command Set in normal format diff --git a/Documentation/nvme-list-subsys.1 b/Documentation/nvme-list-subsys.1 index 225740ec..91add1ee 100644 --- a/Documentation/nvme-list-subsys.1 +++ b/Documentation/nvme-list-subsys.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list-subsys .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST\-SUBSYS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST\-SUBSYS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,19 +32,25 @@ nvme-list-subsys \- List all NVMe subsystems .SH "SYNOPSIS" .sp .nf -\fInvme list\-subsys\fR [\-o | \-\-output\-format=] +\fInvme list\-subsys\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Scan the sysfs tree for NVM Express subsystems and return the controllers for those subsystems as well as some pertinent information about them\&. If a device is given, print out only the values for the controllers and subsystems leading to the device\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR +\fInormal\fR, +\fIjson\fR or -\fIjson\fR\&. Only one output format can be used at a time\&. +\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 diff --git a/Documentation/nvme-list-subsys.html b/Documentation/nvme-list-subsys.html index 9e0fbec0..434385a1 100644 --- a/Documentation/nvme-list-subsys.html +++ b/Documentation/nvme-list-subsys.html @@ -749,7 +749,7 @@ nvme-list-subsys(1) Manual Page

SYNOPSIS

-
nvme list-subsys [-o <fmt> | --output-format=<fmt>] <device>
+
nvme list-subsys <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -768,15 +768,26 @@ and subsystems leading to the device.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal or json. Only one output - format can be used at a time. + 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.

@@ -854,7 +865,7 @@ nvme-subsys1 - NQN=nvmf-test2 diff --git a/Documentation/nvme-list.1 b/Documentation/nvme-list.1 index 463cf785..e71dee45 100644 --- a/Documentation/nvme-list.1 +++ b/Documentation/nvme-list.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,19 +32,20 @@ nvme-list \- List all recognized NVMe devices .SH "SYNOPSIS" .sp .nf -\fInvme list\fR [\-o | \-\-output\-format=] +\fInvme list\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to -\fInormal\fR +\fInormal\fR, +\fIjson\fR or -\fIjson\fR\&. Only one output format can be used at a time\&. +\fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP \-v, \-\-verbose diff --git a/Documentation/nvme-list.html b/Documentation/nvme-list.html index cfa91f3a..26efc470 100644 --- a/Documentation/nvme-list.html +++ b/Documentation/nvme-list.html @@ -749,7 +749,7 @@ nvme-list(1) Manual Page

SYNOPSIS

-
nvme list [-o <fmt> | --output-format=<fmt>]
+
nvme list [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -766,15 +766,15 @@ for those devices as well as some pertinent information about them.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal or json. Only one output - format can be used at a time. + Set the reporting format to normal, json or binary. Only one + output format can be used at a time.

@@ -816,7 +816,7 @@ for those devices as well as some pertinent information about them.

diff --git a/Documentation/nvme-lockdown.1 b/Documentation/nvme-lockdown.1 index cd382104..f1f3c6c1 100644 --- a/Documentation/nvme-lockdown.1 +++ b/Documentation/nvme-lockdown.1 @@ -2,12 +2,12 @@ .\" Title: nvme-lockdown .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LOCKDOWN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LOCKDOWN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,41 +32,56 @@ nvme-lockdown \- Send an NVMe Lockdown command to prohibit or allow the executio .SH "SYNOPSIS" .sp .nf -\fInvme\-lockdown\fR [\-\-ofi= | \-o ] +\fInvme\-lockdown\fR [\-\-ofi= | \-O ] [\-\-ifc= | \-f ] [\-\-prhbt= | \-p ] [\-\-scp= | \-s ] [\-\-uuid= | \-U ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Lockdown command is used to control the Command and Feature Lockdown capability which configures the prohibition or allowance of execution of the specified command or Set Features command targeting a specific Feature Identifier\&. .SH "OPTIONS" .PP -\-\-ofi=, \-o +\-O , \-\-ofi= .RS 4 Opcode or Feature Identifier(OFI) specifies the command opcode or Set Features Feature Identifier identified by the Scope field\&. .RE .PP -\-\-ifc=, \-f +\-f , \-\-ifc= .RS 4 Interface (INF) field identifies the interfaces affected by this command\&. .RE .PP -\-\-prhbt=, \-p +\-p , \-\-prhbt= .RS 4 Prohibit (PRHBT) bit specifies whether to prohibit or allow the command opcode or Set Features Feature Identifier specified by this command\&. .RE .PP -\-\-scp=, \-s +\-s , \-\-scp= .RS 4 Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field\&. .RE .PP -\-\-uuid=, \-U +\-U , \-\-uuid= .RS 4 UUID Index \- If this field is set to a non\-zero value, then the value of this field is the index of a UUID in the UUID List that is used by the command\&. If this field is cleared to 0h,then no UUID index is specified\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-lockdown.html b/Documentation/nvme-lockdown.html index 7c75f209..4bbaffc5 100644 --- a/Documentation/nvme-lockdown.html +++ b/Documentation/nvme-lockdown.html @@ -749,11 +749,12 @@ nvme-lockdown(1) Manual Page

SYNOPSIS

-
nvme-lockdown <device> [--ofi=<ofi> | -o <ofi>]
+
nvme-lockdown <device> [--ofi=<ofi> | -O <ofi>]
                         [--ifc=<ifc> | -f <ifc>]
                         [--prhbt=<prhbt> | -p <prhbt>]
                         [--scp=<scp> | -s <scp>]
-                        [--uuid=<UUID_Index> | -U <UUID_Index>]

+                        [--uuid=<UUID_Index> | -U <UUID_Index>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -772,10 +773,10 @@ Identifier.

---ofi=<ofi> +-O <ofi>
--o <ofi> +--ofi=<ofi>

@@ -784,10 +785,10 @@ Identifier.

---ifc=<ifc> +-f <ifc>
--f <ifc> +--ifc=<ifc>

@@ -795,10 +796,10 @@ Identifier.

---prhbt=<prhbt> +-p <prhbt>
--p <prhbt> +--prhbt=<prhbt>

@@ -807,10 +808,10 @@ Identifier.

---scp=<scp> +-s <scp>
--s <scp> +--scp=<scp>

@@ -818,10 +819,10 @@ Identifier.

---uuid=<UUID_Index> +-U <UUID_Index>
--U <UUID_Index> +--uuid=<UUID_Index>

@@ -830,6 +831,29 @@ Identifier.

If this field is cleared to 0h,then no UUID index is specified.

+
+-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. +

+
@@ -850,7 +874,7 @@ Identifier.

diff --git a/Documentation/nvme-mi-cmd-support-effects-log.1 b/Documentation/nvme-mi-cmd-support-effects-log.1 index a47a7eb1..632a36ce 100644 --- a/Documentation/nvme-mi-cmd-support-effects-log.1 +++ b/Documentation/nvme-mi-cmd-support-effects-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-mi-cmd-support-effects-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MI\-CMD\-SUPPO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MI\-CMD\-SUPPO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-mi-cmd-support-effects-log \- Send NVMe MI Command Support and Effects log, .SH "SYNOPSIS" .sp .nf -\fInvme\-mi\-cmd\-support\-effects\-log\fR [\-o | \-\-output\-format=] - [\-H | \-\-human\-readable] +\fInvme\-mi\-cmd\-support\-effects\-log\fR [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,17 +44,23 @@ The parameter is mandatory and may be either the NVMe character device On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o , \-\-output\-format= .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 -\-H, \-\-human\-readable +\-v, \-\-verbose .RS 4 -This option will parse and format many of the bit fields into human\-readable formats\&. +Increase the information detail in the output\&. .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-mi-cmd-support-effects-log.html b/Documentation/nvme-mi-cmd-support-effects-log.html index 38ff0671..7807979e 100644 --- a/Documentation/nvme-mi-cmd-support-effects-log.html +++ b/Documentation/nvme-mi-cmd-support-effects-log.html @@ -740,7 +740,7 @@ nvme-mi-cmd-support-effects-log(1) Manual Page

NAME

nvme-mi-cmd-support-effects-log - - Send NVMe MI Command Support and Effects log, returns results and structure + Send NVMe MI Command Support and Effects log, returns results and structure

@@ -749,8 +749,8 @@ nvme-mi-cmd-support-effects-log(1) Manual Page

SYNOPSIS

-
nvme-mi-cmd-support-effects-log <device> [-o <fmt> | --output-format=<fmt>]
-                                        [-H | --human-readable]
+
nvme-mi-cmd-support-effects-log <device> [--human-readable | -H]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -772,27 +772,38 @@ raw buffer may be printed to stdout.

--o <format> +-H
---output-format=<format> +--human-readable

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + This option will parse and format many of the bit fields + into human-readable formats.

--H +-o <fmt>
---human-readable +--output-format=<fmt>

- This option will parse and format many of the bit fields - into human-readable formats. + 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.

@@ -815,7 +826,7 @@ raw buffer may be printed to stdout.

diff --git a/Documentation/nvme-micron-clear-pcie-errors.1 b/Documentation/nvme-micron-clear-pcie-errors.1 index 326f37e1..ed8c0dbe 100644 --- a/Documentation/nvme-micron-clear-pcie-errors.1 +++ b/Documentation/nvme-micron-clear-pcie-errors.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-clear-pcie-errors .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-CLEAR\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-CLEAR\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-clear-pcie-errors.html b/Documentation/nvme-micron-clear-pcie-errors.html index 1b954df4..22ad45b4 100644 --- a/Documentation/nvme-micron-clear-pcie-errors.html +++ b/Documentation/nvme-micron-clear-pcie-errors.html @@ -798,7 +798,7 @@ Retrieve NAND statistics information diff --git a/Documentation/nvme-micron-internal-log.1 b/Documentation/nvme-micron-internal-log.1 index df7d7366..63db825e 100644 --- a/Documentation/nvme-micron-internal-log.1 +++ b/Documentation/nvme-micron-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-INTERN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-INTERN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -36,7 +36,7 @@ nvme-micron-internal-log \- Retrieve Micron device\*(Aqs internal logs and save .fi .SH "DESCRIPTION" .sp -For the given NVMe device, sends the Micron vendor specific device commands to retrieve various logs (in binary format) and compresses them and saves into specified zip file\&. These vendor unique logs can be analyzed with Micron Technical support team for any device specific issues +For the given NVMe device, sends the Micron vendor specific device commands to retrieve various logs (in binary format) and compresses them and saves into specified zip file\&. These vendor unique logs can be analyzed with Micron Technical support team for any device specific issues\&. .sp The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. .sp diff --git a/Documentation/nvme-micron-internal-log.html b/Documentation/nvme-micron-internal-log.html index de274c24..710ecb9f 100644 --- a/Documentation/nvme-micron-internal-log.html +++ b/Documentation/nvme-micron-internal-log.html @@ -757,15 +757,16 @@ nvme-micron-internal-log(1) Manual Page

DESCRIPTION

-

For the given NVMe device, sends the Micron vendor specific device commands to retrieve -various logs (in binary format) and compresses them and saves into specified zip file. -These vendor unique logs can be analyzed with Micron Technical support team for any device -specific issues

+

For the given NVMe device, sends the Micron vendor specific device commands to +retrieve various logs (in binary format) and compresses them and saves into +specified zip file. These vendor unique logs can be analyzed with Micron +Technical support team for any device specific issues.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

-

This will only work on Micron devices devices of model numbers 9200 and 54XX. Support -for new devices may be added subsequently. Results for any other device are undefined.

+

This will only work on Micron devices devices of model numbers 9200 and 54XX. +Support for new devices may be added subsequently. Results for any other device +are undefined.

@@ -813,7 +814,7 @@ Gets the logs from the device and saves to micron_logs.zip file diff --git a/Documentation/nvme-micron-nand-stats.1 b/Documentation/nvme-micron-nand-stats.1 index 02f47640..28fb4c31 100644 --- a/Documentation/nvme-micron-nand-stats.1 +++ b/Documentation/nvme-micron-nand-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-nand-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-NAND\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-NAND\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-nand-stats.html b/Documentation/nvme-micron-nand-stats.html index c3279b84..6a8cfa5e 100644 --- a/Documentation/nvme-micron-nand-stats.html +++ b/Documentation/nvme-micron-nand-stats.html @@ -799,7 +799,7 @@ Retrieve NAND statistics information diff --git a/Documentation/nvme-micron-pcie-stats.1 b/Documentation/nvme-micron-pcie-stats.1 index f99df4a5..4ba53a46 100644 --- a/Documentation/nvme-micron-pcie-stats.1 +++ b/Documentation/nvme-micron-pcie-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-pcie-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-PCIE\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-PCIE\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-pcie-stats.html b/Documentation/nvme-micron-pcie-stats.html index 4c640109..a4b05574 100644 --- a/Documentation/nvme-micron-pcie-stats.html +++ b/Documentation/nvme-micron-pcie-stats.html @@ -799,7 +799,7 @@ Retrieve PCIe error information diff --git a/Documentation/nvme-micron-selective-download.1 b/Documentation/nvme-micron-selective-download.1 index 99a364dd..18faaeb1 100644 --- a/Documentation/nvme-micron-selective-download.1 +++ b/Documentation/nvme-micron-selective-download.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-selective-download .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-SELECT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-SELECT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,19 +28,20 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -nvme-micron-selective-download \- Performs selective firmware download that allows user to select which firmware binary to update for 9200 devices\&. This requires power cycle once the update completes\&. +nvme-micron-selective-download \- Performs selective firmware download that allows user select which firmware binary to update for 9200 devices\&. This requires power cycle the update completes\&. .SH "SYNOPSIS" .sp .nf -\fInvme micron selective\-download\fR [\-\-fw=, \-f ] [\-\-select=, \-s ] +\fInvme micron selective\-download\fR [\-\-fw=, \-f ] + [\-\-select=, \-s ] .fi .SH "DESCRIPTION" .sp -This command uses micron vendor specific nvme commands to download given firmware image to the specified 9200 device to update selected or all portions of firmware image\&. +This command uses micron vendor specific nvme commands to download given firmware image to the 9200 device to update selected or all portions of firmware image\&. .sp The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. .sp -This will only work on Micron devices devices of model number 9200\&. Support for new devices may be added subsequently\&. Results for any other device are undefined\&. +This will only work on Micron devices devices of model number 9200\&. Support for new devices be added subsequently\&. Results for any other device are undefined\&. .SH "OPTIONS" .PP \-f , \-\-fw= diff --git a/Documentation/nvme-micron-selective-download.html b/Documentation/nvme-micron-selective-download.html index da0910ec..4cd38163 100644 --- a/Documentation/nvme-micron-selective-download.html +++ b/Documentation/nvme-micron-selective-download.html @@ -740,7 +740,7 @@ nvme-micron-selective-download(1) Manual Page

NAME

nvme-micron-selective-download - - Performs selective firmware download that allows user to select which firmware binary to update for 9200 devices. This requires power cycle once the update completes. + Performs selective firmware download that allows user select which firmware binary to update for 9200 devices. This requires power cycle the update completes.

@@ -749,7 +749,8 @@ nvme-micron-selective-download(1) Manual Page

SYNOPSIS

-
nvme micron selective-download <device> [--fw=<FILE>, -f <FILE>] [--select=<flag>, -s <flag>]
+
nvme micron selective-download <device> [--fw=<FILE>, -f <FILE>]
+                        [--select=<flag>, -s <flag>]
@@ -757,13 +758,14 @@ nvme-micron-selective-download(1) Manual Page

DESCRIPTION

-

This command uses micron vendor specific nvme commands to download given firmware image to the -specified 9200 device to update selected or all portions of firmware image.

+

This command uses micron vendor specific nvme commands to download given +firmware image to the 9200 device to update selected or all portions of firmware +image.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

-

This will only work on Micron devices devices of model number 9200. Support for new devices -may be added subsequently. Results for any other device are undefined.

+

This will only work on Micron devices devices of model number 9200. Support for +new devices be added subsequently. Results for any other device are undefined.

@@ -867,7 +869,7 @@ Update eeprom, OOB and main firmware diff --git a/Documentation/nvme-micron-smart-add-log.1 b/Documentation/nvme-micron-smart-add-log.1 index c514bed5..9ba76b14 100644 --- a/Documentation/nvme-micron-smart-add-log.1 +++ b/Documentation/nvme-micron-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-SMART\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-SMART\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-micron-smart-add-log \- Retrieves NAND statistics (2200 model drives) or Ex .SH "SYNOPSIS" .sp .nf -\fInvme micron vs\-smart\-add\-log\fR \-f +\fInvme micron vs\-smart\-add\-log\fR \-f .fi .SH "DESCRIPTION" .sp @@ -44,8 +44,11 @@ The \fI\-f\fR option controls the displayed output data format based on the opti .sp This will only work on Micron devices devices of model numbers 54XX and OCP complaint controllers\&. Support for new devices may be added subsequently\&. .SH "OPTIONS" -.sp -\-f controls the format of displayed output\&. +.PP +\-f +.RS 4 +Controls the format of displayed output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-micron-smart-add-log.html b/Documentation/nvme-micron-smart-add-log.html index b4a9025e..3b5f2453 100644 --- a/Documentation/nvme-micron-smart-add-log.html +++ b/Documentation/nvme-micron-smart-add-log.html @@ -749,7 +749,7 @@ nvme-micron-smart-add-log(1) Manual Page

SYNOPSIS

-
nvme micron vs-smart-add-log <device>  -f <json|normal>
+
nvme micron vs-smart-add-log <device> -f <json|normal>
@@ -775,7 +775,16 @@ complaint controllers. Support for new devices may be added subsequently.

OPTIONS

-

-f <json|normal> controls the format of displayed output.

+
+
+-f <json|normal> +
+
+

+ Controls the format of displayed output. +

+
+
@@ -808,7 +817,7 @@ Retrieve NAND/extended SMART data and display in json format diff --git a/Documentation/nvme-micron-temperature-stats.1 b/Documentation/nvme-micron-temperature-stats.1 index 419f6193..1b0cb47c 100644 --- a/Documentation/nvme-micron-temperature-stats.1 +++ b/Documentation/nvme-micron-temperature-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-temperature-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-TEMPER" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-TEMPER" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-temperature-stats.html b/Documentation/nvme-micron-temperature-stats.html index 68f9f61b..b5a8ac53 100644 --- a/Documentation/nvme-micron-temperature-stats.html +++ b/Documentation/nvme-micron-temperature-stats.html @@ -799,7 +799,7 @@ Retrieve temperature information diff --git a/Documentation/nvme-netapp-ontapdevices.1 b/Documentation/nvme-netapp-ontapdevices.1 index 233e1836..f5493289 100644 --- a/Documentation/nvme-netapp-ontapdevices.1 +++ b/Documentation/nvme-netapp-ontapdevices.1 @@ -2,12 +2,12 @@ .\" Title: nvme-netapp-ontapdevices .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NETAPP\-ONTAPD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NETAPP\-ONTAPD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-netapp-ontapdevices \- Display information about ONTAP devices .SH "SYNOPSIS" .sp .nf -\fInvme netapp ontapdevices\fR [\-o | \-\-output\-format=] +\fInvme netapp ontapdevices\fR [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-netapp-ontapdevices.html b/Documentation/nvme-netapp-ontapdevices.html index be92dc2f..ecd745ba 100644 --- a/Documentation/nvme-netapp-ontapdevices.html +++ b/Documentation/nvme-netapp-ontapdevices.html @@ -749,7 +749,7 @@ nvme-netapp-ontapdevices(1) Manual Page

SYNOPSIS

-
nvme netapp ontapdevices [-o <fmt> | --output-format=<fmt>]
+
nvme netapp ontapdevices [--output-format=<fmt> | -o <fmt>]
@@ -773,8 +773,8 @@ identified using the Identify Controller data.

- Set the reporting format to normal (default), column, or - json. Only one output format can be used at a time. + Set the reporting format to normal (default), column, or + json. Only one output format can be used at a time.

@@ -807,7 +807,7 @@ Display information, in a column-based format, for ONTAP devices. diff --git a/Documentation/nvme-netapp-smdevices.1 b/Documentation/nvme-netapp-smdevices.1 index a86c54d7..507b6bdf 100644 --- a/Documentation/nvme-netapp-smdevices.1 +++ b/Documentation/nvme-netapp-smdevices.1 @@ -2,12 +2,12 @@ .\" Title: nvme-netapp-smdevices .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NETAPP\-SMDEVI" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NETAPP\-SMDEVI" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-netapp-smdevices \- Display information for each NVMe path to an E\-Series .SH "SYNOPSIS" .sp .nf -\fInvme netapp smdevices\fR [\-o | \-\-output\-format=] +\fInvme netapp smdevices\fR [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-netapp-smdevices.html b/Documentation/nvme-netapp-smdevices.html index 8546e9d1..66b4998f 100644 --- a/Documentation/nvme-netapp-smdevices.html +++ b/Documentation/nvme-netapp-smdevices.html @@ -749,7 +749,7 @@ nvme-netapp-smdevices(1) Manual Page

SYNOPSIS

-
nvme netapp smdevices [-o <fmt> | --output-format=<fmt>]
+
nvme netapp smdevices [--output-format=<fmt> | -o <fmt>]
@@ -809,7 +809,7 @@ namespace. diff --git a/Documentation/nvme-ns-descs.1 b/Documentation/nvme-ns-descs.1 index 034669f9..f577c11a 100644 --- a/Documentation/nvme-ns-descs.1 +++ b/Documentation/nvme-ns-descs.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ns-descs .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NS\-DESCS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NS\-DESCS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-ns-descs \- Send NVMe Identify for a list of Namespace Identification Descr .SH "SYNOPSIS" .sp .nf -\fInvme ns\-descs\fR [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] +\fInvme ns\-descs\fR [\-\-namespace\-id= | \-n ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,13 +54,19 @@ Retrieve the identify namespace identification descriptor structure for the give Print the raw buffer to stdout\&. Structure is not parsed by program\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-ns-descs.html b/Documentation/nvme-ns-descs.html index 83888463..79325076 100644 --- a/Documentation/nvme-ns-descs.html +++ b/Documentation/nvme-ns-descs.html @@ -749,9 +749,8 @@ nvme-ns-descs(1) Manual Page

SYNOPSIS

-
nvme ns-descs <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+
nvme ns-descs <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -803,15 +802,26 @@ raw buffer may be printed to stdout.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + 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.

@@ -857,7 +867,7 @@ Have the program return the raw structure in binary: diff --git a/Documentation/nvme-ns-rescan.1 b/Documentation/nvme-ns-rescan.1 index 35b52857..89f22a0f 100644 --- a/Documentation/nvme-ns-rescan.1 +++ b/Documentation/nvme-ns-rescan.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ns-rescan .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NS\-RESCAN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NS\-RESCAN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,26 @@ nvme-ns-rescan \- Rescans the nvme namespaces\&. .SH "SYNOPSIS" .sp .nf -\fInvme ns\-rescan\fR +\fInvme ns\-rescan\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe controller rescans the namespaces\&. The param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-ns-rescan.html b/Documentation/nvme-ns-rescan.html index 0386119e..3f4ebde9 100644 --- a/Documentation/nvme-ns-rescan.html +++ b/Documentation/nvme-ns-rescan.html @@ -749,7 +749,7 @@ nvme-ns-rescan(1) Manual Page

SYNOPSIS

-
nvme ns-rescan <device>
+
nvme ns-rescan <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -764,7 +764,31 @@ be an NVMe character device (ex: /dev/nvme0).

OPTIONS

-

None

+
+
+-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. +

+
+
@@ -794,7 +818,7 @@ Rescans the nvme namespaces. diff --git a/Documentation/nvme-nvm-id-ctrl.1 b/Documentation/nvme-nvm-id-ctrl.1 index 83cc4fe1..5ec77e71 100644 --- a/Documentation/nvme-nvm-id-ctrl.1 +++ b/Documentation/nvme-nvm-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-nvm-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NVM\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NVM\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-nvm-id-ctrl \- Send NVMe Identify Controller, return NVM command set struct .SH "SYNOPSIS" .sp .nf -\fInvme nvm\-id\-ctrl\fR [\-o | \-\-output\-format=] +\fInvme nvm\-id\-ctrl\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,13 +43,19 @@ The parameter is mandatory and may be either the NVMe character device On success, the data structure returned by the device will be decoded and displayed in one of several ways\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-nvm-id-ctrl.html b/Documentation/nvme-nvm-id-ctrl.html index 8acedc2c..e79aa2e4 100644 --- a/Documentation/nvme-nvm-id-ctrl.html +++ b/Documentation/nvme-nvm-id-ctrl.html @@ -749,7 +749,7 @@ nvme-nvm-id-ctrl(1) Manual Page

SYNOPSIS

-
nvme nvm-id-ctrl <device> [-o <fmt> | --output-format=<fmt>]
+
nvme nvm-id-ctrl <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -770,15 +770,26 @@ displayed in one of several ways.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -821,7 +832,7 @@ Show the output in json format diff --git a/Documentation/nvme-nvme-mi-recv.1 b/Documentation/nvme-nvme-mi-recv.1 index ffa43c7f..4d357d07 100644 --- a/Documentation/nvme-nvme-mi-recv.1 +++ b/Documentation/nvme-nvme-mi-recv.1 @@ -2,12 +2,12 @@ .\" Title: nvme-nvme-mi-recv .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NVME\-MI\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NVME\-MI\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,13 +32,13 @@ nvme-nvme-mi-recv \- Send a NVMe\-MI Receive command to the specified device .SH "SYNOPSIS" .sp .nf -\fInvme nvme\-mi\-recv\fR [\-\-opcode= | \-o ] - [\-\-namespace\-id=] - [\-\-data\-len= | \-l ] - [\-\-nmimt= | \-m ] - [\-\-nmd0= | \-0 ] - [\-\-nmd1= | \-1 ] - [\-\-input\-file= | \-i ] +\fInvme nvme\-mi\-recv\fR [\-\-opcode= | \-O ] + [\-\-namespace\-id= | \-n ] + [\-\-data\-len= | \-l ] + [\-\-nmimt= | \-m ] + [\-\-nmd0= | \-0 ] [\-\-nmd1= | \-1 ] + [\-\-input\-file= | \-i ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,7 +49,7 @@ The parameter is mandatory and may be either the NVMe character device On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-opcode= +\-O , \-\-opcode= .RS 4 The NVMe\-MI opcode to send to the device in the command .RE @@ -83,6 +83,20 @@ The value for the NVMe management request dword 1 in the command\&. .RS 4 If the command is a data\-out (write) command, use this file to fill the buffer sent to the device\&. If no file is given, assumed to use STDIN\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 @@ -99,7 +113,7 @@ Has the program issue a nvme\-mi\-recv to execute the VPD read\&. .RS 4 .\} .nf -# nvme nvme\-mi\-recv /dev/nvme0n1 \-o 5 \-m 1 \-0 0 \-1 0x100 \-l 256 +# nvme nvme\-mi\-recv /dev/nvme0n1 \-O 5 \-m 1 \-0 0 \-1 0x100 \-l 256 .fi .if n \{\ .RE diff --git a/Documentation/nvme-nvme-mi-recv.html b/Documentation/nvme-nvme-mi-recv.html index 800d7167..4d9dad21 100644 --- a/Documentation/nvme-nvme-mi-recv.html +++ b/Documentation/nvme-nvme-mi-recv.html @@ -749,13 +749,13 @@ nvme-nvme-mi-recv(1) Manual Page

SYNOPSIS

-
nvme nvme-mi-recv <device> [--opcode=<opcode> | -o <opcode>]
-                             [--namespace-id=<nsid>]
-                             [--data-len=<data-len> | -l <data-len>]
-                             [--nmimt=<nmimt> | -m <nmimt>]
-                             [--nmd0=<nmd0> | -0 <nmd0>]
-                             [--nmd1=<nmd1> | -1 <nmd1>]
-                             [--input-file=<file> | -i <file>]
+
nvme nvme-mi-recv <device> [--opcode=<opcode> | -O <opcode>]
+                        [--namespace-id=<nsid> | -n <nsid>]
+                        [--data-len=<data-len> | -l <data-len>]
+                        [--nmimt=<nmimt> | -m <nmimt>]
+                        [--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]
+                        [--input-file=<file> | -i <file>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -774,7 +774,7 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

--o <opcode> +-O <opcode>
--opcode=<opcode> @@ -852,6 +852,29 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

assumed to use STDIN.

+
+-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. +

+
@@ -865,7 +888,7 @@ Has the program issue a nvme-mi-recv to execute the VPD read.

-
# nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256
+
# nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256
@@ -882,7 +905,7 @@ Has the program issue a nvme-mi-recv to execute the VPD read. diff --git a/Documentation/nvme-nvme-mi-send.1 b/Documentation/nvme-nvme-mi-send.1 index 9a7df991..509f88c9 100644 --- a/Documentation/nvme-nvme-mi-send.1 +++ b/Documentation/nvme-nvme-mi-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-nvme-mi-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NVME\-MI\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-NVME\-MI\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,13 +32,13 @@ nvme-nvme-mi-send \- Send a NVMe\-MI Send command to the specified device .SH "SYNOPSIS" .sp .nf -\fInvme nvme\-mi\-send\fR [\-\-opcode= | \-o ] - [\-\-namespace\-id=] - [\-\-data\-len= | \-l ] - [\-\-nmimt= | \-m ] - [\-\-nmd0= | \-0 ] - [\-\-nmd1= | \-1 ] - [\-\-input\-file= | \-i ] +\fInvme nvme\-mi\-send\fR [\-\-opcode= | \-O ] + [\-\-namespace\-id= | \-n ] + [\-\-data\-len= | \-l ] + [\-\-nmimt= | \-m ] + [\-\-nmd0= | \-0 ] [\-\-nmd1= | \-1 ] + [\-\-input\-file= | \-i ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,7 +49,7 @@ The parameter is mandatory and may be either the NVMe character device On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-opcode= +\-O , \-\-opcode= .RS 4 The NVMe\-MI opcode to send to the device in the command .RE @@ -83,6 +83,20 @@ The value for the NVMe management request dword 1 in the command\&. .RS 4 If the command is a data\-out (write) command, use this file to fill the buffer sent to the device\&. If no file is given, assumed to use STDIN\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 @@ -99,7 +113,7 @@ Has the program issue a nvme\-mi\-send to execute the VPD write\&. .RS 4 .\} .nf -# nvme nvme\-mi\-send /dev/nvme0n1 \-o 6 \-m 1 \-0 0 \-1 0x100 \-l 256 \-i vpd\&.bin +# nvme nvme\-mi\-send /dev/nvme0n1 \-O 6 \-m 1 \-0 0 \-1 0x100 \-l 256 \-i vpd\&.bin .fi .if n \{\ .RE diff --git a/Documentation/nvme-nvme-mi-send.html b/Documentation/nvme-nvme-mi-send.html index 09fb05ee..2f7d1100 100644 --- a/Documentation/nvme-nvme-mi-send.html +++ b/Documentation/nvme-nvme-mi-send.html @@ -749,13 +749,13 @@ nvme-nvme-mi-send(1) Manual Page

SYNOPSIS

-
nvme nvme-mi-send <device> [--opcode=<opcode> | -o <opcode>]
-                             [--namespace-id=<nsid>]
-                             [--data-len=<data-len> | -l <data-len>]
-                             [--nmimt=<nmimt> | -m <nmimt>]
-                             [--nmd0=<nmd0> | -0 <nmd0>]
-                             [--nmd1=<nmd1> | -1 <nmd1>]
-                             [--input-file=<file> | -i <file>]
+
nvme nvme-mi-send <device> [--opcode=<opcode> | -O <opcode>]
+                        [--namespace-id=<nsid> | -n <nsid>]
+                        [--data-len=<data-len> | -l <data-len>]
+                        [--nmimt=<nmimt> | -m <nmimt>]
+                        [--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]
+                        [--input-file=<file> | -i <file>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -774,7 +774,7 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

--o <opcode> +-O <opcode>
--opcode=<opcode> @@ -852,6 +852,29 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

assumed to use STDIN.

+
+-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. +

+
@@ -865,7 +888,7 @@ Has the program issue a nvme-mi-send to execute the VPD write.

-
# nvme nvme-mi-send /dev/nvme0n1 -o 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
+
# nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
@@ -882,7 +905,7 @@ Has the program issue a nvme-mi-send to execute the VPD write. diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.1 b/Documentation/nvme-ocp-clear-fw-activate-history.1 index 9d794bf6..d7acd69e 100644 --- a/Documentation/nvme-ocp-clear-fw-activate-history.1 +++ b/Documentation/nvme-ocp-clear-fw-activate-history.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-clear-fw-activate-history .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-CLEAR\-FW" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-CLEAR\-FW" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.html b/Documentation/nvme-ocp-clear-fw-activate-history.html index 8894de29..bd12738a 100644 --- a/Documentation/nvme-ocp-clear-fw-activate-history.html +++ b/Documentation/nvme-ocp-clear-fw-activate-history.html @@ -817,7 +817,7 @@ Clears OCP Firmware Activation History Log for the device: diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 index 090fec2c..10d22df5 100644 --- a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 +++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-clear-pcie-correctable-error-counters .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-CLEAR\-PC" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-CLEAR\-PC" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.html b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.html index 60a98dc2..e3d7fac6 100644 --- a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.html +++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.html @@ -817,7 +817,7 @@ Clears PCIe correctable error counters Log for the device: diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.1 b/Documentation/nvme-ocp-eol-plp-failure-mode.1 index 87effa5d..0e746c29 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.1 +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-eol-plp-failure-mode .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-EOL\-PLP\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-EOL\-PLP\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,9 @@ nvme-ocp-eol-plp-failure-mode \- Define and print EOL or PLP circuitry failure m .SH "SYNOPSIS" .sp .nf -\fInvme ocp eol\-plp\-failure\-mode\fR [\-\-mode= | \-m ] [\-\-no\-uuid | \-n] [\-\-save | \-s] - [\-\-sel=] +\fInvme ocp eol\-plp\-failure\-mode\fR [\-\-mode= | \-m ] + [\-\-no\-uuid | \-n] [\-\-save | \-s] + [\-\-sel=] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.html b/Documentation/nvme-ocp-eol-plp-failure-mode.html index ebc44363..b7b4a283 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.html +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.html @@ -749,8 +749,9 @@ nvme-ocp-eol-plp-failure-mode(1) Manual Page

SYNOPSIS

-
nvme ocp eol-plp-failure-mode <device> [--mode=<mode> | -m <mode>] [--no-uuid | -n] [--save | -s]
-                                         [--sel=<select> | -s <select>]
+
nvme ocp eol-plp-failure-mode <device> [--mode=<mode> | -m <mode>]
+                        [--no-uuid | -n] [--save | -s]
+                        [--sel=<select> | -s <select>]
@@ -804,7 +805,8 @@ Results for any other device are undefined.

- Save the attribute so that it persists through all power states and resets. + Save the attribute so that it persists through all power states and + resets.

@@ -884,7 +886,7 @@ Has the program issue a eol-plp-failure-mode to retrieve the 0xC2 get features. diff --git a/Documentation/nvme-ocp-latency-monitor-log.1 b/Documentation/nvme-ocp-latency-monitor-log.1 index 3fc507d0..0b8a4465 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.1 +++ b/Documentation/nvme-ocp-latency-monitor-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-latency-monitor-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-LATENCY\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-LATENCY\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on OCP compliant devices supporting this log page\&. Results On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR diff --git a/Documentation/nvme-ocp-latency-monitor-log.html b/Documentation/nvme-ocp-latency-monitor-log.html index 420a35f1..d7847b90 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.html +++ b/Documentation/nvme-ocp-latency-monitor-log.html @@ -770,10 +770,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -811,7 +811,7 @@ Displays the get latency monitor log for the device:

diff --git a/Documentation/nvme-ocp-smart-add-log.1 b/Documentation/nvme-ocp-smart-add-log.1 index 1cbdfb78..51dcff07 100644 --- a/Documentation/nvme-ocp-smart-add-log.1 +++ b/Documentation/nvme-ocp-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-SMART\-AD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-SMART\-AD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on OCP compliant devices supporting this feature\&. Results On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR diff --git a/Documentation/nvme-ocp-smart-add-log.html b/Documentation/nvme-ocp-smart-add-log.html index b41fd2c5..249733e2 100644 --- a/Documentation/nvme-ocp-smart-add-log.html +++ b/Documentation/nvme-ocp-smart-add-log.html @@ -771,10 +771,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -812,7 +812,7 @@ Has the program issue a smart-add-log command to retrieve the 0xC0 log page.

diff --git a/Documentation/nvme-persistent-event-log.1 b/Documentation/nvme-persistent-event-log.1 index bb5cbda5..86278e8f 100644 --- a/Documentation/nvme-persistent-event-log.1 +++ b/Documentation/nvme-persistent-event-log.1 @@ -2,12 +2,12 @@ .\" Title: persistent-event-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "PERSISTENT\-EVENT\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "PERSISTENT\-EVENT\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,9 +33,8 @@ nvme-persistent-event-log \- Send NVMe persistent event log page request, return .sp .nf \fInvme persistent\-event\-log\fR [\-\-action= | \-a ] - [\-\-log\-len= | \-l ] - [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-log\-len= | \-l ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -61,13 +60,19 @@ Allocates a buffer of bytes size and requests this many bytes be retu Print the raw persistent event log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-persistent-event-log.html b/Documentation/nvme-persistent-event-log.html index d64081dc..004356ea 100644 --- a/Documentation/nvme-persistent-event-log.html +++ b/Documentation/nvme-persistent-event-log.html @@ -750,9 +750,8 @@ persistent-event-log(1) Manual Page 
nvme persistent-event-log <device> [--action=<action> | -a <action>]
-            [--log-len=<log-len> | -l <log-len>]
-            [--raw-binary | -b]
-            [--output-format=<fmt> | -o <fmt>]
+ [--log-len=<log-len> | -l <log-len>] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -782,12 +781,12 @@ may be printed to stdout for another program to parse.

- While try to retrieve this log action the controller shall take - during processing this persistent log page command. This mandatory - field, based on the value issued it may Read Log Data, Establish - Context and Read Log Data or Release Context can occur. For More - details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent - Event Log (Log Identifier 0Dh) + While try to retrieve this log action the controller shall take + during processing this persistent log page command. This mandatory + field, based on the value issued it may Read Log Data, Establish + Context and Read Log Data or Release Context can occur. For More + details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent + Event Log (Log Identifier 0Dh)

@@ -798,10 +797,10 @@ may be printed to stdout for another program to parse.

- Allocates a buffer of <log-len> bytes size and requests this - many bytes be returned in the constructed NVMe command. This - param is mandatory. If <log-len> given is 0 and action is 0, - it will read the Total Log Length(TLL) of the page. + Allocates a buffer of <log-len> bytes size and requests this + many bytes be returned in the constructed NVMe command. This + param is mandatory. If <log-len> given is 0 and action is 0, + it will read the Total Log Length(TLL) of the page.

@@ -812,19 +811,30 @@ may be printed to stdout for another program to parse.

- Print the raw persistent event log buffer to stdout. + Print the raw persistent event log buffer to stdout.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + 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.

@@ -867,7 +877,7 @@ Print the raw persistent event log to a file: diff --git a/Documentation/nvme-pred-lat-event-agg-log.1 b/Documentation/nvme-pred-lat-event-agg-log.1 index 86369044..41296296 100644 --- a/Documentation/nvme-pred-lat-event-agg-log.1 +++ b/Documentation/nvme-pred-lat-event-agg-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-pred-lat-event-agg-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-PRED\-LAT\-EVE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-PRED\-LAT\-EVE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,10 @@ nvme-pred-lat-event-agg-log \- Send Predictable Latency Event Aggregate Log Page .SH "SYNOPSIS" .sp .nf -\fInvme pred\-lat\-event\-agg\-log\fR [\-\-log\-entries= | \-e ] +\fInvme pred\-lat\-event\-agg\-log\fR + [\-\-log\-entries= | \-e ] [\-\-rae | \-r] [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -60,7 +61,7 @@ Retain an Asynchronous Event\&. Print the raw Predictable Latency Event Aggregate log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-pred-lat-event-agg-log.html b/Documentation/nvme-pred-lat-event-agg-log.html index c2ea7fe2..7de2ebe3 100644 --- a/Documentation/nvme-pred-lat-event-agg-log.html +++ b/Documentation/nvme-pred-lat-event-agg-log.html @@ -749,9 +749,10 @@ nvme-pred-lat-event-agg-log(1) Manual Page

SYNOPSIS

-
nvme pred-lat-event-agg-log <device> [--log-entries=<log_entries> | -e <log_entries>]
+
nvme pred-lat-event-agg-log <device>
+                        [--log-entries=<log_entries> | -e <log_entries>]
                         [--rae | -r] [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]

+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -782,11 +783,11 @@ another program to parse.

- Retrieve the Predictable Latency Event Aggregate Log pending entries. - This argument is mandatory and its success may depend on the device’s - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.11. The maximum number of log entries supported is 2044 - for the device. + Retrieve the Predictable Latency Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.11. The maximum number of log entries supported is 2044 + for the device.

@@ -812,15 +813,15 @@ another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + Set the reporting format to normal, json, or binary. + Only one output format can be used at a time.

@@ -863,7 +864,7 @@ Print the raw Predictable Latency Event Aggregate log to a file: diff --git a/Documentation/nvme-predictable-lat-log.1 b/Documentation/nvme-predictable-lat-log.1 index e96b0e62..9beb918e 100644 --- a/Documentation/nvme-predictable-lat-log.1 +++ b/Documentation/nvme-predictable-lat-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-predictable-lat-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-PREDICTABLE\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-PREDICTABLE\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,7 +34,7 @@ nvme-predictable-lat-log \- Send Predictable latency per NVM set log page reques .nf \fInvme predictable\-lat\-log\fR [\-\-nvmset\-id= | \-i ] [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,13 +55,19 @@ Retrieve the Predictable latency per NVM set log for the given nvmset id\&. This Print the raw Predictable latency per NVM set log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-predictable-lat-log.html b/Documentation/nvme-predictable-lat-log.html index b74dbbfc..a59eb915 100644 --- a/Documentation/nvme-predictable-lat-log.html +++ b/Documentation/nvme-predictable-lat-log.html @@ -751,7 +751,7 @@ nvme-predictable-lat-log(1) Manual Page 
nvme predictable-lat-log <device> [--nvmset-id=<nvmset_id> | -i <nvmset_id>]
                         [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -781,10 +781,10 @@ the raw buffer may be printed to stdout for another program to parse.

- Retrieve the Predictable latency per NVM set log for the given nvmset id. - This argument is mandatory and its success may depend on the device’s - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.10. The default nvmset id to use is 1 for the device. + Retrieve the Predictable latency per NVM set log for the given nvmset id. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.10. The default nvmset id to use is 1 for the device.

@@ -799,15 +799,26 @@ the raw buffer may be printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -850,7 +861,7 @@ Print the raw Predictable latency per NVM set log to a file: diff --git a/Documentation/nvme-primary-ctrl-caps.1 b/Documentation/nvme-primary-ctrl-caps.1 index 74c98843..12abb702 100644 --- a/Documentation/nvme-primary-ctrl-caps.1 +++ b/Documentation/nvme-primary-ctrl-caps.1 @@ -2,12 +2,12 @@ .\" Title: nvme-primary-ctrl-caps .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-PRIMARY\-CTRL\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-PRIMARY\-CTRL\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-primary-ctrl-caps \- Send identify Primary Controller Caps, return result a .SH "SYNOPSIS" .sp .nf -\fInvme primary\-ctrl\-caps\fR [\-o | \-\-output\-format=] +\fInvme primary\-ctrl\-caps\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,17 +43,23 @@ The parameter is mandatory and may be either the NVMe character device On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o , \-\-output\-format= .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 -\-H, \-\-human\-readable +\-v, \-\-verbose .RS 4 -This option will parse and format many of the bit fields into human\-readable formats\&. +Increase the information detail in the output\&. .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-primary-ctrl-caps.html b/Documentation/nvme-primary-ctrl-caps.html index 8af03448..2e967347 100644 --- a/Documentation/nvme-primary-ctrl-caps.html +++ b/Documentation/nvme-primary-ctrl-caps.html @@ -749,7 +749,7 @@ nvme-primary-ctrl-caps(1) Manual Page

SYNOPSIS

-
nvme primary-ctrl-caps <device> [-o <format> | --output-format=<format>]
+
nvme primary-ctrl-caps <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -771,27 +771,38 @@ raw buffer may be printed to stdout.

--o <format> +-H
---output-format=<format> +--human-readable

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + This option will parse and format many of the bit fields + into human-readable formats.

--H +-o <fmt>
---human-readable +--output-format=<fmt>

- This option will parse and format many of the bit fields - into human-readable formats. + 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.

@@ -835,7 +846,7 @@ fields in a human readable format: diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index 4d9d9f72..3bd3a710 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -2,12 +2,12 @@ .\" Title: nvme-read .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,54 +42,50 @@ nvme-read \- Send an NVMe Read command, provide results [\-\-prinfo= | \-p ] [\-\-app\-tag\-mask= | \-m ] [\-\-app\-tag= | \-a ] - [\-\-limited\-retry | \-l] - [\-\-force\-unit\-access | \-f] + [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-dir\-type= | \-T ] - [\-\-dir\-spec= | \-S ] - [\-\-dsm= | \-D ] - [\-\-show\-command | \-v] - [\-\-dry\-run | \-w] - [\-\-latency | \-t] + [\-\-dir\-spec= | \-S ] [\-\-dsm= | \-D ] + [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t] [\-\-storage\-tag | \-g ] - [\-\-storage\-tag\-check | \-C ] - [\-\-force] + [\-\-storage\-tag\-check | \-C] [\-\-force] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Read command reads the logical blocks specified by the command from the medium and copies to the data data buffer provided\&. Will use stdout by default if you don\(cqt provide a file\&. .SH "OPTIONS" .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block\&. .RE .PP -\-\-block\-count, \-c +\-c, \-\-block\-count .RS 4 The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&. .RE .PP -\-\-data\-size=, \-z +\-z , \-\-data\-size= .RS 4 Size of data, in bytes\&. .RE .PP -\-\-metadata\-size=, \-y +\-y , \-\-metadata\-size= .RS 4 Size of metadata in bytes\&. .RE .PP -\-\-data=, \-d +\-d , \-\-data= .RS 4 Data file\&. If none provided, contents are sent to STDOUT\&. .RE .PP -\-\-metadata=, \-M +\-M , \-\-metadata= .RS 4 Metadata file, if necessary\&. .RE .PP -\-\-prinfo=, \-p +\-p , \-\-prinfo= .RS 4 Protection Information field definition\&. .TS @@ -134,17 +130,17 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=, \-m +\-m , \-\-app\-tag\-mask= .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE @@ -164,7 +160,7 @@ Optional field for directive specifics\&. When used with write streams, this val The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&. .RE .PP -\-v, \-\-show\-cmd +\-V, \-\-show\-cmd .RS 4 Print out the command to be sent\&. .RE @@ -196,6 +192,20 @@ This flag enables Storage Tag field checking as part of end\-to\-end data protec .RS 4 Ignore namespace is currently busy and performed the operation even though\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-read.html b/Documentation/nvme-read.html index 2904f3df..3d2392fc 100644 --- a/Documentation/nvme-read.html +++ b/Documentation/nvme-read.html @@ -759,17 +759,13 @@ nvme-read(1) Manual Page [--prinfo=<prinfo> | -p <prinfo>] [--app-tag-mask=<appmask> | -m <appmask>] [--app-tag=<apptag> | -a <apptag>] - [--limited-retry | -l] - [--force-unit-access | -f] + [--limited-retry | -l] [--force-unit-access | -f] [--dir-type=<type> | -T <type>] - [--dir-spec=<spec> | -S <spec>] - [--dsm=<dsm> | -D <dsm>] - [--show-command | -v] - [--dry-run | -w] - [--latency | -t] + [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag<storage-tag> | -g <storage-tag>] - [--storage-tag-check | -C ] - [--force] + [--storage-tag-check | -C] [--force] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -787,10 +783,10 @@ by default if you don’t provide a file.

---start-block=<slba> +-s <slba>
--s <slba> +--start-block=<slba>

@@ -798,10 +794,10 @@ by default if you don’t provide a file.

---block-count +-c
--c +--block-count

@@ -811,10 +807,10 @@ by default if you don’t provide a file.

---data-size=<size> +-z <size>
--z <size> +--data-size=<size>

@@ -822,10 +818,10 @@ by default if you don’t provide a file.

---metadata-size=<size> +-y <size>
--y <size> +--metadata-size=<size>

@@ -833,10 +829,10 @@ by default if you don’t provide a file.

---data=<data-file> +-d <data-file>
--d <data-file> +--data=<data-file>

@@ -844,10 +840,10 @@ by default if you don’t provide a file.

---metadata=<metadata-file> +-M <metadata-file>
--M <metadata-file> +--metadata=<metadata-file>

@@ -855,10 +851,10 @@ by default if you don’t provide a file.

---prinfo=<prinfo> +-p <prinfo>
--p <prinfo> +--prinfo=<prinfo>

@@ -903,10 +899,10 @@ metadata is passes.

---ref-tag=<reftag> +-r <reftag>
--r <reftag> +--ref-tag=<reftag>

@@ -914,10 +910,10 @@ metadata is passes.

---app-tag-mask=<appmask> +-m <appmask>
--m <appmask> +--app-tag-mask=<appmask>

@@ -925,10 +921,10 @@ metadata is passes.

---force-unit-access +-f
--f +--force-unit-access

@@ -982,7 +978,7 @@ metadata is passes.

--v +-V
--show-cmd @@ -1048,6 +1044,29 @@ metadata is passes.

even though.

+
+-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. +

+
@@ -1068,7 +1087,7 @@ metadata is passes.

diff --git a/Documentation/nvme-reset.1 b/Documentation/nvme-reset.1 index 0ef0b7ee..ecc35d42 100644 --- a/Documentation/nvme-reset.1 +++ b/Documentation/nvme-reset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-reset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESET" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESET" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,26 @@ nvme-reset \- Reset the nvme controller\&. .SH "SYNOPSIS" .sp .nf -\fInvme reset\fR +\fInvme reset\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe controller reset\&. The param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-reset.html b/Documentation/nvme-reset.html index 74f963af..7ade36d6 100644 --- a/Documentation/nvme-reset.html +++ b/Documentation/nvme-reset.html @@ -749,7 +749,7 @@ nvme-reset(1) Manual Page

SYNOPSIS

-
nvme reset <device>
+
nvme reset <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -764,7 +764,31 @@ be an NVMe character device (ex: /dev/nvme0).

OPTIONS

-

None

+
+
+-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. +

+
+
@@ -794,7 +818,7 @@ Resets the controller. diff --git a/Documentation/nvme-resv-acquire.1 b/Documentation/nvme-resv-acquire.1 index 14dfff4f..23cf4b93 100644 --- a/Documentation/nvme-resv-acquire.1 +++ b/Documentation/nvme-resv-acquire.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-acquire .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-ACQUIRE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-ACQUIRE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,11 @@ nvme-resv-acquire \- Acquire an nvme reservation .sp .nf \fInvme resv\-acquire\fR [\-\-namespace\-id= | \-n ] - [\-\-crkey= | \-c ] - [\-\-prkey= | \-p ] - [\-\-rtype= | \-t ] - [\-\-racqa= | \-a ] - [\-\-iekey | \-i] + [\-\-crkey= | \-c ] + [\-\-prkey= | \-p ] + [\-\-rtype= | \-t ] + [\-\-racqa= | \-a ] [\-\-iekey | \-i] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -169,6 +169,20 @@ Ignore Existing Key: If this bit is set to a Indicator option, defaults to \fI0\fR\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet diff --git a/Documentation/nvme-resv-acquire.html b/Documentation/nvme-resv-acquire.html index 12a3526b..13c9b7bd 100644 --- a/Documentation/nvme-resv-acquire.html +++ b/Documentation/nvme-resv-acquire.html @@ -750,11 +750,11 @@ nvme-resv-acquire(1) Manual Page 
nvme resv-acquire <device> [--namespace-id=<nsid> | -n <nsid>]
-                             [--crkey=<crkey> | -c <crkey>]
-                             [--prkey=<prkey> | -p <prkey>]
-                             [--rtype=<rtype> | -t <rtype>]
-                             [--racqa=<racqa> | -a <racqa>]
-                             [--iekey | -i]
+ [--crkey=<crkey> | -c <crkey>] + [--prkey=<prkey> | -p <prkey>] + [--rtype=<rtype> | -t <rtype>] + [--racqa=<racqa> | -a <racqa>] [--iekey | -i] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -924,10 +924,33 @@ cellspacing="0" cellpadding="4">

Ignore Existing Key: If this bit is set to a 1, then the Current Reservation Key (CRKEY) check is disabled and the command - shall succeed regardless of the CRKEY field value. + shall succeed regardless of the CRKEY field value.

Indicator option, defaults to 0.

+
+-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. +

+
@@ -948,7 +971,7 @@ cellspacing="0" cellpadding="4"> diff --git a/Documentation/nvme-resv-notif-log.1 b/Documentation/nvme-resv-notif-log.1 index 3daff9ed..ada77ba3 100644 --- a/Documentation/nvme-resv-notif-log.1 +++ b/Documentation/nvme-resv-notif-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-notif-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-NOTIF\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-NOTIF\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-resv-notif-log \- Send NVMe Reservation Notification log page request, retu .SH "SYNOPSIS" .sp .nf -\fInvme resv\-notif\-log\fR [\-\-output\-format= | \-o ] +\fInvme resv\-notif\-log\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,13 +43,19 @@ The parameter is mandatory and may be either the NVMe character device On success, the returned Reservation Notification log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer may be printed to stdout for another program to parse\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-resv-notif-log.html b/Documentation/nvme-resv-notif-log.html index ef5cfeac..2e41634f 100644 --- a/Documentation/nvme-resv-notif-log.html +++ b/Documentation/nvme-resv-notif-log.html @@ -740,7 +740,7 @@ nvme-resv-notif-log(1) Manual Page

NAME

nvme-resv-notif-log - - Send NVMe Reservation Notification log page request, return result and log + Send NVMe Reservation Notification log page request, return result and log

@@ -749,7 +749,7 @@ nvme-resv-notif-log(1) Manual Page

SYNOPSIS

-
nvme resv-notif-log <device> [--output-format=<fmt> | -o <fmt>]
+
nvme resv-notif-log <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -772,15 +772,26 @@ may be printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -822,7 +833,7 @@ Print the output in json format: diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 05029fa4..4b56b7c7 100644 --- a/Documentation/nvme-resv-register.1 +++ b/Documentation/nvme-resv-register.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-register .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REGISTER" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REGISTER" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,11 @@ nvme-resv-register \- Register an nvme reservation .sp .nf \fInvme resv\-register\fR [\-\-namespace\-id= | \-n ] - [\-\-crkey= | \-c ] - [\-\-nrkey= | \-k ] - [\-\-rrega= | \-r ] - [\-\-cptpl= | \-p ] - [\-\-iekey | \-i] + [\-\-crkey= | \-c ] + [\-\-nrkey= | \-k ] + [\-\-rrega= | \-r ] + [\-\-cptpl= | \-p ] [\-\-iekey | \-i] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -145,6 +145,20 @@ Ignore Existing Key: If this bit is set to a Indicator option, defaults to \fI0\fR\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet diff --git a/Documentation/nvme-resv-register.html b/Documentation/nvme-resv-register.html index 072acf2a..ef76f962 100644 --- a/Documentation/nvme-resv-register.html +++ b/Documentation/nvme-resv-register.html @@ -750,11 +750,11 @@ nvme-resv-register(1) Manual Page 
nvme resv-register <device> [--namespace-id=<nsid> | -n <nsid>]
-                              [--crkey=<crkey> | -c <crkey>]
-                              [--nrkey=<nrkey> | -k <nrkey>]
-                              [--rrega=<rrega> | -r <rrega>]
-                              [--cptpl=<cptpl> | -p <cptpl>]
-                              [--iekey | -i]
+ [--crkey=<crkey> | -c <crkey>] + [--nrkey=<nrkey> | -k <nrkey>] + [--rrega=<rrega> | -r <rrega>] + [--cptpl=<cptpl> | -p <cptpl>] [--iekey | -i] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -917,6 +917,29 @@ cellspacing="0" cellpadding="4">

Indicator option, defaults to 0.

+
+-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. +

+
@@ -937,7 +960,7 @@ cellspacing="0" cellpadding="4"> diff --git a/Documentation/nvme-resv-release.1 b/Documentation/nvme-resv-release.1 index 8f1e1585..39887a87 100644 --- a/Documentation/nvme-resv-release.1 +++ b/Documentation/nvme-resv-release.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-release .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-RELEASE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-RELEASE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,10 @@ nvme-resv-release \- Release an nvme reservation .sp .nf \fInvme resv\-release\fR [\-\-namespace\-id= | \-n ] - [\-\-crkey= | \-c ] - [\-\-rtype= | \-t ] - [\-\-rrela= | \-a ] - [\-\-iekey | \-i] + [\-\-crkey= | \-c ] + [\-\-rtype= | \-t ] + [\-\-rrela= | \-a ] [\-\-iekey | \-i] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -157,6 +157,20 @@ Ignore Existing Key: If this bit is set to a Indicator option, defaults to \fI0\fR\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet diff --git a/Documentation/nvme-resv-release.html b/Documentation/nvme-resv-release.html index 1504945b..c8a9d15d 100644 --- a/Documentation/nvme-resv-release.html +++ b/Documentation/nvme-resv-release.html @@ -750,10 +750,10 @@ nvme-resv-release(1) Manual Page 
nvme resv-release <device> [--namespace-id=<nsid> | -n <nsid>]
-                             [--crkey=<crkey> | -c <crkey>]
-                             [--rtype=<rtype> | -t <rtype>]
-                             [--rrela=<rrela> | -a <rrela>]
-                             [--iekey | -i]
+ [--crkey=<crkey> | -c <crkey>] + [--rtype=<rtype> | -t <rtype>] + [--rrela=<rrela> | -a <rrela>] [--iekey | -i] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -910,6 +910,29 @@ cellspacing="0" cellpadding="4">

Indicator option, defaults to 0.

+
+-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. +

+
@@ -930,7 +953,7 @@ cellspacing="0" cellpadding="4"> diff --git a/Documentation/nvme-resv-report.1 b/Documentation/nvme-resv-report.1 index aee6c8ae..01a33da7 100644 --- a/Documentation/nvme-resv-report.1 +++ b/Documentation/nvme-resv-report.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-report .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REPORT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REPORT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,9 @@ nvme-resv-report \- Send NVMe Reservation Report, parse the result .sp .nf \fInvme resv\-report\fR [\-\-namespace\-id= | \-n ] - [\-\-numd= | \-d ] - [\-\-eds | \-e] + [\-\-numd= | \-d ] [\-\-eds | \-e] [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -66,13 +65,19 @@ Request extended Data Structure: If this bit is set to a Print the raw buffer to stdout\&. Structure is not parsed by program\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 No examples yet\&. diff --git a/Documentation/nvme-resv-report.html b/Documentation/nvme-resv-report.html index 0f085f9b..280a0d10 100644 --- a/Documentation/nvme-resv-report.html +++ b/Documentation/nvme-resv-report.html @@ -750,10 +750,9 @@ nvme-resv-report(1) Manual Page 
nvme resv-report <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--numd=<num-dwords> | -d <num-dwords>]
-                        [--eds | -e]
+                        [--numd=<num-dwords> | -d <num-dwords>] [--eds | -e]
                         [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -824,15 +823,26 @@ Controller data structure for each such controller).

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -855,7 +865,7 @@ Controller data structure for each such controller).

diff --git a/Documentation/nvme-rpmb.1 b/Documentation/nvme-rpmb.1 index 52aed1c0..eab95b6e 100644 --- a/Documentation/nvme-rpmb.1 +++ b/Documentation/nvme-rpmb.1 @@ -2,12 +2,12 @@ .\" Title: nvme-rpmb .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RPMB" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RPMB" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,13 +33,13 @@ nvme-rpmb \- Send RPMB commands to an NVMe device .sp .nf \fInvme rpmb\fR [\-\-cmd= | \-c ] - [\-\-msgfile= | \-f ] - [\-\-keyfile= | \-g ] - [\-\-key= | \-k ] - [\-\-msg= | \-d ] - [\-\-address= | \-o ] - [\-\-blocks=<512 byte sectors> | \-b ] - [\-\-target= | \-t ] + [\-\-msgfile= | \-f ] + [\-\-keyfile= | \-g ] + [\-\-key= | \-k ] [\-\-msg= | \-d ] + [\-\-address= | \-o ] + [\-\-blocks=<512 byte sectors> | \-b ] + [\-\-target= | \-t ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -181,6 +181,20 @@ The address (in 512 byte sector offset from 0) to be used for data transfer comm .RS 4 The size in 512 byte sectors to be used for data transfer commands (read or write) for a specified RPMB target\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-rpmb.html b/Documentation/nvme-rpmb.html index 97d80a1e..47440b1b 100644 --- a/Documentation/nvme-rpmb.html +++ b/Documentation/nvme-rpmb.html @@ -750,13 +750,13 @@ nvme-rpmb(1) Manual Page 
nvme rpmb <device> [--cmd=<command> | -c <command>]
-                    [--msgfile=<data-file> | -f <data-file>]
-                    [--keyfile=<key-file> | -g <key-file>]
-                    [--key=<key> | -k <key>]
-                    [--msg=<data> | -d <data>]
-                    [--address=<offset> | -o <offset>]
-                    [--blocks=<512 byte sectors> | -b <sectors> ]
-                    [--target=<target-id> | -t <id> ]
+ [--msgfile=<data-file> | -f <data-file>] + [--keyfile=<key-file> | -g <key-file>] + [--key=<key> | -k <key>] [--msg=<data> | -d <data>] + [--address=<offset> | -o <offset>] + [--blocks=<512 byte sectors> | -b <sectors>] + [--target=<target-id> | -t <id>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -921,6 +921,29 @@ default address if no -address or -o option is specified, (read or write) for a specified RPMB target.

+
+-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. +

+
@@ -1001,7 +1024,7 @@ data onto output.bin diff --git a/Documentation/nvme-sanitize-log.1 b/Documentation/nvme-sanitize-log.1 index 143a1aa5..92a360a3 100644 --- a/Documentation/nvme-sanitize-log.1 +++ b/Documentation/nvme-sanitize-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-sanitize-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SANITIZE\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SANITIZE\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,9 @@ nvme-sanitize-log \- Send NVMe sanitize\-log Command, return result .SH "SYNOPSIS" .sp .nf -\fInvme sanitize\-log\fR [\-\-rae | \-r] [\-\-output\-format= | \-o ] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] +\fInvme sanitize\-log\fR [\-\-rae | \-r] [\-\-human\-readable | \-H] + [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -105,14 +105,6 @@ On success it returns 0, error code otherwise\&. Retain an Asynchronous Event\&. .RE .PP -\-o , \-\-output\-format= -.RS 4 -Set the reporting format to -\fInormal\fR, -\fIjson\fR, or -\fIbinary\fR\&. Only one output format can be used at a time\&. -.RE -.PP \-H, \-\-human\-readable .RS 4 This option will parse and format many of the bit fields into human\-readable formats\&. @@ -122,6 +114,20 @@ This option will parse and format many of the bit fields into human\-readable fo .RS 4 Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-sanitize-log.html b/Documentation/nvme-sanitize-log.html index 4ed2e901..322cbd8c 100644 --- a/Documentation/nvme-sanitize-log.html +++ b/Documentation/nvme-sanitize-log.html @@ -749,9 +749,9 @@ nvme-sanitize-log(1) Manual Page

SYNOPSIS

-
nvme sanitize-log <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
-                             [--human-readable | -H]
-                             [--raw-binary | -b]
+
nvme sanitize-log <device> [--rae | -r] [--human-readable | -H]
+                        [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -798,11 +798,11 @@ cellspacing="0" cellpadding="4"> + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation of the NVM subsystem.

Global Data Erased bit If set to 1 then non-volatile storage in the NVM subsystem has not been written to: - a) since being manufactured and the NVM subsystem has never been sanitized; or - b) since the most recent successful sanitize operation. + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation. If cleared to 0, then non-volatile storage in the NVM subsystem has been written to: - a) since being manufactured and the NVM subsystem has never been sanitized; or - b) since the most recent successful sanitize operation of the NVM subsystem.
@@ -827,18 +827,6 @@ If cleared to 0, then non-volatile storage in the NVM subsystem has been written

--o <format> -
-
---output-format=<format> -
-
-

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. -

-
-
-H
@@ -862,6 +850,29 @@ If cleared to 0, then non-volatile storage in the NVM subsystem has been written program. This overrides the vendor specific and human readable options.

+
+-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. +

+
@@ -892,7 +903,7 @@ Has the program issue Sanitize-log Command : diff --git a/Documentation/nvme-sanitize.1 b/Documentation/nvme-sanitize.1 index 7a71f4f8..b25886ca 100644 --- a/Documentation/nvme-sanitize.1 +++ b/Documentation/nvme-sanitize.1 @@ -2,12 +2,12 @@ .\" Title: nvme-sanitize .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SANITIZE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SANITIZE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,13 +32,12 @@ nvme-sanitize \- Send NVMe Sanitize Command, return result .SH "SYNOPSIS" .sp .nf -\fInvme sanitize\fR [\-\-no\-dealloc | \-d] - [\-\-oipbp | \-i] - [\-\-owpass= | \-n ] - [\-\-ause | \-u] - [\-\-sanact= | \-a ] - [\-\-ovrpat= | \-p ] - [\-\-force] +\fInvme sanitize\fR [\-\-no\-dealloc | \-d] [\-\-oipbp | \-i] + [\-\-owpass= | \-n ] + [\-\-ause | \-u] [\-\-sanact= | \-a ] + [\-\-ovrpat= | \-p ] + [\-\-force] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -127,6 +126,20 @@ Overwrite Pattern: This field is ignored unless the Sanitize Action field in Com .RS 4 Ignore namespace is currently busy and performed the operation even though\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-sanitize.html b/Documentation/nvme-sanitize.html index 32b0e046..aa1c8773 100644 --- a/Documentation/nvme-sanitize.html +++ b/Documentation/nvme-sanitize.html @@ -749,13 +749,12 @@ nvme-sanitize(1) Manual Page

SYNOPSIS

-
nvme sanitize <device> [--no-dealloc | -d]
-              [--oipbp | -i]
-              [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
-              [--ause | -u]
-              [--sanact=<action> | -a <action>]
-              [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
-              [--force]
+
nvme sanitize <device> [--no-dealloc | -d] [--oipbp | -i]
+                        [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
+                        [--ause | -u] [--sanact=<action> | -a <action>]
+                        [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
+                        [--force]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -781,13 +780,13 @@ provides the result.

- No Deallocate After Sanitize: - If set, then the controller shall not deallocate any logical - blocks as a result of successfully completing the sanitize - operation. If cleared, then the controller should deallocate - logical blocks as a result of successfully completing the - sanitize operation. This bit shall be ignored if the Sanitize - Action field is set to 001b (i.e., Exit Failure Mode). + No Deallocate After Sanitize: + If set, then the controller shall not deallocate any logical + blocks as a result of successfully completing the sanitize + operation. If cleared, then the controller should deallocate + logical blocks as a result of successfully completing the + sanitize operation. This bit shall be ignored if the Sanitize + Action field is set to 001b (i.e., Exit Failure Mode).

@@ -798,11 +797,11 @@ provides the result.

- Overwrite Invert Pattern Between Passes: - If set, then the Overwrite Pattern shall be inverted between - passes. If cleared, then the overwrite pattern shall not be - inverted between passes. This bit shall be ignored unless the - Sanitize Action field is set to 011b (i.e., Overwrite). + Overwrite Invert Pattern Between Passes: + If set, then the Overwrite Pattern shall be inverted between + passes. If cleared, then the overwrite pattern shall not be + inverted between passes. This bit shall be ignored unless the + Sanitize Action field is set to 011b (i.e., Overwrite).

@@ -813,12 +812,12 @@ provides the result.

- Overwrite Pass Count: - This field specifies the number of overwrite passes (i.e., - how many times the media is to be overwritten) using the data - from the Overwrite Pattern field of this command. A value of 0 - specifies 16 overwrite passes. This field shall be ignored - unless the Sanitize Action field is set to 011b (i.e., Overwrite). + Overwrite Pass Count: + This field specifies the number of overwrite passes (i.e., + how many times the media is to be overwritten) using the data + from the Overwrite Pattern field of this command. A value of 0 + specifies 16 overwrite passes. This field shall be ignored + unless the Sanitize Action field is set to 011b (i.e., Overwrite).

@@ -829,11 +828,11 @@ provides the result.

- Allow Unrestricted Sanitize Exit: - If set, then the sanitize operation is performed in unrestricted - completion mode. If cleared then the sanitize operation is - performed in restricted completion mode. This bit shall be ignored - if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode). + Allow Unrestricted Sanitize Exit: + If set, then the sanitize operation is performed in unrestricted + completion mode. If cleared then the sanitize operation is + performed in restricted completion mode. This bit shall be ignored + if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode).

@@ -844,7 +843,7 @@ provides the result.

- Sanitize Action: + Sanitize Action:

- Overwrite Pattern: - This field is ignored unless the Sanitize Action field in - Command Dword 10 is set to 011b (i.e., Overwrite). This field - specifies a 32-bit pattern that is used for the Overwrite - sanitize operation. + Overwrite Pattern: + This field is ignored unless the Sanitize Action field in + Command Dword 10 is set to 011b (i.e., Overwrite). This field + specifies a 32-bit pattern that is used for the Overwrite + sanitize operation.

@@ -902,8 +901,31 @@ cellspacing="0" cellpadding="4">

- Ignore namespace is currently busy and performed the operation - even though. + Ignore namespace is currently busy and performed the operation + even though. +

+
+
+-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.

@@ -938,7 +960,7 @@ Has the program issue Sanitize Command : diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.1 b/Documentation/nvme-seagate-clear-fw-activate-history.1 index cb605ba6..1417b625 100644 --- a/Documentation/nvme-seagate-clear-fw-activate-history.1 +++ b/Documentation/nvme-seagate-clear-fw-activate-history.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-clear-fw-activate-history .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.html b/Documentation/nvme-seagate-clear-fw-activate-history.html index 6dc0d103..f03c6d96 100644 --- a/Documentation/nvme-seagate-clear-fw-activate-history.html +++ b/Documentation/nvme-seagate-clear-fw-activate-history.html @@ -757,7 +757,7 @@ nvme-seagate-clear-fw-activate-history (1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The <device> may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -792,7 +792,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 b/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 index d8c9a906..7757d8d5 100644 --- a/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 +++ b/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-clear-pcie-correctable-errors .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-seagate-clear-pcie-correctable-errors \- Clear Seagate PCIe error statistic .SH "SYNOPSIS" .sp .nf -\fInvme seagate clear\-pcie\-correctable\-errors [] [OPTIONS]\fR +\fInvme seagate clear\-pcie\-correctable\-errors [] [OPTIONS]\fR .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.html b/Documentation/nvme-seagate-clear-pcie-correctable-errors.html index feb6ad6d..9ed2a9d3 100644 --- a/Documentation/nvme-seagate-clear-pcie-correctable-errors.html +++ b/Documentation/nvme-seagate-clear-pcie-correctable-errors.html @@ -749,7 +749,7 @@ nvme-seagate-clear-pcie-correctable-errors(1) Manual Page

SYNOPSIS

-
nvme seagate clear-pcie-correctable-errors [<device>]  [OPTIONS]
+
nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]
@@ -757,7 +757,7 @@ nvme-seagate-clear-pcie-correctable-errors(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The <device> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0), or an nvme block device (ex: /dev/nvme0n1).

@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 b/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 index 1989f200..821c800b 100644 --- a/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 +++ b/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-cloud-SSD-plugin-version .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-CLOUD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-CLOUD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-cloud-SSD-plugin-version.html b/Documentation/nvme-seagate-cloud-SSD-plugin-version.html index bc93aadc..d8964c9c 100644 --- a/Documentation/nvme-seagate-cloud-SSD-plugin-version.html +++ b/Documentation/nvme-seagate-cloud-SSD-plugin-version.html @@ -787,7 +787,7 @@ nvme-seagate-cloud-SSD-plugin-version (1) Manual Page diff --git a/Documentation/nvme-seagate-get-ctrl-tele.1 b/Documentation/nvme-seagate-get-ctrl-tele.1 index 60f20be8..4ee18194 100644 --- a/Documentation/nvme-seagate-get-ctrl-tele.1 +++ b/Documentation/nvme-seagate-get-ctrl-tele.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-get-ctrl-tele .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-GET\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-GET\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-get-ctrl-tele.html b/Documentation/nvme-seagate-get-ctrl-tele.html index 4374c554..1eb5e6ac 100644 --- a/Documentation/nvme-seagate-get-ctrl-tele.html +++ b/Documentation/nvme-seagate-get-ctrl-tele.html @@ -757,7 +757,7 @@ nvme-seagate-get-ctrl-tele(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The '<device>'parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -813,7 +813,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-get-host-tele.1 b/Documentation/nvme-seagate-get-host-tele.1 index 20905811..2035164b 100644 --- a/Documentation/nvme-seagate-get-host-tele.1 +++ b/Documentation/nvme-seagate-get-host-tele.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-get-host-tele .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-GET\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-GET\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -38,7 +38,7 @@ nvme-seagate-get-host-tele \- Retrieve Seagate Host\-Initiated Telemetry in eith .sp This will only work on Seagate devices supporting this feature\&. Not all commands work across all product families\&. .sp -The \fI\fR parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&. +The \fI\fR parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP \-n , \-\-namespace\-id= diff --git a/Documentation/nvme-seagate-get-host-tele.html b/Documentation/nvme-seagate-get-host-tele.html index da3b81ba..89de9ec1 100644 --- a/Documentation/nvme-seagate-get-host-tele.html +++ b/Documentation/nvme-seagate-get-host-tele.html @@ -757,10 +757,10 @@ nvme-seagate-get-host-tele(1) Manual Page

DESCRIPTION

-

This will only work on Seagate devices supporting this feature. Not all +

This will only work on Seagate devices supporting this feature. Not all commands work across all product families.

-

The <device> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an -nvme block device (ex: /dev/nvme0n1).

+

The <device> parameter is mandatory and may be either an NVMe character device +(ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1).

@@ -786,7 +786,8 @@ nvme block device (ex: /dev/nvme0n1).

- 1 - controller shall capture Data representing the internal state of the controller at the time the command is processed. + 1 - controller shall capture Data representing the internal state of the + controller at the time the command is processed. 0 - controller shall not update the Telemetry Host Initiated Data.

@@ -825,7 +826,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-help.1 b/Documentation/nvme-seagate-help.1 index bdfcfb2f..bad6f324 100644 --- a/Documentation/nvme-seagate-help.1 +++ b/Documentation/nvme-seagate-help.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-help .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-HELP" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-HELP" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-help.html b/Documentation/nvme-seagate-help.html index 304d08b1..baba4f0d 100644 --- a/Documentation/nvme-seagate-help.html +++ b/Documentation/nvme-seagate-help.html @@ -812,7 +812,7 @@ help Display this help diff --git a/Documentation/nvme-seagate-plugin-version.1 b/Documentation/nvme-seagate-plugin-version.1 index 94d39855..d5d8a2c2 100644 --- a/Documentation/nvme-seagate-plugin-version.1 +++ b/Documentation/nvme-seagate-plugin-version.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-plugin-version .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-PLUGI" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-PLUGI" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-plugin-version.html b/Documentation/nvme-seagate-plugin-version.html index 5a65c48b..dcf59781 100644 --- a/Documentation/nvme-seagate-plugin-version.html +++ b/Documentation/nvme-seagate-plugin-version.html @@ -787,7 +787,7 @@ nvme-seagate-plugin-version(1) Manual Page diff --git a/Documentation/nvme-seagate-version.1 b/Documentation/nvme-seagate-version.1 index abf2b34d..a81491bf 100644 --- a/Documentation/nvme-seagate-version.1 +++ b/Documentation/nvme-seagate-version.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-version .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VERSI" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VERSI" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-version.html b/Documentation/nvme-seagate-version.html index 62b9af08..d3edf79a 100644 --- a/Documentation/nvme-seagate-version.html +++ b/Documentation/nvme-seagate-version.html @@ -787,7 +787,7 @@ nvme-seagate-version(1) Manual Page diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.1 b/Documentation/nvme-seagate-vs-fw-activate-history.1 index 260c9472..39d484b3 100644 --- a/Documentation/nvme-seagate-vs-fw-activate-history.1 +++ b/Documentation/nvme-seagate-vs-fw-activate-history.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-fw-activate-history .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-F" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-F" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.html b/Documentation/nvme-seagate-vs-fw-activate-history.html index 0f45465b..2e58f119 100644 --- a/Documentation/nvme-seagate-vs-fw-activate-history.html +++ b/Documentation/nvme-seagate-vs-fw-activate-history.html @@ -757,7 +757,7 @@ nvme-seagate-vs-fw-activate-history (1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The <device> may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -813,7 +813,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-vs-internal-log.1 b/Documentation/nvme-seagate-vs-internal-log.1 index e39f3485..120676c0 100644 --- a/Documentation/nvme-seagate-vs-internal-log.1 +++ b/Documentation/nvme-seagate-vs-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-I" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-I" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-vs-internal-log.html b/Documentation/nvme-seagate-vs-internal-log.html index 35e42bba..860fa31b 100644 --- a/Documentation/nvme-seagate-vs-internal-log.html +++ b/Documentation/nvme-seagate-vs-internal-log.html @@ -757,10 +757,10 @@ nvme-seagate-vs-internal-log(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

-

The <device> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an -nvme block device (ex: /dev/nvme0n1).

+

The <device> parameter is mandatory and may be either an NVMe character device +(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -795,7 +795,8 @@ nvme block device (ex: /dev/nvme0n1).

EXAMPLES

-

Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device.

+

Get the Seagate vendor specific Controller-Initiated telemetry log for the +specified device.

# nvme seagate vs-internal-log /dev/nvme0
@@ -813,7 +814,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-vs-log-page-sup.1 b/Documentation/nvme-seagate-vs-log-page-sup.1 index 6b7bac14..475c0adf 100644 --- a/Documentation/nvme-seagate-vs-log-page-sup.1 +++ b/Documentation/nvme-seagate-vs-log-page-sup.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-log-page-sup .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,7 +41,7 @@ This command will only work on Seagate devices supporting this feature\&. Not al The \fI\fR may be either an NVMe character device (ex: /dev/nvme0) or an NVMe block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Output in binary format .RE diff --git a/Documentation/nvme-seagate-vs-log-page-sup.html b/Documentation/nvme-seagate-vs-log-page-sup.html index 44765aa0..fa883924 100644 --- a/Documentation/nvme-seagate-vs-log-page-sup.html +++ b/Documentation/nvme-seagate-vs-log-page-sup.html @@ -757,7 +757,7 @@ nvme-seagate-vs-log-page-sup(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The <device> may be either an NVMe character device (ex: /dev/nvme0) or an NVMe block device (ex: /dev/nvme0n1).

@@ -768,10 +768,10 @@ NVMe block device (ex: /dev/nvme0n1).

--o <FMT> +-o <fmt>
---output-format=<FMT> +--output-format=<fmt>

@@ -814,7 +814,7 @@ LogPage-Id LogPage-Name

diff --git a/Documentation/nvme-seagate-vs-pcie-stats.1 b/Documentation/nvme-seagate-vs-pcie-stats.1 index afe83e56..b14e060c 100644 --- a/Documentation/nvme-seagate-vs-pcie-stats.1 +++ b/Documentation/nvme-seagate-vs-pcie-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-pcie-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-P" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-P" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,7 +41,7 @@ This command will only work on Seagate devices supporting this feature\&. Not al The \fI\fR parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Output in binary format .RE diff --git a/Documentation/nvme-seagate-vs-pcie-stats.html b/Documentation/nvme-seagate-vs-pcie-stats.html index b43cba0f..0584dbe7 100644 --- a/Documentation/nvme-seagate-vs-pcie-stats.html +++ b/Documentation/nvme-seagate-vs-pcie-stats.html @@ -757,7 +757,7 @@ nvme-seagate-vs-pcie-stats(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The <device> parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -768,10 +768,10 @@ nvme block device (ex: /dev/nvme0n1).

--o <FMT> +-o <fmt>
---output-format=<FMT> +--output-format=<fmt>

@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-seagate-vs-smart-add-log.1 b/Documentation/nvme-seagate-vs-smart-add-log.1 index 799c101d..0941e844 100644 --- a/Documentation/nvme-seagate-vs-smart-add-log.1 +++ b/Documentation/nvme-seagate-vs-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-S" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-S" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-vs-smart-add-log.html b/Documentation/nvme-seagate-vs-smart-add-log.html index ddd4cd65..bbe2d2b5 100644 --- a/Documentation/nvme-seagate-vs-smart-add-log.html +++ b/Documentation/nvme-seagate-vs-smart-add-log.html @@ -764,7 +764,7 @@ character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

The log contents may be associated with the controller, in which case the namespace parameter is ignored.

Two logs exist, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM Supercap SMART log page)

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

@@ -830,7 +830,7 @@ all commands work across all product families.

diff --git a/Documentation/nvme-seagate-vs-temperature-stats.1 b/Documentation/nvme-seagate-vs-temperature-stats.1 index d933def9..702729cc 100644 --- a/Documentation/nvme-seagate-vs-temperature-stats.1 +++ b/Documentation/nvme-seagate-vs-temperature-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-seagate-vs-temperature-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SEAGATE\-VS\-T" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SEAGATE\-VS\-T" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,7 +41,7 @@ This command will only work on Seagate devices supporting this feature\&. Not al The \*(Aq\*(Aqparameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Output in binary format .RE diff --git a/Documentation/nvme-seagate-vs-temperature-stats.html b/Documentation/nvme-seagate-vs-temperature-stats.html index 75e7c651..a2824ead 100644 --- a/Documentation/nvme-seagate-vs-temperature-stats.html +++ b/Documentation/nvme-seagate-vs-temperature-stats.html @@ -757,7 +757,7 @@ nvme-seagate-vs-temperature-stats(1) Manual Page

DESCRIPTION

-

This command will only work on Seagate devices supporting this feature. Not +

This command will only work on Seagate devices supporting this feature. Not all commands work across all product families.

The '<device>'parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).

@@ -768,10 +768,10 @@ nvme block device (ex: /dev/nvme0n1).

--o <FMT> +-o <fmt>
---output-format=<FMT> +--output-format=<fmt>

@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).

diff --git a/Documentation/nvme-security-recv.1 b/Documentation/nvme-security-recv.1 index 262720fd..745c9b68 100644 --- a/Documentation/nvme-security-recv.1 +++ b/Documentation/nvme-security-recv.1 @@ -2,12 +2,12 @@ .\" Title: nvme-security-recv .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SECURITY\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SECURITY\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,12 +33,12 @@ nvme-security-recv \- Security Recv command .sp .nf \fInvme security\-recv\fR [\-\-size= | \-x ] - [\-\-secp= | \-p ] - [\-\-spsp= | \-s ] - [\-\-nssf= | \-N ] - [\-\-al= | \-t ] - [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] + [\-\-secp= | \-p ] + [\-\-spsp= | \-s ] + [\-\-nssf= | \-N ] + [\-\-al= | \-t ] + [\-\-namespace\-id= | \-n ] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -83,6 +83,20 @@ Allocation Length: The value of this field is specific to the Security Protocol .RS 4 Print the raw buffer to stdout\&. Defaults to print in hex\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No Examples diff --git a/Documentation/nvme-security-recv.html b/Documentation/nvme-security-recv.html index 3eacdffc..290a2f18 100644 --- a/Documentation/nvme-security-recv.html +++ b/Documentation/nvme-security-recv.html @@ -750,12 +750,12 @@ nvme-security-recv(1) Manual Page 
nvme security-recv <device> [--size=<size> | -x <size>]
-                    [--secp=<security-protocol> | -p <security-protocol>]
-                    [--spsp=<protocol-specific> | -s <protocol-specific>]
-                    [--nssf=<nvme-specific> | -N <nvme-specific>]
-                    [--al=<allocation-length> | -t <allocation-length>]
-                    [--namespace-id=<nsid> | -n <nsid>]
-                    [--raw-binary | -b]
+ [--secp=<security-protocol> | -p <security-protocol>] + [--spsp=<protocol-specific> | -s <protocol-specific>] + [--nssf=<nvme-specific> | -N <nvme-specific>] + [--al=<allocation-length> | -t <allocation-length>] + [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -866,6 +866,29 @@ controller reset occurs.

Print the raw buffer to stdout. Defaults to print in hex.

+
+-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. +

+
@@ -886,7 +909,7 @@ controller reset occurs.

diff --git a/Documentation/nvme-security-send.1 b/Documentation/nvme-security-send.1 index 187b7faf..91b5507d 100644 --- a/Documentation/nvme-security-send.1 +++ b/Documentation/nvme-security-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-security-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SECURITY\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SECURITY\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,12 @@ nvme-security-send \- Security Send command .sp .nf \fInvme security\-send\fR [\-\-file= | \-f ] - [\-\-secp= | \-p ] - [\-\-spsp= | \-s ] - [\-\-tl= | \-t ] - [\-\-nssf= | \-N ] - [\-\-namespace\-id= | \-n ] + [\-\-secp= | \-p ] + [\-\-spsp= | \-s ] + [\-\-tl= | \-t ] + [\-\-nssf= | \-N ] + [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -75,6 +76,20 @@ SP Specific: The value of this field is specific to the Security Protocol as def .RS 4 Transfer Length: The value of this field is specific to the Security Protocol as defined in SPC\-4\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No Examples diff --git a/Documentation/nvme-security-send.html b/Documentation/nvme-security-send.html index b2ee749a..7cdc7ab6 100644 --- a/Documentation/nvme-security-send.html +++ b/Documentation/nvme-security-send.html @@ -750,11 +750,12 @@ nvme-security-send(1) Manual Page 
nvme security-send <device> [--file=<file> | -f <file>]
-                    [--secp=<security-protocol> | -p <security-protocol>]
-                    [--spsp=<protocol-specific> | -s <protocol-specific>]
-                    [--tl=<transfer-length> | -t <transfer-length>]
-                    [--nssf=<nvme-specific> | -N <nvme-specific>]
-                    [--namespace-id=<nsid> | -n <nsid>]
+ [--secp=<security-protocol> | -p <security-protocol>] + [--spsp=<protocol-specific> | -s <protocol-specific>] + [--tl=<transfer-length> | -t <transfer-length>] + [--nssf=<nvme-specific> | -N <nvme-specific>] + [--namespace-id=<nsid> | -n <nsid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -852,6 +853,29 @@ Receive command is Security Protocol field dependent as defined in SPC-4.

+
+-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. +

+
@@ -872,7 +896,7 @@ Receive command is Security Protocol field dependent as defined in SPC-4.

Last updated - 2023-09-29 08:33:07 CEST + 2023-12-19 12:48:30 CET
diff --git a/Documentation/nvme-self-test-log.1 b/Documentation/nvme-self-test-log.1 index 9be513db..e2087b7d 100644 --- a/Documentation/nvme-self-test-log.1 +++ b/Documentation/nvme-self-test-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-self-test-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SELF\-TEST\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SELF\-TEST\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-self-test-log \- Retrieve the log information initiated by device\-self\-te .sp .nf \fInvme self\-test\fR\-log [\-\-log\-entries= | \-e ] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -51,13 +51,19 @@ By default the log is printed out in the normal readable format\&. Specifies how many DST log entries the program should request from the device\&. This must be at least one, and shouldn\(cqt exceed the 20 entries\&. Defaults to 20 DST log entries\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-self-test-log.html b/Documentation/nvme-self-test-log.html index 84907294..9f29c483 100644 --- a/Documentation/nvme-self-test-log.html +++ b/Documentation/nvme-self-test-log.html @@ -750,7 +750,7 @@ nvme-self-test-log(1) Manual Page 
nvme self-test-log <device> [--log-entries=<entries> | -e <entries>]
-                    [--output-format=<FMT> | -o <FMT>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -788,15 +788,26 @@ json format.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -847,7 +858,7 @@ Get the self-test-log and print it in a json format: diff --git a/Documentation/nvme-set-feature.1 b/Documentation/nvme-set-feature.1 index 0ab78b90..76a4aced 100644 --- a/Documentation/nvme-set-feature.1 +++ b/Documentation/nvme-set-feature.1 @@ -2,12 +2,12 @@ .\" Title: nvme-set-feature .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-FEATURE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-FEATURE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,11 @@ nvme-set-feature \- Sets an NVMe feature, returns applicable results .sp .nf \fInvme set\-feature\fR [\-\-namespace\-id= | \-n ] - [\-\-feature\-id= | \-f ] [\-\-value= | \-v ] - [\-\-uuid\-index= | \-U ] - [\-\-data\-len= | \-l ] - [\-\-data= | \-d ] - [\-\-save | \-s] + [\-\-feature\-id= | \-f ] [\-\-value= | \-V ] + [\-\-uuid\-index= | \-U ] + [\-\-data\-len= | \-l ] + [\-\-data= | \-d ] [\-\-save | \-s] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -68,7 +68,7 @@ The data length for the buffer submitted for this feature\&. Most known features The data file for the buffer submitted for this feature\&. Most known features do not use this value\&. The exceptions is LBA Range Type and host identifier\&. This defaults to STDIN so files and echo can be piped\&. .RE .PP -\-v , \-\-value= +\-V , \-\-value= .RS 4 The value for command dword 11, the value you want to set the feature to\&. .RE @@ -82,6 +82,20 @@ Save the attribute so that it persists through all power states and resets\&. .RS 4 UUID Index of the feature .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 @@ -98,7 +112,7 @@ Sets the Power State (PS) to 1 in feature id 2: .RS 4 .\} .nf -# nvme set\-feature /dev/nvme0 \-f 2 /dev/nvme0n1 \-v 0x1 +# nvme set\-feature /dev/nvme0 \-f 2 /dev/nvme0n1 \-V 0x1 .fi .if n \{\ .RE diff --git a/Documentation/nvme-set-feature.html b/Documentation/nvme-set-feature.html index 7fcb060b..1cd0d9c9 100644 --- a/Documentation/nvme-set-feature.html +++ b/Documentation/nvme-set-feature.html @@ -750,11 +750,11 @@ nvme-set-feature(1) Manual Page 
nvme set-feature <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--feature-id=<fid> | -f <fid>] [--value=<value> | -v <value>]
-                          [--uuid-index=<uuid-index> | -U <uuid_index>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--data=<data-file> | -d <data-file>]
-                          [--save | -s]
+ [--feature-id=<fid> | -f <fid>] [--value=<value> | -V <value>] + [--uuid-index=<uuid-index> | -U <uuid_index>] + [--data-len=<data-len> | -l <data-len>] + [--data=<data-file> | -d <data-file>] [--save | -s] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -826,7 +826,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--v <value> +-V <value>
--value=<value> @@ -859,6 +859,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+-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. +

+
@@ -868,11 +891,11 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

  • -Sets the Power State (PS) to 1 in feature id 2: +Sets the Power State (PS) to 1 in feature id 2:

    -
    # nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -v 0x1
    +
    # nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1
  • @@ -899,7 +922,7 @@ Sets the host id to the ascii string. diff --git a/Documentation/nvme-set-property.1 b/Documentation/nvme-set-property.1 index ef5d1f43..e7a2654f 100644 --- a/Documentation/nvme-set-property.1 +++ b/Documentation/nvme-set-property.1 @@ -2,12 +2,12 @@ .\" Title: nvme-set-property .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-PROPERTY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-PROPERTY" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,23 +32,38 @@ nvme-set-property \- Writes and shows the defined NVMe controller property for N .SH "SYNOPSIS" .sp .nf -\fInvme set\-property\fR [\-\-offset= | \-o ] - [\-\-value= | \-v ] +\fInvme set\-property\fR [\-\-offset= | \-O ] + [\-\-value= | \-V ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Writes and shows the defined NVMe controller property for NVMe over Fabric\&. .SH "OPTIONS" .PP -\-o, \-\-offset +\-O, \-\-offset .RS 4 The offset of the property\&. .RE .PP -\-v +\-V .RS 4 \-\-value: The value of the property to be set\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples (yet)\&. diff --git a/Documentation/nvme-set-property.html b/Documentation/nvme-set-property.html index ff254122..4cc32a53 100644 --- a/Documentation/nvme-set-property.html +++ b/Documentation/nvme-set-property.html @@ -749,8 +749,9 @@ nvme-set-property(1) Manual Page

    SYNOPSIS

    -
    nvme set-property <device> [--offset=<offset> | -o <offset>]
-                                [--value=<val> | -v <val>]
    +
    nvme set-property <device> [--offset=<offset> | -O <offset>]
+                        [--value=<val> | -V <val>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
    @@ -766,18 +767,18 @@ nvme-set-property(1) Manual Page
    --o +-O
    --offset

    - The offset of the property. + The offset of the property.

    --v +-V

    @@ -785,6 +786,29 @@ nvme-set-property(1) Manual Page The value of the property to be set.

    +
    +-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. +

    +
@@ -805,7 +829,7 @@ nvme-set-property(1) Manual Page diff --git a/Documentation/nvme-show-hostnqn.1 b/Documentation/nvme-show-hostnqn.1 index 0411ebd9..fb167e37 100644 --- a/Documentation/nvme-show-hostnqn.1 +++ b/Documentation/nvme-show-hostnqn.1 @@ -2,12 +2,12 @@ .\" Title: nvme-show-hostnqn .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SHOW\-HOSTNQN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SHOW\-HOSTNQN" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,26 @@ nvme-show-hostnqn \- Show the host NQN configured for the system .SH "SYNOPSIS" .sp .nf -\fInvme show\-hostnqn\fR +\fInvme show\-hostnqn\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Show the host NQN configured for the system\&. If /usr/local/etc/nvme/hostnqn is not present and systemd application\-specific machine IDs are available, this will show the systemd\-generated host NQN for the system\&. .SH "OPTIONS" -.sp -No options needed +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 nvme show\-hostnqn diff --git a/Documentation/nvme-show-hostnqn.html b/Documentation/nvme-show-hostnqn.html index e31b27dd..49976ee5 100644 --- a/Documentation/nvme-show-hostnqn.html +++ b/Documentation/nvme-show-hostnqn.html @@ -749,7 +749,7 @@ nvme-show-hostnqn(1) Manual Page

SYNOPSIS

-
nvme show-hostnqn
+
nvme show-hostnqn [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -757,7 +757,7 @@ nvme-show-hostnqn(1) Manual Page

DESCRIPTION

-

Show the host NQN configured for the system. If /usr/local/etc/nvme/hostnqn is +

Show the host NQN configured for the system. If /usr/local/etc/nvme/hostnqn is not present and systemd application-specific machine IDs are available, this will show the systemd-generated host NQN for the system.

@@ -765,7 +765,31 @@ this will show the systemd-generated host NQN for the system.

OPTIONS

-

No options needed

+
+
+-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. +

+
+
@@ -785,7 +809,7 @@ this will show the systemd-generated host NQN for the system.

diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1 index a7ea5acf..1310f97c 100644 --- a/Documentation/nvme-show-regs.1 +++ b/Documentation/nvme-show-regs.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-show-regs \- Reads and shows the defined NVMe controller registers for NVMe .SH "SYNOPSIS" .sp .nf -\fInvme show\-regs\fR [\-\-human\-readable | \-H] - [\-\-output\-format= | \-o ] +\fInvme show\-regs\fR [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,13 +47,19 @@ The parameter is mandatory and must be the nvme admin character device Display registers or supported properties in human readable format\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html index 194b73c5..63a11552 100644 --- a/Documentation/nvme-show-regs.html +++ b/Documentation/nvme-show-regs.html @@ -749,8 +749,8 @@ nvme-id-ns(1) Manual Page

SYNOPSIS

-
nvme show-regs <device>       [--human-readable | -H]
-                                [--output-format=<FMT> | -o <FMT>]
+
nvme show-regs <device> [--human-readable | -H]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -782,19 +782,30 @@ Only the supported properties are displayed.

- Display registers or supported properties in human readable format. + Display registers or supported properties in human readable format.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -848,7 +859,7 @@ in a json format: diff --git a/Documentation/nvme-show-topology.1 b/Documentation/nvme-show-topology.1 index 1f56e19a..2df4bc8c 100644 --- a/Documentation/nvme-show-topology.1 +++ b/Documentation/nvme-show-topology.1 @@ -2,12 +2,12 @@ .\" Title: nvme-show-topology .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SHOW\-TOPOLOGY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SHOW\-TOPOLOGY" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,14 +32,14 @@ nvme-show-topology \- Show topology of all NVMe subsystems .SH "SYNOPSIS" .sp .nf -\fInvme show\-topology\fR +\fInvme show\-topology\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Show the topology of all NVMe subsystems\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR @@ -62,6 +62,20 @@ Set the ranking orer to \fInamespace\fR ordered\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 nvme show\-topology diff --git a/Documentation/nvme-show-topology.html b/Documentation/nvme-show-topology.html index 27556a37..9060731d 100644 --- a/Documentation/nvme-show-topology.html +++ b/Documentation/nvme-show-topology.html @@ -749,7 +749,7 @@ nvme-show-topology(1) Manual Page

SYNOPSIS

-
nvme show-topology
+
nvme show-topology [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -765,10 +765,10 @@ nvme-show-topology(1) Manual Page
--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -802,6 +802,29 @@ nvme-show-topology(1) Manual Page always namespace ordered.

+
+-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. +

+
@@ -822,7 +845,7 @@ nvme-show-topology(1) Manual Page diff --git a/Documentation/nvme-smart-log.1 b/Documentation/nvme-smart-log.1 index 6c95ab57..0d2e3a19 100644 --- a/Documentation/nvme-smart-log.1 +++ b/Documentation/nvme-smart-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-smart-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SMART\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SMART\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,7 +34,7 @@ nvme-smart-log \- Send NVMe SMART log page request, returns result and log .nf \fInvme smart\-log\fR [\-\-namespace\-id= | \-n ] [\-\-raw\-binary | \-b] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,13 +55,19 @@ Retrieve the SMART log for the given nsid\&. This is optional and its success ma Print the raw SMART log buffer to stdout\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .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 diff --git a/Documentation/nvme-smart-log.html b/Documentation/nvme-smart-log.html index ba0605f8..e9d0ff2a 100644 --- a/Documentation/nvme-smart-log.html +++ b/Documentation/nvme-smart-log.html @@ -751,7 +751,7 @@ nvme-smart-log(1) Manual Page 
nvme smart-log <device> [--namespace-id=<nsid> | -n <nsid>]
                         [--raw-binary | -b]
-                        [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -799,15 +799,26 @@ printed to stdout for another program to parse.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + 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.

@@ -850,7 +861,7 @@ Print the raw SMART log to a file: diff --git a/Documentation/nvme-subsystem-reset.1 b/Documentation/nvme-subsystem-reset.1 index 6a7ee6bb..b587eb6c 100644 --- a/Documentation/nvme-subsystem-reset.1 +++ b/Documentation/nvme-subsystem-reset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-subsystem-reset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SUBSYSTEM\-RES" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SUBSYSTEM\-RES" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,13 +33,26 @@ nvme-subsystem-reset \- Reset the nvme subsystem\&. .sp .nf \fInvme subsystem\-reset\fR + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe subsystem reset\&. The param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-subsystem-reset.html b/Documentation/nvme-subsystem-reset.html index d8889387..18adf9af 100644 --- a/Documentation/nvme-subsystem-reset.html +++ b/Documentation/nvme-subsystem-reset.html @@ -749,7 +749,8 @@ nvme-subsystem-reset(1) Manual Page

SYNOPSIS

-
nvme subsystem-reset <device>
+
nvme subsystem-reset <device>
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -764,7 +765,31 @@ be an NVMe character device (ex: /dev/nvme0).

OPTIONS

-

None

+
+
+-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. +

+
+
@@ -794,7 +819,7 @@ Resets the subsystem. diff --git a/Documentation/nvme-supported-log-pages.1 b/Documentation/nvme-supported-log-pages.1 index 5a411339..afac92fd 100644 --- a/Documentation/nvme-supported-log-pages.1 +++ b/Documentation/nvme-supported-log-pages.1 @@ -2,12 +2,12 @@ .\" Title: nvme-supported-log-pages .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SUPPORTED\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SUPPORTED\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,7 @@ nvme-supported-log-pages \- Send NVMe Supported Log pages request, returns resul .SH "SYNOPSIS" .sp .nf -\fInvme supported\-log\-pages\fR [\-\-output\-format= | \-o ] - [\-\-verbose | \-v] +\fInvme supported\-log\-pages\fR [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,14 +43,18 @@ The parameter is mandatory and should be the NVMe character device (ex: On success, the returned supported log pages log structure will be printed for each command that is supported\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 -This option will set the reporting format to normal, json, or binary\&. Only one output format can be used at a time\&. +Set the reporting format to +\fInormal\fR, +\fIjson\fR +or +\fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP \-v, \-\-verbose .RS 4 -Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details\&. +Increase the information detail in the output\&. Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details\&. .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-supported-log-pages.html b/Documentation/nvme-supported-log-pages.html index 2fe71262..b1959f08 100644 --- a/Documentation/nvme-supported-log-pages.html +++ b/Documentation/nvme-supported-log-pages.html @@ -749,8 +749,7 @@ nvme-supported-log-pages(1) Manual Page

SYNOPSIS

-
nvme supported-log-pages <device> [--output-format=<fmt> | -o <fmt>]
-                            [--verbose | -v]
+
nvme supported-log-pages <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -771,15 +770,15 @@ for each command that is supported.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. + Set the reporting format to normal, json or binary. Only one + output format can be used at a time.

@@ -790,7 +789,8 @@ for each command that is supported.

- Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details. + Increase the information detail in the output. Show more information + including LID Supported (LSUPP) and Index Offset Supported (IOP) details.

@@ -813,7 +813,7 @@ for each command that is supported.

diff --git a/Documentation/nvme-telemetry-log.1 b/Documentation/nvme-telemetry-log.1 index 9f68cd9c..91728cab 100644 --- a/Documentation/nvme-telemetry-log.1 +++ b/Documentation/nvme-telemetry-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-telemetry-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TELEMETRY\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TELEMETRY\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,9 @@ nvme-telemetry-log \- Retrieves a Telemetry Host\-Initiated log page from an NVM .SH "SYNOPSIS" .sp .nf -\fInvme telemetry\-log\fR [\-\-output\-file= | \-o ] - [\-\-host\-generate= | \-g ] +\fInvme telemetry\-log\fR [\-\-output\-file= | \-O ] + [\-\-host\-generate= | \-g ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,7 +45,7 @@ The parameter is mandatory and may be either the NVMe character device On success, the returned log structure will be in raw binary format \fIonly\fR with \-\-output\-file option which is mandatory\&. .SH "OPTIONS" .PP -\-o , \-\-output\-file= +\-O , \-\-output\-file= .RS 4 File name to which raw binary data will be saved to\&. .RE @@ -60,6 +61,20 @@ update this data\&. .RS 4 Retrieves the specific data area requested\&. Valid inputs are 1,2,3,4\&. If this option is not specified, the default value is 3, since data area 4 may not be supported\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 diff --git a/Documentation/nvme-telemetry-log.html b/Documentation/nvme-telemetry-log.html index 5cc59789..fa3ca6fc 100644 --- a/Documentation/nvme-telemetry-log.html +++ b/Documentation/nvme-telemetry-log.html @@ -749,8 +749,9 @@ nvme-telemetry-log(1) Manual Page

SYNOPSIS

-
nvme telemetry-log <device> [--output-file=<file> | -o <file>]
-                      [--host-generate=<gen> | -g <gen>]
+
nvme telemetry-log <device> [--output-file=<file> | -O <file>]
+                        [--host-generate=<gen> | -g <gen>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -771,7 +772,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

--o <file> +-O <file>
--output-file=<file> @@ -808,6 +809,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+-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. +

+
@@ -838,7 +862,7 @@ Retrieve Telemetry Host-Initiated data to telemetry_log.bin diff --git a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.1 b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.1 index ad49454b..07129468 100644 --- a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.1 +++ b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.1 @@ -2,12 +2,12 @@ .\" Title: nvme-toshiba-clear-pcie-correctable-errors .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TOSHIBA\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TOSHIBA\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.html b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.html index ad20764e..b338f10e 100644 --- a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.html +++ b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.html @@ -791,7 +791,7 @@ Clear the PCIe correctable errors count: diff --git a/Documentation/nvme-toshiba-vs-internal-log.1 b/Documentation/nvme-toshiba-vs-internal-log.1 index 08ee01bd..920a16ff 100644 --- a/Documentation/nvme-toshiba-vs-internal-log.1 +++ b/Documentation/nvme-toshiba-vs-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-toshiba-vs-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TOSHIBA\-VS\-I" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TOSHIBA\-VS\-I" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-toshiba-vs-internal-log.html b/Documentation/nvme-toshiba-vs-internal-log.html index 32641bbd..7c6bf4df 100644 --- a/Documentation/nvme-toshiba-vs-internal-log.html +++ b/Documentation/nvme-toshiba-vs-internal-log.html @@ -837,7 +837,7 @@ Get the previous log from the device and save to a binary file: diff --git a/Documentation/nvme-toshiba-vs-smart-add-log.1 b/Documentation/nvme-toshiba-vs-smart-add-log.1 index 1703e52e..e5ab8bb9 100644 --- a/Documentation/nvme-toshiba-vs-smart-add-log.1 +++ b/Documentation/nvme-toshiba-vs-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-toshiba-vs-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TOSHIBA\-VS\-S" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TOSHIBA\-VS\-S" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-toshiba-vs-smart-add-log.html b/Documentation/nvme-toshiba-vs-smart-add-log.html index 25dffa53..2bb6b838 100644 --- a/Documentation/nvme-toshiba-vs-smart-add-log.html +++ b/Documentation/nvme-toshiba-vs-smart-add-log.html @@ -764,7 +764,8 @@ request and either saves the result to a file or dumps the content to stdout.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

-

The log contents may be associated with the controller, in which case the namespace parameter is ignored.

+

The log contents may be associated with the controller, in which case the +namespace parameter is ignored.

Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page)

This will only work on Toshiba devices supporting this feature.

@@ -781,7 +782,7 @@ character device (ex: /dev/nvme0), or a namespace block device (ex:

- Log page: 0xC0 or 0xCA (defaults to 0xCA) + Log page: 0xC0 or 0xCA (defaults to 0xCA)

@@ -840,7 +841,7 @@ Get the contents of log page 0xC0 from the device and save to a binary file: diff --git a/Documentation/nvme-transcend-badblock.1 b/Documentation/nvme-transcend-badblock.1 index 4daf67d0..99e70573 100644 --- a/Documentation/nvme-transcend-badblock.1 +++ b/Documentation/nvme-transcend-badblock.1 @@ -2,12 +2,12 @@ .\" Title: nvme-transcend-badblock .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TRANSCEND\-BAD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TRANSCEND\-BAD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-transcend-badblock.html b/Documentation/nvme-transcend-badblock.html index 002c5646..5b89f465 100644 --- a/Documentation/nvme-transcend-badblock.html +++ b/Documentation/nvme-transcend-badblock.html @@ -796,7 +796,7 @@ Print the Transcend device’s bad blocks in a human readable format: diff --git a/Documentation/nvme-transcend-healthvalue.1 b/Documentation/nvme-transcend-healthvalue.1 index 9da212cb..ffa18876 100644 --- a/Documentation/nvme-transcend-healthvalue.1 +++ b/Documentation/nvme-transcend-healthvalue.1 @@ -2,12 +2,12 @@ .\" Title: nvme-transcend-healthvalue .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-TRANSCEND\-HEA" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-TRANSCEND\-HEA" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-transcend-healthvalue.html b/Documentation/nvme-transcend-healthvalue.html index 2bd62eea..317a77b1 100644 --- a/Documentation/nvme-transcend-healthvalue.html +++ b/Documentation/nvme-transcend-healthvalue.html @@ -757,7 +757,8 @@ nvme-transcend-healthvalue(1) Manual Page

DESCRIPTION

-

Retrieves the NVMe Device SMART log page from the Transcend device and evaluate health status of Transcend device.

+

Retrieves the NVMe Device SMART log page from the Transcend device and evaluate +health status of Transcend device.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

On success, the returned value would print health percentage value.

@@ -796,7 +797,7 @@ Print the Transcend Device health value in a human readable format: diff --git a/Documentation/nvme-verify.1 b/Documentation/nvme-verify.1 index 1fbdd360..b4d67208 100644 --- a/Documentation/nvme-verify.1 +++ b/Documentation/nvme-verify.1 @@ -2,12 +2,12 @@ .\" Title: nvme-verify .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-VERIFY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-VERIFY" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,48 +33,48 @@ nvme-verify \- Send an NVMe Verify command, return results .sp .nf \fInvme\-verify\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-block= | \-s ] - [\-\-block\-count= | \-c ] - [\-\-limited\-retry | \-l] - [\-\-force\-unit\-access | \-f] - [\-\-prinfo= | \-p ] - [\-\-ref\-tag= | \-r ] - [\-\-app\-tag\-mask= | \-m ] - [\-\-app\-tag= | \-a ] - [\-\-storage\-tag | \-S ] - [\-\-storage\-tag\-check | \-C] + [\-\-start\-block= | \-s ] + [\-\-block\-count= | \-c ] [\-\-limited\-retry | \-l] + [\-\-force\-unit\-access | \-f] + [\-\-prinfo= | \-p ] + [\-\-ref\-tag= | \-r ] + [\-\-app\-tag\-mask= | \-m ] + [\-\-app\-tag= | \-a ] + [\-\-storage\-tag | \-S ] + [\-\-storage\-tag\-check | \-C] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Verify command verifies the integrity of the stored information by reading data and metadata\&. .SH "OPTIONS" .PP -\-\-namespace\-id=, \-n +\-n , \-\-namespace\-id= .RS 4 Namespace ID use in the command\&. .RE .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block address\&. .RE .PP -\-\-block\-count=, \-c +\-c , \-\-block\-count= .RS 4 Number of logical blocks to Verify\&. .RE .PP -\-\-limited\-retry, \-l +\-l, \-\-limited\-retry .RS 4 Sets the limited retry flag\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE .PP -\-\-prinfo=, \-p +\-p , \-\-prinfo= .RS 4 Protection Information field definition\&. .TS @@ -119,17 +119,17 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=, \-m +\-m , \-\-app\-tag\-mask= .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=, \-a +\-a , \-\-app\-tag= .RS 4 Optional application tag when used with protection information\&. .RE @@ -143,6 +143,20 @@ Variable Sized Expected Logical Block Storage Tag(ELBST)\&. .RS 4 This flag enables Storage Tag field checking as part of Verify operation\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-verify.html b/Documentation/nvme-verify.html index 28736049..d7b5e3bd 100644 --- a/Documentation/nvme-verify.html +++ b/Documentation/nvme-verify.html @@ -750,16 +750,16 @@ nvme-verify(1) Manual Page 
nvme-verify <device> [--namespace-id=<nsid> | -n <nsid>]
-            [--start-block=<slba> | -s <slba>]
-            [--block-count=<nlb> | -c <nlb>]
-            [--limited-retry | -l]
-            [--force-unit-access | -f]
-            [--prinfo=<prinfo> | -p <prinfo>]
-            [--ref-tag=<reftag> | -r <reftag>]
-            [--app-tag-mask=<appmask> | -m <appmask>]
-            [--app-tag=<apptag> | -a <apptag>]
-            [--storage-tag<storage-tag> | -S <storage-tag>]
-            [--storage-tag-check | -C]
+ [--start-block=<slba> | -s <slba>] + [--block-count=<nlb> | -c <nlb>] [--limited-retry | -l] + [--force-unit-access | -f] + [--prinfo=<prinfo> | -p <prinfo>] + [--ref-tag=<reftag> | -r <reftag>] + [--app-tag-mask=<appmask> | -m <appmask>] + [--app-tag=<apptag> | -a <apptag>] + [--storage-tag<storage-tag> | -S <storage-tag>] + [--storage-tag-check | -C] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -776,10 +776,10 @@ reading data and metadata.

---namespace-id=<nsid> +-n <nsid>
--n <nsid> +--namespace-id=<nsid>

@@ -787,10 +787,10 @@ reading data and metadata.

---start-block=<slba> +-s <slba>
--s <slba> +--start-block=<slba>

@@ -798,10 +798,10 @@ reading data and metadata.

---block-count=<nlb> +-c <nlb>
--c <nlb> +--block-count=<nlb>

@@ -809,10 +809,10 @@ reading data and metadata.

---limited-retry +-l
--l +--limited-retry

@@ -820,10 +820,10 @@ reading data and metadata.

---force-unit-access +-f
--f +--force-unit-access

@@ -831,10 +831,10 @@ reading data and metadata.

---prinfo=<prinfo> +-p <prinfo>
--p <prinfo> +--prinfo=<prinfo>

@@ -879,10 +879,10 @@ metadata is passes.

---ref-tag=<reftag> +-r <reftag>
--r <reftag> +--ref-tag=<reftag>

@@ -890,10 +890,10 @@ metadata is passes.

---app-tag-mask=<appmask> +-m <appmask>
--m <appmask> +--app-tag-mask=<appmask>

@@ -901,10 +901,10 @@ metadata is passes.

---app-tag=<apptag> +-a <apptag>
--a <apptag> +--app-tag=<apptag>

@@ -933,6 +933,29 @@ metadata is passes.

This flag enables Storage Tag field checking as part of Verify operation.

+
+-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. +

+
@@ -953,7 +976,7 @@ metadata is passes.

diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.1 b/Documentation/nvme-virtium-save-smart-to-vtview-log.1 index 292c91b8..34c3be5e 100644 --- a/Documentation/nvme-virtium-save-smart-to-vtview-log.1 +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-virtium-save-smart-to-vtview-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-VIRTIUM\-SAVE\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-VIRTIUM\-SAVE\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,7 +39,7 @@ nvme-virtium-save-smart-to-vtview-log \- Periodically save smart attributes into .fi .SH "DESCRIPTION" .sp -This command automates the process of collecting SMART data periodically and saving the data in a ready\-to\-analyze format\&. Each entry is saved with timestamp and in csv format\&. Users can use excel to analyze the data\&. Some examples of use cases are collecting SMART data for temperature characterization, collecting data to calculate endurance, or collecting SMART data during a test or during normal operation\&. +This command automates the process of collecting SMART data periodically and saving the data in a ready\-to\-analyze format\&. Each entry is saved with timestamp and in csv format\&. Users can use excel to analyze the data\&. Some examples of use cases are collecting SMART data for temperature characterization, data to calculate endurance, or collecting SMART data during a test or during normal operation\&. .sp The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. .sp @@ -57,7 +57,7 @@ If the test\-name option is specified, it will be recorded in the log file and b .PP \-f , \-\-freq= .RS 4 -(optional) How often you want to log SMART data (0\&.25 = 15\*(Aq , 0\&.5 = 30\*(Aq , 1 = 1 hour, 2 = 2 hours, etc\&.)\&. Default = 10 hours\&. +(optional) How often you want to log SMART data (0\&.25 = 15\*(Aq, 0\&.5 = 30\*(Aq, 1 = 1 hour, 2 = 2 hours, etc\&.)\&. Default = 10 hours\&. .RE .PP \-o , \-\-output\-file= diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.html b/Documentation/nvme-virtium-save-smart-to-vtview-log.html index b8d3d70a..715de2a0 100644 --- a/Documentation/nvme-virtium-save-smart-to-vtview-log.html +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.html @@ -763,18 +763,19 @@ nvme-virtium-save-smart-to-vtview-log(1) Manual Page

This command automates the process of collecting SMART data periodically and saving the data in a ready-to-analyze format. Each entry is saved with timestamp and in csv format. Users can use excel to analyze the data. -Some examples of use cases are collecting SMART data for temperature characterization, -collecting data to calculate endurance, or collecting SMART data during a test -or during normal operation.

+Some examples of use cases are collecting SMART data for temperature +characterization, data to calculate endurance, or collecting SMART data during a +test or during normal operation.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

-

On success, the command generates a log file, which contains an entry for identify device -(current features & settings) and periodic entries of SMART data.

-

This command runs for the time specified by the option <run-time>, and collects SMART data -at the frequency specified by the option <freq>. If the output file name is not specified, -this command will generate a file name that include model string and serial number of the device.

-

If the test-name option is specified, it will be recorded in the log file and be used as part -of the log file name.

+

On success, the command generates a log file, which contains an entry for +identify device (current features & settings) and periodic entries of SMART data.

+

This command runs for the time specified by the option <run-time>, and collects +SMART data at the frequency specified by the option <freq>. If the output file +name is not specified, this command will generate a file name that include model +string and serial number of the device.

+

If the test-name option is specified, it will be recorded in the log file and be +used as part of the log file name.

@@ -800,8 +801,8 @@ of the log file name.

- (optional) How often you want to log SMART data - (0.25 = 15' , 0.5 = 30' , 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours. + (optional) How often you want to log SMART data (0.25 = 15', 0.5 = 30', + 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.

@@ -812,9 +813,9 @@ of the log file name.

- (optional) Name of the log file (give it a name that easy for you to remember - what the test is). You can leave it blank too, the file name will be generated - as <model string>-<serial number>-<test name>.txt. + (optional) Name of the log file (give it a name that easy for you to + remember what the test is). You can leave it blank too, the file name + will be generated as <model string>-<serial number>-<test name>.txt.

@@ -825,7 +826,8 @@ of the log file name.

- (optional) Name of the test you are doing. We use this string as part of the name of the log file. + (optional) Name of the test you are doing. We use this string as part of + the name of the log file.

@@ -876,7 +878,7 @@ Just logging: Default logging is run for 20 hours and log every 10 hours. diff --git a/Documentation/nvme-virtium-show-identify.1 b/Documentation/nvme-virtium-show-identify.1 index 8b445cbf..7f7f938a 100644 --- a/Documentation/nvme-virtium-show-identify.1 +++ b/Documentation/nvme-virtium-show-identify.1 @@ -2,12 +2,12 @@ .\" Title: nvme-virtium-show-identify .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-VIRTIUM\-SHOW\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-VIRTIUM\-SHOW\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-virtium-show-identify.html b/Documentation/nvme-virtium-show-identify.html index 31b91120..73e7ab8f 100644 --- a/Documentation/nvme-virtium-show-identify.html +++ b/Documentation/nvme-virtium-show-identify.html @@ -798,7 +798,7 @@ Show Identify Device: diff --git a/Documentation/nvme-wdc-cap-diag.1 b/Documentation/nvme-wdc-cap-diag.1 index edb93b23..081cd2ad 100644 --- a/Documentation/nvme-wdc-cap-diag.1 +++ b/Documentation/nvme-wdc-cap-diag.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-cap-diag .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CAP\-DIAG" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CAP\-DIAG" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-cap-diag.html b/Documentation/nvme-wdc-cap-diag.html index b3d496cf..03147e82 100644 --- a/Documentation/nvme-wdc-cap-diag.html +++ b/Documentation/nvme-wdc-cap-diag.html @@ -787,7 +787,7 @@ Results for any other device are undefined.

- Transfer size; defaults to 0x10000 (65536 decimal) bytes + Transfer size; defaults to 0x10000 (65536 decimal) bytes

@@ -856,7 +856,7 @@ Gets the capture diagnostics log from the device transferring the data in 16k ch diff --git a/Documentation/nvme-wdc-capabilities.1 b/Documentation/nvme-wdc-capabilities.1 index 348702a8..555c493e 100644 --- a/Documentation/nvme-wdc-capabilities.1 +++ b/Documentation/nvme-wdc-capabilities.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-capabilities .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CAPABILIT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CAPABILIT" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-capabilities.html b/Documentation/nvme-wdc-capabilities.html index f43e981e..491780aa 100644 --- a/Documentation/nvme-wdc-capabilities.html +++ b/Documentation/nvme-wdc-capabilities.html @@ -789,7 +789,7 @@ Displays the capabilities for the device: diff --git a/Documentation/nvme-wdc-clear-assert-dump.1 b/Documentation/nvme-wdc-clear-assert-dump.1 index 6b4c8873..ebbe6018 100644 --- a/Documentation/nvme-wdc-clear-assert-dump.1 +++ b/Documentation/nvme-wdc-clear-assert-dump.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-clear-assert-dump .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-AS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLEAR\-AS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-clear-assert-dump.html b/Documentation/nvme-wdc-clear-assert-dump.html index 922bc679..7adc7aac 100644 --- a/Documentation/nvme-wdc-clear-assert-dump.html +++ b/Documentation/nvme-wdc-clear-assert-dump.html @@ -798,7 +798,7 @@ Clears the assert dump (if present): diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.1 b/Documentation/nvme-wdc-clear-fw-activate-history.1 index 92998b91..1ca208f8 100644 --- a/Documentation/nvme-wdc-clear-fw-activate-history.1 +++ b/Documentation/nvme-wdc-clear-fw-activate-history.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-clear-fw-activate-history .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-FW" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLEAR\-FW" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.html b/Documentation/nvme-wdc-clear-fw-activate-history.html index c23cddbd..a4e536ba 100644 --- a/Documentation/nvme-wdc-clear-fw-activate-history.html +++ b/Documentation/nvme-wdc-clear-fw-activate-history.html @@ -797,7 +797,7 @@ Clears the firmware activate history table: diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 index e9791857..5af084a6 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-clear-pcie-correctable-errors .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-PC" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLEAR\-PC" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.html b/Documentation/nvme-wdc-clear-pcie-correctable-errors.html index a7957711..18cdf43e 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.html +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.html @@ -799,7 +799,7 @@ Clears the PCIe Correctable Error Count field returned in the smart-log-add comm diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 b/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 index c7147762..c83dcd27 100644 --- a/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 +++ b/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-cloud-SSD-plugin-version .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLOUD\-SS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLOUD\-SS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.html b/Documentation/nvme-wdc-cloud-SSD-plugin-version.html index 42721484..e7f4c389 100644 --- a/Documentation/nvme-wdc-cloud-SSD-plugin-version.html +++ b/Documentation/nvme-wdc-cloud-SSD-plugin-version.html @@ -790,7 +790,7 @@ Displays the cloud ssd plugin version for the device: diff --git a/Documentation/nvme-wdc-cloud-boot-SSD-version.1 b/Documentation/nvme-wdc-cloud-boot-SSD-version.1 index 34b62899..f32792aa 100644 --- a/Documentation/nvme-wdc-cloud-boot-SSD-version.1 +++ b/Documentation/nvme-wdc-cloud-boot-SSD-version.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-cloud-boot-SSD-version .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLOUD\-BO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLOUD\-BO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-cloud-boot-SSD-version.html b/Documentation/nvme-wdc-cloud-boot-SSD-version.html index 29c00588..6b74cd42 100644 --- a/Documentation/nvme-wdc-cloud-boot-SSD-version.html +++ b/Documentation/nvme-wdc-cloud-boot-SSD-version.html @@ -790,7 +790,7 @@ Displays the cloud boot ssd version for the device: diff --git a/Documentation/nvme-wdc-drive-essentials.1 b/Documentation/nvme-wdc-drive-essentials.1 index 9c5d70fc..924dd5c2 100644 --- a/Documentation/nvme-wdc-drive-essentials.1 +++ b/Documentation/nvme-wdc-drive-essentials.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-drive-essentials .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-DRIVE\-ES" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-DRIVE\-ES" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-drive-essentials.html b/Documentation/nvme-wdc-drive-essentials.html index 618ccbff..91aface1 100644 --- a/Documentation/nvme-wdc-drive-essentials.html +++ b/Documentation/nvme-wdc-drive-essentials.html @@ -757,9 +757,10 @@ nvme-wdc-drive-essentials(1) Manual Page

DESCRIPTION

-

For the NVMe device given, captures the drive essential bin files and saves them into a tar file. -The tar file will be in the following format: DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz - e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz

+

For the NVMe device given, captures the drive essential bin files and saves them +into a tar file. The tar file will be in the following format: +DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz + e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz

The <device> parameter is mandatory; NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

@@ -821,7 +822,7 @@ Gets the drive essentials data files from the device and saves the tar file to s diff --git a/Documentation/nvme-wdc-drive-log.1 b/Documentation/nvme-wdc-drive-log.1 index 0fca5165..e8c80201 100644 --- a/Documentation/nvme-wdc-drive-log.1 +++ b/Documentation/nvme-wdc-drive-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-drive-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-DRIVE\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-DRIVE\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-drive-log.html b/Documentation/nvme-wdc-drive-log.html index d1a44f31..dd16cb92 100644 --- a/Documentation/nvme-wdc-drive-log.html +++ b/Documentation/nvme-wdc-drive-log.html @@ -829,7 +829,7 @@ Gets the drive log from the device and saves to defined file with pathname (e.g. diff --git a/Documentation/nvme-wdc-drive-resize.1 b/Documentation/nvme-wdc-drive-resize.1 index 7fe9e5e3..6fac29b5 100644 --- a/Documentation/nvme-wdc-drive-resize.1 +++ b/Documentation/nvme-wdc-drive-resize.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-drive-resize .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-DRIVE\-RE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-DRIVE\-RE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-drive-resize.html b/Documentation/nvme-wdc-drive-resize.html index b38489c4..da4d3276 100644 --- a/Documentation/nvme-wdc-drive-resize.html +++ b/Documentation/nvme-wdc-drive-resize.html @@ -810,7 +810,7 @@ Has the program issue WDC Resize Vendor Unique Command : diff --git a/Documentation/nvme-wdc-enc-get-log.1 b/Documentation/nvme-wdc-enc-get-log.1 index 02110aa4..5570b65d 100644 --- a/Documentation/nvme-wdc-enc-get-log.1 +++ b/Documentation/nvme-wdc-enc-get-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-enc-get-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-ENC\-GET\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-ENC\-GET\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,9 @@ nvme-wdc-enc-get-log \- Send NVMe WDC enc\-get\-log Vendor Unique Command, retur .SH "SYNOPSIS" .sp .nf -\fInvme wdc enc\-get\-log\fR [\-\-log\-id=, \-l ] [\-\-output\-file=, \-o ] [\-\-transfer\-size=, \-s ] +\fInvme wdc enc\-get\-log\fR [\-\-log\-id=, \-l ] + [\-\-output\-file=, \-o ] + [\-\-transfer\-size=, \-s ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-wdc-enc-get-log.html b/Documentation/nvme-wdc-enc-get-log.html index 5eae1d36..9d9f600a 100644 --- a/Documentation/nvme-wdc-enc-get-log.html +++ b/Documentation/nvme-wdc-enc-get-log.html @@ -749,7 +749,9 @@ nvme-wdc-enc-get-log(1) Manual Page

SYNOPSIS

-
nvme wdc enc-get-log <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+
nvme wdc enc-get-log <device> [--log-id=<NUM>, -l <NUM>]
+                        [--output-file=<FILE>, -o <FILE>]
+                        [--transfer-size=<SIZE>, -s <SIZE>]
@@ -761,7 +763,8 @@ nvme-wdc-enc-get-log(1) Manual Page output the Enclosure logs.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0).

-

The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.

+

The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, +0xd3, 0xd4, 0xe2 and 0xe4.

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

On success it returns the enclosure log data, error code otherwise.

@@ -779,7 +782,7 @@ Results for any other device are undefined.

- Output file pathname + Output file pathname

@@ -790,7 +793,8 @@ Results for any other device are undefined.

- Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192) + Data retrieval transfer size, maximum transfer size should be 0x2000 + (decimal 8192)

@@ -802,7 +806,8 @@ Results for any other device are undefined.

  • -Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory: +Gets the enclosure log from the device based on the log id(0xd1) with transfer + size(0x2000) and saves to defined file in current directory:

    @@ -832,7 +837,7 @@ Gets the enclosure log from the device based on the log id(0xd2) with default tr diff --git a/Documentation/nvme-wdc-get-crash-dump.1 b/Documentation/nvme-wdc-get-crash-dump.1 index 6959dc17..3fa863f2 100644 --- a/Documentation/nvme-wdc-get-crash-dump.1 +++ b/Documentation/nvme-wdc-get-crash-dump.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-crash-dump .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-CRAS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-CRAS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-get-crash-dump.html b/Documentation/nvme-wdc-get-crash-dump.html index f900b25b..1640d9d4 100644 --- a/Documentation/nvme-wdc-get-crash-dump.html +++ b/Documentation/nvme-wdc-get-crash-dump.html @@ -830,7 +830,7 @@ Gets the crash dump from the device and saves to defined file with pathname (e.g diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.1 b/Documentation/nvme-wdc-get-dev-capabilities-log.1 index 3ad7d997..a6156f56 100644 --- a/Documentation/nvme-wdc-get-dev-capabilities-log.1 +++ b/Documentation/nvme-wdc-get-dev-capabilities-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-dev-capabilities-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-DEV\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-DEV\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,7 @@ nvme-wdc-get-dev-capabilities-log \- Send NVMe WDC get\-dev\-capabilities\-log p .SH "SYNOPSIS" .sp .nf -\fInvme wdc get\-dev\-capabilities\-log\fR [\-\-output\-format= -\-o ] +\fInvme wdc get\-dev\-capabilities\-log\fR [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -46,7 +45,7 @@ This will only work on WDC devices supporting this log page\&. Results for any o On success it returns the parsed device capabilities log page data, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.html b/Documentation/nvme-wdc-get-dev-capabilities-log.html index 6ee46c00..bef5b2e1 100644 --- a/Documentation/nvme-wdc-get-dev-capabilities-log.html +++ b/Documentation/nvme-wdc-get-dev-capabilities-log.html @@ -740,7 +740,7 @@ nvme-wdc-get-dev-capabilities-log(1) Manual Page

    NAME

    nvme-wdc-get-dev-capabilities-log - - Send NVMe WDC get-dev-capabilities-log plugin command, return parsed log output + Send NVMe WDC get-dev-capabilities-log plugin command, return parsed log output

    @@ -749,8 +749,7 @@ nvme-wdc-get-dev-capabilities-log(1) Manual Page

    SYNOPSIS

    -
    nvme wdc get-dev-capabilities-log <device> [--output-format=<normal|json>
--o <normal|json>]
    +
    nvme wdc get-dev-capabilities-log <device> [--output-format=<fmt> | -o <fmt>]
    @@ -774,10 +773,10 @@ code otherwise.

    --o <format> +-o <fmt>
    ---output-format=<format> +--output-format=<fmt>

    @@ -816,7 +815,7 @@ Has the program issue WDC get-dev-capabilities-log plugin command :

    diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1 index 3119b40e..a0a2669b 100644 --- a/Documentation/nvme-wdc-get-drive-status.1 +++ b/Documentation/nvme-wdc-get-drive-status.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-drive-status .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-DRIV" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-DRIV" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-get-drive-status.html b/Documentation/nvme-wdc-get-drive-status.html index 4376b59b..22313e0b 100644 --- a/Documentation/nvme-wdc-get-drive-status.html +++ b/Documentation/nvme-wdc-get-drive-status.html @@ -790,19 +790,19 @@ cellspacing="0" cellpadding="4">
- + - + - + - +

EOL (End of Life) Status

The 3 possible states are : Normal, Read Only, or End of Life.

The 3 possible states are : Normal, Read Only, or End of Life.

Assert Dump Status

The 2 possible states are : Present or Not Present.

The 2 possible states are : Present or Not Present.

Thermal Throttling Status

The 3 possible states are : Off, On, or Unavailable.

The 3 possible states are : Off, On, or Unavailable.

Format Corrupt Reason

The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.

The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.
@@ -836,7 +836,7 @@ Has the program issue WDC get-drive-status command : diff --git a/Documentation/nvme-wdc-get-error-recovery-log.1 b/Documentation/nvme-wdc-get-error-recovery-log.1 index 1d00faeb..b26bfcff 100644 --- a/Documentation/nvme-wdc-get-error-recovery-log.1 +++ b/Documentation/nvme-wdc-get-error-recovery-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-error-recovery-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-ERRO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-ERRO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ This will only work on WDC devices supporting this log page\&. Results for any o On success it returns the parsed error recovery log page data, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-get-error-recovery-log.html b/Documentation/nvme-wdc-get-error-recovery-log.html index 156396bf..79fddf7e 100644 --- a/Documentation/nvme-wdc-get-error-recovery-log.html +++ b/Documentation/nvme-wdc-get-error-recovery-log.html @@ -740,7 +740,7 @@ nvme-wdc-get-error-recovery-log(1) Manual Page

NAME

nvme-wdc-get-error-recovery-log - - Send NVMe WDC get-error-recovery-log plugin command, return parsed log output + Send NVMe WDC get-error-recovery-log plugin command, return parsed log output

@@ -774,10 +774,10 @@ code otherwise.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -816,7 +816,7 @@ Has the program issue WDC get-error-recovery-log plugin command :

diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.1 b/Documentation/nvme-wdc-get-latency-monitor-log.1 index c6425b60..b95c36a5 100644 --- a/Documentation/nvme-wdc-get-latency-monitor-log.1 +++ b/Documentation/nvme-wdc-get-latency-monitor-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-latency-monitor-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-LATE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-LATE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on WDC devices supporting this log page\&. Results for any o On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.html b/Documentation/nvme-wdc-get-latency-monitor-log.html index 20198539..89c3e060 100644 --- a/Documentation/nvme-wdc-get-latency-monitor-log.html +++ b/Documentation/nvme-wdc-get-latency-monitor-log.html @@ -769,10 +769,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -810,7 +810,7 @@ Displays the get latency monitor log for the device:

diff --git a/Documentation/nvme-wdc-get-pfail-dump.1 b/Documentation/nvme-wdc-get-pfail-dump.1 index 054a0c5b..98a826ac 100644 --- a/Documentation/nvme-wdc-get-pfail-dump.1 +++ b/Documentation/nvme-wdc-get-pfail-dump.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-pfail-dump .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-PFAI" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-PFAI" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-get-pfail-dump.html b/Documentation/nvme-wdc-get-pfail-dump.html index 4a9010e7..2776c246 100644 --- a/Documentation/nvme-wdc-get-pfail-dump.html +++ b/Documentation/nvme-wdc-get-pfail-dump.html @@ -832,7 +832,7 @@ Gets the pfail crash dump from the device and saves to defined file with pathnam diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.1 b/Documentation/nvme-wdc-get-unsupported-reqs-log.1 index c9dfaefd..2d5076eb 100644 --- a/Documentation/nvme-wdc-get-unsupported-reqs-log.1 +++ b/Documentation/nvme-wdc-get-unsupported-reqs-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-unsupported-reqs-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-UNSU" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-UNSU" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ This will only work on WDC devices supporting this log page\&. Results for any o On success it returns the parsed unsupported requirements log page data, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.html b/Documentation/nvme-wdc-get-unsupported-reqs-log.html index cd63df17..b8997696 100644 --- a/Documentation/nvme-wdc-get-unsupported-reqs-log.html +++ b/Documentation/nvme-wdc-get-unsupported-reqs-log.html @@ -774,10 +774,10 @@ code otherwise.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -816,7 +816,7 @@ Has the program issue WDC get-unsupported-reqs-log plugin command :

diff --git a/Documentation/nvme-wdc-id-ctrl.1 b/Documentation/nvme-wdc-id-ctrl.1 index 17ecc42d..59db3738 100644 --- a/Documentation/nvme-wdc-id-ctrl.1 +++ b/Documentation/nvme-wdc-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,9 @@ nvme-wdc-id-ctrl \- Send NVMe Identify Controller, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme wdc id\-ctrl\fR [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-H | \-\-human\-readable] - [\-o | \-\-output\-format=] +\fInvme wdc id\-ctrl\fR [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -64,7 +64,7 @@ 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 , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-wdc-id-ctrl.html b/Documentation/nvme-wdc-id-ctrl.html index c423221f..89e71b69 100644 --- a/Documentation/nvme-wdc-id-ctrl.html +++ b/Documentation/nvme-wdc-id-ctrl.html @@ -749,9 +749,9 @@ nvme-wdc-id-ctrl(1) Manual Page

SYNOPSIS

-
nvme wdc id-ctrl <device> [-v | --vendor-specific] [-b | --raw-binary]
-                        [-H | --human-readable]
-                        [-o <fmt> | --output-format=<fmt>]
+
nvme wdc id-ctrl <device> [--vendor-specific | -v] [--raw-binary | -b]
+                        [--human-readable | -H]
+                        [--output-format=<fmt> | -o <fmt>]
@@ -814,15 +814,15 @@ will decode WDC vendor unique portions of the structure.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -856,7 +856,7 @@ fields in a human readable format: diff --git a/Documentation/nvme-wdc-log-page-directory.1 b/Documentation/nvme-wdc-log-page-directory.1 index a81fd04d..5fe1261e 100644 --- a/Documentation/nvme-wdc-log-page-directory.1 +++ b/Documentation/nvme-wdc-log-page-directory.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-log-page-directory .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-LOG\-PAGE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-LOG\-PAGE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns the log page directory information, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-wdc-log-page-directory.html b/Documentation/nvme-wdc-log-page-directory.html index 3f416dec..cdd98331 100644 --- a/Documentation/nvme-wdc-log-page-directory.html +++ b/Documentation/nvme-wdc-log-page-directory.html @@ -758,7 +758,7 @@ nvme-wdc-log-page-directory(1) Manual Page

DESCRIPTION

For the NVMe device given, retrieves the log page directory which contains the list of -log page IDs supported by the drive. The --output-format option will format the output as +log page IDs supported by the drive. The --output-format option will format the output as specified.

The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. @@ -771,10 +771,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -812,7 +812,7 @@ WDC log-page-directory example command :

diff --git a/Documentation/nvme-wdc-namespace-resize.1 b/Documentation/nvme-wdc-namespace-resize.1 index 02468eee..21dbefe5 100644 --- a/Documentation/nvme-wdc-namespace-resize.1 +++ b/Documentation/nvme-wdc-namespace-resize.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-namespace-resize .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-NAMESPACE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-NAMESPACE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,40 +32,26 @@ nvme-wdc-namespace-resize \- Resizes the device\*(Aqs namespace\&. .SH "SYNOPSIS" .sp .nf -\fInvme wdc namespace\-resize\fR [\-\-nsid=, \-n ] [\-\-op_option=, \-o ] +\fInvme wdc namespace\-resize\fR [\-\-nsid=, \-n ] + [\-\-op_option=, \-o ] .fi .SH "DESCRIPTION" .sp -For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&. +For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported the device\&. .sp The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. .sp This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. .SH "OPTIONS" .PP -\-n , \-\-namespace\-id= +\-n , \-\-namespace\-id= .RS 4 Namespace ID; ID of the namespace to resize .RE .PP \-o , \-\-op\-option= .RS 4 -Overprovisioning Option; defaults to 0xF -.sp -.if n \{\ -.RS 4 -.\} -.nf -Valid Values: -0x1 \- 7% of Original TNVMCAP reported value -0x2 \- 28% of Original TNVMCAP reported value -0x3 \- 50% of Original TNVMCAP reported value -0xF \- 0% of Original TNVMCAP reported value (original config) -All other values \- reserved -.fi -.if n \{\ -.RE -.\} +Overprovisioning Option; defaults to 0xF Valid Values: 0x1 \- 7% of Original TNVMCAP reported value 0x2 \- 28% of Original TNVMCAP reported value 0x3 \- 50% of Original TNVMCAP reported value 0xF \- 0% of Original TNVMCAP reported value (original config) All other values \- reserved .RE .SH "EXAMPLES" .sp diff --git a/Documentation/nvme-wdc-namespace-resize.html b/Documentation/nvme-wdc-namespace-resize.html index 1eb751f3..f72873de 100644 --- a/Documentation/nvme-wdc-namespace-resize.html +++ b/Documentation/nvme-wdc-namespace-resize.html @@ -749,7 +749,8 @@ nvme-wdc-namespace-resize(1) Manual Page

SYNOPSIS

-
nvme wdc namespace-resize <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>] [--op_option=<OP OPTION>, -o <OP OPTION>]
+
nvme wdc namespace-resize <device> [--nsid=<NAMESPACE ID>, -n <NAMSPACE ID>]
+                        [--op_option=<OP OPTION>, -o <OP OPTION>]
@@ -757,8 +758,8 @@ nvme-wdc-namespace-resize(1) Manual Page

DESCRIPTION

-

For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported -by the device.

+

For the NVMe device given, sends the WDC Vendor Specific Command that modifies +the namespace size reported the device.

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

@@ -769,10 +770,10 @@ Results for any other device are undefined.

--n <NAMSPACE ID> +-n <NAMESPACE ID>
---namespace-id=<NAMSPACE_ID> +--namespace-id=<NAMESPACE_ID>

@@ -787,17 +788,14 @@ Results for any other device are undefined.

- Overprovisioning Option; defaults to 0xF + Overprovisioning Option; defaults to 0xF + Valid Values: + 0x1 - 7% of Original TNVMCAP reported value + 0x2 - 28% of Original TNVMCAP reported value + 0x3 - 50% of Original TNVMCAP reported value + 0xF - 0% of Original TNVMCAP reported value (original config) + All other values - reserved

-
-
-
Valid Values:
-0x1 - 7% of Original TNVMCAP reported value
-0x2 - 28% of Original TNVMCAP reported value
-0x3 - 50% of Original TNVMCAP reported value
-0xF - 0% of Original TNVMCAP reported value (original config)
-All other values - reserved
-
@@ -838,7 +836,7 @@ Resizes namespace 2 to 7% of the original TNVMCAP reported value: diff --git a/Documentation/nvme-wdc-purge-monitor.1 b/Documentation/nvme-wdc-purge-monitor.1 index dc8612b5..8823018a 100644 --- a/Documentation/nvme-wdc-purge-monitor.1 +++ b/Documentation/nvme-wdc-purge-monitor.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-purge-monitor .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-PURGE\-MO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-PURGE\-MO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-purge-monitor.html b/Documentation/nvme-wdc-purge-monitor.html index c3fb22e1..11848e9b 100644 --- a/Documentation/nvme-wdc-purge-monitor.html +++ b/Documentation/nvme-wdc-purge-monitor.html @@ -837,7 +837,7 @@ Has the program issue WDC Purge-Monitor Vendor Unique Command : diff --git a/Documentation/nvme-wdc-purge.1 b/Documentation/nvme-wdc-purge.1 index 5a790472..a41b5f08 100644 --- a/Documentation/nvme-wdc-purge.1 +++ b/Documentation/nvme-wdc-purge.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-purge .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-PURGE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-PURGE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-purge.html b/Documentation/nvme-wdc-purge.html index 9597d3d6..52cd5a18 100644 --- a/Documentation/nvme-wdc-purge.html +++ b/Documentation/nvme-wdc-purge.html @@ -799,7 +799,7 @@ Has the program issue WDC Purge Vendor Unique Command : diff --git a/Documentation/nvme-wdc-vs-cloud-log.1 b/Documentation/nvme-wdc-vs-cloud-log.1 index df71f005..310206b2 100644 --- a/Documentation/nvme-wdc-vs-cloud-log.1 +++ b/Documentation/nvme-wdc-vs-cloud-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-cloud-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-CLOUD" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-CLOUD" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-cloud-log.html b/Documentation/nvme-wdc-vs-cloud-log.html index 7eae4da9..4b36fa04 100644 --- a/Documentation/nvme-wdc-vs-cloud-log.html +++ b/Documentation/nvme-wdc-vs-cloud-log.html @@ -772,10 +772,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -828,7 +828,7 @@ Has the program issue WDC vs-cloud-log Vendor Unique Command :

diff --git a/Documentation/nvme-wdc-vs-device-waf.1 b/Documentation/nvme-wdc-vs-device-waf.1 index 4e898a2a..b0bdd192 100644 --- a/Documentation/nvme-wdc-vs-device-waf.1 +++ b/Documentation/nvme-wdc-vs-device-waf.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-device-waf .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-DEVIC" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-DEVIC" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-device-waf.html b/Documentation/nvme-wdc-vs-device-waf.html index 73baeae8..542e031e 100644 --- a/Documentation/nvme-wdc-vs-device-waf.html +++ b/Documentation/nvme-wdc-vs-device-waf.html @@ -772,10 +772,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -828,7 +828,7 @@ Has the program issue WDC vs-device-waf plugin Command :

diff --git a/Documentation/nvme-wdc-vs-drive-info.1 b/Documentation/nvme-wdc-vs-drive-info.1 index 08ae9c75..c96e98ff 100644 --- a/Documentation/nvme-wdc-vs-drive-info.1 +++ b/Documentation/nvme-wdc-vs-drive-info.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-drive-info .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-DRIVE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-DRIVE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-vs-drive-info.html b/Documentation/nvme-wdc-vs-drive-info.html index ed6e1fe7..414f2528 100644 --- a/Documentation/nvme-wdc-vs-drive-info.html +++ b/Documentation/nvme-wdc-vs-drive-info.html @@ -795,7 +795,7 @@ on the drive:

diff --git a/Documentation/nvme-wdc-vs-error-reason-identifier.1 b/Documentation/nvme-wdc-vs-error-reason-identifier.1 index 33ed0aef..eb7c36fb 100644 --- a/Documentation/nvme-wdc-vs-error-reason-identifier.1 +++ b/Documentation/nvme-wdc-vs-error-reason-identifier.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-error-reason-identifier .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-ERROR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-ERROR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-vs-error-reason-identifier.html b/Documentation/nvme-wdc-vs-error-reason-identifier.html index 56f64e6a..375cf324 100644 --- a/Documentation/nvme-wdc-vs-error-reason-identifier.html +++ b/Documentation/nvme-wdc-vs-error-reason-identifier.html @@ -758,7 +758,7 @@ nvme-wdc-vs-error-reason-identifier(1) Manual Page

DESCRIPTION

For the NVMe device given, retrieve the telemetry log error reason id field for either the host generated or -controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the +controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the error reason id for that log page id.

The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. @@ -836,7 +836,7 @@ Retrieves the controller initiated error reason identifier field and save it in

diff --git a/Documentation/nvme-wdc-vs-fw-activate-history.1 b/Documentation/nvme-wdc-vs-fw-activate-history.1 index 305f5ba8..f9e706ff 100644 --- a/Documentation/nvme-wdc-vs-fw-activate-history.1 +++ b/Documentation/nvme-wdc-vs-fw-activate-history.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-fw-activate-history .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-FW\-A" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-FW\-A" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-fw-activate-history.html b/Documentation/nvme-wdc-vs-fw-activate-history.html index b9d997af..e8fd432e 100644 --- a/Documentation/nvme-wdc-vs-fw-activate-history.html +++ b/Documentation/nvme-wdc-vs-fw-activate-history.html @@ -770,10 +770,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -805,7 +805,7 @@ cellspacing="0" cellpadding="4">

Entry Number

-

The number of fw activate entry. The most recent 20 entries will be displayed.

+

The number of fw activate entry. The most recent 20 entries will be displayed.

Power on Hour

@@ -833,7 +833,7 @@ cellspacing="0" cellpadding="4">

Result

-

The result of the firmware activation event. The output shall be in the format: +

The result of the firmware activation event. The output shall be in the format: Pass or Failed + error code

@@ -868,7 +868,7 @@ Has the program issue WDC vs-fw-activate-history Vendor Unique Command : diff --git a/Documentation/nvme-wdc-vs-hw-rev-log.1 b/Documentation/nvme-wdc-vs-hw-rev-log.1 index 1ea7cbdd..2587e1a5 100644 --- a/Documentation/nvme-wdc-vs-hw-rev-log.1 +++ b/Documentation/nvme-wdc-vs-hw-rev-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-hw-rev-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-HW\-R" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-HW\-R" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-hw-rev-log.html b/Documentation/nvme-wdc-vs-hw-rev-log.html index 7bcd3039..954a4cf4 100644 --- a/Documentation/nvme-wdc-vs-hw-rev-log.html +++ b/Documentation/nvme-wdc-vs-hw-rev-log.html @@ -771,10 +771,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -827,7 +827,7 @@ Has the program issue WDC vs-hw-rev-log plugin Command :

diff --git a/Documentation/nvme-wdc-vs-internal-log.1 b/Documentation/nvme-wdc-vs-internal-log.1 index 138064db..597d283f 100644 --- a/Documentation/nvme-wdc-vs-internal-log.1 +++ b/Documentation/nvme-wdc-vs-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-INTER" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-INTER" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,12 @@ nvme-wdc-vs-internal-log \- Retrieve WDC device\*(Aqs internal firmware log and .SH "SYNOPSIS" .sp .nf -\fInvme wdc vs\-internal\-log\fR [\-\-output\-file=, \-o ] [\-\-transfer\-size=, \-s ] - [\-\-data\-area=, \-d ] [\-\-file\-size=, \-f ] [\-\-offset=, \-e ] - [\-\-type=, \-t ] [\-\-verbose, \-v] +\fInvme wdc vs\-internal\-log\fR [\-\-output\-file=, \-o ] + [\-\-transfer\-size=, \-s ] + [\-\-data\-area=, \-d ] + [\-\-file\-size=, \-f ] + [\-\-offset=, \-e ] + [\-\-type=, \-t ] [\-\-verbose, \-v] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-wdc-vs-internal-log.html b/Documentation/nvme-wdc-vs-internal-log.html index f7c0e0a8..06f48f7a 100644 --- a/Documentation/nvme-wdc-vs-internal-log.html +++ b/Documentation/nvme-wdc-vs-internal-log.html @@ -749,9 +749,12 @@ nvme-wdc-vs-internal-log(1) Manual Page

SYNOPSIS

-
nvme wdc vs-internal-log <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
-    [--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -e <OFFSET>]
-    [--type=<TYPE>, -t <type>] [--verbose, -v]
+
nvme wdc vs-internal-log <device> [--output-file=<FILE>, -o <FILE>]
+                        [--transfer-size=<SIZE>, -s <SIZE>]
+                        [--data-area=<DATA AREA>, -d <DATA_AREA>]
+                        [--file-size=<FILE SIZE>, -f <FILE SIZE>]
+                        [--offset=<OFFSET>, -e <OFFSET>]
+                        [--type=<TYPE>, -t <type>] [--verbose, -v]
@@ -759,8 +762,8 @@ nvme-wdc-vs-internal-log(1) Manual Page

DESCRIPTION

-

For the NVMe device given, sends the WDC Vendor Specific Internal Log request and saves -the result to a file.

+

For the NVMe device given, sends the WDC Vendor Specific Internal Log request +and saves the result to a file.

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

@@ -778,7 +781,8 @@ Results for any other device are undefined.

- Output file; defaults to device serial number followed by "internal_fw_log<date>_<time>.bin" suffix + Output file; defaults to device serial number followed by + "internal_fw_log<date>_<time>.bin" suffix

@@ -789,7 +793,7 @@ Results for any other device are undefined.

- Transfer size; defaults to 0x10000 (65536 decimal) bytes + Transfer size; defaults to 0x10000 (65536 decimal) bytes

@@ -800,8 +804,9 @@ Results for any other device are undefined.

- DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will be retrieved. This parameter - is currently only supported on the SN340, SN640, SN730, and SN840 devices. + DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will + be retrieved. This parameter is currently only supported on the SN340, + SN640, SN730, and SN840 devices.

@@ -812,9 +817,10 @@ Results for any other device are undefined.

- Specifies the desired size of the data file starting at the passed in offset. This allows the user to - retrieve the data in several smaller files of the passed in size. This parameter is currently only - supported on the SN340 device. + Specifies the desired size of the data file starting at the passed in + offset. This allows the user to retrieve the data in several smaller + files of the passed in size. This parameter is currently only supported + on the SN340 device.

@@ -825,9 +831,10 @@ Results for any other device are undefined.

- Specifies the data offset at which to start retrieving the data. This parameter is used in combination - with the file size parameter to retrieve the data in several smaller files. This parameter is currently - only supported on the SN340 device. + Specifies the data offset at which to start retrieving the data. This + parameter is used in combination with the file size parameter to + retrieve the data in several smaller files. This parameter is currently + only supported on the SN340 device.

@@ -838,10 +845,11 @@ Results for any other device are undefined.

- Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter is used to get either the host - generated or controller initiated telemetry log page. If not specified or none is specified, the command - will return the default E6 log data. This parameter is currently only supported on the SN640 and SN840 - devices. + Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter + is used to get either the host generated or controller initiated + telemetry log page. If not specified or none is specified, the command + will return the default E6 log data. This parameter is currently only + supported on the SN640 and SN840 devices.

@@ -950,7 +958,7 @@ Gets the controller telemetry log page to data area 3 from the device and stores diff --git a/Documentation/nvme-wdc-vs-nand-stats.1 b/Documentation/nvme-wdc-vs-nand-stats.1 index a16f9a24..9560eea2 100644 --- a/Documentation/nvme-wdc-vs-nand-stats.1 +++ b/Documentation/nvme-wdc-vs-nand-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-nand-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-NAND\" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-NAND\" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ This will only work on WDC devices supporting this feature\&. Results for any ot On success it returns the NAND statistics, error code otherwise\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-nand-stats.html b/Documentation/nvme-wdc-vs-nand-stats.html index f3547110..b2879a08 100644 --- a/Documentation/nvme-wdc-vs-nand-stats.html +++ b/Documentation/nvme-wdc-vs-nand-stats.html @@ -772,10 +772,10 @@ Results for any other device are undefined.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -814,7 +814,7 @@ Has the program issue WDC vs-nand-stats Vendor Unique Command :

diff --git a/Documentation/nvme-wdc-vs-smart-add-log.1 b/Documentation/nvme-wdc-vs-smart-add-log.1 index e9551629..0269b854 100644 --- a/Documentation/nvme-wdc-vs-smart-add-log.1 +++ b/Documentation/nvme-wdc-vs-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-SMART" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-SMART" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -54,7 +54,7 @@ On success it returns 0, error code otherwise\&. Return the statistics from specific interval, defaults to 14\&. This parameter is only valid for the 0xC1 log page and ignored for all other log pages\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, or diff --git a/Documentation/nvme-wdc-vs-smart-add-log.html b/Documentation/nvme-wdc-vs-smart-add-log.html index 1c204dd0..27c9843c 100644 --- a/Documentation/nvme-wdc-vs-smart-add-log.html +++ b/Documentation/nvme-wdc-vs-smart-add-log.html @@ -782,15 +782,16 @@ Results for any other device are undefined.

- Return the statistics from specific interval, defaults to 14. This parameter is only valid for the 0xC1 log page - and ignored for all other log pages. + Return the statistics from specific interval, defaults to 14. This + parameter is only valid for the 0xC1 log page and ignored for all other + log pages.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

@@ -807,8 +808,8 @@ Results for any other device are undefined.

- Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for the 0xC0 log page and ignored for all - other log pages. + Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for + the 0xC0 log page and ignored for all other log pages.

@@ -819,10 +820,10 @@ Results for any other device are undefined.

- Supply a comma separated list of desired log pages to display. - The possible values are 0xc0, 0xc1, 0xca, 0xd0. - Note: Not all pages are supported on all drives. - The default is to display all supported log pages. + Supply a comma separated list of desired log pages to display. + The possible values are 0xc0, 0xc1, 0xca, 0xd0. + Note: Not all pages are supported on all drives. + The default is to display all supported log pages.

@@ -927,7 +928,7 @@ Has the program issue WDC vs-smart-add-log Vendor Unique Command for 0xC0 and 0x diff --git a/Documentation/nvme-wdc-vs-telemetry-controller-option.1 b/Documentation/nvme-wdc-vs-telemetry-controller-option.1 index e5f4dccd..8339b828 100644 --- a/Documentation/nvme-wdc-vs-telemetry-controller-option.1 +++ b/Documentation/nvme-wdc-vs-telemetry-controller-option.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-telemetry-controller-option .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-TELEM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-TELEM" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,12 +32,12 @@ nvme-wdc-vs-telemetry-controller-option \- Disable/Enable the controller initiat .SH "SYNOPSIS" .sp .nf -\fInvme wdc vs\-telemetry\-controller\-option\fR [\-\-disable, \-d] [\-\-enable, \-e] - [\-\-status, \-s] +\fInvme wdc vs\-telemetry\-controller\-option\fR + [\-\-disable, \-d] [\-\-enable, \-e] [\-\-status, \-s] .fi .SH "DESCRIPTION" .sp -For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status of the controller initiated option of the telemetry log page\&. +For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status the controller initiated option of the telemetry log page\&. .sp The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. .sp diff --git a/Documentation/nvme-wdc-vs-telemetry-controller-option.html b/Documentation/nvme-wdc-vs-telemetry-controller-option.html index 2593a945..40b93b29 100644 --- a/Documentation/nvme-wdc-vs-telemetry-controller-option.html +++ b/Documentation/nvme-wdc-vs-telemetry-controller-option.html @@ -749,8 +749,8 @@ nvme-wdc-vs-telemetry-controller-option(1) Manual Page

SYNOPSIS

-
nvme wdc vs-telemetry-controller-option <device> [--disable, -d] [--enable, -e]
-    [--status, -s]
+
nvme wdc vs-telemetry-controller-option <device>
+                        [--disable, -d] [--enable, -e] [--status, -s]
@@ -758,8 +758,9 @@ nvme-wdc-vs-telemetry-controller-option(1) Manual Page

DESCRIPTION

-

For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status -of the controller initiated option of the telemetry log page.

+

For the NVMe device given, sends the WDC Vendor Specific set feature command to +disable, enable or get current status the controller initiated option of the +telemetry log page.

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

@@ -799,7 +800,8 @@ Results for any other device are undefined.

- Returns the current status (enabled or disabled) of the controller initiated option of the telemetry log page. + Returns the current status (enabled or disabled) of the controller + initiated option of the telemetry log page.

@@ -853,7 +855,7 @@ Gets the current status (enabled or disabled) of the controller initiated option diff --git a/Documentation/nvme-wdc-vs-temperature-stats.1 b/Documentation/nvme-wdc-vs-temperature-stats.1 index 4a3ffc32..98c27297 100644 --- a/Documentation/nvme-wdc-vs-temperature-stats.1 +++ b/Documentation/nvme-wdc-vs-temperature-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-vs-temperature-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-TEMPE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-TEMPE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-vs-temperature-stats.html b/Documentation/nvme-wdc-vs-temperature-stats.html index 775305e4..8aadc46b 100644 --- a/Documentation/nvme-wdc-vs-temperature-stats.html +++ b/Documentation/nvme-wdc-vs-temperature-stats.html @@ -857,7 +857,7 @@ Displays the temperature stats for the device: diff --git a/Documentation/nvme-write-uncor.1 b/Documentation/nvme-write-uncor.1 index b7e0efe5..0c9843dd 100644 --- a/Documentation/nvme-write-uncor.1 +++ b/Documentation/nvme-write-uncor.1 @@ -2,12 +2,12 @@ .\" Title: nvme-uncor .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-UNCOR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-UNCOR" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -37,23 +37,24 @@ nvme-write-uncor \- Send an NVMe write uncorrectable command, return results [\-\-namespace\-id= | \-n ] [\-\-dir\-type= | \-T ] [\-\-dir\-spec= | \-S ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Write Uncorrectable command is used to invalidate a range of logical blocks\&. .SH "OPTIONS" .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block\&. .RE .PP -\-\-block\-count=, \-c +\-c, \-\-block\-count= .RS 4 Number of logical blocks to write uncorrectable\&. .RE .PP -\-\-namespace\-id=, \-n +\-n , \-\-namespace\-id= .RS 4 Namespace ID use in the command\&. .RE @@ -67,6 +68,20 @@ Directive type .RS 4 Directive specific .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-write-uncor.html b/Documentation/nvme-write-uncor.html index dd6d6e0d..7348c5e3 100644 --- a/Documentation/nvme-write-uncor.html +++ b/Documentation/nvme-write-uncor.html @@ -753,7 +753,8 @@ nvme-uncor(1) Manual Page [--block-count=<nlb> | -c <nlb>] [--namespace-id=<nsid> | -n <nsid>] [--dir-type=<dtype> | -T <dtype>] - [--dir-spec=<dspec> | -S <dspec>] + [--dir-spec=<dspec> | -S <dspec>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -770,10 +771,10 @@ blocks.

---start-block=<slba> +-s <slba>
--s <slba> +--start-block=<slba>

@@ -781,10 +782,10 @@ blocks.

---block-count=<nlb> +-c
--c +--block-count=<nlb>

@@ -792,10 +793,10 @@ blocks.

---namespace-id=<nsid> +-n <nsid>
--n <nsid> +--namespace-id=<nsid>

@@ -824,6 +825,29 @@ blocks.

Directive specific

+
+-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. +

+
@@ -844,7 +868,7 @@ blocks.

diff --git a/Documentation/nvme-write-zeroes.1 b/Documentation/nvme-write-zeroes.1 index 0ec2964c..99e03293 100644 --- a/Documentation/nvme-write-zeroes.1 +++ b/Documentation/nvme-write-zeroes.1 @@ -2,12 +2,12 @@ .\" Title: nvme-write-zeroes .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE\-ZEROES" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE\-ZEROES" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -37,32 +37,31 @@ nvme-write-zeroes \- Send an NVMe write zeroes command, return results [\-\-ref\-tag= | \-r ] [\-\-prinfo= | \-p ] [\-\-app\-tag\-mask= | \-m ] - [\-\-app\-tag= | \-a ] - [\-\-deac | \-d] - [\-\-limited\-retry | \-l] - [\-\-force\-unit\-access | \-f] + [\-\-app\-tag= | \-a ] [\-\-deac | \-d] + [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-namespace\-id= | \-n ] [\-\-storage\-tag | \-S ] [\-\-storage\-tag\-check | \-C ] [\-\-dir\-type= | \-T ] [\-\-dir\-spec= | \-D ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Write Zeroes command is used to set a range of logical blocks to 0\&. .SH "OPTIONS" .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block\&. .RE .PP -\-\-block\-count=, \-c +\-c , \-\-block\-count= .RS 4 Number of logical blocks to write zeroes\&. .RE .PP -\-\-prinfo=, \-p +\-p , \-\-prinfo= .RS 4 Protection Information field definition\&. .TS @@ -107,47 +106,47 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=, \-m +\-m , \-\-app\-tag\-mask= .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=, \-a +\-a , \-\-app\-tag= .RS 4 Optional application tag when used with protection information\&. .RE .PP -\-\-limited\-retry, \-l +\-l, \-\-limited\-retry .RS 4 Sets the limited retry flag\&. .RE .PP -\-\-deac, \-d +\-d, \-\-deac .RS 4 Sets the DEAC bit, requesting controller deallocate the logical blocks\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE .PP -\-\-namespace\-id=, \-n +\-n , \-\-namespace\-id= .RS 4 Namespace ID use in the command\&. .RE .PP -\-\-storage\-tag=, \-S +\-S , \-\-storage\-tag= .RS 4 Variable Sized Logical Block Storage Tag(LBST)\&. .RE .PP -\-\-storage\-tag\-check=, \-C +\-C , \-\-storage\-tag\-check= .RS 4 This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&. .RE @@ -161,6 +160,20 @@ Directive type .RS 4 Directive specific .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-write-zeroes.html b/Documentation/nvme-write-zeroes.html index 65293cb0..91457cc2 100644 --- a/Documentation/nvme-write-zeroes.html +++ b/Documentation/nvme-write-zeroes.html @@ -754,15 +754,14 @@ nvme-write-zeroes(1) Manual Page [--ref-tag=<reftag> | -r <reftag>] [--prinfo=<prinfo> | -p <prinfo>] [--app-tag-mask=<appmask> | -m <appmask>] - [--app-tag=<apptag> | -a <apptag>] - [--deac | -d] - [--limited-retry | -l] - [--force-unit-access | -f] + [--app-tag=<apptag> | -a <apptag>] [--deac | -d] + [--limited-retry | -l] [--force-unit-access | -f] [--namespace-id=<nsid> | -n <nsid>] [--storage-tag<storage-tag> | -S <storage-tag>] [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>] [--dir-type=<dtype> | -T <dtype>] - [--dir-spec=<dspec> | -D <dspec>] + [--dir-spec=<dspec> | -D <dspec>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -778,10 +777,10 @@ nvme-write-zeroes(1) Manual Page
---start-block=<slba> +-s <slba>
--s <slba> +--start-block=<slba>

@@ -789,10 +788,10 @@ nvme-write-zeroes(1) Manual Page

---block-count=<nlb> +-c <nlb>
--c <nlb> +--block-count=<nlb>

@@ -800,10 +799,10 @@ nvme-write-zeroes(1) Manual Page

---prinfo=<prinfo> +-p <prinfo>
--p <prinfo> +--prinfo=<prinfo>

@@ -848,10 +847,10 @@ metadata is passes.

---ref-tag=<reftag> +-r <reftag>
--r <reftag> +--ref-tag=<reftag>

@@ -859,10 +858,10 @@ metadata is passes.

---app-tag-mask=<appmask> +-m <appmask>
--m <appmask> +--app-tag-mask=<appmask>

@@ -870,10 +869,10 @@ metadata is passes.

---app-tag=<apptag> +-a <apptag>
--a <apptag> +--app-tag=<apptag>

@@ -881,10 +880,10 @@ metadata is passes.

---limited-retry +-l
--l +--limited-retry

@@ -892,10 +891,10 @@ metadata is passes.

---deac +-d
--d +--deac

@@ -903,10 +902,10 @@ metadata is passes.

---force-unit-access +-f
--f +--force-unit-access

@@ -914,10 +913,10 @@ metadata is passes.

---namespace-id=<nsid> +-n <nsid>
--n <nsid> +--namespace-id=<nsid>

@@ -925,10 +924,10 @@ metadata is passes.

---storage-tag=<storage-tag> +-S <storage-tag>
--S <storage-tag> +--storage-tag=<storage-tag>

@@ -936,10 +935,10 @@ metadata is passes.

---storage-tag-check=<storage-tag-check> +-C <storage-tag-check>
--C <storage-tag-check> +--storage-tag-check=<storage-tag-check>

@@ -969,6 +968,29 @@ metadata is passes.

Directive specific

+
+-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. +

+
@@ -989,7 +1011,7 @@ metadata is passes.

diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1 index 867524ee..9d33f58d 100644 --- a/Documentation/nvme-write.1 +++ b/Documentation/nvme-write.1 @@ -2,12 +2,12 @@ .\" Title: nvme-write .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,54 +42,50 @@ nvme-write \- Send an NVMe write command, provide results [\-\-prinfo= | \-p ] [\-\-app\-tag\-mask= | \-m ] [\-\-app\-tag= | \-a ] - [\-\-limited\-retry | \-l] - [\-\-force\-unit\-access | \-f] + [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-dir\-type= | \-T ] - [\-\-dir\-spec= | \-S ] - [\-\-dsm= | \-D ] - [\-\-show\-command | \-v] - [\-\-dry\-run | \-w] - [\-\-latency | \-t] + [\-\-dir\-spec= | \-S ] [\-\-dsm= | \-D ] + [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t] [\-\-storage\-tag | \-g ] - [\-\-storage\-tag\-check | \-C] - [\-\-force] + [\-\-storage\-tag\-check | \-C] [\-\-force] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Write command writes the logical blocks specified by the command to the medium from the data data buffer provided\&. Will use stdin by default if you don\(cqt provide a file\&. .SH "OPTIONS" .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block\&. .RE .PP -\-\-block\-count, \-c +\-c, \-\-block\-count .RS 4 The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&. .RE .PP -\-\-data\-size=, \-z +\-z , \-\-data\-size= .RS 4 Size of data, in bytes\&. .RE .PP -\-\-metadata\-size=, \-y +\-y , \-\-metadata\-size= .RS 4 Size of metadata in bytes\&. .RE .PP -\-\-data=, \-d +\-d , \-\-data= .RS 4 Data file\&. If none provided, contents are sent from STDIN\&. .RE .PP -\-\-metadata=, \-M +\-M , \-\-metadata= .RS 4 Metadata file, if necessary\&. .RE .PP -\-\-prinfo=, \-p +\-p , \-\-prinfo= .RS 4 Protection Information field definition\&. .TS @@ -134,27 +130,27 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=, \-m +\-m , \-\-app\-tag\-mask= .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=, \-a +\-a , \-\-app\-tag= .RS 4 Optional application tag when used with protection information\&. .RE .PP -\-\-limited\-retry, \-l +\-l, \-\-limited\-retry .RS 4 Sets the limited retry flag\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE @@ -174,7 +170,7 @@ Optional field for directive specifics\&. When used with write streams, this val The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&. .RE .PP -\-v, \-\-show\-cmd +\-V, \-\-show\-cmd .RS 4 Print out the command to be sent\&. .RE @@ -206,6 +202,20 @@ This flag enables Storage Tag field checking as part of end\-to\-end data protec .RS 4 Ignore namespace is currently busy and performed the operation even though\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\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 No examples yet\&. diff --git a/Documentation/nvme-write.html b/Documentation/nvme-write.html index ed44f0d4..0401a52f 100644 --- a/Documentation/nvme-write.html +++ b/Documentation/nvme-write.html @@ -759,17 +759,13 @@ nvme-write(1) Manual Page [--prinfo=<prinfo> | -p <prinfo>] [--app-tag-mask=<appmask> | -m <appmask>] [--app-tag=<apptag> | -a <apptag>] - [--limited-retry | -l] - [--force-unit-access | -f] + [--limited-retry | -l] [--force-unit-access | -f] [--dir-type=<type> | -T <type>] - [--dir-spec=<spec> | -S <spec>] - [--dsm=<dsm> | -D <dsm>] - [--show-command | -v] - [--dry-run | -w] - [--latency | -t] + [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag<storage-tag> | -g <storage-tag>] - [--storage-tag-check | -C] - [--force] + [--storage-tag-check | -C] [--force] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -787,10 +783,10 @@ if you don’t provide a file.

---start-block=<slba> +-s <slba>
--s <slba> +--start-block=<slba>

@@ -798,10 +794,10 @@ if you don’t provide a file.

---block-count +-c
--c +--block-count

@@ -811,10 +807,10 @@ if you don’t provide a file.

---data-size=<size> +-z <size>
--z <size> +--data-size=<size>

@@ -822,10 +818,10 @@ if you don’t provide a file.

---metadata-size=<size> +-y <size>
--y <size> +--metadata-size=<size>

@@ -833,10 +829,10 @@ if you don’t provide a file.

---data=<data-file> +-d <data-file>
--d <data-file> +--data=<data-file>

@@ -844,10 +840,10 @@ if you don’t provide a file.

---metadata=<metadata-file> +-M <metadata-file>
--M <metadata-file> +--metadata=<metadata-file>

@@ -855,10 +851,10 @@ if you don’t provide a file.

---prinfo=<prinfo> +-p <prinfo>
--p <prinfo> +--prinfo=<prinfo>

@@ -903,10 +899,10 @@ metadata is passes.

---ref-tag=<reftag> +-r <reftag>
--r <reftag> +--ref-tag=<reftag>

@@ -914,10 +910,10 @@ metadata is passes.

---app-tag-mask=<appmask> +-m <appmask>
--m <appmask> +--app-tag-mask=<appmask>

@@ -925,10 +921,10 @@ metadata is passes.

---app-tag=<apptag> +-a <apptag>
--a <apptag> +--app-tag=<apptag>

@@ -936,10 +932,10 @@ metadata is passes.

---limited-retry +-l
--l +--limited-retry

@@ -947,10 +943,10 @@ metadata is passes.

---force-unit-access +-f
--f +--force-unit-access

@@ -1004,7 +1000,7 @@ metadata is passes.

--v +-V
--show-cmd @@ -1066,8 +1062,31 @@ metadata is passes.

- Ignore namespace is currently busy and performed the operation - even though. + Ignore namespace is currently busy and performed the operation + even though. +

+
+
+-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.

@@ -1090,7 +1109,7 @@ metadata is passes.

diff --git a/Documentation/nvme-zns-changed-zone-list.1 b/Documentation/nvme-zns-changed-zone-list.1 index 1aaec89c..76b36cc8 100644 --- a/Documentation/nvme-zns-changed-zone-list.1 +++ b/Documentation/nvme-zns-changed-zone-list.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-changed-zone-list .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-CHANGED\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-CHANGED\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-zns-changed-zone-list \- Retrieve Changed Zone log for the given device .SH "SYNOPSIS" .sp .nf -\fInvme zns changed\-zone\-list\fR [\-o | \-\-output\-format=] - [\-\-namespace\-id= | \-n ] - [\-\-rae | \-r] +\fInvme zns changed\-zone\-list\fR [\-\-output\-format= | \-o ] + [\-\-namespace\-id= | \-n ] [\-\-rae | \-r] .fi .SH "DESCRIPTION" .sp @@ -45,7 +44,7 @@ The parameter is mandatory and may be either the NVMe character device On success, the returned list may be decoded and displayed in one of several ways\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-zns-changed-zone-list.html b/Documentation/nvme-zns-changed-zone-list.html index befb331c..65fac118 100644 --- a/Documentation/nvme-zns-changed-zone-list.html +++ b/Documentation/nvme-zns-changed-zone-list.html @@ -749,9 +749,8 @@ nvme-zns-changed-zone-list(1) Manual Page

SYNOPSIS

-
nvme zns changed-zone-list <device> [-o <fmt> | --output-format=<fmt>]
-                                      [--namespace-id=<NUM> | -n <NUM>]
-                                      [--rae | -r]
+
nvme zns changed-zone-list <device> [--output-format=<fmt> | -o <fmt>]
+                        [--namespace-id=<NUM> | -n <NUM>] [--rae | -r]
@@ -772,15 +771,15 @@ ways.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -833,7 +832,7 @@ Show the output in json format diff --git a/Documentation/nvme-zns-close-zone.1 b/Documentation/nvme-zns-close-zone.1 index 9b939d9a..351a1bbb 100644 --- a/Documentation/nvme-zns-close-zone.1 +++ b/Documentation/nvme-zns-close-zone.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-close-zone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-zns-close-zone.html b/Documentation/nvme-zns-close-zone.html index 67c01782..57fc033a 100644 --- a/Documentation/nvme-zns-close-zone.html +++ b/Documentation/nvme-zns-close-zone.html @@ -846,7 +846,7 @@ Close all zones on namespace 1: diff --git a/Documentation/nvme-zns-finish-zone.1 b/Documentation/nvme-zns-finish-zone.1 index 82e631f7..6ecc4b96 100644 --- a/Documentation/nvme-zns-finish-zone.1 +++ b/Documentation/nvme-zns-finish-zone.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-finish-zone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-FINISH\-Z" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-FINISH\-Z" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-zns-finish-zone.html b/Documentation/nvme-zns-finish-zone.html index be00fcde..547c4a5c 100644 --- a/Documentation/nvme-zns-finish-zone.html +++ b/Documentation/nvme-zns-finish-zone.html @@ -847,7 +847,7 @@ Finish all zones on namespace 1: diff --git a/Documentation/nvme-zns-id-ctrl.1 b/Documentation/nvme-zns-id-ctrl.1 index 6c230e2d..717f44d0 100644 --- a/Documentation/nvme-zns-id-ctrl.1 +++ b/Documentation/nvme-zns-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-zns-id-ctrl \- Send NVMe Zoned Command Set Identify Controller, return resu .SH "SYNOPSIS" .sp .nf -\fInvme zns id\-ctrl\fR [\-o | \-\-output\-format=] +\fInvme zns id\-ctrl\fR [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -43,7 +43,7 @@ The parameter is mandatory and may be either the NVMe character device On success, the data structure returned by the device will be decoded and displayed in one of several ways\&. .SH "OPTIONS" .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-zns-id-ctrl.html b/Documentation/nvme-zns-id-ctrl.html index 8e0c56ec..b759e42d 100644 --- a/Documentation/nvme-zns-id-ctrl.html +++ b/Documentation/nvme-zns-id-ctrl.html @@ -740,7 +740,7 @@ nvme-zns-id-ctrl(1) Manual Page

NAME

nvme-zns-id-ctrl - - Send NVMe Zoned Command Set Identify Controller, return result and structure + Send NVMe Zoned Command Set Identify Controller, return result and structure

@@ -749,7 +749,7 @@ nvme-zns-id-ctrl(1) Manual Page

SYNOPSIS

-
nvme zns id-ctrl <device> [-o <fmt> | --output-format=<fmt>]
+
nvme zns id-ctrl <device> [--output-format=<fmt> | -o <fmt>]
@@ -770,15 +770,15 @@ displayed in one of several ways.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -821,7 +821,7 @@ Show the output in json format diff --git a/Documentation/nvme-zns-id-ns.1 b/Documentation/nvme-zns-id-ns.1 index d7829bb4..09759fc0 100644 --- a/Documentation/nvme-zns-id-ns.1 +++ b/Documentation/nvme-zns-id-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,9 +32,8 @@ nvme-zns-id-ns \- Send NVMe Zoned Command Set Identify namespace, return result .SH "SYNOPSIS" .sp .nf -\fInvme zns id\-ns\fR [\-\-namespace\-id= | \-n ] - [\-o | \-\-output\-format=] - [\-v | \-\-verbose] +\fInvme zns id\-ns\fR [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -55,7 +54,7 @@ Use the provided namespace id for the command\&. If not provided, the namespace Increase the information detail in the output\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-zns-id-ns.html b/Documentation/nvme-zns-id-ns.html index 1b721047..a9439149 100644 --- a/Documentation/nvme-zns-id-ns.html +++ b/Documentation/nvme-zns-id-ns.html @@ -740,7 +740,7 @@ nvme-zns-id-ns(1) Manual Page

NAME

nvme-zns-id-ns - - Send NVMe Zoned Command Set Identify namespace, return result and structure + Send NVMe Zoned Command Set Identify namespace, return result and structure

@@ -749,9 +749,8 @@ nvme-zns-id-ns(1) Manual Page

SYNOPSIS

-
nvme zns id-ns <device>  [--namespace-id=<NUM> | -n <NUM>]
-                             [-o <fmt> | --output-format=<fmt>]
-                             [-v | --verbose]
+
nvme zns id-ns <device> [--namespace-id=<NUM> | -n <NUM>]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
@@ -796,15 +795,15 @@ displayed in one of several ways.

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -847,7 +846,7 @@ Show the output in json format with extra details diff --git a/Documentation/nvme-zns-offline-zone.1 b/Documentation/nvme-zns-offline-zone.1 index 116817d4..cdc4ebe0 100644 --- a/Documentation/nvme-zns-offline-zone.1 +++ b/Documentation/nvme-zns-offline-zone.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-offline-zone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-OFFLINE\-" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-OFFLINE\-" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-zns-offline-zone.html b/Documentation/nvme-zns-offline-zone.html index 5e2e126e..32d198a5 100644 --- a/Documentation/nvme-zns-offline-zone.html +++ b/Documentation/nvme-zns-offline-zone.html @@ -846,7 +846,7 @@ Offline all zones on namespace 1: diff --git a/Documentation/nvme-zns-open-zone.1 b/Documentation/nvme-zns-open-zone.1 index 40b0ec94..6b72babb 100644 --- a/Documentation/nvme-zns-open-zone.1 +++ b/Documentation/nvme-zns-open-zone.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-open-zone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-OPEN\-ZON" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-OPEN\-ZON" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,8 @@ nvme-zns-open-zone \- Opens one or all zones .sp .nf \fInvme zns open\-zone\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-zrwaa | \-r] - [\-\-select\-all | \-a] - [\-\-timeout= | \-t ] + [\-\-start\-lba= | \-s ] [\-\-zrwaa | \-r] + [\-\-select\-all | \-a] [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-zns-open-zone.html b/Documentation/nvme-zns-open-zone.html index 31ab9918..0142ad41 100644 --- a/Documentation/nvme-zns-open-zone.html +++ b/Documentation/nvme-zns-open-zone.html @@ -750,10 +750,8 @@ nvme-zns-open-zone(1) Manual Page 
nvme zns open-zone <device> [--namespace-id=<NUM> | -n <NUM>]
-                              [--start-lba=<LBA> | -s <LBA>]
-                              [--zrwaa | -r]
-                              [--select-all | -a]
-                              [--timeout=<timeout> | -t <timeout>]
+ [--start-lba=<LBA> | -s <LBA>] [--zrwaa | -r] + [--select-all | -a] [--timeout=<timeout> | -t <timeout>]
@@ -858,7 +856,7 @@ Open the first zone on namespace 1: diff --git a/Documentation/nvme-zns-report-zones.1 b/Documentation/nvme-zns-report-zones.1 index dea48f4c..9558b566 100644 --- a/Documentation/nvme-zns-report-zones.1 +++ b/Documentation/nvme-zns-report-zones.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-report-zones .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-REPORT\-Z" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-REPORT\-Z" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,7 +39,7 @@ nvme-zns-report-zones \- Retrieve and display the Report Zones data structure [\-\-extended | \-e] [\-\-partial | \-p] [\-\-verbose | \-v] - [\-\-output\-format= | \-o ] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -143,7 +143,7 @@ If set, the device will return the number of zones that match the state rather t Increase the information detail in the output\&. .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-zns-report-zones.html b/Documentation/nvme-zns-report-zones.html index d3107e8b..b660c9d2 100644 --- a/Documentation/nvme-zns-report-zones.html +++ b/Documentation/nvme-zns-report-zones.html @@ -756,7 +756,7 @@ nvme-zns-report-zones(1) Manual Page [--extended | -e] [--partial | -p] [--verbose | -v] - [--output-format=<FMT> | -o <FMT>] + [--output-format=<fmt> | -o <fmt>]
@@ -906,15 +906,15 @@ cellspacing="0" cellpadding="4">

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json, or + binary. Only one output format can be used at a time.

@@ -957,7 +957,7 @@ Show the output in json format with extra details diff --git a/Documentation/nvme-zns-reset-zone.1 b/Documentation/nvme-zns-reset-zone.1 index a834aee7..497c4131 100644 --- a/Documentation/nvme-zns-reset-zone.1 +++ b/Documentation/nvme-zns-reset-zone.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-reset-zone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-RESET\-ZO" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-RESET\-ZO" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,9 +33,9 @@ nvme-zns-reset-zone \- Resets one or all zones .sp .nf \fInvme zns reset\-zone\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] - [\-\-timeout= | \-t ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-zns-reset-zone.html b/Documentation/nvme-zns-reset-zone.html index 8f57ec9a..40d1e973 100644 --- a/Documentation/nvme-zns-reset-zone.html +++ b/Documentation/nvme-zns-reset-zone.html @@ -750,9 +750,9 @@ nvme-zns-reset-zone(1) Manual Page 
nvme zns reset-zone <device> [--namespace-id=<NUM> | -n <NUM>]
-                                    [--start-lba=<LBA> | -s <LBA>]
-                                    [--select-all | -a]
-                                    [--timeout=<timeout> | -t <timeout>]
+ [--start-lba=<LBA> | -s <LBA>] + [--select-all | -a] + [--timeout=<timeout> | -t <timeout>]
@@ -847,7 +847,7 @@ Reset the first zone on namespace 1: diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1 index 0721cb5c..e13e03ca 100644 --- a/Documentation/nvme-zns-set-zone-desc.1 +++ b/Documentation/nvme-zns-set-zone-desc.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-set-zone-desc .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-SET\-ZONE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-SET\-ZONE" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,10 +33,10 @@ nvme-zns-set-zone-desc \- Set extended descriptor data for a zone .sp .nf \fInvme zns set\-zone\-desc\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba=, \-s ] - [\-\-zrwaa | \-r] - [\-data=, \-d ] - [\-\-timeout= | \-t ] + [\-\-start\-lba=, \-s ] + [\-\-zrwaa | \-r] + [\-\-data=, \-d ] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -58,7 +58,7 @@ The starting LBA of the zone to manage send\&. Allocate Zone Random Write Area to zone\&. .RE .PP -\-d +\-d , \-\-data= .RS 4 Optional file for data (default stdin) .RE diff --git a/Documentation/nvme-zns-set-zone-desc.html b/Documentation/nvme-zns-set-zone-desc.html index 06c0c3e4..9337a883 100644 --- a/Documentation/nvme-zns-set-zone-desc.html +++ b/Documentation/nvme-zns-set-zone-desc.html @@ -750,10 +750,10 @@ nvme-zns-set-zone-desc(1) Manual Page 
nvme zns set-zone-desc <device> [--namespace-id=<NUM> | -n <NUM>]
-                                 [--start-lba=<IONUM>, -s <IONUM>]
-                                 [--zrwaa | -r]
-                                 [-data=<FILE>, -d <FILE>]
-                                 [--timeout=<timeout> | -t <timeout>]
+ [--start-lba=<IONUM>, -s <IONUM>] + [--zrwaa | -r] + [--data=<FILE>, -d <FILE>] + [--timeout=<timeout> | -t <timeout>]
@@ -807,10 +807,10 @@ length will automatically be calculated from the zns identify namespace.

--d <FILE +-d <FILE>
--data=<FILE> +--data=<FILE>

@@ -859,7 +859,7 @@ Write "hello world" into the zone descriptor for namespace 1’s first zone

diff --git a/Documentation/nvme-zns-zone-append.1 b/Documentation/nvme-zns-zone-append.1 index 8f1a80f2..687452ef 100644 --- a/Documentation/nvme-zns-zone-append.1 +++ b/Documentation/nvme-zns-zone-append.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-zone-append .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-ZONE\-APP" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-ZONE\-APP" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-zns-zone-append.html b/Documentation/nvme-zns-zone-append.html index e9c6c966..09003471 100644 --- a/Documentation/nvme-zns-zone-append.html +++ b/Documentation/nvme-zns-zone-append.html @@ -940,7 +940,7 @@ Append the data "hello world" into 4k worth of blocks into the zone starting diff --git a/Documentation/nvme-zns-zone-mgmt-recv.1 b/Documentation/nvme-zns-zone-mgmt-recv.1 index fcf0b65f..67216be3 100644 --- a/Documentation/nvme-zns-zone-mgmt-recv.1 +++ b/Documentation/nvme-zns-zone-mgmt-recv.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-zone-mgmt-recv .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-ZONE\-MGM" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,12 +33,10 @@ nvme-zns-zone-mgmt-recv \- Zone Management Receive command .sp .nf \fInvme zns zone\-mgmt\-recv\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-data\-len=, \-l ] - [\-\-zra=, \-z ] - [\-\-zrasf=, \-a ] - [\-\-zra\-spec\-feat, \-f] - [\-\-output\-format=, \-o ] + [\-\-start\-lba= | \-s ] + [\-\-data\-len=, \-l ] + [\-\-zra=, \-z ] [\-\-zrasf=, \-a ] + [\-\-zra\-spec\-feat, \-f] [\-\-output\-format=, \-o ] .fi .SH "DESCRIPTION" .sp @@ -55,7 +53,7 @@ Use the provided namespace id for the command\&. If not provided, the namespace The starting LBA of the zone to manage receive\&. .RE .sp -\-\-data\-len= \-l Received data buffer length +\-l \-\-data\-len= Received data buffer length .PP \-z , \-\-zra= .RS 4 @@ -69,7 +67,7 @@ Zone Receive Action Enable Zone Receive Action Specific features .RE .PP -\-o , \-\-output\-format= +\-o , \-\-output\-format= .RS 4 Output format: normal|json|binary .RE diff --git a/Documentation/nvme-zns-zone-mgmt-recv.html b/Documentation/nvme-zns-zone-mgmt-recv.html index 1427d89c..6f0df635 100644 --- a/Documentation/nvme-zns-zone-mgmt-recv.html +++ b/Documentation/nvme-zns-zone-mgmt-recv.html @@ -750,12 +750,10 @@ nvme-zns-zone-mgmt-recv(1) Manual Page 
nvme zns zone-mgmt-recv <device> [--namespace-id=<NUM> | -n <NUM>]
-                                   [--start-lba=<LBA> | -s <LBA>]
-                                   [--data-len=<IONUM>, -l <IONUM>]
-                                   [--zra=<NUM>, -z <NUM>]
-                                   [--zrasf=<NUM>, -a <NUM>]
-                                   [--zra-spec-feat, -f]
-                                   [--output-format=<FMT>, -o <FMT>]
+ [--start-lba=<LBA> | -s <LBA>] + [--data-len=<IONUM>, -l <IONUM>] + [--zra=<NUM>, -z <NUM>] [--zrasf=<NUM>, -a <NUM>] + [--zra-spec-feat, -f] [--output-format=<fmt>, -o <fmt>]
@@ -801,8 +799,8 @@ binary.

-

--data-len=<NUM> --l <NUM> +

-l <NUM> +--data-len=<NUM> Received data buffer length

@@ -833,10 +831,10 @@ binary.

--o <FMT> +-o <fmt>
---output-format=<FMT> +--output-format=<fmt>

@@ -882,7 +880,7 @@ Binary dump of a report all zones

diff --git a/Documentation/nvme-zns-zone-mgmt-send.1 b/Documentation/nvme-zns-zone-mgmt-send.1 index d67fb067..273a32d9 100644 --- a/Documentation/nvme-zns-zone-mgmt-send.1 +++ b/Documentation/nvme-zns-zone-mgmt-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-zns-zone-mgmt-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ZNS\-ZONE\-MGM" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,13 +33,11 @@ nvme-zns-zone-mgmt-send \- Zone Management Send command .sp .nf \fInvme zns zone\-mgmt\-send\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba=, \-s ] - [\-\-zsaso, \-o] - [\-\-select\-all, \-a] - [\-\-zsa=, \-z ] - [\-\-data\-len=, \-l ] - [\-\-data=, \-d ] - [\-\-timeout= | \-t ] + [\-\-start\-lba=, \-s ] [\-\-zsaso, \-o] + [\-\-select\-all, \-a] [\-\-zsa=, \-z ] + [\-\-data\-len=, \-l ] + [\-\-data=, \-d ] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -66,7 +64,7 @@ Send data buffer length Zone Send Action Specific Option .RE .PP -\-\-select\-all, \-a +\-a, \-\-select\-all .RS 4 Send command to all zones .RE @@ -81,7 +79,7 @@ Zone send action\&. Buffer length if data required .RE .PP -\-d +\-d , \-\-data= .RS 4 Optional file for data (default stdin) .RE diff --git a/Documentation/nvme-zns-zone-mgmt-send.html b/Documentation/nvme-zns-zone-mgmt-send.html index c35410f1..cd1b0a6d 100644 --- a/Documentation/nvme-zns-zone-mgmt-send.html +++ b/Documentation/nvme-zns-zone-mgmt-send.html @@ -750,13 +750,11 @@ nvme-zns-zone-mgmt-send(1) Manual Page 
nvme zns zone-mgmt-send <device> [--namespace-id=<NUM> | -n <NUM>]
-                                   [--start-lba=<IONUM>, -s <IONUM>]
-                                   [--zsaso, -o]
-                                   [--select-all, -a]
-                                   [--zsa=<NUM>, -z <NUM>]
-                                   [--data-len=<IONUM>, -l <IONUM>]
-                                   [--data=<FILE>, -d <FILE>]
-                                   [--timeout=<timeout> | -t <timeout>]
+ [--start-lba=<IONUM>, -s <IONUM>] [--zsaso, -o] + [--select-all, -a] [--zsa=<NUM>, -z <NUM>] + [--data-len=<IONUM>, -l <IONUM>] + [--data=<FILE>, -d <FILE>] + [--timeout=<timeout> | -t <timeout>]
@@ -821,10 +819,10 @@ Alternatively, the data may come from a file that can be specified.

---select-all +-a
--a +--select-all

@@ -854,7 +852,7 @@ Alternatively, the data may come from a file that can be specified.

--d <FILE +-d <FILE>
--data=<FILE> @@ -916,7 +914,7 @@ Write "hello world" into the zone descriptor for namespace 1’s first zone diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index 3e0043c7..d54eb8b8 100644 --- a/Documentation/nvme.1 +++ b/Documentation/nvme.1 @@ -2,12 +2,12 @@ .\" Title: nvme .\" Author: [see the "Authors" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/19/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME" "1" "12/19/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme.html b/Documentation/nvme.html index 3881c500..3322f2bb 100644 --- a/Documentation/nvme.html +++ b/Documentation/nvme.html @@ -2114,7 +2114,7 @@ NVM-Express Site.