From f7892cbabca6257ab03f37e1a0b87dadd89a55fb Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Thu, 1 Mar 2018 10:06:52 -0700 Subject: [PATCH] Regenerate documentation Signed-off-by: Keith Busch --- Documentation/cmds-main.txt | 6 + Documentation/nvme-admin-passthru.1 | 8 +- Documentation/nvme-attach-ns.1 | 8 +- Documentation/nvme-compare.1 | 8 +- Documentation/nvme-connect-all.1 | 8 +- Documentation/nvme-connect.1 | 6 +- Documentation/nvme-create-ns.1 | 8 +- Documentation/nvme-delete-ns.1 | 8 +- Documentation/nvme-detach-ns.1 | 8 +- Documentation/nvme-dir-receive.1 | 8 +- Documentation/nvme-dir-send.1 | 8 +- Documentation/nvme-disconnect.1 | 10 +- Documentation/nvme-disconnect.html | 4 +- Documentation/nvme-dsm.1 | 8 +- Documentation/nvme-effects-log.1 | 8 +- Documentation/nvme-endurance-log.1 | 106 +++ Documentation/nvme-endurance-log.html | 837 ++++++++++++++++++++++ Documentation/nvme-error-log.1 | 8 +- Documentation/nvme-flush.1 | 8 +- Documentation/nvme-format.1 | 8 +- Documentation/nvme-gen-hostnqn.1 | 8 +- Documentation/nvme-get-feature.html | 11 +- Documentation/nvme-get-log.1 | 8 +- Documentation/nvme-get-log.html | 11 +- Documentation/nvme-help.1 | 8 +- Documentation/nvme-huawei-id-ctrl.1 | 8 +- Documentation/nvme-huawei-list.1 | 8 +- Documentation/nvme-id-ctrl.1 | 8 +- Documentation/nvme-id-ns.1 | 8 +- Documentation/nvme-intel-id-ctrl.1 | 8 +- Documentation/nvme-intel-internal-log.1 | 8 +- Documentation/nvme-intel-market-name.1 | 8 +- Documentation/nvme-intel-smart-log-add.1 | 8 +- Documentation/nvme-intel-temp-stats.1 | 8 +- Documentation/nvme-io-passthru.1 | 8 +- Documentation/nvme-list-ctrl.1 | 8 +- Documentation/nvme-list-ns.1 | 8 +- Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list.1 | 8 +- Documentation/nvme-lnvm-create.1 | 8 +- Documentation/nvme-lnvm-diag-bbtbl.1 | 8 +- Documentation/nvme-lnvm-diag-set-bbtbl.1 | 8 +- Documentation/nvme-lnvm-factory.1 | 8 +- Documentation/nvme-lnvm-info.1 | 8 +- Documentation/nvme-lnvm-init.1 | 8 +- Documentation/nvme-lnvm-list.1 | 8 +- Documentation/nvme-lnvm-remove.1 | 8 +- Documentation/nvme-netapp-smdevices.1 | 31 +- Documentation/nvme-ns-descs.1 | 8 +- Documentation/nvme-ns-rescan.1 | 8 +- Documentation/nvme-read.1 | 8 +- Documentation/nvme-read.html | 11 +- Documentation/nvme-reset.1 | 8 +- Documentation/nvme-resv-acquire.1 | 8 +- Documentation/nvme-resv-register.1 | 8 +- Documentation/nvme-resv-report.1 | 8 +- Documentation/nvme-sanitize-log.1 | 8 +- Documentation/nvme-sanitize.1 | 8 +- Documentation/nvme-security-recv.1 | 8 +- Documentation/nvme-security-send.1 | 8 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-smart-log.1 | 8 +- Documentation/nvme-subsystem-reset.1 | 8 +- Documentation/nvme-telemetry-log.html | 11 +- Documentation/nvme-wdc-clear-pcie-corr.1 | 8 +- Documentation/nvme-wdc-drive-essentials.1 | 8 +- Documentation/nvme-wdc-drive-log.1 | 8 +- Documentation/nvme-wdc-get-crash-dump.1 | 8 +- Documentation/nvme-wdc-id-ctrl.1 | 8 +- Documentation/nvme-wdc-purge-monitor.1 | 8 +- Documentation/nvme-wdc-purge.1 | 8 +- Documentation/nvme-wdc-smart-add-log.1 | 8 +- Documentation/nvme-write-uncor.1 | 8 +- Documentation/nvme-write-zeroes.1 | 8 +- Documentation/nvme-write.1 | 8 +- Documentation/nvme.1 | 26 +- Documentation/nvme.html | 34 +- 78 files changed, 1288 insertions(+), 324 deletions(-) create mode 100644 Documentation/nvme-endurance-log.1 create mode 100644 Documentation/nvme-endurance-log.html diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index 3b40fa1..b34d48d 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -37,6 +37,12 @@ linknvme:nvme-telemetry-log[1]:: linknvme:nvme-smart-log[1]:: Retrieve Smart Log +linknvme:nvme-endurance-log[1]:: + Retrieve endurance Log + +linknvme:nvme-effects-log[1]:: + Retrieve effects Log + linknvme:nvme-get-ns-id[1]:: Retrieve namespace identifier diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 0662764..ddf806c 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-admin-passthru -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/30/2018 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "01/30/2018" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 890ab62..516f736 100644 --- a/Documentation/nvme-attach-ns.1 +++ b/Documentation/nvme-attach-ns.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-attach-ns -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index 7fb9223..71c2278 100644 --- a/Documentation/nvme-compare.1 +++ b/Documentation/nvme-compare.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-compare -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/30/2018 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "01/30/2018" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index b049b54..8d5d8cc 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-connect-all -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 995b51d..04c8c75 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index c66973c..c66e192 100644 --- a/Documentation/nvme-create-ns.1 +++ b/Documentation/nvme-create-ns.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-create-ns -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CREATE\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-CREATE\-NS" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index 56873d6..027e63c 100644 --- a/Documentation/nvme-delete-ns.1 +++ b/Documentation/nvme-delete-ns.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-id-ns -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-detach-ns.1 b/Documentation/nvme-detach-ns.1 index 6edb23b..4d6b6de 100644 --- a/Documentation/nvme-detach-ns.1 +++ b/Documentation/nvme-detach-ns.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-detach-ns -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DETACH\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-DETACH\-NS" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-receive.1 b/Documentation/nvme-dir-receive.1 index 5a85bcb..65c96c2 100644 --- a/Documentation/nvme-dir-receive.1 +++ b/Documentation/nvme-dir-receive.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-dir-receive -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-RECEIVE" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-RECEIVE" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-send.1 b/Documentation/nvme-dir-send.1 index 87cb5d6..3d1b5f9 100644 --- a/Documentation/nvme-dir-send.1 +++ b/Documentation/nvme-dir-send.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-dir-send -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-SEND" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-SEND" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-disconnect.1 b/Documentation/nvme-disconnect.1 index 50c885b..26dc393 100644 --- a/Documentation/nvme-disconnect.1 +++ b/Documentation/nvme-disconnect.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-disconnect -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-disconnect \- Disonnect one or more Fabrics controller(s)\&. .SH "SYNOPSIS" .sp .nf -\fInvme connect\fR +\fInvme disconnect\fR [\-\-nqn= | \-n ] [\-\-device= | \-d ] .fi diff --git a/Documentation/nvme-disconnect.html b/Documentation/nvme-disconnect.html index e288ae4..87a7bda 100644 --- a/Documentation/nvme-disconnect.html +++ b/Documentation/nvme-disconnect.html @@ -746,7 +746,7 @@ nvme-disconnect(1) Manual Page

