nvme-cli: update documentations to sync up with subcommands
Subsystems (2)
PATCH 1/1 nvme-cli: update documentations to sync up with subcommands
Update all documentations to sync up with built-in plugin subcommands. Not only options supported by subcommands, But few descriptions have not been updated with implementations.
Sync-up documentation with subcommands implementations.
--- Documentation/cmds-main.txt | 6 + Documentation/nvme-admin-passthru.1 | 19 +- Documentation/nvme-admin-passthru.html | 27 +- Documentation/nvme-admin-passthru.txt | 11 +- Documentation/nvme-compare.1 | 158 ++- Documentation/nvme-compare.html | 267 ++++- Documentation/nvme-compare.txt | 108 +- Documentation/nvme-format.1 | 6 +- Documentation/nvme-format.html | 13 +- Documentation/nvme-format.txt | 2 +- Documentation/nvme-get-feature.1 | 10 +- Documentation/nvme-get-feature.html | 26 +- Documentation/nvme-get-feature.txt | 6 + Documentation/nvme-get-log.1 | 16 +- Documentation/nvme-get-log.html | 38 +- Documentation/nvme-get-log.txt | 11 + Documentation/nvme-id-ns.1 | 5 +- Documentation/nvme-id-ns.html | 12 +- Documentation/nvme-id-ns.txt | 1 + Documentation/nvme-io-passthru.1 | 14 +- Documentation/nvme-io-passthru.html | 20 +- Documentation/nvme-io-passthru.txt | 9 +- Documentation/nvme-list-ns.1 | 10 +- Documentation/nvme-list-ns.html | 26 +- Documentation/nvme-list-ns.txt | 6 + Documentation/nvme-ns-descs.1 | 115 +++ Documentation/nvme-ns-descs.html | 863 ++++++++++++++++ Documentation/nvme-ns-descs.txt | 74 ++ Documentation/nvme-read.1 | 41 +- Documentation/nvme-read.html | 92 +- Documentation/nvme-read.txt | 44 +- Documentation/nvme-resv-acquire.1 | 11 +- Documentation/nvme-resv-acquire.html | 18 +- Documentation/nvme-resv-acquire.txt | 7 +- Documentation/nvme-resv-register.1 | 11 +- Documentation/nvme-resv-register.html | 18 +- Documentation/nvme-resv-register.txt | 7 +- Documentation/nvme-resv-release.1 | 10 +- Documentation/nvme-resv-release.html | 17 +- Documentation/nvme-resv-release.txt | 6 +- Documentation/nvme-resv-report.1 | 9 +- Documentation/nvme-resv-report.html | 16 +- Documentation/nvme-resv-report.txt | 5 +- Documentation/nvme-sanitize-log.1 | 28 +- Documentation/nvme-sanitize-log.html | 1735 ++++++++++++++++---------------- Documentation/nvme-sanitize-log.txt | 19 +- Documentation/nvme-security-recv.1 | 12 +- Documentation/nvme-security-recv.html | 19 +- Documentation/nvme-security-recv.txt | 8 +- Documentation/nvme-security-send.1 | 6 +- Documentation/nvme-security-send.html | 13 +- Documentation/nvme-security-send.txt | 2 +- Documentation/nvme-telemetry-log.1 | 82 ++ Documentation/nvme-telemetry-log.html | 831 +++++++++++++++ Documentation/nvme-telemetry-log.txt | 48 + Documentation/nvme-wdc-id-ctrl.1 | 5 +- Documentation/nvme-wdc-id-ctrl.html | 12 +- Documentation/nvme-wdc-id-ctrl.txt | 1 + Documentation/nvme-write.1 | 65 +- Documentation/nvme-write.html | 125 ++- Documentation/nvme-write.txt | 70 +- 61 files changed, 4151 insertions(+), 1121 deletions(-) create mode 100644 Documentation/nvme-ns-descs.1 create mode 100644 Documentation/nvme-ns-descs.html create mode 100644 Documentation/nvme-ns-descs.txt create mode 100644 Documentation/nvme-telemetry-log.1 create mode 100644 Documentation/nvme-telemetry-log.html create mode 100644 Documentation/nvme-telemetry-log.txt
Documentation/cmds-main.txt +6 -0
@@ -31,6 +31,9 @@ linknvme:nvme-get-feature[1]:: linknvme:nvme-get-log[1]:: Generic Get Log +linknvme:nvme-telemetry-log[1]:: + Telemetry Host-Initiated Log + linknvme:nvme-smart-log[1]:: Retrieve Smart Log
@@ -64,6 +67,9 @@ linknvme:nvme-io-passthru[1]:: linknvme:nvme-list-ns[1]:: List all nvme namespaces +linknvme:nvme-ns-descs[1]:: + Identify Namespace Identification Descriptor + linknvme:nvme-list[1]:: List all nvme controllers
Documentation/nvme-admin-passthru.1 +14 -5
@@ -2,12 +2,12 @@ .\" Title: nvme-admin-passthru .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -42,7 +42,8 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results [\-\-input\-file=<file> | \-f <file>] [\-\-read | \-r ] [\-\-write | \-w] [\-\-timeout=<to> | \-t <to>] - [\-\-show\-command | \-\-dry\-run | \-s] + [\-\-show\-command | \-s] + [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] [\-\-prefill=<prefill> | \-p <prefill>] .fi
@@ -100,9 +101,17 @@ The data length for the buffer used for this command\&. The metadata length for the buffer used for this command\&. .RE .PP -\-s, \-\-show\-cmd, \-\-dry\-run +\-s, \-\-show\-cmd .RS 4 -Do not actually send the command; print out the command that would be sent\&. +Print out the command to be sent\&. +.RE +.PP +\-d, \-\-dry\-run +.RS 4 +Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option +\fImust\fR +be set\&. Otherwise \-\-dry\-run optionn will be +\fIignored\fR\&. .RE .PP \-b, \-\-raw\-binary
Documentation/nvme-admin-passthru.html +20 -7
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-admin-passthru(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -756,7 +758,8 @@ nvme-admin-passthru(1) Manual Page [--input-file=<file> | -f <file>] [--read | -r ] [--write | -w] [--timeout=<to> | -t <to>] - [--show-command | --dry-run | -s] + [--show-command | -s] + [--dry-run | -d] [--raw-binary | -b] [--prefill=<prefill> | -p <prefill>]</pre> <div class="attribution">
@@ -895,13 +898,22 @@ printed to stdout for another program to parse.</p></div> <dt class="hdlist1"> --show-cmd </dt> +<dd> +<p> + Print out the command to be sent. +</p> +</dd> +<dt class="hdlist1"> +-d +</dt> <dt class="hdlist1"> --dry-run </dt> <dd> <p> - Do not actually send the command; print out the command that - would be sent. + Do not actually send the command. If want to use --dry-run option, + --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be + <em>ignored</em>. </p> </dd> <dt class="hdlist1">
@@ -972,7 +984,8 @@ Or if you want to save that structure to a file: <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-02-27 10:11:57 EST +Last updated + 2018-01-27 01:39:13 KST </div> </div> </body>
Documentation/nvme-admin-passthru.txt +8 -3
@@ -18,7 +18,8 @@ SYNOPSIS [--input-file=<file> | -f <file>] [--read | -r ] [--write | -w] [--timeout=<to> | -t <to>] - [--show-command | --dry-run | -s] + [--show-command | -s] + [--dry-run | -d] [--raw-binary | -b] [--prefill=<prefill> | -p <prefill>]
@@ -83,9 +84,13 @@ OPTIONS -s:: --show-cmd:: + Print out the command to be sent. + +-d:: --dry-run:: - Do not actually send the command; print out the command that - would be sent. + Do not actually send the command. If want to use --dry-run option, + --show-cmd option _must_ be set. Otherwise --dry-run optionn will be + _ignored_. -b:: --raw-binary::
Documentation/nvme-compare.1 +154 -4
188 lines not on this page · raw message
Documentation/nvme-compare.html +260 -7
315 lines not on this page · raw message
Documentation/nvme-compare.txt +106 -2
128 lines not on this page · raw message
Documentation/nvme-format.1 +3 -3
@@ -2,12 +2,12 @@ .\" Title: nvme-format .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -39,7 +39,7 @@ nvme-format \- Format an NVMe device [\-\-pi=<pi> | \-i <pi>] [\-\-ms=<ms> | \-m <ms>] [\-\-reset | \-r ] - [\-\-timeout | \-t ] + [\-\-timeout=<timeout> | \-t <timeout> ] .fi .SH "DESCRIPTION" .sp
Documentation/nvme-format.html +8 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-format(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -753,7 +755,7 @@ nvme-format(1) Manual Page [--pi=<pi> | -i <pi>] [--ms=<ms> | -m <ms>] [--reset | -r ] - [--timeout | -t ]</pre> + [--timeout=<timeout> | -t <timeout> ]</pre> <div class="attribution"> </div></div> </div>
@@ -997,7 +999,8 @@ information: <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-02-27 10:11:57 EST +Last updated + 2018-01-27 01:32:58 KST </div> </div> </body>
Documentation/nvme-format.txt +1 -1
@@ -15,7 +15,7 @@ SYNOPSIS [--pi=<pi> | -i <pi>] [--ms=<ms> | -m <ms>] [--reset | -r ] - [--timeout | -t ] + [--timeout=<timeout> | -t <timeout> ] DESCRIPTION -----------
Documentation/nvme-get-feature.1 +8 -2
@@ -2,12 +2,12 @@ .\" Title: nvme-get-feature .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-FEATURE" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-FEATURE" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -37,6 +37,7 @@ nvme-get-feature \- Gets an NVMe feature, returns applicable results [\-\-data\-len=<data\-len> | \-l <data\-len>] [\-\-sel=<select> | \-s <select>] [\-\-raw\-binary | \-b] + [\-\-human\-readable | \-H] .fi .SH "DESCRIPTION" .sp
@@ -116,6 +117,11 @@ The value for command dword 11, if applicable\&. .RS 4 Print the raw feature buffer to stdout if the feature returns a structure\&. .RE +.PP +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE .SH "EXAMPLES" .sp .RS 4
Documentation/nvme-get-feature.html +21 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-get-feature(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -750,7 +752,8 @@ nvme-get-feature(1) Manual Page [--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>] [--data-len=<data-len> | -l <data-len>] [--sel=<select> | -s <select>] - [--raw-binary | -b]</pre> + [--raw-binary | -b] + [--human-readable | -H]</pre> <div class="attribution"> </div></div> </div>
@@ -878,6 +881,18 @@ cellspacing="0" cellpadding="4"> a structure. </p> </dd> +<dt class="hdlist1"> +-H +</dt> +<dt class="hdlist1"> +--human-readable +</dt> +<dd> +<p> + This option will parse and format many of the bit fields + into human-readable formats. +</p> +</dd> </dl></div> </div> </div>
@@ -941,7 +956,8 @@ format: <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-06-23 12:34:32 EDT +Last updated + 2018-01-27 01:31:15 KST </div> </div> </body>
Documentation/nvme-get-feature.txt +6 -0
@@ -13,6 +13,7 @@ SYNOPSIS [--data-len=<data-len> | -l <data-len>] [--sel=<select> | -s <select>] [--raw-binary | -b] + [--human-readable | -H] DESCRIPTION -----------
@@ -70,6 +71,11 @@ OPTIONS Print the raw feature buffer to stdout if the feature returns a structure. +-H:: +--human-readable:: + This option will parse and format many of the bit fields + into human-readable formats. + EXAMPLES -------- * Retrieves the feature for Number of Queues, or feature id 7:
Documentation/nvme-get-log.1 +14 -2
@@ -2,12 +2,12 @@ .\" Title: nvme-get-log .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LOG" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LOG" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -37,6 +37,8 @@ nvme-get-log \- Retrieves a log page from an NVMe device [\-\-aen=<aen> | \-a <aen>] [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-raw\-binary | \-b] + [\-\-lpo=<offset> | \-o <offset>] + [\-\-lsp=<field> | \-s <field>] .fi .SH "DESCRIPTION" .sp
@@ -71,6 +73,16 @@ Sets the command\(cqs nsid value to the given nsid\&. Defaults to 0xffffffff if .RS 4 Print the raw log buffer to stdout\&. .RE +.PP +\-o <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 +.PP +\-s <field>, \-\-lsp=<field> +.RS 4 +The log specified field of LID\&. +.RE .SH "EXAMPLES" .sp .RS 4
Documentation/nvme-get-log.html +33 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-get-log(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -750,7 +752,9 @@ nvme-get-log(1) Manual Page [--log-len=<log-len> | -l <log-len>] [--aen=<aen> | -a <aen>] [--namespace-id=<nsid> | -n <nsid>] - [--raw-binary | -b]</pre> + [--raw-binary | -b] + [--lpo=<offset> | -o <offset>] + [--lsp=<field> | -s <field>]</pre> <div class="attribution"> </div></div> </div>
@@ -834,6 +838,29 @@ program to parse.</p></div> Print the raw log buffer to stdout. </p> </dd> +<dt class="hdlist1"> +-o <offset> +</dt> +<dt class="hdlist1"> +--lpo=<offset> +</dt> +<dd> +<p> + The log page offset specifies the location within a log page to start + returning data from. It’s Dword-aligned and 64-bits. +</p> +</dd> +<dt class="hdlist1"> +-s <field> +</dt> +<dt class="hdlist1"> +--lsp=<field> +</dt> +<dd> +<p> + The log specified field of LID. +</p> +</dd> </dl></div> </div> </div>
@@ -877,7 +904,8 @@ Have the program return the raw log page in binary: <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-10-20 15:09:05 MDT +Last updated + 2018-01-27 01:15:13 KST </div> </div> </body>
Documentation/nvme-get-log.txt +11 -0
@@ -13,6 +13,8 @@ SYNOPSIS [--aen=<aen> | -a <aen>] [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b] + [--lpo=<offset> | -o <offset>] + [--lsp=<field> | -s <field>] DESCRIPTION -----------
@@ -56,6 +58,15 @@ OPTIONS --raw-binary:: Print the raw log buffer to stdout. +-o <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. + +-s <field>:: +--lsp=<field>:: + The log specified field of LID. + EXAMPLES -------- * Get 512 bytes from log page 2
Documentation/nvme-id-ns.1 +3 -2
@@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -34,6 +34,7 @@ nvme-id-ns \- Send NVMe Identify Namespace, return result and structure .nf \fInvme id\-ns\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-f | \-\-force] + [\-\-human\-readable | \-H] [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION"
Documentation/nvme-id-ns.html +8 -4
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-id-ns(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -748,6 +750,7 @@ nvme-id-ns(1) Manual Page <div class="verseblock"> <pre class="content"><em>nvme id-ns</em> <device> [-v | --vendor-specific] [-b | --raw-binary] [--namespace-id=<nsid> | -n <nsid>] [-f | --force] + [--human-readable | -H] [--output-format=<fmt> | -o <fmt>]</pre> <div class="attribution"> </div></div>
@@ -950,7 +953,8 @@ int main(int argc, char **argv) <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-02-27 10:11:58 EST +Last updated + 2018-01-27 00:45:23 KST </div> </div> </body>
Documentation/nvme-id-ns.txt +1 -0
@@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme id-ns' <device> [-v | --vendor-specific] [-b | --raw-binary] [--namespace-id=<nsid> | -n <nsid>] [-f | --force] + [--human-readable | -H] [--output-format=<fmt> | -o <fmt>] DESCRIPTION
Documentation/nvme-io-passthru.1 +9 -5
@@ -2,12 +2,12 @@ .\" Title: nvme-io-passthru .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-IO\-PASSTHRU" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-IO\-PASSTHRU" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -41,9 +41,10 @@ nvme-io-passthru \- Submit an arbitrary io command, return results [\-\-data\-len=<data\-len> | \-l <data\-len>] [\-\-metadata\-len=<len> | \-m <len>] [\-\-read | \-r ] [\-\-write | \-w] - [\-\-input\-file=<file> | \-f <file>] + [\-\-input\-file=<file> | \-i <file>] [\-\-timeout=<to> | \-t <to>] - [\-\-show\-command | \-\-dry\-run | \-s] + [\-\-show\-command | \-s] + [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] [\-\-prefill=<prefill> | \-p <prefill>] .fi
@@ -109,7 +110,10 @@ Print out the command to be sent\&. .PP \-d, \-\-dry\-run .RS 4 -Do not actually send the command\&. +Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option +\fImust\fR +be set\&. Otherwise \-\-dry\-run optionn will be +\fIignored\fR\&. .RE .PP \-b, \-\-raw\-binary
Documentation/nvme-io-passthru.html +13 -7
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-io-passthru(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -755,9 +757,10 @@ nvme-io-passthru(1) Manual Page [--data-len=<data-len> | -l <data-len>] [--metadata-len=<len> | -m <len>] [--read | -r ] [--write | -w] - [--input-file=<file> | -f <file>] + [--input-file=<file> | -i <file>] [--timeout=<to> | -t <to>] - [--show-command | --dry-run | -s] + [--show-command | -s] + [--dry-run | -d] [--raw-binary | -b] [--prefill=<prefill> | -p <prefill>]</pre> <div class="attribution">
@@ -909,7 +912,9 @@ printed to stdout for another program to parse.</p></div> </dt> <dd> <p> - Do not actually send the command. + Do not actually send the command. If want to use --dry-run option, + --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be + <em>ignored</em>. </p> </dd> <dt class="hdlist1">
@@ -958,7 +963,8 @@ printed to stdout for another program to parse.</p></div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-02-27 10:11:58 EST +Last updated + 2018-01-27 01:39:14 KST </div> </div> </body>
Documentation/nvme-io-passthru.txt +6 -3
@@ -17,9 +17,10 @@ SYNOPSIS [--data-len=<data-len> | -l <data-len>] [--metadata-len=<len> | -m <len>] [--read | -r ] [--write | -w] - [--input-file=<file> | -f <file>] + [--input-file=<file> | -i <file>] [--timeout=<to> | -t <to>] - [--show-command | --dry-run | -s] + [--show-command | -s] + [--dry-run | -d] [--raw-binary | -b] [--prefill=<prefill> | -p <prefill>]
@@ -88,7 +89,9 @@ OPTIONS -d:: --dry-run:: - Do not actually send the command. + Do not actually send the command. If want to use --dry-run option, + --show-cmd option _must_ be set. Otherwise --dry-run optionn will be + _ignored_. -b:: --raw-binary::
Documentation/nvme-list-ns.1 +8 -2
@@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -33,6 +33,7 @@ nvme-list-ns \- Send NVMe Identify List Namespaces, return result and structure .sp .nf \fInvme list\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-all | \-a] .fi .SH "DESCRIPTION" .sp
@@ -47,6 +48,11 @@ On success, the namespace array is printed for each index and nsid for a valid n .RS 4 Retrieve the identify list structure starting with the given nsid\&. .RE +.PP +\-a, \-\-all +.RS 4 +Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&. +.RE .SH "EXAMPLES" .sp No examples yet\&.
Documentation/nvme-list-ns.html +21 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-id-ns(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -746,7 +748,8 @@ nvme-id-ns(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre> +<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>] + [--all | -a]</pre> <div class="attribution"> </div></div> </div>
@@ -779,6 +782,18 @@ a valid nsid.</p></div> Retrieve the identify list structure starting with the given nsid. </p> </dd> +<dt class="hdlist1"> +-a +</dt> +<dt class="hdlist1"> +--all +</dt> +<dd> +<p> + Retrieve the identify list structure for all namespaces in the + subsystem, whether attached or inactive. +</p> +</dd> </dl></div> </div> </div>
@@ -798,7 +813,8 @@ a valid nsid.</p></div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2017-04-18 09:19:59 EDT +Last updated + 2018-01-27 00:47:55 KST </div> </div> </body>
Documentation/nvme-list-ns.txt +6 -0
@@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme list-ns' <device> [--namespace-id=<nsid> | -n <nsid>] + [--all | -a] DESCRIPTION -----------
@@ -29,6 +30,11 @@ OPTIONS --namespace-id=<nsid>:: Retrieve the identify list structure starting with the given nsid. +-a:: +--all:: + Retrieve the identify list structure for all namespaces in the + subsystem, whether attached or inactive. + EXAMPLES -------- No examples yet.
Documentation/nvme-ns-descs.1 new file +115 -0
115 lines not on this page · raw message
Documentation/nvme-ns-descs.html new file +863 -0
863 lines not on this page · raw message
Documentation/nvme-ns-descs.txt new file +74 -0
74 lines not on this page · raw message
Documentation/nvme-read.1 +37 -4
64 lines not on this page · raw message
Documentation/nvme-read.html +85 -7
132 lines not on this page · raw message
Documentation/nvme-read.txt +42 -2
58 lines not on this page · raw message
Documentation/nvme-resv-acquire.1 +8 -3
@@ -2,12 +2,12 @@ .\" Title: nvme-resv-acquire .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-ACQUIRE" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-ACQUIRE" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -32,7 +32,12 @@ nvme-resv-acquire \- Acquire an nvme reservation .SH "SYNOPSIS" .sp .nf -\fInvme resv\-acquire\fR <device> +\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] .fi .SH "DESCRIPTION" .sp
Documentation/nvme-resv-acquire.html +13 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-resv-acquire(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -746,7 +748,12 @@ nvme-resv-acquire(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<pre class="content"><em>nvme resv-acquire</em> <device></pre> +<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> <div class="attribution"> </div></div> </div>
@@ -939,7 +946,8 @@ cellspacing="0" cellpadding="4"> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2016-05-16 12:47:42 EDT +Last updated + 2018-01-27 01:46:31 KST </div> </div> </body>
Documentation/nvme-resv-acquire.txt +6 -1
@@ -8,7 +8,12 @@ nvme-resv-acquire - Acquire an nvme reservation SYNOPSIS -------- [verse] -'nvme resv-acquire' <device> +'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] DESCRIPTION -----------
Documentation/nvme-resv-register.1 +8 -3
@@ -2,12 +2,12 @@ .\" Title: nvme-resv-register .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REGISTER" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REGISTER" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -32,7 +32,12 @@ nvme-resv-register \- Register an nvme reservation .SH "SYNOPSIS" .sp .nf -\fInvme resv\-register\fR <device> +\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] .fi .SH "DESCRIPTION" .sp
Documentation/nvme-resv-register.html +13 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-resv-register(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -746,7 +748,12 @@ nvme-resv-register(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<pre class="content"><em>nvme resv-register</em> <device></pre> +<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> <div class="attribution"> </div></div> </div>
@@ -928,7 +935,8 @@ cellspacing="0" cellpadding="4"> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2016-05-16 12:47:42 EDT +Last updated + 2018-01-27 01:46:24 KST </div> </div> </body>
Documentation/nvme-resv-register.txt +6 -1
@@ -8,7 +8,12 @@ nvme-resv-register - Register an nvme reservation SYNOPSIS -------- [verse] -'nvme resv-register' <device> +'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] DESCRIPTION -----------
Documentation/nvme-resv-release.1 +7 -3
@@ -2,12 +2,12 @@ .\" Title: nvme-resv-release .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-RELEASE" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-RELEASE" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -32,7 +32,11 @@ nvme-resv-release \- Release an nvme reservation .SH "SYNOPSIS" .sp .nf -\fInvme resv\-release\fR <device> +\fInvme resv\-release\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-crkey=<crkey> | \-c <crkey>] + [\-\-rtype=<rtype> | \-t <rtype>] + [\-\-rrela=<rrela> | \-a <rrela>] + [\-\-iekey | \-i] .fi .SH "DESCRIPTION" .sp
Documentation/nvme-resv-release.html +12 -5
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-resv-release(1)</title> <style type="text/css"> /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,7 +94,9 @@ ul > li > * { color: black; } padding: 0; margin: 0; } - +pre { + white-space: pre-wrap; +} #author { color: #527bbd;
@@ -223,7 +225,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } +span.image img { border-style: none; vertical-align: text-bottom; } a.image:visited { color: white; } dl {
@@ -746,7 +748,11 @@ nvme-resv-release(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<pre class="content"><em>nvme resv-release</em> <device></pre> +<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> <div class="attribution"> </div></div> </div>
@@ -922,7 +928,8 @@ cellspacing="0" cellpadding="4"> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2016-05-16 12:47:42 EDT +Last updated + 2018-01-27 01:48:53 KST </div> </div> </body>
Documentation/nvme-resv-release.txt +5 -1
@@ -8,7 +8,11 @@ nvme-resv-release - Release an nvme reservation SYNOPSIS -------- [verse] -'nvme resv-release' <device> +'nvme resv-release' <device> [--namespace-id=<nsid> | -n <nsid>] + [--crkey=<crkey> | -c <crkey>] + [--rtype=<rtype> | -t <rtype>] + [--rrela=<rrela> | -a <rrela>] + [--iekey | -i] DESCRIPTION -----------
Documentation/nvme-resv-report.1 +5 -4
@@ -2,12 +2,12 @@ .\" Title: nvme-resv-report .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 12/10/2017 +.\" Date: 01/27/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REPORT" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REPORT" "1" "01/27/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -34,8 +34,9 @@ nvme-resv-report \- Send NVMe Reservation Report, parse the result .nf \fInvme resv\-report\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-numd=<num\-dwords> | \-d <num\-dwords>] - [\-b | \-\-raw\-binary] - [\-o <fmt> | \-\-output\-format=<fmt>] + [\-\-cdw11=<cdw11> | \-c <cdw11>] + [\-\-raw\-binary | \-b] + [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" .sp
Documentation/nvme-resv-report.html +10 -6
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> +<meta name="generator" content="AsciiDoc 8.6.9" /> <title>nvme-resv-report(1)</title> <style type="text/css">
Lines of this file are not shown. View the raw message.
Documentation/nvme-sanitize-log.html +887 -848
1,735 lines not on this page · raw message
Documentation/nvme-telemetry-log.1 new file +82 -0
82 lines not on this page · raw message
Documentation/nvme-telemetry-log.html new file +831 -0
831 lines not on this page · raw message
Documentation/nvme-telemetry-log.txt new file +48 -0
48 lines not on this page · raw message
Documentation/nvme-write.1 +40 -25
65 lines not on this page · raw message
Documentation/nvme-write.html +77 -48
125 lines not on this page · raw message
Documentation/nvme-write.txt +41 -29
70 lines not on this page · raw message
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.7.4
Part of the diff is not shown here. View the raw message.