diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-12-24 07:57:49 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-12-24 07:57:49 +0000 |
| commit | fc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch) | |
| tree | 4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation | |
| parent | Adding upstream version 2.5. (diff) | |
| download | nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip | |
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation')
569 files changed, 7406 insertions, 3694 deletions
diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 4929a23..38fbba7 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] +\fInvme\-admin\-passthru\fR <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] .fi .SH "DESCRIPTION" .sp @@ -59,7 +60,7 @@ The <device> 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>, \-\-opcode=<opcode> +\-O <opcode>, \-\-opcode=<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 <fmt>, \-\-output\-format=<fmt> +.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 065f553..b5ba02a 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -749,23 +749,24 @@ nvme-admin-passthru(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme-admin-passthru</em> <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]</pre>
+<pre class="content"><em>nvme-admin-passthru</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -790,7 +791,7 @@ printed to stdout for another program to parse.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <opcode>
+-O <opcode>
</dt>
<dt class="hdlist1">
--opcode=<opcode>
@@ -961,6 +962,29 @@ printed to stdout for another program to parse.</p></div> Print out the latency the IOCTL took (in us).
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1003,7 +1027,7 @@ Or if you want to save that structure to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-admin-passthru.txt b/Documentation/nvme-admin-passthru.txt index 5a20ff8..22559db 100644 --- a/Documentation/nvme-admin-passthru.txt +++ b/Documentation/nvme-admin-passthru.txt @@ -8,23 +8,24 @@ nvme-admin-passthru - Submit an arbitrary admin command, return results SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -43,7 +44,7 @@ printed to stdout for another program to parse. OPTIONS ------- --o <opcode>:: +-O <opcode>:: --opcode=<opcode>:: The NVMe opcode to send to the device in the command @@ -113,6 +114,15 @@ OPTIONS --latency:: 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. + EXAMPLES -------- * The following will run the admin command with opcode=6 and cdw10=1, which diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1 index 28cbf41..cbddd88 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme ana\-log\fR <device> [\-\-groups | \-g] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-ana-log.html b/Documentation/nvme-ana-log.html index b3d2ef5..be72490 100644 --- a/Documentation/nvme-ana-log.html +++ b/Documentation/nvme-ana-log.html @@ -749,7 +749,8 @@ nvme-ana-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme ana-log</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme ana-log</em> <device> [--groups | -g]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -778,19 +779,30 @@ printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- Return the list of ANA groups without the namespace listing.
+ Return the list of ANA groups without the namespace listing.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -823,7 +835,7 @@ Print the ANA log page in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ana-log.txt b/Documentation/nvme-ana-log.txt index b6dc9c5..92dc12a 100644 --- a/Documentation/nvme-ana-log.txt +++ b/Documentation/nvme-ana-log.txt @@ -8,7 +8,8 @@ nvme-ana-log - Send NVMe ANA log page request, returns result and log SYNOPSIS -------- [verse] -'nvme ana-log' <device> [-o <fmt> | --output-format=<fmt>] +'nvme ana-log' <device> [--groups | -g] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -26,12 +27,16 @@ OPTIONS ------- -g:: --groups:: - Return the list of ANA groups without the namespace listing. + Return the list of ANA groups without the namespace listing. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 6864869..95bacce 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 a90e3dd..6fb6183 100644 --- a/Documentation/nvme-attach-ns.html +++ b/Documentation/nvme-attach-ns.html @@ -750,7 +750,8 @@ nvme-attach-ns(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme attach-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--controllers=<ctrl-list,> | -c <ctrl-list,>]</pre>
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -790,6 +791,29 @@ controller identifiers.</p></div> the namespace too.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -802,7 +826,7 @@ controller identifiers.</p></div> </div></div>
<div class="literalblock">
<div class="content">
-<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>
+<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>
</div></div>
</div>
</div>
@@ -817,7 +841,7 @@ controller identifiers.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-attach-ns.txt b/Documentation/nvme-attach-ns.txt index 64ab9d1..601c20d 100644 --- a/Documentation/nvme-attach-ns.txt +++ b/Documentation/nvme-attach-ns.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>] [--controllers=<ctrl-list,> | -c <ctrl-list,>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -28,11 +29,20 @@ OPTIONS The comma separated list of controller identifiers to attach 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. + EXAMPLES -------- Attach namespace to the controller: - # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21 + # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21 NVME ---- diff --git a/Documentation/nvme-boot-part-log.1 b/Documentation/nvme-boot-part-log.1 index 53b6dad..0596416 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <file>, \-\-output\-file=<file> +\-f <file>, \-\-output\-file=<file> .RS 4 File name to which raw binary data will be saved to\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-boot-part-log.html b/Documentation/nvme-boot-part-log.html index b327078..28fce1d 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme boot-part-log</em> <device> [--lsp=<field> | -s <field>]
- [--output-file=<file> | -o <file>]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-file=<file> | -f <file>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -783,7 +783,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--o <file>
+-f <file>
</dt>
<dt class="hdlist1">
--output-file=<file>
@@ -794,15 +794,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -835,7 +846,7 @@ Retrieve Boot Partition data to boot_part_log.bin <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-boot-part-log.txt b/Documentation/nvme-boot-part-log.txt index 2dd32a6..0999071 100644 --- a/Documentation/nvme-boot-part-log.txt +++ b/Documentation/nvme-boot-part-log.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -29,14 +29,18 @@ OPTIONS --lsp=<field>:: The log specified field of LID. --o <file>:: +-f <file>:: --output-file=<file>:: File name to which raw binary data will be saved to. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-capacity-mgmt.1 b/Documentation/nvme-capacity-mgmt.1 index c96ee58..ac995fe 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-operation=<operation> | \-o <operation>] +\fInvme capacity\-mgmt\fR <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>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,7 +45,7 @@ For the NVMe device given, sends a capacity management command to configure/crea The <device> 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>, \-\-operation=<operation> +\-O <operation>, \-\-operation=<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 <fmt>, \-\-output\-format=<fmt> +.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 e0fdc4a..4892aba 100644 --- a/Documentation/nvme-capacity-mgmt.html +++ b/Documentation/nvme-capacity-mgmt.html @@ -740,7 +740,7 @@ nvme-capacity-mgmt(1) Manual Page <h2>NAME</h2>
<div class="sectionbody">
<p>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.
</p>
</div>
</div>
@@ -749,10 +749,11 @@ nvme-capacity-mgmt(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme capacity-mgmt</em> <device> [--operation=<operation> | -o <operation>]
+<pre class="content"><em>nvme capacity-mgmt</em> <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>]</pre>
+ [--cap-upper=<cap-upper> | -u <cap-upper>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -774,14 +775,14 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <operation>
+-O <operation>
</dt>
<dt class="hdlist1">
--operation=<operation>
</dt>
<dd>
<p>
- Operation to be performed by the controller
+ Operation to be performed by the controller
</p>
</dd>
<dt class="hdlist1">
@@ -792,7 +793,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </dt>
<dd>
<p>
- Value specific to the value of the Operation field.
+ Value specific to the value of the Operation field.
</p>
</dd>
<dt class="hdlist1">
@@ -804,7 +805,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <dd>
<p>
Least significant 32 bits of the capacity in bytes of the Endurance Group or
- NVM Set to be created
+ NVM Set to be created
</p>
</dd>
<dt class="hdlist1">
@@ -816,7 +817,30 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <dd>
<p>
Most significant 32 bits of the capacity in bytes of the Endurance Group or
- NVM Set to be created
+ NVM Set to be created
+</p>
+</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -839,7 +863,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt index 96274cf..a20561f 100644 --- a/Documentation/nvme-capacity-mgmt.txt +++ b/Documentation/nvme-capacity-mgmt.txt @@ -4,15 +4,16 @@ nvme-capacity-mgmt(1) NAME ---- nvme-capacity-mgmt - Send capacity management command to configure/create/delete - Endurance Groups or NVM Sets, returns results. +Endurance Groups or NVM Sets, returns results. SYNOPSIS -------- [verse] -'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>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -27,23 +28,32 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). OPTIONS ------- --o <operation>:: +-O <operation>:: --operation=<operation>:: - Operation to be performed by the controller + Operation to be performed by the controller -i <element-id>:: --element-id=<element-id>:: - Value specific to the value of the Operation field. + Value specific to the value of the Operation field. -l <cap-lower>:: --cap-lower=<cap-lower>:: Least significant 32 bits of the capacity in bytes of the Endurance Group or - NVM Set to be created + NVM Set to be created -u <cap-upper>:: --cap-upper=<cap-upper>:: 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. EXAMPLES -------- diff --git a/Documentation/nvme-changed-ns-list-log.1 b/Documentation/nvme-changed-ns-list-log.1 index 5e39559..017de32 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-changed-ns-list-log.html b/Documentation/nvme-changed-ns-list-log.html index 13b9f37..6c7f5fb 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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.
</p>
</div>
</div>
@@ -750,7 +750,7 @@ nvme-changed-ns-list-log(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme changed-ns-list-log</em> <device> [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -784,15 +784,26 @@ the raw buffer may be printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -835,7 +846,7 @@ Print the raw Changed Namespace List log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-changed-ns-list-log.txt b/Documentation/nvme-changed-ns-list-log.txt index 4cfd065..22e552f 100644 --- a/Documentation/nvme-changed-ns-list-log.txt +++ b/Documentation/nvme-changed-ns-list-log.txt @@ -4,13 +4,13 @@ nvme-changed-ns-list-log(1) NAME ---- nvme-changed-ns-list-log - Send NVMe Changed Namespace List log page - request, returns result and log. +request, returns result and log. SYNOPSIS -------- [verse] 'nvme changed-ns-list-log' <device> [--raw-binary | -b] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -31,10 +31,14 @@ OPTIONS --raw-binary:: Print the raw Changed Namespace List log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-check-dhchap-key.txt b/Documentation/nvme-check-dhchap-key.txt index 9cfa1f7..b131afe 100644 --- a/Documentation/nvme-check-dhchap-key.txt +++ b/Documentation/nvme-check-dhchap-key.txt @@ -8,7 +8,8 @@ nvme-check-dhchap-key - Check a generated host DH-HMAC-CHAP key SYNOPSIS -------- [verse] -'nvme check-dhchap-key' [--key=<key> ] +'nvme check-dhchap-key' [--key=<key>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -22,6 +23,15 @@ OPTIONS --key=<key>:: Key to be checked. +-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 -------- No Examples diff --git a/Documentation/nvme-check-tls-key.txt b/Documentation/nvme-check-tls-key.txt index a676f04..2df4fca 100644 --- a/Documentation/nvme-check-tls-key.txt +++ b/Documentation/nvme-check-tls-key.txt @@ -8,17 +8,22 @@ nvme-check-tls-key - Check a generated NVMe TLS PSK SYNOPSIS -------- [verse] -'nvme check-tls-key' [--keyring=<name> | -k <name> ] - [--keytype=<type> | -t <type> ] - [--hostnqn=<nqn> | -n <nqn> ] - [--subsysnqn=<nqn> | -c <nqn> ] - [--keydata=<key> | -d <key> ] +'nvme check-tls-key' [--keyring=<name> | -k <name>] + [--keytype=<type> | -t <type>] + [--hostnqn=<nqn> | -n <nqn>] + [--subsysnqn=<nqn> | -c <nqn>] + [--keydata=<key> | -d <key>] + [--output-format=<fmt> | -o <fmt>] + [--identity=<id-vers> | -I <id-vers>] + [--insert | -i ] + [--verbose | -v] DESCRIPTION ----------- Checks if the key is a valid NVMe TLS PSK in the PSK interchange format -'NVMeTLSkey-1:01:<base64-encoded data>:', and stores the derived 'retained' -TLS key in the keyring if the subsystem NQN is specified. +'NVMeTLSkey-1:01:<base64-encoded data>:'. If '--insert' is specified the +the derived 'retained' TLS key is stored in the keyring, otherwise the +TLS identity of the key is printed out. OPTIONS ------- @@ -46,6 +51,25 @@ OPTIONS --keydata=<key>:: Key to be checked. +-I <id-vers>:: +--identity=<id-vers>:: + NVMe TLS key identity version to be used; '0' for the default + identity, and '1' for the TLS identity suffixed by the PSK hash + as specified in TP8018. + +-i: +--insert: + Insert the derived 'retained' key in the keyring. + +-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 -------- No Examples diff --git a/Documentation/nvme-cmdset-ind-id-ns.1 b/Documentation/nvme-cmdset-ind-id-ns.1 index 09a2858..5790734 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-cmdset-ind-id-ns.html b/Documentation/nvme-cmdset-ind-id-ns.html index c4459b9..6635308 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme cmdset-ind-id-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [-b | --raw-binary]
- [--human-readable | -H]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--raw-binary | -b] [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -815,15 +814,26 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -879,7 +889,7 @@ Have the program return the raw structure in binary: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-cmdset-ind-id-ns.txt b/Documentation/nvme-cmdset-ind-id-ns.txt index fa55c83..5bf3862 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.txt +++ b/Documentation/nvme-cmdset-ind-id-ns.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -47,11 +46,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index da550ce..b7f82b5 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -47,12 +47,13 @@ nvme-compare \- Send an NVMe Compare command, provide results [\-\-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] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -97,9 +98,6 @@ Metadata file\&. \-p <prinfo>, \-\-prinfo=<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 <appmask>, \-\-app\-tag\-mask=<appmask> .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 <fmt>, \-\-output\-format=<fmt> +.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 4adf97e..7334107 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]</pre>
+ [--force]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -877,9 +878,6 @@ provided, then a comparison is also performed for the metadata.</p></div> <p>
Protection Information and check field.
</p>
-</dd>
-</dl></div>
-<div class="paragraph"><p>+</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
@@ -917,7 +915,7 @@ metadata is passes.</p></td> </tbody>
</table>
</div>
-<div class="dlist"><dl>
+</dd>
<dt class="hdlist1">
-m <appmask>
</dt>
@@ -1009,7 +1007,7 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dt class="hdlist1">
--show-cmd
@@ -1071,8 +1069,31 @@ metadata is passes.</p></td> </dt>
<dd>
<p>
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+</p>
+</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -1095,7 +1116,7 @@ metadata is passes.</p></td> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-compare.txt b/Documentation/nvme-compare.txt index 12121ab..59d1ea9 100644 --- a/Documentation/nvme-compare.txt +++ b/Documentation/nvme-compare.txt @@ -23,12 +23,13 @@ SYNOPSIS [--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] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -73,7 +74,6 @@ OPTIONS -p <prinfo>:: --prinfo=<prinfo>:: Protection Information and check field. - + [] |================= @@ -127,7 +127,7 @@ metadata is passes. 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. --v:: +-V:: --show-cmd:: Print out the command to be sent. @@ -151,8 +151,17 @@ metadata is passes. data protection processing. --force:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-config.txt b/Documentation/nvme-config.txt index 5b76925..aea6f6a 100644 --- a/Documentation/nvme-config.txt +++ b/Documentation/nvme-config.txt @@ -8,33 +8,28 @@ nvme-config - NVMe-over-Fabrics configuration. SYNOPSIS -------- [verse] -'nvme config' - [--scan | -R] - [--modify | -M] - [--update | -U] - [--dump | -O] - [--config=<cfg> | -J <cfg> ] - [--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>] - [--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 <#>] - [--duplicate-connect | -D] - [--disable-sqflow | -d] - [--hdr-digest | -g] - [--data-digest | -G] +'nvme config' [--scan | -R] [--modify | -M] [--update | -U] [--dump | -O] + [--config=<cfg> | -J <cfg>] + [--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>] + [--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 <#>] + [--duplicate-connect | -D] [--disable-sqflow | -d] + [--hdr-digest | -g] [--data-digest | -G] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -52,7 +47,7 @@ OPTIONS -M:: --modify:: Add or modify entries in the configuration based on the values from - the commandline. + the commandline. -U:: --update:: @@ -71,7 +66,7 @@ OPTIONS -t <trtype>:: --transport=<trtype>:: 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: + [] |================= @@ -94,7 +89,7 @@ OPTIONS -s <trsvcid>:: --trsvcid=<trsvcid>:: - 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. @@ -186,6 +181,15 @@ OPTIONS --data-digest:: Generates/verifies data digest (TCP). +-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 -------- * Read the current system configuration and write the contents to /tmp/config.json: @@ -200,7 +204,6 @@ nvme-discover(1) nvme-connect(1) https://github.com/linux-nvme/libnvme/doc/config-schema.json - AUTHORS ------- This was written by mailto:hare@suse.com[Hannes Reinecke] diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index 9e795f5..4f37956 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<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>] +\fInvme connect\-all\fR [\-\-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] .fi .SH "DESCRIPTION" .sp @@ -266,6 +258,20 @@ Use a user\-defined path to the NBFT tables .RS 4 Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 4124714..d579c1f 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.html @@ -749,37 +749,29 @@ nvme-connect-all(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme connect-all</em>
- [--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>]</pre>
+<pre class="content"><em>nvme connect-all</em> [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -813,7 +805,7 @@ background.</p></div> <dd>
<p>
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:
</p>
<div class="tableblock">
<table rules="all"
@@ -879,7 +871,7 @@ cellspacing="0" cellpadding="4"> </dt>
<dd>
<p>
- 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.
</p>
@@ -1178,6 +1170,29 @@ cellspacing="0" cellpadding="4"> the management of the global resources.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1221,9 +1236,9 @@ Issue a <em>nvme connect-all</em> command using a /usr/local/etc/nvme/discovery. </p>
<div class="listingblock">
<div class="content">
-<pre><code># Machine default 'nvme discover' commands. Query the
+<pre><code># 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)</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index 46b0911..faa2cf8 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -8,37 +8,29 @@ nvme-connect-all - Discover and Connect to Fabrics controllers. SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -62,13 +54,13 @@ OPTIONS -t <trtype>:: --transport=<trtype>:: 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: + [] |================= |Value|Definition |rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) -|fc |*WIP* The network fabric is a Fibre Channel network. +|fc |*WIP* The network fabric is a Fibre Channel network. |tcp |The network fabric is a TCP/IP network. |loop|Connect to a NVMe over Fabrics target on the local host |================= @@ -85,7 +77,7 @@ OPTIONS -s <trsvcid>:: --trsvcid=<trsvcid>:: - 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. @@ -203,18 +195,27 @@ OPTIONS Print out resulting JSON configuration file to stdout. --nbft:: - Only look at NBFT tables + Only look at NBFT tables --no-nbft:: - Do not look at NBFT tables + Do not look at NBFT tables --nbft-path=<STR>:: - Use a user-defined path to the NBFT tables + Use a user-defined path to the NBFT tables --context <STR>:: Set the execution context to <STR>. This allows to coordinate 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. + EXAMPLES -------- * Connect to all records returned by the Discover Controller with IP4 address @@ -241,9 +242,9 @@ the RDMA network. Port 4420 is used by default: * Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file: + ----------- -# 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 diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index b27680a..4eb8bb6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "12/21/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=<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> ] +\fInvme connect\fR [\-\-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] .fi .SH "DESCRIPTION" .sp @@ -154,7 +147,7 @@ to not read in an existing configuration file\&. The JSON configuration file for \-S <secret>, \-\-dhchap\-secret=<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 <secret>, \-\-dhchap\-ctrl\-secret=<secret> @@ -243,17 +236,23 @@ Enable TLS encryption (TCP)\&. Print out resulting JSON configuration file to stdout\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-\-context <STR> +.RS 4 +Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> .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 <STR> +\-v, \-\-verbose .RS 4 -Set the execution context to <STR>\&. 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 4007df2..4282f24 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -749,36 +749,29 @@ nvme-connect(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme connect</em>
- [--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> ]</pre>
+<pre class="content"><em>nvme connect</em> [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -804,7 +797,7 @@ specified by the --nqn option.</p></div> <dd>
<p>
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:
</p>
<div class="tableblock">
<table rules="all"
@@ -870,7 +863,7 @@ cellspacing="0" cellpadding="4"> </dt>
<dd>
<p>
- 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.
</p>
@@ -953,9 +946,6 @@ cellspacing="0" cellpadding="4"> <p>
NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>.
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -1144,25 +1134,35 @@ cellspacing="0" cellpadding="4"> </p>
</dd>
<dt class="hdlist1">
--o <format>
+--context <STR>
</dt>
+<dd>
+<p>
+ Set the execution context to <STR>. This allows to coordinate
+ the management of the global resources.
+</p>
+</dd>
<dt class="hdlist1">
---output-format=<format>
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> or <em>json</em>. 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 <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
---context <STR>
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
</dt>
<dd>
<p>
- Set the execution context to <STR>. This allows to coordinate
- the management of the global resources.
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -1211,7 +1211,7 @@ and <a href="mailto:hch@lst.de">Christoph Hellwig</a></p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt index a6effaf..af3e7d3 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -8,36 +8,29 @@ nvme-connect - Connect to a Fabrics controller. SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -50,7 +43,7 @@ OPTIONS -t <trtype>:: --transport=<trtype>:: 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: + [] |================= @@ -73,7 +66,7 @@ OPTIONS -s <trsvcid>:: --trsvcid=<trsvcid>:: - 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. @@ -114,9 +107,6 @@ OPTIONS --dhchap-secret=<secret>:: 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 - @SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication - is attempted. -C <secret>:: --dhchap-ctrl-secret=<secret>:: @@ -190,16 +180,19 @@ OPTIONS --dump-config:: Print out resulting JSON configuration file to stdout. --o <format>:: ---output-format=<format>:: - 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. - --context <STR>:: Set the execution context to <STR>. This allows to coordinate 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. + EXAMPLES -------- * Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 @@ -215,7 +208,6 @@ SEE ALSO nvme-discover(1) nvme-connect-all(1) - AUTHORS ------- This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee] diff --git a/Documentation/nvme-copy.1 b/Documentation/nvme-copy.1 index 4228451..b3fe795 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COPY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-COPY" "1" "12/21/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 <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>] @@ -48,91 +50,116 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results [\-\-dir\-type=<type> | \-T <type>] [\-\-dir\-spec=<spec> | \-S <spec>] [\-\-format=<entry\-format> | \-F <entry\-format>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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=<sdlba>, \-d <sdlba> +\-d <sdlba>, \-\-sdlba=<sdlba> .RS 4 64\-bit addr of first destination logical block .RE .PP -\-\-blocks=<nlb\-list,>, \-b <nlb\-list,> +\-b <nlb\-list,>, \-\-blocks=<nlb\-list,> .RS 4 Comma separated list of the number of blocks in each range .RE .PP -\-\-slbs=<slbas,>, \-s <slbas,> +\-s <slbas,>, \-\-slbs=<slbas,> .RS 4 Comma separated list of the starting blocks in each range .RE .PP -\-\-limited\-retry, \-l +\-\-snsids=<snsids,>, \-N <snsids,> +.RS 4 +Comma separated list of the source namespace identifiers in each range +.RE +.PP +\-\-sopts=<sopts,>, \-O <sopts,> +.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=<prinfow>, \-p <prinfow> +\-p <prinfow>, \-\-prinfow=<prinfow> .RS 4 Protection Information field write definition\&. .RE .PP -\-\-prinfor=<prinfor>, \-P <prinfor> +\-P <prinfor>, \-\-prinfor=<prinfor> .RS 4 Protection Information field read definition\&. .RE .PP -\-\-ref\-tag=<reftag>, \-r <reftag> +\-r <reftag>, \-\-ref\-tag=<reftag> .RS 4 initial lba reference tag\&. .RE .PP -\-\-expected\-ref\-tags=<reftag,>, \-R <reftag,> +\-R <reftag,>, \-\-expected\-ref\-tags=<reftag,> .RS 4 expected lba reference tags (comma\-separated list)\&. .RE .PP -\-\-app\-tag=<apptag>, \-a <apptag> +\-a <apptag>, \-\-app\-tag=<apptag> .RS 4 lba app tag .RE .PP -\-\-expected\-app\-tags=<apptag,>, \-A <apptag,> +\-A <apptag,>, \-\-expected\-app\-tags=<apptag,> .RS 4 expected lba app tags (comma\-separated list) .RE .PP -\-\-app\-mask=<appmask>, \-m <appmask> +\-m <appmask>, \-\-app\-mask=<appmask> .RS 4 lba tag mask .RE .PP -\-\-expected\-app\-masks=<appmask,>, \-M <appmask,> +\-M <appmask,>, \-\-expected\-app\-masks=<appmask,> .RS 4 expected lba tag masks (comma\-separated list) .RE .PP -\-\-dir\-type=<type>, \-T <type> +\-T <type>, \-\-dir\-type=<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=<spec>, \-S <spec> +\-S <spec>, \-\-dir\-spec=<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=<entry\-format>, \-F <entry\-format> +\-F <entry\-format>, \-\-format=<entry\-format> .RS 4 source range entry format .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 875304c..010361e 100644 --- a/Documentation/nvme-copy.html +++ b/Documentation/nvme-copy.html @@ -752,6 +752,8 @@ nvme-copy(1) Manual Page <pre class="content"><em>nvme-copy</em> <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>]</pre>
+ [--format=<entry-format> | -F <entry-format>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,10 +784,10 @@ logical block ranges to a single consecutive destination logical block range.</p <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---sdlba=<sdlba>
+-d <sdlba>
</dt>
<dt class="hdlist1">
--d <sdlba>
+--sdlba=<sdlba>
</dt>
<dd>
<p>
@@ -792,10 +795,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---blocks=<nlb-list,>
+-b <nlb-list,>
</dt>
<dt class="hdlist1">
--b <nlb-list,>
+--blocks=<nlb-list,>
</dt>
<dd>
<p>
@@ -803,10 +806,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---slbs=<slbas,>
+-s <slbas,>
</dt>
<dt class="hdlist1">
--s <slbas,>
+--slbs=<slbas,>
</dt>
<dd>
<p>
@@ -814,21 +817,43 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---limited-retry
+--snsids=<snsids,>
+</dt>
+<dt class="hdlist1">
+-N <snsids,>
+</dt>
+<dd>
+<p>
+ Comma separated list of the source namespace identifiers in each range
+</p>
+</dd>
+<dt class="hdlist1">
+--sopts=<sopts,>
</dt>
<dt class="hdlist1">
+-O <sopts,>
+</dt>
+<dd>
+<p>
+ Comma separated list of the source options in each range
+</p>
+</dd>
+<dt class="hdlist1">
-l
</dt>
+<dt class="hdlist1">
+--limited-retry
+</dt>
<dd>
<p>
Sets the limited retry flag.
</p>
</dd>
<dt class="hdlist1">
---force-unit-access
+-f
</dt>
<dt class="hdlist1">
--f
+--force-unit-access
</dt>
<dd>
<p>
@@ -836,10 +861,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---prinfow=<prinfow>
+-p <prinfow>
</dt>
<dt class="hdlist1">
--p <prinfow>
+--prinfow=<prinfow>
</dt>
<dd>
<p>
@@ -847,10 +872,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---prinfor=<prinfor>
+-P <prinfor>
</dt>
<dt class="hdlist1">
--P <prinfor>
+--prinfor=<prinfor>
</dt>
<dd>
<p>
@@ -858,10 +883,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---ref-tag=<reftag>
+-r <reftag>
</dt>
<dt class="hdlist1">
--r <reftag>
+--ref-tag=<reftag>
</dt>
<dd>
<p>
@@ -869,10 +894,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---expected-ref-tags=<reftag,>
+-R <reftag,>
</dt>
<dt class="hdlist1">
--R <reftag,>
+--expected-ref-tags=<reftag,>
</dt>
<dd>
<p>
@@ -880,10 +905,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---app-tag=<apptag>
+-a <apptag>
</dt>
<dt class="hdlist1">
--a <apptag>
+--app-tag=<apptag>
</dt>
<dd>
<p>
@@ -891,10 +916,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---expected-app-tags=<apptag,>
+-A <apptag,>
</dt>
<dt class="hdlist1">
--A <apptag,>
+--expected-app-tags=<apptag,>
</dt>
<dd>
<p>
@@ -902,10 +927,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---app-mask=<appmask>
+-m <appmask>
</dt>
<dt class="hdlist1">
--m <appmask>
+--app-mask=<appmask>
</dt>
<dd>
<p>
@@ -913,10 +938,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---expected-app-masks=<appmask,>
+-M <appmask,>
</dt>
<dt class="hdlist1">
--M <appmask,>
+--expected-app-masks=<appmask,>
</dt>
<dd>
<p>
@@ -924,10 +949,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---dir-type=<type>
+-T <type>
</dt>
<dt class="hdlist1">
--T <type>
+--dir-type=<type>
</dt>
<dd>
<p>
@@ -938,10 +963,10 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---dir-spec=<spec>
+-S <spec>
</dt>
<dt class="hdlist1">
--S <spec>
+--dir-spec=<spec>
</dt>
<dd>
<p>
@@ -952,16 +977,39 @@ logical block ranges to a single consecutive destination logical block range.</p </p>
</dd>
<dt class="hdlist1">
---format=<entry-format>
+-F <entry-format>
</dt>
<dt class="hdlist1">
--F <entry-format>
+--format=<entry-format>
</dt>
<dd>
<p>
source range entry format
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -982,7 +1030,7 @@ logical block ranges to a single consecutive destination logical block range.</p <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-copy.txt b/Documentation/nvme-copy.txt index 1fad952..7c5fb0e 100644 --- a/Documentation/nvme-copy.txt +++ b/Documentation/nvme-copy.txt @@ -11,6 +11,8 @@ SYNOPSIS '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>] @@ -24,6 +26,7 @@ SYNOPSIS [--dir-type=<type> | -T <type>] [--dir-spec=<spec> | -S <spec>] [--format=<entry-format> | -F <entry-format>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -32,76 +35,93 @@ logical block ranges to a single consecutive destination logical block range. OPTIONS ------- ---sdlba=<sdlba>:: -d <sdlba>:: +--sdlba=<sdlba>:: 64-bit addr of first destination logical block ---blocks=<nlb-list,>:: -b <nlb-list,>:: +--blocks=<nlb-list,>:: Comma separated list of the number of blocks in each range ---slbs=<slbas,>:: -s <slbas,>:: +--slbs=<slbas,>:: Comma separated list of the starting blocks in each 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:: +--force-unit-access:: Set the force-unit access flag. ---prinfow=<prinfow>:: -p <prinfow>:: +--prinfow=<prinfow>:: Protection Information field write definition. ---prinfor=<prinfor>:: -P <prinfor>:: +--prinfor=<prinfor>:: Protection Information field read definition. ---ref-tag=<reftag>:: -r <reftag>:: +--ref-tag=<reftag>:: initial lba reference tag. ---expected-ref-tags=<reftag,>:: -R <reftag,>:: +--expected-ref-tags=<reftag,>:: expected lba reference tags (comma-separated list). ---app-tag=<apptag>:: -a <apptag>:: +--app-tag=<apptag>:: lba app tag ---expected-app-tags=<apptag,>:: -A <apptag,>:: +--expected-app-tags=<apptag,>:: expected lba app tags (comma-separated list) ---app-mask=<appmask>:: -m <appmask>:: +--app-mask=<appmask>:: lba tag mask ---expected-app-masks=<appmask,>:: -M <appmask,>:: +--expected-app-masks=<appmask,>:: expected lba tag masks (comma-separated list) ---dir-type=<type>:: -T <type>:: +--dir-type=<type>:: 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. ---dir-spec=<spec>:: -S <spec>:: +--dir-spec=<spec>:: 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's capabilities. ---format=<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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index a63aaad..89cf2a9 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<nmic> | \-m <nmic>] [\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>] [\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>] + [\-\-endg\-id=<endgid> | \-e <endgid>] [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>] [\-\-lbstm=<lbstm> | \-l <lbstm>] [\-\-nphndls=<nphndls> | \-n <nphndls>] @@ -48,9 +49,10 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re [\-\-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,>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <endgid>, \-\-endg\-id=<endgid> +.RS 4 +This field specifies the identifier of the endurance group\&. +.RE +.PP \-y <command_set_identifier>, \-\-csi=<command_set_identifier> .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>, \-\-ror=<ror> +\-O <ror>, \-\-ror=<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 <fmt>, \-\-output\-format=<fmt> +.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 fe15e74..1ff077a 100644 --- a/Documentation/nvme-create-ns.html +++ b/Documentation/nvme-create-ns.html @@ -756,6 +756,7 @@ nvme-create-ns(1) Manual Page [--nmic=<nmic> | -m <nmic>]
[--anagrp-id=<anagrpid> | -a <anagrpid>]
[--nvmset-id=<nvmsetid> | -i <nvmsetid>]
+ [--endg-id=<endgid> | -e <endgid>]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--lbstm=<lbstm> | -l <lbstm>]
[--nphndls=<nphndls> | -n <nphndls>]
@@ -765,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,>]</pre>
+ [--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -866,6 +868,17 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
+-e <endgid>
+</dt>
+<dt class="hdlist1">
+--endg-id=<endgid>
+</dt>
+<dd>
+<p>
+ This field specifies the identifier of the endurance group.
+</p>
+</dd>
+<dt class="hdlist1">
-y <command_set_identifier>
</dt>
<dt class="hdlist1">
@@ -910,8 +923,8 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <dd>
<p>
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.
</p>
</dd>
<dt class="hdlist1">
@@ -967,7 +980,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--o <ror>
+-O <ror>
</dt>
<dt class="hdlist1">
--ror=<ror>
@@ -1002,6 +1015,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di with each Placement Handle.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1033,7 +1069,7 @@ Create a namespace: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-create-ns.txt b/Documentation/nvme-create-ns.txt index 5d1355d..740d05b 100644 --- a/Documentation/nvme-create-ns.txt +++ b/Documentation/nvme-create-ns.txt @@ -15,6 +15,7 @@ SYNOPSIS [--nmic=<nmic> | -m <nmic>] [--anagrp-id=<anagrpid> | -a <anagrpid>] [--nvmset-id=<nvmsetid> | -i <nvmsetid>] + [--endg-id=<endgid> | -e <endgid>] [--csi=<command_set_identifier> | -y <command_set_identifier>] [--lbstm=<lbstm> | -l <lbstm>] [--nphndls=<nphndls> | -n <nphndls>] @@ -24,9 +25,10 @@ SYNOPSIS [--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,>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -69,6 +71,10 @@ OPTIONS --nvmset-id=<nvmsetid>:: This field specifies the identifier of the NVM Set. +-e <endgid>:: +--endg-id=<endgid>:: + This field specifies the identifier of the endurance group. + -y <command_set_identifier>:: --csi=<command_set_identifier>:: This field specifies the identifier of command set. @@ -87,8 +93,8 @@ OPTIONS -b:: --block-size:: 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. -S:: --nsze-si:: @@ -114,7 +120,7 @@ OPTIONS Requested Active Resources. This field specifies the number of active resources to be allocated to the created namespace. --o <ror>:: +-O <ror>:: --ror=<ror>:: Requested Open Resources. This field specifies the number of open resources to be allocated to the created namespace. @@ -129,6 +135,15 @@ OPTIONS The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle. +-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 -------- * Create a namespace: diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index d50ed5d..c9d8a0f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -45,6 +46,20 @@ The <device> parameter is mandatory and may be either the NVMe character device .RS 4 The namespace identifier to delete\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 7004e10..057d0bf 100644 --- a/Documentation/nvme-delete-ns.html +++ b/Documentation/nvme-delete-ns.html @@ -749,7 +749,8 @@ nvme-id-ns(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme delete-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre>
+<pre class="content"><em>nvme delete-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -779,6 +780,29 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div> The namespace identifier to delete.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -799,7 +823,7 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-delete-ns.txt b/Documentation/nvme-delete-ns.txt index 62301b4..1b306b2 100644 --- a/Documentation/nvme-delete-ns.txt +++ b/Documentation/nvme-delete-ns.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme delete-ns' <device> [--namespace-id=<nsid> | -n <nsid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -25,6 +26,15 @@ OPTIONS --namespace-id=<nsid>:: 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-dera-stat.1 b/Documentation/nvme-dera-stat.1 index 8a206ed..02c6e73 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dera-stat.html b/Documentation/nvme-dera-stat.html index 41946f7..13b9f84 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-dera-stat.txt b/Documentation/nvme-dera-stat.txt index 512e584..f3a87ae 100644 --- a/Documentation/nvme-dera-stat.txt +++ b/Documentation/nvme-dera-stat.txt @@ -24,7 +24,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Dera Device status and Additional SMART log page in a human readable format: diff --git a/Documentation/nvme-detach-ns.1 b/Documentation/nvme-detach-ns.1 index 824166b..70d895d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,> + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <ctrl\-list,>, \-controllers=<ctrl\-list,> +\-c <ctrl\-list,>, \-\-controllers=<ctrl\-list,> .RS 4 The comma separated list of controller identifiers to detach the namespace from\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 2e8bcc1..469f5ed 100644 --- a/Documentation/nvme-detach-ns.html +++ b/Documentation/nvme-detach-ns.html @@ -750,7 +750,8 @@ nvme-detach-ns(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme detach-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--controllers=<ctrl-list,> | -c <ctrl-list,></pre>
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -782,7 +783,7 @@ controller identifiers.</p></div> -c <ctrl-list,>
</dt>
<dt class="hdlist1">
--controllers=<ctrl-list,>
+--controllers=<ctrl-list,>
</dt>
<dd>
<p>
@@ -790,6 +791,29 @@ controller identifiers.</p></div> the namespace from.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -810,7 +834,7 @@ controller identifiers.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-detach-ns.txt b/Documentation/nvme-detach-ns.txt index ed23c15..842889c 100644 --- a/Documentation/nvme-detach-ns.txt +++ b/Documentation/nvme-detach-ns.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>] [--controllers=<ctrl-list,> | -c <ctrl-list,> + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -24,10 +25,19 @@ OPTIONS The namespace identifier to detach. -c <ctrl-list,>:: --controllers=<ctrl-list,>:: +--controllers=<ctrl-list,>:: The comma separated list of controller identifiers to detach 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-device-self-test.1 b/Documentation/nvme-device-self-test.1 index 393bd02..f37be3f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 e5dfb38..ce0251e 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme device-self-test</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--self-test-code=<NUM> | -s <NUM>] [--wait | -w]</pre>
+ [--self-test-code=<NUM> | -s <NUM>] [--wait | -w]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -809,6 +810,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di The option is ignored if the abort self-test code option specified.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -848,7 +872,7 @@ Abort the device self-test operation in the namespace-id 1: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-device-self-test.txt b/Documentation/nvme-device-self-test.txt index d098277..17fe875 100644 --- a/Documentation/nvme-device-self-test.txt +++ b/Documentation/nvme-device-self-test.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -28,12 +29,12 @@ OPTIONS -s <NUM>:: --self-test-code=<NUM>:: - This field specifies the action taken by the device self-test command : - 0h: Show current state of device self-test operation - 1h: Start a short device self-test operation - 2h: Start a extended device self-test operation - eh: Start a vendor specific device self-test operation - fh: Abort the device self-test operation + This field specifies the action taken by the device self-test command : + 0h: Show current state of device self-test operation + 1h: Start a short device self-test operation + 2h: Start a extended device self-test operation + eh: Start a vendor specific device self-test operation + fh: Abort the device self-test operation Default is 0h. -w:: @@ -42,6 +43,15 @@ OPTIONS 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. +-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 -------- * Start a short device self-test in the namespace-id 1: diff --git a/Documentation/nvme-dim.1 b/Documentation/nvme-dim.1 index c417d2e..c944163 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DIM" "1" "12/21/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=<task> | \-t <task>] - [\-\-nqn=<nqn> | \-n <nqn>] - [\-\-device=<device> | \-d <device>] +\fInvme dim\fR [\-\-task=<task> | \-t <task>] [\-\-nqn=<nqn> | \-n <nqn>] + [\-\-device=<device> | \-d <device>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 f5eb82c..d88df34 100644 --- a/Documentation/nvme-dim.html +++ b/Documentation/nvme-dim.html @@ -749,10 +749,9 @@ nvme-dim(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme dim</em>
- [--task=<task> | -t <task>]
- [--nqn=<nqn> | -n <nqn>]
- [--device=<device> | -d <device>]</pre>
+<pre class="content"><em>nvme dim</em> [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]
+ [--device=<device> | -d <device>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -817,6 +816,29 @@ with the nvme-discover(1) command using the --persistent option.</p></div> be supplied to apply the command to more than one DC.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -863,7 +885,7 @@ Deregister from Central Discovery Controller (CDC) associated with nvme4 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-dim.txt b/Documentation/nvme-dim.txt index 52df256..fcfc9b8 100644 --- a/Documentation/nvme-dim.txt +++ b/Documentation/nvme-dim.txt @@ -3,15 +3,15 @@ nvme-dim(1) NAME ---- -nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers. +nvme-dim - Send Discovery Information Management command to one or more +Discovery Controllers. SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -51,6 +51,15 @@ OPTIONS with this NVMe device handle. A list of comma-separated device handles can 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. + EXAMPLES -------- * Register with the Central Discovery Controller (CDC) named diff --git a/Documentation/nvme-dir-receive.1 b/Documentation/nvme-dir-receive.1 index f34b23e..fce97d6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .fi .SH "DESCRIPTION" .sp @@ -73,9 +73,6 @@ Directive operation \-r <nsr>, \-\-req\-resource=<nsr> .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>, \-\-data\-len=<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 <fmt>, \-\-output\-format=<fmt> +.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 e73882f..112a3f4 100644 --- a/Documentation/nvme-dir-receive.html +++ b/Documentation/nvme-dir-receive.html @@ -750,13 +750,13 @@ nvme-dir-receive(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme dir-receive</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -835,9 +835,6 @@ printed to stdout for another program to parse.</p></div> <p>
Directive requested resource count
</p>
-</dd>
-</dl></div>
-<div class="paragraph"><p>+</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
@@ -873,7 +870,7 @@ cellspacing="0" cellpadding="4"> </tbody>
</table>
</div>
-<div class="dlist"><dl>
+</dd>
<dt class="hdlist1">
-l <data-len>
</dt>
@@ -911,6 +908,29 @@ cellspacing="0" cellpadding="4"> a structure.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -969,7 +989,7 @@ Get streams directive status : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-dir-receive.txt b/Documentation/nvme-dir-receive.txt index b412c0b..f3f31ba 100644 --- a/Documentation/nvme-dir-receive.txt +++ b/Documentation/nvme-dir-receive.txt @@ -9,13 +9,13 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -41,20 +41,19 @@ OPTIONS -D <dtype>:: --dir-type=<dtype>:: - Directive type + Directive type -S <dspec>:: --dir-spec=<dspec>:: - Directive specific + Directive specific -O <doper>:: --dir-oper=<doper>:: - Directive operation + Directive operation -r <nsr>:: --req-resource=<nsr>:: Directive requested resource count - + [] |================== @@ -82,6 +81,15 @@ OPTIONS Print the decoded receive buffer to stdout if the command returns 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. + EXAMPLES -------- * Identify directive type supported : diff --git a/Documentation/nvme-dir-send.1 b/Documentation/nvme-dir-send.1 index 7476e8b..cfb2087 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .fi .SH "DESCRIPTION" .sp @@ -79,9 +79,6 @@ Target directive of the operation \-e <endir>, \-\-endir=<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>, \-\-data\-len=<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 <fmt>, \-\-output\-format=<fmt> +.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 c2acdb3..8ffbf30 100644 --- a/Documentation/nvme-dir-send.html +++ b/Documentation/nvme-dir-send.html @@ -750,14 +750,14 @@ nvme-dir-send(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme dir-send</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -848,9 +848,6 @@ printed to stdout for another program to parse.</p></div> <p>
Target directive enable(1) or disable (0) operation
</p>
-</dd>
-</dl></div>
-<div class="paragraph"><p>+</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
@@ -886,7 +883,7 @@ cellspacing="0" cellpadding="4"> </tbody>
</table>
</div>
-<div class="dlist"><dl>
+</dd>
<dt class="hdlist1">
-l <data-len>
</dt>
@@ -924,6 +921,29 @@ cellspacing="0" cellpadding="4"> a structure.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -982,7 +1002,7 @@ Release stream ID 3 : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-dir-send.txt b/Documentation/nvme-dir-send.txt index eb5dad0..1e3743d 100644 --- a/Documentation/nvme-dir-send.txt +++ b/Documentation/nvme-dir-send.txt @@ -9,14 +9,14 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -43,15 +43,15 @@ OPTIONS -D <dtype>:: --dir-type=<dtype>:: - Directive type + Directive type -S <dspec>:: --dir-spec=<dspec>:: - Directive specific + Directive specific -O <doper>:: --dir-oper=<doper>:: - Directive operation + Directive operation -T <tdir>:: --target-dir=<nsr>:: @@ -60,7 +60,6 @@ OPTIONS -e <endir>:: --endir=<endir>:: Target directive enable(1) or disable (0) operation - + [] |================== @@ -88,6 +87,15 @@ OPTIONS Print the decoded receive buffer to stdout if the command returns 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. + EXAMPLES -------- * Enable streams directive : diff --git a/Documentation/nvme-disconnect-all.1 b/Documentation/nvme-disconnect-all.1 index bee5db7..a2cde6a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 afc08e0..6bd3efc 100644 --- a/Documentation/nvme-disconnect-all.html +++ b/Documentation/nvme-disconnect-all.html @@ -749,7 +749,7 @@ nvme-disconnect-all(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme disconnect-all</em></pre>
+<pre class="content"><em>nvme disconnect-all</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -763,6 +763,36 @@ background.</p></div> </div>
</div>
<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="ulist"><ul>
@@ -795,7 +825,7 @@ Disconnect all existing nvme controllers: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-disconnect-all.txt b/Documentation/nvme-disconnect-all.txt index 6be7e41..9f023ea 100644 --- a/Documentation/nvme-disconnect-all.txt +++ b/Documentation/nvme-disconnect-all.txt @@ -8,7 +8,7 @@ nvme-disconnect-all - Disconnect from all connected Fabrics controllers. SYNOPSIS -------- [verse] -'nvme disconnect-all' +'nvme disconnect-all' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,6 +17,17 @@ Disconnects and removes all existing NVMe over Fabrics controllers. See the documentation for the nvme-disconnect(1) command for further 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 -------- * Disconnect all existing nvme controllers: diff --git a/Documentation/nvme-disconnect.1 b/Documentation/nvme-disconnect.1 index 58120ba..18ae643 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT" "1" "12/21/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=<subnqn> | \-n <subnqn>] - [\-\-device=<device> | \-d <device>] +\fInvme disconnect\fR [\-\-nqn=<subnqn> | \-n <subnqn>] + [\-\-device=<device> | \-d <device>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 87df800..5ffdd76 100644 --- a/Documentation/nvme-disconnect.html +++ b/Documentation/nvme-disconnect.html @@ -749,9 +749,9 @@ nvme-disconnect(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme disconnect</em>
- [--nqn=<subnqn> | -n <subnqn>]
- [--device=<device> | -d <device>]</pre>
+<pre class="content"><em>nvme disconnect</em> [--nqn=<subnqn> | -n <subnqn>]
+ [--device=<device> | -d <device>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -761,7 +761,7 @@ nvme-disconnect(1) Manual Page <div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
</div>
</div>
@@ -793,6 +793,29 @@ the controller specified by the --device option will be removed.</p></div> removed.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -839,7 +862,7 @@ Disconnect the controller nvme4 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-disconnect.txt b/Documentation/nvme-disconnect.txt index badb86f..d3b8c52 100644 --- a/Documentation/nvme-disconnect.txt +++ b/Documentation/nvme-disconnect.txt @@ -8,15 +8,15 @@ nvme-disconnect - Disconnect one or more Fabrics controller(s). SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- 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. OPTIONS @@ -31,6 +31,15 @@ OPTIONS Indicates that the controller with the specified name should be 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. + EXAMPLES -------- * Disconnect all controllers for a subsystem named @@ -50,7 +59,6 @@ SEE ALSO -------- nvme-connect(1) - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-discover.1 b/Documentation/nvme-discover.1 index fb940a5..0a5f2bf 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCOVER" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DISCOVER" "1" "12/21/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=<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>] +\fInvme discover\fR [\-\-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] .fi .SH "DESCRIPTION" .sp @@ -254,11 +245,12 @@ Suppress already connected errors\&. Print out resulting JSON configuration file to stdout\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP @@ -286,6 +278,20 @@ Use a user\-defined path to the NBFT tables .RS 4 Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 bce1ae8..dc56c6b 100644 --- a/Documentation/nvme-discover.html +++ b/Documentation/nvme-discover.html @@ -749,39 +749,30 @@ nvme-discover(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme discover</em>
- [--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>]</pre>
+<pre class="content"><em>nvme discover</em> [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -793,7 +784,7 @@ nvme-discover(1) Manual Page Controller.</p></div>
<div class="paragraph"><p>If no parameters are given, then <em>nvme discover</em> 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.</p></div>
<div class="paragraph"><p>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.</p></div> <div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>A Discovery Controller has it’s own NQN defined in the NVMe-over-Fabrics
-specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery
+specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery
Controllers must use this NQN name. This NQN is used by default by
nvme-cli for the <em>discover</em> command.</p></div>
</div>
@@ -837,7 +828,7 @@ nvme-cli for the <em>discover</em> command.</p></div> <dd>
<p>
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:
</p>
<div class="tableblock">
<table rules="all"
@@ -903,7 +894,7 @@ cellspacing="0" cellpadding="4"> </dt>
<dd>
<p>
- 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.
</p>
@@ -1168,15 +1159,15 @@ cellspacing="0" cellpadding="4"> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
@@ -1222,6 +1213,29 @@ cellspacing="0" cellpadding="4"> the management of the global resources.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1265,9 +1279,9 @@ Issue a <em>nvme discover</em> command using a /usr/local/etc/nvme/discovery.con </p>
<div class="listingblock">
<div class="content">
-<pre><code># Machine default 'nvme discover' commands. Query the
+<pre><code># 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)</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index a0ffb36..32f10bc 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -8,39 +8,30 @@ nvme-discover - Send Get Log Page request to Discovery Controller. SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -49,7 +40,7 @@ Controller. If no parameters are given, then 'nvme discover' will attempt to find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of -Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file +Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file exists, the command will quit with an error. Otherwise, a specific Discovery Controller should be specified using the @@ -61,7 +52,7 @@ BACKGROUND 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 @@ -76,7 +67,7 @@ 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. @@ -85,7 +76,7 @@ OPTIONS -t <trtype>:: --transport=<trtype>:: 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: + [] |================= @@ -108,7 +99,7 @@ OPTIONS -s <trsvcid>:: --trsvcid=<trsvcid>:: - 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. @@ -223,10 +214,10 @@ OPTIONS --dump-config:: Print out resulting JSON configuration file to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. --force:: Disable the built-in persistent discover connection rules. @@ -234,18 +225,27 @@ OPTIONS persistent discovery connection. --nbft:: - Only look at NBFT tables + Only look at NBFT tables --no-nbft:: - Do not look at NBFT tables + Do not look at NBFT tables --nbft-path=<STR>:: - Use a user-defined path to the NBFT tables + Use a user-defined path to the NBFT tables --context <STR>:: Set the execution context to <STR>. This allows to coordinate 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. + EXAMPLES -------- * Query the Discover Controller with IP4 address 192.168.1.3 for all @@ -272,9 +272,9 @@ Port 4420 is used by default: * Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file: + ----------- -# 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 diff --git a/Documentation/nvme-dsm.1 b/Documentation/nvme-dsm.1 index 1f228e6..d5b3222 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DSM" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-DSM" "1" "12/21/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 <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> ] +\fInvme dsm\fR <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 58c1764..e522e97 100644 --- a/Documentation/nvme-dsm.html +++ b/Documentation/nvme-dsm.html @@ -749,12 +749,14 @@ nvme-dsm(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme dsm</em> <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> ]</pre>
+<pre class="content"><em>nvme dsm</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -873,6 +875,29 @@ any settings from the flags may have provided.</p></div> specifying individual attributes
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -893,7 +918,7 @@ any settings from the flags may have provided.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-dsm.txt b/Documentation/nvme-dsm.txt index ff658a7..6a2e61a 100644 --- a/Documentation/nvme-dsm.txt +++ b/Documentation/nvme-dsm.txt @@ -8,13 +8,14 @@ nvme-dsm - Send NVMe Data Set Management, return results SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -73,6 +74,15 @@ OPTIONS All the command command dword 11 attributes. Use exclusive from 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. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-effects-log.1 b/Documentation/nvme-effects-log.1 index 66741c3..c97df78 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-output\-format=<fmt> | \-o <fmt>] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] +\fInvme effects\-log\fR <device> [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -45,11 +44,6 @@ The <device> 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 <format>, \-\-output\-format=<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 <fmt>, \-\-output\-format=<fmt> +.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 23dc161..17ec867 100644 --- a/Documentation/nvme-effects-log.html +++ b/Documentation/nvme-effects-log.html @@ -749,9 +749,8 @@ nvme-effects-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme effects-log</em> <device> [--output-format=<fmt> | -o <fmt>]
- [--human-readable | -H]
- [--raw-binary | -b]</pre>
+<pre class="content"><em>nvme effects-log</em> <device> [--human-readable | -H] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -772,39 +771,50 @@ for each command that is supported.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-H
</dt>
<dt class="hdlist1">
---output-format=<format>
+--human-readable
</dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
--H
+-b
</dt>
<dt class="hdlist1">
---human-readable
+--raw-binary
</dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
--b
+-o <fmt>
</dt>
<dt class="hdlist1">
---raw-binary
+--output-format=<fmt>
</dt>
<dd>
<p>
- 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 <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -847,7 +857,7 @@ Have the program return the raw structure in binary: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-effects-log.txt b/Documentation/nvme-effects-log.txt index f7d0092..57a1369 100644 --- a/Documentation/nvme-effects-log.txt +++ b/Documentation/nvme-effects-log.txt @@ -3,14 +3,14 @@ nvme-effects-log(1) NAME ---- -nvme-effects-log - Send NVMe Command Effects log page request, returns result and log +nvme-effects-log - Send NVMe Command Effects log page request, returns result +and log SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -26,11 +26,6 @@ for each command that is supported. OPTIONS ------- --o <format>:: ---output-format=<format>:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields into a @@ -39,7 +34,16 @@ OPTIONS -b:: --raw-binary:: This option will print the raw buffer to stdout. Structure is not - parsed by program. This overrides the human-readable option. + parsed by program. This overrides the human-readable option. + +-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 -------- diff --git a/Documentation/nvme-endurance-event-agg-log.1 b/Documentation/nvme-endurance-event-agg-log.1 index c908d90..72bf8a6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-endurance-event-agg-log.html b/Documentation/nvme-endurance-event-agg-log.html index 771ce5a..c80cd0d 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 <div class="verseblock">
<pre class="content"><em>nvme endurance-event-agg-log</em> <device> [--log-entries=<log_entries> | -e <log_entries>]
[--rae | -r] [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,11 +781,11 @@ printed to stdout for another program to parse, or reported in json format.</p>< </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -800,15 +800,26 @@ printed to stdout for another program to parse, or reported in json format.</p>< </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -851,7 +862,7 @@ Print the raw Endurance log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-endurance-event-agg-log.txt b/Documentation/nvme-endurance-event-agg-log.txt index 69701e3..7cbceb1 100644 --- a/Documentation/nvme-endurance-event-agg-log.txt +++ b/Documentation/nvme-endurance-event-agg-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] '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] DESCRIPTION ----------- @@ -29,20 +29,24 @@ OPTIONS ------- -e <log_entries>:: --log-entries=<log_entries>:: - 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. -r:: --rae:: Retain an Asynchronous Event. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-endurance-log.1 b/Documentation/nvme-endurance-log.1 index ec34603..5d653e1 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-group\-id=<group> | \-g <group>] - [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-endurance-log.html b/Documentation/nvme-endurance-log.html index 109bdf1..1ec51f6 100644 --- a/Documentation/nvme-endurance-log.html +++ b/Documentation/nvme-endurance-log.html @@ -750,7 +750,7 @@ nvme-endurance-log(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme endurance-log</em> <device> [--group-id=<group> | -g <group>]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -783,15 +783,26 @@ printed to stdout for another program to parse, or reported in json format.</p>< </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -834,7 +845,7 @@ Print the raw Endurance log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-endurance-log.txt b/Documentation/nvme-endurance-log.txt index 5e18b57..c263834 100644 --- a/Documentation/nvme-endurance-log.txt +++ b/Documentation/nvme-endurance-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme endurance-log' <device> [--group-id=<group> | -g <group>] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -29,10 +29,14 @@ OPTIONS --group-id=<group>:: The endurance group identifier. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index 1666278..3a0d154 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-log\-entries=<entries> | \-e <entries>] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] +\fInvme error\-log\fR <device> [\-\-log\-entries=<entries> | \-e <entries>] + [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-error-log.html b/Documentation/nvme-error-log.html index d83eb97..229b883 100644 --- a/Documentation/nvme-error-log.html +++ b/Documentation/nvme-error-log.html @@ -749,9 +749,9 @@ nvme-error-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme error-log</em> <device> [--log-entries=<entries> | -e <entries>]
- [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+<pre class="content"><em>nvme error-log</em> <device> [--log-entries=<entries> | -e <entries>]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -798,15 +798,26 @@ printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -849,7 +860,7 @@ Print the raw output to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt index eebaca7..94442ee 100644 --- a/Documentation/nvme-error-log.txt +++ b/Documentation/nvme-error-log.txt @@ -8,9 +8,9 @@ nvme-error-log - Send NVME Error log page request, return result and log SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -37,11 +37,14 @@ OPTIONS --raw-binary:: Print the raw error log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-fdp-configs.1 b/Documentation/nvme-fdp-configs.1 index bafe726..2b7903f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-configs.html b/Documentation/nvme-fdp-configs.html index 7035659..fe68c4a 100644 --- a/Documentation/nvme-fdp-configs.html +++ b/Documentation/nvme-fdp-configs.html @@ -750,9 +750,8 @@ nvme-fdp-configs(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fdp configs</em> <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--human-readable | -H]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]</pre>
+ [--human-readable | -H] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -802,10 +801,10 @@ the possible configurations for Flexible Data Placement.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -827,7 +826,7 @@ the possible configurations for Flexible Data Placement.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-configs.txt b/Documentation/nvme-fdp-configs.txt index c4311fb..d5cc487 100644 --- a/Documentation/nvme-fdp-configs.txt +++ b/Documentation/nvme-fdp-configs.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- @@ -32,8 +31,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fdp-events.1 b/Documentation/nvme-fdp-events.1 index 6a1017a..1949d3d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] - [\-\-host\-events | \-E] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<FMT> | \-o <FMT>] +\fInvme fdp events\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-host\-events | \-E] + [\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-events.html b/Documentation/nvme-fdp-events.html index 972d185..91f7d2f 100644 --- a/Documentation/nvme-fdp-events.html +++ b/Documentation/nvme-fdp-events.html @@ -749,10 +749,8 @@ nvme-fdp-events(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme fdp events</em> <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--host-events | -E]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]</pre>
+<pre class="content"><em>nvme fdp events</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--host-events | -E]
+ [--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -802,10 +800,10 @@ Units and media usage in an Endurance Group.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -827,7 +825,7 @@ Units and media usage in an Endurance Group.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-events.txt b/Documentation/nvme-fdp-events.txt index 606a163..5602f44 100644 --- a/Documentation/nvme-fdp-events.txt +++ b/Documentation/nvme-fdp-events.txt @@ -8,10 +8,8 @@ nvme-fdp-events - Get Flexible Data Placement Events SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -32,8 +30,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fdp-set-events.1 b/Documentation/nvme-fdp-set-events.1 index 82be4a0..860f6e0 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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,>] .fi .SH "DESCRIPTION" .sp @@ -52,7 +51,7 @@ Namespace identifier\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 4541a6c..95c3e6e 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fdp set-events</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--placement-handle=<NUM> | -p <NUM>]
- [--enable | -e]
- [--event-types=<NUM,> | -t <NUM,>]</pre>
+ [--placement-handle=<NUM> | -p <NUM>] [--enable | -e]
+ [--event-types=<NUM,> | -t <NUM,>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -792,10 +791,10 @@ Handle.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -817,7 +816,7 @@ Handle.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-set-events.txt b/Documentation/nvme-fdp-set-events.txt index b45819b..b93cdc3 100644 --- a/Documentation/nvme-fdp-set-events.txt +++ b/Documentation/nvme-fdp-set-events.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] '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,>] DESCRIPTION ----------- @@ -29,8 +28,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fdp-stats.1 b/Documentation/nvme-fdp-stats.1 index 703382c..629162d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<FMT> | \-o <FMT>] +\fInvme fdp stats\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-stats.html b/Documentation/nvme-fdp-stats.html index 892bcf9..8d81eef 100644 --- a/Documentation/nvme-fdp-stats.html +++ b/Documentation/nvme-fdp-stats.html @@ -749,9 +749,8 @@ nvme-fdp-stats(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme fdp stats</em> <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]</pre>
+<pre class="content"><em>nvme fdp stats</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -790,10 +789,10 @@ the life of the FDP configuration in an Endurance Group.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -815,7 +814,7 @@ the life of the FDP configuration in an Endurance Group.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-stats.txt b/Documentation/nvme-fdp-stats.txt index 7f96065..0b184a9 100644 --- a/Documentation/nvme-fdp-stats.txt +++ b/Documentation/nvme-fdp-stats.txt @@ -8,9 +8,8 @@ nvme-fdp-stats - Get Flexible Data Placement Statistics SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -27,8 +26,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fdp-status.1 b/Documentation/nvme-fdp-status.1 index 752b00e..6fefff4 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<FMT> | \-o <FMT>] +\fInvme fdp status\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" .sp @@ -51,7 +50,7 @@ Namespace identifier\&. Print the raw buffer to the standard output stream\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-status.html b/Documentation/nvme-fdp-status.html index d53f4f9..01a7b60 100644 --- a/Documentation/nvme-fdp-status.html +++ b/Documentation/nvme-fdp-status.html @@ -749,9 +749,8 @@ nvme-fdp-status(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme fdp status</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]</pre>
+<pre class="content"><em>nvme fdp status</em> <device> [--namespace-id=<NUM> | -n <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -790,10 +789,10 @@ are accessible by the specified namespace.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -815,7 +814,7 @@ are accessible by the specified namespace.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-status.txt b/Documentation/nvme-fdp-status.txt index 263cb4c..78dddae 100644 --- a/Documentation/nvme-fdp-status.txt +++ b/Documentation/nvme-fdp-status.txt @@ -8,9 +8,8 @@ nvme-fdp-status - Get Reclaim Unit Handle Status SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -27,8 +26,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fdp-update.1 b/Documentation/nvme-fdp-update.1 index 5bb9528..abf36fd 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] - [\-\-pids=<NUM,> | \-p <NUM,>] + [\-\-pids=<NUM,> | \-p <NUM,>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-fdp-update.html b/Documentation/nvme-fdp-update.html index 63e8042..1fd97c7 100644 --- a/Documentation/nvme-fdp-update.html +++ b/Documentation/nvme-fdp-update.html @@ -750,7 +750,7 @@ nvme-fdp-update(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fdp update</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--pids=<NUM,> | -p <NUM,>]</pre>
+ [--pids=<NUM,> | -p <NUM,>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -802,7 +802,7 @@ a different Reclaim Unit accessible by the specified namespace.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-update.txt b/Documentation/nvme-fdp-update.txt index 4b70c24..5af83e5 100644 --- a/Documentation/nvme-fdp-update.txt +++ b/Documentation/nvme-fdp-update.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fdp update' <device> [--namespace-id=<NUM> | -n <NUM>] - [--pids=<NUM,> | -p <NUM,>] + [--pids=<NUM,> | -p <NUM,>] DESCRIPTION ----------- diff --git a/Documentation/nvme-fdp-usage.1 b/Documentation/nvme-fdp-usage.1 index 41873e4..b561adb 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<FMT> | \-o <FMT>] +\fInvme fdp usage\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, diff --git a/Documentation/nvme-fdp-usage.html b/Documentation/nvme-fdp-usage.html index e789004..a617aa0 100644 --- a/Documentation/nvme-fdp-usage.html +++ b/Documentation/nvme-fdp-usage.html @@ -749,9 +749,8 @@ nvme-fdp-usage(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme fdp usage</em> <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]</pre>
+<pre class="content"><em>nvme fdp usage</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -791,10 +790,10 @@ Endurance Group.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -816,7 +815,7 @@ Endurance Group.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fdp-usage.txt b/Documentation/nvme-fdp-usage.txt index ad9d1eb..3e0fb98 100644 --- a/Documentation/nvme-fdp-usage.txt +++ b/Documentation/nvme-fdp-usage.txt @@ -8,9 +8,8 @@ nvme-fdp-usage - Get Reclaim Unit Handle Usage SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -28,8 +27,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o <format>:: ---output-format=<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. diff --git a/Documentation/nvme-fid-support-effects-log.1 b/Documentation/nvme-fid-support-effects-log.1 index d833b37..8c2ab58 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme fid\-support\-effects\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,17 +43,23 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP -\-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 ef42d4c..255a1bc 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme fid-support-effects-log</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme fid-support-effects-log</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -771,27 +771,38 @@ raw buffer may be printed to stdout.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-H
</dt>
<dt class="hdlist1">
---output-format=<format>
+--human-readable
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. 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.
</p>
</dd>
<dt class="hdlist1">
--H
+-o <fmt>
</dt>
<dt class="hdlist1">
---human-readable
+--output-format=<fmt>
</dt>
<dd>
<p>
- This option will parse and format many of the bit fields
- into human-readable formats.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -814,7 +825,7 @@ raw buffer may be printed to stdout.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fid-support-effects-log.txt b/Documentation/nvme-fid-support-effects-log.txt index 5d12b18..9670b88 100644 --- a/Documentation/nvme-fid-support-effects-log.txt +++ b/Documentation/nvme-fid-support-effects-log.txt @@ -8,7 +8,7 @@ nvme-fid-support-effects-log - Send NVMe FID Support and Effects log, return res SYNOPSIS -------- [verse] -'nvme fid-support-effects-log' <device> [-o <fmt> | --output-format=<fmt>] +'nvme fid-support-effects-log' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -24,16 +24,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --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:: --human-readable:: This option will parse and format many of the bit fields 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index b21d3fb..4e60728 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FLUSH" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FLUSH" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ nvme-flush \- Flush command\&. .sp .nf \fInvme flush\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 d4f3dd1..d0fefd2 100644 --- a/Documentation/nvme-flush.html +++ b/Documentation/nvme-flush.html @@ -749,7 +749,8 @@ nvme-flush(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme flush</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre>
+<pre class="content"><em>nvme flush</em> <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -780,6 +781,29 @@ any namespace.</p></div> 0xffffffff, indicating flush for all namespaces.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -800,7 +824,7 @@ any namespace.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-flush.txt b/Documentation/nvme-flush.txt index 28cfa63..102cd71 100644 --- a/Documentation/nvme-flush.txt +++ b/Documentation/nvme-flush.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme flush' <device> [--namespace-id=<nsid> | -n <nsid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -25,6 +26,15 @@ OPTIONS Specify the optional namespace id for this command. Defaults to 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index 63a099c..8fbcaaf 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,15 +33,13 @@ nvme-format \- Format an NVMe device .sp .nf \fInvme format\fR <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 b617bb8..cc7f899 100644 --- a/Documentation/nvme-format.html +++ b/Documentation/nvme-format.html @@ -750,15 +750,13 @@ nvme-format(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme format</em> <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> ]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -995,6 +993,29 @@ cellspacing="0" cellpadding="4"> Override default timeout value. In milliseconds.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1035,7 +1056,7 @@ information: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-format.txt b/Documentation/nvme-format.txt index cbadd1d..e4623f1 100644 --- a/Documentation/nvme-format.txt +++ b/Documentation/nvme-format.txt @@ -9,15 +9,13 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -135,6 +133,15 @@ cryptographically. This is accomplished by deleting the encryption key. --timeout=<timeout>:: 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. + EXAMPLES -------- * Format the device using all defaults: diff --git a/Documentation/nvme-fw-commit.1 b/Documentation/nvme-fw-commit.1 index 748b9b0..d002b07 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 3b84432..82f1b8e 100644 --- a/Documentation/nvme-fw-commit.html +++ b/Documentation/nvme-fw-commit.html @@ -750,8 +750,9 @@ nvme-fw-commit(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fw-commit</em> <device> [--slot=<slot> | -s <slot>]
- [--action=<action> | -a <action>]
- [--bpid=<boot-partid> | -b <boot-partid> ]</pre>
+ [--action=<action> | -a <action>]
+ [--bpid=<boot-partid> | -b <boot-partid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -869,6 +870,29 @@ BPINFO.ABPID.</p></td> if applicable (default: 0)
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -905,7 +929,7 @@ commit the last downloaded fw to slot 1. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fw-commit.txt b/Documentation/nvme-fw-commit.txt index 337e783..8e08bd4 100644 --- a/Documentation/nvme-fw-commit.txt +++ b/Documentation/nvme-fw-commit.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -75,6 +76,15 @@ BPINFO.ABPID. Specifies the Boot partition that shall be used for the Commit Action, 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. + EXAMPLES -------- * commit the last downloaded fw to slot 1. diff --git a/Documentation/nvme-fw-download.1 b/Documentation/nvme-fw-download.1 index 6839e72..39e181b 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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>, \-\-offset=<offset> +\-O <offset>, \-\-offset=<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 <fmt>, \-\-output\-format=<fmt> +.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 2ca7499..d39f1e5 100644 --- a/Documentation/nvme-fw-download.html +++ b/Documentation/nvme-fw-download.html @@ -750,8 +750,9 @@ nvme-fw-download(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fw-download</em> <device> [--fw=<firmware-file> | -f <firmware-file>]
- [--xfer=<transfer-size> | -x <transfer-size>]
- [--offset=<offset> | -o <offset>]</pre>
+ [--xfer=<transfer-size> | -x <transfer-size>]
+ [--offset=<offset> | -O <offset>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -809,7 +810,7 @@ the Firmware Commit command (nvme fw-commit <args>).</p></div> </p>
</dd>
<dt class="hdlist1">
--o <offset>
+-O <offset>
</dt>
<dt class="hdlist1">
--offset=<offset>
@@ -822,6 +823,29 @@ the Firmware Commit command (nvme fw-commit <args>).</p></div> <em>xfer</em> size given.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -852,7 +876,7 @@ Transfer a firmware size 128KiB at a time: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fw-download.txt b/Documentation/nvme-fw-download.txt index 84e407e..1ec466f 100644 --- a/Documentation/nvme-fw-download.txt +++ b/Documentation/nvme-fw-download.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -48,13 +49,22 @@ OPTIONS the device has a max transfer size requirement for firmware. It defaults to 4k. --o <offset>:: +-O <offset>:: --offset=<offset>:: 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 '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. + EXAMPLES -------- * Transfer a firmware size 128KiB at a time: diff --git a/Documentation/nvme-fw-log.1 b/Documentation/nvme-fw-log.1 index 09f9bdd..63fe225 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-fw-log.html b/Documentation/nvme-fw-log.html index 37d313d..627d5d9 100644 --- a/Documentation/nvme-fw-log.html +++ b/Documentation/nvme-fw-log.html @@ -750,7 +750,7 @@ nvme-fw-log(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme fw-log</em> <device> [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -784,15 +784,26 @@ printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -835,7 +846,7 @@ Print the log firmware to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-fw-log.txt b/Documentation/nvme-fw-log.txt index 4b73577..d957548 100644 --- a/Documentation/nvme-fw-log.txt +++ b/Documentation/nvme-fw-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fw-log' <device> [--raw-binary | -b] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -30,11 +30,14 @@ OPTIONS --raw-binary:: Print the raw fw log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-gen-dhchap-key.txt b/Documentation/nvme-gen-dhchap-key.txt index 79e8ed5..1e5f969 100644 --- a/Documentation/nvme-gen-dhchap-key.txt +++ b/Documentation/nvme-gen-dhchap-key.txt @@ -9,9 +9,10 @@ SYNOPSIS -------- [verse] 'nvme gen-dhchap-key' [--hmac=<hmac-id> | -h <hmac-id>] - [--secret=<secret> | -s <secret> ] - [--key-length=<len> | -l <len> ] - [--nqn=<host-nqn> | -n <host-nqn> ] + [--secret=<secret> | -s <secret>] + [--key-length=<len> | -l <len>] + [--nqn=<host-nqn> | -n <host-nqn>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -43,6 +44,15 @@ OPTIONS Host-NQN to be used for the transformation. This parameter is only valid if a non-zero HMAC function has been 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. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index 37e9229..abdba4c 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 4ae8da7..c4ee073 100644 --- a/Documentation/nvme-gen-hostnqn.html +++ b/Documentation/nvme-gen-hostnqn.html @@ -749,7 +749,7 @@ nvme-gen-hostnqn(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme gen-hostnqn</em></pre>
+<pre class="content"><em>nvme gen-hostnqn</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -765,7 +765,31 @@ and prints it to stdout.</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>No options needed</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -785,7 +809,7 @@ and prints it to stdout.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-gen-hostnqn.txt b/Documentation/nvme-gen-hostnqn.txt index 9efefb5..7b7d776 100644 --- a/Documentation/nvme-gen-hostnqn.txt +++ b/Documentation/nvme-gen-hostnqn.txt @@ -8,7 +8,7 @@ nvme-gen-hostnqn - Generate a host NVMe Qualified Name SYNOPSIS -------- [verse] -'nvme gen-hostnqn' +'nvme gen-hostnqn' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -18,7 +18,14 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-gen-tls-key.txt b/Documentation/nvme-gen-tls-key.txt index 9a03e3a..772c7bc 100644 --- a/Documentation/nvme-gen-tls-key.txt +++ b/Documentation/nvme-gen-tls-key.txt @@ -9,24 +9,29 @@ SYNOPSIS -------- [verse] 'nvme gen-tls-key' [--keyring=<name> | -k <name>] - [--keytype=<type> | -t <type> ] - [--hostnqn=<nqn> | -n <nqn>] - [--subsysnqn=<nqn> | -c <nqn>] - [--hmac=<hmac-id> | -h <hmac-id>] - [--secret=<secret> | -s <secret> ] - [--insert | -i ] + [--keytype=<type> | -t <type>] + [--hostnqn=<nqn> | -n <nqn>] + [--subsysnqn=<nqn> | -c <nqn>] + [--hmac=<hmac-id> | -h <hmac-id>] + [--identity=<id-vers> | -I <id-vers>] + [--secret=<secret> | -s <secret>] + [--insert | -i] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- Generate a base64-encoded NVMe TLS pre-shared key (PSK). The resulting key is either printed in the PSK interchange format -'NVMeTLSkey-1:01:<base64 encoded data>:', -inserted as a 'retained' key into the specified keyring, or both. +'NVMeTLSkey-1:01:<base64 encoded data>:' or inserted as a +'retained' key into the specified keyring if the '--insert' option +is given. When the PSK should be inserted into the keyring a 'retained' key -is derived from the secret key material, and the resulting 'retained' +is derived from the secret key material. The resulting 'retained' key is stored with the identity 'NVMe0R0<hmac> <host NQN> <subsystem NQN>' -in the keyring. +(for identity version '0') or +'NVMe1R0<hmac> <host NQN> <subsystem NQN> <PSK hash>' +(for identity version '1') in the keyring. The 'retained' key is derived from the secret key material, the specified subsystem NQN, and the host NQN. Once the 'retained' key is stored in the keyring the original @@ -60,6 +65,12 @@ OPTIONS 1 - SHA-256 (default) 2 - SHA-384 +-I <vers>:: +--identity=<id-vers>:: + Select the TLS identity to use. Possible values are: + 0 - Original NVMe TLS 1.0c identity + 1 - NVMe TLS 2.0 (TP8018) identity + -s <secret>:: --secret=<secret>:: Secret value (in hexadecimal) to be used for the key. If none are @@ -70,6 +81,15 @@ OPTIONS Insert the resulting TLS key into the keyring without printing out the key in PSK interchange 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. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-get-feature.1 b/Documentation/nvme-get-feature.1 index 015d5c2..ea7653a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 7752e56..6ee42ae 100644 --- a/Documentation/nvme-get-feature.html +++ b/Documentation/nvme-get-feature.html @@ -750,12 +750,13 @@ nvme-get-feature(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme get-feature</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -906,6 +907,29 @@ cellspacing="0" cellpadding="4"> into human-readable formats.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -977,7 +1001,7 @@ format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-get-feature.txt b/Documentation/nvme-get-feature.txt index 34df0c3..6477bc6 100644 --- a/Documentation/nvme-get-feature.txt +++ b/Documentation/nvme-get-feature.txt @@ -9,12 +9,13 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -81,6 +82,15 @@ OPTIONS This option will parse and format many of the bit fields 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. + EXAMPLES -------- * Retrieves the feature for Number of Queues, or feature id 7: diff --git a/Documentation/nvme-get-lba-status.1 b/Documentation/nvme-get-lba-status.1 index b42f2e5..97efab3 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-get-lba-status.html b/Documentation/nvme-get-lba-status.html index c1a03a4..e739871 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme get-lba-status</em> <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>]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -846,15 +846,26 @@ printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -896,7 +907,7 @@ Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-get-lba-status.txt b/Documentation/nvme-get-lba-status.txt index 157dc41..9ef9d59 100644 --- a/Documentation/nvme-get-lba-status.txt +++ b/Documentation/nvme-get-lba-status.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -57,10 +57,14 @@ OPTIONS --timeout=<timeout>:: Override default timeout value. In milliseconds. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1 index 804e18c..66a3573 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <offset>, \-\-lpo=<offset> +\-L <offset>, \-\-lpo=<offset> .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 <length>: Specify the read chunk size\&. The length argument is expected to be a multiple of 4096\&. The default size is 4096\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 6480f1b..2c25c2b 100644 --- a/Documentation/nvme-get-log.html +++ b/Documentation/nvme-get-log.html @@ -750,17 +750,18 @@ nvme-get-log(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme get-log</em> <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>]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -845,7 +846,7 @@ program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <offset>
+-L <offset>
</dt>
<dt class="hdlist1">
--lpo=<offset>
@@ -929,6 +930,29 @@ program to parse.</p></div> a multiple of 4096. The default size is 4096.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -973,7 +997,7 @@ Have the program return the raw log page in binary: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-get-log.txt b/Documentation/nvme-get-log.txt index a51c435..98b1f9c 100644 --- a/Documentation/nvme-get-log.txt +++ b/Documentation/nvme-get-log.txt @@ -9,17 +9,18 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -63,7 +64,7 @@ OPTIONS --raw-binary:: Print the raw log buffer to stdout. --o <offset>:: +-L <offset>:: --lpo=<offset>:: The log page offset specifies the location within a log page to start returning data from. It's Dword-aligned and 64-bits. @@ -101,6 +102,15 @@ OPTIONS Specify the read chunk size. The length argument is expected to be 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. + EXAMPLES -------- * Get 512 bytes from log page 2 diff --git a/Documentation/nvme-get-ns-id.1 b/Documentation/nvme-get-ns-id.1 index e42c26e..f317c17 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> +\fInvme get\-ns\-id\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Retrieves the namespace ID for an NVMe block device\&. The <device> param is mandatory and must be an NVMe block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" -.sp -None +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 e4f0838..dcdc39e 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme get-ns-id</em> <device></pre>
+<pre class="content"><em>nvme get-ns-id</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -764,7 +764,31 @@ is mandatory and must be an NVMe block device (ex: /dev/nvme0n1).</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>None</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -794,7 +818,7 @@ Shows the namespace id for the given block device: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-get-ns-id.txt b/Documentation/nvme-get-ns-id.txt index 5dcdc6d..8516cb8 100644 --- a/Documentation/nvme-get-ns-id.txt +++ b/Documentation/nvme-get-ns-id.txt @@ -8,7 +8,7 @@ nvme-get-ns-id - Retrieves the namespace ID for an NVMe block device SYNOPSIS -------- [verse] -'nvme get-ns-id' <device> +'nvme get-ns-id' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-get-property.1 b/Documentation/nvme-get-property.1 index 6735f12..79ed8c6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-offset=<offset> | \-o <offset>] - [\-\-human\-readable | \-H ] +\fInvme get\-property\fR <device> [\-\-offset=<offset> | \-O <offset>] + [\-\-human\-readable | \-H] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 f6ebe4f..9b2a793 100644 --- a/Documentation/nvme-get-property.html +++ b/Documentation/nvme-get-property.html @@ -749,8 +749,9 @@ nvme-get-property(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme get-property</em> <device> [--offset=<offset> | -o <offset>]
- [--human-readable | -H ]</pre>
+<pre class="content"><em>nvme get-property</em> <device> [--offset=<offset> | -O <offset>]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -766,7 +767,7 @@ nvme-get-property(1) Manual Page <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o
+-O
</dt>
<dt class="hdlist1">
--offset
@@ -785,6 +786,29 @@ nvme-get-property(1) Manual Page Show the fields packed in the property
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -843,7 +867,7 @@ Then look for NVMe Fabrics command (0x7f) at trace <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt index b2b7d29..601b8a4 100644 --- a/Documentation/nvme-get-property.txt +++ b/Documentation/nvme-get-property.txt @@ -9,25 +9,32 @@ for NVMe over Fabric SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- Reads and shows the defined NVMe controller property for NVMe over Fabric. - OPTIONS ------- --o:: +-O:: --offset:: - The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 + The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 -H:: --human-readable: 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. EXAMPLES -------- @@ -37,7 +44,6 @@ EXAMPLES # nvme get-property /dev/nvme0 --offset=0x0 --human-readable ------------ - BUGS ---- Currently the CAP value is truncated to 32 bits due to a limitation in diff --git a/Documentation/nvme-help.1 b/Documentation/nvme-help.1 index 4b68960..e22061a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-HELP" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-HELP" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-help.html b/Documentation/nvme-help.html index 102d647..3091633 100644 --- a/Documentation/nvme-help.html +++ b/Documentation/nvme-help.html @@ -794,7 +794,7 @@ Show help for nvme smart log: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-huawei-id-ctrl.1 b/Documentation/nvme-huawei-id-ctrl.1 index 2d11b8b..570bb01 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme huawei id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 608a2ac..2bbd642 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme huawei id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme huawei id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -813,15 +813,15 @@ will decode Huawei vendor unique portions of the structure.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -855,7 +855,7 @@ fields in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-huawei-id-ctrl.txt b/Documentation/nvme-huawei-id-ctrl.txt index f4d2f80..47225d1 100644 --- a/Documentation/nvme-huawei-id-ctrl.txt +++ b/Documentation/nvme-huawei-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-huawei-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -47,10 +47,10 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-huawei-list.1 b/Documentation/nvme-huawei-list.1 index f093e7e..70a1da9 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST" "1" "12/21/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 <fmt> | \-\-output\-format=<fmt>] +\fInvme huawei list\fR [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR diff --git a/Documentation/nvme-huawei-list.html b/Documentation/nvme-huawei-list.html index ef99034..c4e865f 100644 --- a/Documentation/nvme-huawei-list.html +++ b/Documentation/nvme-huawei-list.html @@ -749,7 +749,7 @@ nvme-list(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme huawei list</em> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme huawei list</em> [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -766,10 +766,10 @@ for those Huawei devices as well as some pertinent information about them.</p></ <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -797,7 +797,7 @@ for those Huawei devices as well as some pertinent information about them.</p></ <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-huawei-list.txt b/Documentation/nvme-huawei-list.txt index 65a6c21..95f1099 100644 --- a/Documentation/nvme-huawei-list.txt +++ b/Documentation/nvme-huawei-list.txt @@ -8,7 +8,7 @@ nvme-huawei-list - List all recognized Huawei NVMe devices SYNOPSIS -------- [verse] -'nvme huawei list' [-o <fmt> | --output-format=<fmt>] +'nvme huawei list' [--output-format=<fmt> | -o <fmt>] DESCRIPTION ----------- @@ -17,8 +17,8 @@ for those Huawei devices as well as some pertinent information about them. OPTIONS ------- --o <format>:: ---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. diff --git a/Documentation/nvme-id-ctrl.1 b/Documentation/nvme-id-ctrl.1 index 0e4c7bc..f8acb1c 100644 --- a/Documentation/nvme-id-ctrl.1 +++ b/Documentation/nvme-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-CTRL" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,8 +32,8 @@ nvme-id-ctrl \- Send NVMe Identify Controller, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme id\-ctrl\fR <device> [\-\-vendor\-specific | \-V] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -49,7 +49,7 @@ On success, the structure may be returned in one of several ways depending on th Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&. .RE .PP -\-v, \-\-vendor\-specific +\-V, \-\-vendor\-specific .RS 4 In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii interpretation\&. .RE @@ -59,13 +59,19 @@ In addition to parsing known fields, this option will dump the vendor specific r This option will parse and format many of the bit fields into human\-readable formats\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 @@ -104,7 +110,7 @@ In addition to showing the known fields, has the program to display the vendor u .\} .nf # nvme id\-ctrl /dev/nvme0 \-\-vendor\-specific -# nvme id\-ctrl /dev/nvme0 \-v +# nvme id\-ctrl /dev/nvme0 \-V .fi .if n \{\ .RE diff --git a/Documentation/nvme-id-ctrl.html b/Documentation/nvme-id-ctrl.html index 5de0ca2..40040e6 100644 --- a/Documentation/nvme-id-ctrl.html +++ b/Documentation/nvme-id-ctrl.html @@ -749,8 +749,8 @@ nvme-id-ctrl(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme id-ctrl</em> <device> [--vendor-specific | -V] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -784,7 +784,7 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dt class="hdlist1">
--vendor-specific
@@ -809,15 +809,26 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
</dt>
<dt class="hdlist1">
---output-format=<format>
+--verbose
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -845,7 +856,7 @@ the vendor unique field: <div class="listingblock">
<div class="content">
<pre><code># nvme id-ctrl /dev/nvme0 --vendor-specific
-# nvme id-ctrl /dev/nvme0 -v</code></pre>
+# nvme id-ctrl /dev/nvme0 -V</code></pre>
</div></div>
<div class="paragraph"><p>The above will dump the <em>vs</em> buffer in hex since it doesn’t know how to
interpret it.</p></div>
@@ -910,7 +921,7 @@ int main(int argc, char **argv) <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt index b9fcffc..3667c63 100644 --- a/Documentation/nvme-id-ctrl.txt +++ b/Documentation/nvme-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary] - [-o <fmt> | --output-format=<fmt>] +'nvme id-ctrl' <device> [--vendor-specific | -V] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -30,7 +30,7 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. This overrides the vendor specific and human readable options. --v:: +-V:: --vendor-specific:: In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii @@ -41,10 +41,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- @@ -61,7 +65,7 @@ the vendor unique field: + ------------ # nvme id-ctrl /dev/nvme0 --vendor-specific -# nvme id-ctrl /dev/nvme0 -v +# nvme id-ctrl /dev/nvme0 -V ------------ + The above will dump the 'vs' buffer in hex since it doesn't know how to diff --git a/Documentation/nvme-id-domain.1 b/Documentation/nvme-id-domain.1 index 67304a1..b260dc0 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-dom\-id=<domian_id> | \-d <domian_id>] - [\-o <fmt> | \-\-output\-format=<fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,13 +47,19 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-id-domain.html b/Documentation/nvme-id-domain.html index 02dfee8..6a22d19 100644 --- a/Documentation/nvme-id-domain.html +++ b/Documentation/nvme-id-domain.html @@ -750,7 +750,7 @@ nvme-id-domain(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme id-domain</em> <device> [--dom-id=<domian_id> | -d <domian_id>]
- [-o <fmt> | --output-format=<fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,15 +781,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -812,7 +823,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-id-domain.txt b/Documentation/nvme-id-domain.txt index 87883c5..1d6ec48 100644 --- a/Documentation/nvme-id-domain.txt +++ b/Documentation/nvme-id-domain.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-domain' <device> [--dom-id=<domian_id> | -d <domian_id>] - [-o <fmt> | --output-format=<fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -26,10 +26,14 @@ OPTIONS Retrieve the identify domain list data structure for the given domain id. If this value is not given, domain id will be 0xffff. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-iocs.1 b/Documentation/nvme-id-iocs.1 index 58ae111..942fe4e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-controller\-id=<cntid> | \-c <cntid>] - [\-o <fmt> | \-\-output\-format=<fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-id-iocs.html b/Documentation/nvme-id-iocs.html index f03b979..c823d1a 100644 --- a/Documentation/nvme-id-iocs.html +++ b/Documentation/nvme-id-iocs.html @@ -750,7 +750,7 @@ nvme-id-iocs(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme id-iocs</em> <device> [--controller-id=<cntid> | -c <cntid>]
- [-o <fmt> | --output-format=<fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -793,15 +793,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -844,7 +855,7 @@ show the fields in human readable format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt index a35217e..bb85aef 100644 --- a/Documentation/nvme-id-iocs.txt +++ b/Documentation/nvme-id-iocs.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-iocs' <device> [--controller-id=<cntid> | -c <cntid>] - [-o <fmt> | --output-format=<fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -30,10 +30,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-ns-granularity.txt b/Documentation/nvme-id-ns-granularity.txt new file mode 100755 index 0000000..67006c3 --- /dev/null +++ b/Documentation/nvme-id-ns-granularity.txt @@ -0,0 +1,46 @@ +nvme-id-ns-granularity(1) +========================= + +NAME +---- +nvme-id-ns-granularity - Send a Identify Namespace Granularity List command to +the specified device + +SYNOPSIS +-------- +[verse] +'nvme id-ns-granularity' <device> + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Send a Identify Namespace Granularity List command command to the specified +device, return results. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +On success it returns 0, error code otherwise. + +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 +-------- +* Has the program issue a id-ns-granularity to display structure. ++ +------------ +# nvme id-ns-granularity /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-id-ns-lba-format.txt b/Documentation/nvme-id-ns-lba-format.txt index 32df2f6..514ba48 100644 --- a/Documentation/nvme-id-ns-lba-format.txt +++ b/Documentation/nvme-id-ns-lba-format.txt @@ -9,9 +9,9 @@ SYNOPSIS -------- [verse] 'nvme id-ns' <device> [--uuid-index=<uuid-index> | -U <uuid_index>] - [--lba-format-index=<lba_format_index> | -i <lba_format_index>] - [-v | --verbose] - [--output-format=<fmt> | -o <fmt>] + [--lba-format-index=<lba_format_index> | -i <lba_format_index>] + [--verbose | -v] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -31,7 +31,7 @@ OPTIONS -U <uuid-index>:: --uuid-index=<uuid-index>:: UUID Index of the feature - + -i <lba_format_index>:: --lba-format-index=<lba_format_index>:: This field specifies the index into the LBA Format list identifying @@ -41,10 +41,10 @@ OPTIONS --verbose:: Increase the information detail in the output. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-id-ns.1 b/Documentation/nvme-id-ns.1 index 4bac15e..be219cc 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-force] - [\-\-human\-readable | \-H] - [\-\-output\-format=<fmt> | \-o <fmt>] +\fInvme id\-ns\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-force] + [\-\-human\-readable | \-H] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 @@ -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 5ada031..48ac22b 100644 --- a/Documentation/nvme-id-ns.html +++ b/Documentation/nvme-id-ns.html @@ -749,10 +749,10 @@ nvme-id-ns(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme id-ns</em> <device> [-v | --vendor-specific] [-b | --raw-binary]
- [--namespace-id=<nsid> | -n <nsid>] [--force]
- [--human-readable | -H]
- [--output-format=<fmt> | -o <fmt>]</pre>
+<pre class="content"><em>nvme id-ns</em> <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--namespace-id=<nsid> | -n <nsid>] [--force]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -817,7 +817,7 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dt class="hdlist1">
--vendor-specific
@@ -842,15 +842,26 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
</dt>
<dt class="hdlist1">
---output-format=<format>
+--verbose
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -889,7 +900,7 @@ the vendor unique field: <div class="listingblock">
<div class="content">
<pre><code># nvme id-ns /dev/nvme0n1 --vendor-specific
-# nvme id-ns /dev/nvme0n1 -v</code></pre>
+# nvme id-ns /dev/nvme0n1 -V</code></pre>
</div></div>
<div class="paragraph"><p>The above will dump the 'vs' buffer in hex since it doesn’t know how to
interpret it.</p></div>
@@ -955,7 +966,7 @@ int main(int argc, char **argv) <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-id-ns.txt b/Documentation/nvme-id-ns.txt index a2ac155..0791250 100644 --- a/Documentation/nvme-id-ns.txt +++ b/Documentation/nvme-id-ns.txt @@ -8,10 +8,10 @@ nvme-id-ns - Send NVMe Identify Namespace, return result and structure SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -51,7 +51,7 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. This overrides the vendor specific and human readable options. --v:: +-V:: --vendor-specific:: In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii @@ -62,12 +62,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- @@ -93,7 +95,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 diff --git a/Documentation/nvme-id-nvmset.1 b/Documentation/nvme-id-nvmset.1 index fe06cc6..3ce9705 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-i <id> | \-\-nvmset_id=<id> ] - [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme id\-nvmset\fR <device> [\-\-nvmset_id=<id> | \-i <id>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-id-nvmset.html b/Documentation/nvme-id-nvmset.html index 7c75fc2..96c5382 100644 --- a/Documentation/nvme-id-nvmset.html +++ b/Documentation/nvme-id-nvmset.html @@ -749,8 +749,8 @@ nvme-id-nvmset(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme id-nvmset</em> <device> [-i <id> | --nvmset_id=<id> ]
- [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme id-nvmset</em> <device> [--nvmset_id=<id> | -i <id>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -779,21 +779,32 @@ raw buffer may be printed to stdout.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -851,7 +862,7 @@ as shown in the above example, or you can <code>'cat'</code> a saved output buff <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-id-nvmset.txt b/Documentation/nvme-id-nvmset.txt index c331410..e2894e3 100644 --- a/Documentation/nvme-id-nvmset.txt +++ b/Documentation/nvme-id-nvmset.txt @@ -8,8 +8,8 @@ nvme-id-nvmset - Send NVMe Identify NVM Set List, return result and structure SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -27,14 +27,18 @@ OPTIONS ------- -i <id>:: --nvmset_id=<id>:: - 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>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-uuid.txt b/Documentation/nvme-id-uuid.txt new file mode 100755 index 0000000..f7cc1c0 --- /dev/null +++ b/Documentation/nvme-id-uuid.txt @@ -0,0 +1,55 @@ +nvme-id-uuid(1) +=============== + +NAME +---- +nvme-id-uuid - Send a Identify UUID List command to the specified device + +SYNOPSIS +-------- +[verse] +'nvme id-uuid' <device> [--raw-binary | -b] [--human-readable | -H] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Send a Identify UUID List command command to the specified device, return +results. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-b:: +--raw-binary:: + Print the raw buffer to stdout. Structure is not parsed by + program. This overrides the vendor specific and human readable options. + +-H:: +--human-readable:: + This option will parse and format many of the bit fields + 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. + +EXAMPLES +-------- +* Has the program issue a id-uuid to display structure. ++ +------------ +# nvme id-uuid /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-inspur-nvme-vendor-log.1 b/Documentation/nvme-inspur-nvme-vendor-log.1 index 63f338e..e3905b6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 ccc8e9d..0eec2c2 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-inspur-nvme-vendor-log.txt b/Documentation/nvme-inspur-nvme-vendor-log.txt index cd0266b..c860497 100644 --- a/Documentation/nvme-inspur-nvme-vendor-log.txt +++ b/Documentation/nvme-inspur-nvme-vendor-log.txt @@ -23,7 +23,6 @@ OPTIONS ------- none - EXAMPLES -------- * 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 ab2c374..63f2915 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme intel id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 32a720d..10c0645 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme intel id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme intel id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -811,15 +811,15 @@ will decode Intel vendor unique portions of the structure.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -853,7 +853,7 @@ fields in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-intel-id-ctrl.txt b/Documentation/nvme-intel-id-ctrl.txt index 1a6369c..469d60e 100644 --- a/Documentation/nvme-intel-id-ctrl.txt +++ b/Documentation/nvme-intel-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-intel-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -44,10 +44,10 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-intel-internal-log.1 b/Documentation/nvme-intel-internal-log.1 index 9649a14..ff324dd 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 34bbcfe..6f5d120 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-intel-internal-log.txt b/Documentation/nvme-intel-internal-log.txt index 2f00313..a1e1792 100644 --- a/Documentation/nvme-intel-internal-log.txt +++ b/Documentation/nvme-intel-internal-log.txt @@ -53,7 +53,6 @@ OPTIONS When used with 'nlog', this specifies which nlog to read. -1 for all, if supported by the device. - EXAMPLES -------- * Gets the nlog from the device and saves to default file: diff --git a/Documentation/nvme-intel-lat-stats.1 b/Documentation/nvme-intel-lat-stats.1 index 7e52cbb..6cf57e7 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 ee9c0df..dfb4582 100644 --- a/Documentation/nvme-intel-lat-stats.html +++ b/Documentation/nvme-intel-lat-stats.html @@ -832,7 +832,7 @@ Get the write statistics <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-intel-market-name.1 b/Documentation/nvme-intel-market-name.1 index a7c45d4..d46eb33 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 e29a60d..ee06f92 100644 --- a/Documentation/nvme-intel-market-name.html +++ b/Documentation/nvme-intel-market-name.html @@ -813,7 +813,7 @@ Get the marketing name <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-intel-smart-log-add.1 b/Documentation/nvme-intel-smart-log-add.1 index cdcdaf3..91fe4eb 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] - [\-\-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 af356af..6895f39 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme intel smart-log-add</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--raw-binary | -b]
- [--json | -j]</pre>
+ [--raw-binary | -b] [--json | -j]</pre>
<div class="attribution">
</div></div>
</div>
@@ -807,7 +806,7 @@ printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- Dump output in json format.
+ Dump output in json format.
</p>
</dd>
</dl></div>
@@ -850,7 +849,7 @@ Print the raw Intel Additional SMART log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-intel-smart-log-add.txt b/Documentation/nvme-intel-smart-log-add.txt index 7cfe794..0ed1f10 100644 --- a/Documentation/nvme-intel-smart-log-add.txt +++ b/Documentation/nvme-intel-smart-log-add.txt @@ -3,14 +3,14 @@ nvme-intel-smart-log-add(1) NAME ---- -nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request, returns result and log +nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request, +returns result and log SYNOPSIS -------- [verse] 'nvme intel smart-log-add' <device> [--namespace-id=<nsid> | -n <nsid>] - [--raw-binary | -b] - [--json | -j] + [--raw-binary | -b] [--json | -j] DESCRIPTION ----------- @@ -41,7 +41,7 @@ OPTIONS -j:: --json:: - Dump output in json format. + Dump output in json format. EXAMPLES -------- diff --git a/Documentation/nvme-intel-temp-stats.1 b/Documentation/nvme-intel-temp-stats.1 index b47065c..234c6eb 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 04de67b..1269805 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-io-mgmt-recv.1 b/Documentation/nvme-io-mgmt-recv.1 index 2251125..93f0fea 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .fi .SH "DESCRIPTION" .sp @@ -67,6 +67,20 @@ Management Operation to perform\&. .RS 4 Management Operation Specific parameter\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 3c00355..795d64a 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme io-mgmt-recv</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--mos=<NUM> | -s <NUM>]
- [--mo=<NUM> | -m <NUM>]
- [--data=<FILE> | -d <FILE>]
- [--data-len=<NUM> | -l <NUM>]</pre>
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>]
+ [--data=<FILE> | -d <FILE>]
+ [--data-len=<NUM> | -l <NUM>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -832,6 +832,29 @@ a hex dump, or binary.</p></div> Management Operation Specific parameter.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -846,7 +869,7 @@ a hex dump, or binary.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-io-mgmt-recv.txt b/Documentation/nvme-io-mgmt-recv.txt index e611c15..332d0bb 100644 --- a/Documentation/nvme-io-mgmt-recv.txt +++ b/Documentation/nvme-io-mgmt-recv.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -49,6 +49,14 @@ OPTIONS --mos=<NUM>:: 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. NVME ---- diff --git a/Documentation/nvme-io-mgmt-send.1 b/Documentation/nvme-io-mgmt-send.1 index 044cb77..47e869e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .fi .SH "DESCRIPTION" .sp @@ -67,6 +67,20 @@ Management Operation to perform\&. .RS 4 Management Operation Specific parameter\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 a625024..a0df7b0 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme io-mgmt-send</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--mos=<NUM> | -s <NUM>]
- [--mo=<NUM> | -m <NUM>]
- [--data=<FILE> | -d <FILE>]
- [--data-len=<NUM> | -l <NUM>]</pre>
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>]
+ [--data=<FILE> | -d <FILE>]
+ [--data-len=<NUM> | -l <NUM>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -831,6 +831,29 @@ convenience parameters to produce the binary payload.</p></div> Management Operation Specific parameter.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -845,7 +868,7 @@ convenience parameters to produce the binary payload.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-io-mgmt-send.txt b/Documentation/nvme-io-mgmt-send.txt index ce8d8d2..f7e8f6d 100644 --- a/Documentation/nvme-io-mgmt-send.txt +++ b/Documentation/nvme-io-mgmt-send.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -48,6 +48,14 @@ OPTIONS --mos=<NUM>:: 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. NVME ---- diff --git a/Documentation/nvme-io-passthru.1 b/Documentation/nvme-io-passthru.1 index da0e301..102da64 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] +\fInvme\-io\-passthru\fR <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] .fi .SH "DESCRIPTION" .sp @@ -59,7 +58,7 @@ The <device> 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>, \-\-opcode=<opcode> +\-O <opcode>, \-\-opcode=<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 <fmt>, \-\-output\-format=<fmt> +.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 f65a513..4de9587 100644 --- a/Documentation/nvme-io-passthru.html +++ b/Documentation/nvme-io-passthru.html @@ -749,23 +749,22 @@ nvme-io-passthru(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme-io-passthru</em> <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]</pre>
+<pre class="content"><em>nvme-io-passthru</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -790,7 +789,7 @@ printed to stdout for another program to parse.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <opcode>
+-O <opcode>
</dt>
<dt class="hdlist1">
--opcode=<opcode>
@@ -973,6 +972,29 @@ printed to stdout for another program to parse.</p></div> Print out the latency the IOCTL took (in us).
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -993,7 +1015,7 @@ printed to stdout for another program to parse.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-io-passthru.txt b/Documentation/nvme-io-passthru.txt index ba0904c..3ad5231 100644 --- a/Documentation/nvme-io-passthru.txt +++ b/Documentation/nvme-io-passthru.txt @@ -8,23 +8,22 @@ nvme-io-passthru - Submit an arbitrary io command, return results SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -43,7 +42,7 @@ printed to stdout for another program to parse. OPTIONS ------- --o <opcode>:: +-O <opcode>:: --opcode=<opcode>:: The NVMe opcode to send to the device in the command @@ -120,6 +119,15 @@ OPTIONS --latency:: 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. + EXAMPLES -------- diff --git a/Documentation/nvme-lba-status-log.1 b/Documentation/nvme-lba-status-log.1 index 2b273f7..d083039 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-rae | \-r] [\-\-output\-format=<fmt> | \-o <fmt>] +\fInvme lba\-status\-log\fR <device> [\-\-rae | \-r] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-lba-status-log.html b/Documentation/nvme-lba-status-log.html index 76ef5c7..1e571bf 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme lba-status-log</em> <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]</pre>
+<pre class="content"><em>nvme lba-status-log</em> <device> [--rae | -r]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -783,15 +784,26 @@ may be printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.
- Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -831,7 +843,7 @@ NVME</code></pre> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-lba-status-log.txt b/Documentation/nvme-lba-status-log.txt index 0d888f7..7d6efbd 100644 --- a/Documentation/nvme-lba-status-log.txt +++ b/Documentation/nvme-lba-status-log.txt @@ -8,7 +8,8 @@ nvme-lba-status-log - Send LBA Status Log Page request returns result and log SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -29,10 +30,14 @@ OPTIONS --rae:: Retain an Asynchronous Event. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-ctrl.1 b/Documentation/nvme-list-ctrl.1 index 5d10cfb..1b6134e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <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 -`\*(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 <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 \*(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>, \-\-cntid=<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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 3ad61a4..b58d5ef 100644 --- a/Documentation/nvme-list-ctrl.html +++ b/Documentation/nvme-list-ctrl.html @@ -750,26 +750,29 @@ nvme-list-ctrl(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme list-ctrl</em> <device> [--cntid=<cntid> | -c <cntid>]
- [--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>]
-DESCRIPTION</pre>
+ [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
-<div class="listingblock">
-<div class="content">
-<pre><code>For the NVMe device given, sends an identify command for controller list
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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</code></pre>
-</div></div>
+<code>'--cntid'</code> option is given to override.</p></div>
+<div class="paragraph"><p>On success, the controller array is printed for each index and controller
+identifier.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-c <cntid>
@@ -797,15 +800,26 @@ OPTIONS</code></pre> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
</dt>
<dt class="hdlist1">
---output-format=<format>
+--verbose
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output
- format can be used at a time.
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -828,7 +842,7 @@ OPTIONS</code></pre> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-list-ctrl.txt b/Documentation/nvme-list-ctrl.txt index f1bb52d..6cd5c01 100644 --- a/Documentation/nvme-list-ctrl.txt +++ b/Documentation/nvme-list-ctrl.txt @@ -9,7 +9,9 @@ SYNOPSIS -------- [verse] 'nvme list-ctrl' <device> [--cntid=<cntid> | -c <cntid>] - [--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>] + [--namespace-id=<nsid> | -n <nsid>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + DESCRIPTION ----------- For the NVMe device given, sends an identify command for controller list @@ -37,10 +39,14 @@ OPTIONS command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s). --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-endgrp.1 b/Documentation/nvme-list-endgrp.1 index be623ae..1d62e03 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-endgrp\-id=<endgrp\-id> | \-i <endgrp\-id>] - [\-o <fmt> | \-\-output\-format=<fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,12 +47,18 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 c377757..97db7ae 100644 --- a/Documentation/nvme-list-endgrp.html +++ b/Documentation/nvme-list-endgrp.html @@ -750,7 +750,7 @@ nvme-list-endgrp(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme list-endgrp</em> <device> [--endgrp-id=<endgrp-id> | -i <endgrp-id>]
- [-o <fmt> | --output-format=<fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -779,20 +779,31 @@ than or equal to the value specified in the CDW11.ENDGID field.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output
- format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -815,7 +826,7 @@ than or equal to the value specified in the CDW11.ENDGID field.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-list-endgrp.txt b/Documentation/nvme-list-endgrp.txt index 157dca9..2d7724d 100644 --- a/Documentation/nvme-list-endgrp.txt +++ b/Documentation/nvme-list-endgrp.txt @@ -3,14 +3,15 @@ nvme-list-endgrp(1) NAME ---- -nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and structure +nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and +structure SYNOPSIS -------- [verse] 'nvme list-endgrp' <device> [--endgrp-id=<endgrp-id> | -i <endgrp-id>] - [-o <fmt> | --output-format=<fmt>] - + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + DESCRIPTION ----------- For the NVMe device given, sends an identify command for endurance group list @@ -26,13 +27,17 @@ OPTIONS ------- -i <endgrp-id>:: --endgrp-id=<endgrp-id>:: - 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 <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-ns.1 b/Documentation/nvme-list-ns.1 index da5f1cc..ebb3800 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 b06c669..d73ee5e 100644 --- a/Documentation/nvme-list-ns.html +++ b/Documentation/nvme-list-ns.html @@ -751,7 +751,8 @@ nvme-id-ns(1) Manual Page <div class="verseblock">
<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
- [--all | -a] [--output-format=<fmt> | -o <fmt>]</pre>
+ [--all | -a]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -809,15 +810,26 @@ a valid nsid.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, or <em>json</em>.
- Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -859,7 +871,7 @@ Print the namespaces present for NVM Command Set in normal format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-list-ns.txt b/Documentation/nvme-list-ns.txt index 753a959..d241287 100644 --- a/Documentation/nvme-list-ns.txt +++ b/Documentation/nvme-list-ns.txt @@ -10,7 +10,8 @@ SYNOPSIS [verse] '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] DESCRIPTION ----------- @@ -41,10 +42,14 @@ OPTIONS Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', or 'json'. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-secondary.txt b/Documentation/nvme-list-secondary.txt new file mode 100755 index 0000000..88fbf42 --- /dev/null +++ b/Documentation/nvme-list-secondary.txt @@ -0,0 +1,54 @@ +nvme-list-secondary(1) +====================== + +NAME +---- +nvme-list-secondary - Show secondary controller list associated with the primary +controller of the given device + +SYNOPSIS +-------- +[verse] +'nvme list-secondary' <device> [--cntid=<cntid> | -c <cntid>] + [--num-entries=<entries> | -e <entries>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Show secondary controller list associated with the primary of the given device + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +On success, the secondary controller list is printed. + +OPTIONS +------- +-c <cntid>:: +--cntid=<cntid>:: + Lowest controller identifier to display. + +-e <entries>:: +--num-entries=<entries>:: + Number of entries to retrieve. + +-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 +-------- +* Has the program issue a list-secondary to display list. ++ +------------ +# nvme list-secondary /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-list-subsys.1 b/Documentation/nvme-list-subsys.1 index 225740e..d81d35a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <fmt> | \-\-output\-format=<fmt>] <device> +\fInvme list\-subsys\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 0b82591..289e515 100644 --- a/Documentation/nvme-list-subsys.html +++ b/Documentation/nvme-list-subsys.html @@ -749,7 +749,7 @@ nvme-list-subsys(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme list-subsys</em> [-o <fmt> | --output-format=<fmt>] <device></pre>
+<pre class="content"><em>nvme list-subsys</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -768,15 +768,26 @@ and subsystems leading to the device.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output
- format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -854,7 +865,7 @@ nvme-subsys1 - NQN=nvmf-test2 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-list-subsys.txt b/Documentation/nvme-list-subsys.txt index 6650bbe..a5d2d48 100644 --- a/Documentation/nvme-list-subsys.txt +++ b/Documentation/nvme-list-subsys.txt @@ -8,7 +8,7 @@ nvme-list-subsys - List all NVMe subsystems SYNOPSIS -------- [verse] -'nvme list-subsys' [-o <fmt> | --output-format=<fmt>] <device> +'nvme list-subsys' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -19,10 +19,14 @@ and subsystems leading to the device. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list.1 b/Documentation/nvme-list.1 index 463cf78..63f2de7 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LIST" "1" "12/21/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 <fmt> | \-\-output\-format=<fmt>] +\fInvme list\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 976c90d..9d09113 100644 --- a/Documentation/nvme-list.html +++ b/Documentation/nvme-list.html @@ -749,7 +749,7 @@ nvme-list(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme list</em> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme list</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -766,15 +766,15 @@ for those devices as well as some pertinent information about them.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output
- format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
@@ -816,7 +816,7 @@ for those devices as well as some pertinent information about them.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt index 7cc333b..a8c5428 100644 --- a/Documentation/nvme-list.txt +++ b/Documentation/nvme-list.txt @@ -8,7 +8,7 @@ nvme-list - List all recognized NVMe devices SYNOPSIS -------- [verse] -'nvme list' [-o <fmt> | --output-format=<fmt>] +'nvme list' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,10 +17,10 @@ for those devices as well as some pertinent information about them. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. -v:: --verbose:: @@ -32,7 +32,6 @@ ENVIRONMENT ----------- PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in common locations. - EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-lockdown.1 b/Documentation/nvme-lockdown.1 index cd38210..8779819 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LOCKDOWN" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-LOCKDOWN" "1" "12/21/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 <device> [\-\-ofi=<ofi> | \-o <ofi>] +\fInvme\-lockdown\fR <device> [\-\-ofi=<ofi> | \-O <ofi>] [\-\-ifc=<ifc> | \-f <ifc>] [\-\-prhbt=<prhbt> | \-p <prhbt>] [\-\-scp=<scp> | \-s <scp>] [\-\-uuid=<UUID_Index> | \-U <UUID_Index>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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=<ofi>, \-o <ofi> +\-O <ofi>, \-\-ofi=<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=<ifc>, \-f <ifc> +\-f <ifc>, \-\-ifc=<ifc> .RS 4 Interface (INF) field identifies the interfaces affected by this command\&. .RE .PP -\-\-prhbt=<prhbt>, \-p <prhbt> +\-p <prhbt>, \-\-prhbt=<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=<scp>, \-s <scp> +\-s <scp>, \-\-scp=<scp> .RS 4 Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field\&. .RE .PP -\-\-uuid=<UUID_Index>, \-U <UUID_Index> +\-U <UUID_Index>, \-\-uuid=<UUID_Index> .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 <fmt>, \-\-output\-format=<fmt> +.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 f572ee1..06b7967 100644 --- a/Documentation/nvme-lockdown.html +++ b/Documentation/nvme-lockdown.html @@ -749,11 +749,12 @@ nvme-lockdown(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme-lockdown</em> <device> [--ofi=<ofi> | -o <ofi>]
+<pre class="content"><em>nvme-lockdown</em> <device> [--ofi=<ofi> | -O <ofi>]
[--ifc=<ifc> | -f <ifc>]
[--prhbt=<prhbt> | -p <prhbt>]
[--scp=<scp> | -s <scp>]
- [--uuid=<UUID_Index> | -U <UUID_Index>]</pre>
+ [--uuid=<UUID_Index> | -U <UUID_Index>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -772,10 +773,10 @@ Identifier.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---ofi=<ofi>
+-O <ofi>
</dt>
<dt class="hdlist1">
--o <ofi>
+--ofi=<ofi>
</dt>
<dd>
<p>
@@ -784,10 +785,10 @@ Identifier.</p></div> </p>
</dd>
<dt class="hdlist1">
---ifc=<ifc>
+-f <ifc>
</dt>
<dt class="hdlist1">
--f <ifc>
+--ifc=<ifc>
</dt>
<dd>
<p>
@@ -795,10 +796,10 @@ Identifier.</p></div> </p>
</dd>
<dt class="hdlist1">
---prhbt=<prhbt>
+-p <prhbt>
</dt>
<dt class="hdlist1">
--p <prhbt>
+--prhbt=<prhbt>
</dt>
<dd>
<p>
@@ -807,10 +808,10 @@ Identifier.</p></div> </p>
</dd>
<dt class="hdlist1">
---scp=<scp>
+-s <scp>
</dt>
<dt class="hdlist1">
--s <scp>
+--scp=<scp>
</dt>
<dd>
<p>
@@ -818,10 +819,10 @@ Identifier.</p></div> </p>
</dd>
<dt class="hdlist1">
---uuid=<UUID_Index>
+-U <UUID_Index>
</dt>
<dt class="hdlist1">
--U <UUID_Index>
+--uuid=<UUID_Index>
</dt>
<dd>
<p>
@@ -830,6 +831,29 @@ Identifier.</p></div> If this field is cleared to 0h,then no UUID index is specified.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -850,7 +874,7 @@ Identifier.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-lockdown.txt b/Documentation/nvme-lockdown.txt index cf8a48f..e17ac70 100644 --- a/Documentation/nvme-lockdown.txt +++ b/Documentation/nvme-lockdown.txt @@ -8,11 +8,12 @@ nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution SYNOPSIS -------- [verse] -'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>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -23,34 +24,42 @@ Identifier. OPTIONS ------- +-O <ofi>:: --ofi=<ofi>:: --o <ofi>:: Opcode or Feature Identifier(OFI) specifies the command opcode or Set Features Feature Identifier identified by the Scope field. ---ifc=<ifc>:: -f <ifc>:: +--ifc=<ifc>:: Interface (INF) field identifies the interfaces affected by this command. ---prhbt=<prhbt>:: -p <prhbt>:: +--prhbt=<prhbt>:: Prohibit (PRHBT) bit specifies whether to prohibit or allow the command opcode or Set Features Feature Identifier specified by this command. ---scp=<scp>:: -s <scp>:: +--scp=<scp>:: Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field. - ---uuid=<UUID_Index>:: -U <UUID_Index>:: +--uuid=<UUID_Index>:: 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. +-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 -------- No examples yet. NVME ---- -Part of the nvme-user suite
\ No newline at end of file +Part of the nvme-user suite diff --git a/Documentation/nvme-media-unit-stat-log.txt b/Documentation/nvme-media-unit-stat-log.txt index 427b77c..997a497 100644 --- a/Documentation/nvme-media-unit-stat-log.txt +++ b/Documentation/nvme-media-unit-stat-log.txt @@ -9,9 +9,8 @@ request, returns result and log. SYNOPSIS -------- [verse] -'nvme media-unit-stat-log' <device> [--dom-id | -d ] - [--output-format=<fmt> | -o <fmt>] - [--raw-binary | -b] +'nvme media-unit-stat-log' <device> [--dom-id | -d] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -26,17 +25,18 @@ On success, the returned Media unit status log pages log structure will be print OPTIONS ------- --o <format>:: ---output-format=<format>:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. +-o <fmt>:: +--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. -d:: --dom-id:: - To get the domain ID. + To get the domain ID. + -b:: --raw-binary:: - To show raw binary data. + To show raw binary data. EXAMPLES -------- diff --git a/Documentation/nvme-mi-cmd-support-effects-log.1 b/Documentation/nvme-mi-cmd-support-effects-log.1 index a47a7eb..7163a17 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] - [\-H | \-\-human\-readable] +\fInvme\-mi\-cmd\-support\-effects\-log\fR <device> [\-\-human\-readable | \-H] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,17 +44,23 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP -\-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 ef4846b..f923ad0 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -749,8 +749,8 @@ nvme-mi-cmd-support-effects-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme-mi-cmd-support-effects-log</em> <device> [-o <fmt> | --output-format=<fmt>]
- [-H | --human-readable]</pre>
+<pre class="content"><em>nvme-mi-cmd-support-effects-log</em> <device> [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -772,27 +772,38 @@ raw buffer may be printed to stdout.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-H
</dt>
<dt class="hdlist1">
---output-format=<format>
+--human-readable
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. 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.
</p>
</dd>
<dt class="hdlist1">
--H
+-o <fmt>
</dt>
<dt class="hdlist1">
---human-readable
+--output-format=<fmt>
</dt>
<dd>
<p>
- This option will parse and format many of the bit fields
- into human-readable formats.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -815,7 +826,7 @@ raw buffer may be printed to stdout.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt index 67b8355..2221804 100644 --- a/Documentation/nvme-mi-cmd-support-effects-log.txt +++ b/Documentation/nvme-mi-cmd-support-effects-log.txt @@ -4,13 +4,13 @@ nvme-mi-cmd-support-effects-log(1) NAME ---- nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log, - returns results and structure +returns results and structure SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -26,16 +26,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --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:: --human-readable:: This option will parse and format many of the bit fields 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. + EXAMPLES -------- nvme mi-cmd-support-effects-log /dev/nvme0 -H diff --git a/Documentation/nvme-micron-clear-pcie-errors.1 b/Documentation/nvme-micron-clear-pcie-errors.1 index 326f37e..b4dc9ad 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 8458851..e2218e2 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-internal-log.1 b/Documentation/nvme-micron-internal-log.1 index df7d736..5d70916 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> 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 02a1985..da3e119 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>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</p></div>
+<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).</p></div>
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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.</p></div>
</div>
</div>
<div class="sect1">
@@ -813,7 +814,7 @@ Gets the logs from the device and saves to micron_logs.zip file <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-internal-log.txt b/Documentation/nvme-micron-internal-log.txt index 37a50ad..b8e9228 100644 --- a/Documentation/nvme-micron-internal-log.txt +++ b/Documentation/nvme-micron-internal-log.txt @@ -3,7 +3,8 @@ nvme-micron-internal-log(1) NAME ---- -nvme-micron-internal-log - Retrieve Micron device's internal logs and save to given zip file. +nvme-micron-internal-log - Retrieve Micron device's internal logs and save to +given zip file. SYNOPSIS -------- @@ -12,23 +13,24 @@ SYNOPSIS 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. OPTIONS ------- -l <FILE>:: --package=<FILE>:: - name of the file (with .zip extension) to save the device logs + name of the file (with .zip extension) to save the device logs EXAMPLES -------- diff --git a/Documentation/nvme-micron-nand-stats.1 b/Documentation/nvme-micron-nand-stats.1 index 02f4764..b5e2711 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 919b86f..5a0bcdd 100644 --- a/Documentation/nvme-micron-nand-stats.html +++ b/Documentation/nvme-micron-nand-stats.html @@ -799,7 +799,7 @@ Retrieve NAND statistics information <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-pcie-stats.1 b/Documentation/nvme-micron-pcie-stats.1 index f99df4a..ba2c81c 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 9efb712..dfcfcfd 100644 --- a/Documentation/nvme-micron-pcie-stats.html +++ b/Documentation/nvme-micron-pcie-stats.html @@ -799,7 +799,7 @@ Retrieve PCIe error information <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-selective-download.1 b/Documentation/nvme-micron-selective-download.1 index 99a364d..77d8e99 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-fw=<FILE>, \-f <FILE>] [\-\-select=<flag>, \-s <flag>] +\fInvme micron selective\-download\fR <device> [\-\-fw=<FILE>, \-f <FILE>] + [\-\-select=<flag>, \-s <flag>] .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 <device> 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 <FILE>, \-\-fw=<FILE> diff --git a/Documentation/nvme-micron-selective-download.html b/Documentation/nvme-micron-selective-download.html index d041cb0..0ae4c13 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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.
</p>
</div>
</div>
@@ -749,7 +749,8 @@ nvme-micron-selective-download(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme micron selective-download</em> <device> [--fw=<FILE>, -f <FILE>] [--select=<flag>, -s <flag>]</pre>
+<pre class="content"><em>nvme micron selective-download</em> <device> [--fw=<FILE>, -f <FILE>]
+ [--select=<flag>, -s <flag>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -757,13 +758,14 @@ nvme-micron-selective-download(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).</p></div>
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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.</p></div>
</div>
</div>
<div class="sect1">
@@ -867,7 +869,7 @@ Update eeprom, OOB and main firmware <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-selective-download.txt b/Documentation/nvme-micron-selective-download.txt index 5fb11d7..c20af74 100644 --- a/Documentation/nvme-micron-selective-download.txt +++ b/Documentation/nvme-micron-selective-download.txt @@ -3,38 +3,41 @@ nvme-micron-selective-download(1) 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. SYNOPSIS -------- [verse] -'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>] 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. OPTIONS ------- -f <FILE>:: --fw=<FILE>:: - name of the firmware image file + name of the firmware image file + -s <flag>:: --select=<flag>:: - flag that has following values - OOB:: This updates the OOB and main firmware\n" - EEP:: This updates the eeprom and main firmware\n" - ALL:: This updates the eeprom, OOB, and main firmware"; + flag that has following values + OOB:: This updates the OOB and main firmware\n" + EEP:: This updates the eeprom and main firmware\n" + ALL:: This updates the eeprom, OOB, and main firmware"; EXAMPLES -------- @@ -42,7 +45,7 @@ EXAMPLES + ------------ # nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=OOB -# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB +# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB ------------ * Update OOB and main firmware diff --git a/Documentation/nvme-micron-smart-add-log.1 b/Documentation/nvme-micron-smart-add-log.1 index c514bed..c388df2 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> \-f <json|normal> +\fInvme micron vs\-smart\-add\-log\fR <device> \-f <json|normal> .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 <json|normal> controls the format of displayed output\&. +.PP +\-f <json|normal> +.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 c87e321..068edce 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme micron vs-smart-add-log</em> <device> -f <json|normal></pre>
+<pre class="content"><em>nvme micron vs-smart-add-log</em> <device> -f <json|normal></pre>
<div class="attribution">
</div></div>
</div>
@@ -775,7 +775,16 @@ complaint controllers. Support for new devices may be added subsequently.</p></d <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>-f <json|normal> controls the format of displayed output.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-f <json|normal>
+</dt>
+<dd>
+<p>
+ Controls the format of displayed output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -808,7 +817,7 @@ Retrieve NAND/extended SMART data and display in json format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-micron-smart-add-log.txt b/Documentation/nvme-micron-smart-add-log.txt index 1fd74ba..13e0d96 100644 --- a/Documentation/nvme-micron-smart-add-log.txt +++ b/Documentation/nvme-micron-smart-add-log.txt @@ -9,7 +9,7 @@ or Extended SMART information (OCP complaint models) of given micron device SYNOPSIS -------- [verse] -'nvme micron vs-smart-add-log' <device> -f <json|normal> +'nvme micron vs-smart-add-log' <device> -f <json|normal> DESCRIPTION ----------- @@ -32,8 +32,8 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-micron-temperature-stats.1 b/Documentation/nvme-micron-temperature-stats.1 index 419f619..21eb5cf 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 061aad0..66d3149 100644 --- a/Documentation/nvme-micron-temperature-stats.html +++ b/Documentation/nvme-micron-temperature-stats.html @@ -799,7 +799,7 @@ Retrieve temperature information <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-netapp-ontapdevices.1 b/Documentation/nvme-netapp-ontapdevices.1 index 233e183..507a554 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <fmt> | \-\-output\-format=<fmt>] +\fInvme netapp ontapdevices\fR [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-netapp-ontapdevices.html b/Documentation/nvme-netapp-ontapdevices.html index 6292259..02d30ca 100644 --- a/Documentation/nvme-netapp-ontapdevices.html +++ b/Documentation/nvme-netapp-ontapdevices.html @@ -749,7 +749,7 @@ nvme-netapp-ontapdevices(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme netapp ontapdevices</em> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme netapp ontapdevices</em> [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -773,8 +773,8 @@ identified using the Identify Controller data.</p></div> </dt>
<dd>
<p>
- Set the reporting format to <em>normal</em> (default), <em>column</em>, or
- <em>json</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em> (default), <em>column</em>, or
+ <em>json</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -807,7 +807,7 @@ Display information, in a column-based format, for ONTAP devices. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-netapp-ontapdevices.txt b/Documentation/nvme-netapp-ontapdevices.txt index c292758..fc28947 100644 --- a/Documentation/nvme-netapp-ontapdevices.txt +++ b/Documentation/nvme-netapp-ontapdevices.txt @@ -8,7 +8,7 @@ nvme-netapp-ontapdevices - Display information about ONTAP devices SYNOPSIS -------- [verse] -'nvme netapp ontapdevices' [-o <fmt> | --output-format=<fmt>] +'nvme netapp ontapdevices' [--output-format=<fmt> | -o <fmt>] DESCRIPTION ----------- @@ -19,8 +19,8 @@ OPTIONS ------- -o <fmt>:: --output-format=<fmt>:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-netapp-smdevices.1 b/Documentation/nvme-netapp-smdevices.1 index a86c54d..017489e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <fmt> | \-\-output\-format=<fmt>] +\fInvme netapp smdevices\fR [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-netapp-smdevices.html b/Documentation/nvme-netapp-smdevices.html index b8e896d..39aac53 100644 --- a/Documentation/nvme-netapp-smdevices.html +++ b/Documentation/nvme-netapp-smdevices.html @@ -749,7 +749,7 @@ nvme-netapp-smdevices(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme netapp smdevices</em> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme netapp smdevices</em> [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -809,7 +809,7 @@ namespace. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-netapp-smdevices.txt b/Documentation/nvme-netapp-smdevices.txt index b66b98d..cb68acf 100644 --- a/Documentation/nvme-netapp-smdevices.txt +++ b/Documentation/nvme-netapp-smdevices.txt @@ -8,7 +8,7 @@ nvme-netapp-smdevices - Display information for each NVMe path to an E-Series vo SYNOPSIS -------- [verse] -'nvme netapp smdevices' [-o <fmt> | --output-format=<fmt>] +'nvme netapp smdevices' [--output-format=<fmt> | -o <fmt>] DESCRIPTION ----------- diff --git a/Documentation/nvme-ns-descs.1 b/Documentation/nvme-ns-descs.1 index 034669f..8a18840 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] - [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] +\fInvme ns\-descs\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-ns-descs.html b/Documentation/nvme-ns-descs.html index 192432b..19a5a29 100644 --- a/Documentation/nvme-ns-descs.html +++ b/Documentation/nvme-ns-descs.html @@ -749,9 +749,8 @@ nvme-ns-descs(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme ns-descs</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+<pre class="content"><em>nvme ns-descs</em> <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -803,15 +802,26 @@ raw buffer may be printed to stdout.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.
- Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -857,7 +867,7 @@ Have the program return the raw structure in binary: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ns-descs.txt b/Documentation/nvme-ns-descs.txt index 8afeba5..04c6e51 100644 --- a/Documentation/nvme-ns-descs.txt +++ b/Documentation/nvme-ns-descs.txt @@ -9,9 +9,8 @@ nvme-ns-descs - Send NVMe Identify for a list of Namespace Identification SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -43,11 +42,14 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-ns-rescan.1 b/Documentation/nvme-ns-rescan.1 index 35b5285..866fe49 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> +\fInvme ns\-rescan\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe controller rescans the namespaces\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 7202c4b..a640801 100644 --- a/Documentation/nvme-ns-rescan.html +++ b/Documentation/nvme-ns-rescan.html @@ -749,7 +749,7 @@ nvme-ns-rescan(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme ns-rescan</em> <device></pre>
+<pre class="content"><em>nvme ns-rescan</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -764,7 +764,31 @@ be an NVMe character device (ex: /dev/nvme0).</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>None</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -794,7 +818,7 @@ Rescans the nvme namespaces. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ns-rescan.txt b/Documentation/nvme-ns-rescan.txt index cd41870..5681eab 100644 --- a/Documentation/nvme-ns-rescan.txt +++ b/Documentation/nvme-ns-rescan.txt @@ -8,7 +8,7 @@ nvme-ns-rescan - Rescans the nvme namespaces. SYNOPSIS -------- [verse] -'nvme ns-rescan' <device> +'nvme ns-rescan' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ctrl.1 b/Documentation/nvme-nvm-id-ctrl.1 index 83cc4fe..e168328 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme nvm\-id\-ctrl\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,13 +43,19 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-nvm-id-ctrl.html b/Documentation/nvme-nvm-id-ctrl.html index 25be91a..04438bd 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme nvm-id-ctrl</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme nvm-id-ctrl</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -770,15 +770,26 @@ displayed in one of several ways.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -821,7 +832,7 @@ Show the output in json format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-nvm-id-ctrl.txt b/Documentation/nvme-nvm-id-ctrl.txt index fb4a237..eabc4b1 100644 --- a/Documentation/nvme-nvm-id-ctrl.txt +++ b/Documentation/nvme-nvm-id-ctrl.txt @@ -8,7 +8,7 @@ nvme-nvm-id-ctrl - Send NVMe Identify Controller, return NVM command set structu SYNOPSIS -------- [verse] -'nvme nvm-id-ctrl' <device> [-o <fmt> | --output-format=<fmt>] +'nvme nvm-id-ctrl' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -23,10 +23,14 @@ displayed in one of several ways. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ns-lba-format.txt b/Documentation/nvme-nvm-id-ns-lba-format.txt index 638e2fb..1048995 100644 --- a/Documentation/nvme-nvm-id-ns-lba-format.txt +++ b/Documentation/nvme-nvm-id-ns-lba-format.txt @@ -11,8 +11,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns-lba-format' <device> [--uuid-index=<uuid-index> | -U <uuid_index>] [--lba-format-index=<lba_format_index> | -i <lba_format_index>] - [-v | --verbose] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -37,15 +36,15 @@ OPTIONS This field specifies the index into the LBA Format list identifying the LBA Format capabilities that are to be returned +-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. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - EXAMPLES -------- * Has the program interpret the returned buffer and display the known diff --git a/Documentation/nvme-nvm-id-ns.txt b/Documentation/nvme-nvm-id-ns.txt index dfbbfaa..5a8cb09 100644 --- a/Documentation/nvme-nvm-id-ns.txt +++ b/Documentation/nvme-nvm-id-ns.txt @@ -10,8 +10,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns' <device> [--uuid-index=<uuid-index> | -U <uuid_index>] [--namespace-id=<NUM> | -n <NUM>] - [-v | --verbose] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -37,15 +36,15 @@ OPTIONS --uuid-index=<uuid-index>:: UUID Index of the feature +-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. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - EXAMPLES -------- * Has the program interpret the returned buffer and display the known diff --git a/Documentation/nvme-nvme-mi-recv.1 b/Documentation/nvme-nvme-mi-recv.1 index ffa43c7..0926527 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] +\fInvme nvme\-mi\-recv\fR <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] .fi .SH "DESCRIPTION" .sp @@ -49,7 +49,7 @@ The <device> parameter is mandatory and may be either the NVMe character device On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o <opcode>, \-\-opcode=<opcode> +\-O <opcode>, \-\-opcode=<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 <fmt>, \-\-output\-format=<fmt> +.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 7c8ce29..b3e44f9 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme nvme-mi-recv</em> <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>]</pre>
+<pre class="content"><em>nvme nvme-mi-recv</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -774,7 +774,7 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <opcode>
+-O <opcode>
</dt>
<dt class="hdlist1">
--opcode=<opcode>
@@ -852,6 +852,29 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).</p></div> assumed to use STDIN.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -865,7 +888,7 @@ Has the program issue a nvme-mi-recv to execute the VPD read. </p>
<div class="listingblock">
<div class="content">
-<pre><code># nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256</code></pre>
+<pre><code># nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256</code></pre>
</div></div>
</li>
</ul></div>
@@ -882,7 +905,7 @@ Has the program issue a nvme-mi-recv to execute the VPD read. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-nvme-mi-recv.txt b/Documentation/nvme-nvme-mi-recv.txt index e5130ed..152bbe6 100644..100755 --- a/Documentation/nvme-nvme-mi-recv.txt +++ b/Documentation/nvme-nvme-mi-recv.txt @@ -8,13 +8,13 @@ nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -27,7 +27,7 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <opcode>:: +-O <opcode>:: --opcode=<opcode>:: The NVMe-MI opcode to send to the device in the command @@ -57,12 +57,21 @@ OPTIONS to fill the buffer sent to the device. If no file is given, 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. + EXAMPLES -------- * 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 ------------ NVME diff --git a/Documentation/nvme-nvme-mi-send.1 b/Documentation/nvme-nvme-mi-send.1 index 9a7df99..7608df8 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] +\fInvme nvme\-mi\-send\fR <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] .fi .SH "DESCRIPTION" .sp @@ -49,7 +49,7 @@ The <device> parameter is mandatory and may be either the NVMe character device On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP -\-o <opcode>, \-\-opcode=<opcode> +\-O <opcode>, \-\-opcode=<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 <fmt>, \-\-output\-format=<fmt> +.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 00a6e26..203d938 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme nvme-mi-send</em> <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>]</pre>
+<pre class="content"><em>nvme nvme-mi-send</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -774,7 +774,7 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <opcode>
+-O <opcode>
</dt>
<dt class="hdlist1">
--opcode=<opcode>
@@ -852,6 +852,29 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).</p></div> assumed to use STDIN.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -865,7 +888,7 @@ Has the program issue a nvme-mi-send to execute the VPD write. </p>
<div class="listingblock">
<div class="content">
-<pre><code># nvme nvme-mi-send /dev/nvme0n1 -o 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin</code></pre>
+<pre><code># nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin</code></pre>
</div></div>
</li>
</ul></div>
@@ -882,7 +905,7 @@ Has the program issue a nvme-mi-send to execute the VPD write. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-nvme-mi-send.txt b/Documentation/nvme-nvme-mi-send.txt index 5139a86..0e80fe7 100644..100755 --- a/Documentation/nvme-nvme-mi-send.txt +++ b/Documentation/nvme-nvme-mi-send.txt @@ -8,13 +8,13 @@ nvme-nvme-mi-send - Send a NVMe-MI Send command to the specified device SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -27,7 +27,7 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <opcode>:: +-O <opcode>:: --opcode=<opcode>:: The NVMe-MI opcode to send to the device in the command @@ -57,12 +57,21 @@ OPTIONS to fill the buffer sent to the device. If no file is given, 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. + EXAMPLES -------- * 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 ------------ NVME diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.1 b/Documentation/nvme-ocp-clear-fw-activate-history.1 index 9d794bf..f0da3cd 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 24825f8..8eeea64 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.txt b/Documentation/nvme-ocp-clear-fw-activate-history.txt index 20ec724..335a228 100644 --- a/Documentation/nvme-ocp-clear-fw-activate-history.txt +++ b/Documentation/nvme-ocp-clear-fw-activate-history.txt @@ -34,7 +34,7 @@ OPTIONS -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) EXAMPLES -------- diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.1 index 090fec2..749f58c 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 48d3b9a..adec4fa 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt index 92cd148..3d5706d 100644 --- a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt +++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt @@ -34,7 +34,7 @@ OPTIONS -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) EXAMPLES -------- diff --git a/Documentation/nvme-ocp-device-capability-log.txt b/Documentation/nvme-ocp-device-capability-log.txt index 7789531..d2f0761 100644 --- a/Documentation/nvme-ocp-device-capability-log.txt +++ b/Documentation/nvme-ocp-device-capability-log.txt @@ -24,8 +24,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---output-format=<format>:: +-o <fmt>:: +--output-format=<fmt>:: Set the reporting format to 'normal' or 'json' or 'binary'. Only one output format can be used at a time. The default is normal. diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.1 b/Documentation/nvme-ocp-eol-plp-failure-mode.1 index 87effa5..be65967 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-mode=<mode> | \-m <mode>] [\-\-no\-uuid | \-n] [\-\-save | \-s] - [\-\-sel=<select> | \-s <select>] +\fInvme ocp eol\-plp\-failure\-mode\fR <device> [\-\-mode=<mode> | \-m <mode>] + [\-\-no\-uuid | \-n] [\-\-save | \-s] + [\-\-sel=<select> | \-s <select>] .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 8b43ad7..8618b20 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme ocp eol-plp-failure-mode</em> <device> [--mode=<mode> | -m <mode>] [--no-uuid | -n] [--save | -s]
- [--sel=<select> | -s <select>]</pre>
+<pre class="content"><em>nvme ocp eol-plp-failure-mode</em> <device> [--mode=<mode> | -m <mode>]
+ [--no-uuid | -n] [--save | -s]
+ [--sel=<select> | -s <select>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -804,7 +805,8 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -884,7 +886,7 @@ Has the program issue a eol-plp-failure-mode to retrieve the 0xC2 get features. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.txt b/Documentation/nvme-ocp-eol-plp-failure-mode.txt index 9a47375..0ebc4ab 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.txt +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.txt @@ -3,13 +3,15 @@ nvme-ocp-eol-plp-failure-mode(1) NAME ---- -nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure mode +nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure +mode SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -29,17 +31,18 @@ OPTIONS -m <mode>:: --mode=<mode>:: Set the EOL or PLP circuitry failure mode to [0-3] ('0: default', - '1: rom', '2: wtm' or '3: normal'). Only one mode + '1: rom', '2: wtm' or '3: normal'). Only one mode can be used at a time. The default is rom. -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) -s:: --save:: - 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. -s <select>:: --sel=<select>:: diff --git a/Documentation/nvme-ocp-error-recovery-log.txt b/Documentation/nvme-ocp-error-recovery-log.txt index edbf4e6..7a26150 100644 --- a/Documentation/nvme-ocp-error-recovery-log.txt +++ b/Documentation/nvme-ocp-error-recovery-log.txt @@ -24,8 +24,8 @@ On success it returns 0, error code otherwise. OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json' or 'binary'.
Only one output format can be used at a time. The default is normal.
@@ -34,7 +34,7 @@ EXAMPLES * Has the program issue a error-recovery-log command to retrieve the 0xC1 log page.
+
------------
-# nvme ocp unsupported-reqs-log /dev/nvme0 -o normal
+# nvme ocp error-recovery-log /dev/nvme0 -o normal
------------
NVME
diff --git a/Documentation/nvme-ocp-get-plp-health-check-interval.txt b/Documentation/nvme-ocp-get-plp-health-check-interval.txt new file mode 100644 index 0000000..7ecd5d5 --- /dev/null +++ b/Documentation/nvme-ocp-get-plp-health-check-interval.txt @@ -0,0 +1,54 @@ +nvme-ocp-get-plp-health-check-interval(1) +================================ + +NAME +---- +nvme-ocp-get-plp-health-check-interval - Define and print plp-health-check-interval value + +SYNOPSIS +-------- +[verse] +'nvme ocp get-plp-health-check-interval' <device> [--sel=<select> | -s <select>] + +DESCRIPTION +----------- +Define plp-health-check-interval. +No argument prints current mode. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- + +-s <select>:: +--sel=<select>:: + Select (SEL): This field specifies which value of the attributes + to return in the provided data: ++ +[] +|================== +|Select|Description +|0|Current +|1|Default +|2|Saved +|3|Supported capabilities +|4-7|Reserved +|================== + +EXAMPLES +-------- +* Has the program issue a get-plp-health-check-interval to retrieve the 0xC6 get features. ++ +------------ +# nvme ocp get-plp-health-check-interval /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-latency-monitor-log.1 b/Documentation/nvme-ocp-latency-monitor-log.1 index 3fc507d..10b9743 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 88282ad..a49acdb 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -811,7 +811,7 @@ Displays the get latency monitor log for the device: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ocp-latency-monitor-log.txt b/Documentation/nvme-ocp-latency-monitor-log.txt index 66f760c..a67c523 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.txt +++ b/Documentation/nvme-ocp-latency-monitor-log.txt @@ -26,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. The default is normal. diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt new file mode 100644 index 0000000..c9ae578 --- /dev/null +++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt @@ -0,0 +1,43 @@ +set-dssd-power-state-feature(1) +=============================== + +NAME +---- +nvme-ocp-set-dssd-power-state-feature - Set DSSD Power State + +SYNOPSIS +-------- +[verse] +'nvme ocp set-dssd-power-state-feature' <device> + [--power-state=<fmt> | -p <fmt>] [--no-uuid | -n] + [--save | -s] + +DESCRIPTION +----------- +For the NVMe device given, retrieves OCP DSSD Power state Feature + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-p <fmt>:: +--power-state=<fmt>:: + DSSD Power State to set in watts. + +EXAMPLES +-------- +* Has the program issue a set-dssd-power-state-feature command to set DSSD Power State to set in watts. ++ +------------ +# nvme ocp set-dssd-power-state-feature /dev/nvme0 -p <value> -s <value> -n <value> +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-set-plp-health-check-interval.txt b/Documentation/nvme-ocp-set-plp-health-check-interval.txt new file mode 100644 index 0000000..ac3acb3 --- /dev/null +++ b/Documentation/nvme-ocp-set-plp-health-check-interval.txt @@ -0,0 +1,53 @@ +nvme-ocp-set-plp-health-check-interval(1) +================================ + +NAME +---- +nvme-ocp-set-plp-health-check-interval - Define and set PLP health check interval + +SYNOPSIS +-------- +[verse] +'nvme ocp set-plp-health-check-interval' <device> [--plp_health_interval=<plp_health_interval> | -p <plp_health_interval>] [--save | -s] [--no-uuid | -n] + + +DESCRIPTION +----------- +Define Set PLP health check interval. +No argument prints current mode. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-p <plp_health_interval>:: +--plp_health_interval=<plp_health_interval>:: + Set the plp health check interval [31:16] + +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +-s:: +--save:: + Save the attribute so that it persists through all power states and resets. + + +EXAMPLES +-------- +* Has the program issue a set-plp-health-check-interval to retrieve the 0xC6 set features. ++ +------------ +# nvme ocp eol-plp-failure-mode /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-smart-add-log.1 b/Documentation/nvme-ocp-smart-add-log.1 index 1cbdfb7..d433d84 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 9757c3d..4333149 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -812,7 +812,7 @@ Has the program issue a smart-add-log command to retrieve the 0xC0 log page. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-ocp-smart-add-log.txt b/Documentation/nvme-ocp-smart-add-log.txt index 3a25822..66a55a9 100644 --- a/Documentation/nvme-ocp-smart-add-log.txt +++ b/Documentation/nvme-ocp-smart-add-log.txt @@ -26,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. The default is normal. diff --git a/Documentation/nvme-ocp-telemetry-string-log-page.txt b/Documentation/nvme-ocp-telemetry-string-log-page.txt new file mode 100644 index 0000000..76349ed --- /dev/null +++ b/Documentation/nvme-ocp-telemetry-string-log-page.txt @@ -0,0 +1,43 @@ +nvme-ocp-telemetry-string-log-page(1) +===================================== + +NAME +---- +nvme-ocp-telemetry-string-log-page - Retrieve OCP Telemetry String Log page + +SYNOPSIS +-------- +[verse] +'nvme ocp telemetry-str-log' <device> [--output-format=<fmt> | -o <fmt>] + +DESCRIPTION +----------- +For the NVMe device given, Retrieve OCP Telemetry String Log page + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-o <fmt>:: +--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. + + +EXAMPLES +-------- +* Has the program issue a telemetry-string-log command to get the log page data from bin file. ++ +------------ +# nvme ocp telemetry-string-log /dev/nvme0n1 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt index 65818d3..1657f6a 100644 --- a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt +++ b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt @@ -27,8 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---output-format=<format>:: +-o <fmt>:: +--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. diff --git a/Documentation/nvme-persistent-event-log.1 b/Documentation/nvme-persistent-event-log.1 index bb5cbda..a8ca1df 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .fi .SH "DESCRIPTION" .sp @@ -61,13 +60,19 @@ Allocates a buffer of <log\-len> bytes size and requests this many bytes be retu Print the raw persistent event log buffer to stdout\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-persistent-event-log.html b/Documentation/nvme-persistent-event-log.html index f960bea..618a192 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme persistent-event-log</em> <device> [--action=<action> | -a <action>]
- [--log-len=<log-len> | -l <log-len>]
- [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--log-len=<log-len> | -l <log-len>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -782,12 +781,12 @@ may be printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- 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)
</p>
</dd>
<dt class="hdlist1">
@@ -798,10 +797,10 @@ may be printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -812,19 +811,30 @@ may be printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- Print the raw persistent event log buffer to stdout.
+ Print the raw persistent event log buffer to stdout.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.
- Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -867,7 +877,7 @@ Print the raw persistent event log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-persistent-event-log.txt b/Documentation/nvme-persistent-event-log.txt index 833491f..cf1cbad 100644 --- a/Documentation/nvme-persistent-event-log.txt +++ b/Documentation/nvme-persistent-event-log.txt @@ -10,9 +10,8 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -31,28 +30,32 @@ OPTIONS ------- -a <action>:: --action=<action>:: - 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) -l <log-len>:: --log-len=<log-len>:: - 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. -b:: --raw-binary:: - Print the raw persistent event log buffer to stdout. + Print the raw persistent event log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-phy-rx-eom-log.txt b/Documentation/nvme-phy-rx-eom-log.txt new file mode 100644 index 0000000..8a31131 --- /dev/null +++ b/Documentation/nvme-phy-rx-eom-log.txt @@ -0,0 +1,68 @@ +nvme-phy-rx-eom-log(1) +====================== + +NAME +---- +nvme-phy-rx-eom-log - Retrieves a Physical Interface Receiver Eye Opening +Measurement log page from an NVMe device + +SYNOPSIS +-------- +[verse] +'nvme phy-rx-eom-log' <device> [--lsp=<field> | -s <field>] + [--controller=<id> | -c <id>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Retrieves a Physical Interface Receiver Eye Opening Measurement log page from +an NVMe device and provides the returned structure. + +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 it returns 0, error code otherwise. + +OPTIONS +------- +-s <field>:: +--lsp=<field>:: + The log specified field configuring the controller's action to take + during processing of the command and the measurement quality. + +-c <id>:: +--controller=<id>:: + Controller ID of the controller associated with the PCIe port to be + measured. + +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + +EXAMPLES +-------- +* Start a best quality measurement and retrieve the log page header ++ +------------ +# nvme phy-rx-eom-log /dev/nvme0 --lsp=10 +------------ + +* Retrieve a finished best quality measurement on controller with ID 3 ++ +------------ +# nvme phy-rx-eom-log /dev/nvme0 --lsp=2 --controller=3 +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-pred-lat-event-agg-log.1 b/Documentation/nvme-pred-lat-event-agg-log.1 index 8636904..b3416bf 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-log\-entries=<log_entries> | \-e <log_entries>] +\fInvme pred\-lat\-event\-agg\-log\fR <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 bead028..9acd37a 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme pred-lat-event-agg-log</em> <device> [--log-entries=<log_entries> | -e <log_entries>]
+<pre class="content"><em>nvme pred-lat-event-agg-log</em> <device>
+ [--log-entries=<log_entries> | -e <log_entries>]
[--rae | -r] [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -782,11 +783,11 @@ another program to parse.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -812,15 +813,15 @@ another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.
- Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.
+ Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -863,7 +864,7 @@ Print the raw Predictable Latency Event Aggregate log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-pred-lat-event-agg-log.txt b/Documentation/nvme-pred-lat-event-agg-log.txt index b01c9bb..6fb8acc 100644 --- a/Documentation/nvme-pred-lat-event-agg-log.txt +++ b/Documentation/nvme-pred-lat-event-agg-log.txt @@ -9,9 +9,10 @@ Page request, returns result and log SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -31,11 +32,11 @@ OPTIONS ------- -e <log_entries>:: --log-entries=<log_entries>:: - 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. -r:: --rae:: @@ -45,10 +46,10 @@ OPTIONS --raw-binary:: Print the raw Predictable Latency Event Aggregate log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or 'binary'. + Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-predictable-lat-log.1 b/Documentation/nvme-predictable-lat-log.1 index e96b0e6..932646a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-nvmset\-id=<nvmset_id> | \-i <nvmset_id>] [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-predictable-lat-log.html b/Documentation/nvme-predictable-lat-log.html index 5419947..4a8fec3 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 <div class="verseblock">
<pre class="content"><em>nvme predictable-lat-log</em> <device> [--nvmset-id=<nvmset_id> | -i <nvmset_id>]
[--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,10 +781,10 @@ the raw buffer may be printed to stdout for another program to parse.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -799,15 +799,26 @@ the raw buffer may be printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -850,7 +861,7 @@ Print the raw Predictable latency per NVM set log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-predictable-lat-log.txt b/Documentation/nvme-predictable-lat-log.txt index d1dde80..f0b2ad3 100644 --- a/Documentation/nvme-predictable-lat-log.txt +++ b/Documentation/nvme-predictable-lat-log.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] '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] DESCRIPTION ----------- @@ -30,19 +30,23 @@ OPTIONS ------- -i <nvmset_id>:: --nvmset-id=<nvmset_id>:: - 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. -b:: --raw-binary:: Print the raw Predictable latency per NVM set log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-primary-ctrl-caps.1 b/Documentation/nvme-primary-ctrl-caps.1 index 74c9884..238716b 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <format> | \-\-output\-format=<format>] +\fInvme primary\-ctrl\-caps\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,17 +43,23 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE .PP -\-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 dfeec00..91f1ae2 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme primary-ctrl-caps</em> <device> [-o <format> | --output-format=<format>]</pre>
+<pre class="content"><em>nvme primary-ctrl-caps</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -771,27 +771,38 @@ raw buffer may be printed to stdout.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-H
</dt>
<dt class="hdlist1">
---output-format=<format>
+--human-readable
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. 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.
</p>
</dd>
<dt class="hdlist1">
--H
+-o <fmt>
</dt>
<dt class="hdlist1">
---human-readable
+--output-format=<fmt>
</dt>
<dd>
<p>
- This option will parse and format many of the bit fields
- into human-readable formats.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -835,7 +846,7 @@ fields in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-primary-ctrl-caps.txt b/Documentation/nvme-primary-ctrl-caps.txt index 3edf5c1..0300383 100644 --- a/Documentation/nvme-primary-ctrl-caps.txt +++ b/Documentation/nvme-primary-ctrl-caps.txt @@ -8,7 +8,7 @@ nvme-primary-ctrl-caps - Send identify Primary Controller Caps, return result an SYNOPSIS -------- [verse] -'nvme primary-ctrl-caps' <device> [-o <format> | --output-format=<format>] +'nvme primary-ctrl-caps' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -24,16 +24,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --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:: --human-readable:: This option will parse and format many of the bit fields 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. + EXAMPLES -------- * Get Primary Ctrl Caps of the device in default format diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index 4d9d9f7..338c904 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,54 +42,50 @@ nvme-read \- Send an NVMe Read command, provide results [\-\-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] .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=<slba>, \-s <slba> +\-s <slba>, \-\-start\-block=<slba> .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=<size>, \-z <size> +\-z <size>, \-\-data\-size=<size> .RS 4 Size of data, in bytes\&. .RE .PP -\-\-metadata\-size=<size>, \-y <size> +\-y <size>, \-\-metadata\-size=<size> .RS 4 Size of metadata in bytes\&. .RE .PP -\-\-data=<data\-file>, \-d <data\-file> +\-d <data\-file>, \-\-data=<data\-file> .RS 4 Data file\&. If none provided, contents are sent to STDOUT\&. .RE .PP -\-\-metadata=<metadata\-file>, \-M <metadata\-file> +\-M <metadata\-file>, \-\-metadata=<metadata\-file> .RS 4 Metadata file, if necessary\&. .RE .PP -\-\-prinfo=<prinfo>, \-p <prinfo> +\-p <prinfo>, \-\-prinfo=<prinfo> .RS 4 Protection Information field definition\&. .TS @@ -134,17 +130,17 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=<reftag>, \-r <reftag> +\-r <reftag>, \-\-ref\-tag=<reftag> .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=<appmask>, \-m <appmask> +\-m <appmask>, \-\-app\-tag\-mask=<appmask> .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 <fmt>, \-\-output\-format=<fmt> +.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 a881ec2..74b1c64 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]</pre>
+ [--storage-tag-check | -C] [--force]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -787,10 +783,10 @@ by default if you don’t provide a file.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---start-block=<slba>
+-s <slba>
</dt>
<dt class="hdlist1">
--s <slba>
+--start-block=<slba>
</dt>
<dd>
<p>
@@ -798,10 +794,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---block-count
+-c
</dt>
<dt class="hdlist1">
--c
+--block-count
</dt>
<dd>
<p>
@@ -811,10 +807,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---data-size=<size>
+-z <size>
</dt>
<dt class="hdlist1">
--z <size>
+--data-size=<size>
</dt>
<dd>
<p>
@@ -822,10 +818,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---metadata-size=<size>
+-y <size>
</dt>
<dt class="hdlist1">
--y <size>
+--metadata-size=<size>
</dt>
<dd>
<p>
@@ -833,10 +829,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---data=<data-file>
+-d <data-file>
</dt>
<dt class="hdlist1">
--d <data-file>
+--data=<data-file>
</dt>
<dd>
<p>
@@ -844,10 +840,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---metadata=<metadata-file>
+-M <metadata-file>
</dt>
<dt class="hdlist1">
--M <metadata-file>
+--metadata=<metadata-file>
</dt>
<dd>
<p>
@@ -855,10 +851,10 @@ by default if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---prinfo=<prinfo>
+-p <prinfo>
</dt>
<dt class="hdlist1">
--p <prinfo>
+--prinfo=<prinfo>
</dt>
<dd>
<p>
@@ -903,10 +899,10 @@ metadata is passes.</p></td> </div>
</dd>
<dt class="hdlist1">
---ref-tag=<reftag>
+-r <reftag>
</dt>
<dt class="hdlist1">
--r <reftag>
+--ref-tag=<reftag>
</dt>
<dd>
<p>
@@ -914,10 +910,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag-mask=<appmask>
+-m <appmask>
</dt>
<dt class="hdlist1">
--m <appmask>
+--app-tag-mask=<appmask>
</dt>
<dd>
<p>
@@ -925,10 +921,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---force-unit-access
+-f
</dt>
<dt class="hdlist1">
--f
+--force-unit-access
</dt>
<dd>
<p>
@@ -982,7 +978,7 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dt class="hdlist1">
--show-cmd
@@ -1048,6 +1044,29 @@ metadata is passes.</p></td> even though.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1068,7 +1087,7 @@ metadata is passes.</p></td> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index 3ceeba1..cecaa71 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -18,17 +18,13 @@ SYNOPSIS [--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] DESCRIPTION ----------- @@ -38,34 +34,34 @@ by default if you don't provide a file. OPTIONS ------- ---start-block=<slba>:: -s <slba>:: +--start-block=<slba>:: Start block. ---block-count:: -c:: +--block-count:: The number of blocks to transfer. This is a zeroes based value to align with the kernel's use of this field. (ie. 0 means transfer 1 block). ---data-size=<size>:: -z <size>:: +--data-size=<size>:: Size of data, in bytes. ---metadata-size=<size>:: -y <size>:: +--metadata-size=<size>:: Size of metadata in bytes. ---data=<data-file>:: -d <data-file>:: +--data=<data-file>:: Data file. If none provided, contents are sent to STDOUT. ---metadata=<metadata-file>:: -M <metadata-file>:: +--metadata=<metadata-file>:: Metadata file, if necessary. ---prinfo=<prinfo>:: -p <prinfo>:: +--prinfo=<prinfo>:: Protection Information field definition. + [] @@ -80,16 +76,16 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=<reftag>:: -r <reftag>:: +--ref-tag=<reftag>:: Optional reftag when used with protection information. ---app-tag-mask=<appmask>:: -m <appmask>:: +--app-tag-mask=<appmask>:: Optional application tag mask when used with protection information. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. -T <type>:: @@ -117,7 +113,7 @@ metadata is passes. consult the NVMe specification for detailed breakdown of how to use this field. --v:: +-V:: --show-cmd:: Print out the command to be sent. @@ -144,6 +140,15 @@ metadata is passes. 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-reset.1 b/Documentation/nvme-reset.1 index 0ef0b7e..506cbea 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESET" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RESET" "1" "12/21/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 <device> +\fInvme reset\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe controller reset\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 1296dc7..0bac21c 100644 --- a/Documentation/nvme-reset.html +++ b/Documentation/nvme-reset.html @@ -749,7 +749,7 @@ nvme-reset(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme reset</em> <device></pre>
+<pre class="content"><em>nvme reset</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -764,7 +764,31 @@ be an NVMe character device (ex: /dev/nvme0).</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>None</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -794,7 +818,7 @@ Resets the controller. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-reset.txt b/Documentation/nvme-reset.txt index d1a282b..20fcbb1 100644 --- a/Documentation/nvme-reset.txt +++ b/Documentation/nvme-reset.txt @@ -8,7 +8,7 @@ nvme-reset - Reset the nvme controller. SYNOPSIS -------- [verse] -'nvme reset' <device> +'nvme reset' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-resv-acquire.1 b/Documentation/nvme-resv-acquire.1 index 14dfff4..2066508 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 fbbd31d..3d8e876 100644 --- a/Documentation/nvme-resv-acquire.html +++ b/Documentation/nvme-resv-acquire.html @@ -750,11 +750,11 @@ nvme-resv-acquire(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme resv-acquire</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--crkey=<crkey> | -c <crkey>]
- [--prkey=<prkey> | -p <prkey>]
- [--rtype=<rtype> | -t <rtype>]
- [--racqa=<racqa> | -a <racqa>]
- [--iekey | -i]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -924,10 +924,33 @@ cellspacing="0" cellpadding="4"> <p>
Ignore Existing Key: If this bit is set to a <em>1</em>, 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.
</p>
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -948,7 +971,7 @@ cellspacing="0" cellpadding="4"> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-resv-acquire.txt b/Documentation/nvme-resv-acquire.txt index 1b6e110..19282c6 100644 --- a/Documentation/nvme-resv-acquire.txt +++ b/Documentation/nvme-resv-acquire.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -79,10 +79,19 @@ OPTIONS --iekey:: 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. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-notif-log.1 b/Documentation/nvme-resv-notif-log.1 index 3daff9e..1f0a6d4 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-output\-format=<fmt> | \-o <fmt>] +\fInvme resv\-notif\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -43,13 +43,19 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-resv-notif-log.html b/Documentation/nvme-resv-notif-log.html index 05775f5..6809559 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -749,7 +749,7 @@ nvme-resv-notif-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme resv-notif-log</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>
+<pre class="content"><em>nvme resv-notif-log</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -772,15 +772,26 @@ may be printed to stdout for another program to parse.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -822,7 +833,7 @@ Print the output in json format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-resv-notif-log.txt b/Documentation/nvme-resv-notif-log.txt index a9c5cdd..f8d828b 100644 --- a/Documentation/nvme-resv-notif-log.txt +++ b/Documentation/nvme-resv-notif-log.txt @@ -4,12 +4,12 @@ nvme-resv-notif-log(1) NAME ---- nvme-resv-notif-log - Send NVMe Reservation Notification log page request, - return result and log +return result and log SYNOPSIS -------- [verse] -'nvme resv-notif-log' <device> [--output-format=<fmt> | -o <fmt>] +'nvme resv-notif-log' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -26,10 +26,14 @@ may be printed to stdout for another program to parse. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 05029fa..383cad0 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 ed2481e..c4875dc 100644 --- a/Documentation/nvme-resv-register.html +++ b/Documentation/nvme-resv-register.html @@ -750,11 +750,11 @@ nvme-resv-register(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme resv-register</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--crkey=<crkey> | -c <crkey>]
- [--nrkey=<nrkey> | -k <nrkey>]
- [--rrega=<rrega> | -r <rrega>]
- [--cptpl=<cptpl> | -p <cptpl>]
- [--iekey | -i]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -917,6 +917,29 @@ cellspacing="0" cellpadding="4"> </p>
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -937,7 +960,7 @@ cellspacing="0" cellpadding="4"> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-resv-register.txt b/Documentation/nvme-resv-register.txt index e0553f4..4a83050 100644 --- a/Documentation/nvme-resv-register.txt +++ b/Documentation/nvme-resv-register.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -84,6 +84,15 @@ a power loss. + 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. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-release.1 b/Documentation/nvme-resv-release.1 index 8f1e158..f10293e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 c02dd1b..496f8e8 100644 --- a/Documentation/nvme-resv-release.html +++ b/Documentation/nvme-resv-release.html @@ -750,10 +750,10 @@ nvme-resv-release(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme resv-release</em> <device> [--namespace-id=<nsid> | -n <nsid>]
- [--crkey=<crkey> | -c <crkey>]
- [--rtype=<rtype> | -t <rtype>]
- [--rrela=<rrela> | -a <rrela>]
- [--iekey | -i]</pre>
+ [--crkey=<crkey> | -c <crkey>]
+ [--rtype=<rtype> | -t <rtype>]
+ [--rrela=<rrela> | -a <rrela>] [--iekey | -i]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -910,6 +910,29 @@ cellspacing="0" cellpadding="4"> </p>
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -930,7 +953,7 @@ cellspacing="0" cellpadding="4"> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt index 6eb0b43..c3dc90d 100644 --- a/Documentation/nvme-resv-release.txt +++ b/Documentation/nvme-resv-release.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -75,6 +75,15 @@ OPTIONS + 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. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-report.1 b/Documentation/nvme-resv-report.1 index aee6c8a..c38280b 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-resv-report.html b/Documentation/nvme-resv-report.html index 0a0e33b..fc96975 100644 --- a/Documentation/nvme-resv-report.html +++ b/Documentation/nvme-resv-report.html @@ -750,10 +750,9 @@ nvme-resv-report(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme resv-report</em> <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>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -824,15 +823,26 @@ Controller data structure for each such controller).</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -855,7 +865,7 @@ Controller data structure for each such controller).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-resv-report.txt b/Documentation/nvme-resv-report.txt index 32012fe..2e12826 100644 --- a/Documentation/nvme-resv-report.txt +++ b/Documentation/nvme-resv-report.txt @@ -9,10 +9,9 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -48,11 +47,14 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-rpmb.1 b/Documentation/nvme-rpmb.1 index 52aed1c..5c6325e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RPMB" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-RPMB" "1" "12/21/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 <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 490fd07..76addf4 100644 --- a/Documentation/nvme-rpmb.html +++ b/Documentation/nvme-rpmb.html @@ -750,13 +750,13 @@ nvme-rpmb(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme rpmb</em> <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> ]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -921,6 +921,29 @@ default address if no -address or -o option is specified,</code></pre> (read or write) for a specified RPMB target.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1001,7 +1024,7 @@ data onto output.bin <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-rpmb.txt b/Documentation/nvme-rpmb.txt index c30c83d..9dc954d 100644 --- a/Documentation/nvme-rpmb.txt +++ b/Documentation/nvme-rpmb.txt @@ -9,13 +9,13 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -71,7 +71,7 @@ OPTIONS nvme-rpmb without sending it to device. RPMB target 0 is used as the default target if --target or -t is not specified. 0x0 is used as the default address if no -address or -o option is specified, - + -t <target>:: --target=<target>:: RPMB target id. This should be one of the supported RPMB targets as @@ -105,6 +105,15 @@ OPTIONS The size in 512 byte sectors to be used for data transfer commands (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. + EXAMPLES -------- * Print RPMB support information of an NVMe device @@ -147,4 +156,3 @@ EXAMPLES NVME ---- Part of the nvme-user suite - diff --git a/Documentation/nvme-sanitize-log.1 b/Documentation/nvme-sanitize-log.1 index 143a1aa..7bf1cfb 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-rae | \-r] [\-\-output\-format=<fmt> | \-o <fmt>] - [\-\-human\-readable | \-H] - [\-\-raw\-binary | \-b] +\fInvme sanitize\-log\fR <device> [\-\-rae | \-r] [\-\-human\-readable | \-H] + [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<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 <fmt>, \-\-output\-format=<fmt> +.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 d421e62..f6e0c2a 100644 --- a/Documentation/nvme-sanitize-log.html +++ b/Documentation/nvme-sanitize-log.html @@ -749,9 +749,9 @@ nvme-sanitize-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme sanitize-log</em> <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
- [--human-readable | -H]
- [--raw-binary | -b]</pre>
+<pre class="content"><em>nvme sanitize-log</em> <device> [--rae | -r] [--human-readable | -H]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -798,11 +798,11 @@ cellspacing="0" cellpadding="4"> <td align="left" valign="top"><p class="table">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.</p></td>
+ 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.</p></td>
</tr>
</tbody>
</table>
@@ -827,18 +827,6 @@ If cleared to 0, then non-volatile storage in the NVM subsystem has been written </p>
</dd>
<dt class="hdlist1">
--o <format>
-</dt>
-<dt class="hdlist1">
---output-format=<format>
-</dt>
-<dd>
-<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
-</p>
-</dd>
-<dt class="hdlist1">
-H
</dt>
<dt class="hdlist1">
@@ -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.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -892,7 +903,7 @@ Has the program issue Sanitize-log Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-sanitize-log.txt b/Documentation/nvme-sanitize-log.txt index 3c2d43e..af45e9f 100644 --- a/Documentation/nvme-sanitize-log.txt +++ b/Documentation/nvme-sanitize-log.txt @@ -8,9 +8,9 @@ nvme-sanitize-log - Send NVMe sanitize-log Command, return result SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -41,11 +41,11 @@ Expected status and description :- |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. + 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. |=== Sanitize Progress - percentage complete @@ -58,11 +58,6 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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:: --human-readable:: This option will parse and format many of the bit fields @@ -73,6 +68,15 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by 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. + EXAMPLES -------- * Has the program issue Sanitize-log Command : diff --git a/Documentation/nvme-sanitize.1 b/Documentation/nvme-sanitize.1 index 7a71f4f..793f2d1 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SANITIZE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-SANITIZE" "1" "12/21/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 <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] +\fInvme sanitize\fR <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 a9f3e99..de92545 100644 --- a/Documentation/nvme-sanitize.html +++ b/Documentation/nvme-sanitize.html @@ -749,13 +749,12 @@ nvme-sanitize(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme sanitize</em> <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]</pre>
+<pre class="content"><em>nvme sanitize</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,13 +780,13 @@ provides the result.</p></div> </dt>
<dd>
<p>
- 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).
</p>
</dd>
<dt class="hdlist1">
@@ -798,11 +797,11 @@ provides the result.</p></div> </dt>
<dd>
<p>
- 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).
</p>
</dd>
<dt class="hdlist1">
@@ -813,12 +812,12 @@ provides the result.</p></div> </dt>
<dd>
<p>
- 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).
</p>
</dd>
<dt class="hdlist1">
@@ -829,11 +828,11 @@ provides the result.</p></div> </dt>
<dd>
<p>
- 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).
</p>
</dd>
<dt class="hdlist1">
@@ -844,7 +843,7 @@ provides the result.</p></div> </dt>
<dd>
<p>
- Sanitize Action:
+ Sanitize Action:
</p>
<div class="tableblock">
<table rules="all"
@@ -890,11 +889,11 @@ cellspacing="0" cellpadding="4"> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -902,8 +901,31 @@ cellspacing="0" cellpadding="4"> </dt>
<dd>
<p>
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+</p>
+</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -938,7 +960,7 @@ Has the program issue Sanitize Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-sanitize.txt b/Documentation/nvme-sanitize.txt index c3b9af2..1e43463 100644 --- a/Documentation/nvme-sanitize.txt +++ b/Documentation/nvme-sanitize.txt @@ -8,13 +8,12 @@ nvme-sanitize - Send NVMe Sanitize Command, return result SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -29,42 +28,42 @@ OPTIONS ------- -d:: --no-dealloc:: - 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). -i:: --oipbp:: - 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). -n <overwrite-pass-count>:: --owpass=<overwrite-pass-count>:: - 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). -u:: --ause:: - 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). -a <action>:: --sanact=<action>:: - Sanitize Action: + Sanitize Action: + [] |================= @@ -78,15 +77,24 @@ OPTIONS -p <overwrite-pattern>:: --ovrpat=<overwrite-pattern>:: - 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. --force:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.1 b/Documentation/nvme-seagate-clear-fw-activate-history.1 index cb605ba..68a943d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 dbba892..a395267 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an
nvme block device (ex: /dev/nvme0n1).</p></div>
@@ -792,7 +792,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.txt b/Documentation/nvme-seagate-clear-fw-activate-history.txt index 2b17222..01f018b 100644 --- a/Documentation/nvme-seagate-clear-fw-activate-history.txt +++ b/Documentation/nvme-seagate-clear-fw-activate-history.txt @@ -12,7 +12,7 @@ SYNOPSIS 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 @@ -22,7 +22,7 @@ OPTIONS ------- -s --save:: - specifies that the controller shall save the attribute. + specifies that the controller shall save the attribute. EXAMPLES -------- diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 b/Documentation/nvme-seagate-clear-pcie-correctable-errors.1 index d8c9a90..beebd42 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 [<device>] [OPTIONS]\fR +\fInvme seagate clear\-pcie\-correctable\-errors [<device>] [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 32cde9c..cd71dc5 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]</em></pre>
+<pre class="content"><em>nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]</em></pre>
<div class="attribution">
</div></div>
</div>
@@ -757,7 +757,7 @@ nvme-seagate-clear-pcie-correctable-errors(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0), or an
nvme block device (ex: /dev/nvme0n1).</p></div>
@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt index 33952d3..1239f83 100644 --- a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt @@ -8,12 +8,12 @@ nvme-seagate-clear-pcie-correctable-errors - Clear Seagate PCIe error statistics SYNOPSIS -------- [verse] -'nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]' +'nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]' 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 @@ -23,7 +23,7 @@ OPTIONS ------- -s:: --save:: - Specifies that the controller shall save the attribute + Specifies that the controller shall save the attribute EXAMPLES -------- diff --git a/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 b/Documentation/nvme-seagate-cloud-SSD-plugin-version.1 index 1989f20..24dddf5 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 a70616a..ac4ab82 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-get-ctrl-tele.1 b/Documentation/nvme-seagate-get-ctrl-tele.1 index 60f20be..c7dce50 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 9455a72..980b051 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The '<device>'parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
nvme block device (ex: /dev/nvme0n1).</p></div>
@@ -813,7 +813,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-get-ctrl-tele.txt b/Documentation/nvme-seagate-get-ctrl-tele.txt index e170548..4bb7362 100644 --- a/Documentation/nvme-seagate-get-ctrl-tele.txt +++ b/Documentation/nvme-seagate-get-ctrl-tele.txt @@ -13,7 +13,7 @@ SYNOPSIS 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 @@ -23,11 +23,11 @@ OPTIONS ------- -n <NUM>:: --namespace-id=<NUM>:: - Desired namespace + Desired namespace -b:: --raw-binary:: - Output in raw format + Output in raw format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-get-host-tele.1 b/Documentation/nvme-seagate-get-host-tele.1 index 2090581..0ff7d52 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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<device>\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<device>\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 <NUM>, \-\-namespace\-id=<NUM> diff --git a/Documentation/nvme-seagate-get-host-tele.html b/Documentation/nvme-seagate-get-host-tele.html index 84d5a36..7882d91 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This will only work on Seagate devices supporting this feature. Not all
+<div class="paragraph"><p>This will only work on Seagate devices supporting this feature. Not all
commands work across all product families.</p></div>
-<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
-nvme block device (ex: /dev/nvme0n1).</p></div>
+<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device
+(ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1).</p></div>
</div>
</div>
<div class="sect1">
@@ -786,7 +786,8 @@ nvme block device (ex: /dev/nvme0n1).</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
@@ -825,7 +826,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-get-host-tele.txt b/Documentation/nvme-seagate-get-host-tele.txt index 2863c12..83cdefc 100644 --- a/Documentation/nvme-seagate-get-host-tele.txt +++ b/Documentation/nvme-seagate-get-host-tele.txt @@ -13,26 +13,27 @@ SYNOPSIS 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). OPTIONS ------- -n <NUM>:: --namespace-id=<NUM>:: - desired namespace + desired namespace -i <NUM>:: --log_specific=<NUM>:: - 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. + 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. -b:: --raw-binary:: - output in raw format + output in raw format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-help.1 b/Documentation/nvme-seagate-help.1 index bdfcfb2..003fd21 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-help.html b/Documentation/nvme-seagate-help.html index eb24703..91791da 100644 --- a/Documentation/nvme-seagate-help.html +++ b/Documentation/nvme-seagate-help.html @@ -812,7 +812,7 @@ help Display this help</code></pre> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-plugin-version.1 b/Documentation/nvme-seagate-plugin-version.1 index 94d3985..b0c24da 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 2e188e3..110efe8 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-version.1 b/Documentation/nvme-seagate-version.1 index abf2b34..b1faf83 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-seagate-version.html b/Documentation/nvme-seagate-version.html index e8bee0d..dbeb82a 100644 --- a/Documentation/nvme-seagate-version.html +++ b/Documentation/nvme-seagate-version.html @@ -787,7 +787,7 @@ nvme-seagate-version(1) Manual Page <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.1 b/Documentation/nvme-seagate-vs-fw-activate-history.1 index 260c947..6d7be65 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 bfc9572..47934c7 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an
nvme block device (ex: /dev/nvme0n1).</p></div>
@@ -813,7 +813,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.txt b/Documentation/nvme-seagate-vs-fw-activate-history.txt index e6b030d..8df58b4 100644 --- a/Documentation/nvme-seagate-vs-fw-activate-history.txt +++ b/Documentation/nvme-seagate-vs-fw-activate-history.txt @@ -13,7 +13,7 @@ SYNOPSIS 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 @@ -23,11 +23,11 @@ OPTIONS ------- -n <NUM>:: --namespace-id=<NUM>:: - Desired namespace + Desired namespace -f <FILE>:: --dump-file=<FILE>:: - Dump file + Dump file EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-internal-log.1 b/Documentation/nvme-seagate-vs-internal-log.1 index e39f348..2d16e16 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 19283d1..a78d5b2 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
-<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
-nvme block device (ex: /dev/nvme0n1).</p></div>
+<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device
+(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).</p></div>
</div>
</div>
<div class="sect1">
@@ -795,7 +795,8 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device.</p></div>
+<div class="paragraph"><p>Get the Seagate vendor specific Controller-Initiated telemetry log for the
+specified device.</p></div>
<div class="listingblock">
<div class="content">
<pre><code># nvme seagate vs-internal-log /dev/nvme0</code></pre>
@@ -813,7 +814,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-internal-log.txt b/Documentation/nvme-seagate-vs-internal-log.txt index 3284020..4a895bc 100644 --- a/Documentation/nvme-seagate-vs-internal-log.txt +++ b/Documentation/nvme-seagate-vs-internal-log.txt @@ -13,25 +13,26 @@ SYNOPSIS 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). OPTIONS ------- -n <NUM>:: --namespace-id=<NUM>:: - Desired namespace + Desired namespace -f <FILE>:: --dump-file=<FILE>:: - Dump file + Dump file 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 diff --git a/Documentation/nvme-seagate-vs-log-page-sup.1 b/Documentation/nvme-seagate-vs-log-page-sup.1 index 6b7bac1..59d1436 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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<device>\fR may be either an NVMe character device (ex: /dev/nvme0) or an NVMe block device (ex: /dev/nvme0n1)\&. .SH "OPTIONS" .PP -\-o <FMT>, \-\-output\-format=<FMT> +\-o <fmt>, \-\-output\-format=<fmt> .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 e8be1aa..055665d 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an
NVMe block device (ex: /dev/nvme0n1).</p></div>
@@ -768,10 +768,10 @@ NVMe block device (ex: /dev/nvme0n1).</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <FMT>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<FMT>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -814,7 +814,7 @@ LogPage-Id LogPage-Name <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-log-page-sup.txt b/Documentation/nvme-seagate-vs-log-page-sup.txt index a5d1488..55c65fd 100644 --- a/Documentation/nvme-seagate-vs-log-page-sup.txt +++ b/Documentation/nvme-seagate-vs-log-page-sup.txt @@ -13,7 +13,7 @@ SYNOPSIS 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 @@ -21,9 +21,9 @@ NVMe block device (ex: /dev/nvme0n1). OPTIONS ------- --o <FMT>:: ---output-format=<FMT>:: - Output in binary format +-o <fmt>:: +--output-format=<fmt>:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-pcie-stats.1 b/Documentation/nvme-seagate-vs-pcie-stats.1 index afe83e5..9722029 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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<device>\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 <FMT>, \-\-output\-format=<FMT> +\-o <fmt>, \-\-output\-format=<fmt> .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 c85cf25..d0b935e 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>The <em><device></em> parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an
nvme block device (ex: /dev/nvme0n1).</p></div>
@@ -768,10 +768,10 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <FMT>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<FMT>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-pcie-stats.txt b/Documentation/nvme-seagate-vs-pcie-stats.txt index 74599bf..86f87a3 100644 --- a/Documentation/nvme-seagate-vs-pcie-stats.txt +++ b/Documentation/nvme-seagate-vs-pcie-stats.txt @@ -13,7 +13,7 @@ SYNOPSIS 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 @@ -21,9 +21,9 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o <FMT>:: ---output-format=<FMT>:: - Output in binary format +-o <fmt>:: +--output-format=<fmt>:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-smart-add-log.1 b/Documentation/nvme-seagate-vs-smart-add-log.1 index 799c101..19730ff 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 e34c938..5d189cb 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).</p></div>
<div class="paragraph"><p>The log contents may be associated with the controller, in which case the namespace parameter is ignored.</p></div>
<div class="paragraph"><p>Two logs exist, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM Supercap SMART log page)</p></div>
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
</div>
</div>
@@ -830,7 +830,7 @@ all commands work across all product families.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-smart-add-log.txt b/Documentation/nvme-seagate-vs-smart-add-log.txt index 962a109..836220a 100644 --- a/Documentation/nvme-seagate-vs-smart-add-log.txt +++ b/Documentation/nvme-seagate-vs-smart-add-log.txt @@ -24,23 +24,23 @@ The log contents may be associated with the controller, in which case the namesp 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. OPTIONS ------- -l <NUM>:: --log=<NUM>:: - Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM - Supercap SMART log page) + Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM + Supercap SMART log page) -n <NUM>:: --namespace-id=<NUM>:: - Namespace number + Namespace number -o <FILE>:: --output-file=<FILE>:: - Output in binary format. Defaults to text-formatted dump to stdout + Output in binary format. Defaults to text-formatted dump to stdout EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-temperature-stats.1 b/Documentation/nvme-seagate-vs-temperature-stats.1 index d933def..075dd28 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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<device>\*(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 <FMT>, \-\-output\-format=<FMT> +\-o <fmt>, \-\-output\-format=<fmt> .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 2b3ab2a..2046e49 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.</p></div>
<div class="paragraph"><p>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).</p></div>
@@ -768,10 +768,10 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <FMT>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<FMT>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -802,7 +802,7 @@ nvme block device (ex: /dev/nvme0n1).</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-seagate-vs-temperature-stats.txt b/Documentation/nvme-seagate-vs-temperature-stats.txt index 2691e30..58a9f11 100644 --- a/Documentation/nvme-seagate-vs-temperature-stats.txt +++ b/Documentation/nvme-seagate-vs-temperature-stats.txt @@ -13,7 +13,7 @@ SYNOPSIS 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 @@ -21,9 +21,9 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o <FMT>:: ---output-format=<FMT>:: - Output in binary format +-o <fmt>:: +--output-format=<fmt>:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-security-recv.1 b/Documentation/nvme-security-recv.1 index 262720f..1dcf782 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,12 +33,12 @@ nvme-security-recv \- Security Recv command .sp .nf \fInvme security\-recv\fR <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 34f1982..f2d0074 100644 --- a/Documentation/nvme-security-recv.html +++ b/Documentation/nvme-security-recv.html @@ -750,12 +750,12 @@ nvme-security-recv(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme security-recv</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -866,6 +866,29 @@ controller reset occurs.</p></div> Print the raw buffer to stdout. Defaults to print in hex.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -886,7 +909,7 @@ controller reset occurs.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-security-recv.txt b/Documentation/nvme-security-recv.txt index 0b9fe99..ef77531 100644 --- a/Documentation/nvme-security-recv.txt +++ b/Documentation/nvme-security-recv.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -71,6 +71,15 @@ OPTIONS --raw-binary:: 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. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-security-send.1 b/Documentation/nvme-security-send.1 index 187b7fa..236348a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,11 +33,12 @@ nvme-security-send \- Security Send command .sp .nf \fInvme security\-send\fR <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] .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 <fmt>, \-\-output\-format=<fmt> +.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 a345ded..8058ba3 100644 --- a/Documentation/nvme-security-send.html +++ b/Documentation/nvme-security-send.html @@ -750,11 +750,12 @@ nvme-security-send(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme security-send</em> <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>]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -852,6 +853,29 @@ Receive command is Security Protocol field dependent as defined in SPC-4.</p></d Security Protocol as defined in SPC-4.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -872,7 +896,7 @@ Receive command is Security Protocol field dependent as defined in SPC-4.</p></d <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-security-send.txt b/Documentation/nvme-security-send.txt index ae22628..347b970 100644 --- a/Documentation/nvme-security-send.txt +++ b/Documentation/nvme-security-send.txt @@ -9,11 +9,12 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -63,6 +64,15 @@ OPTIONS Transfer Length: The value of this field is specific to the Security Protocol 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. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-self-test-log.1 b/Documentation/nvme-self-test-log.1 index 9be513d..395cf51 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-log\-entries=<entries> | \-e <entries>] - [\-\-output\-format=<FMT> | \-o <FMT>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-self-test-log.html b/Documentation/nvme-self-test-log.html index 00c0490..a58677b 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme self-test</em>-log <device> [--log-entries=<entries> | -e <entries>]
- [--output-format=<FMT> | -o <FMT>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -788,15 +788,26 @@ json format.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -847,7 +858,7 @@ Get the self-test-log and print it in a json format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-self-test-log.txt b/Documentation/nvme-self-test-log.txt index 56a3c4a..d4600e8 100644 --- a/Documentation/nvme-self-test-log.txt +++ b/Documentation/nvme-self-test-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme self-test'-log <device> [--log-entries=<entries> | -e <entries>] - [--output-format=<FMT> | -o <FMT>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -35,11 +35,14 @@ OPTION the device. This must be at least one, and shouldn't exceed the 20 entries. Defaults to 20 DST log entries. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-set-feature.1 b/Documentation/nvme-set-feature.1 index 0ab78b9..40e8a07 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] .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>, \-\-value=<value> +\-V <value>, \-\-value=<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 <fmt>, \-\-output\-format=<fmt> +.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 41d8018..912a97f 100644 --- a/Documentation/nvme-set-feature.html +++ b/Documentation/nvme-set-feature.html @@ -750,11 +750,11 @@ nvme-set-feature(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme set-feature</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -826,7 +826,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di </p>
</dd>
<dt class="hdlist1">
--v <value>
+-V <value>
</dt>
<dt class="hdlist1">
--value=<value>
@@ -859,6 +859,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di UUID Index of the feature
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -868,11 +891,11 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <div class="ulist"><ul>
<li>
<p>
-Sets the Power State (PS) to 1 in feature id 2:
+Sets the Power State (PS) to 1 in feature id 2:
</p>
<div class="listingblock">
<div class="content">
-<pre><code># nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -v 0x1</code></pre>
+<pre><code># nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1</code></pre>
</div></div>
</li>
<li>
@@ -899,7 +922,7 @@ Sets the host id to the ascii string. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-set-feature.txt b/Documentation/nvme-set-feature.txt index 08b38f4..05c2210 100644 --- a/Documentation/nvme-set-feature.txt +++ b/Documentation/nvme-set-feature.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -51,7 +51,7 @@ OPTIONS Range Type and host identifier. This defaults to STDIN so files and echo can be piped. --v <value>:: +-V <value>:: --value=<value>:: The value for command dword 11, the value you want to set the feature to. @@ -64,12 +64,21 @@ OPTIONS --uuid-index=<uuid-index>:: UUID Index of the feature +-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 -------- -* 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 ------------ + diff --git a/Documentation/nvme-set-property.1 b/Documentation/nvme-set-property.1 index ef5d1f4..a18ac85 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-offset=<offset> | \-o <offset>] - [\-\-value=<val> | \-v <val>] +\fInvme set\-property\fR <device> [\-\-offset=<offset> | \-O <offset>] + [\-\-value=<val> | \-V <val>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 873b83b..c35b4ff 100644 --- a/Documentation/nvme-set-property.html +++ b/Documentation/nvme-set-property.html @@ -749,8 +749,9 @@ nvme-set-property(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme set-property</em> <device> [--offset=<offset> | -o <offset>]
- [--value=<val> | -v <val>]</pre>
+<pre class="content"><em>nvme set-property</em> <device> [--offset=<offset> | -O <offset>]
+ [--value=<val> | -V <val>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -766,18 +767,18 @@ nvme-set-property(1) Manual Page <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o
+-O
</dt>
<dt class="hdlist1">
--offset
</dt>
<dd>
<p>
- The offset of the property.
+ The offset of the property.
</p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dd>
<p>
@@ -785,6 +786,29 @@ nvme-set-property(1) Manual Page The value of the property to be set.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -805,7 +829,7 @@ nvme-set-property(1) Manual Page <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt index ba90fd3..22a513c 100644 --- a/Documentation/nvme-set-property.txt +++ b/Documentation/nvme-set-property.txt @@ -9,9 +9,9 @@ for NVMe over Fabric SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -19,14 +19,23 @@ Writes and shows the defined NVMe controller property for NVMe over Fabric. OPTIONS ------- --o:: +-O:: --offset:: - The offset of the property. + The offset of the property. --v:: +-V:: --value: 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. + EXAMPLES -------- No examples (yet). diff --git a/Documentation/nvme-show-hostnqn.1 b/Documentation/nvme-show-hostnqn.1 index 0411ebd..7ecddf5 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<fmt> | \-o <fmt>] [\-\-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 <fmt>, \-\-output\-format=<fmt> +.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 19ee45e..e395b37 100644 --- a/Documentation/nvme-show-hostnqn.html +++ b/Documentation/nvme-show-hostnqn.html @@ -749,7 +749,7 @@ nvme-show-hostnqn(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme show-hostnqn</em></pre>
+<pre class="content"><em>nvme show-hostnqn</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -757,7 +757,7 @@ nvme-show-hostnqn(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Show the host NQN configured for the system. If /usr/local/etc/nvme/hostnqn is
+<div class="paragraph"><p>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.</p></div>
</div>
@@ -765,7 +765,31 @@ this will show the systemd-generated host NQN for the system.</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>No options needed</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -785,7 +809,7 @@ this will show the systemd-generated host NQN for the system.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-show-hostnqn.txt b/Documentation/nvme-show-hostnqn.txt index 047e291..5074e2c 100644 --- a/Documentation/nvme-show-hostnqn.txt +++ b/Documentation/nvme-show-hostnqn.txt @@ -8,17 +8,24 @@ nvme-show-hostnqn - Show the host NQN configured for the system SYNOPSIS -------- [verse] -'nvme show-hostnqn' +'nvme show-hostnqn' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- -Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is +Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is not present and systemd application-specific machine IDs are available, 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. EXAMPLES -------- diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1 index a7ea5ac..e47d913 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-human\-readable | \-H] - [\-\-output\-format=<FMT> | \-o <FMT>] +\fInvme show\-regs\fR <device> [\-\-human\-readable | \-H] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -47,13 +47,19 @@ The <device> parameter is mandatory and must be the nvme admin character device Display registers or supported properties in human readable format\&. .RE .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html index 79ed622..96941b9 100644 --- a/Documentation/nvme-show-regs.html +++ b/Documentation/nvme-show-regs.html @@ -749,8 +749,8 @@ nvme-id-ns(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme show-regs</em> <device> [--human-readable | -H]
- [--output-format=<FMT> | -o <FMT>]</pre>
+<pre class="content"><em>nvme show-regs</em> <device> [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -782,19 +782,30 @@ Only the supported properties are displayed.</p></div> </dt>
<dd>
<p>
- Display registers or supported properties in human readable format.
+ Display registers or supported properties in human readable format.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -848,7 +859,7 @@ in a json format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-show-regs.txt b/Documentation/nvme-show-regs.txt index 892b394..0460365 100644 --- a/Documentation/nvme-show-regs.txt +++ b/Documentation/nvme-show-regs.txt @@ -9,8 +9,8 @@ NVMe over PCIe or the controller properties for NVMe over Fabrics. SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -30,12 +30,16 @@ OPTIONS ------- -H:: --human-readable:: - Display registers or supported properties in human readable format. + Display registers or supported properties in human readable format. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-show-topology.1 b/Documentation/nvme-show-topology.1 index 1f56e19..4885936 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Show the topology of all NVMe subsystems\&. .SH "OPTIONS" .PP -\-o <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR @@ -62,6 +62,20 @@ Set the ranking orer to \fInamespace\fR ordered\&. .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 7675a6b..ca90b74 100644 --- a/Documentation/nvme-show-topology.html +++ b/Documentation/nvme-show-topology.html @@ -749,7 +749,7 @@ nvme-show-topology(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme show-topology</em></pre>
+<pre class="content"><em>nvme show-topology</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -765,10 +765,10 @@ nvme-show-topology(1) Manual Page <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -802,6 +802,29 @@ nvme-show-topology(1) Manual Page always <em>namespace</em> ordered.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -822,7 +845,7 @@ nvme-show-topology(1) Manual Page <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-show-topology.txt b/Documentation/nvme-show-topology.txt index f0583fb..32ffad1 100644 --- a/Documentation/nvme-show-topology.txt +++ b/Documentation/nvme-show-topology.txt @@ -8,7 +8,7 @@ nvme-show-topology - Show topology of all NVMe subsystems SYNOPSIS -------- [verse] -'nvme show-topology' +'nvme show-topology' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -16,8 +16,8 @@ Show the topology of all NVMe subsystems. OPTIONS ------- --o <format>:: ---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. @@ -33,6 +33,15 @@ OPTIONS has only an effect for output format 'normal'. The JSON output is 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. + EXAMPLES -------- nvme show-topology diff --git a/Documentation/nvme-smart-log.1 b/Documentation/nvme-smart-log.1 index 6c95ab5..2fa623b 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-raw\-binary | \-b] - [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .RS 4 Set the reporting format to \fInormal\fR, -\fIjson\fR, or +\fIjson\fR +or \fIbinary\fR\&. Only one output format can be used at a time\&. .RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-smart-log.html b/Documentation/nvme-smart-log.html index 5c62ef2..31e7615 100644 --- a/Documentation/nvme-smart-log.html +++ b/Documentation/nvme-smart-log.html @@ -751,7 +751,7 @@ nvme-smart-log(1) Manual Page <div class="verseblock">
<pre class="content"><em>nvme smart-log</em> <device> [--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]</pre>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -799,15 +799,26 @@ printed to stdout for another program to parse.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -850,7 +861,7 @@ Print the raw SMART log to a file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-smart-log.txt b/Documentation/nvme-smart-log.txt index 77d0015..c08f523 100644 --- a/Documentation/nvme-smart-log.txt +++ b/Documentation/nvme-smart-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme smart-log' <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b] - [--output-format=<fmt> | -o <fmt>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -38,10 +38,14 @@ OPTIONS --raw-binary:: Print the raw SMART log buffer to stdout. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-subsystem-reset.1 b/Documentation/nvme-subsystem-reset.1 index 6a7ee6b..a5c3cd6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp Requests NVMe subsystem reset\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. .SH "OPTIONS" -.sp -None +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 51e27cc..c4f769c 100644 --- a/Documentation/nvme-subsystem-reset.html +++ b/Documentation/nvme-subsystem-reset.html @@ -749,7 +749,8 @@ nvme-subsystem-reset(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme subsystem-reset</em> <device></pre>
+<pre class="content"><em>nvme subsystem-reset</em> <device>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -764,7 +765,31 @@ be an NVMe character device (ex: /dev/nvme0).</p></div> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>None</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
+</dl></div>
</div>
</div>
<div class="sect1">
@@ -794,7 +819,7 @@ Resets the subsystem. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-subsystem-reset.txt b/Documentation/nvme-subsystem-reset.txt index 2267acd..cc3a139 100644 --- a/Documentation/nvme-subsystem-reset.txt +++ b/Documentation/nvme-subsystem-reset.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme subsystem-reset' <device> + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +18,14 @@ 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. EXAMPLES -------- diff --git a/Documentation/nvme-supported-cap-config-log.txt b/Documentation/nvme-supported-cap-config-log.txt index 0050634..b60303b 100644 --- a/Documentation/nvme-supported-cap-config-log.txt +++ b/Documentation/nvme-supported-cap-config-log.txt @@ -9,9 +9,8 @@ Configuration List Log pages request, returns result and log. SYNOPSIS -------- [verse] -'nvme supported-cap-config-log' <device> [--dom-id | -d ] - [--output-format=<fmt> | -o <fmt>] - [--raw-binary | -b] +'nvme supported-cap-config-log' <device> [--dom-id | -d] [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -27,19 +26,23 @@ pages log structure will be printed. OPTIONS ------- - --o <format>:: ---output-format=<format>:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. - -d:: --dom-id:: - To get the domain ID. + To get the domain ID. + -b:: --raw-binary:: To show raw binary data. +-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 -------- No examples provided yet. diff --git a/Documentation/nvme-supported-log-pages.1 b/Documentation/nvme-supported-log-pages.1 index 5a41133..1b84d03 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-output\-format=<fmt> | \-o <fmt>] - [\-\-verbose | \-v] +\fInvme supported\-log\-pages\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,14 +43,18 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 228ee9a..3f811d7 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme supported-log-pages</em> <device> [--output-format=<fmt> | -o <fmt>]
- [--verbose | -v]</pre>
+<pre class="content"><em>nvme supported-log-pages</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -771,15 +770,15 @@ for each command that is supported.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- 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 <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
@@ -790,7 +789,8 @@ for each command that is supported.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
</dl></div>
@@ -813,7 +813,7 @@ for each command that is supported.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-supported-log-pages.txt b/Documentation/nvme-supported-log-pages.txt index f80aa5f..bd17fdf 100644 --- a/Documentation/nvme-supported-log-pages.txt +++ b/Documentation/nvme-supported-log-pages.txt @@ -8,8 +8,7 @@ nvme-supported-log-pages - Send NVMe Supported Log pages request, returns result SYNOPSIS -------- [verse] -'nvme supported-log-pages' <device> [--output-format=<fmt> | -o <fmt>] - [--verbose | -v] +'nvme supported-log-pages' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -25,14 +24,15 @@ for each command that is supported. OPTIONS ------- --o <format>:: ---output-format=<format>:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. -v:: --verbose:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-telemetry-log.1 b/Documentation/nvme-telemetry-log.1 index 9f68cd9..16be54c 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-output\-file=<file> | \-o <file>] - [\-\-host\-generate=<gen> | \-g <gen>] +\fInvme telemetry\-log\fR <device> [\-\-output\-file=<file> | \-O <file>] + [\-\-host\-generate=<gen> | \-g <gen>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp @@ -44,7 +45,7 @@ The <device> 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 <file>, \-\-output\-file=<file> +\-O <file>, \-\-output\-file=<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 <fmt>, \-\-output\-format=<fmt> +.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 bcd352e..9dd19a6 100644 --- a/Documentation/nvme-telemetry-log.html +++ b/Documentation/nvme-telemetry-log.html @@ -749,8 +749,9 @@ nvme-telemetry-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme telemetry-log</em> <device> [--output-file=<file> | -o <file>]
- [--host-generate=<gen> | -g <gen>]</pre>
+<pre class="content"><em>nvme telemetry-log</em> <device> [--output-file=<file> | -O <file>]
+ [--host-generate=<gen> | -g <gen>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -771,7 +772,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <file>
+-O <file>
</dt>
<dt class="hdlist1">
--output-file=<file>
@@ -808,6 +809,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di 4 may not be supported.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -838,7 +862,7 @@ Retrieve Telemetry Host-Initiated data to telemetry_log.bin <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-telemetry-log.txt b/Documentation/nvme-telemetry-log.txt index cf126d9..4d2a494 100644 --- a/Documentation/nvme-telemetry-log.txt +++ b/Documentation/nvme-telemetry-log.txt @@ -8,8 +8,9 @@ nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -24,7 +25,7 @@ On success, the returned log structure will be in raw binary format _only_ with OPTIONS ------- --o <file>:: +-O <file>:: --output-file=<file>:: File name to which raw binary data will be saved to. @@ -41,6 +42,15 @@ OPTIONS this option is not specified, the default value is 3, since data area 4 may not be supported. +-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 -------- * 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 ad49454..55d427d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 88b176d..0446e41 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt index 5871900..862c860 100644 --- a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt @@ -10,7 +10,6 @@ SYNOPSIS [verse] 'nvme toshiba clear-pcie-correctable-errors ' <device> - DESCRIPTION ----------- For the NVMe device given, sends the Toshiba clear PCIe correctable errors @@ -20,7 +19,6 @@ The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). - EXAMPLES -------- * 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 08ee01b..a229fd9 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 e520bfc..9ef7959 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-toshiba-vs-internal-log.txt b/Documentation/nvme-toshiba-vs-internal-log.txt index d3c0104..3cfb917 100644 --- a/Documentation/nvme-toshiba-vs-internal-log.txt +++ b/Documentation/nvme-toshiba-vs-internal-log.txt @@ -34,12 +34,10 @@ A progress runner is included when data is written to file and a page count is i OPTIONS ------- - -o <FILE>:: --output-file=<FILE>:: Output binary file. Defaults to text-formatted dump to stdout - -p:: --prev-log:: Use previous log contents. Defaults to the current log contents. diff --git a/Documentation/nvme-toshiba-vs-smart-add-log.1 b/Documentation/nvme-toshiba-vs-smart-add-log.1 index 1703e52..2a43f9f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 f9ff173..1ef222f 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.</p <div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).</p></div>
-<div class="paragraph"><p>The log contents may be associated with the controller, in which case the namespace parameter is ignored.</p></div>
+<div class="paragraph"><p>The log contents may be associated with the controller, in which case the
+namespace parameter is ignored.</p></div>
<div class="paragraph"><p>Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page)</p></div>
<div class="paragraph"><p>This will only work on Toshiba devices supporting this feature.</p></div>
</div>
@@ -781,7 +782,7 @@ character device (ex: /dev/nvme0), or a namespace block device (ex: </dt>
<dd>
<p>
- Log page: 0xC0 or 0xCA (defaults to 0xCA)
+ Log page: 0xC0 or 0xCA (defaults to 0xCA)
</p>
</dd>
<dt class="hdlist1">
@@ -840,7 +841,7 @@ Get the contents of log page 0xC0 from the device and save to a binary file: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-toshiba-vs-smart-add-log.txt b/Documentation/nvme-toshiba-vs-smart-add-log.txt index 8ea4d3e..96a13ca 100644 --- a/Documentation/nvme-toshiba-vs-smart-add-log.txt +++ b/Documentation/nvme-toshiba-vs-smart-add-log.txt @@ -3,7 +3,8 @@ nvme-toshiba-vs-smart-add-log(1) NAME ---- -nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific extended SMART log page contents and either save to file or dump the contents. +nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific +extended SMART log page contents and either save to file or dump the contents. SYNOPSIS -------- @@ -12,7 +13,6 @@ SYNOPSIS [--namespace-id=<NUM>, -n <NUM>] [--output-file=<FILE>, -o <FILE>] - DESCRIPTION ----------- For the NVMe device given, sends the Toshiba vendor log @@ -22,7 +22,8 @@ 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) @@ -33,7 +34,7 @@ OPTIONS -l <NUM>:: --log=<NUM>:: - Log page: 0xC0 or 0xCA (defaults to 0xCA) + Log page: 0xC0 or 0xCA (defaults to 0xCA) -n <NUM>:: --namespace-id=<NUM>:: @@ -42,8 +43,6 @@ OPTIONS --output-file=<FILE>:: Output binary file. Defaults to text-formatted dump to stdout - - EXAMPLES -------- * Get the current log from the device and dumps it to stdout: diff --git a/Documentation/nvme-transcend-badblock.1 b/Documentation/nvme-transcend-badblock.1 index 4daf67d..affdaa3 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-transcend-badblock.html b/Documentation/nvme-transcend-badblock.html index f8df9fa..276080f 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-transcend-badblock.txt b/Documentation/nvme-transcend-badblock.txt index 888076c..9b6f671 100644 --- a/Documentation/nvme-transcend-badblock.txt +++ b/Documentation/nvme-transcend-badblock.txt @@ -23,7 +23,6 @@ OPTIONS ------- none - EXAMPLES -------- * 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 9da212c..e69b1c8 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-transcend-healthvalue.html b/Documentation/nvme-transcend-healthvalue.html index 51668ee..5c1e541 100644 --- a/Documentation/nvme-transcend-healthvalue.html +++ b/Documentation/nvme-transcend-healthvalue.html @@ -757,7 +757,8 @@ nvme-transcend-healthvalue(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Retrieves the NVMe Device SMART log page from the Transcend device and evaluate health status of Transcend device.</p></div>
+<div class="paragraph"><p>Retrieves the NVMe Device SMART log page from the Transcend device and evaluate
+health status of Transcend device.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>
<div class="paragraph"><p>On success, the returned value would print health percentage value.</p></div>
@@ -796,7 +797,7 @@ Print the Transcend Device health value in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-transcend-healthvalue.txt b/Documentation/nvme-transcend-healthvalue.txt index 4a7d52f..90340ce 100644 --- a/Documentation/nvme-transcend-healthvalue.txt +++ b/Documentation/nvme-transcend-healthvalue.txt @@ -3,7 +3,8 @@ nvme-transcend-healthvalue(1) NAME ---- -nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of Transcend device. +nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of +Transcend device. SYNOPSIS -------- @@ -12,7 +13,8 @@ SYNOPSIS 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). @@ -23,7 +25,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Transcend Device health value in a human readable format: diff --git a/Documentation/nvme-verify.1 b/Documentation/nvme-verify.1 index 1fbdd36..858e432 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-VERIFY" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-VERIFY" "1" "12/21/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 <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] .fi .SH "DESCRIPTION" .sp The Verify command verifies the integrity of the stored information by reading data and metadata\&. .SH "OPTIONS" .PP -\-\-namespace\-id=<nsid>, \-n <nsid> +\-n <nsid>, \-\-namespace\-id=<nsid> .RS 4 Namespace ID use in the command\&. .RE .PP -\-\-start\-block=<slba>, \-s <slba> +\-s <slba>, \-\-start\-block=<slba> .RS 4 Start block address\&. .RE .PP -\-\-block\-count=<nlb>, \-c <nlb> +\-c <nlb>, \-\-block\-count=<nlb> .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=<prinfo>, \-p <prinfo> +\-p <prinfo>, \-\-prinfo=<prinfo> .RS 4 Protection Information field definition\&. .TS @@ -119,17 +119,17 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=<reftag>, \-r <reftag> +\-r <reftag>, \-\-ref\-tag=<reftag> .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=<appmask>, \-m <appmask> +\-m <appmask>, \-\-app\-tag\-mask=<appmask> .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=<apptag>, \-a <apptag> +\-a <apptag>, \-\-app\-tag=<apptag> .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 <fmt>, \-\-output\-format=<fmt> +.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 5616b77..a21984e 100644 --- a/Documentation/nvme-verify.html +++ b/Documentation/nvme-verify.html @@ -750,16 +750,16 @@ nvme-verify(1) Manual Page <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme-verify</em> <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]</pre>
+ [--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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -776,10 +776,10 @@ reading data and metadata.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---namespace-id=<nsid>
+-n <nsid>
</dt>
<dt class="hdlist1">
--n <nsid>
+--namespace-id=<nsid>
</dt>
<dd>
<p>
@@ -787,10 +787,10 @@ reading data and metadata.</p></div> </p>
</dd>
<dt class="hdlist1">
---start-block=<slba>
+-s <slba>
</dt>
<dt class="hdlist1">
--s <slba>
+--start-block=<slba>
</dt>
<dd>
<p>
@@ -798,10 +798,10 @@ reading data and metadata.</p></div> </p>
</dd>
<dt class="hdlist1">
---block-count=<nlb>
+-c <nlb>
</dt>
<dt class="hdlist1">
--c <nlb>
+--block-count=<nlb>
</dt>
<dd>
<p>
@@ -809,10 +809,10 @@ reading data and metadata.</p></div> </p>
</dd>
<dt class="hdlist1">
---limited-retry
+-l
</dt>
<dt class="hdlist1">
--l
+--limited-retry
</dt>
<dd>
<p>
@@ -820,10 +820,10 @@ reading data and metadata.</p></div> </p>
</dd>
<dt class="hdlist1">
---force-unit-access
+-f
</dt>
<dt class="hdlist1">
--f
+--force-unit-access
</dt>
<dd>
<p>
@@ -831,10 +831,10 @@ reading data and metadata.</p></div> </p>
</dd>
<dt class="hdlist1">
---prinfo=<prinfo>
+-p <prinfo>
</dt>
<dt class="hdlist1">
--p <prinfo>
+--prinfo=<prinfo>
</dt>
<dd>
<p>
@@ -879,10 +879,10 @@ metadata is passes.</p></td> </div>
</dd>
<dt class="hdlist1">
---ref-tag=<reftag>
+-r <reftag>
</dt>
<dt class="hdlist1">
--r <reftag>
+--ref-tag=<reftag>
</dt>
<dd>
<p>
@@ -890,10 +890,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag-mask=<appmask>
+-m <appmask>
</dt>
<dt class="hdlist1">
--m <appmask>
+--app-tag-mask=<appmask>
</dt>
<dd>
<p>
@@ -901,10 +901,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag=<apptag>
+-a <apptag>
</dt>
<dt class="hdlist1">
--a <apptag>
+--app-tag=<apptag>
</dt>
<dd>
<p>
@@ -933,6 +933,29 @@ metadata is passes.</p></td> This flag enables Storage Tag field checking as part of Verify operation.
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -953,7 +976,7 @@ metadata is passes.</p></td> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-verify.txt b/Documentation/nvme-verify.txt index 3c8039a..01dabbf 100644 --- a/Documentation/nvme-verify.txt +++ b/Documentation/nvme-verify.txt @@ -9,16 +9,16 @@ SYNOPSIS -------- [verse] '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] DESCRIPTION ----------- @@ -27,28 +27,28 @@ reading data and metadata. OPTIONS ------- ---namespace-id=<nsid>:: -n <nsid>:: +--namespace-id=<nsid>:: Namespace ID use in the command. ---start-block=<slba>:: -s <slba>:: +--start-block=<slba>:: Start block address. ---block-count=<nlb>:: -c <nlb>:: +--block-count=<nlb>:: Number of logical blocks to Verify. ---limited-retry:: -l:: +--limited-retry:: Sets the limited retry flag. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. ---prinfo=<prinfo>:: -p <prinfo>:: +--prinfo=<prinfo>:: Protection Information field definition. + [] @@ -63,16 +63,16 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=<reftag>:: -r <reftag>:: +--ref-tag=<reftag>:: Optional reftag when used with protection information. ---app-tag-mask=<appmask>:: -m <appmask>:: +--app-tag-mask=<appmask>:: Optional application tag mask when used with protection information. ---app-tag=<apptag>:: -a <apptag>:: +--app-tag=<apptag>:: Optional application tag when used with protection information. -S <storage-tag>:: @@ -83,6 +83,15 @@ metadata is passes. --storage-tag-check:: 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-virt-mgmt.txt b/Documentation/nvme-virt-mgmt.txt new file mode 100755 index 0000000..5eede14 --- /dev/null +++ b/Documentation/nvme-virt-mgmt.txt @@ -0,0 +1,70 @@ +nvme-virt-mgmt(1) +================= + +NAME +---- +nvme-virt-mgmt - Manage flexible resources between primary and secondary +controller + +SYNOPSIS +-------- +[verse] +'nvme virt-mgmt' <device> [--cntlid=<cntlid> | -c <cntlid>] + [--rt=<rt> | -r <rt>] [--act=<act> | -a <act>] + [--nr=<nr> | -n <nr>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Manage flexible resources between primary and secondary controller, return +results. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-c <cntlid>:: +--cntlid=<cntlid>:: + Controller identifier (CNTLID) + +-r <rt>:: +--rt=<rt>:: + Resource Type (RT): [0,1] + 0h: VQ Resources + 1h: VI Resources + +-a <act>:: +--act=<act>:: + Action(ACT): [1,7,8,9] + 1h: Primary Flexible + 7h: Secondary Offline + 8h: Secondary Assign + 9h: Secondary Online + +-n <nr>:: +--nr=<nr>:: + Number of controller resources (NR) + +-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 +-------- +* Has the program issue a virt-mgmt to manage flexible resources. ++ +------------ +# nvme virt-mgmt /dev/nvme0 -c 0 -r 1 -a 1 -n 0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.1 b/Documentation/nvme-virtium-save-smart-to-vtview-log.1 index 292c91b..b21beba 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> 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 <NUM>, \-\-freq=<NUM> .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 <FILE>, \-\-output\-file=<FILE> diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.html b/Documentation/nvme-virtium-save-smart-to-vtview-log.html index 7140680..4f84716 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 <div class="paragraph"><p>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.</p></div>
+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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>
-<div class="paragraph"><p>On success, the command generates a log file, which contains an entry for identify device
-(current features & settings) and periodic entries of SMART data.</p></div>
-<div class="paragraph"><p>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.</p></div>
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>On success, the command generates a log file, which contains an entry for
+identify device (current features & settings) and periodic entries of SMART data.</p></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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.</p></div>
</div>
</div>
<div class="sect1">
@@ -800,8 +801,8 @@ of the log file name.</p></div> </dt>
<dd>
<p>
- (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.
</p>
</dd>
<dt class="hdlist1">
@@ -812,9 +813,9 @@ of the log file name.</p></div> </dt>
<dd>
<p>
- (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.
</p>
</dd>
<dt class="hdlist1">
@@ -825,7 +826,8 @@ of the log file name.</p></div> </dt>
<dd>
<p>
- (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.
</p>
</dd>
</dl></div>
@@ -876,7 +878,7 @@ Just logging: Default logging is run for 20 hours and log every 10 hours. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.txt b/Documentation/nvme-virtium-save-smart-to-vtview-log.txt index 313ac35..72090c0 100644 --- a/Documentation/nvme-virtium-save-smart-to-vtview-log.txt +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.txt @@ -3,7 +3,8 @@ nvme-virtium-save-smart-to-vtview-log(1) NAME ---- -nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into a log file (csv format). +nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into +a log file (csv format). SYNOPSIS -------- @@ -12,28 +13,29 @@ SYNOPSIS [--freq=<NUM> | -f <NUM>] [--output-file=<FILE> | -o <FILE>] [--test-name=<NAME> | -n <NAME>] - + DESCRIPTION ----------- 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. +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. +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. +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. OPTIONS ------- @@ -43,20 +45,20 @@ OPTIONS -f <NUM>:: --freq=<NUM>:: - (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. -o <FILE>:: --output-file=<FILE>:: - (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. -n <NAME>:: --test-name=<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. + EXAMPLES -------- * Temperature characterization: diff --git a/Documentation/nvme-virtium-show-identify.1 b/Documentation/nvme-virtium-show-identify.1 index 8b445cb..6e4192a 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 ab4cb8e..ae82003 100644 --- a/Documentation/nvme-virtium-show-identify.html +++ b/Documentation/nvme-virtium-show-identify.html @@ -798,7 +798,7 @@ Show Identify Device: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-virtium-show-identify.txt b/Documentation/nvme-virtium-show-identify.txt index 5ce1933..881824c 100644 --- a/Documentation/nvme-virtium-show-identify.txt +++ b/Documentation/nvme-virtium-show-identify.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme virtium show-identify' <device> - + DESCRIPTION ----------- This command prints complete detail of the identify device information. The @@ -24,8 +24,7 @@ On success, the command prints identify device in human readable format. OPTIONS ------- none - - + EXAMPLES -------- * Show Identify Device: diff --git a/Documentation/nvme-wdc-cap-diag.1 b/Documentation/nvme-wdc-cap-diag.1 index edb93b2..6ce52a3 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 29a0cd6..1df78bc 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.</p></div> </dt>
<dd>
<p>
- Transfer size; defaults to 0x10000 (65536 decimal) bytes
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes
</p>
</dd>
</dl></div>
@@ -856,7 +856,7 @@ Gets the capture diagnostics log from the device transferring the data in 16k ch <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-cap-diag.txt b/Documentation/nvme-wdc-cap-diag.txt index 9439eaa..bfcde9a 100644 --- a/Documentation/nvme-wdc-cap-diag.txt +++ b/Documentation/nvme-wdc-cap-diag.txt @@ -29,7 +29,7 @@ OPTIONS -s <SIZE>:: --transfer-size=<SIZE>:: - Transfer size; defaults to 0x10000 (65536 decimal) bytes + Transfer size; defaults to 0x10000 (65536 decimal) bytes EXAMPLES -------- diff --git a/Documentation/nvme-wdc-capabilities.1 b/Documentation/nvme-wdc-capabilities.1 index 348702a..c0c2a69 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-capabilities.html b/Documentation/nvme-wdc-capabilities.html index 3109d51..d89304e 100644 --- a/Documentation/nvme-wdc-capabilities.html +++ b/Documentation/nvme-wdc-capabilities.html @@ -789,7 +789,7 @@ Displays the capabilities for the device: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-clear-assert-dump.1 b/Documentation/nvme-wdc-clear-assert-dump.1 index 6b4c887..6176d1f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 a8eed74..0a3c3c9 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): <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-clear-assert-dump.txt b/Documentation/nvme-wdc-clear-assert-dump.txt index a575089..60493df 100644 --- a/Documentation/nvme-wdc-clear-assert-dump.txt +++ b/Documentation/nvme-wdc-clear-assert-dump.txt @@ -33,7 +33,6 @@ EXAMPLES # nvme wdc clear-assert-dump /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.1 b/Documentation/nvme-wdc-clear-fw-activate-history.1 index 92998b9..f8f4e39 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 ed34302..99ab9a5 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.txt b/Documentation/nvme-wdc-clear-fw-activate-history.txt index 50be1e9..ddb6c26 100644 --- a/Documentation/nvme-wdc-clear-fw-activate-history.txt +++ b/Documentation/nvme-wdc-clear-fw-activate-history.txt @@ -32,7 +32,6 @@ EXAMPLES # nvme wdc clear-fw-activate-history /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 index e979185..5f9e7e5 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 bbbc8d4..cbe996f 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt b/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt index 4788f1f..cecc52e 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt @@ -34,7 +34,6 @@ EXAMPLES # nvme wdc clear-pcie-correctable-errors /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 b/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 index c714776..5c5e541 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 c94e7a5..b6cc4c8 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-cloud-boot-SSD-version.1 b/Documentation/nvme-wdc-cloud-boot-SSD-version.1 index 34b6289..7be90e1 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 b536657..d781c18 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-drive-essentials.1 b/Documentation/nvme-wdc-drive-essentials.1 index 9c5d70f..4783608 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 48c4a83..a9bbc3c 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 <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>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</p></div>
+<div class="paragraph"><p>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</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory; NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
Results for any other device are undefined.</p></div>
@@ -821,7 +822,7 @@ Gets the drive essentials data files from the device and saves the tar file to s <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-drive-essentials.txt b/Documentation/nvme-wdc-drive-essentials.txt index 59b2787..7f06040 100644 --- a/Documentation/nvme-wdc-drive-essentials.txt +++ b/Documentation/nvme-wdc-drive-essentials.txt @@ -3,7 +3,8 @@ nvme-wdc-drive-essentials(1) NAME ---- -nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and save to a tar file. +nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and +save to a tar file. SYNOPSIS -------- @@ -13,9 +14,10 @@ SYNOPSIS 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). diff --git a/Documentation/nvme-wdc-drive-log.1 b/Documentation/nvme-wdc-drive-log.1 index 0fca516..91cd4d1 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 4c442be..80a8981 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. <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-drive-log.txt b/Documentation/nvme-wdc-drive-log.txt index 3c6a589..0587df9 100644 --- a/Documentation/nvme-wdc-drive-log.txt +++ b/Documentation/nvme-wdc-drive-log.txt @@ -28,7 +28,6 @@ OPTIONS --output-file=<FILE>:: Output file; defaults to device serial number followed by "drive_log" suffix - EXAMPLES -------- * Gets the drive log from the device and saves to default file in current directory (e.g. STM00019F3F9drive_log.bin): diff --git a/Documentation/nvme-wdc-drive-resize.1 b/Documentation/nvme-wdc-drive-resize.1 index 7fe9e5e..ac0955f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 f1a952f..e1d5cf0 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 : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-enc-get-log.1 b/Documentation/nvme-wdc-enc-get-log.1 index 02110aa..c4d8ef6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-log\-id=<NUM>, \-l <NUM>] [\-\-output\-file=<FILE>, \-o <FILE>] [\-\-transfer\-size=<SIZE>, \-s <SIZE>] +\fInvme wdc enc\-get\-log\fR <device> [\-\-log\-id=<NUM>, \-l <NUM>] + [\-\-output\-file=<FILE>, \-o <FILE>] + [\-\-transfer\-size=<SIZE>, \-s <SIZE>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-wdc-enc-get-log.html b/Documentation/nvme-wdc-enc-get-log.html index 7ff9cdd..59f37ff 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc enc-get-log</em> <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]</pre>
+<pre class="content"><em>nvme wdc enc-get-log</em> <device> [--log-id=<NUM>, -l <NUM>]
+ [--output-file=<FILE>, -o <FILE>]
+ [--transfer-size=<SIZE>, -s <SIZE>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -761,7 +763,8 @@ nvme-wdc-enc-get-log(1) Manual Page output the Enclosure logs.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0).</p></div>
-<div class="paragraph"><p>The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.</p></div>
+<div class="paragraph"><p>The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2,
+0xd3, 0xd4, 0xe2 and 0xe4.</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
Results for any other device are undefined.</p></div>
<div class="paragraph"><p>On success it returns the enclosure log data, error code otherwise.</p></div>
@@ -779,7 +782,7 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- Output file pathname
+ Output file pathname
</p>
</dd>
<dt class="hdlist1">
@@ -790,7 +793,8 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192)
+ Data retrieval transfer size, maximum transfer size should be 0x2000
+ (decimal 8192)
</p>
</dd>
</dl></div>
@@ -802,7 +806,8 @@ Results for any other device are undefined.</p></div> <div class="ulist"><ul>
<li>
<p>
-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:
</p>
<div class="listingblock">
<div class="content">
@@ -832,7 +837,7 @@ Gets the enclosure log from the device based on the log id(0xd2) with default tr <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-enc-get-log.txt b/Documentation/nvme-wdc-enc-get-log.txt index ae93a7a..bcff83f 100644 --- a/Documentation/nvme-wdc-enc-get-log.txt +++ b/Documentation/nvme-wdc-enc-get-log.txt @@ -3,12 +3,15 @@ nvme-wdc-enc-get-log(1) NAME ---- -nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return result. +nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return +result. SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -19,7 +22,8 @@ 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. @@ -30,15 +34,17 @@ OPTIONS ------- -o <FILE>:: --output-file=<FILE>:: - Output file pathname + Output file pathname -s <SIZE>:: --transfer-size=<NUM>:: - Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192) + Data retrieval transfer size, maximum transfer size should be 0x2000 + (decimal 8192) EXAMPLES -------- -* 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: + ------------ # nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000 diff --git a/Documentation/nvme-wdc-get-crash-dump.1 b/Documentation/nvme-wdc-get-crash-dump.1 index 6959dc1..7313533 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 639d665..f3ded31 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.1 b/Documentation/nvme-wdc-get-dev-capabilities-log.1 index 3ad7d99..38c5373 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-output\-format=<normal|json> -\-o <normal|json>] +\fInvme wdc get\-dev\-capabilities\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 d2627dd..424d77d 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -749,8 +749,7 @@ nvme-wdc-get-dev-capabilities-log(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc get-dev-capabilities-log</em> <device> [--output-format=<normal|json>
--o <normal|json>]</pre>
+<pre class="content"><em>nvme wdc get-dev-capabilities-log</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -774,10 +773,10 @@ code otherwise.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -816,7 +815,7 @@ Has the program issue WDC get-dev-capabilities-log plugin command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.txt b/Documentation/nvme-wdc-get-dev-capabilities-log.txt index 0621881..cf8606a 100644 --- a/Documentation/nvme-wdc-get-dev-capabilities-log.txt +++ b/Documentation/nvme-wdc-get-dev-capabilities-log.txt @@ -4,13 +4,12 @@ nvme-wdc-get-dev-capabilities-log(1) NAME ---- nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log - plugin command, return parsed log output +plugin command, return parsed log output SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -29,8 +28,8 @@ code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1 index 3119b40..c397041 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 c3d5735..b9377c0 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"> </tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>EOL (End of Life) Status</strong></p></td>
-<td align="left" valign="top"><p class="table">The 3 possible states are : Normal, Read Only, or End of Life.</p></td>
+<td align="left" valign="top"><p class="table">The 3 possible states are : Normal, Read Only, or End of Life.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>Assert Dump Status</strong></p></td>
-<td align="left" valign="top"><p class="table">The 2 possible states are : Present or Not Present.</p></td>
+<td align="left" valign="top"><p class="table">The 2 possible states are : Present or Not Present.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>Thermal Throttling Status</strong></p></td>
-<td align="left" valign="top"><p class="table">The 3 possible states are : Off, On, or Unavailable.</p></td>
+<td align="left" valign="top"><p class="table">The 3 possible states are : Off, On, or Unavailable.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>Format Corrupt Reason</strong></p></td>
-<td align="left" valign="top"><p class="table">The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.</p></td>
+<td align="left" valign="top"><p class="table">The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.</p></td>
</tr>
</tbody>
</table>
@@ -836,7 +836,7 @@ Has the program issue WDC get-drive-status command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-drive-status.txt b/Documentation/nvme-wdc-get-drive-status.txt index 10e212b..b1b4de4 100644 --- a/Documentation/nvme-wdc-get-drive-status.txt +++ b/Documentation/nvme-wdc-get-drive-status.txt @@ -3,7 +3,8 @@ nvme-wdc-get-drive-status(1) NAME ---- -nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return result +nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return +result SYNOPSIS -------- @@ -33,20 +34,19 @@ Output Explanation |The percentage of drive function used. |*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. |=== - EXAMPLES -------- * 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 1d00fae..ced322f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 9d2352c..c7c20d8 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -774,10 +774,10 @@ code otherwise.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -816,7 +816,7 @@ Has the program issue WDC get-error-recovery-log plugin command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-error-recovery-log.txt b/Documentation/nvme-wdc-get-error-recovery-log.txt index 2ad3605..4998390 100644 --- a/Documentation/nvme-wdc-get-error-recovery-log.txt +++ b/Documentation/nvme-wdc-get-error-recovery-log.txt @@ -4,7 +4,7 @@ nvme-wdc-get-error-recovery-log(1) NAME ---- nvme-wdc-get-error-recovery-log - Send NVMe WDC get-error-recovery-log plugin - command, return parsed log output +command, return parsed log output SYNOPSIS -------- @@ -29,8 +29,8 @@ code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.1 b/Documentation/nvme-wdc-get-latency-monitor-log.1 index c6425b6..72cd24b 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 438217a..12fab08 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -810,7 +810,7 @@ Displays the get latency monitor log for the device: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.txt b/Documentation/nvme-wdc-get-latency-monitor-log.txt index 19fda4a..abab8e8 100644 --- a/Documentation/nvme-wdc-get-latency-monitor-log.txt +++ b/Documentation/nvme-wdc-get-latency-monitor-log.txt @@ -24,8 +24,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. The default is normal. diff --git a/Documentation/nvme-wdc-get-pfail-dump.1 b/Documentation/nvme-wdc-get-pfail-dump.1 index 054a0c5..177a4a7 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 20f55a9..b000c32 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.1 b/Documentation/nvme-wdc-get-unsupported-reqs-log.1 index c9dfaef..0e71282 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 8645c49..7610f60 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -816,7 +816,7 @@ Has the program issue WDC get-unsupported-reqs-log plugin command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.txt b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt index f028665..61f09aa 100644 --- a/Documentation/nvme-wdc-get-unsupported-reqs-log.txt +++ b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt @@ -29,8 +29,8 @@ code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-id-ctrl.1 b/Documentation/nvme-wdc-id-ctrl.1 index 17ecc42..94a9f3c 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-H | \-\-human\-readable] - [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme wdc id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b] + [\-\-human\-readable | \-H] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 1ce9fa3..ae00b92 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-H | --human-readable]
- [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme wdc id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -814,15 +814,15 @@ will decode WDC vendor unique portions of the structure.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -856,7 +856,7 @@ fields in a human readable format: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-id-ctrl.txt b/Documentation/nvme-wdc-id-ctrl.txt index a9c6afe..b62eb60 100644 --- a/Documentation/nvme-wdc-id-ctrl.txt +++ b/Documentation/nvme-wdc-id-ctrl.txt @@ -8,9 +8,9 @@ nvme-wdc-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'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>] DESCRIPTION ----------- @@ -48,10 +48,10 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-wdc-log-page-directory.1 b/Documentation/nvme-wdc-log-page-directory.1 index a81fd04..6b468fe 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 03769b7..011087d 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 <h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
@@ -771,10 +771,10 @@ Results for any other device are undefined.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -812,7 +812,7 @@ WDC log-page-directory example command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-log-page-directory.txt b/Documentation/nvme-wdc-log-page-directory.txt index 4d6192f..27b5d9e 100644 --- a/Documentation/nvme-wdc-log-page-directory.txt +++ b/Documentation/nvme-wdc-log-page-directory.txt @@ -13,7 +13,7 @@ SYNOPSIS 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). @@ -25,8 +25,8 @@ On success it returns the log page directory information, error code otherwise. OPTIONS ------- --o <format>:: ---output-format=<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. The default is normal. diff --git a/Documentation/nvme-wdc-namespace-resize.1 b/Documentation/nvme-wdc-namespace-resize.1 index 02468ee..501112d 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-nsid=<NAMSPACE ID>, \-n <NAMSPACE ID>] [\-\-op_option=<OP OPTION>, \-o <OP OPTION>] +\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMESPACE ID>, \-n <NAMSPACE ID>] + [\-\-op_option=<OP OPTION>, \-o <OP OPTION>] .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 <device> 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 <NAMSPACE ID>, \-\-namespace\-id=<NAMSPACE_ID> +\-n <NAMESPACE ID>, \-\-namespace\-id=<NAMESPACE_ID> .RS 4 Namespace ID; ID of the namespace to resize .RE .PP \-o <OP OPTION>, \-\-op\-option=<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 419acc4..d8088b8 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc namespace-resize</em> <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>] [--op_option=<OP OPTION>, -o <OP OPTION>]</pre>
+<pre class="content"><em>nvme wdc namespace-resize</em> <device> [--nsid=<NAMESPACE ID>, -n <NAMSPACE ID>]
+ [--op_option=<OP OPTION>, -o <OP OPTION>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -757,8 +758,8 @@ nvme-wdc-namespace-resize(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported
-by the device.</p></div>
+<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Command that modifies
+the namespace size reported the device.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
Results for any other device are undefined.</p></div>
@@ -769,10 +770,10 @@ Results for any other device are undefined.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--n <NAMSPACE ID>
+-n <NAMESPACE ID>
</dt>
<dt class="hdlist1">
---namespace-id=<NAMSPACE_ID>
+--namespace-id=<NAMESPACE_ID>
</dt>
<dd>
<p>
@@ -787,17 +788,14 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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
</p>
-<div class="literalblock">
-<div class="content">
-<pre><code>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</code></pre>
-</div></div>
</dd>
</dl></div>
</div>
@@ -838,7 +836,7 @@ Resizes namespace 2 to 7% of the original TNVMCAP reported value: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-namespace-resize.txt b/Documentation/nvme-wdc-namespace-resize.txt index 71fc781..42994ad 100644 --- a/Documentation/nvme-wdc-namespace-resize.txt +++ b/Documentation/nvme-wdc-namespace-resize.txt @@ -8,13 +8,14 @@ nvme-wdc-namespace-resize - Resizes the device's namespace. SYNOPSIS -------- [verse] -'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>] 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). @@ -23,20 +24,19 @@ Results for any other device are undefined. OPTIONS ------- --n <NAMSPACE ID>:: ---namespace-id=<NAMSPACE_ID>:: +-n <NAMESPACE ID>:: +--namespace-id=<NAMESPACE_ID>:: Namespace ID; ID of the namespace to resize -o <OP OPTION>:: --op-option=<OP OPTION>:: - 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 + 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 EXAMPLES -------- diff --git a/Documentation/nvme-wdc-purge-monitor.1 b/Documentation/nvme-wdc-purge-monitor.1 index dc8612b..2a4bafe 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 a96def6..94e0f1d 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 : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-purge-monitor.txt b/Documentation/nvme-wdc-purge-monitor.txt index 313c8db..5d44183 100644 --- a/Documentation/nvme-wdc-purge-monitor.txt +++ b/Documentation/nvme-wdc-purge-monitor.txt @@ -37,7 +37,6 @@ Expected status and description :- |Purge State Error : Purge operation interrupted by power cycle or reset. |=== - The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). diff --git a/Documentation/nvme-wdc-purge.1 b/Documentation/nvme-wdc-purge.1 index 5a79047..5806ea8 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-purge.html b/Documentation/nvme-wdc-purge.html index 710914d..1d9bb9f 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 : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-set-latency-monitor-feature.txt b/Documentation/nvme-wdc-set-latency-monitor-feature.txt new file mode 100644 index 0000000..60b3e26 --- /dev/null +++ b/Documentation/nvme-wdc-set-latency-monitor-feature.txt @@ -0,0 +1,118 @@ +nvme-wdc-set-latency-monitor-feature(1) +======================================= + +NAME +---- +nvme-wdc-set-latency-monitor-feature - Set NVMe WDC latency monitor feature options + +SYNOPSIS +-------- +[verse] +'nvme wdc set-latency-monitor-feature' <device> + [--active_bucket_timer_threshold=<NUM> | -t <NUM>] + [--active_threshold_a=<NUM> | -a <NUM>] + [--active_threshold_b=<NUM> | -b <NUM>] + [--active_threshold_c=<NUM> | -c <NUM>] + [--active_threshold_d=<NUM> | -d <NUM>] + [--active_latency_config=<NUM> | -f <NUM>] + [--active_latency_minimum_window=<NUM> | -w <NUM>] + [--debug_log_trigger_enable=<NUM> | -r <NUM>] + [--discard_debug_log=<NUM> | -l <NUM>] + [--latency_monitor_feature_enable=<NUM> | -e <NUM>] + +DESCRIPTION +----------- +For the NVMe device given, this command set the +latency monitor feature options (if supported by the device). + +The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0). + +Setting results can be checked with 'get-latency-monitor-log' command. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-t <NUM>:: +--active_bucket_timer_threshold=<NUM>:: + The value that loads the Active Bucket Timer Threshold; default value is 07E0h. + +-a <NUM>:: +--active_threshold_a=<NUM>:: + The value that loads into the Active Threshold A; default value is 05h. + +-b <NUM>:: +--active_threshold_b=<NUM>:: + The value that loads into the Active Threshold B; default value is 13h. + +-c <NUM>:: +--active_threshold_c=<NUM>:: + The value that loads into the Active Threshold C; default value is 1Eh. + +-d <NUM>:: +--active_threshold_d=<NUM>:: + The value that loads into the Active Threshold D; default value is 2Eh. + +-f <NUM>:: +--active_latency_config=<NUM>:: + The value that loads into the Active Latency Configuration. This + configures how both the Active Latency Stamp, and the Active Measured + Latency Fields are updated on a per I/O command (Read, Write, Deallocate) + counter basis; default value is 0FFFh. + +-w <NUM>:: +--active_latency_minimum_window=<NUM>:: + The value that loads into the Active Latency Minimum Window; default value is 0Ah. + +-r <NUM>:: +--debug_log_trigger_enable=<NUM>:: + The value that loads into the Debug Log Trigger Enable; When set to 1b + the first time the bucket/counter combination is incremented a debug log + is triggered. When cleared to 0b a debug log will not be triggered when + the bucket/counter combination is incremented. + +-l <NUM>:: +--discard_debug_log=<NUM>:: + Discard Debug Log. When cleared to 00h the debug log, if it exists, will + not be cleared. When set to 01h the debug log will be discarded so + another log can be triggered. All the fields in the Set Features Data + structure are valid. When set to 02h the debug log will be discarded so + another log can be triggered. None of the other fields of the Set + Features Data structure are valid. + +-e <NUM>:: +--latency_monitor_feature_enable=<NUM>:: + Latency Monitor Feature Enable; When set to 01h the Latency Monitor + Feature is enabled. When cleared to 00h the Latency Monitor Feature is + disabled. + +EXAMPLES +-------- +* Set NVMe WDC latency monitor feature options enabled with default value values: ++ +------------ +# nvme wdc set-latency-monitor-feature /dev/nvme0 -e 1 +------------ +* Set NVMe WDC latency monitor feature options disabled with default value values: ++ +------------ +# nvme wdc set-latency-monitor-feature /dev/nvme0 -e 0 +------------ +* Set NVMe WDC latency monitor feature options enabled with specific values: ++ +------------ +# nvme wdc set-latency-monitor-feature /dev/nvme0 --active_bucket_timer_threshold=1 \ + --active_threshold_a=0x0 \ + --active_threshold_b=0x1 \ + --active_threshold_c=0x2 \ + --active_threshold_d=0x3 \ + --active_latency_config=0xfff \ + --active_latency_minimum_window=0 \ + --debug_log_trigger_enable=0 \ + --discard_debug_log=0 \ + --latency_monitor_feature_enable=0x1 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-wdc-vs-cloud-log.1 b/Documentation/nvme-wdc-vs-cloud-log.1 index df71f00..c12f92e 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 337ea65..55b5ac4 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -828,7 +828,7 @@ Has the program issue WDC vs-cloud-log Vendor Unique Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-cloud-log.txt b/Documentation/nvme-wdc-vs-cloud-log.txt index 9eeee42..9739295 100644 --- a/Documentation/nvme-wdc-vs-cloud-log.txt +++ b/Documentation/nvme-wdc-vs-cloud-log.txt @@ -26,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-vs-device-waf.1 b/Documentation/nvme-wdc-vs-device-waf.1 index 4e898a2..6e9e184 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 d62dd6c..00689b9 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -828,7 +828,7 @@ Has the program issue WDC vs-device-waf plugin Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-device-waf.txt b/Documentation/nvme-wdc-vs-device-waf.txt index 55095a4..f25618d 100644 --- a/Documentation/nvme-wdc-vs-device-waf.txt +++ b/Documentation/nvme-wdc-vs-device-waf.txt @@ -27,8 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-vs-drive-info.1 b/Documentation/nvme-wdc-vs-drive-info.1 index 08ae9c7..3c53fd6 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 fe6b5d8..e8f8412 100644 --- a/Documentation/nvme-wdc-vs-drive-info.html +++ b/Documentation/nvme-wdc-vs-drive-info.html @@ -795,7 +795,7 @@ on the drive:</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-drive-info.txt b/Documentation/nvme-wdc-vs-drive-info.txt index 0cfdd7a..bc18b17 100644 --- a/Documentation/nvme-wdc-vs-drive-info.txt +++ b/Documentation/nvme-wdc-vs-drive-info.txt @@ -38,12 +38,10 @@ HyperScale Boot Version TCG Device Ownership - EXAMPLE -------- # nvme wdc vs-drive-info /dev/nvme0 - NVME ---- Part of the nvme-user suite. diff --git a/Documentation/nvme-wdc-vs-error-reason-identifier.1 b/Documentation/nvme-wdc-vs-error-reason-identifier.1 index 33ed0ae..785fe76 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 d107c8a..8f13214 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 <h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-error-reason-identifier.txt b/Documentation/nvme-wdc-vs-error-reason-identifier.txt index 054d675..0c7f397 100644 --- a/Documentation/nvme-wdc-vs-error-reason-identifier.txt +++ b/Documentation/nvme-wdc-vs-error-reason-identifier.txt @@ -13,8 +13,8 @@ SYNOPSIS 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 -error reason id for that log page id. +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). @@ -27,7 +27,7 @@ OPTIONS ------- -i <id>:: --log-id=<id>:: - Specifies the telemetry log id of the error reason identifier to retrieve. + Specifies the telemetry log id of the error reason identifier to retrieve. Use id 7 for the host generated log page. Use id 8 for the controller initiated log page. The default is 7/host generated diff --git a/Documentation/nvme-wdc-vs-fw-activate-history.1 b/Documentation/nvme-wdc-vs-fw-activate-history.1 index 305f5ba..28a1952 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 53d3478..f1842a8 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -805,7 +805,7 @@ cellspacing="0" cellpadding="4"> <tbody>
<tr>
<td align="left" valign="top"><p class="table"><strong>Entry Number</strong></p></td>
-<td align="left" valign="top"><p class="table">The number of fw activate entry. The most recent 20 entries will be displayed.</p></td>
+<td align="left" valign="top"><p class="table">The number of fw activate entry. The most recent 20 entries will be displayed.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>Power on Hour</strong></p></td>
@@ -833,7 +833,7 @@ cellspacing="0" cellpadding="4"> </tr>
<tr>
<td align="left" valign="top"><p class="table"><strong>Result</strong></p></td>
-<td align="left" valign="top"><p class="table">The result of the firmware activation event. The output shall be in the format:
+<td align="left" valign="top"><p class="table">The result of the firmware activation event. The output shall be in the format:
Pass or Failed + error code</p></td>
</tr>
</tbody>
@@ -868,7 +868,7 @@ Has the program issue WDC vs-fw-activate-history Vendor Unique Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-fw-activate-history.txt b/Documentation/nvme-wdc-vs-fw-activate-history.txt index 30c6ede..923ff0a 100644 --- a/Documentation/nvme-wdc-vs-fw-activate-history.txt +++ b/Documentation/nvme-wdc-vs-fw-activate-history.txt @@ -24,13 +24,12 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. - Firmware Activate History Log Page Data Output Explanation ----------------------------------------------------------- [cols="2*", frame="topbot", align="center", options="header"] @@ -38,7 +37,7 @@ Firmware Activate History Log Page Data Output Explanation |Field |Description |*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* |The time since the power on in hours:minutes:seconds. @@ -59,7 +58,7 @@ Firmware Activate History Log Page Data Output Explanation |The commit action type associated with the firmware activation event |*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 |=== diff --git a/Documentation/nvme-wdc-vs-hw-rev-log.1 b/Documentation/nvme-wdc-vs-hw-rev-log.1 index 1ea7cbd..0b9bab0 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 06dcc28..3fd4b56 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -827,7 +827,7 @@ Has the program issue WDC vs-hw-rev-log plugin Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-hw-rev-log.txt b/Documentation/nvme-wdc-vs-hw-rev-log.txt index c5335d9..b4eb4dd 100644 --- a/Documentation/nvme-wdc-vs-hw-rev-log.txt +++ b/Documentation/nvme-wdc-vs-hw-rev-log.txt @@ -25,8 +25,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-vs-internal-log.1 b/Documentation/nvme-wdc-vs-internal-log.1 index 138064d..45e8466 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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] +\fInvme wdc vs\-internal\-log\fR <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] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-wdc-vs-internal-log.html b/Documentation/nvme-wdc-vs-internal-log.html index 2c9a34a..b8bc8fd 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc vs-internal-log</em> <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]</pre>
+<pre class="content"><em>nvme wdc vs-internal-log</em> <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]</pre>
<div class="attribution">
</div></div>
</div>
@@ -759,8 +762,8 @@ nvme-wdc-vs-internal-log(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Internal Log request and saves
-the result to a file.</p></div>
+<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Internal Log request
+and saves the result to a file.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
Results for any other device are undefined.</p></div>
@@ -778,7 +781,8 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- Output file; defaults to device serial number followed by "<em>internal_fw_log</em><date>_<time>.bin" suffix
+ Output file; defaults to device serial number followed by
+ "<em>internal_fw_log</em><date>_<time>.bin" suffix
</p>
</dd>
<dt class="hdlist1">
@@ -789,7 +793,7 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- Transfer size; defaults to 0x10000 (65536 decimal) bytes
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes
</p>
</dd>
<dt class="hdlist1">
@@ -800,8 +804,9 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -812,9 +817,10 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -825,9 +831,10 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -838,10 +845,11 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -950,7 +958,7 @@ Gets the controller telemetry log page to data area 3 from the device and stores <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-internal-log.txt b/Documentation/nvme-wdc-vs-internal-log.txt index 4fbde38..08f585b 100644 --- a/Documentation/nvme-wdc-vs-internal-log.txt +++ b/Documentation/nvme-wdc-vs-internal-log.txt @@ -8,15 +8,18 @@ nvme-wdc-vs-internal-log - Retrieve WDC device's internal firmware log and save SYNOPSIS -------- [verse] -'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] 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). @@ -27,35 +30,40 @@ OPTIONS ------- -o <FILE>:: --output-file=<FILE>:: - 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 -s <SIZE>:: --transfer-size=<SIZE>:: - Transfer size; defaults to 0x10000 (65536 decimal) bytes + Transfer size; defaults to 0x10000 (65536 decimal) bytes -d <DATA AREA>:: --data-area=<DATA AREA>:: - 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. -f <FILE SIZE>:: --file-size=<FILE SIZE>:: - 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. -e <OFFSET>:: --offset=<OFFSET>:: - 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. -t <TYPE>:: --type=<TYPE>:: - 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. -v <VERBOSE>:: --verbose=<VERBOSE>:: diff --git a/Documentation/nvme-wdc-vs-nand-stats.1 b/Documentation/nvme-wdc-vs-nand-stats.1 index a16f9a2..fa00962 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 1ea9f8f..0f7625d 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.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -814,7 +814,7 @@ Has the program issue WDC vs-nand-stats Vendor Unique Command : <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-nand-stats.txt b/Documentation/nvme-wdc-vs-nand-stats.txt index cc1f422..1b16daa 100644 --- a/Documentation/nvme-wdc-vs-nand-stats.txt +++ b/Documentation/nvme-wdc-vs-nand-stats.txt @@ -26,8 +26,8 @@ On success it returns the NAND statistics, error code otherwise. OPTIONS ------- --o <format>:: ---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. Default is normal. diff --git a/Documentation/nvme-wdc-vs-smart-add-log.1 b/Documentation/nvme-wdc-vs-smart-add-log.1 index e955162..7fe4900 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 6abbe25..00d6ce7 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.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -807,8 +808,8 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -819,10 +820,10 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
<dt class="hdlist1">
@@ -927,7 +928,7 @@ Has the program issue WDC vs-smart-add-log Vendor Unique Command for 0xC0 and 0x <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-smart-add-log.txt b/Documentation/nvme-wdc-vs-smart-add-log.txt index 7de1ac8..925287f 100644 --- a/Documentation/nvme-wdc-vs-smart-add-log.txt +++ b/Documentation/nvme-wdc-vs-smart-add-log.txt @@ -3,7 +3,8 @@ nvme-wdc-vs-smart-add-log(1) NAME ---- -nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command, return result +nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command, +return result SYNOPSIS -------- @@ -31,26 +32,27 @@ OPTIONS ------- -i <NUM>:: --interval=<NUM>:: - 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>:: ---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. Default is normal. -l <NUM>:: --log-page-version=<NUM>:: - 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. -p <LIST>:: --log-page-mask=<LIST>:: - 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. -n <nsid>:: --namespace-id=<nsid>:: @@ -82,7 +84,6 @@ accumulated statistics. |The statistical set accumulated during the entire lifetime of the device. |=== - EXAMPLES -------- * Has the program issue WDC vs-smart-add-log Vendor Unique Command with default interval (14) : diff --git a/Documentation/nvme-wdc-vs-telemetry-controller-option.1 b/Documentation/nvme-wdc-vs-telemetry-controller-option.1 index e5f4dcc..5176f93 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-disable, \-d] [\-\-enable, \-e] - [\-\-status, \-s] +\fInvme wdc vs\-telemetry\-controller\-option\fR <device> + [\-\-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 <device> 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 8599741..4b8b0c8 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme wdc vs-telemetry-controller-option</em> <device> [--disable, -d] [--enable, -e]
- [--status, -s]</pre>
+<pre class="content"><em>nvme wdc vs-telemetry-controller-option</em> <device>
+ [--disable, -d] [--enable, -e] [--status, -s]</pre>
<div class="attribution">
</div></div>
</div>
@@ -758,8 +758,9 @@ nvme-wdc-vs-telemetry-controller-option(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.
Results for any other device are undefined.</p></div>
@@ -799,7 +800,8 @@ Results for any other device are undefined.</p></div> </dt>
<dd>
<p>
- 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.
</p>
</dd>
</dl></div>
@@ -853,7 +855,7 @@ Gets the current status (enabled or disabled) of the controller initiated option <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-wdc-vs-telemetry-controller-option.txt b/Documentation/nvme-wdc-vs-telemetry-controller-option.txt index 8c1a7e7..2353e7c 100644 --- a/Documentation/nvme-wdc-vs-telemetry-controller-option.txt +++ b/Documentation/nvme-wdc-vs-telemetry-controller-option.txt @@ -3,19 +3,21 @@ nvme-wdc-vs-telemetry-controller-option(1) NAME ---- -nvme-wdc-vs-telemetry-controller-option - Disable/Enable the controller initiated option of the telemetry log page. +nvme-wdc-vs-telemetry-controller-option - Disable/Enable the controller +initiated option of the telemetry log page. SYNOPSIS -------- [verse] -'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] 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). @@ -34,8 +36,8 @@ OPTIONS -s:: --status:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-wdc-vs-temperature-stats.1 b/Documentation/nvme-wdc-vs-temperature-stats.1 index 4a3ffc3..b5c2370 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 6ba4aa1..f76c0e3 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-write-uncor.1 b/Documentation/nvme-write-uncor.1 index b7e0efe..148e7c8 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-UNCOR" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-UNCOR" "1" "12/21/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=<nsid> | \-n <nsid>] [\-\-dir\-type=<dtype> | \-T <dtype>] [\-\-dir\-spec=<dspec> | \-S <dspec>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Write Uncorrectable command is used to invalidate a range of logical blocks\&. .SH "OPTIONS" .PP -\-\-start\-block=<slba>, \-s <slba> +\-s <slba>, \-\-start\-block=<slba> .RS 4 Start block\&. .RE .PP -\-\-block\-count=<nlb>, \-c +\-c, \-\-block\-count=<nlb> .RS 4 Number of logical blocks to write uncorrectable\&. .RE .PP -\-\-namespace\-id=<nsid>, \-n <nsid> +\-n <nsid>, \-\-namespace\-id=<nsid> .RS 4 Namespace ID use in the command\&. .RE @@ -67,6 +68,20 @@ Directive type .RS 4 Directive specific .RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.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 4c69628..6f9c038 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>]</pre>
+ [--dir-spec=<dspec> | -S <dspec>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -770,10 +771,10 @@ blocks.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---start-block=<slba>
+-s <slba>
</dt>
<dt class="hdlist1">
--s <slba>
+--start-block=<slba>
</dt>
<dd>
<p>
@@ -781,10 +782,10 @@ blocks.</p></div> </p>
</dd>
<dt class="hdlist1">
---block-count=<nlb>
+-c
</dt>
<dt class="hdlist1">
--c
+--block-count=<nlb>
</dt>
<dd>
<p>
@@ -792,10 +793,10 @@ blocks.</p></div> </p>
</dd>
<dt class="hdlist1">
---namespace-id=<nsid>
+-n <nsid>
</dt>
<dt class="hdlist1">
--n <nsid>
+--namespace-id=<nsid>
</dt>
<dd>
<p>
@@ -824,6 +825,29 @@ blocks.</p></div> Directive specific
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -844,7 +868,7 @@ blocks.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-write-uncor.txt b/Documentation/nvme-write-uncor.txt index 19415c2..6e49c61 100644 --- a/Documentation/nvme-write-uncor.txt +++ b/Documentation/nvme-write-uncor.txt @@ -13,6 +13,7 @@ SYNOPSIS [--namespace-id=<nsid> | -n <nsid>] [--dir-type=<dtype> | -T <dtype>] [--dir-spec=<dspec> | -S <dspec>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -21,16 +22,16 @@ blocks. OPTIONS ------- ---start-block=<slba>:: -s <slba>:: +--start-block=<slba>:: Start block. ---block-count=<nlb>:: -c:: +--block-count=<nlb>:: Number of logical blocks to write uncorrectable. ---namespace-id=<nsid>:: -n <nsid>:: +--namespace-id=<nsid>:: Namespace ID use in the command. -T <dtype>:: @@ -41,6 +42,15 @@ OPTIONS --dir-spec=<dspec>:: 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-write-zeroes.1 b/Documentation/nvme-write-zeroes.1 index 0ec2964..6c8f5c4 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<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>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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=<slba>, \-s <slba> +\-s <slba>, \-\-start\-block=<slba> .RS 4 Start block\&. .RE .PP -\-\-block\-count=<nlb>, \-c <nlb> +\-c <nlb>, \-\-block\-count=<nlb> .RS 4 Number of logical blocks to write zeroes\&. .RE .PP -\-\-prinfo=<prinfo>, \-p <prinfo> +\-p <prinfo>, \-\-prinfo=<prinfo> .RS 4 Protection Information field definition\&. .TS @@ -107,47 +106,47 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=<reftag>, \-r <reftag> +\-r <reftag>, \-\-ref\-tag=<reftag> .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=<appmask>, \-m <appmask> +\-m <appmask>, \-\-app\-tag\-mask=<appmask> .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=<apptag>, \-a <apptag> +\-a <apptag>, \-\-app\-tag=<apptag> .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=<nsid>, \-n <nsid> +\-n <nsid>, \-\-namespace\-id=<nsid> .RS 4 Namespace ID use in the command\&. .RE .PP -\-\-storage\-tag=<storage\-tag>, \-S <storage\-tag> +\-S <storage\-tag>, \-\-storage\-tag=<storage\-tag> .RS 4 Variable Sized Logical Block Storage Tag(LBST)\&. .RE .PP -\-\-storage\-tag\-check=<storage\-tag\-check>, \-C <storage\-tag\-check> +\-C <storage\-tag\-check>, \-\-storage\-tag\-check=<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 <fmt>, \-\-output\-format=<fmt> +.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 a596cd5..ac0cf70 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>]</pre>
+ [--dir-spec=<dspec> | -D <dspec>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -778,10 +777,10 @@ nvme-write-zeroes(1) Manual Page <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---start-block=<slba>
+-s <slba>
</dt>
<dt class="hdlist1">
--s <slba>
+--start-block=<slba>
</dt>
<dd>
<p>
@@ -789,10 +788,10 @@ nvme-write-zeroes(1) Manual Page </p>
</dd>
<dt class="hdlist1">
---block-count=<nlb>
+-c <nlb>
</dt>
<dt class="hdlist1">
--c <nlb>
+--block-count=<nlb>
</dt>
<dd>
<p>
@@ -800,10 +799,10 @@ nvme-write-zeroes(1) Manual Page </p>
</dd>
<dt class="hdlist1">
---prinfo=<prinfo>
+-p <prinfo>
</dt>
<dt class="hdlist1">
--p <prinfo>
+--prinfo=<prinfo>
</dt>
<dd>
<p>
@@ -848,10 +847,10 @@ metadata is passes.</p></td> </div>
</dd>
<dt class="hdlist1">
---ref-tag=<reftag>
+-r <reftag>
</dt>
<dt class="hdlist1">
--r <reftag>
+--ref-tag=<reftag>
</dt>
<dd>
<p>
@@ -859,10 +858,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag-mask=<appmask>
+-m <appmask>
</dt>
<dt class="hdlist1">
--m <appmask>
+--app-tag-mask=<appmask>
</dt>
<dd>
<p>
@@ -870,10 +869,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag=<apptag>
+-a <apptag>
</dt>
<dt class="hdlist1">
--a <apptag>
+--app-tag=<apptag>
</dt>
<dd>
<p>
@@ -881,10 +880,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---limited-retry
+-l
</dt>
<dt class="hdlist1">
--l
+--limited-retry
</dt>
<dd>
<p>
@@ -892,10 +891,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---deac
+-d
</dt>
<dt class="hdlist1">
--d
+--deac
</dt>
<dd>
<p>
@@ -903,10 +902,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---force-unit-access
+-f
</dt>
<dt class="hdlist1">
--f
+--force-unit-access
</dt>
<dd>
<p>
@@ -914,10 +913,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---namespace-id=<nsid>
+-n <nsid>
</dt>
<dt class="hdlist1">
--n <nsid>
+--namespace-id=<nsid>
</dt>
<dd>
<p>
@@ -925,10 +924,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---storage-tag=<storage-tag>
+-S <storage-tag>
</dt>
<dt class="hdlist1">
--S <storage-tag>
+--storage-tag=<storage-tag>
</dt>
<dd>
<p>
@@ -936,10 +935,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---storage-tag-check=<storage-tag-check>
+-C <storage-tag-check>
</dt>
<dt class="hdlist1">
--C <storage-tag-check>
+--storage-tag-check=<storage-tag-check>
</dt>
<dd>
<p>
@@ -969,6 +968,29 @@ metadata is passes.</p></td> Directive specific
</p>
</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -989,7 +1011,7 @@ metadata is passes.</p></td> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-write-zeroes.txt b/Documentation/nvme-write-zeroes.txt index 7e936e5..0daf320 100644 --- a/Documentation/nvme-write-zeroes.txt +++ b/Documentation/nvme-write-zeroes.txt @@ -13,15 +13,14 @@ SYNOPSIS [--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>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] DESCRIPTION ----------- @@ -29,16 +28,16 @@ The Write Zeroes command is used to set a range of logical blocks to 0. OPTIONS ------- ---start-block=<slba>:: -s <slba>:: +--start-block=<slba>:: Start block. ---block-count=<nlb>:: -c <nlb>:: +--block-count=<nlb>:: Number of logical blocks to write zeroes. ---prinfo=<prinfo>:: -p <prinfo>:: +--prinfo=<prinfo>:: Protection Information field definition. + [] @@ -53,40 +52,40 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=<reftag>:: -r <reftag>:: +--ref-tag=<reftag>:: Optional reftag when used with protection information. ---app-tag-mask=<appmask>:: -m <appmask>:: +--app-tag-mask=<appmask>:: Optional application tag mask when used with protection information. ---app-tag=<apptag>:: -a <apptag>:: +--app-tag=<apptag>:: Optional application tag when used with protection information. ---limited-retry:: -l:: +--limited-retry:: Sets the limited retry flag. ---deac:: -d:: +--deac:: Sets the DEAC bit, requesting controller deallocate the logical blocks. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. ---namespace-id=<nsid>:: -n <nsid>:: +--namespace-id=<nsid>:: Namespace ID use in the command. ---storage-tag=<storage-tag>:: -S <storage-tag>:: +--storage-tag=<storage-tag>:: Variable Sized Logical Block Storage Tag(LBST). ---storage-tag-check=<storage-tag-check>:: -C <storage-tag-check>:: +--storage-tag-check=<storage-tag-check>:: This bit specifies the Storage Tag field shall be checked as part of end-to-end data protection processing. @@ -98,6 +97,15 @@ metadata is passes. --dir-spec=<dspec>:: 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. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1 index 867524e..66b6994 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,54 +42,50 @@ nvme-write \- Send an NVMe write command, provide results [\-\-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] .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=<slba>, \-s <slba> +\-s <slba>, \-\-start\-block=<slba> .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=<size>, \-z <size> +\-z <size>, \-\-data\-size=<size> .RS 4 Size of data, in bytes\&. .RE .PP -\-\-metadata\-size=<size>, \-y <size> +\-y <size>, \-\-metadata\-size=<size> .RS 4 Size of metadata in bytes\&. .RE .PP -\-\-data=<data\-file>, \-d <data\-file> +\-d <data\-file>, \-\-data=<data\-file> .RS 4 Data file\&. If none provided, contents are sent from STDIN\&. .RE .PP -\-\-metadata=<metadata\-file>, \-M <metadata\-file> +\-M <metadata\-file>, \-\-metadata=<metadata\-file> .RS 4 Metadata file, if necessary\&. .RE .PP -\-\-prinfo=<prinfo>, \-p <prinfo> +\-p <prinfo>, \-\-prinfo=<prinfo> .RS 4 Protection Information field definition\&. .TS @@ -134,27 +130,27 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=<reftag>, \-r <reftag> +\-r <reftag>, \-\-ref\-tag=<reftag> .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=<appmask>, \-m <appmask> +\-m <appmask>, \-\-app\-tag\-mask=<appmask> .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-app\-tag=<apptag>, \-a <apptag> +\-a <apptag>, \-\-app\-tag=<apptag> .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 <fmt>, \-\-output\-format=<fmt> +.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 c268201..9fe4df9 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]</pre>
+ [--storage-tag-check | -C] [--force]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -787,10 +783,10 @@ if you don’t provide a file.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---start-block=<slba>
+-s <slba>
</dt>
<dt class="hdlist1">
--s <slba>
+--start-block=<slba>
</dt>
<dd>
<p>
@@ -798,10 +794,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---block-count
+-c
</dt>
<dt class="hdlist1">
--c
+--block-count
</dt>
<dd>
<p>
@@ -811,10 +807,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---data-size=<size>
+-z <size>
</dt>
<dt class="hdlist1">
--z <size>
+--data-size=<size>
</dt>
<dd>
<p>
@@ -822,10 +818,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---metadata-size=<size>
+-y <size>
</dt>
<dt class="hdlist1">
--y <size>
+--metadata-size=<size>
</dt>
<dd>
<p>
@@ -833,10 +829,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---data=<data-file>
+-d <data-file>
</dt>
<dt class="hdlist1">
--d <data-file>
+--data=<data-file>
</dt>
<dd>
<p>
@@ -844,10 +840,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---metadata=<metadata-file>
+-M <metadata-file>
</dt>
<dt class="hdlist1">
--M <metadata-file>
+--metadata=<metadata-file>
</dt>
<dd>
<p>
@@ -855,10 +851,10 @@ if you don’t provide a file.</p></div> </p>
</dd>
<dt class="hdlist1">
---prinfo=<prinfo>
+-p <prinfo>
</dt>
<dt class="hdlist1">
--p <prinfo>
+--prinfo=<prinfo>
</dt>
<dd>
<p>
@@ -903,10 +899,10 @@ metadata is passes.</p></td> </div>
</dd>
<dt class="hdlist1">
---ref-tag=<reftag>
+-r <reftag>
</dt>
<dt class="hdlist1">
--r <reftag>
+--ref-tag=<reftag>
</dt>
<dd>
<p>
@@ -914,10 +910,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag-mask=<appmask>
+-m <appmask>
</dt>
<dt class="hdlist1">
--m <appmask>
+--app-tag-mask=<appmask>
</dt>
<dd>
<p>
@@ -925,10 +921,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---app-tag=<apptag>
+-a <apptag>
</dt>
<dt class="hdlist1">
--a <apptag>
+--app-tag=<apptag>
</dt>
<dd>
<p>
@@ -936,10 +932,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---limited-retry
+-l
</dt>
<dt class="hdlist1">
--l
+--limited-retry
</dt>
<dd>
<p>
@@ -947,10 +943,10 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
---force-unit-access
+-f
</dt>
<dt class="hdlist1">
--f
+--force-unit-access
</dt>
<dd>
<p>
@@ -1004,7 +1000,7 @@ metadata is passes.</p></td> </p>
</dd>
<dt class="hdlist1">
--v
+-V
</dt>
<dt class="hdlist1">
--show-cmd
@@ -1066,8 +1062,31 @@ metadata is passes.</p></td> </dt>
<dd>
<p>
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+</p>
+</dd>
+<dt class="hdlist1">
+-o <fmt>
+</dt>
+<dt class="hdlist1">
+--output-format=<fmt>
+</dt>
+<dd>
+<p>
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+ output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+ Increase the information detail in the output.
</p>
</dd>
</dl></div>
@@ -1090,7 +1109,7 @@ metadata is passes.</p></td> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-write.txt b/Documentation/nvme-write.txt index 76cbd7a..af5340e 100644 --- a/Documentation/nvme-write.txt +++ b/Documentation/nvme-write.txt @@ -18,17 +18,13 @@ SYNOPSIS [--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] DESCRIPTION ----------- @@ -38,34 +34,34 @@ if you don't provide a file. OPTIONS ------- ---start-block=<slba>:: -s <slba>:: +--start-block=<slba>:: Start block. ---block-count:: -c:: +--block-count:: The number of blocks to transfer. This is a zeroes based value to align with the kernel's use of this field. (ie. 0 means transfer 1 block). ---data-size=<size>:: -z <size>:: +--data-size=<size>:: Size of data, in bytes. ---metadata-size=<size>:: -y <size>:: +--metadata-size=<size>:: Size of metadata in bytes. ---data=<data-file>:: -d <data-file>:: +--data=<data-file>:: Data file. If none provided, contents are sent from STDIN. ---metadata=<metadata-file>:: -M <metadata-file>:: +--metadata=<metadata-file>:: Metadata file, if necessary. ---prinfo=<prinfo>:: -p <prinfo>:: +--prinfo=<prinfo>:: Protection Information field definition. + [] @@ -80,24 +76,24 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=<reftag>:: -r <reftag>:: +--ref-tag=<reftag>:: Optional reftag when used with protection information. ---app-tag-mask=<appmask>:: -m <appmask>:: +--app-tag-mask=<appmask>:: Optional application tag mask when used with protection information. ---app-tag=<apptag>:: -a <apptag>:: +--app-tag=<apptag>:: Optional application tag when used with protection information. ---limited-retry:: -l:: +--limited-retry:: Sets the limited retry flag. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. -T <type>:: @@ -125,7 +121,7 @@ metadata is passes. consult the NVMe specification for detailed breakdown of how to use this field. --v:: +-V:: --show-cmd:: Print out the command to be sent. @@ -149,8 +145,17 @@ metadata is passes. data protection processing. --force:: - 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. EXAMPLES -------- diff --git a/Documentation/nvme-zns-changed-zone-list.1 b/Documentation/nvme-zns-changed-zone-list.1 index 1aaec89..183c4d5 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] - [\-\-namespace\-id=<NUM> | \-n <NUM>] - [\-\-rae | \-r] +\fInvme zns changed\-zone\-list\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] + [\-\-namespace\-id=<NUM> | \-n <NUM>] [\-\-rae | \-r] .fi .SH "DESCRIPTION" .sp @@ -45,7 +44,7 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 a2a48c4..d97df21 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 <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme zns changed-zone-list</em> <device> [-o <fmt> | --output-format=<fmt>]
- [--namespace-id=<NUM> | -n <NUM>]
- [--rae | -r]</pre>
+<pre class="content"><em>nvme zns changed-zone-list</em> <device> [--output-format=<fmt> | -o <fmt>]
+ [--namespace-id=<NUM> | -n <NUM>] [--rae | -r]</pre>
<div class="attribution">
</div></div>
</div>
@@ -772,15 +771,15 @@ ways.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
@@ -833,7 +832,7 @@ Show the output in json format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-changed-zone-list.txt b/Documentation/nvme-zns-changed-zone-list.txt index 9626c05..ad447ce 100644 --- a/Documentation/nvme-zns-changed-zone-list.txt +++ b/Documentation/nvme-zns-changed-zone-list.txt @@ -8,9 +8,8 @@ nvme-zns-changed-zone-list - Retrieve Changed Zone log for the given device SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -25,10 +24,10 @@ ways. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. -r:: --rae:: diff --git a/Documentation/nvme-zns-close-zone.1 b/Documentation/nvme-zns-close-zone.1 index 9b939d9..cba967f 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 8212189..503e3b7 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-finish-zone.1 b/Documentation/nvme-zns-finish-zone.1 index 82e631f..dafb761 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 fe8fbfc..c0a1fac 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-id-ctrl.1 b/Documentation/nvme-zns-id-ctrl.1 index 6c230e2..1495993 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-o <fmt> | \-\-output\-format=<fmt>] +\fInvme zns id\-ctrl\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" .sp @@ -43,7 +43,7 @@ The <device> 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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 7279c65..0e06efe 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -749,7 +749,7 @@ nvme-zns-id-ctrl(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme zns id-ctrl</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>
+<pre class="content"><em>nvme zns id-ctrl</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -770,15 +770,15 @@ displayed in one of several ways.</p></div> <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -821,7 +821,7 @@ Show the output in json format <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-id-ctrl.txt b/Documentation/nvme-zns-id-ctrl.txt index e7bd5ba..0057159 100644 --- a/Documentation/nvme-zns-id-ctrl.txt +++ b/Documentation/nvme-zns-id-ctrl.txt @@ -4,12 +4,12 @@ nvme-zns-id-ctrl(1) NAME ---- nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return - result and structure +result and structure SYNOPSIS -------- [verse] -'nvme zns id-ctrl' <device> [-o <fmt> | --output-format=<fmt>] +'nvme zns id-ctrl' <device> [--output-format=<fmt> | -o <fmt>] DESCRIPTION ----------- @@ -24,10 +24,10 @@ displayed in one of several ways. OPTIONS ------- --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-zns-id-ns.1 b/Documentation/nvme-zns-id-ns.1 index d7829bb..89f44e8 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] - [\-o <fmt> | \-\-output\-format=<fmt>] - [\-v | \-\-verbose] +\fInvme zns id\-ns\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 7f56f7e..38d6f8c 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 <h2>NAME</h2>
<div class="sectionbody">
<p>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
</p>
</div>
</div>
@@ -749,9 +749,8 @@ nvme-zns-id-ns(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme zns id-ns</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [-o <fmt> | --output-format=<fmt>]
- [-v | --verbose]</pre>
+<pre class="content"><em>nvme zns id-ns</em> <device> [--namespace-id=<NUM> | -n <NUM>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>
<div class="attribution">
</div></div>
</div>
@@ -796,15 +795,15 @@ displayed in one of several ways.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -847,7 +846,7 @@ Show the output in json format with extra details <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-id-ns.txt b/Documentation/nvme-zns-id-ns.txt index 799e3b6..c22b5c7 100644 --- a/Documentation/nvme-zns-id-ns.txt +++ b/Documentation/nvme-zns-id-ns.txt @@ -3,15 +3,14 @@ nvme-zns-id-ns(1) NAME ---- -nvme-zns-id-ns - Send NVMe Zoned Command Set Identify namespace, return - result and structure +nvme-zns-id-ns - Send NVMe Zoned Command Set Identify namespace, return result +and structure SYNOPSIS -------- [verse] -'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] DESCRIPTION ----------- @@ -36,10 +35,10 @@ OPTIONS --verbose:: Increase the information detail in the output. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-zns-offline-zone.1 b/Documentation/nvme-zns-offline-zone.1 index 116817d..18a7638 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 9d12c96..c459366 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: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-open-zone.1 b/Documentation/nvme-zns-open-zone.1 index 40b0ec9..2f84543 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-zns-open-zone.html b/Documentation/nvme-zns-open-zone.html index fda136e..0a18862 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme zns open-zone</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--start-lba=<LBA> | -s <LBA>]
- [--zrwaa | -r]
- [--select-all | -a]
- [--timeout=<timeout> | -t <timeout>]</pre>
+ [--start-lba=<LBA> | -s <LBA>] [--zrwaa | -r]
+ [--select-all | -a] [--timeout=<timeout> | -t <timeout>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -858,7 +856,7 @@ Open the first zone on namespace 1: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-open-zone.txt b/Documentation/nvme-zns-open-zone.txt index 0f2cb35..4639bcc 100644 --- a/Documentation/nvme-zns-open-zone.txt +++ b/Documentation/nvme-zns-open-zone.txt @@ -9,10 +9,8 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- diff --git a/Documentation/nvme-zns-report-zones.1 b/Documentation/nvme-zns-report-zones.1 index dea48f4..ba89e50 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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=<FMT> | \-o <FMT>] + [\-\-output\-format=<fmt> | \-o <fmt>] .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 <format>, \-\-output\-format=<format> +\-o <fmt>, \-\-output\-format=<fmt> .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 79fdb2a..582b8dd 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>]</pre>
+ [--output-format=<fmt> | -o <fmt>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -906,15 +906,15 @@ cellspacing="0" cellpadding="4"> </p>
</dd>
<dt class="hdlist1">
--o <format>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<format>
+--output-format=<fmt>
</dt>
<dd>
<p>
- Set the reporting format to <em>normal</em>, <em>json</em>, or
- <em>binary</em>. Only one output format can be used at a time.
+ Set the reporting format to <em>normal</em>, <em>json</em>, or
+ <em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
</dl></div>
@@ -957,7 +957,7 @@ Show the output in json format with extra details <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-report-zones.txt b/Documentation/nvme-zns-report-zones.txt index 35d5eda..23dd6b4 100644 --- a/Documentation/nvme-zns-report-zones.txt +++ b/Documentation/nvme-zns-report-zones.txt @@ -15,7 +15,7 @@ SYNOPSIS [--extended | -e] [--partial | -p] [--verbose | -v] - [--output-format=<FMT> | -o <FMT>] + [--output-format=<fmt> | -o <fmt>] DESCRIPTION ----------- @@ -76,10 +76,10 @@ OPTIONS --verbose:: Increase the information detail in the output. --o <format>:: ---output-format=<format>:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-zns-reset-zone.1 b/Documentation/nvme-zns-reset-zone.1 index a834aee..a1cd0b4 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-zns-reset-zone.html b/Documentation/nvme-zns-reset-zone.html index 2b3d58c..ec4b484 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme zns reset-zone</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--start-lba=<LBA> | -s <LBA>]
- [--select-all | -a]
- [--timeout=<timeout> | -t <timeout>]</pre>
+ [--start-lba=<LBA> | -s <LBA>]
+ [--select-all | -a]
+ [--timeout=<timeout> | -t <timeout>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -847,7 +847,7 @@ Reset the first zone on namespace 1: <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-reset-zone.txt b/Documentation/nvme-zns-reset-zone.txt index 25d01a1..b58f276 100644 --- a/Documentation/nvme-zns-reset-zone.txt +++ b/Documentation/nvme-zns-reset-zone.txt @@ -9,9 +9,9 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1 index 0721cb5..934b7ff 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .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 <FILE, \-data=<FILE> +\-d <FILE>, \-\-data=<FILE> .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 ddf9779..181809a 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme zns set-zone-desc</em> <device> [--namespace-id=<NUM> | -n <NUM>]
- [--start-lba=<IONUM>, -s <IONUM>]
- [--zrwaa | -r]
- [-data=<FILE>, -d <FILE>]
- [--timeout=<timeout> | -t <timeout>]</pre>
+ [--start-lba=<IONUM>, -s <IONUM>]
+ [--zrwaa | -r]
+ [--data=<FILE>, -d <FILE>]
+ [--timeout=<timeout> | -t <timeout>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -807,10 +807,10 @@ length will automatically be calculated from the zns identify namespace.</p></di </p>
</dd>
<dt class="hdlist1">
--d <FILE
+-d <FILE>
</dt>
<dt class="hdlist1">
--data=<FILE>
+--data=<FILE>
</dt>
<dd>
<p>
@@ -859,7 +859,7 @@ Write "hello world" into the zone descriptor for namespace 1’s first zone <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-set-zone-desc.txt b/Documentation/nvme-zns-set-zone-desc.txt index dd759a2..3df8c4b 100644 --- a/Documentation/nvme-zns-set-zone-desc.txt +++ b/Documentation/nvme-zns-set-zone-desc.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- @@ -37,8 +37,8 @@ OPTIONS --zrwaa:: Allocate Zone Random Write Area to zone. --d <FILE:: --data=<FILE>:: +-d <FILE>:: +--data=<FILE>:: Optional file for data (default stdin) -t <timeout>:: diff --git a/Documentation/nvme-zns-zone-append.1 b/Documentation/nvme-zns-zone-append.1 index 8f1a80f..0981fea 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 2dd499f..1661f6a 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 <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-zone-mgmt-recv.1 b/Documentation/nvme-zns-zone-mgmt-recv.1 index fcf0b65..b4682a0 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .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=<NUM> \-l <NUM> Received data buffer length +\-l <NUM> \-\-data\-len=<NUM> Received data buffer length .PP \-z <NUM>, \-\-zra=<NUM> .RS 4 @@ -69,7 +67,7 @@ Zone Receive Action Enable Zone Receive Action Specific features .RE .PP -\-o <FMT>, \-\-output\-format=<FMT> +\-o <fmt>, \-\-output\-format=<fmt> .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 cebdb7e..e0a8675 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme zns zone-mgmt-recv</em> <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>]</pre>
+ [--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>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -801,8 +799,8 @@ binary.</p></div> </p>
</dd>
</dl></div>
-<div class="paragraph"><p>--data-len=<NUM>
--l <NUM>
+<div class="paragraph"><p>-l <NUM>
+--data-len=<NUM>
Received data buffer length</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
@@ -833,10 +831,10 @@ binary.</p></div> </p>
</dd>
<dt class="hdlist1">
--o <FMT>
+-o <fmt>
</dt>
<dt class="hdlist1">
---output-format=<FMT>
+--output-format=<fmt>
</dt>
<dd>
<p>
@@ -882,7 +880,7 @@ Binary dump of a report all zones <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-zone-mgmt-recv.txt b/Documentation/nvme-zns-zone-mgmt-recv.txt index 07cd98e..5a3e2a3 100644 --- a/Documentation/nvme-zns-zone-mgmt-recv.txt +++ b/Documentation/nvme-zns-zone-mgmt-recv.txt @@ -9,12 +9,10 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- @@ -38,8 +36,8 @@ OPTIONS --start-lba=<lba>:: The starting LBA of the zone to manage receive. ---data-len=<NUM> -l <NUM> +--data-len=<NUM> Received data buffer length -z <NUM>:: @@ -54,8 +52,8 @@ OPTIONS --zra-spec-feat:: Enable Zone Receive Action Specific features --o <FMT>:: ---output-format=<FMT>:: +-o <fmt>:: +--output-format=<fmt>:: Output format: normal|json|binary EXAMPLES diff --git a/Documentation/nvme-zns-zone-mgmt-send.1 b/Documentation/nvme-zns-zone-mgmt-send.1 index d67fb06..b152f47 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/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/21/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 <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>] .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 <FILE, \-\-data=<FILE> +\-d <FILE>, \-\-data=<FILE> .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 424c2ff..9b92844 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 <div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>nvme zns zone-mgmt-send</em> <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>]</pre>
+ [--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>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -821,10 +819,10 @@ Alternatively, the data may come from a file that can be specified.</p></div> </p>
</dd>
<dt class="hdlist1">
---select-all
+-a
</dt>
<dt class="hdlist1">
--a
+--select-all
</dt>
<dd>
<p>
@@ -854,7 +852,7 @@ Alternatively, the data may come from a file that can be specified.</p></div> </p>
</dd>
<dt class="hdlist1">
--d <FILE
+-d <FILE>
</dt>
<dt class="hdlist1">
--data=<FILE>
@@ -916,7 +914,7 @@ Write "hello world" into the zone descriptor for namespace 1’s first zone <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
diff --git a/Documentation/nvme-zns-zone-mgmt-send.txt b/Documentation/nvme-zns-zone-mgmt-send.txt index 8cbb5c0..3803d27 100644 --- a/Documentation/nvme-zns-zone-mgmt-send.txt +++ b/Documentation/nvme-zns-zone-mgmt-send.txt @@ -9,13 +9,11 @@ SYNOPSIS -------- [verse] '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>] DESCRIPTION ----------- @@ -44,8 +42,8 @@ OPTIONS --zsaso:: Zone Send Action Specific Option ---select-all:: -a:: +--select-all:: Send command to all zones -z <NUM>:: @@ -56,7 +54,7 @@ OPTIONS --data-len=<IONUM>:: Buffer length if data required --d <FILE:: +-d <FILE>:: --data=<FILE>:: Optional file for data (default stdin) diff --git a/Documentation/nvme-zns-zrwa-flush-zone.txt b/Documentation/nvme-zns-zrwa-flush-zone.txt index 4f3e72c..e8f61ed 100644 --- a/Documentation/nvme-zns-zrwa-flush-zone.txt +++ b/Documentation/nvme-zns-zrwa-flush-zone.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'nvme zns zrwa-flush-zone' <device> [--namespace-id=<NUM> | -n <NUM>] - [--lba=<LBA> | -l <LBA>] - [--timeout=<timeout> | -t <timeout> ] + [--lba=<LBA> | -l <LBA>] + [--timeout=<timeout> | -t <timeout>] DESCRIPTION ----------- diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index 3e0043c..b114bf1 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 <http://docbook.sf.net/> -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme.html b/Documentation/nvme.html index 9ab55c8..eaedf0e 100644 --- a/Documentation/nvme.html +++ b/Documentation/nvme.html @@ -2114,7 +2114,7 @@ NVM-Express Site</a>.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-06-30 15:20:22 CEST
+ 2023-12-21 15:49:29 CET
</div>
</div>
</body>
|