SYNOPSIS

-
nvme connect
+
nvme disconnect
                 [--nqn=<subnqn>           | -n <subnqn>]
                 [--device=<device>        | -d <device>]
@@ -834,7 +834,7 @@ Disconnect the controller nvme4

diff --git a/Documentation/nvme-dsm.1 b/Documentation/nvme-dsm.1 index 4d06dca..bca2982 100644 --- a/Documentation/nvme-dsm.1 +++ b/Documentation/nvme-dsm.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-dsm -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DSM" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-DSM" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-effects-log.1 b/Documentation/nvme-effects-log.1 index 737e64a..8c27e2b 100644 --- a/Documentation/nvme-effects-log.1 +++ b/Documentation/nvme-effects-log.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-effects-log -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/13/2018 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-EFFECTS\-LOG" "1" "01/13/2018" "NVMe" "NVMe Manual" +.TH "NVME\-EFFECTS\-LOG" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-endurance-log.1 b/Documentation/nvme-endurance-log.1 new file mode 100644 index 0000000..c4819a4 --- /dev/null +++ b/Documentation/nvme-endurance-log.1 @@ -0,0 +1,106 @@ +'\" t +.\" Title: nvme-endurance-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ENDURANCE\-LOG" "1" "03/01/2018" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-endurance-log \- Send NVMe Endurance log page request, returns result and log +.SH "SYNOPSIS" +.sp +.nf +\fInvme endurance\-log\fR [\-\-group\-id= | \-g ] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the NVMe Endurance log page from an NVMe device and provides the retuned structure\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +On success, the returned endurance 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, the raw buffer may be printed to stdout for another program to parse, or reported in json format\&. +.SH "OPTIONS" +.PP +\-g , \-\-group\-id= +.RS 4 +The endurance group identifier\&. +.RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the Endurance log page in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme endurance\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the raw Endurance log to a file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme endurance\-log /dev/nvme0 \-\-output=binary > endurance_log\&.raw +.fi +.if n \{\ +.RE +.\} +.sp +It is probably a bad idea to not redirect stdout when using this mode\&. +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-endurance-log.html b/Documentation/nvme-endurance-log.html new file mode 100644 index 0000000..95a31dc --- /dev/null +++ b/Documentation/nvme-endurance-log.html @@ -0,0 +1,837 @@ + + + + + +nvme-endurance-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme endurance-log <device> [--group-id=<group> | -g <group>]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe Endurance log page from an NVMe device and provides the retuned 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, the returned endurance 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, the raw buffer may be +printed to stdout for another program to parse, or reported in json format.

