From ce5ce11426294187e8d6985bec75866d9d620cde Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Tue, 16 Jun 2020 08:06:09 -0700 Subject: [PATCH] add zns documentation Signed-off-by: Keith Busch --- Documentation/nvme-admin-passthru.1 | 4 +- Documentation/nvme-ana-log.1 | 4 +- Documentation/nvme-attach-ns.1 | 4 +- Documentation/nvme-changed-ns-list-log.1 | 4 +- Documentation/nvme-compare.1 | 4 +- Documentation/nvme-connect-all.1 | 4 +- Documentation/nvme-connect.1 | 4 +- Documentation/nvme-connect.html | 2 +- Documentation/nvme-create-ns.1 | 4 +- Documentation/nvme-delete-ns.1 | 4 +- Documentation/nvme-dera-stat.1 | 4 +- Documentation/nvme-detach-ns.1 | 4 +- Documentation/nvme-device-self-test.1 | 4 +- Documentation/nvme-dir-receive.1 | 4 +- Documentation/nvme-dir-send.1 | 4 +- Documentation/nvme-disconnect-all.1 | 4 +- Documentation/nvme-disconnect.1 | 4 +- Documentation/nvme-discover.1 | 4 +- Documentation/nvme-dsm.1 | 4 +- Documentation/nvme-effects-log.1 | 4 +- Documentation/nvme-endurance-log.1 | 4 +- Documentation/nvme-endurance-log.html | 2 +- Documentation/nvme-error-log.1 | 4 +- Documentation/nvme-flush.1 | 4 +- Documentation/nvme-format.1 | 4 +- Documentation/nvme-fw-commit.1 | 4 +- Documentation/nvme-fw-download.1 | 4 +- Documentation/nvme-fw-log.1 | 4 +- Documentation/nvme-gen-hostnqn.1 | 4 +- Documentation/nvme-get-feature.1 | 4 +- Documentation/nvme-get-log.1 | 4 +- Documentation/nvme-get-ns-id.1 | 4 +- Documentation/nvme-get-ns-id.html | 14 +- Documentation/nvme-get-property.1 | 4 +- Documentation/nvme-help.1 | 4 +- Documentation/nvme-huawei-id-ctrl.1 | 4 +- Documentation/nvme-huawei-list.1 | 4 +- Documentation/nvme-id-ctrl.1 | 4 +- Documentation/nvme-id-ns.1 | 4 +- Documentation/nvme-id-nvmset.1 | 4 +- Documentation/nvme-intel-id-ctrl.1 | 4 +- Documentation/nvme-intel-internal-log.1 | 4 +- Documentation/nvme-intel-lat-stats.1 | 4 +- Documentation/nvme-intel-market-name.1 | 4 +- Documentation/nvme-intel-smart-log-add.1 | 4 +- Documentation/nvme-intel-temp-stats.1 | 4 +- Documentation/nvme-intel-temp-stats.html | 14 +- Documentation/nvme-io-passthru.1 | 4 +- Documentation/nvme-list-ctrl.1 | 4 +- Documentation/nvme-list-ns.1 | 4 +- Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list.1 | 4 +- Documentation/nvme-lnvm-create.1 | 4 +- Documentation/nvme-lnvm-diag-bbtbl.1 | 4 +- Documentation/nvme-lnvm-diag-set-bbtbl.1 | 4 +- Documentation/nvme-lnvm-factory.1 | 4 +- Documentation/nvme-lnvm-id-ns.1 | 4 +- Documentation/nvme-lnvm-info.1 | 4 +- Documentation/nvme-lnvm-init.1 | 4 +- Documentation/nvme-lnvm-list.1 | 4 +- Documentation/nvme-lnvm-remove.1 | 4 +- Documentation/nvme-netapp-ontapdevices.1 | 4 +- Documentation/nvme-netapp-smdevices.1 | 4 +- Documentation/nvme-ns-descs.1 | 4 +- Documentation/nvme-ns-rescan.1 | 4 +- Documentation/nvme-ns-rescan.html | 1256 +++++++++++------ Documentation/nvme-read.1 | 4 +- Documentation/nvme-reset.1 | 4 +- Documentation/nvme-resv-acquire.1 | 4 +- Documentation/nvme-resv-register.1 | 4 +- Documentation/nvme-resv-release.1 | 4 +- Documentation/nvme-resv-report.1 | 4 +- Documentation/nvme-resv-report.html | 7 +- Documentation/nvme-sanitize-log.1 | 4 +- Documentation/nvme-sanitize.1 | 4 +- Documentation/nvme-security-recv.1 | 4 +- Documentation/nvme-security-send.1 | 4 +- Documentation/nvme-self-test-log.1 | 4 +- Documentation/nvme-set-feature.1 | 4 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-show-hostnqn.1 | 4 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-smart-log.1 | 4 +- Documentation/nvme-smart-log.html | 14 +- Documentation/nvme-subsystem-reset.1 | 4 +- Documentation/nvme-telemetry-log.1 | 4 +- ...me-toshiba-clear-pcie-correctable-errors.1 | 4 +- Documentation/nvme-toshiba-vs-internal-log.1 | 4 +- Documentation/nvme-toshiba-vs-smart-add-log.1 | 4 +- Documentation/nvme-transcend-badblock.1 | 4 +- Documentation/nvme-transcend-healthvalue.1 | 4 +- .../nvme-virtium-save-smart-to-vtview-log.1 | 4 +- Documentation/nvme-virtium-show-identify.1 | 4 +- Documentation/nvme-wdc-cap-diag.1 | 4 +- Documentation/nvme-wdc-clear-assert-dump.1 | 4 +- .../nvme-wdc-clear-fw-activate-history.1 | 4 +- .../nvme-wdc-clear-pcie-correctable-errors.1 | 4 +- Documentation/nvme-wdc-drive-essentials.1 | 4 +- Documentation/nvme-wdc-drive-log.1 | 4 +- Documentation/nvme-wdc-drive-resize.1 | 4 +- Documentation/nvme-wdc-get-crash-dump.1 | 4 +- Documentation/nvme-wdc-get-drive-status.1 | 4 +- Documentation/nvme-wdc-get-pfail-dump.1 | 4 +- Documentation/nvme-wdc-id-ctrl.1 | 4 +- Documentation/nvme-wdc-log-page-directory.1 | 4 +- Documentation/nvme-wdc-namespace-resize.1 | 4 +- Documentation/nvme-wdc-purge-monitor.1 | 4 +- Documentation/nvme-wdc-purge.1 | 4 +- Documentation/nvme-wdc-vs-drive-info.1 | 4 +- .../nvme-wdc-vs-error-reason-identifier.1 | 4 +- .../nvme-wdc-vs-fw-activate-history.1 | 4 +- Documentation/nvme-wdc-vs-internal-log.1 | 4 +- Documentation/nvme-wdc-vs-nand-stats.1 | 4 +- Documentation/nvme-wdc-vs-nand-stats.html | 12 +- Documentation/nvme-wdc-vs-smart-add-log.1 | 4 +- .../nvme-wdc-vs-telemetry-controller-option.1 | 4 +- Documentation/nvme-write-uncor.1 | 4 +- Documentation/nvme-write-zeroes.1 | 4 +- Documentation/nvme-write.1 | 4 +- Documentation/nvme-zns-changed-zone-list.1 | 105 ++ Documentation/nvme-zns-changed-zone-list.html | 840 +++++++++++ Documentation/nvme-zns-changed-zone-list.txt | 54 + Documentation/nvme-zns-close-zone.1 | 84 ++ Documentation/nvme-zns-close-zone.html | 841 +++++++++++ Documentation/nvme-zns-close-zone.txt | 49 + Documentation/nvme-zns-finish-zone.1 | 84 ++ Documentation/nvme-zns-finish-zone.html | 842 +++++++++++ Documentation/nvme-zns-finish-zone.txt | 50 + Documentation/nvme-zns-id-ctrl.1 | 98 ++ Documentation/nvme-zns-id-ctrl.html | 828 +++++++++++ Documentation/nvme-zns-id-ctrl.txt | 50 + Documentation/nvme-zns-id-ns.html | 854 +++++++++++ Documentation/nvme-zns-id-ns.txt | 62 + Documentation/nvme-zns-offline-zone.1 | 84 ++ Documentation/nvme-zns-offline-zone.html | 841 +++++++++++ Documentation/nvme-zns-offline-zone.txt | 49 + Documentation/nvme-zns-open-zone.1 | 84 ++ Documentation/nvme-zns-open-zone.html | 841 +++++++++++ Documentation/nvme-zns-open-zone.txt | 49 + Documentation/nvme-zns-report-zones.1 | 198 +++ Documentation/nvme-zns-report-zones.html | 964 +++++++++++++ Documentation/nvme-zns-report-zones.txt | 102 ++ Documentation/nvme-zns-reset-zone.1 | 84 ++ Documentation/nvme-zns-reset-zone.html | 842 +++++++++++ Documentation/nvme-zns-reset-zone.txt | 50 + Documentation/nvme-zns-set-zone-desc.1 | 82 ++ Documentation/nvme-zns-set-zone-desc.html | 842 +++++++++++ Documentation/nvme-zns-set-zone-desc.txt | 50 + Documentation/nvme-zns-zone-append.1 | 133 ++ Documentation/nvme-zns-zone-append.html | 947 +++++++++++++ Documentation/nvme-zns-zone-append.txt | 96 ++ Documentation/nvme-zns-zone-mgmt-recv.1 | 121 ++ Documentation/nvme-zns-zone-mgmt-recv.html | 889 ++++++++++++ Documentation/nvme-zns-zone-mgmt-recv.txt | 78 + Documentation/nvme-zns-zone-mgmt-send.1 | 126 ++ Documentation/nvme-zns-zone-mgmt-send.html | 899 ++++++++++++ Documentation/nvme-zns-zone-mgmt-send.txt | 77 + Documentation/nvme.1 | 4 +- 158 files changed, 14435 insertions(+), 703 deletions(-) create mode 100644 Documentation/nvme-zns-changed-zone-list.1 create mode 100644 Documentation/nvme-zns-changed-zone-list.html create mode 100644 Documentation/nvme-zns-changed-zone-list.txt create mode 100644 Documentation/nvme-zns-close-zone.1 create mode 100644 Documentation/nvme-zns-close-zone.html create mode 100644 Documentation/nvme-zns-close-zone.txt create mode 100644 Documentation/nvme-zns-finish-zone.1 create mode 100644 Documentation/nvme-zns-finish-zone.html create mode 100644 Documentation/nvme-zns-finish-zone.txt create mode 100644 Documentation/nvme-zns-id-ctrl.1 create mode 100644 Documentation/nvme-zns-id-ctrl.html create mode 100644 Documentation/nvme-zns-id-ctrl.txt create mode 100644 Documentation/nvme-zns-id-ns.html create mode 100644 Documentation/nvme-zns-id-ns.txt create mode 100644 Documentation/nvme-zns-offline-zone.1 create mode 100644 Documentation/nvme-zns-offline-zone.html create mode 100644 Documentation/nvme-zns-offline-zone.txt create mode 100644 Documentation/nvme-zns-open-zone.1 create mode 100644 Documentation/nvme-zns-open-zone.html create mode 100644 Documentation/nvme-zns-open-zone.txt create mode 100644 Documentation/nvme-zns-report-zones.1 create mode 100644 Documentation/nvme-zns-report-zones.html create mode 100644 Documentation/nvme-zns-report-zones.txt create mode 100644 Documentation/nvme-zns-reset-zone.1 create mode 100644 Documentation/nvme-zns-reset-zone.html create mode 100644 Documentation/nvme-zns-reset-zone.txt create mode 100644 Documentation/nvme-zns-set-zone-desc.1 create mode 100644 Documentation/nvme-zns-set-zone-desc.html create mode 100644 Documentation/nvme-zns-set-zone-desc.txt create mode 100644 Documentation/nvme-zns-zone-append.1 create mode 100644 Documentation/nvme-zns-zone-append.html create mode 100644 Documentation/nvme-zns-zone-append.txt create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.1 create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.html create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.txt create mode 100644 Documentation/nvme-zns-zone-mgmt-send.1 create mode 100644 Documentation/nvme-zns-zone-mgmt-send.html create mode 100644 Documentation/nvme-zns-zone-mgmt-send.txt diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index f6d247f..34d4087 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -2,12 +2,12 @@ .\" Title: nvme-admin-passthru .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1 index 862f42d..302f5c2 100644 --- a/Documentation/nvme-ana-log.1 +++ b/Documentation/nvme-ana-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ana-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ANA\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ANA\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 0af22ae..0add8c1 100644 --- a/Documentation/nvme-attach-ns.1 +++ b/Documentation/nvme-attach-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-attach-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-changed-ns-list-log.1 b/Documentation/nvme-changed-ns-list-log.1 index 13dda55..9e0e66e 100644 --- a/Documentation/nvme-changed-ns-list-log.1 +++ b/Documentation/nvme-changed-ns-list-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-changed-ns-list-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CHANGED\-NS\-L" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CHANGED\-NS\-L" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index 0f1c6ff..09d3cf6 100644 --- a/Documentation/nvme-compare.1 +++ b/Documentation/nvme-compare.1 @@ -2,12 +2,12 @@ .\" Title: nvme-compare .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index f829935..ca1c82a 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/29/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "04/29/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 9170d01..097ff93 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index 3387333..fc75009 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -1070,7 +1070,7 @@ and Christoph Hellwig

diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index 7f358c1..0c7d3cb 100644 --- a/Documentation/nvme-create-ns.1 +++ b/Documentation/nvme-create-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-create-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CREATE\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CREATE\-NS" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index c186a86..bce99ca 100644 --- a/Documentation/nvme-delete-ns.1 +++ b/Documentation/nvme-delete-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dera-stat.1 b/Documentation/nvme-dera-stat.1 index bf2ec27..7f6d426 100644 --- a/Documentation/nvme-dera-stat.1 +++ b/Documentation/nvme-dera-stat.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dera-stat .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DERA\-STAT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DERA\-STAT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-detach-ns.1 b/Documentation/nvme-detach-ns.1 index 5765c85..4a4b0ba 100644 --- a/Documentation/nvme-detach-ns.1 +++ b/Documentation/nvme-detach-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-detach-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DETACH\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DETACH\-NS" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-device-self-test.1 b/Documentation/nvme-device-self-test.1 index 699c178..946a940 100644 --- a/Documentation/nvme-device-self-test.1 +++ b/Documentation/nvme-device-self-test.1 @@ -2,12 +2,12 @@ .\" Title: nvme-device-self-test .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DEVICE\-SELF\-" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DEVICE\-SELF\-" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-receive.1 b/Documentation/nvme-dir-receive.1 index 44e8a2a..18e7d12 100644 --- a/Documentation/nvme-dir-receive.1 +++ b/Documentation/nvme-dir-receive.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-receive .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-RECEIVE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-RECEIVE" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-send.1 b/Documentation/nvme-dir-send.1 index 77f9120..c8e446b 100644 --- a/Documentation/nvme-dir-send.1 +++ b/Documentation/nvme-dir-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-SEND" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-SEND" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-disconnect-all.1 b/Documentation/nvme-disconnect-all.1 index 04aec10..274691e 100644 --- a/Documentation/nvme-disconnect-all.1 +++ b/Documentation/nvme-disconnect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-disconnect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT\-AL" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT\-AL" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-disconnect.1 b/Documentation/nvme-disconnect.1 index 23e1af7..6e9a762 100644 --- a/Documentation/nvme-disconnect.1 +++ b/Documentation/nvme-disconnect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-disconnect .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-discover.1 b/Documentation/nvme-discover.1 index f354560..ab22ca4 100644 --- a/Documentation/nvme-discover.1 +++ b/Documentation/nvme-discover.1 @@ -2,12 +2,12 @@ .\" Title: nvme-discover .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCOVER" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DISCOVER" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dsm.1 b/Documentation/nvme-dsm.1 index 899a6a6..e15a3ab 100644 --- a/Documentation/nvme-dsm.1 +++ b/Documentation/nvme-dsm.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dsm .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DSM" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DSM" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-effects-log.1 b/Documentation/nvme-effects-log.1 index 72b22fb..c145a59 100644 --- a/Documentation/nvme-effects-log.1 +++ b/Documentation/nvme-effects-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-effects-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-EFFECTS\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-EFFECTS\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-endurance-log.1 b/Documentation/nvme-endurance-log.1 index 067a7a3..ea27d59 100644 --- a/Documentation/nvme-endurance-log.1 +++ b/Documentation/nvme-endurance-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-endurance-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ENDURANCE\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ENDURANCE\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-endurance-log.html b/Documentation/nvme-endurance-log.html index 42fe267..809edee 100644 --- a/Documentation/nvme-endurance-log.html +++ b/Documentation/nvme-endurance-log.html @@ -834,7 +834,7 @@ Print the raw Endurance log to a file: diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index e116ad4..f574e00 100644 --- a/Documentation/nvme-error-log.1 +++ b/Documentation/nvme-error-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-error-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ERROR\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ERROR\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index 3c4ddeb..e43c060 100644 --- a/Documentation/nvme-flush.1 +++ b/Documentation/nvme-flush.1 @@ -2,12 +2,12 @@ .\" Title: nvme-flush .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FLUSH" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FLUSH" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index b47c53e..de630b3 100644 --- a/Documentation/nvme-format.1 +++ b/Documentation/nvme-format.1 @@ -2,12 +2,12 @@ .\" Title: nvme-format .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-commit.1 b/Documentation/nvme-fw-commit.1 index 2a965a7..7c37ffa 100644 --- a/Documentation/nvme-fw-commit.1 +++ b/Documentation/nvme-fw-commit.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-commit .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-COMMIT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-COMMIT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-download.1 b/Documentation/nvme-fw-download.1 index 0fd360b..fc7edae 100644 --- a/Documentation/nvme-fw-download.1 +++ b/Documentation/nvme-fw-download.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-download .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-DOWNLOAD" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-DOWNLOAD" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-log.1 b/Documentation/nvme-fw-log.1 index f96bcdc..2955dc7 100644 --- a/Documentation/nvme-fw-log.1 +++ b/Documentation/nvme-fw-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index 255dcca..dd7a208 100644 --- a/Documentation/nvme-gen-hostnqn.1 +++ b/Documentation/nvme-gen-hostnqn.1 @@ -2,12 +2,12 @@ .\" Title: nvme-gen-hostnqn .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GEN\-HOSTNQN" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GEN\-HOSTNQN" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-feature.1 b/Documentation/nvme-get-feature.1 index 1bc451f..2a95eb2 100644 --- a/Documentation/nvme-get-feature.1 +++ b/Documentation/nvme-get-feature.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-feature .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-FEATURE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-FEATURE" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1 index 742a791..583ff78 100644 --- a/Documentation/nvme-get-log.1 +++ b/Documentation/nvme-get-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LOG" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-ns-id.1 b/Documentation/nvme-get-ns-id.1 index f7e69e4..e816929 100644 --- a/Documentation/nvme-get-ns-id.1 +++ b/Documentation/nvme-get-ns-id.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-ns-id .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-NS\-ID" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-NS\-ID" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-ns-id.html b/Documentation/nvme-get-ns-id.html index bd02929..6fd2329 100644 --- a/Documentation/nvme-get-ns-id.html +++ b/Documentation/nvme-get-ns-id.html @@ -1,9 +1,10 @@ + - + nvme-get-ns-id(1) - - - -

