From 34a0d157ae6bd4f1912850ce535badddad890b27 Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Sat, 21 Oct 2023 04:25:27 +0900 Subject: [PATCH] doc: Add nvme commands --output-format and --verbose options Signed-off-by: Tokunori Ikegami --- Documentation/nvme-admin-passthru.txt | 42 +++++---- Documentation/nvme-ana-log.txt | 17 ++-- Documentation/nvme-attach-ns.txt | 12 ++- Documentation/nvme-boot-part-log.txt | 18 ++-- Documentation/nvme-capacity-mgmt.txt | 20 +++- Documentation/nvme-changed-ns-list-log.txt | 16 ++-- Documentation/nvme-check-dhchap-key.txt | 12 ++- Documentation/nvme-check-tls-key.txt | 20 +++- Documentation/nvme-cmdset-ind-id-ns.txt | 16 ++-- Documentation/nvme-compare.txt | 15 ++- Documentation/nvme-config.txt | 65 +++++++------ Documentation/nvme-connect-all.txt | 79 ++++++++-------- Documentation/nvme-connect.txt | 73 +++++++------- Documentation/nvme-copy.txt | 42 +++++---- Documentation/nvme-create-ns.txt | 14 ++- Documentation/nvme-delete-ns.txt | 10 ++ Documentation/nvme-dera-stat.txt | 1 - Documentation/nvme-detach-ns.txt | 12 ++- Documentation/nvme-device-self-test.txt | 24 +++-- Documentation/nvme-dim.txt | 19 +++- Documentation/nvme-dir-receive.txt | 30 +++--- Documentation/nvme-dir-send.txt | 32 ++++--- Documentation/nvme-disconnect-all.txt | 13 ++- Documentation/nvme-disconnect.txt | 18 +++- Documentation/nvme-discover.txt | 94 +++++++++---------- Documentation/nvme-dsm.txt | 24 +++-- Documentation/nvme-effects-log.txt | 24 +++-- .../nvme-endurance-event-agg-log.txt | 24 +++-- Documentation/nvme-endurance-log.txt | 14 ++- Documentation/nvme-error-log.txt | 17 ++-- Documentation/nvme-fdp-configs.txt | 9 +- Documentation/nvme-fdp-events.txt | 10 +- Documentation/nvme-fdp-set-events.txt | 9 +- Documentation/nvme-fdp-stats.txt | 9 +- Documentation/nvme-fdp-status.txt | 9 +- Documentation/nvme-fdp-update.txt | 2 +- Documentation/nvme-fdp-usage.txt | 9 +- .../nvme-fid-support-effects-log.txt | 16 ++-- Documentation/nvme-flush.txt | 10 ++ Documentation/nvme-format.txt | 25 +++-- Documentation/nvme-fw-commit.txt | 14 ++- Documentation/nvme-fw-download.txt | 14 ++- Documentation/nvme-fw-log.txt | 13 ++- Documentation/nvme-gen-dhchap-key.txt | 16 +++- Documentation/nvme-gen-hostnqn.txt | 11 ++- Documentation/nvme-gen-tls-key.txt | 22 +++-- Documentation/nvme-get-feature.txt | 22 +++-- Documentation/nvme-get-lba-status.txt | 24 +++-- Documentation/nvme-get-log.txt | 32 ++++--- Documentation/nvme-get-ns-id.txt | 11 ++- Documentation/nvme-get-property.txt | 16 +++- Documentation/nvme-huawei-id-ctrl.txt | 12 +-- Documentation/nvme-huawei-list.txt | 6 +- Documentation/nvme-id-ctrl.txt | 16 ++-- Documentation/nvme-id-domain.txt | 14 ++- Documentation/nvme-id-iocs.txt | 14 ++- Documentation/nvme-id-ns-lba-format.txt | 16 ++-- Documentation/nvme-id-ns.txt | 20 ++-- Documentation/nvme-id-nvmset.txt | 18 ++-- Documentation/nvme-inspur-nvme-vendor-log.txt | 1 - Documentation/nvme-intel-id-ctrl.txt | 12 +-- Documentation/nvme-intel-internal-log.txt | 1 - Documentation/nvme-intel-smart-log-add.txt | 8 +- Documentation/nvme-io-mgmt-recv.txt | 16 +++- Documentation/nvme-io-mgmt-send.txt | 16 +++- Documentation/nvme-io-passthru.txt | 40 ++++---- Documentation/nvme-lba-status-log.txt | 15 ++- Documentation/nvme-list-ctrl.txt | 16 +++- Documentation/nvme-list-endgrp.txt | 23 +++-- Documentation/nvme-list-ns.txt | 15 ++- Documentation/nvme-list-subsys.txt | 14 ++- Documentation/nvme-list.txt | 11 +-- Documentation/nvme-lockdown.txt | 22 +++-- Documentation/nvme-media-unit-stat-log.txt | 18 ++-- .../nvme-mi-cmd-support-effects-log.txt | 20 ++-- Documentation/nvme-micron-internal-log.txt | 18 ++-- .../nvme-micron-selective-download.txt | 31 +++--- Documentation/nvme-micron-smart-add-log.txt | 6 +- Documentation/nvme-netapp-ontapdevices.txt | 6 +- Documentation/nvme-netapp-smdevices.txt | 2 +- Documentation/nvme-ns-descs.txt | 16 ++-- Documentation/nvme-ns-rescan.txt | 11 ++- Documentation/nvme-nvm-id-ctrl.txt | 14 ++- Documentation/nvme-nvm-id-ns-lba-format.txt | 13 ++- Documentation/nvme-nvm-id-ns.txt | 13 ++- Documentation/nvme-nvme-mi-recv.txt | 21 +++-- Documentation/nvme-nvme-mi-send.txt | 21 +++-- .../nvme-ocp-clear-fw-activate-history.txt | 2 +- ...-clear-pcie-correctable-error-counters.txt | 2 +- .../nvme-ocp-device-capability-log.txt | 4 +- .../nvme-ocp-eol-plp-failure-mode.txt | 15 +-- Documentation/nvme-ocp-error-recovery-log.txt | 4 +- .../nvme-ocp-latency-monitor-log.txt | 4 +- .../nvme-ocp-set-dssd-power-state-feature.txt | 9 +- Documentation/nvme-ocp-smart-add-log.txt | 4 +- .../nvme-ocp-unsupported-reqs-log-pages.txt | 4 +- Documentation/nvme-persistent-event-log.txt | 39 ++++---- Documentation/nvme-phy-rx-eom-log.txt | 25 +++-- Documentation/nvme-pred-lat-event-agg-log.txt | 23 ++--- Documentation/nvme-predictable-lat-log.txt | 22 +++-- Documentation/nvme-primary-ctrl-caps.txt | 16 ++-- Documentation/nvme-read.txt | 43 +++++---- Documentation/nvme-reset.txt | 11 ++- Documentation/nvme-resv-acquire.txt | 21 +++-- Documentation/nvme-resv-notif-log.txt | 16 ++-- Documentation/nvme-resv-register.txt | 19 +++- Documentation/nvme-resv-release.txt | 17 +++- Documentation/nvme-resv-report.txt | 16 ++-- Documentation/nvme-rpmb.txt | 26 +++-- Documentation/nvme-sanitize-log.txt | 28 +++--- Documentation/nvme-sanitize.txt | 84 +++++++++-------- ...nvme-seagate-clear-fw-activate-history.txt | 4 +- ...-seagate-clear-pcie-correctable-errors.txt | 6 +- Documentation/nvme-seagate-get-ctrl-tele.txt | 6 +- Documentation/nvme-seagate-get-host-tele.txt | 15 +-- .../nvme-seagate-vs-fw-activate-history.txt | 6 +- .../nvme-seagate-vs-internal-log.txt | 13 +-- .../nvme-seagate-vs-log-page-sup.txt | 8 +- Documentation/nvme-seagate-vs-pcie-stats.txt | 8 +- .../nvme-seagate-vs-smart-add-log.txt | 10 +- .../nvme-seagate-vs-temperature-stats.txt | 8 +- Documentation/nvme-security-recv.txt | 21 +++-- Documentation/nvme-security-send.txt | 20 +++- Documentation/nvme-self-test-log.txt | 13 ++- Documentation/nvme-set-feature.txt | 21 +++-- Documentation/nvme-set-property.txt | 15 ++- Documentation/nvme-show-hostnqn.txt | 13 ++- Documentation/nvme-show-regs.txt | 18 ++-- Documentation/nvme-show-topology.txt | 15 ++- Documentation/nvme-smart-log.txt | 14 ++- Documentation/nvme-subsystem-reset.txt | 10 +- .../nvme-supported-cap-config-log.txt | 23 +++-- Documentation/nvme-supported-log-pages.txt | 14 +-- Documentation/nvme-telemetry-log.txt | 12 ++- ...-toshiba-clear-pcie-correctable-errors.txt | 2 - .../nvme-toshiba-vs-internal-log.txt | 2 - .../nvme-toshiba-vs-smart-add-log.txt | 11 +-- Documentation/nvme-transcend-badblock.txt | 1 - Documentation/nvme-transcend-healthvalue.txt | 7 +- Documentation/nvme-verify.txt | 47 ++++++---- .../nvme-virtium-save-smart-to-vtview-log.txt | 42 +++++---- Documentation/nvme-virtium-show-identify.txt | 5 +- Documentation/nvme-wdc-cap-diag.txt | 2 +- Documentation/nvme-wdc-clear-assert-dump.txt | 1 - .../nvme-wdc-clear-fw-activate-history.txt | 1 - ...nvme-wdc-clear-pcie-correctable-errors.txt | 1 - Documentation/nvme-wdc-drive-essentials.txt | 10 +- Documentation/nvme-wdc-drive-log.txt | 1 - Documentation/nvme-wdc-enc-get-log.txt | 18 ++-- .../nvme-wdc-get-dev-capabilities-log.txt | 9 +- Documentation/nvme-wdc-get-drive-status.txt | 12 +-- .../nvme-wdc-get-error-recovery-log.txt | 6 +- .../nvme-wdc-get-latency-monitor-log.txt | 4 +- .../nvme-wdc-get-unsupported-reqs-log.txt | 4 +- Documentation/nvme-wdc-id-ctrl.txt | 14 +-- Documentation/nvme-wdc-log-page-directory.txt | 6 +- Documentation/nvme-wdc-namespace-resize.txt | 22 ++--- Documentation/nvme-wdc-purge-monitor.txt | 1 - .../nvme-wdc-set-latency-monitor-feature.txt | 63 +++++++------ Documentation/nvme-wdc-vs-cloud-log.txt | 4 +- Documentation/nvme-wdc-vs-device-waf.txt | 4 +- Documentation/nvme-wdc-vs-drive-info.txt | 2 - .../nvme-wdc-vs-error-reason-identifier.txt | 6 +- .../nvme-wdc-vs-fw-activate-history.txt | 9 +- Documentation/nvme-wdc-vs-hw-rev-log.txt | 4 +- Documentation/nvme-wdc-vs-internal-log.txt | 46 +++++---- Documentation/nvme-wdc-vs-nand-stats.txt | 4 +- Documentation/nvme-wdc-vs-smart-add-log.txt | 25 ++--- ...vme-wdc-vs-telemetry-controller-option.txt | 16 ++-- Documentation/nvme-write-uncor.txt | 16 +++- Documentation/nvme-write-zeroes.txt | 40 ++++---- Documentation/nvme-write.txt | 51 +++++----- Documentation/nvme-zns-changed-zone-list.txt | 13 ++- Documentation/nvme-zns-id-ctrl.txt | 12 +-- Documentation/nvme-zns-id-ns.txt | 17 ++-- Documentation/nvme-zns-open-zone.txt | 6 +- Documentation/nvme-zns-report-zones.txt | 10 +- Documentation/nvme-zns-reset-zone.txt | 6 +- Documentation/nvme-zns-set-zone-desc.txt | 12 +-- Documentation/nvme-zns-zone-mgmt-recv.txt | 16 ++-- Documentation/nvme-zns-zone-mgmt-send.txt | 16 ++-- Documentation/nvme-zns-zrwa-flush-zone.txt | 4 +- 182 files changed, 1824 insertions(+), 1210 deletions(-) diff --git a/Documentation/nvme-admin-passthru.txt b/Documentation/nvme-admin-passthru.txt index 796d446e..22559dbc 100644 --- a/Documentation/nvme-admin-passthru.txt +++ b/Documentation/nvme-admin-passthru.txt @@ -9,22 +9,23 @@ SYNOPSIS -------- [verse] 'nvme-admin-passthru' [--opcode= | -O ] - [--flags= | -f ] [-rsvd= | -R ] - [--namespace-id= | -n ] [--cdw2= | -2 ] - [--cdw3= | -3 ] [--cdw10= | -4 ] - [--cdw11= | -5 ] [--cdw12= | -6 ] - [--cdw13= | -7 ] [--cdw14= | -8 ] - [--cdw15= | -9 ] - [--data-len= | -l ] - [--metadata-len= | -m ] - [--input-file= | -i ] - [--read | -r ] [--write | -w] - [--timeout= | -t ] - [--show-command | -s] - [--dry-run | -d] - [--raw-binary | -b] - [--prefill= | -p ] - [--latency | -T] + [--flags= | -f ] [-rsvd= | -R ] + [--namespace-id= | -n ] [--cdw2= | -2 ] + [--cdw3= | -3 ] [--cdw10= | -4 ] + [--cdw11= | -5 ] [--cdw12= | -6 ] + [--cdw13= | -7 ] [--cdw14= | -8 ] + [--cdw15= | -9 ] + [--data-len= | -l ] + [--metadata-len= | -m ] + [--input-file= | -i ] + [--read | -r] [--write | -w] + [--timeout= | -t ] + [--show-command | -s] + [--dry-run | -d] + [--raw-binary | -b] + [--prefill= | -p ] + [--latency | -T] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -113,6 +114,15 @@ OPTIONS --latency:: Print out the latency the IOCTL took (in us). +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * The following will run the admin command with opcode=6 and cdw10=1, which diff --git a/Documentation/nvme-ana-log.txt b/Documentation/nvme-ana-log.txt index b6dc9c58..92dc12a0 100644 --- a/Documentation/nvme-ana-log.txt +++ b/Documentation/nvme-ana-log.txt @@ -8,7 +8,8 @@ nvme-ana-log - Send NVMe ANA log page request, returns result and log SYNOPSIS -------- [verse] -'nvme ana-log' [-o | --output-format=] +'nvme ana-log' [--groups | -g] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,12 +27,16 @@ OPTIONS ------- -g:: --groups:: - Return the list of ANA groups without the namespace listing. + Return the list of ANA groups without the namespace listing. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-attach-ns.txt b/Documentation/nvme-attach-ns.txt index 64ab9d1a..601c20df 100644 --- a/Documentation/nvme-attach-ns.txt +++ b/Documentation/nvme-attach-ns.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme attach-ns' [--namespace-id= | -n ] [--controllers= | -c ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -28,11 +29,20 @@ OPTIONS The comma separated list of controller identifiers to attach the namespace too. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- Attach namespace to the controller: - # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21 + # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21 NVME ---- diff --git a/Documentation/nvme-boot-part-log.txt b/Documentation/nvme-boot-part-log.txt index 2dd32a67..09990715 100644 --- a/Documentation/nvme-boot-part-log.txt +++ b/Documentation/nvme-boot-part-log.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'nvme boot-part-log' [--lsp= | -s ] - [--output-file= | -o ] - [--output-format= | -o ] + [--output-file= | -f ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,14 +29,18 @@ OPTIONS --lsp=:: The log specified field of LID. --o :: +-f :: --output-file=:: File name to which raw binary data will be saved to. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt index b43ffc5b..a20561f0 100644 --- a/Documentation/nvme-capacity-mgmt.txt +++ b/Documentation/nvme-capacity-mgmt.txt @@ -4,7 +4,7 @@ nvme-capacity-mgmt(1) NAME ---- nvme-capacity-mgmt - Send capacity management command to configure/create/delete - Endurance Groups or NVM Sets, returns results. +Endurance Groups or NVM Sets, returns results. SYNOPSIS -------- @@ -13,6 +13,7 @@ SYNOPSIS [--element-id= | -i ] [--cap-lower= | -l ] [--cap-upper= | -u ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,21 +30,30 @@ OPTIONS ------- -O :: --operation=:: - Operation to be performed by the controller + Operation to be performed by the controller -i :: --element-id=:: - Value specific to the value of the Operation field. + Value specific to the value of the Operation field. -l :: --cap-lower=:: Least significant 32 bits of the capacity in bytes of the Endurance Group or - NVM Set to be created + NVM Set to be created -u :: --cap-upper=:: Most significant 32 bits of the capacity in bytes of the Endurance Group or - NVM Set to be created + NVM Set to be created + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-changed-ns-list-log.txt b/Documentation/nvme-changed-ns-list-log.txt index 4cfd0653..22e552f6 100644 --- a/Documentation/nvme-changed-ns-list-log.txt +++ b/Documentation/nvme-changed-ns-list-log.txt @@ -4,13 +4,13 @@ nvme-changed-ns-list-log(1) NAME ---- nvme-changed-ns-list-log - Send NVMe Changed Namespace List log page - request, returns result and log. +request, returns result and log. SYNOPSIS -------- [verse] 'nvme changed-ns-list-log' [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -31,10 +31,14 @@ OPTIONS --raw-binary:: Print the raw Changed Namespace List log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-check-dhchap-key.txt b/Documentation/nvme-check-dhchap-key.txt index 9cfa1f73..b131afec 100644 --- a/Documentation/nvme-check-dhchap-key.txt +++ b/Documentation/nvme-check-dhchap-key.txt @@ -8,7 +8,8 @@ nvme-check-dhchap-key - Check a generated host DH-HMAC-CHAP key SYNOPSIS -------- [verse] -'nvme check-dhchap-key' [--key= ] +'nvme check-dhchap-key' [--key=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -22,6 +23,15 @@ OPTIONS --key=:: Key to be checked. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-check-tls-key.txt b/Documentation/nvme-check-tls-key.txt index a676f043..0683ba35 100644 --- a/Documentation/nvme-check-tls-key.txt +++ b/Documentation/nvme-check-tls-key.txt @@ -8,11 +8,12 @@ nvme-check-tls-key - Check a generated NVMe TLS PSK SYNOPSIS -------- [verse] -'nvme check-tls-key' [--keyring= | -k ] - [--keytype= | -t ] - [--hostnqn= | -n ] - [--subsysnqn= | -c ] - [--keydata= | -d ] +'nvme check-tls-key' [--keyring= | -k ] + [--keytype= | -t ] + [--hostnqn= | -n ] + [--subsysnqn= | -c ] + [--keydata= | -d ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -46,6 +47,15 @@ OPTIONS --keydata=:: Key to be checked. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-cmdset-ind-id-ns.txt b/Documentation/nvme-cmdset-ind-id-ns.txt index fa55c833..5bf3862f 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.txt +++ b/Documentation/nvme-cmdset-ind-id-ns.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] 'nvme cmdset-ind-id-ns' [--namespace-id= | -n ] - [-b | --raw-binary] - [--human-readable | -H] - [--output-format= | -o ] + [--raw-binary | -b] [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -47,11 +46,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-compare.txt b/Documentation/nvme-compare.txt index 736ca9e2..59d1ea9c 100644 --- a/Documentation/nvme-compare.txt +++ b/Documentation/nvme-compare.txt @@ -29,6 +29,7 @@ SYNOPSIS [--storage-tag | -g ] [--storage-tag-check | -C] [--force] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -73,7 +74,6 @@ OPTIONS -p :: --prinfo=:: Protection Information and check field. - + [] |================= @@ -151,8 +151,17 @@ metadata is passes. data protection processing. --force:: - Ignore namespace is currently busy and performed the operation - even though. + Ignore namespace is currently busy and performed the operation + even though. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-config.txt b/Documentation/nvme-config.txt index 5b769258..aea6f6ad 100644 --- a/Documentation/nvme-config.txt +++ b/Documentation/nvme-config.txt @@ -8,33 +8,28 @@ nvme-config - NVMe-over-Fabrics configuration. SYNOPSIS -------- [verse] -'nvme config' - [--scan | -R] - [--modify | -M] - [--update | -U] - [--dump | -O] - [--config= | -J ] - [--transport= | -t ] - [--nqn= | -n ] - [--traddr= | -a ] - [--trsvcid= | -s ] - [--host-traddr= | -w ] - [--host-iface= | -f ] - [--hostnqn= | -q ] - [--hostid= | -I ] - [--dhchap-secret= | -S ] - [--dhchap-ctrl-secret= | -C ] - [--nr-io-queues=<#> | -i <#>] - [--nr-write-queues=<#> | -W <#>] - [--nr-poll-queues=<#> | -P <#>] - [--queue-size=<#> | -Q <#>] - [--keep-alive-tmo=<#> | -k <#>] - [--reconnect-delay=<#> | -c <#>] - [--ctrl-loss-tmo=<#> | -l <#>] - [--duplicate-connect | -D] - [--disable-sqflow | -d] - [--hdr-digest | -g] - [--data-digest | -G] +'nvme config' [--scan | -R] [--modify | -M] [--update | -U] [--dump | -O] + [--config= | -J ] + [--transport= | -t ] + [--nqn= | -n ] + [--traddr= | -a ] + [--trsvcid= | -s ] + [--host-traddr= | -w ] + [--host-iface= | -f ] + [--hostnqn= | -q ] + [--hostid= | -I ] + [--dhchap-secret= | -S ] + [--dhchap-ctrl-secret= | -C ] + [--nr-io-queues=<#> | -i <#>] + [--nr-write-queues=<#> | -W <#>] + [--nr-poll-queues=<#> | -P <#>] + [--queue-size=<#> | -Q <#>] + [--keep-alive-tmo=<#> | -k <#>] + [--reconnect-delay=<#> | -c <#>] + [--ctrl-loss-tmo=<#> | -l <#>] + [--duplicate-connect | -D] [--disable-sqflow | -d] + [--hdr-digest | -g] [--data-digest | -G] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -52,7 +47,7 @@ OPTIONS -M:: --modify:: Add or modify entries in the configuration based on the values from - the commandline. + the commandline. -U:: --update:: @@ -71,7 +66,7 @@ OPTIONS -t :: --transport=:: This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include: + [] |================= @@ -94,7 +89,7 @@ OPTIONS -s :: --trsvcid=:: - This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420. @@ -186,6 +181,15 @@ OPTIONS --data-digest:: Generates/verifies data digest (TCP). +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Read the current system configuration and write the contents to /tmp/config.json: @@ -200,7 +204,6 @@ nvme-discover(1) nvme-connect(1) https://github.com/linux-nvme/libnvme/doc/config-schema.json - AUTHORS ------- This was written by mailto:hare@suse.com[Hannes Reinecke] diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index 46b09116..faa2cf89 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -8,37 +8,29 @@ nvme-connect-all - Discover and Connect to Fabrics controllers. SYNOPSIS -------- [verse] -'nvme connect-all' - [--transport= | -t ] - [--nqn= | -n ] - [--traddr= | -a ] - [--trsvcid= | -s ] - [--host-traddr= | -w ] - [--host-iface= | -f ] - [--hostnqn= | -q ] - [--hostid= | -I ] - [--raw= | -r ] - [--device= | -d ] - [--cfg-file= | -C ] - [--keep-alive-tmo= | -k ] - [--reconnect-delay=<#> | -c <#>] - [--ctrl-loss-tmo=<#> | -l <#>] - [--nr-io-queues=<#> | -i <#>] - [--nr-write-queues=<#> | -W <#>] - [--nr-poll-queues=<#> | -P <#>] - [--queue-size=<#> | -Q <#>] - [--keyring=<#> ] - [--tls_key=<#> ] - [--hdr-digest | -g] - [--data-digest | -G] - [--persistent | -p] - [--tls ] - [--quiet | -S] - [--dump-config | -O] - [--nbft] - [--no-nbft] - [--nbft-path=] - [--context=] +'nvme connect-all' [--transport= | -t ] + [--nqn= | -n ] + [--traddr= | -a ] + [--trsvcid= | -s ] + [--host-traddr= | -w ] + [--host-iface= | -f ] + [--hostnqn= | -q ] + [--hostid= | -I ] + [--raw= | -r ] + [--device= | -d ] + [--cfg-file= | -C ] + [--keep-alive-tmo= | -k ] + [--reconnect-delay=<#> | -c <#>] + [--ctrl-loss-tmo=<#> | -l <#>] + [--nr-io-queues=<#> | -i <#>] + [--nr-write-queues=<#> | -W <#>] + [--nr-poll-queues=<#> | -P <#>] + [--queue-size=<#> | -Q <#>] [--keyring=<#>] + [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G] + [--persistent | -p] [--tls] [--quiet | -S] + [--dump-config | -O] [--nbft] [--no-nbft] + [--nbft-path=] [--context=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -62,13 +54,13 @@ OPTIONS -t :: --transport=:: This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include: + [] |================= |Value|Definition |rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) -|fc |*WIP* The network fabric is a Fibre Channel network. +|fc |*WIP* The network fabric is a Fibre Channel network. |tcp |The network fabric is a TCP/IP network. |loop|Connect to a NVMe over Fabrics target on the local host |================= @@ -85,7 +77,7 @@ OPTIONS -s :: --trsvcid=:: - This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420. @@ -203,18 +195,27 @@ OPTIONS Print out resulting JSON configuration file to stdout. --nbft:: - Only look at NBFT tables + Only look at NBFT tables --no-nbft:: - Do not look at NBFT tables + Do not look at NBFT tables --nbft-path=:: - Use a user-defined path to the NBFT tables + Use a user-defined path to the NBFT tables --context :: Set the execution context to . This allows to coordinate the management of the global resources. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Connect to all records returned by the Discover Controller with IP4 address @@ -241,9 +242,9 @@ the RDMA network. Port 4420 is used by default: * Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file: + ----------- -# Machine default 'nvme discover' commands. Query the +# Machine default 'nvme discover' commands. Query the # Discovery Controller's two ports (some resources may only -# be accessible on a single port). Note an official +# be accessible on a single port). Note an official # nqn (Host) name defined in the NVMe specification is being used # in this example. -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt index a6effafb..c7fb035f 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -8,36 +8,29 @@ nvme-connect - Connect to a Fabrics controller. SYNOPSIS -------- [verse] -'nvme connect' - [--transport= | -t ] - [--nqn= | -n ] - [--traddr= | -a ] - [--trsvcid= | -s ] - [--host-traddr= | -w ] - [--host-iface= | -f ] - [--hostnqn= | -q ] - [--hostid= | -I ] - [--config-file= | -J ] - [--dhchap-secret= | -S ] - [--dhchap-ctrl-secret= | -C ] - [--nr-io-queues=<#> | -i <#>] - [--nr-write-queues=<#> | -W <#>] - [--nr-poll-queues=<#> | -P <#>] - [--queue-size=<#> | -Q <#>] - [--keep-alive-tmo=<#> | -k <#>] - [--reconnect-delay=<#> | -c <#>] - [--ctrl-loss-tmo=<#> | -l <#>] - [--tos=<#> | -T <#>] - [--keyring=<#> ] - [--tls_key=<#> ] - [--duplicate-connect | -D] - [--disable-sqflow | -d] - [--hdr-digest | -g] - [--data-digest | -G] - [--tls ] - [--dump-config | -O] - [--output-format= | -o ] - [--application= ] +'nvme connect' [--transport= | -t ] + [--nqn= | -n ] + [--traddr= | -a ] + [--trsvcid= | -s ] + [--host-traddr= | -w ] + [--host-iface= | -f ] + [--hostnqn= | -q ] + [--hostid= | -I ] + [--config-file= | -J ] + [--dhchap-secret= | -S ] + [--dhchap-ctrl-secret= | -C ] + [--nr-io-queues=<#> | -i <#>] + [--nr-write-queues=<#> | -W <#>] + [--nr-poll-queues=<#> | -P <#>] + [--queue-size=<#> | -Q <#>] + [--keep-alive-tmo=<#> | -k <#>] + [--reconnect-delay=<#> | -c <#>] + [--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>] + [--keyring=<#>] [--tls_key=<#>] + [--duplicate-connect | -D] [--disable-sqflow | -d] + [--hdr-digest | -g] [--data-digest | -G] [--tls] + [--dump-config | -O] [--application=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -50,7 +43,7 @@ OPTIONS -t :: --transport=:: This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include: + [] |================= @@ -73,7 +66,7 @@ OPTIONS -s :: --trsvcid=:: - This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420. @@ -190,16 +183,19 @@ OPTIONS --dump-config:: Print out resulting JSON configuration file to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. Only one output format can - be used at a time. When this option is specified, the device associated with - the connection will be printed. Nothing is printed otherwise. - --context :: Set the execution context to . This allows to coordinate the management of the global resources. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 @@ -215,7 +211,6 @@ SEE ALSO nvme-discover(1) nvme-connect-all(1) - AUTHORS ------- This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee] diff --git a/Documentation/nvme-copy.txt b/Documentation/nvme-copy.txt index 1fad952d..e8dcc6c7 100644 --- a/Documentation/nvme-copy.txt +++ b/Documentation/nvme-copy.txt @@ -24,6 +24,7 @@ SYNOPSIS [--dir-type= | -T ] [--dir-spec= | -S ] [--format= | -F ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -32,76 +33,85 @@ logical block ranges to a single consecutive destination logical block range. OPTIONS ------- ---sdlba=:: -d :: +--sdlba=:: 64-bit addr of first destination logical block ---blocks=:: -b :: +--blocks=:: Comma separated list of the number of blocks in each range ---slbs=:: -s :: +--slbs=:: Comma separated list of the starting blocks in each range ---limited-retry:: -l:: +--limited-retry:: Sets the limited retry flag. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. ---prinfow=:: -p :: +--prinfow=:: Protection Information field write definition. ---prinfor=:: -P :: +--prinfor=:: Protection Information field read definition. ---ref-tag=:: -r :: +--ref-tag=:: initial lba reference tag. ---expected-ref-tags=:: -R :: +--expected-ref-tags=:: expected lba reference tags (comma-separated list). ---app-tag=:: -a :: +--app-tag=:: lba app tag ---expected-app-tags=:: -A :: +--expected-app-tags=:: expected lba app tags (comma-separated list) ---app-mask=:: -m :: +--app-mask=:: lba tag mask ---expected-app-masks=:: -M :: +--expected-app-masks=:: expected lba tag masks (comma-separated list) ---dir-type=:: -T :: +--dir-type=:: Optional directive type. The nvme-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1.3a) defines only one directive, 01h, for write stream identifiers. ---dir-spec=:: -S :: +--dir-spec=:: Optional field for directive specifics. When used with write streams, this value is defined to be the write stream identifier. The nvme-cli will not validate the stream requested is within the controller's capabilities. ---format=:: -F :: +--format=:: source range entry format +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-create-ns.txt b/Documentation/nvme-create-ns.txt index 9d81a155..740d05b9 100644 --- a/Documentation/nvme-create-ns.txt +++ b/Documentation/nvme-create-ns.txt @@ -28,6 +28,7 @@ SYNOPSIS [--ror= | -O ] [--rnumzrwa= | -u ] [--phndls= | -p ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -92,8 +93,8 @@ OPTIONS -b:: --block-size:: Target block size the new namespace should be formatted as. Potential FLBAS - values will be values will be scanned and the lowest numbered will be - selected for the create-ns operation. Conflicts with --flbas argument. + values will be values will be scanned and the lowest numbered will be + selected for the create-ns operation. Conflicts with --flbas argument. -S:: --nsze-si:: @@ -134,6 +135,15 @@ OPTIONS The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Create a namespace: diff --git a/Documentation/nvme-delete-ns.txt b/Documentation/nvme-delete-ns.txt index 62301b4e..1b306b21 100644 --- a/Documentation/nvme-delete-ns.txt +++ b/Documentation/nvme-delete-ns.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme delete-ns' [--namespace-id= | -n ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -25,6 +26,15 @@ OPTIONS --namespace-id=:: The namespace identifier to delete. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-dera-stat.txt b/Documentation/nvme-dera-stat.txt index 512e584f..f3a87aea 100644 --- a/Documentation/nvme-dera-stat.txt +++ b/Documentation/nvme-dera-stat.txt @@ -24,7 +24,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Dera Device status and Additional SMART log page in a human readable format: diff --git a/Documentation/nvme-detach-ns.txt b/Documentation/nvme-detach-ns.txt index ed23c15c..842889c7 100644 --- a/Documentation/nvme-detach-ns.txt +++ b/Documentation/nvme-detach-ns.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme detach-ns' [--namespace-id= | -n ] [--controllers= | -c + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -24,10 +25,19 @@ OPTIONS The namespace identifier to detach. -c :: --controllers=:: +--controllers=:: The comma separated list of controller identifiers to detach the namespace from. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-device-self-test.txt b/Documentation/nvme-device-self-test.txt index d0982777..17fe8758 100644 --- a/Documentation/nvme-device-self-test.txt +++ b/Documentation/nvme-device-self-test.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme device-self-test' [--namespace-id= | -n ] - [--self-test-code= | -s ] [--wait | -w] + [--self-test-code= | -s ] [--wait | -w] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -28,12 +29,12 @@ OPTIONS -s :: --self-test-code=:: - This field specifies the action taken by the device self-test command : - 0h: Show current state of device self-test operation - 1h: Start a short device self-test operation - 2h: Start a extended device self-test operation - eh: Start a vendor specific device self-test operation - fh: Abort the device self-test operation + This field specifies the action taken by the device self-test command : + 0h: Show current state of device self-test operation + 1h: Start a short device self-test operation + 2h: Start a extended device self-test operation + eh: Start a vendor specific device self-test operation + fh: Abort the device self-test operation Default is 0h. -w:: @@ -42,6 +43,15 @@ OPTIONS The device self-test is aborted by SIGINT signal interrupt for the wait The option is ignored if the abort self-test code option specified. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Start a short device self-test in the namespace-id 1: diff --git a/Documentation/nvme-dim.txt b/Documentation/nvme-dim.txt index 52df256d..fcfc9b8a 100644 --- a/Documentation/nvme-dim.txt +++ b/Documentation/nvme-dim.txt @@ -3,15 +3,15 @@ nvme-dim(1) NAME ---- -nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers. +nvme-dim - Send Discovery Information Management command to one or more +Discovery Controllers. SYNOPSIS -------- [verse] -'nvme dim' - [--task= | -t ] - [--nqn= | -n ] - [--device= | -d ] +'nvme dim' [--task= | -t ] [--nqn= | -n ] + [--device= | -d ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -51,6 +51,15 @@ OPTIONS with this NVMe device handle. A list of comma-separated device handles can be supplied to apply the command to more than one DC. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Register with the Central Discovery Controller (CDC) named diff --git a/Documentation/nvme-dir-receive.txt b/Documentation/nvme-dir-receive.txt index b412c0b9..f3f31bae 100644 --- a/Documentation/nvme-dir-receive.txt +++ b/Documentation/nvme-dir-receive.txt @@ -9,13 +9,13 @@ SYNOPSIS -------- [verse] 'nvme dir-receive' [--namespace-id= | -n ] - [--data-len= | -l ] - [--dir-type= | -D ] - [--dir-spec= | -S ] - [--dir-oper= | -O ] - [--req-resource= | -r ] - [--human-readable | -H] - [--raw-binary | -b] + [--data-len= | -l ] + [--dir-type= | -D ] + [--dir-spec= | -S ] + [--dir-oper= | -O ] + [--req-resource= | -r ] + [--human-readable | -H] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -41,20 +41,19 @@ OPTIONS -D :: --dir-type=:: - Directive type + Directive type -S :: --dir-spec=:: - Directive specific + Directive specific -O :: --dir-oper=:: - Directive operation + Directive operation -r :: --req-resource=:: Directive requested resource count - + [] |================== @@ -82,6 +81,15 @@ OPTIONS Print the decoded receive buffer to stdout if the command returns a structure. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Identify directive type supported : diff --git a/Documentation/nvme-dir-send.txt b/Documentation/nvme-dir-send.txt index eb5dad0d..1e3743d8 100644 --- a/Documentation/nvme-dir-send.txt +++ b/Documentation/nvme-dir-send.txt @@ -9,14 +9,14 @@ SYNOPSIS -------- [verse] 'nvme dir-send' [--namespace-id= | -n ] - [--data-len= | -l ] - [--dir-type= | -D ] - [--dir-spec= | -S ] - [--dir-oper= | -O ] - [--endir= | -e ] - [--target-dir= | -T ] - [--human-readable | -H] - [--raw-binary | -b] + [--data-len= | -l ] + [--dir-type= | -D ] + [--dir-spec= | -S ] + [--dir-oper= | -O ] + [--endir= | -e ] + [--target-dir= | -T ] + [--human-readable | -H] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -43,15 +43,15 @@ OPTIONS -D :: --dir-type=:: - Directive type + Directive type -S :: --dir-spec=:: - Directive specific + Directive specific -O :: --dir-oper=:: - Directive operation + Directive operation -T :: --target-dir=:: @@ -60,7 +60,6 @@ OPTIONS -e :: --endir=:: Target directive enable(1) or disable (0) operation - + [] |================== @@ -88,6 +87,15 @@ OPTIONS Print the decoded receive buffer to stdout if the command returns a structure. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Enable streams directive : diff --git a/Documentation/nvme-disconnect-all.txt b/Documentation/nvme-disconnect-all.txt index 6be7e414..9f023ea0 100644 --- a/Documentation/nvme-disconnect-all.txt +++ b/Documentation/nvme-disconnect-all.txt @@ -8,7 +8,7 @@ nvme-disconnect-all - Disconnect from all connected Fabrics controllers. SYNOPSIS -------- [verse] -'nvme disconnect-all' +'nvme disconnect-all' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,6 +17,17 @@ Disconnects and removes all existing NVMe over Fabrics controllers. See the documentation for the nvme-disconnect(1) command for further background. +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Disconnect all existing nvme controllers: diff --git a/Documentation/nvme-disconnect.txt b/Documentation/nvme-disconnect.txt index badb86fa..d3b8c524 100644 --- a/Documentation/nvme-disconnect.txt +++ b/Documentation/nvme-disconnect.txt @@ -8,15 +8,15 @@ nvme-disconnect - Disconnect one or more Fabrics controller(s). SYNOPSIS -------- [verse] -'nvme disconnect' - [--nqn= | -n ] - [--device= | -d ] +'nvme disconnect' [--nqn= | -n ] + [--device= | -d ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- Disconnects and removes one or more existing NVMe over Fabrics controllers. If the --nqn option is specified all controllers connecting to the Subsystem -identified by subnqn will be removed. If the --device option is specified +identified by subnqn will be removed. If the --device option is specified the controller specified by the --device option will be removed. OPTIONS @@ -31,6 +31,15 @@ OPTIONS Indicates that the controller with the specified name should be removed. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Disconnect all controllers for a subsystem named @@ -50,7 +59,6 @@ SEE ALSO -------- nvme-connect(1) - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index a0ffb362..32f10bce 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -8,39 +8,30 @@ nvme-discover - Send Get Log Page request to Discovery Controller. SYNOPSIS -------- [verse] -'nvme discover' - [--transport= | -t ] - [--nqn= | -n ] - [--traddr= | -a ] - [--trsvcid= | -s ] - [--host-traddr= | -w ] - [--host-iface= | -f ] - [--hostnqn= | -q ] - [--hostid= | -I ] - [--raw= | -r ] - [--device= | -d ] - [--cfg-file= | -C ] - [--keep-alive-tmo= | -k ] - [--reconnect-delay=<#> | -c <#>] - [--ctrl-loss-tmo=<#> | -l <#>] - [--nr-io-queues=<#> | -i <#>] - [--nr-write-queues=<#> | -W <#>] - [--nr-poll-queues=<#> | -P <#>] - [--queue-size=<#> | -Q <#>] - [--keyring=<#> ] - [--tls_key=<#> ] - [--hdr-digest | -g] - [--data-digest | -G] - [--persistent | -p] - [--quiet | -S] - [--tls ] - [--dump-config | -O] - [--output-format= | -o ] - [--force] - [--nbft] - [--no-nbft] - [--nbft-path=] - [--context=] +'nvme discover' [--transport= | -t ] + [--nqn= | -n ] + [--traddr= | -a ] + [--trsvcid= | -s ] + [--host-traddr= | -w ] + [--host-iface= | -f ] + [--hostnqn= | -q ] + [--hostid= | -I ] + [--raw= | -r ] + [--device= | -d ] + [--cfg-file= | -C ] + [--keep-alive-tmo= | -k ] + [--reconnect-delay=<#> | -c <#>] + [--ctrl-loss-tmo=<#> | -l <#>] + [--nr-io-queues=<#> | -i <#>] + [--nr-write-queues=<#> | -W <#>] + [--nr-poll-queues=<#> | -P <#>] + [--queue-size=<#> | -Q <#>] [--keyring=<#>] + [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G] + [--persistent | -p] [--quiet | -S] [--tls] + [--dump-config | -O] [--output-format= | -o ] + [--force] [--nbft] [--no-nbft] [--nbft-path=] + [--context=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -49,7 +40,7 @@ Controller. If no parameters are given, then 'nvme discover' will attempt to find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of -Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file +Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file exists, the command will quit with an error. Otherwise, a specific Discovery Controller should be specified using the @@ -61,7 +52,7 @@ BACKGROUND The NVMe-over-Fabrics specification defines the concept of a Discovery Controller that an NVMe Host can query on a fabric network to discover NVMe subsystems contained in NVMe Targets -which it can connect to on the network. The Discovery Controller +which it can connect to on the network. The Discovery Controller will return Discovery Log Pages that provide the NVMe Host with specific information (such as network address and unique subsystem NQN) the NVMe Host can use to issue an @@ -76,7 +67,7 @@ may be used by the Discovery Controller to control what NVMe Target resources are allocated to the NVMe Host for a connection. A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics -specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery +specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery Controllers must use this NQN name. This NQN is used by default by nvme-cli for the 'discover' command. @@ -85,7 +76,7 @@ OPTIONS -t :: --transport=:: This field specifies the network fabric being used for - a NVMe-over-Fabrics network. Current string values include: + a NVMe-over-Fabrics network. Current string values include: + [] |================= @@ -108,7 +99,7 @@ OPTIONS -s :: --trsvcid=:: - This field specifies the transport service id. For transports using IP + This field specifies the transport service id. For transports using IP addressing (e.g. rdma) this field is the port number. By default, the IP port number for the RDMA transport is 4420. @@ -223,10 +214,10 @@ OPTIONS --dump-config:: Print out resulting JSON configuration file to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. --force:: Disable the built-in persistent discover connection rules. @@ -234,18 +225,27 @@ OPTIONS persistent discovery connection. --nbft:: - Only look at NBFT tables + Only look at NBFT tables --no-nbft:: - Do not look at NBFT tables + Do not look at NBFT tables --nbft-path=:: - Use a user-defined path to the NBFT tables + Use a user-defined path to the NBFT tables --context :: Set the execution context to . This allows to coordinate the management of the global resources. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Query the Discover Controller with IP4 address 192.168.1.3 for all @@ -272,9 +272,9 @@ Port 4420 is used by default: * Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file: + ----------- -# Machine default 'nvme discover' commands. Query the +# Machine default 'nvme discover' commands. Query the # Discovery Controller's two ports (some resources may only -# be accessible on a single port). Note an official +# be accessible on a single port). Note an official # nqn (Host) name defined in the NVMe specification is being used # in this example. -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 diff --git a/Documentation/nvme-dsm.txt b/Documentation/nvme-dsm.txt index ff658a78..6a2e61a4 100644 --- a/Documentation/nvme-dsm.txt +++ b/Documentation/nvme-dsm.txt @@ -8,13 +8,14 @@ nvme-dsm - Send NVMe Data Set Management, return results SYNOPSIS -------- [verse] -'nvme dsm' [ --namespace-id= | -n ] - [ --ctx-attrs= | -a ] - [ --blocks= | -b ] - [ --slbs= | -s ] - [ --ad | -d ] [ --idw | -w ] [ --idr | -r ] - [ --cdw11= | -c ] - +'nvme dsm' [--namespace-id= | -n ] + [--ctx-attrs= | -a ] + [--blocks= | -b ] + [--slbs= | -s ] + [--ad= | -d ] + [--idw= | -w ] [--idr= | -r ] + [--cdw11= | -c ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -73,6 +74,15 @@ OPTIONS All the command command dword 11 attributes. Use exclusive from specifying individual attributes +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-effects-log.txt b/Documentation/nvme-effects-log.txt index f7d0092d..57a13694 100644 --- a/Documentation/nvme-effects-log.txt +++ b/Documentation/nvme-effects-log.txt @@ -3,14 +3,14 @@ nvme-effects-log(1) NAME ---- -nvme-effects-log - Send NVMe Command Effects log page request, returns result and log +nvme-effects-log - Send NVMe Command Effects log page request, returns result +and log SYNOPSIS -------- [verse] -'nvme effects-log' [--output-format= | -o ] - [--human-readable | -H] - [--raw-binary | -b] +'nvme effects-log' [--human-readable | -H] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,11 +26,6 @@ for each command that is supported. OPTIONS ------- --o :: ---output-format=:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields into a @@ -39,7 +34,16 @@ OPTIONS -b:: --raw-binary:: This option will print the raw buffer to stdout. Structure is not - parsed by program. This overrides the human-readable option. + parsed by program. This overrides the human-readable option. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-endurance-event-agg-log.txt b/Documentation/nvme-endurance-event-agg-log.txt index 69701e3d..7cbceb1b 100644 --- a/Documentation/nvme-endurance-event-agg-log.txt +++ b/Documentation/nvme-endurance-event-agg-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme endurance-event-agg-log' [--log-entries= | -e ] [--rae | -r] [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,20 +29,24 @@ OPTIONS ------- -e :: --log-entries=:: - Retrieve the Endurance Group Event Aggregate Log pending entries. - This argument is mandatory and its success may depend on the device's - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.15. The maximum number of log entries supported is 2044 - for the device. + Retrieve the Endurance Group Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.15. The maximum number of log entries supported is 2044 + for the device. -r:: --rae:: Retain an Asynchronous Event. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-endurance-log.txt b/Documentation/nvme-endurance-log.txt index 5e18b57a..c263834c 100644 --- a/Documentation/nvme-endurance-log.txt +++ b/Documentation/nvme-endurance-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme endurance-log' [--group-id= | -g ] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,10 +29,14 @@ OPTIONS --group-id=:: The endurance group identifier. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt index eebaca7d..94442ee5 100644 --- a/Documentation/nvme-error-log.txt +++ b/Documentation/nvme-error-log.txt @@ -8,9 +8,9 @@ nvme-error-log - Send NVME Error log page request, return result and log SYNOPSIS -------- [verse] -'nvme error-log' [--log-entries= | -e ] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme error-log' [--log-entries= | -e ] + [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -37,11 +37,14 @@ OPTIONS --raw-binary:: Print the raw error log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-fdp-configs.txt b/Documentation/nvme-fdp-configs.txt index c4311fb3..d5cc4873 100644 --- a/Documentation/nvme-fdp-configs.txt +++ b/Documentation/nvme-fdp-configs.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] 'nvme fdp configs' [--endgrp-id= | -e ] - [--human-readable | -H] - [--raw-binary | -b] - [--output-format= | -o ] + [--human-readable | -H] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -32,8 +31,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fdp-events.txt b/Documentation/nvme-fdp-events.txt index 606a1636..5602f448 100644 --- a/Documentation/nvme-fdp-events.txt +++ b/Documentation/nvme-fdp-events.txt @@ -8,10 +8,8 @@ nvme-fdp-events - Get Flexible Data Placement Events SYNOPSIS -------- [verse] -'nvme fdp events' [--endgrp-id= | -e ] - [--host-events | -E] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme fdp events' [--endgrp-id= | -e ] [--host-events | -E] + [--raw-binary | -b] [--output-format= | -o ] DESCRIPTION ----------- @@ -32,8 +30,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fdp-set-events.txt b/Documentation/nvme-fdp-set-events.txt index b45819be..b93cdc33 100644 --- a/Documentation/nvme-fdp-set-events.txt +++ b/Documentation/nvme-fdp-set-events.txt @@ -9,9 +9,8 @@ SYNOPSIS -------- [verse] 'nvme fdp set-events' [--namespace-id= | -n ] - [--placement-handle= | -p ] - [--enable | -e] - [--event-types= | -t ] + [--placement-handle= | -p ] [--enable | -e] + [--event-types= | -t ] DESCRIPTION ----------- @@ -29,8 +28,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fdp-stats.txt b/Documentation/nvme-fdp-stats.txt index 7f96065a..0b184a96 100644 --- a/Documentation/nvme-fdp-stats.txt +++ b/Documentation/nvme-fdp-stats.txt @@ -8,9 +8,8 @@ nvme-fdp-stats - Get Flexible Data Placement Statistics SYNOPSIS -------- [verse] -'nvme fdp stats' [--endgrp-id= | -e ] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme fdp stats' [--endgrp-id= | -e ] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -27,8 +26,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fdp-status.txt b/Documentation/nvme-fdp-status.txt index 263cb4c9..78dddaed 100644 --- a/Documentation/nvme-fdp-status.txt +++ b/Documentation/nvme-fdp-status.txt @@ -8,9 +8,8 @@ nvme-fdp-status - Get Reclaim Unit Handle Status SYNOPSIS -------- [verse] -'nvme fdp status' [--namespace-id= | -n ] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme fdp status' [--namespace-id= | -n ] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -27,8 +26,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fdp-update.txt b/Documentation/nvme-fdp-update.txt index 4b70c247..5af83e5a 100644 --- a/Documentation/nvme-fdp-update.txt +++ b/Documentation/nvme-fdp-update.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fdp update' [--namespace-id= | -n ] - [--pids= | -p ] + [--pids= | -p ] DESCRIPTION ----------- diff --git a/Documentation/nvme-fdp-usage.txt b/Documentation/nvme-fdp-usage.txt index ad9d1eba..3e0fb989 100644 --- a/Documentation/nvme-fdp-usage.txt +++ b/Documentation/nvme-fdp-usage.txt @@ -8,9 +8,8 @@ nvme-fdp-usage - Get Reclaim Unit Handle Usage SYNOPSIS -------- [verse] -'nvme fdp usage' [--endgrp-id= | -e ] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme fdp usage' [--endgrp-id= | -e ] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -28,8 +27,8 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal', 'json', or 'binary'. Only one output format can be used at a time. diff --git a/Documentation/nvme-fid-support-effects-log.txt b/Documentation/nvme-fid-support-effects-log.txt index 5d12b18a..9670b887 100644 --- a/Documentation/nvme-fid-support-effects-log.txt +++ b/Documentation/nvme-fid-support-effects-log.txt @@ -8,7 +8,7 @@ nvme-fid-support-effects-log - Send NVMe FID Support and Effects log, return res SYNOPSIS -------- [verse] -'nvme fid-support-effects-log' [-o | --output-format=] +'nvme fid-support-effects-log' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -24,16 +24,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields into human-readable formats. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-flush.txt b/Documentation/nvme-flush.txt index 28cfa63b..102cd71d 100644 --- a/Documentation/nvme-flush.txt +++ b/Documentation/nvme-flush.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme flush' [--namespace-id= | -n ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -25,6 +26,15 @@ OPTIONS Specify the optional namespace id for this command. Defaults to 0xffffffff, indicating flush for all namespaces. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-format.txt b/Documentation/nvme-format.txt index cbadd1d6..e4623f15 100644 --- a/Documentation/nvme-format.txt +++ b/Documentation/nvme-format.txt @@ -9,15 +9,13 @@ SYNOPSIS -------- [verse] 'nvme format' [--namespace-id= | -n ] - [--lbaf= | -l ] - [--block-size=] - [--ses= | -s ] - [--pil= | -p ] - [--pi= | -i ] - [--ms= | -m ] - [--reset | -r ] - [--force ] - [--timeout= | -t ] + [--lbaf= | -l ] + [--block-size=] + [--ses= | -s ] [--pil= | -p ] + [--pi= | -i ] [--ms= | -m ] + [--reset | -r] [--force] + [--timeout= | -t ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -135,6 +133,15 @@ cryptographically. This is accomplished by deleting the encryption key. --timeout=:: Override default timeout value. In milliseconds. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Format the device using all defaults: diff --git a/Documentation/nvme-fw-commit.txt b/Documentation/nvme-fw-commit.txt index 337e783e..8e08bd44 100644 --- a/Documentation/nvme-fw-commit.txt +++ b/Documentation/nvme-fw-commit.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] 'nvme fw-commit' [--slot= | -s ] - [--action= | -a ] - [--bpid= | -b ] + [--action= | -a ] + [--bpid= | -b ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -75,6 +76,15 @@ BPINFO.ABPID. Specifies the Boot partition that shall be used for the Commit Action, if applicable (default: 0) +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * commit the last downloaded fw to slot 1. diff --git a/Documentation/nvme-fw-download.txt b/Documentation/nvme-fw-download.txt index a00be4c6..1ec466f3 100644 --- a/Documentation/nvme-fw-download.txt +++ b/Documentation/nvme-fw-download.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] 'nvme fw-download' [--fw= | -f ] - [--xfer= | -x ] - [--offset= | -O ] + [--xfer= | -x ] + [--offset= | -O ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -55,6 +56,15 @@ OPTIONS the offset starts at zero and automatically adjusts based on the 'xfer' size given. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Transfer a firmware size 128KiB at a time: diff --git a/Documentation/nvme-fw-log.txt b/Documentation/nvme-fw-log.txt index 4b735772..d9575480 100644 --- a/Documentation/nvme-fw-log.txt +++ b/Documentation/nvme-fw-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fw-log' [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -30,11 +30,14 @@ OPTIONS --raw-binary:: Print the raw fw log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-gen-dhchap-key.txt b/Documentation/nvme-gen-dhchap-key.txt index 79e8ed58..1e5f9696 100644 --- a/Documentation/nvme-gen-dhchap-key.txt +++ b/Documentation/nvme-gen-dhchap-key.txt @@ -9,9 +9,10 @@ SYNOPSIS -------- [verse] 'nvme gen-dhchap-key' [--hmac= | -h ] - [--secret= | -s ] - [--key-length= | -l ] - [--nqn= | -n ] + [--secret= | -s ] + [--key-length= | -l ] + [--nqn= | -n ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -43,6 +44,15 @@ OPTIONS Host-NQN to be used for the transformation. This parameter is only valid if a non-zero HMAC function has been specified. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-gen-hostnqn.txt b/Documentation/nvme-gen-hostnqn.txt index 9efefb5a..7b7d776d 100644 --- a/Documentation/nvme-gen-hostnqn.txt +++ b/Documentation/nvme-gen-hostnqn.txt @@ -8,7 +8,7 @@ nvme-gen-hostnqn - Generate a host NVMe Qualified Name SYNOPSIS -------- [verse] -'nvme gen-hostnqn' +'nvme gen-hostnqn' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -18,7 +18,14 @@ and prints it to stdout. OPTIONS ------- -No options needed +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-gen-tls-key.txt b/Documentation/nvme-gen-tls-key.txt index 9a03e3ab..5d134d1a 100644 --- a/Documentation/nvme-gen-tls-key.txt +++ b/Documentation/nvme-gen-tls-key.txt @@ -9,12 +9,13 @@ SYNOPSIS -------- [verse] 'nvme gen-tls-key' [--keyring= | -k ] - [--keytype= | -t ] - [--hostnqn= | -n ] - [--subsysnqn= | -c ] - [--hmac= | -h ] - [--secret= | -s ] - [--insert | -i ] + [--keytype= | -t ] + [--hostnqn= | -n ] + [--subsysnqn= | -c ] + [--hmac= | -h ] + [--secret= | -s ] + [--insert | -i] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -70,6 +71,15 @@ OPTIONS Insert the resulting TLS key into the keyring without printing out the key in PSK interchange format. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-get-feature.txt b/Documentation/nvme-get-feature.txt index 34df0c3a..6477bc6c 100644 --- a/Documentation/nvme-get-feature.txt +++ b/Documentation/nvme-get-feature.txt @@ -9,12 +9,13 @@ SYNOPSIS -------- [verse] 'nvme get-feature' [--namespace-id= | -n ] - [--feature-id= | -f ] [--cdw11=] - [--uuid-index= | -U ] - [--data-len= | -l ] - [--sel=] - [--raw-binary | -b] - [--human-readable | -H] + [--feature-id= | -f ] [--cdw11=] + [--uuid-index= | -U ] + [--data-len= | -l ] + [--sel=] + [--raw-binary | -b] + [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -81,6 +82,15 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Retrieves the feature for Number of Queues, or feature id 7: diff --git a/Documentation/nvme-get-lba-status.txt b/Documentation/nvme-get-lba-status.txt index 157dc419..9ef9d595 100644 --- a/Documentation/nvme-get-lba-status.txt +++ b/Documentation/nvme-get-lba-status.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] 'nvme get-lba-status' [--namespace-id= | -n ] - [--start-lba= | -s ] - [--max-dw= | -m ] - [--action= | -a ] - [--range-len= | -l ] - [--timeout= | -t ] - [--output-format= | -o ] + [--start-lba= | -s ] + [--max-dw= | -m ] + [--action= | -a ] + [--range-len= | -l ] + [--timeout= | -t ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -57,10 +57,14 @@ OPTIONS --timeout=:: Override default timeout value. In milliseconds. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-get-log.txt b/Documentation/nvme-get-log.txt index 7d0f90c5..98b1f9ce 100644 --- a/Documentation/nvme-get-log.txt +++ b/Documentation/nvme-get-log.txt @@ -9,17 +9,18 @@ SYNOPSIS -------- [verse] 'nvme get-log' [--log-id= | -i ] - [--log-len= | -l ] - [--aen= | -a ] - [--namespace-id= | -n ] - [--raw-binary | -b] - [--lpo= | -L ] - [--lsp= | -s ] - [--lsi= | -S ] - [--rae | -r] - [--csi= | -y ] - [--ot= | -O ] - [--xfer-len= | -x ] + [--log-len= | -l ] + [--aen= | -a ] + [--namespace-id= | -n ] + [--raw-binary | -b] + [--lpo= | -L ] + [--lsp= | -s ] + [--lsi= | -S ] + [--rae | -r] + [--csi= | -y ] + [--ot= | -O ] + [--xfer-len= | -x ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -101,6 +102,15 @@ OPTIONS Specify the read chunk size. The length argument is expected to be a multiple of 4096. The default size is 4096. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Get 512 bytes from log page 2 diff --git a/Documentation/nvme-get-ns-id.txt b/Documentation/nvme-get-ns-id.txt index 5dcdc6d4..8516cb89 100644 --- a/Documentation/nvme-get-ns-id.txt +++ b/Documentation/nvme-get-ns-id.txt @@ -8,7 +8,7 @@ nvme-get-ns-id - Retrieves the namespace ID for an NVMe block device SYNOPSIS -------- [verse] -'nvme get-ns-id' +'nvme get-ns-id' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ is mandatory and must be an NVMe block device (ex: /dev/nvme0n1). OPTIONS ------- -None +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt index 8a906e54..601b8a4d 100644 --- a/Documentation/nvme-get-property.txt +++ b/Documentation/nvme-get-property.txt @@ -10,24 +10,31 @@ SYNOPSIS -------- [verse] 'nvme get-property' [--offset= | -O ] - [--human-readable | -H ] - + [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- Reads and shows the defined NVMe controller property for NVMe over Fabric. - OPTIONS ------- -O:: --offset:: - The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 + The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20 -H:: --human-readable: Show the fields packed in the property +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- @@ -37,7 +44,6 @@ EXAMPLES # nvme get-property /dev/nvme0 --offset=0x0 --human-readable ------------ - BUGS ---- Currently the CAP value is truncated to 32 bits due to a limitation in diff --git a/Documentation/nvme-huawei-id-ctrl.txt b/Documentation/nvme-huawei-id-ctrl.txt index f4d2f80c..47225d1a 100644 --- a/Documentation/nvme-huawei-id-ctrl.txt +++ b/Documentation/nvme-huawei-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-huawei-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme huawei id-ctrl' [-v | --vendor-specific] [-b | --raw-binary] - [-o | --output-format=] +'nvme huawei id-ctrl' [--vendor-specific | -v] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -47,10 +47,10 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-huawei-list.txt b/Documentation/nvme-huawei-list.txt index 65a6c21b..95f10999 100644 --- a/Documentation/nvme-huawei-list.txt +++ b/Documentation/nvme-huawei-list.txt @@ -8,7 +8,7 @@ nvme-huawei-list - List all recognized Huawei NVMe devices SYNOPSIS -------- [verse] -'nvme huawei list' [-o | --output-format=] +'nvme huawei list' [--output-format= | -o ] DESCRIPTION ----------- @@ -17,8 +17,8 @@ for those Huawei devices as well as some pertinent information about them. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt index 76ae86df..3667c634 100644 --- a/Documentation/nvme-id-ctrl.txt +++ b/Documentation/nvme-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme id-ctrl' [-V | --vendor-specific] [-b | --raw-binary] - [-o | --output-format=] +'nvme id-ctrl' [--vendor-specific | -V] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -41,10 +41,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-domain.txt b/Documentation/nvme-id-domain.txt index 87883c50..1d6ec48c 100644 --- a/Documentation/nvme-id-domain.txt +++ b/Documentation/nvme-id-domain.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-domain' [--dom-id= | -d ] - [-o | --output-format=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,10 +26,14 @@ OPTIONS Retrieve the identify domain list data structure for the given domain id. If this value is not given, domain id will be 0xffff. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt index a35217e1..bb85aef1 100644 --- a/Documentation/nvme-id-iocs.txt +++ b/Documentation/nvme-id-iocs.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-iocs' [--controller-id= | -c ] - [-o | --output-format=] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -30,10 +30,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-ns-lba-format.txt b/Documentation/nvme-id-ns-lba-format.txt index 32df2f61..514ba489 100644 --- a/Documentation/nvme-id-ns-lba-format.txt +++ b/Documentation/nvme-id-ns-lba-format.txt @@ -9,9 +9,9 @@ SYNOPSIS -------- [verse] 'nvme id-ns' [--uuid-index= | -U ] - [--lba-format-index= | -i ] - [-v | --verbose] - [--output-format= | -o ] + [--lba-format-index= | -i ] + [--verbose | -v] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -31,7 +31,7 @@ OPTIONS -U :: --uuid-index=:: UUID Index of the feature - + -i :: --lba-format-index=:: This field specifies the index into the LBA Format list identifying @@ -41,10 +41,10 @@ OPTIONS --verbose:: Increase the information detail in the output. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-id-ns.txt b/Documentation/nvme-id-ns.txt index 86918d99..07912505 100644 --- a/Documentation/nvme-id-ns.txt +++ b/Documentation/nvme-id-ns.txt @@ -8,10 +8,10 @@ nvme-id-ns - Send NVMe Identify Namespace, return result and structure SYNOPSIS -------- [verse] -'nvme id-ns' [-V | --vendor-specific] [-b | --raw-binary] - [--namespace-id= | -n ] [--force] - [--human-readable | -H] - [--output-format= | -o ] +'nvme id-ns' [--vendor-specific | -v] [--raw-binary | -b] + [--namespace-id= | -n ] [--force] + [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -62,12 +62,14 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-id-nvmset.txt b/Documentation/nvme-id-nvmset.txt index c331410c..e2894e37 100644 --- a/Documentation/nvme-id-nvmset.txt +++ b/Documentation/nvme-id-nvmset.txt @@ -8,8 +8,8 @@ nvme-id-nvmset - Send NVMe Identify NVM Set List, return result and structure SYNOPSIS -------- [verse] -'nvme id-nvmset' [-i | --nvmset_id= ] - [-o | --output-format=] +'nvme id-nvmset' [--nvmset_id= | -i ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -27,14 +27,18 @@ OPTIONS ------- -i :: --nvmset_id=:: - This field specifies the identifier of the NVM Set. If given, NVM set + This field specifies the identifier of the NVM Set. If given, NVM set identifier whose entry is to be in result data will be greater than or equal to this value. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-inspur-nvme-vendor-log.txt b/Documentation/nvme-inspur-nvme-vendor-log.txt index cd0266bc..c8604972 100644 --- a/Documentation/nvme-inspur-nvme-vendor-log.txt +++ b/Documentation/nvme-inspur-nvme-vendor-log.txt @@ -23,7 +23,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Inspur Device Vendor log page in a human readable format: diff --git a/Documentation/nvme-intel-id-ctrl.txt b/Documentation/nvme-intel-id-ctrl.txt index 1a6369c7..469d60ea 100644 --- a/Documentation/nvme-intel-id-ctrl.txt +++ b/Documentation/nvme-intel-id-ctrl.txt @@ -8,8 +8,8 @@ nvme-intel-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme intel id-ctrl' [-v | --vendor-specific] [-b | --raw-binary] - [-o | --output-format=] +'nvme intel id-ctrl' [--vendor-specific | -v] [--raw-binary | -b] + [--output-format= | -o ] DESCRIPTION ----------- @@ -44,10 +44,10 @@ OPTIONS This option will parse and format many of the bit fields into human-readable formats. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-intel-internal-log.txt b/Documentation/nvme-intel-internal-log.txt index 2f00313a..a1e1792d 100644 --- a/Documentation/nvme-intel-internal-log.txt +++ b/Documentation/nvme-intel-internal-log.txt @@ -53,7 +53,6 @@ OPTIONS When used with 'nlog', this specifies which nlog to read. -1 for all, if supported by the device. - EXAMPLES -------- * Gets the nlog from the device and saves to default file: diff --git a/Documentation/nvme-intel-smart-log-add.txt b/Documentation/nvme-intel-smart-log-add.txt index 7cfe7942..0ed1f10c 100644 --- a/Documentation/nvme-intel-smart-log-add.txt +++ b/Documentation/nvme-intel-smart-log-add.txt @@ -3,14 +3,14 @@ nvme-intel-smart-log-add(1) NAME ---- -nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request, returns result and log +nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request, +returns result and log SYNOPSIS -------- [verse] 'nvme intel smart-log-add' [--namespace-id= | -n ] - [--raw-binary | -b] - [--json | -j] + [--raw-binary | -b] [--json | -j] DESCRIPTION ----------- @@ -41,7 +41,7 @@ OPTIONS -j:: --json:: - Dump output in json format. + Dump output in json format. EXAMPLES -------- diff --git a/Documentation/nvme-io-mgmt-recv.txt b/Documentation/nvme-io-mgmt-recv.txt index e611c15f..332d0bbd 100644 --- a/Documentation/nvme-io-mgmt-recv.txt +++ b/Documentation/nvme-io-mgmt-recv.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] 'nvme io-mgmt-recv' [--namespace-id= | -n ] - [--mos= | -s ] - [--mo= | -m ] - [--data= | -d ] - [--data-len= | -l ] + [--mos= | -s ] [--mo= | -m ] + [--data= | -d ] + [--data-len= | -l ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -49,6 +49,14 @@ OPTIONS --mos=:: Management Operation Specific parameter. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. NVME ---- diff --git a/Documentation/nvme-io-mgmt-send.txt b/Documentation/nvme-io-mgmt-send.txt index ce8d8d21..f7e8f6d4 100644 --- a/Documentation/nvme-io-mgmt-send.txt +++ b/Documentation/nvme-io-mgmt-send.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] 'nvme io-mgmt-send' [--namespace-id= | -n ] - [--mos= | -s ] - [--mo= | -m ] - [--data= | -d ] - [--data-len= | -l ] + [--mos= | -s ] [--mo= | -m ] + [--data= | -d ] + [--data-len= | -l ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -48,6 +48,14 @@ OPTIONS --mos=:: Management Operation Specific parameter. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. NVME ---- diff --git a/Documentation/nvme-io-passthru.txt b/Documentation/nvme-io-passthru.txt index 5dad7335..3ad52318 100644 --- a/Documentation/nvme-io-passthru.txt +++ b/Documentation/nvme-io-passthru.txt @@ -9,22 +9,21 @@ SYNOPSIS -------- [verse] 'nvme-io-passthru' [--opcode= | -O ] - [--flags= | -f ] [-rsvd= | -R ] - [--namespace-id= | -nsid ] - [--cdw2=] [--cdw3=] [--cdw10=] - [--cdw11=] [--cdw12=] [--cdw13=] - [--cdw14=] [--cdw15=] - [--data-len= | -l ] - [--metadata-len= | -m ] - [--read | -r ] [--write | -w] - [--input-file= | -i ] - [--metadata= | -M ] - [--timeout= | -t ] - [--show-command | -s] - [--dry-run | -d] - [--raw-binary | -b] - [--prefill= | -p ] - [--latency | -T] + [--flags= | -f ] [-rsvd= | -R ] + [--namespace-id= | -nsid ] + [--cdw2=] [--cdw3=] [--cdw10=] + [--cdw11=] [--cdw12=] [--cdw13=] + [--cdw14=] [--cdw15=] + [--data-len= | -l ] + [--metadata-len= | -m ] + [--read | -r] [--write | -w] + [--input-file= | -i ] + [--metadata= | -M ] + [--timeout= | -t ] [--show-command | -s] + [--dry-run | -d] [--raw-binary | -b] + [--prefill= | -p ] + [--latency | -T] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -120,6 +119,15 @@ OPTIONS --latency:: Print out the latency the IOCTL took (in us). +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- diff --git a/Documentation/nvme-lba-status-log.txt b/Documentation/nvme-lba-status-log.txt index 0d888f7f..7d6efbd7 100644 --- a/Documentation/nvme-lba-status-log.txt +++ b/Documentation/nvme-lba-status-log.txt @@ -8,7 +8,8 @@ nvme-lba-status-log - Send LBA Status Log Page request returns result and log SYNOPSIS -------- [verse] -'nvme lba-status-log' [--rae | -r] [--output-format= | -o ] +'nvme lba-status-log' [--rae | -r] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,10 +30,14 @@ OPTIONS --rae:: Retain an Asynchronous Event. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-ctrl.txt b/Documentation/nvme-list-ctrl.txt index f1bb52d9..6cd5c015 100644 --- a/Documentation/nvme-list-ctrl.txt +++ b/Documentation/nvme-list-ctrl.txt @@ -9,7 +9,9 @@ SYNOPSIS -------- [verse] 'nvme list-ctrl' [--cntid= | -c ] - [--namespace-id= | -n ] [-o | --output-format=] + [--namespace-id= | -n ] + [--output-format= | -o ] [--verbose | -v] + DESCRIPTION ----------- For the NVMe device given, sends an identify command for controller list @@ -37,10 +39,14 @@ OPTIONS command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s). --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-endgrp.txt b/Documentation/nvme-list-endgrp.txt index 157dca98..2d7724d9 100644 --- a/Documentation/nvme-list-endgrp.txt +++ b/Documentation/nvme-list-endgrp.txt @@ -3,14 +3,15 @@ nvme-list-endgrp(1) NAME ---- -nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and structure +nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and +structure SYNOPSIS -------- [verse] 'nvme list-endgrp' [--endgrp-id= | -i ] - [-o | --output-format=] - + [--output-format= | -o ] [--verbose | -v] + DESCRIPTION ----------- For the NVMe device given, sends an identify command for endurance group list @@ -26,13 +27,17 @@ OPTIONS ------- -i :: --endgrp-id=:: - Retrieve the identify endurance group list structure starting for the given - endurance group id. + Retrieve the identify endurance group list structure starting for the + given endurance group id. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-ns.txt b/Documentation/nvme-list-ns.txt index 753a9594..d2412876 100644 --- a/Documentation/nvme-list-ns.txt +++ b/Documentation/nvme-list-ns.txt @@ -10,7 +10,8 @@ SYNOPSIS [verse] 'nvme list-ns' [--namespace-id= | -n ] [--csi= | -y ] - [--all | -a] [--output-format= | -o ] + [--all | -a] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -41,10 +42,14 @@ OPTIONS Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive. --o :: ---output-format=:: - Set the reporting format to 'normal', or 'json'. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list-subsys.txt b/Documentation/nvme-list-subsys.txt index 6650bbe3..a5d2d480 100644 --- a/Documentation/nvme-list-subsys.txt +++ b/Documentation/nvme-list-subsys.txt @@ -8,7 +8,7 @@ nvme-list-subsys - List all NVMe subsystems SYNOPSIS -------- [verse] -'nvme list-subsys' [-o | --output-format=] +'nvme list-subsys' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -19,10 +19,14 @@ and subsystems leading to the device. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt index 7cc333be..a8c5428c 100644 --- a/Documentation/nvme-list.txt +++ b/Documentation/nvme-list.txt @@ -8,7 +8,7 @@ nvme-list - List all recognized NVMe devices SYNOPSIS -------- [verse] -'nvme list' [-o | --output-format=] +'nvme list' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,10 +17,10 @@ for those devices as well as some pertinent information about them. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. Only one output - format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. -v:: --verbose:: @@ -32,7 +32,6 @@ ENVIRONMENT ----------- PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in common locations. - EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-lockdown.txt b/Documentation/nvme-lockdown.txt index 34369ecf..62e04c6e 100644 --- a/Documentation/nvme-lockdown.txt +++ b/Documentation/nvme-lockdown.txt @@ -4,7 +4,6 @@ nvme-lockdown(1) NAME ---- nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution of command - SYNOPSIS -------- [verse] @@ -13,6 +12,7 @@ SYNOPSIS [--prhbt= | -p ] [--scp= | -s ] [--uuid= | -U ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -23,30 +23,38 @@ Identifier. OPTIONS ------- ---ofi=:: -O :: +--ofi=:: Opcode or Feature Identifier(OFI) specifies the command opcode or Set Features Feature Identifier identified by the Scope field. ---ifc=:: -f :: +--ifc=:: Interface (INF) field identifies the interfaces affected by this command. ---prhbt=:: -p :: +--prhbt=:: Prohibit (PRHBT) bit specifies whether to prohibit or allow the command opcode or Set Features Feature Identifier specified by this command. ---scp=:: -s :: +--scp=:: Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field. - ---uuid=:: -U :: +--uuid=:: UUID Index - If this field is set to a non-zero value, then the value of this field is the index of a UUID in the UUID List that is used by the command. If this field is cleared to 0h,then no UUID index is specified. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-media-unit-stat-log.txt b/Documentation/nvme-media-unit-stat-log.txt index 427b77cf..997a4974 100644 --- a/Documentation/nvme-media-unit-stat-log.txt +++ b/Documentation/nvme-media-unit-stat-log.txt @@ -9,9 +9,8 @@ request, returns result and log. SYNOPSIS -------- [verse] -'nvme media-unit-stat-log' [--dom-id | -d ] - [--output-format= | -o ] - [--raw-binary | -b] +'nvme media-unit-stat-log' [--dom-id | -d] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,17 +25,18 @@ On success, the returned Media unit status log pages log structure will be print OPTIONS ------- --o :: ---output-format=:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. +-o :: +--output-format=:: + This option will set the reporting format to normal, json, or binary. + Only one output format can be used at a time. -d:: --dom-id:: - To get the domain ID. + To get the domain ID. + -b:: --raw-binary:: - To show raw binary data. + To show raw binary data. EXAMPLES -------- diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt index 67b8355f..22218040 100644 --- a/Documentation/nvme-mi-cmd-support-effects-log.txt +++ b/Documentation/nvme-mi-cmd-support-effects-log.txt @@ -4,13 +4,13 @@ nvme-mi-cmd-support-effects-log(1) NAME ---- nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log, - returns results and structure +returns results and structure SYNOPSIS -------- [verse] -'nvme-mi-cmd-support-effects-log' [-o | --output-format=] - [-H | --human-readable] +'nvme-mi-cmd-support-effects-log' [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,16 +26,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields into human-readable formats. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- nvme mi-cmd-support-effects-log /dev/nvme0 -H diff --git a/Documentation/nvme-micron-internal-log.txt b/Documentation/nvme-micron-internal-log.txt index 37a50ad4..b8e92281 100644 --- a/Documentation/nvme-micron-internal-log.txt +++ b/Documentation/nvme-micron-internal-log.txt @@ -3,7 +3,8 @@ nvme-micron-internal-log(1) NAME ---- -nvme-micron-internal-log - Retrieve Micron device's internal logs and save to given zip file. +nvme-micron-internal-log - Retrieve Micron device's internal logs and save to +given zip file. SYNOPSIS -------- @@ -12,23 +13,24 @@ SYNOPSIS DESCRIPTION ----------- -For the given NVMe device, sends the Micron vendor specific device commands to retrieve -various logs (in binary format) and compresses them and saves into specified zip file. -These vendor unique logs can be analyzed with Micron Technical support team for any device -specific issues +For the given NVMe device, sends the Micron vendor specific device commands to +retrieve various logs (in binary format) and compresses them and saves into +specified zip file. These vendor unique logs can be analyzed with Micron +Technical support team for any device specific issues. The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). -This will only work on Micron devices devices of model numbers 9200 and 54XX. Support -for new devices may be added subsequently. Results for any other device are undefined. +This will only work on Micron devices devices of model numbers 9200 and 54XX. +Support for new devices may be added subsequently. Results for any other device +are undefined. OPTIONS ------- -l :: --package=:: - name of the file (with .zip extension) to save the device logs + name of the file (with .zip extension) to save the device logs EXAMPLES -------- diff --git a/Documentation/nvme-micron-selective-download.txt b/Documentation/nvme-micron-selective-download.txt index 5fb11d79..c20af74f 100644 --- a/Documentation/nvme-micron-selective-download.txt +++ b/Documentation/nvme-micron-selective-download.txt @@ -3,38 +3,41 @@ nvme-micron-selective-download(1) NAME ---- -nvme-micron-selective-download - Performs selective firmware download that allows user -to select which firmware binary to update for 9200 devices. This requires power cycle -once the update completes. +nvme-micron-selective-download - Performs selective firmware download that +allows user select which firmware binary to update for 9200 devices. This +requires power cycle the update completes. SYNOPSIS -------- [verse] -'nvme micron selective-download' [--fw=, -f ] [--select=, -s ] +'nvme micron selective-download' [--fw=, -f ] + [--select=, -s ] DESCRIPTION ----------- -This command uses micron vendor specific nvme commands to download given firmware image to the -specified 9200 device to update selected or all portions of firmware image. +This command uses micron vendor specific nvme commands to download given +firmware image to the 9200 device to update selected or all portions of firmware +image. The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). -This will only work on Micron devices devices of model number 9200. Support for new devices -may be added subsequently. Results for any other device are undefined. +This will only work on Micron devices devices of model number 9200. Support for +new devices be added subsequently. Results for any other device are undefined. OPTIONS ------- -f :: --fw=:: - name of the firmware image file + name of the firmware image file + -s :: --select=:: - flag that has following values - OOB:: This updates the OOB and main firmware\n" - EEP:: This updates the eeprom and main firmware\n" - ALL:: This updates the eeprom, OOB, and main firmware"; + flag that has following values + OOB:: This updates the OOB and main firmware\n" + EEP:: This updates the eeprom and main firmware\n" + ALL:: This updates the eeprom, OOB, and main firmware"; EXAMPLES -------- @@ -42,7 +45,7 @@ EXAMPLES + ------------ # nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=OOB -# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB +# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB ------------ * Update OOB and main firmware diff --git a/Documentation/nvme-micron-smart-add-log.txt b/Documentation/nvme-micron-smart-add-log.txt index 1fd74bac..13e0d968 100644 --- a/Documentation/nvme-micron-smart-add-log.txt +++ b/Documentation/nvme-micron-smart-add-log.txt @@ -9,7 +9,7 @@ or Extended SMART information (OCP complaint models) of given micron device SYNOPSIS -------- [verse] -'nvme micron vs-smart-add-log' -f +'nvme micron vs-smart-add-log' -f DESCRIPTION ----------- @@ -32,8 +32,8 @@ complaint controllers. Support for new devices may be added subsequently. OPTIONS ------- --f controls the format of displayed output. - +-f :: + Controls the format of displayed output. EXAMPLES -------- diff --git a/Documentation/nvme-netapp-ontapdevices.txt b/Documentation/nvme-netapp-ontapdevices.txt index c2927585..fc28947d 100644 --- a/Documentation/nvme-netapp-ontapdevices.txt +++ b/Documentation/nvme-netapp-ontapdevices.txt @@ -8,7 +8,7 @@ nvme-netapp-ontapdevices - Display information about ONTAP devices SYNOPSIS -------- [verse] -'nvme netapp ontapdevices' [-o | --output-format=] +'nvme netapp ontapdevices' [--output-format= | -o ] DESCRIPTION ----------- @@ -19,8 +19,8 @@ OPTIONS ------- -o :: --output-format=:: - Set the reporting format to 'normal' (default), 'column', or - 'json'. Only one output format can be used at a time. + Set the reporting format to 'normal' (default), 'column', or + 'json'. Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-netapp-smdevices.txt b/Documentation/nvme-netapp-smdevices.txt index b66b98d1..cb68acf7 100644 --- a/Documentation/nvme-netapp-smdevices.txt +++ b/Documentation/nvme-netapp-smdevices.txt @@ -8,7 +8,7 @@ nvme-netapp-smdevices - Display information for each NVMe path to an E-Series vo SYNOPSIS -------- [verse] -'nvme netapp smdevices' [-o | --output-format=] +'nvme netapp smdevices' [--output-format= | -o ] DESCRIPTION ----------- diff --git a/Documentation/nvme-ns-descs.txt b/Documentation/nvme-ns-descs.txt index 8afeba58..04c6e51e 100644 --- a/Documentation/nvme-ns-descs.txt +++ b/Documentation/nvme-ns-descs.txt @@ -9,9 +9,8 @@ nvme-ns-descs - Send NVMe Identify for a list of Namespace Identification SYNOPSIS -------- [verse] -'nvme ns-descs' [--namespace-id= | -n ] - [--raw-binary | -b] - [--output-format= | -o ] +'nvme ns-descs' [--namespace-id= | -n ] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -43,11 +42,14 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-ns-rescan.txt b/Documentation/nvme-ns-rescan.txt index cd41870a..5681eabf 100644 --- a/Documentation/nvme-ns-rescan.txt +++ b/Documentation/nvme-ns-rescan.txt @@ -8,7 +8,7 @@ nvme-ns-rescan - Rescans the nvme namespaces. SYNOPSIS -------- [verse] -'nvme ns-rescan' +'nvme ns-rescan' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ be an NVMe character device (ex: /dev/nvme0). OPTIONS ------- -None +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ctrl.txt b/Documentation/nvme-nvm-id-ctrl.txt index fb4a2372..eabc4b1f 100644 --- a/Documentation/nvme-nvm-id-ctrl.txt +++ b/Documentation/nvme-nvm-id-ctrl.txt @@ -8,7 +8,7 @@ nvme-nvm-id-ctrl - Send NVMe Identify Controller, return NVM command set structu SYNOPSIS -------- [verse] -'nvme nvm-id-ctrl' [-o | --output-format=] +'nvme nvm-id-ctrl' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -23,10 +23,14 @@ 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. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ns-lba-format.txt b/Documentation/nvme-nvm-id-ns-lba-format.txt index 638e2fba..1048995c 100644 --- a/Documentation/nvme-nvm-id-ns-lba-format.txt +++ b/Documentation/nvme-nvm-id-ns-lba-format.txt @@ -11,8 +11,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns-lba-format' [--uuid-index= | -U ] [--lba-format-index= | -i ] - [-v | --verbose] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -37,15 +36,15 @@ OPTIONS This field specifies the index into the LBA Format list identifying the LBA Format capabilities that are to be returned +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + -v:: --verbose:: Increase the information detail in the output. --o :: ---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 diff --git a/Documentation/nvme-nvm-id-ns.txt b/Documentation/nvme-nvm-id-ns.txt index dfbbfaa2..5a8cb090 100644 --- a/Documentation/nvme-nvm-id-ns.txt +++ b/Documentation/nvme-nvm-id-ns.txt @@ -10,8 +10,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns' [--uuid-index= | -U ] [--namespace-id= | -n ] - [-v | --verbose] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -37,15 +36,15 @@ OPTIONS --uuid-index=:: UUID Index of the feature +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + -v:: --verbose:: Increase the information detail in the output. --o :: ---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 diff --git a/Documentation/nvme-nvme-mi-recv.txt b/Documentation/nvme-nvme-mi-recv.txt index c636db4b..152bbe67 100755 --- a/Documentation/nvme-nvme-mi-recv.txt +++ b/Documentation/nvme-nvme-mi-recv.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] 'nvme nvme-mi-recv' [--opcode= | -O ] - [--namespace-id= | -n ] - [--data-len= | -l ] - [--nmimt= | -m ] - [--nmd0= | -0 ] - [--nmd1= | -1 ] - [--input-file= | -i ] + [--namespace-id= | -n ] + [--data-len= | -l ] + [--nmimt= | -m ] + [--nmd0= | -0 ] [--nmd1= | -1 ] + [--input-file= | -i ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -57,6 +57,15 @@ OPTIONS to fill the buffer sent to the device. If no file is given, assumed to use STDIN. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Has the program issue a nvme-mi-recv to execute the VPD read. diff --git a/Documentation/nvme-nvme-mi-send.txt b/Documentation/nvme-nvme-mi-send.txt index b759e2c5..0e80fe7a 100755 --- a/Documentation/nvme-nvme-mi-send.txt +++ b/Documentation/nvme-nvme-mi-send.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] 'nvme nvme-mi-send' [--opcode= | -O ] - [--namespace-id= | -n ] - [--data-len= | -l ] - [--nmimt= | -m ] - [--nmd0= | -0 ] - [--nmd1= | -1 ] - [--input-file= | -i ] + [--namespace-id= | -n ] + [--data-len= | -l ] + [--nmimt= | -m ] + [--nmd0= | -0 ] [--nmd1= | -1 ] + [--input-file= | -i ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -57,6 +57,15 @@ OPTIONS to fill the buffer sent to the device. If no file is given, assumed to use STDIN. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Has the program issue a nvme-mi-send to execute the VPD write. diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.txt b/Documentation/nvme-ocp-clear-fw-activate-history.txt index 20ec7240..335a2288 100644 --- a/Documentation/nvme-ocp-clear-fw-activate-history.txt +++ b/Documentation/nvme-ocp-clear-fw-activate-history.txt @@ -34,7 +34,7 @@ OPTIONS -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) EXAMPLES -------- diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt index 92cd1487..3d5706d9 100644 --- a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt +++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt @@ -34,7 +34,7 @@ OPTIONS -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) EXAMPLES -------- diff --git a/Documentation/nvme-ocp-device-capability-log.txt b/Documentation/nvme-ocp-device-capability-log.txt index 77895319..d2f07613 100644 --- a/Documentation/nvme-ocp-device-capability-log.txt +++ b/Documentation/nvme-ocp-device-capability-log.txt @@ -24,8 +24,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json' or 'binary'. Only one output format can be used at a time. The default is normal. diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.txt b/Documentation/nvme-ocp-eol-plp-failure-mode.txt index 9a47375b..0ebc4ab7 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.txt +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.txt @@ -3,13 +3,15 @@ nvme-ocp-eol-plp-failure-mode(1) NAME ---- -nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure mode +nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure +mode SYNOPSIS -------- [verse] -'nvme ocp eol-plp-failure-mode' [--mode= | -m ] [--no-uuid | -n] [--save | -s] - [--sel=] +'nvme ocp eol-plp-failure-mode' [--mode= | -m ] + [--no-uuid | -n] [--save | -s] + [--sel=] DESCRIPTION ----------- @@ -29,17 +31,18 @@ OPTIONS -m :: --mode=:: Set the EOL or PLP circuitry failure mode to [0-3] ('0: default', - '1: rom', '2: wtm' or '3: normal'). Only one mode + '1: rom', '2: wtm' or '3: normal'). Only one mode can be used at a time. The default is rom. -n:: --no-uuid:: Do not try to automatically detect UUID index for this command (required - for old OCP 1.0 support) + for old OCP 1.0 support) -s:: --save:: - Save the attribute so that it persists through all power states and resets. + Save the attribute so that it persists through all power states and + resets. -s :: diff --git a/Documentation/nvme-ocp-error-recovery-log.txt b/Documentation/nvme-ocp-error-recovery-log.txt index 1ce9dd13..7a261503 100644 --- a/Documentation/nvme-ocp-error-recovery-log.txt +++ b/Documentation/nvme-ocp-error-recovery-log.txt @@ -24,8 +24,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json' or 'binary'. Only one output format can be used at a time. The default is normal. diff --git a/Documentation/nvme-ocp-latency-monitor-log.txt b/Documentation/nvme-ocp-latency-monitor-log.txt index 66f760c5..a67c5237 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.txt +++ b/Documentation/nvme-ocp-latency-monitor-log.txt @@ -26,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. The default is normal. diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt index 7dfe9ea8..c9ae5783 100644 --- a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt +++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt @@ -8,8 +8,9 @@ nvme-ocp-set-dssd-power-state-feature - Set DSSD Power State SYNOPSIS -------- [verse] -'nvme ocp set-dssd-power-state-feature' [--power-state= | -p ] [--no-uuid | -n] - [--save | -s] +'nvme ocp set-dssd-power-state-feature' + [--power-state= | -p ] [--no-uuid | -n] + [--save | -s] DESCRIPTION ----------- @@ -25,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --p :: ---power-state=:: +-p :: +--power-state=:: DSSD Power State to set in watts. EXAMPLES diff --git a/Documentation/nvme-ocp-smart-add-log.txt b/Documentation/nvme-ocp-smart-add-log.txt index 3a258227..66a55a90 100644 --- a/Documentation/nvme-ocp-smart-add-log.txt +++ b/Documentation/nvme-ocp-smart-add-log.txt @@ -26,8 +26,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. The default is normal. diff --git a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt index 65818d36..1657f6aa 100644 --- a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt +++ b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt @@ -27,8 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: This option will set the reporting format to normal, json, or binary. Only one output format can be used at a time. diff --git a/Documentation/nvme-persistent-event-log.txt b/Documentation/nvme-persistent-event-log.txt index 833491f4..cf1cbad1 100644 --- a/Documentation/nvme-persistent-event-log.txt +++ b/Documentation/nvme-persistent-event-log.txt @@ -10,9 +10,8 @@ SYNOPSIS -------- [verse] 'nvme persistent-event-log' [--action= | -a ] - [--log-len= | -l ] - [--raw-binary | -b] - [--output-format= | -o ] + [--log-len= | -l ] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -31,28 +30,32 @@ OPTIONS ------- -a :: --action=:: - While try to retrieve this log action the controller shall take - during processing this persistent log page command. This mandatory - field, based on the value issued it may Read Log Data, Establish - Context and Read Log Data or Release Context can occur. For More - details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent - Event Log (Log Identifier 0Dh) + While try to retrieve this log action the controller shall take + during processing this persistent log page command. This mandatory + field, based on the value issued it may Read Log Data, Establish + Context and Read Log Data or Release Context can occur. For More + details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent + Event Log (Log Identifier 0Dh) -l :: --log-len=:: - Allocates a buffer of bytes size and requests this - many bytes be returned in the constructed NVMe command. This - param is mandatory. If given is 0 and action is 0, - it will read the Total Log Length(TLL) of the page. + Allocates a buffer of bytes size and requests this + many bytes be returned in the constructed NVMe command. This + param is mandatory. If given is 0 and action is 0, + it will read the Total Log Length(TLL) of the page. -b:: --raw-binary:: - Print the raw persistent event log buffer to stdout. + Print the raw persistent event log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-phy-rx-eom-log.txt b/Documentation/nvme-phy-rx-eom-log.txt index 015c851e..d5e0235b 100644 --- a/Documentation/nvme-phy-rx-eom-log.txt +++ b/Documentation/nvme-phy-rx-eom-log.txt @@ -3,14 +3,15 @@ nvme-phy-rx-eom-log(1) NAME ---- -nvme-phy-rx-eom-log - Retrieves a Physical Interface Receiver Eye Opening Measurement log page from an NVMe device +nvme-phy-rx-eom-log - Retrieves a Physical Interface Receiver Eye Opening +Measurement log page from an NVMe device SYNOPSIS -------- [verse] 'nvme phy-rx-eom-log' [--lsp= | -s ] - [--controller= | -c ] - [--output-format= | -o ] + [--controller= | -c ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -34,10 +35,19 @@ OPTIONS Controller ID of the controller associated wit the PCIe port to be measured. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- @@ -53,7 +63,6 @@ EXAMPLES # nvme phy-rx-eom-log /dev/nvme0 --lsp=2 --controller=3 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-pred-lat-event-agg-log.txt b/Documentation/nvme-pred-lat-event-agg-log.txt index b01c9bb0..6fb8accb 100644 --- a/Documentation/nvme-pred-lat-event-agg-log.txt +++ b/Documentation/nvme-pred-lat-event-agg-log.txt @@ -9,9 +9,10 @@ Page request, returns result and log SYNOPSIS -------- [verse] -'nvme pred-lat-event-agg-log' [--log-entries= | -e ] +'nvme pred-lat-event-agg-log' + [--log-entries= | -e ] [--rae | -r] [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -31,11 +32,11 @@ OPTIONS ------- -e :: --log-entries=:: - Retrieve the Predictable Latency Event Aggregate Log pending entries. - This argument is mandatory and its success may depend on the device's - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.11. The maximum number of log entries supported is 2044 - for the device. + Retrieve the Predictable Latency Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.11. The maximum number of log entries supported is 2044 + for the device. -r:: --rae:: @@ -45,10 +46,10 @@ OPTIONS --raw-binary:: Print the raw Predictable Latency Event Aggregate log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. + Only one output format can be used at a time. EXAMPLES -------- diff --git a/Documentation/nvme-predictable-lat-log.txt b/Documentation/nvme-predictable-lat-log.txt index d1dde80d..f0b2ad35 100644 --- a/Documentation/nvme-predictable-lat-log.txt +++ b/Documentation/nvme-predictable-lat-log.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme predictable-lat-log' [--nvmset-id= | -i ] [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -30,19 +30,23 @@ OPTIONS ------- -i :: --nvmset-id=:: - Retrieve the Predictable latency per NVM set log for the given nvmset id. - This argument is mandatory and its success may depend on the device's - statistics to provide this log For More details see NVM Express 1.4 Spec. - Section 5.14.1.10. The default nvmset id to use is 1 for the device. + Retrieve the Predictable latency per NVM set log for the given nvmset id. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.10. The default nvmset id to use is 1 for the device. -b:: --raw-binary:: Print the raw Predictable latency per NVM set log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-primary-ctrl-caps.txt b/Documentation/nvme-primary-ctrl-caps.txt index 3edf5c1a..0300383e 100644 --- a/Documentation/nvme-primary-ctrl-caps.txt +++ b/Documentation/nvme-primary-ctrl-caps.txt @@ -8,7 +8,7 @@ nvme-primary-ctrl-caps - Send identify Primary Controller Caps, return result an SYNOPSIS -------- [verse] -'nvme primary-ctrl-caps' [-o | --output-format=] +'nvme primary-ctrl-caps' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -24,16 +24,20 @@ raw buffer may be printed to stdout. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields into human-readable formats. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Get Primary Ctrl Caps of the device in default format diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index 2f5d174c..cecaa711 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -18,17 +18,13 @@ SYNOPSIS [--prinfo= | -p ] [--app-tag-mask= | -m ] [--app-tag= | -a ] - [--limited-retry | -l] - [--force-unit-access | -f] + [--limited-retry | -l] [--force-unit-access | -f] [--dir-type= | -T ] - [--dir-spec= | -S ] - [--dsm= | -D ] - [--show-command | -V] - [--dry-run | -w] - [--latency | -t] + [--dir-spec= | -S ] [--dsm= | -D ] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag | -g ] - [--storage-tag-check | -C ] - [--force] + [--storage-tag-check | -C] [--force] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -38,34 +34,34 @@ by default if you don't provide a file. OPTIONS ------- ---start-block=:: -s :: +--start-block=:: Start block. ---block-count:: -c:: +--block-count:: The number of blocks to transfer. This is a zeroes based value to align with the kernel's use of this field. (ie. 0 means transfer 1 block). ---data-size=:: -z :: +--data-size=:: Size of data, in bytes. ---metadata-size=:: -y :: +--metadata-size=:: Size of metadata in bytes. ---data=:: -d :: +--data=:: Data file. If none provided, contents are sent to STDOUT. ---metadata=:: -M :: +--metadata=:: Metadata file, if necessary. ---prinfo=:: -p :: +--prinfo=:: Protection Information field definition. + [] @@ -80,16 +76,16 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=:: -r :: +--ref-tag=:: Optional reftag when used with protection information. ---app-tag-mask=:: -m :: +--app-tag-mask=:: Optional application tag mask when used with protection information. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. -T :: @@ -144,6 +140,15 @@ metadata is passes. Ignore namespace is currently busy and performed the operation even though. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-reset.txt b/Documentation/nvme-reset.txt index d1a282bc..20fcbb10 100644 --- a/Documentation/nvme-reset.txt +++ b/Documentation/nvme-reset.txt @@ -8,7 +8,7 @@ nvme-reset - Reset the nvme controller. SYNOPSIS -------- [verse] -'nvme reset' +'nvme reset' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +17,14 @@ be an NVMe character device (ex: /dev/nvme0). OPTIONS ------- -None +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-resv-acquire.txt b/Documentation/nvme-resv-acquire.txt index 1b6e110c..19282c6a 100644 --- a/Documentation/nvme-resv-acquire.txt +++ b/Documentation/nvme-resv-acquire.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] 'nvme resv-acquire' [--namespace-id= | -n ] - [--crkey= | -c ] - [--prkey= | -p ] - [--rtype= | -t ] - [--racqa= | -a ] - [--iekey | -i] + [--crkey= | -c ] + [--prkey= | -p ] + [--rtype= | -t ] + [--racqa= | -a ] [--iekey | -i] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -79,10 +79,19 @@ OPTIONS --iekey:: Ignore Existing Key: If this bit is set to a '1', then the Current Reservation Key (CRKEY) check is disabled and the command - shall succeed regardless of the CRKEY field value. + shall succeed regardless of the CRKEY field value. + Indicator option, defaults to '0'. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-notif-log.txt b/Documentation/nvme-resv-notif-log.txt index a9c5cdda..f8d828bc 100644 --- a/Documentation/nvme-resv-notif-log.txt +++ b/Documentation/nvme-resv-notif-log.txt @@ -4,12 +4,12 @@ nvme-resv-notif-log(1) NAME ---- nvme-resv-notif-log - Send NVMe Reservation Notification log page request, - return result and log +return result and log SYNOPSIS -------- [verse] -'nvme resv-notif-log' [--output-format= | -o ] +'nvme resv-notif-log' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -26,10 +26,14 @@ may be printed to stdout for another program to parse. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-resv-register.txt b/Documentation/nvme-resv-register.txt index e0553f42..4a830506 100644 --- a/Documentation/nvme-resv-register.txt +++ b/Documentation/nvme-resv-register.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] 'nvme resv-register' [--namespace-id= | -n ] - [--crkey= | -c ] - [--nrkey= | -k ] - [--rrega= | -r ] - [--cptpl= | -p ] - [--iekey | -i] + [--crkey= | -c ] + [--nrkey= | -k ] + [--rrega= | -r ] + [--cptpl= | -p ] [--iekey | -i] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -84,6 +84,15 @@ a power loss. + Indicator option, defaults to '0'. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt index 6eb0b43c..c3dc90d3 100644 --- a/Documentation/nvme-resv-release.txt +++ b/Documentation/nvme-resv-release.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] 'nvme resv-release' [--namespace-id= | -n ] - [--crkey= | -c ] - [--rtype= | -t ] - [--rrela= | -a ] - [--iekey | -i] + [--crkey= | -c ] + [--rtype= | -t ] + [--rrela= | -a ] [--iekey | -i] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -75,6 +75,15 @@ OPTIONS + Indicator option, defaults to '0'. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet diff --git a/Documentation/nvme-resv-report.txt b/Documentation/nvme-resv-report.txt index 32012fed..2e12826e 100644 --- a/Documentation/nvme-resv-report.txt +++ b/Documentation/nvme-resv-report.txt @@ -9,10 +9,9 @@ SYNOPSIS -------- [verse] 'nvme resv-report' [--namespace-id= | -n ] - [--numd= | -d ] - [--eds | -e] + [--numd= | -d ] [--eds | -e] [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -48,11 +47,14 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-rpmb.txt b/Documentation/nvme-rpmb.txt index c30c83d8..9dc954db 100644 --- a/Documentation/nvme-rpmb.txt +++ b/Documentation/nvme-rpmb.txt @@ -9,13 +9,13 @@ SYNOPSIS -------- [verse] 'nvme rpmb' [--cmd= | -c ] - [--msgfile= | -f ] - [--keyfile= | -g ] - [--key= | -k ] - [--msg= | -d ] - [--address= | -o ] - [--blocks=<512 byte sectors> | -b ] - [--target= | -t ] + [--msgfile= | -f ] + [--keyfile= | -g ] + [--key= | -k ] [--msg= | -d ] + [--address= | -o ] + [--blocks=<512 byte sectors> | -b ] + [--target= | -t ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -71,7 +71,7 @@ OPTIONS nvme-rpmb without sending it to device. RPMB target 0 is used as the default target if --target or -t is not specified. 0x0 is used as the default address if no -address or -o option is specified, - + -t :: --target=:: RPMB target id. This should be one of the supported RPMB targets as @@ -105,6 +105,15 @@ OPTIONS The size in 512 byte sectors to be used for data transfer commands (read or write) for a specified RPMB target. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Print RPMB support information of an NVMe device @@ -147,4 +156,3 @@ EXAMPLES NVME ---- Part of the nvme-user suite - diff --git a/Documentation/nvme-sanitize-log.txt b/Documentation/nvme-sanitize-log.txt index 3c2d43ea..af45e9fc 100644 --- a/Documentation/nvme-sanitize-log.txt +++ b/Documentation/nvme-sanitize-log.txt @@ -8,9 +8,9 @@ nvme-sanitize-log - Send NVMe sanitize-log Command, return result SYNOPSIS -------- [verse] -'nvme sanitize-log' [--rae | -r] [--output-format= | -o ] - [--human-readable | -H] - [--raw-binary | -b] +'nvme sanitize-log' [--rae | -r] [--human-readable | -H] + [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -41,11 +41,11 @@ Expected status and description :- |Global Data Erased bit If set to 1 then non-volatile storage in the NVM subsystem has not been written to: - a) since being manufactured and the NVM subsystem has never been sanitized; or - b) since the most recent successful sanitize operation. + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation. If cleared to 0, then non-volatile storage in the NVM subsystem has been written to: - a) since being manufactured and the NVM subsystem has never been sanitized; or - b) since the most recent successful sanitize operation of the NVM subsystem. + a) since being manufactured and the NVM subsystem has never been sanitized; or + b) since the most recent successful sanitize operation of the NVM subsystem. |=== Sanitize Progress - percentage complete @@ -58,11 +58,6 @@ OPTIONS --rae:: Retain an Asynchronous Event. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. - -H:: --human-readable:: This option will parse and format many of the bit fields @@ -73,6 +68,15 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. This overrides the vendor specific and human readable options. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Has the program issue Sanitize-log Command : diff --git a/Documentation/nvme-sanitize.txt b/Documentation/nvme-sanitize.txt index c3b9af22..1e434632 100644 --- a/Documentation/nvme-sanitize.txt +++ b/Documentation/nvme-sanitize.txt @@ -8,13 +8,12 @@ nvme-sanitize - Send NVMe Sanitize Command, return result SYNOPSIS -------- [verse] -'nvme sanitize' [--no-dealloc | -d] - [--oipbp | -i] - [--owpass= | -n ] - [--ause | -u] - [--sanact= | -a ] - [--ovrpat= | -p ] - [--force] +'nvme sanitize' [--no-dealloc | -d] [--oipbp | -i] + [--owpass= | -n ] + [--ause | -u] [--sanact= | -a ] + [--ovrpat= | -p ] + [--force] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -29,42 +28,42 @@ OPTIONS ------- -d:: --no-dealloc:: - No Deallocate After Sanitize: - If set, then the controller shall not deallocate any logical - blocks as a result of successfully completing the sanitize - operation. If cleared, then the controller should deallocate - logical blocks as a result of successfully completing the - sanitize operation. This bit shall be ignored if the Sanitize - Action field is set to 001b (i.e., Exit Failure Mode). + No Deallocate After Sanitize: + If set, then the controller shall not deallocate any logical + blocks as a result of successfully completing the sanitize + operation. If cleared, then the controller should deallocate + logical blocks as a result of successfully completing the + sanitize operation. This bit shall be ignored if the Sanitize + Action field is set to 001b (i.e., Exit Failure Mode). -i:: --oipbp:: - Overwrite Invert Pattern Between Passes: - If set, then the Overwrite Pattern shall be inverted between - passes. If cleared, then the overwrite pattern shall not be - inverted between passes. This bit shall be ignored unless the - Sanitize Action field is set to 011b (i.e., Overwrite). + Overwrite Invert Pattern Between Passes: + If set, then the Overwrite Pattern shall be inverted between + passes. If cleared, then the overwrite pattern shall not be + inverted between passes. This bit shall be ignored unless the + Sanitize Action field is set to 011b (i.e., Overwrite). -n :: --owpass=:: - Overwrite Pass Count: - This field specifies the number of overwrite passes (i.e., - how many times the media is to be overwritten) using the data - from the Overwrite Pattern field of this command. A value of 0 - specifies 16 overwrite passes. This field shall be ignored - unless the Sanitize Action field is set to 011b (i.e., Overwrite). + Overwrite Pass Count: + This field specifies the number of overwrite passes (i.e., + how many times the media is to be overwritten) using the data + from the Overwrite Pattern field of this command. A value of 0 + specifies 16 overwrite passes. This field shall be ignored + unless the Sanitize Action field is set to 011b (i.e., Overwrite). -u:: --ause:: - Allow Unrestricted Sanitize Exit: - If set, then the sanitize operation is performed in unrestricted - completion mode. If cleared then the sanitize operation is - performed in restricted completion mode. This bit shall be ignored - if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode). + Allow Unrestricted Sanitize Exit: + If set, then the sanitize operation is performed in unrestricted + completion mode. If cleared then the sanitize operation is + performed in restricted completion mode. This bit shall be ignored + if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode). -a :: --sanact=:: - Sanitize Action: + Sanitize Action: + [] |================= @@ -78,15 +77,24 @@ OPTIONS -p :: --ovrpat=:: - Overwrite Pattern: - This field is ignored unless the Sanitize Action field in - Command Dword 10 is set to 011b (i.e., Overwrite). This field - specifies a 32-bit pattern that is used for the Overwrite - sanitize operation. + Overwrite Pattern: + This field is ignored unless the Sanitize Action field in + Command Dword 10 is set to 011b (i.e., Overwrite). This field + specifies a 32-bit pattern that is used for the Overwrite + sanitize operation. --force:: - Ignore namespace is currently busy and performed the operation - even though. + Ignore namespace is currently busy and performed the operation + even though. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.txt b/Documentation/nvme-seagate-clear-fw-activate-history.txt index 2b172222..01f018b7 100644 --- a/Documentation/nvme-seagate-clear-fw-activate-history.txt +++ b/Documentation/nvme-seagate-clear-fw-activate-history.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The '' may be either an NVMe character device (ex: /dev/nvme0) or an @@ -22,7 +22,7 @@ OPTIONS ------- -s --save:: - specifies that the controller shall save the attribute. + specifies that the controller shall save the attribute. EXAMPLES -------- diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt index 33952d38..1239f83f 100644 --- a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt @@ -8,12 +8,12 @@ nvme-seagate-clear-pcie-correctable-errors - Clear Seagate PCIe error statistics SYNOPSIS -------- [verse] -'nvme seagate clear-pcie-correctable-errors [] [OPTIONS]' +'nvme seagate clear-pcie-correctable-errors [] [OPTIONS]' DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The '' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0), or an @@ -23,7 +23,7 @@ OPTIONS ------- -s:: --save:: - Specifies that the controller shall save the attribute + Specifies that the controller shall save the attribute EXAMPLES -------- diff --git a/Documentation/nvme-seagate-get-ctrl-tele.txt b/Documentation/nvme-seagate-get-ctrl-tele.txt index e170548c..4bb7362e 100644 --- a/Documentation/nvme-seagate-get-ctrl-tele.txt +++ b/Documentation/nvme-seagate-get-ctrl-tele.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The ''parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an @@ -23,11 +23,11 @@ OPTIONS ------- -n :: --namespace-id=:: - Desired namespace + Desired namespace -b:: --raw-binary:: - Output in raw format + Output in raw format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-get-host-tele.txt b/Documentation/nvme-seagate-get-host-tele.txt index 2863c123..83cdefc9 100644 --- a/Documentation/nvme-seagate-get-host-tele.txt +++ b/Documentation/nvme-seagate-get-host-tele.txt @@ -13,26 +13,27 @@ SYNOPSIS DESCRIPTION ----------- -This will only work on Seagate devices supporting this feature. Not all +This will only work on Seagate devices supporting this feature. Not all commands work across all product families. -The '' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an -nvme block device (ex: /dev/nvme0n1). +The '' parameter is mandatory and may be either an NVMe character device +(ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1). OPTIONS ------- -n :: --namespace-id=:: - desired namespace + desired namespace -i :: --log_specific=:: - 1 - controller shall capture Data representing the internal state of the controller at the time the command is processed. - 0 - controller shall not update the Telemetry Host Initiated Data. + 1 - controller shall capture Data representing the internal state of the + controller at the time the command is processed. + 0 - controller shall not update the Telemetry Host Initiated Data. -b:: --raw-binary:: - output in raw format + output in raw format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.txt b/Documentation/nvme-seagate-vs-fw-activate-history.txt index e6b030d2..8df58b46 100644 --- a/Documentation/nvme-seagate-vs-fw-activate-history.txt +++ b/Documentation/nvme-seagate-vs-fw-activate-history.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The '' may be either an NVMe character device (ex: /dev/nvme0) or an @@ -23,11 +23,11 @@ OPTIONS ------- -n :: --namespace-id=:: - Desired namespace + Desired namespace -f :: --dump-file=:: - Dump file + Dump file EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-internal-log.txt b/Documentation/nvme-seagate-vs-internal-log.txt index 32840204..4a895bcb 100644 --- a/Documentation/nvme-seagate-vs-internal-log.txt +++ b/Documentation/nvme-seagate-vs-internal-log.txt @@ -13,25 +13,26 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. -The '' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an -nvme block device (ex: /dev/nvme0n1). +The '' parameter is mandatory and may be either an NVMe character device +(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1). OPTIONS ------- -n :: --namespace-id=:: - Desired namespace + Desired namespace -f :: --dump-file=:: - Dump file + Dump file EXAMPLES -------- -Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device. +Get the Seagate vendor specific Controller-Initiated telemetry log for the +specified device. ------------ # nvme seagate vs-internal-log /dev/nvme0 diff --git a/Documentation/nvme-seagate-vs-log-page-sup.txt b/Documentation/nvme-seagate-vs-log-page-sup.txt index a5d1488f..55c65fd1 100644 --- a/Documentation/nvme-seagate-vs-log-page-sup.txt +++ b/Documentation/nvme-seagate-vs-log-page-sup.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The '' may be either an NVMe character device (ex: /dev/nvme0) or an @@ -21,9 +21,9 @@ NVMe block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format +-o :: +--output-format=:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-pcie-stats.txt b/Documentation/nvme-seagate-vs-pcie-stats.txt index 74599bfb..86f87a3d 100644 --- a/Documentation/nvme-seagate-vs-pcie-stats.txt +++ b/Documentation/nvme-seagate-vs-pcie-stats.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The '' parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an @@ -21,9 +21,9 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format +-o :: +--output-format=:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-smart-add-log.txt b/Documentation/nvme-seagate-vs-smart-add-log.txt index 962a109e..836220a6 100644 --- a/Documentation/nvme-seagate-vs-smart-add-log.txt +++ b/Documentation/nvme-seagate-vs-smart-add-log.txt @@ -24,23 +24,23 @@ The log contents may be associated with the controller, in which case the namesp Two logs exist, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM Supercap SMART log page) -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. OPTIONS ------- -l :: --log=:: - Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM - Supercap SMART log page) + Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM + Supercap SMART log page) -n :: --namespace-id=:: - Namespace number + Namespace number -o :: --output-file=:: - Output in binary format. Defaults to text-formatted dump to stdout + Output in binary format. Defaults to text-formatted dump to stdout EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-temperature-stats.txt b/Documentation/nvme-seagate-vs-temperature-stats.txt index 2691e305..58a9f116 100644 --- a/Documentation/nvme-seagate-vs-temperature-stats.txt +++ b/Documentation/nvme-seagate-vs-temperature-stats.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -This command will only work on Seagate devices supporting this feature. Not +This command will only work on Seagate devices supporting this feature. Not all commands work across all product families. The ''parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an @@ -21,9 +21,9 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format +-o :: +--output-format=:: + Output in binary format EXAMPLES -------- diff --git a/Documentation/nvme-security-recv.txt b/Documentation/nvme-security-recv.txt index 0b9fe99c..ef775312 100644 --- a/Documentation/nvme-security-recv.txt +++ b/Documentation/nvme-security-recv.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] 'nvme security-recv' [--size= | -x ] - [--secp= | -p ] - [--spsp= | -s ] - [--nssf= | -N ] - [--al= | -t ] - [--namespace-id= | -n ] - [--raw-binary | -b] + [--secp= | -p ] + [--spsp= | -s ] + [--nssf= | -N ] + [--al= | -t ] + [--namespace-id= | -n ] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -71,6 +71,15 @@ OPTIONS --raw-binary:: Print the raw buffer to stdout. Defaults to print in hex. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-security-send.txt b/Documentation/nvme-security-send.txt index ae226281..347b9701 100644 --- a/Documentation/nvme-security-send.txt +++ b/Documentation/nvme-security-send.txt @@ -9,11 +9,12 @@ SYNOPSIS -------- [verse] 'nvme security-send' [--file= | -f ] - [--secp= | -p ] - [--spsp= | -s ] - [--tl= | -t ] - [--nssf= | -N ] - [--namespace-id= | -n ] + [--secp= | -p ] + [--spsp= | -s ] + [--tl= | -t ] + [--nssf= | -N ] + [--namespace-id= | -n ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -63,6 +64,15 @@ OPTIONS Transfer Length: The value of this field is specific to the Security Protocol as defined in SPC-4. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No Examples diff --git a/Documentation/nvme-self-test-log.txt b/Documentation/nvme-self-test-log.txt index 56a3c4ac..d4600e8a 100644 --- a/Documentation/nvme-self-test-log.txt +++ b/Documentation/nvme-self-test-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme self-test'-log [--log-entries= | -e ] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -35,11 +35,14 @@ OPTION the device. This must be at least one, and shouldn't exceed the 20 entries. Defaults to 20 DST log entries. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-set-feature.txt b/Documentation/nvme-set-feature.txt index 993e0080..05c22102 100644 --- a/Documentation/nvme-set-feature.txt +++ b/Documentation/nvme-set-feature.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] 'nvme set-feature' [--namespace-id= | -n ] - [--feature-id= | -f ] [--value= | -V ] - [--uuid-index= | -U ] - [--data-len= | -l ] - [--data= | -d ] - [--save | -s] + [--feature-id= | -f ] [--value= | -V ] + [--uuid-index= | -U ] + [--data-len= | -l ] + [--data= | -d ] [--save | -s] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -64,9 +64,18 @@ OPTIONS --uuid-index=:: UUID Index of the feature +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- -* Sets the Power State (PS) to 1 in feature id 2: +* Sets the Power State (PS) to 1 in feature id 2: + ------------ # nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1 diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt index 0ea0d137..22a513c8 100644 --- a/Documentation/nvme-set-property.txt +++ b/Documentation/nvme-set-property.txt @@ -10,8 +10,8 @@ SYNOPSIS -------- [verse] 'nvme set-property' [--offset= | -O ] - [--value= | -V ] - + [--value= | -V ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -21,12 +21,21 @@ OPTIONS ------- -O:: --offset:: - The offset of the property. + The offset of the property. -V:: --value: The value of the property to be set. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples (yet). diff --git a/Documentation/nvme-show-hostnqn.txt b/Documentation/nvme-show-hostnqn.txt index 047e2910..5074e2c8 100644 --- a/Documentation/nvme-show-hostnqn.txt +++ b/Documentation/nvme-show-hostnqn.txt @@ -8,17 +8,24 @@ nvme-show-hostnqn - Show the host NQN configured for the system SYNOPSIS -------- [verse] -'nvme show-hostnqn' +'nvme show-hostnqn' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- -Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is +Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is not present and systemd application-specific machine IDs are available, this will show the systemd-generated host NQN for the system. OPTIONS ------- -No options needed +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-show-regs.txt b/Documentation/nvme-show-regs.txt index 892b3944..0460365f 100644 --- a/Documentation/nvme-show-regs.txt +++ b/Documentation/nvme-show-regs.txt @@ -9,8 +9,8 @@ NVMe over PCIe or the controller properties for NVMe over Fabrics. SYNOPSIS -------- [verse] -'nvme show-regs' [--human-readable | -H] - [--output-format= | -o ] +'nvme show-regs' [--human-readable | -H] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -30,12 +30,16 @@ OPTIONS ------- -H:: --human-readable:: - Display registers or supported properties in human readable format. + Display registers or supported properties in human readable format. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-show-topology.txt b/Documentation/nvme-show-topology.txt index f0583fbc..32ffad1e 100644 --- a/Documentation/nvme-show-topology.txt +++ b/Documentation/nvme-show-topology.txt @@ -8,7 +8,7 @@ nvme-show-topology - Show topology of all NVMe subsystems SYNOPSIS -------- [verse] -'nvme show-topology' +'nvme show-topology' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -16,8 +16,8 @@ Show the topology of all NVMe subsystems. OPTIONS ------- --o :: ---output-format=:: +-o :: +--output-format=:: Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. @@ -33,6 +33,15 @@ OPTIONS has only an effect for output format 'normal'. The JSON output is always 'namespace' ordered. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- nvme show-topology diff --git a/Documentation/nvme-smart-log.txt b/Documentation/nvme-smart-log.txt index 77d00151..c08f523c 100644 --- a/Documentation/nvme-smart-log.txt +++ b/Documentation/nvme-smart-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme smart-log' [--namespace-id= | -n ] [--raw-binary | -b] - [--output-format= | -o ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -38,10 +38,14 @@ OPTIONS --raw-binary:: Print the raw SMART log buffer to stdout. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-subsystem-reset.txt b/Documentation/nvme-subsystem-reset.txt index 2267acdd..cc3a139f 100644 --- a/Documentation/nvme-subsystem-reset.txt +++ b/Documentation/nvme-subsystem-reset.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme subsystem-reset' + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -17,7 +18,14 @@ be an NVMe character device (ex: /dev/nvme0). OPTIONS ------- -None +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. EXAMPLES -------- diff --git a/Documentation/nvme-supported-cap-config-log.txt b/Documentation/nvme-supported-cap-config-log.txt index 00506340..b60303bc 100644 --- a/Documentation/nvme-supported-cap-config-log.txt +++ b/Documentation/nvme-supported-cap-config-log.txt @@ -9,9 +9,8 @@ Configuration List Log pages request, returns result and log. SYNOPSIS -------- [verse] -'nvme supported-cap-config-log' [--dom-id | -d ] - [--output-format= | -o ] - [--raw-binary | -b] +'nvme supported-cap-config-log' [--dom-id | -d] [--raw-binary | -b] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -27,19 +26,23 @@ pages log structure will be printed. OPTIONS ------- - --o :: ---output-format=:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. - -d:: --dom-id:: - To get the domain ID. + To get the domain ID. + -b:: --raw-binary:: To show raw binary data. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples provided yet. diff --git a/Documentation/nvme-supported-log-pages.txt b/Documentation/nvme-supported-log-pages.txt index f80aa5f8..bd17fdf3 100644 --- a/Documentation/nvme-supported-log-pages.txt +++ b/Documentation/nvme-supported-log-pages.txt @@ -8,8 +8,7 @@ nvme-supported-log-pages - Send NVMe Supported Log pages request, returns result SYNOPSIS -------- [verse] -'nvme supported-log-pages' [--output-format= | -o ] - [--verbose | -v] +'nvme supported-log-pages' [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -25,14 +24,15 @@ for each command that is supported. OPTIONS ------- --o :: ---output-format=:: - This option will set the reporting format to normal, json, or binary. - Only one output format can be used at a time. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. -v:: --verbose:: - Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details. + Increase the information detail in the output. Show more information + including LID Supported (LSUPP) and Index Offset Supported (IOP) details. EXAMPLES -------- diff --git a/Documentation/nvme-telemetry-log.txt b/Documentation/nvme-telemetry-log.txt index 576401b9..4d2a494e 100644 --- a/Documentation/nvme-telemetry-log.txt +++ b/Documentation/nvme-telemetry-log.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme telemetry-log' [--output-file= | -O ] - [--host-generate= | -g ] + [--host-generate= | -g ] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -41,6 +42,15 @@ OPTIONS this option is not specified, the default value is 3, since data area 4 may not be supported. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- * Retrieve Telemetry Host-Initiated data to telemetry_log.bin diff --git a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt index 58719000..862c8601 100644 --- a/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt @@ -10,7 +10,6 @@ SYNOPSIS [verse] 'nvme toshiba clear-pcie-correctable-errors ' - DESCRIPTION ----------- For the NVMe device given, sends the Toshiba clear PCIe correctable errors @@ -20,7 +19,6 @@ The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). - EXAMPLES -------- * Clear the PCIe correctable errors count: diff --git a/Documentation/nvme-toshiba-vs-internal-log.txt b/Documentation/nvme-toshiba-vs-internal-log.txt index d3c01040..3cfb9175 100644 --- a/Documentation/nvme-toshiba-vs-internal-log.txt +++ b/Documentation/nvme-toshiba-vs-internal-log.txt @@ -34,12 +34,10 @@ A progress runner is included when data is written to file and a page count is i OPTIONS ------- - -o :: --output-file=:: Output binary file. Defaults to text-formatted dump to stdout - -p:: --prev-log:: Use previous log contents. Defaults to the current log contents. diff --git a/Documentation/nvme-toshiba-vs-smart-add-log.txt b/Documentation/nvme-toshiba-vs-smart-add-log.txt index 8ea4d3e0..96a13cac 100644 --- a/Documentation/nvme-toshiba-vs-smart-add-log.txt +++ b/Documentation/nvme-toshiba-vs-smart-add-log.txt @@ -3,7 +3,8 @@ nvme-toshiba-vs-smart-add-log(1) NAME ---- -nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific extended SMART log page contents and either save to file or dump the contents. +nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific +extended SMART log page contents and either save to file or dump the contents. SYNOPSIS -------- @@ -12,7 +13,6 @@ SYNOPSIS [--namespace-id=, -n ] [--output-file=, -o ] - DESCRIPTION ----------- For the NVMe device given, sends the Toshiba vendor log @@ -22,7 +22,8 @@ The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). -The log contents may be associated with the controller, in which case the namespace parameter is ignored. +The log contents may be associated with the controller, in which case the +namespace parameter is ignored. Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page) @@ -33,7 +34,7 @@ OPTIONS -l :: --log=:: - Log page: 0xC0 or 0xCA (defaults to 0xCA) + Log page: 0xC0 or 0xCA (defaults to 0xCA) -n :: --namespace-id=:: @@ -42,8 +43,6 @@ OPTIONS --output-file=:: Output binary file. Defaults to text-formatted dump to stdout - - EXAMPLES -------- * Get the current log from the device and dumps it to stdout: diff --git a/Documentation/nvme-transcend-badblock.txt b/Documentation/nvme-transcend-badblock.txt index 888076c3..9b6f6716 100644 --- a/Documentation/nvme-transcend-badblock.txt +++ b/Documentation/nvme-transcend-badblock.txt @@ -23,7 +23,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Transcend device's bad blocks in a human readable format: diff --git a/Documentation/nvme-transcend-healthvalue.txt b/Documentation/nvme-transcend-healthvalue.txt index 4a7d52f1..90340cef 100644 --- a/Documentation/nvme-transcend-healthvalue.txt +++ b/Documentation/nvme-transcend-healthvalue.txt @@ -3,7 +3,8 @@ nvme-transcend-healthvalue(1) NAME ---- -nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of Transcend device. +nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of +Transcend device. SYNOPSIS -------- @@ -12,7 +13,8 @@ SYNOPSIS DESCRIPTION ----------- -Retrieves the NVMe Device SMART log page from the Transcend device and evaluate health status of Transcend device. +Retrieves the NVMe Device SMART log page from the Transcend device and evaluate +health status of Transcend device. The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). @@ -23,7 +25,6 @@ OPTIONS ------- none - EXAMPLES -------- * Print the Transcend Device health value in a human readable format: diff --git a/Documentation/nvme-verify.txt b/Documentation/nvme-verify.txt index 3c8039a6..01dabbf4 100644 --- a/Documentation/nvme-verify.txt +++ b/Documentation/nvme-verify.txt @@ -9,16 +9,16 @@ SYNOPSIS -------- [verse] 'nvme-verify' [--namespace-id= | -n ] - [--start-block= | -s ] - [--block-count= | -c ] - [--limited-retry | -l] - [--force-unit-access | -f] - [--prinfo= | -p ] - [--ref-tag= | -r ] - [--app-tag-mask= | -m ] - [--app-tag= | -a ] - [--storage-tag | -S ] - [--storage-tag-check | -C] + [--start-block= | -s ] + [--block-count= | -c ] [--limited-retry | -l] + [--force-unit-access | -f] + [--prinfo= | -p ] + [--ref-tag= | -r ] + [--app-tag-mask= | -m ] + [--app-tag= | -a ] + [--storage-tag | -S ] + [--storage-tag-check | -C] + [--output-format= | -o ] [--verbose | -v] DESCRIPTION ----------- @@ -27,28 +27,28 @@ reading data and metadata. OPTIONS ------- ---namespace-id=:: -n :: +--namespace-id=:: Namespace ID use in the command. ---start-block=:: -s :: +--start-block=:: Start block address. ---block-count=:: -c :: +--block-count=:: Number of logical blocks to Verify. ---limited-retry:: -l:: +--limited-retry:: Sets the limited retry flag. ---force-unit-access:: -f:: +--force-unit-access:: Set the force-unit access flag. ---prinfo=:: -p :: +--prinfo=:: Protection Information field definition. + [] @@ -63,16 +63,16 @@ metadata is passes. |0|Set to 1 enables checking the reference tag |================= ---ref-tag=:: -r :: +--ref-tag=:: Optional reftag when used with protection information. ---app-tag-mask=:: -m :: +--app-tag-mask=:: Optional application tag mask when used with protection information. ---app-tag=:: -a :: +--app-tag=:: Optional application tag when used with protection information. -S :: @@ -83,6 +83,15 @@ metadata is passes. --storage-tag-check:: This flag enables Storage Tag field checking as part of Verify operation. +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.txt b/Documentation/nvme-virtium-save-smart-to-vtview-log.txt index 313ac35a..72090c07 100644 --- a/Documentation/nvme-virtium-save-smart-to-vtview-log.txt +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.txt @@ -3,7 +3,8 @@ nvme-virtium-save-smart-to-vtview-log(1) NAME ---- -nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into a log file (csv format). +nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into +a log file (csv format). SYNOPSIS -------- @@ -12,28 +13,29 @@ SYNOPSIS [--freq= | -f ] [--output-file= | -o ] [--test-name= | -n ] - + DESCRIPTION ----------- This command automates the process of collecting SMART data periodically and saving the data in a ready-to-analyze format. Each entry is saved with timestamp and in csv format. Users can use excel to analyze the data. -Some examples of use cases are collecting SMART data for temperature characterization, -collecting data to calculate endurance, or collecting SMART data during a test -or during normal operation. +Some examples of use cases are collecting SMART data for temperature +characterization, data to calculate endurance, or collecting SMART data during a +test or during normal operation. The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). -On success, the command generates a log file, which contains an entry for identify device -(current features & settings) and periodic entries of SMART data. +On success, the command generates a log file, which contains an entry for +identify device (current features & settings) and periodic entries of SMART data. -This command runs for the time specified by the option , and collects SMART data -at the frequency specified by the option . If the output file name is not specified, -this command will generate a file name that include model string and serial number of the device. +This command runs for the time specified by the option , and collects +SMART data at the frequency specified by the option . If the output file +name is not specified, this command will generate a file name that include model +string and serial number of the device. -If the test-name option is specified, it will be recorded in the log file and be used as part -of the log file name. +If the test-name option is specified, it will be recorded in the log file and be +used as part of the log file name. OPTIONS ------- @@ -43,20 +45,20 @@ OPTIONS -f :: --freq=:: - (optional) How often you want to log SMART data - (0.25 = 15' , 0.5 = 30' , 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours. + (optional) How often you want to log SMART data (0.25 = 15', 0.5 = 30', + 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours. -o :: --output-file=:: - (optional) Name of the log file (give it a name that easy for you to remember - what the test is). You can leave it blank too, the file name will be generated - as --.txt. + (optional) Name of the log file (give it a name that easy for you to + remember what the test is). You can leave it blank too, the file name + will be generated as --.txt. -n :: --test-name=:: - (optional) Name of the test you are doing. We use this string as part of the name of the log file. - - + (optional) Name of the test you are doing. We use this string as part of + the name of the log file. + EXAMPLES -------- * Temperature characterization: diff --git a/Documentation/nvme-virtium-show-identify.txt b/Documentation/nvme-virtium-show-identify.txt index 5ce1933f..881824c3 100644 --- a/Documentation/nvme-virtium-show-identify.txt +++ b/Documentation/nvme-virtium-show-identify.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme virtium show-identify' - + DESCRIPTION ----------- This command prints complete detail of the identify device information. The @@ -24,8 +24,7 @@ On success, the command prints identify device in human readable format. OPTIONS ------- none - - + EXAMPLES -------- * Show Identify Device: diff --git a/Documentation/nvme-wdc-cap-diag.txt b/Documentation/nvme-wdc-cap-diag.txt index 9439eaa6..bfcde9a6 100644 --- a/Documentation/nvme-wdc-cap-diag.txt +++ b/Documentation/nvme-wdc-cap-diag.txt @@ -29,7 +29,7 @@ OPTIONS -s :: --transfer-size=:: - Transfer size; defaults to 0x10000 (65536 decimal) bytes + Transfer size; defaults to 0x10000 (65536 decimal) bytes EXAMPLES -------- diff --git a/Documentation/nvme-wdc-clear-assert-dump.txt b/Documentation/nvme-wdc-clear-assert-dump.txt index a5750896..60493df5 100644 --- a/Documentation/nvme-wdc-clear-assert-dump.txt +++ b/Documentation/nvme-wdc-clear-assert-dump.txt @@ -33,7 +33,6 @@ EXAMPLES # nvme wdc clear-assert-dump /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.txt b/Documentation/nvme-wdc-clear-fw-activate-history.txt index 50be1e93..ddb6c26c 100644 --- a/Documentation/nvme-wdc-clear-fw-activate-history.txt +++ b/Documentation/nvme-wdc-clear-fw-activate-history.txt @@ -32,7 +32,6 @@ EXAMPLES # nvme wdc clear-fw-activate-history /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt b/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt index 4788f1fc..cecc52ed 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.txt @@ -34,7 +34,6 @@ EXAMPLES # nvme wdc clear-pcie-correctable-errors /dev/nvme0 ------------ - NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-wdc-drive-essentials.txt b/Documentation/nvme-wdc-drive-essentials.txt index 59b27877..7f060407 100644 --- a/Documentation/nvme-wdc-drive-essentials.txt +++ b/Documentation/nvme-wdc-drive-essentials.txt @@ -3,7 +3,8 @@ nvme-wdc-drive-essentials(1) NAME ---- -nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and save to a tar file. +nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and +save to a tar file. SYNOPSIS -------- @@ -13,9 +14,10 @@ SYNOPSIS DESCRIPTION ----------- -For the NVMe device given, captures the drive essential bin files and saves them into a tar file. -The tar file will be in the following format: DRIVE_ESSENTIALS____