+
+
+
+

OPTIONS

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the Endurance log page in a human readable format: +

    +
    +
    +
    # nvme endurance-log /dev/nvme0
    +
    +
  • +
  • +

    +Print the raw Endurance log to a file: +

    +
    +
    +
    # nvme endurance-log /dev/nvme0 --output=binary > endurance_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
  • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+

+ + + diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index e39cc86..eadde6e 100644 --- a/Documentation/nvme-error-log.1 +++ b/Documentation/nvme-error-log.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-error-log -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/11/2018 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ERROR\-LOG" "1" "01/11/2018" "NVMe" "NVMe Manual" +.TH "NVME\-ERROR\-LOG" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index 30328b9..9901927 100644 --- a/Documentation/nvme-flush.1 +++ b/Documentation/nvme-flush.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-flush -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FLUSH" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-FLUSH" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index 4b286cb..bd0b340 100644 --- a/Documentation/nvme-format.1 +++ b/Documentation/nvme-format.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-format -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/30/2018 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "01/30/2018" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index b2e5062..9bbee79 100644 --- a/Documentation/nvme-gen-hostnqn.1 +++ b/Documentation/nvme-gen-hostnqn.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-gen-hostnqn -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/01/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GEN\-HOSTNQN" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-GEN\-HOSTNQN" "1" "03/01/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-feature.html b/Documentation/nvme-get-feature.html index 274f432..d3bc1bd 100644 --- a/Documentation/nvme-get-feature.html +++ b/Documentation/nvme-get-feature.html @@ -3,7 +3,7 @@ - + nvme-get-feature(1)