SYNOPSIS

-
-
-
nvme ns-rescan <device>
-
-
-
-

DESCRIPTION

-
-

Requests NVMe controller rescans the namespaces. The <device> param is mandatory and must -be an NVMe character device (ex: /dev/nvme0).

-
-

OPTIONS

-
-

None

-
-

EXAMPLES

-
-
    -
  • -

    -Rescans the nvme namespaces. -

    -
    -
    -
    # nvme ns-rescan /dev/nvme0
    -
    -
    • -
-
-

NVME

-
-

Part of the nvme-user suite

-
- - - + + + + + + +nvme-ns-rescan(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ns-rescan <device>
+
+
+
+
+
+

DESCRIPTION

+
+

Requests NVMe controller rescans the namespaces. The <device> param is mandatory and must +be an NVMe character device (ex: /dev/nvme0).

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Rescans the nvme namespaces. +

    +
    +
    +
    # nvme ns-rescan /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index ae7faf6..e36f3fe 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -2,12 +2,12 @@ .\" Title: nvme-read .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-reset.1 b/Documentation/nvme-reset.1 index 7b8f3de..31b6fc9 100644 --- a/Documentation/nvme-reset.1 +++ b/Documentation/nvme-reset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-reset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESET" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESET" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-acquire.1 b/Documentation/nvme-resv-acquire.1 index f96d127..a197225 100644 --- a/Documentation/nvme-resv-acquire.1 +++ b/Documentation/nvme-resv-acquire.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-acquire .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-ACQUIRE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-ACQUIRE" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 4a50513..d1bf4b8 100644 --- a/Documentation/nvme-resv-register.1 +++ b/Documentation/nvme-resv-register.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-register .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REGISTER" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REGISTER" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-release.1 b/Documentation/nvme-resv-release.1 index 1817e51..6cb872a 100644 --- a/Documentation/nvme-resv-release.1 +++ b/Documentation/nvme-resv-release.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-release .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-RELEASE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-RELEASE" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-report.1 b/Documentation/nvme-resv-report.1 index 7242f3a..5c77cd3 100644 --- a/Documentation/nvme-resv-report.1 +++ b/Documentation/nvme-resv-report.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-report .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REPORT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REPORT" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-report.html b/Documentation/nvme-resv-report.html index d34e6da..83655ae 100644 --- a/Documentation/nvme-resv-report.html +++ b/Documentation/nvme-resv-report.html @@ -1,9 +1,10 @@ + - + nvme-resv-report(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns changed-zone-list <device> [-o <fmt> | --output-format=<fmt>]
+                                      [--namespace-id=<NUM> | -n <NUM>]
+                                      [--rae | -r]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, requests the namespace’s changed zoned list log +and provides the result and 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, the returned list may be decoded and 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. +

+
+
+-r +
+
+--rae +
+
+

+ Retain an Asynchronous Event. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Get the changed zone list log for namespace 1 +

    +
    +
    +
    # nvme zns changed-zone-list /dev/nvme0 -n 1
    +
    +
    • +
  • +

    +Show the output in json format +

    +
    +
    +
    # nvme zns changed-zone-list /dev/nvme0 -o json -n 1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-changed-zone-list.txt b/Documentation/nvme-zns-changed-zone-list.txt new file mode 100644 index 0000000..9626c05 --- /dev/null +++ b/Documentation/nvme-zns-changed-zone-list.txt @@ -0,0 +1,54 @@ +nvme-zns-changed-zone-list(1) +============================= + +NAME +---- +nvme-zns-changed-zone-list - Retrieve Changed Zone log for the given device + +SYNOPSIS +-------- +[verse] +'nvme zns changed-zone-list' [-o | --output-format=] + [--namespace-id= | -n ] + [--rae | -r] + +DESCRIPTION +----------- +For the NVMe device given, requests the namespace's changed zoned list log +and provides the result and returned structure. + +The 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 list may be decoded and displayed in one of several +ways. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +-r:: +--rae:: + Retain an Asynchronous Event. + +EXAMPLES +-------- +* Get the changed zone list log for namespace 1 ++ +------------ +# nvme zns changed-zone-list /dev/nvme0 -n 1 +------------ ++ + +* Show the output in json format ++ +------------ +# nvme zns changed-zone-list /dev/nvme0 -o json -n 1 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-close-zone.1 b/Documentation/nvme-zns-close-zone.1 new file mode 100644 index 0000000..bcc0458 --- /dev/null +++ b/Documentation/nvme-zns-close-zone.1 @@ -0,0 +1,84 @@ +'\" t +.\" Title: nvme-zns-close-zone +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "06/16/2020" "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-zns-close-zone \- Closes one or all zones +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns close\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the "Close Zone" action\&. This will transition the zone to the closed state\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to close\&. +.RE +.PP +\-a, \-\-select\-all +.RS 4 +Select all zones for this action +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Close all zones on namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns close\-zone /dev/nvme0 \-a \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-close-zone.html b/Documentation/nvme-zns-close-zone.html new file mode 100644 index 0000000..d2e297a --- /dev/null +++ b/Documentation/nvme-zns-close-zone.html @@ -0,0 +1,841 @@ + + + + + + +nvme-zns-close-zone(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns close-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"Close Zone" action. This will transition the zone to the closed state.

+

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

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to close. +

+
+
+-a +
+
+--select-all +
+
+

+ Select all zones for this action +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Close all zones on namespace 1: +

    +
    +
    +
    # nvme zns close-zone /dev/nvme0 -a -n 1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-close-zone.txt b/Documentation/nvme-zns-close-zone.txt new file mode 100644 index 0000000..7b47bf0 --- /dev/null +++ b/Documentation/nvme-zns-close-zone.txt @@ -0,0 +1,49 @@ +nvme-zns-close-zone(1) +====================== + +NAME +---- +nvme-zns-close-zone - Closes one or all zones + +SYNOPSIS +-------- +[verse] +'nvme zns close-zone nvme zns id-ctrl' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--select-all | -a] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"Close Zone" action. This will transition the zone to the closed state. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to close. + +-a:: +--select-all:: + Select all zones for this action + +EXAMPLES +-------- +* Close all zones on namespace 1: ++ +------------ +# nvme zns close-zone /dev/nvme0 -a -n 1 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-finish-zone.1 b/Documentation/nvme-zns-finish-zone.1 new file mode 100644 index 0000000..5cc4f16 --- /dev/null +++ b/Documentation/nvme-zns-finish-zone.1 @@ -0,0 +1,84 @@ +'\" t +.\" Title: nvme-zns-finish-zone +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-FINISH\-Z" "1" "06/16/2020" "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-zns-finish-zone \- Finishes one or all zones +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns finish\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the "Finish Zone" action\&. This will transition the zone to the full state on success\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to finish\&. +.RE +.PP +\-a, \-\-select\-all +.RS 4 +Select all zones for this action\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Finish all zones on namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns finish\-zone /dev/nvme0 \-a \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-finish-zone.html b/Documentation/nvme-zns-finish-zone.html new file mode 100644 index 0000000..36b833f --- /dev/null +++ b/Documentation/nvme-zns-finish-zone.html @@ -0,0 +1,842 @@ + + + + + + +nvme-zns-finish-zone(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns finish-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"Finish Zone" action. This will transition the zone to the full state on +success.

+

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

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to finish. +

+
+
+-a +
+
+--select-all +
+
+

+ Select all zones for this action. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Finish all zones on namespace 1: +

    +
    +
    +
    # nvme zns finish-zone /dev/nvme0 -a -n 1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-finish-zone.txt b/Documentation/nvme-zns-finish-zone.txt new file mode 100644 index 0000000..9a9a2f0 --- /dev/null +++ b/Documentation/nvme-zns-finish-zone.txt @@ -0,0 +1,50 @@ +nvme-zns-finish-zone(1) +======================= + +NAME +---- +nvme-zns-finish-zone - Finishes one or all zones + +SYNOPSIS +-------- +[verse] +'nvme zns finish-zone nvme zns id-ctrl' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--select-all | -a] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"Finish Zone" action. This will transition the zone to the full state on +success. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to finish. + +-a:: +--select-all:: + Select all zones for this action. + +EXAMPLES +-------- +* Finish all zones on namespace 1: ++ +------------ +# nvme zns finish-zone /dev/nvme0 -a -n 1 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-id-ctrl.1 b/Documentation/nvme-zns-id-ctrl.1 new file mode 100644 index 0000000..fb91ffc --- /dev/null +++ b/Documentation/nvme-zns-id-ctrl.1 @@ -0,0 +1,98 @@ +'\" t +.\" Title: nvme-zns-id-ctrl +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-ID\-CTRL" "1" "06/16/2020" "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-zns-id-ctrl \- Send NVMe Zoned Command Set Identify Controller, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns id\-ctrl\fR [\-o | \-\-output\-format=] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the zoned command set\(cqs identify controller command and provides the result and returned 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 data structure returned by the device will be decoded and displayed in one of several ways\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program interpret the returned buffer and display the known fields in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns id\-ctrl /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 +.\} +Show the output in json format +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns id\-ctrl /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-id-ctrl.html b/Documentation/nvme-zns-id-ctrl.html new file mode 100644 index 0000000..cc892a5 --- /dev/null +++ b/Documentation/nvme-zns-id-ctrl.html @@ -0,0 +1,828 @@ + + + + + + +nvme-zns-id-ctrl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns id-ctrl <device> [-o <fmt> | --output-format=<fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the zoned command set’s identify controller +command and provides the result and 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, the data structure returned by the device will be decoded and +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. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program interpret the returned buffer and display the known +fields in a human readable format: +

    +
    +
    +
    # nvme zns id-ctrl /dev/nvme0
    +
    +
    • +
  • +

    +Show the output in json format +

    +
    +
    +
    # nvme zns id-ctrl /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-id-ctrl.txt b/Documentation/nvme-zns-id-ctrl.txt new file mode 100644 index 0000000..e7bd5ba --- /dev/null +++ b/Documentation/nvme-zns-id-ctrl.txt @@ -0,0 +1,50 @@ +nvme-zns-id-ctrl(1) +=================== + +NAME +---- +nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return + result and structure + +SYNOPSIS +-------- +[verse] +'nvme zns id-ctrl' [-o | --output-format=] + +DESCRIPTION +----------- +For the NVMe device given, sends the zoned command set's identify controller +command and provides the result and returned structure. + +The 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 data structure returned by the device will be decoded and +displayed in one of several ways. + +OPTIONS +------- +-o :: +--output-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 +fields in a human readable format: ++ +------------ +# nvme zns id-ctrl /dev/nvme0 +------------ ++ + +* Show the output in json format ++ +------------ +# nvme zns id-ctrl /dev/nvme0 -o json +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-id-ns.html b/Documentation/nvme-zns-id-ns.html new file mode 100644 index 0000000..45393db --- /dev/null +++ b/Documentation/nvme-zns-id-ns.html @@ -0,0 +1,854 @@ + + + + + + +nvme-zns-id-ctrl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns id-ctrl <device>  [--namespace-id=<NUM> | -n <NUM>]
+                             [-o <fmt> | --output-format=<fmt>]
+                             [-v | --verbose]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the zoned command set’s identify namepsace +command and provides the result and 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, the data structure returned by the device will be decoded and +displayed in one of several ways.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-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 +fields in a human readable format: +

    +
    +
    +
    # nvme zns id-ns /dev/nvme0 -n 1
    +
    +
    • +
  • +

    +Show the output in json format with extra details +

    +
    +
    +
    # nvme zns id-ctrl /dev/nvme0 -o json -v
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-id-ns.txt b/Documentation/nvme-zns-id-ns.txt new file mode 100644 index 0000000..3c7d51b --- /dev/null +++ b/Documentation/nvme-zns-id-ns.txt @@ -0,0 +1,62 @@ +nvme-zns-id-ctrl(1) +=================== + +NAME +---- +nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return + result and structure + +SYNOPSIS +-------- +[verse] +'nvme zns id-ctrl' [--namespace-id= | -n ] + [-o | --output-format=] + [-v | --verbose] + +DESCRIPTION +----------- +For the NVMe device given, sends the zoned command set's identify namepsace +command and provides the result and returned structure. + +The 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 data structure returned by the device will be decoded and +displayed in one of several ways. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-v:: +--verbose:: + Increase the information detail in the output. + +-o :: +--output-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 +fields in a human readable format: ++ +------------ +# nvme zns id-ns /dev/nvme0 -n 1 +------------ ++ + +* Show the output in json format with extra details ++ +------------ +# nvme zns id-ctrl /dev/nvme0 -o json -v +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-offline-zone.1 b/Documentation/nvme-zns-offline-zone.1 new file mode 100644 index 0000000..8f7a3b9 --- /dev/null +++ b/Documentation/nvme-zns-offline-zone.1 @@ -0,0 +1,84 @@ +'\" t +.\" Title: nvme-zns-offline-zone +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-OFFLINE\-" "1" "06/16/2020" "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-zns-offline-zone \- Offlines one or all zones +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns offline\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the "Offline Zone" action\&. This will transition the zone to the offlined state\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to offline\&. +.RE +.PP +\-a, \-\-select\-all +.RS 4 +Select all zones for this action +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Offline all zones on namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns offline\-zone /dev/nvme0 \-a \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-offline-zone.html b/Documentation/nvme-zns-offline-zone.html new file mode 100644 index 0000000..ae2da7f --- /dev/null +++ b/Documentation/nvme-zns-offline-zone.html @@ -0,0 +1,841 @@ + + + + + + +nvme-zns-offline-zone(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns offline-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"Offline Zone" action. This will transition the zone to the offlined state.

+

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

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to offline. +

+
+
+-a +
+
+--select-all +
+
+

+ Select all zones for this action +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Offline all zones on namespace 1: +

    +
    +
    +
    # nvme zns offline-zone /dev/nvme0 -a -n 1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-offline-zone.txt b/Documentation/nvme-zns-offline-zone.txt new file mode 100644 index 0000000..0a35235 --- /dev/null +++ b/Documentation/nvme-zns-offline-zone.txt @@ -0,0 +1,49 @@ +nvme-zns-offline-zone(1) +======================== + +NAME +---- +nvme-zns-offline-zone - Offlines one or all zones + +SYNOPSIS +-------- +[verse] +'nvme zns offline-zone nvme zns id-ctrl' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--select-all | -a] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"Offline Zone" action. This will transition the zone to the offlined state. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to offline. + +-a:: +--select-all:: + Select all zones for this action + +EXAMPLES +-------- +* Offline all zones on namespace 1: ++ +------------ +# nvme zns offline-zone /dev/nvme0 -a -n 1 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-open-zone.1 b/Documentation/nvme-zns-open-zone.1 new file mode 100644 index 0000000..0a15586 --- /dev/null +++ b/Documentation/nvme-zns-open-zone.1 @@ -0,0 +1,84 @@ +'\" t +.\" Title: nvme-zns-open-zone +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-OPEN\-ZON" "1" "06/16/2020" "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-zns-open-zone \- Opens one or all zones +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns open\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the "Open Zone" action\&. This will transition the zone to the opened state\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to open\&. +.RE +.PP +\-a, \-\-select\-all +.RS 4 +Select all zones for this action +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Open the first zone on namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns open\-zone /dev/nvme0 \-n 1 \-s 0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-open-zone.html b/Documentation/nvme-zns-open-zone.html new file mode 100644 index 0000000..5a648b2 --- /dev/null +++ b/Documentation/nvme-zns-open-zone.html @@ -0,0 +1,841 @@ + + + + + + +nvme-zns-open-zone(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns open-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"Open Zone" action. This will transition the zone to the opened state.

+

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

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to open. +

+
+
+-a +
+
+--select-all +
+
+

+ Select all zones for this action +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Open the first zone on namespace 1: +

    +
    +
    +
    # nvme zns open-zone /dev/nvme0 -n 1 -s 0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-open-zone.txt b/Documentation/nvme-zns-open-zone.txt new file mode 100644 index 0000000..23acf1c --- /dev/null +++ b/Documentation/nvme-zns-open-zone.txt @@ -0,0 +1,49 @@ +nvme-zns-open-zone(1) +====================== + +NAME +---- +nvme-zns-open-zone - Opens one or all zones + +SYNOPSIS +-------- +[verse] +'nvme zns open-zone nvme zns id-ctrl' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--select-all | -a] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"Open Zone" action. This will transition the zone to the opened state. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to open. + +-a:: +--select-all:: + Select all zones for this action + +EXAMPLES +-------- +* Open the first zone on namespace 1: ++ +------------ +# nvme zns open-zone /dev/nvme0 -n 1 -s 0 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-report-zones.1 b/Documentation/nvme-zns-report-zones.1 new file mode 100644 index 0000000..359a9ba --- /dev/null +++ b/Documentation/nvme-zns-report-zones.1 @@ -0,0 +1,198 @@ +'\" t +.\" Title: nvme-zns-report-zones +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-REPORT\-Z" "1" "06/16/2020" "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-zns-report-zones \- Retrieve and display the Report Zones data structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns report\-zones\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-descs= | \-d ] + [\-\-state= | \-S ] + [\-\-extended | \-e] + [\-\-partial | \-p] + [\-\-verbose | \-v] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the Zone Management Receive command with the Zone Receive Action set to either Report Zones or Extended Report Zones, depending on the \fIextended\fR option\&. +.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 data structure returned by the device will be decoded and displayed in one of several ways\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to begin the report +.RE +.PP +\-d , \-\-descs= +.RS 4 +The number of descriptors to request in the report\&. +.RE +.PP +\-S , \-\-state= +.RS 4 +The state of zones to request in the report\&. Known values include: +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Value +T}:T{ +Definition +T} +T{ +0 +T}:T{ +List all zones (default) +T} +T{ +1 +T}:T{ +Empty State +T} +T{ +2 +T}:T{ +Implicitly Opened State +T} +T{ +3 +T}:T{ +Explicitly Opened State +T} +T{ +4 +T}:T{ +Closed State +T} +T{ +5 +T}:T{ +Full State +T} +T{ +6 +T}:T{ +Read Only State +T} +T{ +7 +T}:T{ +Offline State +T} +.TE +.sp 1 +.RE +.PP +\-e, \-\-extended +.RS 4 +Request to use the Extended Report Zones option\&. The extended data is not decoded\&. +.RE +.PP +\-p, \-\-partial +.RS 4 +If set, the device will return the number of zones that match the state rather than the number of zones returned in the report\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.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 +.\} +Has the program interpret the report for 16 zones, and display the known fields in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns report\-zones /dev/nvme0 \-n 1 \-d 16 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Show the output in json format with extra details +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns report\-zones /dev/nvme0 \-n 1 \-d 16 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-report-zones.html b/Documentation/nvme-zns-report-zones.html new file mode 100644 index 0000000..fbdde5c --- /dev/null +++ b/Documentation/nvme-zns-report-zones.html @@ -0,0 +1,964 @@ + + + + + + +nvme-zns-report-zones(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns report-zones <device> [--namespace-id=<NUM> | -n <NUM>]
+                                 [--start-lba=<IONUM> | -s <IONUM>]
+                                 [--descs=<NUM> | -d <NUM>]
+                                 [--state=<NUM> | -S <NUM>]
+                                 [--extended | -e]
+                                 [--partial | -p]
+                                 [--verbose | -v]
+                                 [--output-format=<FMT> | -o <FMT>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the Zone Management Receive command with the +Zone Receive Action set to either Report Zones or Extended Report Zones, +depending on the extended option.

+

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 data structure returned by the device will be decoded and +displayed in one of several ways.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to begin the report +

+
+
+-d <NUM> +
+
+--descs=<NUM> +
+
+

+ The number of descriptors to request in the report. +

+
+
+-S <NUM> +
+
+--state=<NUM> +
+
+

+ The state of zones to request in the report. Known values include: +

+
+ +++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Value

Definition

0

List all zones (default)

1

Empty State

2

Implicitly Opened State

3

Explicitly Opened State

4

Closed State

5

Full State

6

Read Only State

7

Offline State

+
+
+
+-e +
+
+--extended +
+
+

+ Request to use the Extended Report Zones option. The extended data is + not decoded. +

+
+
+-p +
+
+--partial +
+
+

+ If set, the device will return the number of zones that match the state + rather than the number of zones returned in the report. +

+
+
+-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 report for 16 zones, and display the known +fields in a human readable format: +

    +
    +
    +
    # nvme zns report-zones /dev/nvme0 -n 1 -d 16
    +
    +
    • +
  • +

    +Show the output in json format with extra details +

    +
    +
    +
    # nvme zns report-zones /dev/nvme0 -n 1 -d 16 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-report-zones.txt b/Documentation/nvme-zns-report-zones.txt new file mode 100644 index 0000000..35d5eda --- /dev/null +++ b/Documentation/nvme-zns-report-zones.txt @@ -0,0 +1,102 @@ +nvme-zns-report-zones(1) +======================== + +NAME +---- +nvme-zns-report-zones - Retrieve and display the Report Zones data structure + +SYNOPSIS +-------- +[verse] +'nvme zns report-zones' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--descs= | -d ] + [--state= | -S ] + [--extended | -e] + [--partial | -p] + [--verbose | -v] + [--output-format= | -o ] + +DESCRIPTION +----------- +For the NVMe device given, sends the Zone Management Receive command with the +Zone Receive Action set to either Report Zones or Extended Report Zones, +depending on the 'extended' option. + +The 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 data structure returned by the device will be decoded and +displayed in one of several ways. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to begin the report + +-d :: +--descs=:: + The number of descriptors to request in the report. + +-S :: +--state=:: + The state of zones to request in the report. Known values include: ++ +[] +|================= +|Value|Definition +|0|List all zones (default) +|1|Empty State +|2|Implicitly Opened State +|3|Explicitly Opened State +|4|Closed State +|5|Full State +|6|Read Only State +|7|Offline State +|================= + +-e:: +--extended:: + Request to use the Extended Report Zones option. The extended data is + not decoded. + +-p:: +--partial:: + If set, the device will return the number of zones that match the state + rather than the number of zones returned in the report. + +-v:: +--verbose:: + Increase the information detail in the output. + +-o :: +--output-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 report for 16 zones, and display the known +fields in a human readable format: ++ +------------ +# nvme zns report-zones /dev/nvme0 -n 1 -d 16 +------------ ++ + +* Show the output in json format with extra details ++ +------------ +# nvme zns report-zones /dev/nvme0 -n 1 -d 16 -o json +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-reset-zone.1 b/Documentation/nvme-zns-reset-zone.1 new file mode 100644 index 0000000..72a79ef --- /dev/null +++ b/Documentation/nvme-zns-reset-zone.1 @@ -0,0 +1,84 @@ +'\" t +.\" Title: nvme-zns-reset-zone +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-RESET\-ZO" "1" "06/16/2020" "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-zns-reset-zone \- Resets one or all zones +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns reset\-zone\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the "Reset Zone" action\&. This will transition the zone to the empty state, setting the write pointer for each zone back to the beginning on success\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to reset\&. +.RE +.PP +\-a, \-\-select\-all +.RS 4 +Select all zones for this action +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Reset the first zone on namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns reset\-zone /dev/nvme0 \-n 1 \-s 0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-reset-zone.html b/Documentation/nvme-zns-reset-zone.html new file mode 100644 index 0000000..46545b2 --- /dev/null +++ b/Documentation/nvme-zns-reset-zone.html @@ -0,0 +1,842 @@ + + + + + + +nvme-zns-reset-zone(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns reset-zone <device> [--namespace-id=<NUM> | -n <NUM>]
+                               [--start-lba=<LBA> | -s <LBA>]
+                               [--select-all | -a]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"Reset Zone" action. This will transition the zone to the empty state, setting +the write pointer for each zone back to the beginning on success.

+

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

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to reset. +

+
+
+-a +
+
+--select-all +
+
+

+ Select all zones for this action +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Reset the first zone on namespace 1: +

    +
    +
    +
    # nvme zns reset-zone /dev/nvme0 -n 1 -s 0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-reset-zone.txt b/Documentation/nvme-zns-reset-zone.txt new file mode 100644 index 0000000..a04fd66 --- /dev/null +++ b/Documentation/nvme-zns-reset-zone.txt @@ -0,0 +1,50 @@ +nvme-zns-reset-zone(1) +====================== + +NAME +---- +nvme-zns-reset-zone - Resets one or all zones + +SYNOPSIS +-------- +[verse] +'nvme zns reset-zone' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--select-all | -a] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"Reset Zone" action. This will transition the zone to the empty state, setting +the write pointer for each zone back to the beginning on success. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to reset. + +-a:: +--select-all:: + Select all zones for this action + +EXAMPLES +-------- +* Reset the first zone on namespace 1: ++ +------------ +# nvme zns reset-zone /dev/nvme0 -n 1 -s 0 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1 new file mode 100644 index 0000000..49f06e5 --- /dev/null +++ b/Documentation/nvme-zns-set-zone-desc.1 @@ -0,0 +1,82 @@ +'\" t +.\" Title: nvme-zns-set-zone-desc +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-SET\-ZONE" "1" "06/16/2020" "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-zns-set-zone-desc \- Set extended descriptor data for a zone +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns setzone\-desc\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba=, \-s ] + [\-data=, \-d ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the Set Zone Descriptor Extenions action\&. The input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&. The data length will automatically be calculated from the zns identify namesapce\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to manage send\&. +.RE +.PP +\-d +.RS 4 +Optional file for data (default stdin) +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data) +.sp +.if n \{\ +.RS 4 +.\} +.nf +# echo "hello world" | nvme zns set\-zone\-desc /dev/nvme0 \-n 1 \-s 0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-set-zone-desc.html b/Documentation/nvme-zns-set-zone-desc.html new file mode 100644 index 0000000..b69be1f --- /dev/null +++ b/Documentation/nvme-zns-set-zone-desc.html @@ -0,0 +1,842 @@ + + + + + + +nvme-zns-set-zone-desc(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns setzone-desc <device> [--namespace-id=<NUM> | -n <NUM>]
+                                 [--start-lba=<IONUM>, -s <IONUM>]
+                                 [-data=<FILE>, -d <FILE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +Set Zone Descriptor Extenions action. The input will default to stdin. +Alternatively, the data may come from a file that can be specified. The data +length will automatically be calculated from the zns identify namesapce.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to manage send. +

+
+
+-d <FILE +
+
+-data=<FILE> +
+
+

+ Optional file for data (default stdin) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Write "hello world" into the zone descriptor for namespace 1’s first zone + (requires device supports a large enough zone extended data) +

    +
    +
    +
    # echo "hello world" | nvme zns set-zone-desc /dev/nvme0 -n 1 -s 0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-set-zone-desc.txt b/Documentation/nvme-zns-set-zone-desc.txt new file mode 100644 index 0000000..5df3ecb --- /dev/null +++ b/Documentation/nvme-zns-set-zone-desc.txt @@ -0,0 +1,50 @@ +nvme-zns-set-zone-desc(1) +========================= + +NAME +---- +nvme-zns-set-zone-desc - Set extended descriptor data for a zone + +SYNOPSIS +-------- +[verse] +'nvme zns setzone-desc' [--namespace-id= | -n ] + [--start-lba=, -s ] + [-data=, -d ] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +Set Zone Descriptor Extenions action. The input will default to stdin. +Alternatively, the data may come from a file that can be specified. The data +length will automatically be calculated from the zns identify namesapce. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to manage send. + +-d :: + Optional file for data (default stdin) + + +EXAMPLES +-------- +* Write "hello world" into the zone descriptor for namespace 1's first zone + (requires device supports a large enough zone extended data) ++ +------------ +# echo "hello world" | nvme zns set-zone-desc /dev/nvme0 -n 1 -s 0 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-zone-append.1 b/Documentation/nvme-zns-zone-append.1 new file mode 100644 index 0000000..92acf28 --- /dev/null +++ b/Documentation/nvme-zns-zone-append.1 @@ -0,0 +1,133 @@ +'\" t +.\" Title: nvme-zns-zone-append +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-ZONE\-APP" "1" "06/16/2020" "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-zns-zone-append \- Send an NVMe write command, provide results +.SH "SYNOPSIS" +.sp +.nf +\fInvme\-zns\-zone\-append\fR [\-\-namespace\-id= | \-n ] + [\-\-zslba= | \-s ] + [\-\-data\-size= | \-z ] + [\-\-metadata\-size= | \-y ] + [\-\-data= | \-d ] + [\-\-metadata= | \-M ] + [\-\-limited\-retry | \-l] + [\-\-force\-unit\-access | \-f] + [\-\-ref\-tag= | \-r ] + [\-\-app\-tag\-mask= | \-m ] + [\-\-app\-tag= | \-a ] + [\-\-prinfo= | \-p ] +.fi +.SH "DESCRIPTION" +.sp +The zone append 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\&. +.sp +On sucess, the program will report the LBA that was assigned to the data for the append operation\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-zslba=, \-z , \-\-data\-size= +.RS 4 +Size of data, in bytes\&. +.RE +.PP +\-y , \-\-metadata\-size= +.RS 4 +Size of metadata in bytes\&. +.RE +.PP +\-d , \-\-data= +.RS 4 +Data file providing the data to write\&. If none provided, contents are sent from STDIN\&. +.RE +.PP +\-M , \-\-metadata= +.RS 4 +Metadata file, if necessary\&. +.RE +.PP +\-l, \-\-limited\-retry +.RS 4 +Sets the limited retry flag\&. +.RE +.PP +\-f, \-\-force\-unit\-access +.RS 4 +Set the force\-unit access flag\&. +.RE +.PP +\-r , \-\-ref\-tag= +.RS 4 +Optional reftag when used with protection information\&. +.RE +.PP +\-m , \-\-app\-tag\-mask= +.RS 4 +Optional application tag mask when used with protection information\&. +.RE +.PP +\-a , \-\-app\-tag= +.RS 4 +Optional application tag when used with protection information\&. +.RE +.PP +\-p , \-\-prinfo= +.RS 4 +Protection Information field definition\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Append the data "hello world" into 4k worth of blocks into the zone starting at block 0 for namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# echo "hello world" | nvme zns zone\-append /dev/nvme0 \-n 1 \-s 0 \-z 4k +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-zns-zone-append.html b/Documentation/nvme-zns-zone-append.html new file mode 100644 index 0000000..5acc06a --- /dev/null +++ b/Documentation/nvme-zns-zone-append.html @@ -0,0 +1,947 @@ + + + + + + +nvme-zns-zone-append(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme-zns-zone-append <device> [--namespace-id=<NUM> | -n <NUM>]
+                                [--zslba=<IONUM> | -s <IONUM>]
+                                [--data-size=<IONUM> | -z <IONUM>]
+                                [--metadata-size=<IONUM> | -y <IONUM>]
+                                [--data=<FILE> | -d <FILE>]
+                                [--metadata=<FILE> | -M <FILE>]
+                                [--limited-retry | -l]
+                                [--force-unit-access | -f]
+                                [--ref-tag=<NUM> | -r <NUM>]
+                                [--app-tag-mask=<NUM> | -m <NUM>]
+                                [--app-tag=<NUM> | -a <NUM>]
+                                [--prinfo=<NUM> | -p <NUM>]
+
+
+
+
+
+

DESCRIPTION

+
+

The zone append 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’t provide a file.

+

On sucess, the program will report the LBA that was assigned to the data for +the append operation.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <IONUM> +
+
+--zslba=<IONUM> +
+
+-z <IONUM> +
+
+--data-size=<IONUM> +
+
+

+ Size of data, in bytes. +

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

+ Size of metadata in bytes. +

+
+
+-d <FILE> +
+
+--data=<FILE> +
+
+

+ Data file providing the data to write. If none provided, contents are + sent from STDIN. +

+
+
+-M <FILE> +
+
+--metadata=<FILE> +
+
+

+ Metadata file, if necessary. +

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

+ Sets the limited retry flag. +

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

+ Set the force-unit access flag. +

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

+ Optional reftag when used with protection information. +

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

+ Optional application tag mask when used with protection information. +

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

+ Optional application tag when used with protection information. +

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

+ Protection Information field definition. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Append the data "hello world" into 4k worth of blocks into the zone starting + at block 0 for namespace 1: +

    +
    +
    +
    # echo "hello world" | nvme zns zone-append /dev/nvme0 -n 1 -s 0 -z 4k
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-zone-append.txt b/Documentation/nvme-zns-zone-append.txt new file mode 100644 index 0000000..37242a5 --- /dev/null +++ b/Documentation/nvme-zns-zone-append.txt @@ -0,0 +1,96 @@ +nvme-zns-zone-append(1) +======================= + +NAME +---- +nvme-zns-zone-append - Send an NVMe write command, provide results + +SYNOPSIS +-------- +[verse] +'nvme-zns-zone-append' [--namespace-id= | -n ] + [--zslba= | -s ] + [--data-size= | -z ] + [--metadata-size= | -y ] + [--data= | -d ] + [--metadata= | -M ] + [--limited-retry | -l] + [--force-unit-access | -f] + [--ref-tag= | -r ] + [--app-tag-mask= | -m ] + [--app-tag= | -a ] + [--prinfo= | -p ] + +DESCRIPTION +----------- +The zone append 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't provide a file. + +On sucess, the program will report the LBA that was assigned to the data for +the append operation. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--zslba=:: + +-z :: +--data-size=:: + Size of data, in bytes. + +-y :: +--metadata-size=:: + Size of metadata in bytes. + +-d :: +--data=:: + Data file providing the data to write. If none provided, contents are + sent from STDIN. + +-M :: +--metadata=:: + Metadata file, if necessary. + +-l:: +--limited-retry:: + Sets the limited retry flag. + +-f:: +--force-unit-access:: + Set the force-unit access flag. + +-r :: +--ref-tag=:: + Optional reftag when used with protection information. + +-m :: +--app-tag-mask=:: + Optional application tag mask when used with protection information. + +-a :: +--app-tag=:: + Optional application tag when used with protection information. + +-p :: +--prinfo=:: + Protection Information field definition. + +EXAMPLES +-------- +* Append the data "hello world" into 4k worth of blocks into the zone starting + at block 0 for namespace 1: ++ +------------ +# echo "hello world" | nvme zns zone-append /dev/nvme0 -n 1 -s 0 -z 4k +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-zns-zone-mgmt-recv.1 b/Documentation/nvme-zns-zone-mgmt-recv.1 new file mode 100644 index 0000000..d165727 --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-recv.1 @@ -0,0 +1,121 @@ +'\" t +.\" Title: nvme-zns-zone-mgmt-recv +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/16/2020" "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-zns-zone-mgmt-recv \- Zone Management Receive command +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns zone\-mgmt\-recv\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-data\-len=, \-l ] + [\-\-zra=, \-z ] + [\-\-zrasf=, \-a ] + [\-\-zra\-spec\-feat, \-f] + [\-\-output\-format=, \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Receive command with the requested receive action and additional action specific parameters\&. This is the generic interface provided for forward compatibility as new actions are created that this program isn\(cqt aware of at the time of its development\&. As such, this is a generic command that does not do any additional decoding for specific types of data received\&. This will only report the data as a hex dump, or binary\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to manage receive\&. +.RE +.sp +\-\-data\-len= \-l Received data buffer length +.PP +\-z , \-\-zra= +.RS 4 +Zone Receive Action +.RE +.sp +\-a \-\-zrasf= Zone Receive Action Specific field +.PP +\-f, \-\-zra\-spec\-feat +.RS 4 +Enable Zone Receive Action Specific features +.RE +.PP +\-o , \-\-output\-format= +.RS 4 +Output format: normal|json|binary +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Hex dump of a report all zones +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns zone\-mgmt\-recv /dev/nvme0 \-n 1 \-s 0 \-z 0 \-a 0 \-l 4k +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Binary dump of a report all zones +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns zone\-mgmt\-recv /dev/nvme0 \-n 1 \-s 0 \-z 0 \-a 0 \-o \-l 4k binary > report\&.out +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-zone-mgmt-recv.html b/Documentation/nvme-zns-zone-mgmt-recv.html new file mode 100644 index 0000000..74d6a8d --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-recv.html @@ -0,0 +1,889 @@ + + + + + + +nvme-zns-zone-mgmt-recv(1) + + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Receive command with the +requested receive action and additional action specific parameters. This is the +generic interface provided for forward compatibility as new actions are created +that this program isn’t aware of at the time of its development. As such, this +is a generic command that does not do any additional decoding for specific +types of data received. This will only report the data as a hex dump, or +binary.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to manage receive. +

+
+
+

--data-len=<NUM> +-l <NUM> + Received data buffer length

+
+
+-z <NUM> +
+
+--zra=<NUM> +
+
+

+ Zone Receive Action +

+
+
+

-a <NUM> +--zrasf=<NUM> + Zone Receive Action Specific field

+
+
+-f +
+
+--zra-spec-feat +
+
+

+ Enable Zone Receive Action Specific features +

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

+ Output format: normal|json|binary +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Hex dump of a report all zones +

    +
    +
    +
    # nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k
    +
    +
    • +
  • +

    +Binary dump of a report all zones +

    +
    +
    +
    # nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-zone-mgmt-recv.txt b/Documentation/nvme-zns-zone-mgmt-recv.txt new file mode 100644 index 0000000..07cd98e --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-recv.txt @@ -0,0 +1,78 @@ +nvme-zns-zone-mgmt-recv(1) +========================== + +NAME +---- +nvme-zns-zone-mgmt-recv - Zone Management Receive command + +SYNOPSIS +-------- +[verse] +'nvme zns zone-mgmt-recv' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--data-len=, -l ] + [--zra=, -z ] + [--zrasf=, -a ] + [--zra-spec-feat, -f] + [--output-format=, -o ] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Receive command with the +requested receive action and additional action specific parameters. This is the +generic interface provided for forward compatibility as new actions are created +that this program isn't aware of at the time of its development. As such, this +is a generic command that does not do any additional decoding for specific +types of data received. This will only report the data as a hex dump, or +binary. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to manage receive. + +--data-len= +-l + Received data buffer length + +-z :: +--zra=:: + Zone Receive Action + +-a +--zrasf= + Zone Receive Action Specific field + +-f:: +--zra-spec-feat:: + Enable Zone Receive Action Specific features + +-o :: +--output-format=:: + Output format: normal|json|binary + +EXAMPLES +-------- +* Hex dump of a report all zones ++ +------------ +# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k +------------ ++ + +* Binary dump of a report all zones ++ +------------ +# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-zns-zone-mgmt-send.1 b/Documentation/nvme-zns-zone-mgmt-send.1 new file mode 100644 index 0000000..32f8139 --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-send.1 @@ -0,0 +1,126 @@ +'\" t +.\" Title: nvme-zns-zone-mgmt-send +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/16/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/16/2020" "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-zns-zone-mgmt-send \- Zone Management Send command +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns zone\-mgmt\-send\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba=, \-s ] + [\-\-select\-all, \-a] + [\-\-zsa=, \-z ] + [\-\-data\-len=, \-l ] + [\-data=, \-d ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the requested send action\&. If the send requires additional data, you may specify the data length\&. If data is required, the input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&. +.RE +.PP +\-s , \-\-start\-lba= +.RS 4 +The starting LBA of the zone to manage send\&. +.RE +.PP +\-l , \-\-data\-len= +.RS 4 +Send data buffer length +.RE +.PP +\-\-select\-all, \-a +.RS 4 +Send command to all zones +.RE +.PP +\-z , \-\-zsa= +.RS 4 +Zone send action\&. +.RE +.PP +\-l , \-\-data\-len= +.RS 4 +Buffer length if data required +.RE +.PP +\-d +.RS 4 +Optional file for data (default stdin) +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Send a zone management command with action set to 1 (close zone) to namespace 1\(cqs first zone: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data) +.sp +.if n \{\ +.RS 4 +.\} +.nf +# echo "hello world" | nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 0x10 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-zone-mgmt-send.html b/Documentation/nvme-zns-zone-mgmt-send.html new file mode 100644 index 0000000..6305707 --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-send.html @@ -0,0 +1,899 @@ + + + + + + +nvme-zns-zone-mgmt-send(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns zone-mgmt-send <device> [--namespace-id=<NUM> | -n <NUM>]
+                                   [--start-lba=<IONUM>, -s <IONUM>]
+                                   [--select-all, -a]
+                                   [--zsa=<NUM>, -z <NUM>]
+                                   [--data-len=<IONUM>, -l <IONUM>]
+                                   [-data=<FILE>, -d <FILE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +requested send action. If the send requires additional data, you may specify +the data length. If data is required, the input will default to stdin. +Alternatively, the data may come from a file that can be specified.

+
+
+
+

OPTIONS

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

+ Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. +

+
+
+-s <lba> +
+
+--start-lba=<lba> +
+
+

+ The starting LBA of the zone to manage send. +

+
+
+-l <NUM> +
+
+--data-len=<NUM> +
+
+

+ Send data buffer length +

+
+
+--select-all +
+
+-a +
+
+

+ Send command to all zones +

+
+
+-z <NUM> +
+
+--zsa=<NUM> +
+
+

+ Zone send action. +

+
+
+-l <IONUM> +
+
+--data-len=<IONUM> +
+
+

+ Buffer length if data required +

+
+
+-d <FILE +
+
+-data=<FILE> +
+
+

+ Optional file for data (default stdin) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Send a zone management command with action set to 1 (close zone) to namespace + 1’s first zone: +

    +
    +
    +
    # nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 1
    +
    +
    • +
  • +

    +Write "hello world" into the zone descriptor for namespace 1’s first zone + (requires device supports a large enough zone extended data) +

    +
    +
    +
    # echo "hello world" | nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 0x10
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-zone-mgmt-send.txt b/Documentation/nvme-zns-zone-mgmt-send.txt new file mode 100644 index 0000000..e33b9a5 --- /dev/null +++ b/Documentation/nvme-zns-zone-mgmt-send.txt @@ -0,0 +1,77 @@ +nvme-zns-zone-mgmt-send(1) +========================== + +NAME +---- +nvme-zns-zone-mgmt-send - Zone Management Send command + +SYNOPSIS +-------- +[verse] +'nvme zns zone-mgmt-send' [--namespace-id= | -n ] + [--start-lba=, -s ] + [--select-all, -a] + [--zsa=, -z ] + [--data-len=, -l ] + [-data=, -d ] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +requested send action. If the send requires additional data, you may specify +the data length. If data is required, the input will default to stdin. +Alternatively, the data may come from a file that can be specified. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-s :: +--start-lba=:: + The starting LBA of the zone to manage send. + +-l :: +--data-len=:: + Send data buffer length + +--select-all:: +-a:: + Send command to all zones + +-z :: +--zsa=:: + Zone send action. + +-l :: +--data-len=:: + Buffer length if data required + +-d :: + Optional file for data (default stdin) + + +EXAMPLES +-------- +* Send a zone management command with action set to 1 (close zone) to namespace + 1's first zone: ++ +------------ +# nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 1 +------------ ++ + +* Write "hello world" into the zone descriptor for namespace 1's first zone + (requires device supports a large enough zone extended data) ++ +------------ +# echo "hello world" | nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 0x10 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index 55dbfc8..5c5c531 100644 --- a/Documentation/nvme.1 +++ b/Documentation/nvme.1 @@ -2,12 +2,12 @@ .\" Title: nvme .\" Author: [see the "Authors" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 06/16/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME" "1" "06/16/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- -- 2.49.0