diff --git a/Documentation/fabrics-options.txt b/Documentation/fabrics-options.txt new file mode 100644 index 0000000000..5ee1752642 --- /dev/null +++ b/Documentation/fabrics-options.txt @@ -0,0 +1,124 @@ +FABRICS OPTIONS +--------------- + +The following options are common to NVMe over Fabrics commands such as +`nvme connect`: + +-a :: +--traddr=:: + Specify the network address of the controller. For transports + using IP addressing (e.g. rdma, tcp), this should be an IP address. + +--concat:: + Enable secure concatenation (TCP). + +-c <#>:: +--reconnect-delay=<#>:: + Set the delay in seconds before reconnect is attempted after a + connection loss. + +-C :: +--dhchap-ctrl-secret=:: + Controller authentication secret for bi-directional authentication. + If not specified, bi-directional authentication is not attempted. + +-S :: +--dhchap-secret=:: + Host authentication secret (DH-HMAC-CHAP). Must be provided in ASCII + format as defined in the NVMe specification. + +--disable-sqflow:: + Disable submission queue flow control. + +-G:: +--data-digest:: + Enable data digest generation/verification (TCP). + +-D:: +--duplicate-connect:: + Allow duplicate connections to the same subsystem. + +-g:: +--hdr-digest:: + Enable header digest generation/verification (TCP). + +-f :: +--host-iface=:: + Specify the network interface to use for the connection. + +-I :: +--hostid=:: + Specify the host UUID. + +-q :: +--hostnqn=:: + Override the default host NQN. + +-w :: +--host-traddr=:: + Specify the source address on the host side of the connection. + +-k <#>:: +--keep-alive-tmo=<#>:: + Set the keep-alive timeout in seconds. + +--keyring=:: + Keyring to use for TLS key lookup. + +-n :: +--nqn=:: + Specify the NVMe subsystem NQN to connect to. + +-i <#>:: +--nr-io-queues=<#>:: + Number of I/O queues to create. + +-P <#>:: +--nr-poll-queues=<#>:: + Number of polling queues to create. + +-W <#>:: +--nr-write-queues=<#>:: + Number of write queues to create. + +-Q <#>:: +--queue-size=<#>:: + Queue depth for I/O queues. + +-l <#>:: +--ctrl-loss-tmo=<#>:: + Maximum time in seconds to retry reconnect attempts after + controller loss. + +-s :: +--trsvcid=:: + Transport service identifier (e.g. TCP/rdma port). Default is 4420 + for RDMA. + +-T <#>:: +--tos=<#>:: + Type of service value for the connection (TCP). + +-t :: +--transport=:: + Specify the transport type. Supported values include: + ++ +[] +|================= +|Value | Description +|rdma | RDMA (RoCE, iWARP, InfiniBand) +|tcp | TCP/IP +|fc | Fibre Channel (*experimental*) +|loop | Local loopback transport +|================= + +--tls:: + Enable TLS encryption (TCP). + +--tls-key=:: + TLS key for the connection. It is recommended to preload keys + into the system keyring instead of passing them via the command line. + +--tls-key-identity=:: + Identity associated with the TLS key. diff --git a/Documentation/global-options.txt b/Documentation/global-options.txt new file mode 100644 index 0000000000..58684e12d5 --- /dev/null +++ b/Documentation/global-options.txt @@ -0,0 +1,33 @@ +GLOBAL OPTIONS +-------------- + +The following options are defined at the top-level `nvme` command +and are available to this subcommand: + +--dry-run:: + Print the command that would be executed, but do not actually + execute it. + +--no-ioctl-probing:: + Disable probing for 64-bit IOCTL support. + +--no-retries:: + Disable retry logic on transient errors. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'tabular, 'json', or 'binary'. + Only one output format may be used at a time. + +--output-format-version=:: + Select the output format version. Version '1' uses the original + field naming, while version '2' (default) provides more consistent + and script-friendly field names. + +--timeout=:: + Set the timeout for the command in milliseconds. + +-v:: +--verbose:: + Increase the level of detail in the output. May be specified + multiple times to further increase verbosity. diff --git a/Documentation/meson.build b/Documentation/meson.build index 83c883ad5a..bf29c585e4 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -265,6 +265,8 @@ adoc_sources = [ adoc_includes = [ 'cmd-plugins.txt', 'cmds-main.txt', + 'global-options.txt', + 'fabrics-options.txt', ] if want_docs != 'false' diff --git a/Documentation/nvme-admin-passthru.txt b/Documentation/nvme-admin-passthru.txt index 947febea9d..3d10177c0b 100644 --- a/Documentation/nvme-admin-passthru.txt +++ b/Documentation/nvme-admin-passthru.txt @@ -19,13 +19,12 @@ SYNOPSIS [--metadata-len= | -m ] [--input-file= | -i ] [--read | -r] [--write | -w] - [--timeout=] [--show-command | -s] [--dry-run | -d] [--raw-binary | -b] [--prefill= | -p ] [--latency | -T] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -115,17 +114,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ana-log.txt b/Documentation/nvme-ana-log.txt index 92dc12a03c..c884401ccc 100644 --- a/Documentation/nvme-ana-log.txt +++ b/Documentation/nvme-ana-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ana-log' [--groups | -g] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -29,14 +29,7 @@ OPTIONS --groups:: 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-attach-ns.txt b/Documentation/nvme-attach-ns.txt index 7b544a4636..4ffbc004db 100644 --- a/Documentation/nvme-attach-ns.txt +++ b/Documentation/nvme-attach-ns.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme attach-ns' [--namespace-id= | -n ] [--controllers= | -c ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -33,14 +33,7 @@ OPTIONS namespace too. If no list is provided, the namespace will be attached to the controller used for this command. --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ave-discovery-log.txt b/Documentation/nvme-ave-discovery-log.txt index f20aa3e818..b54f2dd46a 100644 --- a/Documentation/nvme-ave-discovery-log.txt +++ b/Documentation/nvme-ave-discovery-log.txt @@ -8,8 +8,8 @@ nvme-ave-discovery-log - Retrieve AVE Discovery Log, show it SYNOPSIS -------- [verse] -'nvme ave-discovery-log' [--rae | -r] [--verbose | -v] - [--output-format= | -o ] [--timeout=] +'nvme ave-discovery-log' [--rae | -r] + [] DESCRIPTION ----------- @@ -25,17 +25,7 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-boot-part-log.txt b/Documentation/nvme-boot-part-log.txt index 0999071503..3cee3a894e 100644 --- a/Documentation/nvme-boot-part-log.txt +++ b/Documentation/nvme-boot-part-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme boot-part-log' [--lsp= | -s ] [--output-file= | -f ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -33,14 +33,7 @@ OPTIONS --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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt index a49c651c9f..1025405ff2 100644 --- a/Documentation/nvme-capacity-mgmt.txt +++ b/Documentation/nvme-capacity-mgmt.txt @@ -13,8 +13,7 @@ SYNOPSIS [--element-id= | -i ] [--cap-lower= | -l ] [--cap-upper= | -u ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -47,17 +46,7 @@ OPTIONS Most significant 32 bits of the capacity in bytes of the Endurance Group or 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-changed-alloc-ns-list-log.txt b/Documentation/nvme-changed-alloc-ns-list-log.txt index b90c94a268..a027e998d9 100644 --- a/Documentation/nvme-changed-alloc-ns-list-log.txt +++ b/Documentation/nvme-changed-alloc-ns-list-log.txt @@ -10,8 +10,7 @@ SYNOPSIS -------- [verse] 'nvme changed-alloc-ns-list-log' [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -32,17 +31,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-changed-ns-list-log.txt b/Documentation/nvme-changed-ns-list-log.txt index 22e552f650..c73f664853 100644 --- a/Documentation/nvme-changed-ns-list-log.txt +++ b/Documentation/nvme-changed-ns-list-log.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'nvme changed-ns-list-log' [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -31,14 +31,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-check-dhchap-key.txt b/Documentation/nvme-check-dhchap-key.txt index b131afecd0..4679f9bf2f 100644 --- a/Documentation/nvme-check-dhchap-key.txt +++ b/Documentation/nvme-check-dhchap-key.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme check-dhchap-key' [--key=] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -23,14 +23,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-check-tls-key.txt b/Documentation/nvme-check-tls-key.txt index 51a6f21e30..8d052cd726 100644 --- a/Documentation/nvme-check-tls-key.txt +++ b/Documentation/nvme-check-tls-key.txt @@ -13,12 +13,11 @@ SYNOPSIS [--hostnqn= | -n ] [--subsysnqn= | -c ] [--keydata= | -d ] - [--output-format= | -o ] [--identity= | -I ] [--insert | -i ] [--compat | -C ] [--keyfile= | -f ] - [--verbose | -v] + [] DESCRIPTION ----------- @@ -73,14 +72,7 @@ OPTIONS Append the resulting TLS key to keyfile. This command line option is depending on --insert. --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-cmdset-ind-id-ns.txt b/Documentation/nvme-cmdset-ind-id-ns.txt index 5bf3862f13..68f84847c3 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.txt +++ b/Documentation/nvme-cmdset-ind-id-ns.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] 'nvme cmdset-ind-id-ns' [--namespace-id= | -n ] - [--raw-binary | -b] [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] + [--human-readable | -H] + [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -43,17 +44,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-compare.txt b/Documentation/nvme-compare.txt index 5b2f005daf..21f8eca593 100644 --- a/Documentation/nvme-compare.txt +++ b/Documentation/nvme-compare.txt @@ -30,8 +30,7 @@ SYNOPSIS [--storage-tag | -g ] [--storage-tag-check | -C] [--force] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -162,17 +161,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-config.txt b/Documentation/nvme-config.txt index f5df34c2c1..d2baf2f4e9 100644 --- a/Documentation/nvme-config.txt +++ b/Documentation/nvme-config.txt @@ -10,26 +10,8 @@ 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 ] - [--hdr-digest | -g] [--data-digest | -G] - [--output-format= | -o ] [--verbose | -v] + [] + [] DESCRIPTION ----------- @@ -63,131 +45,9 @@ OPTIONS default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in an existing configuration file. --t :: ---transport=:: - This field specifies the network fabric being used for - 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 |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 -|================= - --n :: ---nqn :: - This field specifies the name for the NVMe subsystem to connect to. - --a :: ---traddr=:: - This field specifies the network address of the Controller. - For transports using IP addressing (e.g. rdma) this should be an - IP-based address (ex. IPv4). - --s :: ---trsvcid=:: - 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. - --w :: ---host-traddr=:: - This field specifies the network address used on the host to connect - to the Controller. For TCP, this sets the source address on the socket. - --f :: ---host-iface=:: - This field specifies the network interface used on the host to connect - to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces - the connection to be made on a specific interface instead of letting - the system decide. - --q :: ---hostnqn=:: - Overrides the default Host NQN that identifies the NVMe Host. - If this option is not specified, the default is read from - @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the autogenerated - NQN value from the NVMe Host kernel module is used next. - The Host NQN uniquely identifies the NVMe Host. - --I :: ---hostid=:: - UUID(Universally Unique Identifier) to be discovered which should be - formatted. - --S :: ---dhchap-secret=:: - NVMe In-band authentication secret; needs to be in ASCII format as - specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. - If this option is not specified, the default is read from - @SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication - is attempted. - --C :: ---dhchap-ctrl-secret=:: - NVMe In-band authentication controller secret for bi-directional - authentication; needs to be in ASCII format as - specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. - If not present bi-directional authentication is not attempted. - --i <#>:: ---nr-io-queues=<#>:: - Overrides the default number of I/O queues create by the driver. - --W <#>:: ---nr-write-queues=<#>:: - Adds additional queues that will be used for write I/O. - --P <#>:: ---nr-poll-queues=<#>:: - Adds additional queues that will be used for polling latency sensitive I/O. - --Q <#>:: ---queue-size=<#>:: - Overrides the default number of elements in the I/O queues created - by the driver. - --k <#>:: ---keep-alive-tmo=<#>:: - Overrides the default keep alive timeout (in seconds). - --c <#>:: ---reconnect-delay=<#>:: - Overrides the default delay (in seconds) before reconnect is attempted - after a connect loss. - --l <#>:: ---ctrl-loss-tmo=<#>:: - Overrides the default controller loss timeout period (in seconds). - --D:: ---duplicate-connect:: - Allows duplicated connections between same transport host and subsystem - port. - ---disable-sqflow:: - Disables SQ flow control to omit head doorbell update for submission - queues when sending nvme completions. - --g:: ---hdr-digest:: - Generates/verifies header digest (TCP). - --G:: ---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. +include::fabrics-options.txt[] --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index a08aaa27aa..d79a4c4710 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -8,29 +8,15 @@ 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 ] +'nvme connect-all' [--raw= | -r ] [--device= | -d ] [--config= | -J ] - [--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] [--concat] [--quiet] + [--persistent | -p] [--quiet] [--dump-config | -O] [--nbft] [--no-nbft] [--nbft-path=] [--context=] - [--output-format= | -o ] [--verbose | -v] + [] + [] DESCRIPTION ----------- @@ -51,63 +37,6 @@ background. OPTIONS ------- --t :: ---transport=:: - This field specifies the network fabric being used for - 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. -|tcp |The network fabric is a TCP/IP network. -|loop|Connect to a NVMe over Fabrics target on the local host -|================= - --n :: ---nqn :: - This field specifies the name for the NVMe subsystem to connect to. - --a :: ---traddr=:: - This field specifies the network address of the Discovery Controller. - For transports using IP addressing (e.g. rdma) this should be an - IP-based address (ex. IPv4). - --s :: ---trsvcid=:: - 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. - --w :: ---host-traddr=:: - This field specifies the network address used on the host to connect - to the Controller. For TCP, this sets the source address on the socket. - --f :: ---host-iface=:: - This field specifies the network interface used on the host to connect - to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces - the connection to be made on a specific interface instead of letting - the system decide. - --q :: ---hostnqn=:: - Overrides the default Host NQN that identifies the NVMe Host. - If this option is not specified, the default is read from - @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the - autogenerated NQN value from the NVMe Host kernel module is used next. - The Host NQN uniquely identifies the NVMe Host, and may be used by the - the Discovery Controller to control what NVMe Target resources are - allocated to the NVMe Host for a connection. - --I :: ---hostid=:: - UUID(Universally Unique Identifier) to be discovered which should be - formatted. - -r :: --raw=:: This field will take the output of the 'nvme connect-all' command @@ -129,66 +58,11 @@ OPTIONS format is documented in https://github.com/linux-nvme/nvme-cli/blob/master/libnvme/doc/config-schema.json --k <#>:: ---keep-alive-tmo=<#>:: - Overrides the default keep alive timeout (in seconds). This - option will be ignored for discovery, but will be passed on to - the subsequent connect call. - --c <#>:: ---reconnect-delay=<#>:: - Overrides the default delay (in seconds) before reconnect is attempted - after a connect loss. - --l <#>:: ---ctrl-loss-tmo=<#>:: - Overrides the default controller loss timeout period (in seconds). - --i <#>:: ---nr-io-queues=<#>:: - Overrides the default number of I/O queues create by the driver. - This option will be ignored for discovery, but will be passed on - to the subsequent connect call. - --W <#>:: ---nr-write-queues=<#>:: - Adds additional queues that will be used for write I/O. - --P <#>:: ---nr-poll-queues=<#>:: - Adds additional queues that will be used for polling latency sensitive I/O. - --Q <#>:: ---queue-size=<#>:: - Overrides the default number of elements in the I/O queues created - by the driver. This option will be ignored for discovery, but will be - passed on to the subsequent connect call. - ---keyring=<#>:: - Keyring for TLS key lookup. - ---tls_key=<#>:: - TLS key for the connection (TCP). - --g:: ---hdr-digest:: - Generates/verifies header digest (TCP). - --G:: ---data-digest:: - Generates/verifies data digest (TCP). - -p:: --persistent:: Don't remove the discovery controller after retrieving the discovery log page. ---tls:: - Enable TLS encryption (TCP). - ---concat:: - Enable secure concatenation (TCP). - --quiet:: Suppress error messages. @@ -209,14 +83,9 @@ OPTIONS 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. +include::fabrics-options.txt[] --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt index 65d5cfbf23..b04250f2f0 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -8,30 +8,10 @@ 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= | -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=] - [--tls-key-identity=] - [--duplicate-connect | -D] [--disable-sqflow ] - [--hdr-digest | -g] [--data-digest | -G] [--tls] - [--concat] [--dump-config | -O] [--application=] - [--output-format= | -o ] [--verbose | -v] +'nvme connect' [--config=] + [--application=] + [] + [] DESCRIPTION ----------- @@ -41,173 +21,16 @@ specified by the --nqn option. OPTIONS ------- --t :: ---transport=:: - This field specifies the network fabric being used for - 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. -|tcp |The network fabric is a TCP/IP network. -|loop|Connect to a NVMe over Fabrics target on the local host -|================= - --n :: ---nqn :: - This field specifies the name for the NVMe subsystem to connect to. - --a :: ---traddr=:: - This field specifies the network address of the Controller. - For transports using IP addressing (e.g. rdma) this should be an - IP-based address (ex. IPv4). - --s :: ---trsvcid=:: - 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. - --w :: ---host-traddr=:: - This field specifies the network address used on the host to connect - to the Controller. For TCP, this sets the source address on the socket. - --f :: ---host-iface=:: - This field specifies the network interface used on the host to connect - to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces - the connection to be made on a specific interface instead of letting - the system decide. - --q :: ---hostnqn=:: - Overrides the default Host NQN that identifies the NVMe Host. - If this option is not specified, the default is read from - @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the autogenerated - NQN value from the NVMe Host kernel module is used next. - The Host NQN uniquely identifies the NVMe Host. - --I :: ---hostid=:: - UUID(Universally Unique Identifier) to be discovered which should be - formatted. - --J :: --config=:: - Use the specified JSON configuration file instead of the - default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in - an existing configuration file. The JSON configuration file - format is documented in - https://github.com/linux-nvme/nvme-cli/blob/master/libnvme/doc/config-schema.json - --S :: ---dhchap-secret=:: - NVMe In-band authentication secret; needs to be in ASCII format as - specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. - --C :: ---dhchap-ctrl-secret=:: - NVMe In-band authentication controller secret for bi-directional - authentication; needs to be in ASCII format as - specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. - If not present bi-directional authentication is not attempted. - --i <#>:: ---nr-io-queues=<#>:: - Overrides the default number of I/O queues create by the driver. - --W <#>:: ---nr-write-queues=<#>:: - Adds additional queues that will be used for write I/O. - --P <#>:: ---nr-poll-queues=<#>:: - Adds additional queues that will be used for polling latency sensitive I/O. - --Q <#>:: ---queue-size=<#>:: - Overrides the default number of elements in the I/O queues created - by the driver. - --k <#>:: ---keep-alive-tmo=<#>:: - Overrides the default keep alive timeout (in seconds). - --c <#>:: ---reconnect-delay=<#>:: - Overrides the default delay (in seconds) before reconnect is attempted - after a connect loss. - --l <#>:: ---ctrl-loss-tmo=<#>:: - Overrides the default controller loss timeout period (in seconds). - This is the maximum time the kernel will retry a connection, where each - retry will be issued after 'reconnect-delay' seconds. - --T <#>:: ---tos=<#>:: - Type of service for the connection (TCP) - ---keyring=:: - Keyring for TLS key lookup, either the key id or the keyring name. - ---tls-key=:: - TLS key for the connection (TCP), either the TLS key in - interchange format or the key id. It's strongly recommended not - to provide the TLS key via the comamnd line due to security - concerns. Instead in production situation, the key should be - loaded into the keystore with 'nvme tls --import' and only the - '--tls' options used. The kernel will select the matching key. - ---tls-key-identity=:: - The identity used for the tls-key. If none is provided the - tls-key provided via the comamnd line is considered a - configuration key and a derive key will be loaded into the - keyring. - --D:: ---duplicate-connect:: - Allows duplicated connections between same transport host and subsystem - port. - ---disable-sqflow:: - Disables SQ flow control to omit head doorbell update for submission - queues when sending nvme completions. - --g:: ---hdr-digest:: - Generates/verifies header digest (TCP). - --G:: ---data-digest:: - Generates/verifies data digest (TCP). - ---tls:: - Enable TLS encryption (TCP). - ---concat:: - Enable secure concatenation (TCP). - --O:: ---dump-config:: - Print out resulting JSON configuration file to stdout. + Use the specified JSON configuration file instead of the default. --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. +include::fabrics-options.txt[] --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-copy.txt b/Documentation/nvme-copy.txt index 31183f4bbc..d3f46539ad 100644 --- a/Documentation/nvme-copy.txt +++ b/Documentation/nvme-copy.txt @@ -26,8 +26,7 @@ SYNOPSIS [--dir-type= | -T ] [--dir-spec= | -S ] [--format= | -F ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -114,17 +113,7 @@ OPTIONS --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-create-ns.txt b/Documentation/nvme-create-ns.txt index 5cf54996ae..29d271ae80 100644 --- a/Documentation/nvme-create-ns.txt +++ b/Documentation/nvme-create-ns.txt @@ -20,7 +20,6 @@ SYNOPSIS [--lbstm= | -l ] [--nphndls= | -n ] [--block-size= | -b ] - [--timeout=] [--nsze-si= | -S ] [--ncap-si= | -C ] [--azr | -z] @@ -28,7 +27,7 @@ SYNOPSIS [--ror= | -O ] [--rnumzrwa= | -u ] [--phndls= | -p ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -139,17 +138,7 @@ 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. - ---timeout=:: - Override default timeout value 120,000. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dapustor-smart-log-add.txt b/Documentation/nvme-dapustor-smart-log-add.txt index 0c67a21dc4..1a7174c3d2 100644 --- a/Documentation/nvme-dapustor-smart-log-add.txt +++ b/Documentation/nvme-dapustor-smart-log-add.txt @@ -11,6 +11,7 @@ SYNOPSIS [verse] 'nvme dapustor smart-log-add' [--namespace-id= | -n ] [--raw-binary | -b] [--json | -j] + [] DESCRIPTION ----------- @@ -43,6 +44,8 @@ OPTIONS --json:: Dump output in json format. +include::global-options.txt[] + EXAMPLES -------- * Print the DapuStor Additional SMART log page in a human readable format: diff --git a/Documentation/nvme-delete-ns.txt b/Documentation/nvme-delete-ns.txt index 6631fc8ab7..36861f3239 100644 --- a/Documentation/nvme-delete-ns.txt +++ b/Documentation/nvme-delete-ns.txt @@ -9,8 +9,7 @@ SYNOPSIS -------- [verse] 'nvme delete-ns' [--namespace-id= | -n ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -27,17 +26,7 @@ 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. - ---timeout=:: - Override default timeout value 120,000. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dera-stat.txt b/Documentation/nvme-dera-stat.txt index f3a87aeaa2..d11056b4c9 100644 --- a/Documentation/nvme-dera-stat.txt +++ b/Documentation/nvme-dera-stat.txt @@ -8,7 +8,8 @@ nvme-dera-stat - Send NVMe Dera Device status and Additional SMART log page requ SYNOPSIS -------- [verse] -'nvme dera stat' +'nvme dera stat' + [] DESCRIPTION ----------- @@ -24,6 +25,8 @@ OPTIONS ------- none +include::global-options.txt[] + 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 842889c794..384a9b399e 100644 --- a/Documentation/nvme-detach-ns.txt +++ b/Documentation/nvme-detach-ns.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme detach-ns' [--namespace-id= | -n ] [--controllers= | -c - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -29,14 +29,7 @@ OPTIONS 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-device-self-test.txt b/Documentation/nvme-device-self-test.txt index 622c8607e1..08ea3af7d1 100644 --- a/Documentation/nvme-device-self-test.txt +++ b/Documentation/nvme-device-self-test.txt @@ -10,8 +10,7 @@ SYNOPSIS [verse] 'nvme device-self-test' [--namespace-id= | -n ] [--self-test-code= | -s ] [--wait | -w] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -46,17 +45,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dim.txt b/Documentation/nvme-dim.txt index fcfc9b8ad9..1565e4af3c 100644 --- a/Documentation/nvme-dim.txt +++ b/Documentation/nvme-dim.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme dim' [--task= | -t ] [--nqn= | -n ] [--device= | -d ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -51,14 +51,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dir-receive.txt b/Documentation/nvme-dir-receive.txt index f30b5af135..1ea0847051 100644 --- a/Documentation/nvme-dir-receive.txt +++ b/Documentation/nvme-dir-receive.txt @@ -14,9 +14,9 @@ SYNOPSIS [--dir-spec= | -S ] [--dir-oper= | -O ] [--req-resource= | -r ] - [--human-readable | -H] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [--human-readable | -H] + [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -79,20 +79,10 @@ OPTIONS -H:: --human-readable:: - 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. + Display values in a human-readable format where possible. + (deprecated, use --verbose) ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dir-send.txt b/Documentation/nvme-dir-send.txt index d0ecbfadb5..bcc5f3e625 100644 --- a/Documentation/nvme-dir-send.txt +++ b/Documentation/nvme-dir-send.txt @@ -15,9 +15,9 @@ SYNOPSIS [--dir-oper= | -O ] [--endir= | -e ] [--target-dir= | -T ] - [--human-readable | -H] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [--human-readable | -H] + [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -84,19 +84,10 @@ OPTIONS -H:: --human-readable:: - deprecated; does nothing so use the --verbose flag instead. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-disconnect-all.txt b/Documentation/nvme-disconnect-all.txt index 9f023ea007..7abcc26c11 100644 --- a/Documentation/nvme-disconnect-all.txt +++ b/Documentation/nvme-disconnect-all.txt @@ -8,7 +8,8 @@ nvme-disconnect-all - Disconnect from all connected Fabrics controllers. SYNOPSIS -------- [verse] -'nvme disconnect-all' [--output-format= | -o ] [--verbose | -v] +'nvme disconnect-all' + [] DESCRIPTION ----------- @@ -19,14 +20,8 @@ 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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-disconnect.txt b/Documentation/nvme-disconnect.txt index d3b8c524d7..848f4c0093 100644 --- a/Documentation/nvme-disconnect.txt +++ b/Documentation/nvme-disconnect.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme disconnect' [--nqn= | -n ] [--device= | -d ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -31,14 +31,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index 49259e045f..26371d004c 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -8,30 +8,16 @@ 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 ] +'nvme discover' [--raw= | -r ] [--device= | -d ] [--config= | -J ] - [--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] [--tls] [--concat] - [--dump-config | -O] [--output-format= | -o ] + [--persistent | -p] [--quiet] + [--dump-config | -O] [--force] [--nbft] [--no-nbft] [--nbft-path=] [--context=] - [--output-format= | -o ] [--verbose | -v] + [] + [] DESCRIPTION ----------- @@ -73,60 +59,6 @@ nvme-cli for the 'discover' command. OPTIONS ------- --t :: ---transport=:: - This field specifies the network fabric being used for - 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. -|tcp |The network fabric is a TCP/IP network. -|loop|Connect to a NVMe over Fabrics target on the local host -|================= - --n :: ---nqn :: - This field specifies the name for the NVMe subsystem to connect to. - --a :: ---traddr=:: - This field specifies the network address of the Discovery Controller. - For transports using IP addressing (e.g. rdma) this should be an - IP-based address (ex. IPv4). - --s :: ---trsvcid=:: - 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. - --w :: ---host-traddr=:: - This field specifies the network address used on the host to connect - to the Controller. For TCP, this sets the source address on the socket. - --f :: ---host-iface=:: - This field specifies the network interface used on the host to connect - to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces - the connection to be made on a specific interface instead of letting - the system decide. - --q :: ---hostnqn=:: - Overrides the default host NQN that identifies the NVMe Host. - If this option is not specified, the default is read from - @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the - autogenerated NQN value from the NVMe Host kernel module is used next. - --I :: ---hostid=:: - UUID(Universally Unique Identifier) to be discovered which should be - formatted. - -r :: --raw=:: This field will take the output of the 'nvme discover' command @@ -148,67 +80,11 @@ OPTIONS format is documented in https://github.com/linux-nvme/nvme-cli/blob/master/libnvme/doc/config-schema.json --k <#>:: ---keep-alive-tmo=<#>:: - Overrides the default keep alive timeout (in seconds). This - option will be ignored for discovery, and it is only - implemented for completeness. - --c <#>:: ---reconnect-delay=<#>:: - Overrides the default delay (in seconds) before reconnect is attempted - after a connect loss. - --l <#>:: ---ctrl-loss-tmo=<#>:: - Overrides the default controller loss timeout period (in seconds). - --i <#>:: ---nr-io-queues=<#>:: - Overrides the default number of I/O queues create by the driver. - This option will be ignored for the discovery, and it is only - implemented for completeness. - --W <#>:: ---nr-write-queues=<#>:: - Adds additional queues that will be used for write I/O. - --P <#>:: ---nr-poll-queues=<#>:: - Adds additional queues that will be used for polling latency sensitive I/O. - --Q <#>:: ---queue-size=<#>:: - Overrides the default number of elements in the I/O queues created - by the driver which can be found at drivers/nvme/host/fabrics.h. - This option will be ignored for the discovery, and it is only - implemented for completeness. - ---keyring=<#>:: - Keyring for TLS key lookup. - ---tls_key=<#>:: - TLS key for the connection (TCP). - --g:: ---hdr-digest:: - Generates/verifies header digest (TCP). - --G:: ---data-digest:: - Generates/verifies data digest (TCP). - -p:: --persistent:: Don't remove the discovery controller after retrieving the discovery log page. ---tls:: - Enable TLS encryption (TCP). - ---concat:: - Enable secure concatenation (TCP). - --quiet:: Suppress already connected errors. @@ -216,11 +92,6 @@ 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. - --force:: Disable the built-in persistent discover connection rules. Combined with --persistent flag, always create new @@ -239,14 +110,9 @@ OPTIONS 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. +include::fabrics-options.txt[] --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dispersed-ns-participating-nss-log.txt b/Documentation/nvme-dispersed-ns-participating-nss-log.txt index d3b7e2bcce..dbe3d475a5 100644 --- a/Documentation/nvme-dispersed-ns-participating-nss-log.txt +++ b/Documentation/nvme-dispersed-ns-participating-nss-log.txt @@ -10,8 +10,8 @@ SYNOPSIS -------- [verse] 'nvme dispersed-ns-participating-nss-log' - [--namespace-id= | -n ] [--verbose | -v] - [--output-format= | -o ] [--timeout=] + [--namespace-id= | -n ] + [] DESCRIPTION ----------- @@ -29,17 +29,7 @@ OPTIONS Retrieve the dispersed namespace participating NVM subsystems log for the given nsid. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-dsm.txt b/Documentation/nvme-dsm.txt index 08485d2d01..b5b468ef72 100644 --- a/Documentation/nvme-dsm.txt +++ b/Documentation/nvme-dsm.txt @@ -15,8 +15,7 @@ SYNOPSIS [--ad= | -d ] [--idw= | -w ] [--idr= | -r ] [--cdw11= | -c ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -75,17 +74,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-effects-log.txt b/Documentation/nvme-effects-log.txt index 37af290b1c..b594cd4d09 100644 --- a/Documentation/nvme-effects-log.txt +++ b/Documentation/nvme-effects-log.txt @@ -9,9 +9,9 @@ and log SYNOPSIS -------- [verse] -'nvme effects-log' [--human-readable | -H] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] +'nvme effects-log' [--raw-binary | -b] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -26,28 +26,17 @@ for each command that is supported. OPTIONS ------- - --H:: ---human-readable:: - This option will parse and format many of the bit fields into a - human-readable format. - -b:: --raw-binary:: This option will print the raw buffer to stdout. Structure is not 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. +-H:: +--human-readable:: + Display values in a human-readable format where possible. + (deprecated, use --verbose) ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-endurance-event-agg-log.txt b/Documentation/nvme-endurance-event-agg-log.txt index 7cbceb1b0e..8883e08d18 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -39,14 +39,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-endurance-log.txt b/Documentation/nvme-endurance-log.txt index c263834c93..7bae73b552 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -29,14 +29,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt index 94442ee509..000f27f67b 100644 --- a/Documentation/nvme-error-log.txt +++ b/Documentation/nvme-error-log.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme error-log' [--log-entries= | -e ] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -37,14 +37,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-fdp-configs.txt b/Documentation/nvme-fdp-configs.txt index d5cc487343..587c6c22bf 100644 --- a/Documentation/nvme-fdp-configs.txt +++ b/Documentation/nvme-fdp-configs.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] 'nvme fdp configs' [--endgrp-id= | -e ] - [--human-readable | -H] [--raw-binary | -b] - [--output-format= | -o ] + [--human-readable | -H] + [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -25,16 +26,14 @@ OPTIONS -H:: --human-readable:: - Parse, print and describe individual parts of bitfields. + Display values in a human-readable format where possible. + (deprecated, use --verbose) -b:: --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fdp-events.txt b/Documentation/nvme-fdp-events.txt index 5602f448d3..7758375f97 100644 --- a/Documentation/nvme-fdp-events.txt +++ b/Documentation/nvme-fdp-events.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme fdp events' [--endgrp-id= | -e ] [--host-events | -E] - [--raw-binary | -b] [--output-format= | -o ] + [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -30,10 +31,7 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fdp-feature.txt b/Documentation/nvme-fdp-feature.txt index 543c7883f2..c47667d95d 100644 --- a/Documentation/nvme-fdp-feature.txt +++ b/Documentation/nvme-fdp-feature.txt @@ -9,9 +9,9 @@ SYNOPSIS -------- [verse] 'nvme fdp' [--endgrp-id= | -e ] - [--enable-conf-idx= | -c ] - [--disable | -d] - [--verbose | -v] + [--enable-conf-idx= | -c ] + [--disable | -d] + [] DESCRIPTION ----------- @@ -42,9 +42,7 @@ OPTIONS --disable:: Disable the current FDP feature configuration. --v:: ---verbose:: - Increase verbosity of the output. +include::global-options.txt[] SEE ALSO -------- diff --git a/Documentation/nvme-fdp-set-events.txt b/Documentation/nvme-fdp-set-events.txt index b93cdc33a1..a83782866f 100644 --- a/Documentation/nvme-fdp-set-events.txt +++ b/Documentation/nvme-fdp-set-events.txt @@ -11,6 +11,7 @@ SYNOPSIS 'nvme fdp set-events' [--namespace-id= | -n ] [--placement-handle= | -p ] [--enable | -e] [--event-types= | -t ] + [] DESCRIPTION ----------- @@ -28,10 +29,7 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fdp-stats.txt b/Documentation/nvme-fdp-stats.txt index 0b184a961b..3cfb33594d 100644 --- a/Documentation/nvme-fdp-stats.txt +++ b/Documentation/nvme-fdp-stats.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fdp stats' [--endgrp-id= | -e ] [--raw-binary | -b] - [--output-format= | -o ] + [] DESCRIPTION ----------- @@ -26,10 +26,7 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fdp-status.txt b/Documentation/nvme-fdp-status.txt index 78dddaedf2..50bb94fcf2 100644 --- a/Documentation/nvme-fdp-status.txt +++ b/Documentation/nvme-fdp-status.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fdp status' [--namespace-id= | -n ] [--raw-binary | -b] - [--output-format= | -o ] + [] DESCRIPTION ----------- @@ -26,10 +26,7 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fdp-update.txt b/Documentation/nvme-fdp-update.txt index 5af83e5a5f..d38088a472 100644 --- a/Documentation/nvme-fdp-update.txt +++ b/Documentation/nvme-fdp-update.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme fdp update' [--namespace-id= | -n ] [--pids= | -p ] + [] DESCRIPTION ----------- @@ -26,6 +27,8 @@ OPTIONS --pids=:: Comma-separated list of placement identifiers to update. +include::global-options.txt[] + NVME ---- Part of nvme-cli diff --git a/Documentation/nvme-fdp-usage.txt b/Documentation/nvme-fdp-usage.txt index 3e0fb98999..0e5781da5d 100644 --- a/Documentation/nvme-fdp-usage.txt +++ b/Documentation/nvme-fdp-usage.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme fdp usage' [--endgrp-id= | -e ] [--raw-binary | -b] - [--output-format= | -o ] + [] DESCRIPTION ----------- @@ -27,10 +27,7 @@ OPTIONS --raw-binary:: Print the raw buffer to the standard output stream. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one - output format can be used at a time. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-fid-support-effects-log.txt b/Documentation/nvme-fid-support-effects-log.txt index 9670b8878c..e8121e746c 100644 --- a/Documentation/nvme-fid-support-effects-log.txt +++ b/Documentation/nvme-fid-support-effects-log.txt @@ -8,7 +8,9 @@ nvme-fid-support-effects-log - Send NVMe FID Support and Effects log, return res SYNOPSIS -------- [verse] -'nvme fid-support-effects-log' [--output-format= | -o ] [--verbose | -v] +'nvme fid-support-effects-log' + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -26,17 +28,10 @@ OPTIONS ------- -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- @@ -44,4 +39,4 @@ No examples yet. NVME ---- -Part of the nvme-user suite \ No newline at end of file +Part of the nvme-user suite diff --git a/Documentation/nvme-flush.txt b/Documentation/nvme-flush.txt index 102cd71d12..21bbbdfe19 100644 --- a/Documentation/nvme-flush.txt +++ b/Documentation/nvme-flush.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme flush' [--namespace-id= | -n ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -26,14 +26,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-format.txt b/Documentation/nvme-format.txt index 7e3140791e..dec031cbdc 100644 --- a/Documentation/nvme-format.txt +++ b/Documentation/nvme-format.txt @@ -14,8 +14,7 @@ SYNOPSIS [--ses= | -s ] [--pil= | -p ] [--pi= | -i ] [--ms= | -m ] [--reset | -r] [--force] - [--timeout=] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -129,17 +128,7 @@ cryptographically. This is accomplished by deleting the encryption key. --force:: Just send the command immediately without warning of the implications. ---timeout=:: - Override default timeout value 600,000. 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-fw-commit.txt b/Documentation/nvme-fw-commit.txt index bce8b68593..b686ea2f67 100644 --- a/Documentation/nvme-fw-commit.txt +++ b/Documentation/nvme-fw-commit.txt @@ -11,8 +11,7 @@ SYNOPSIS 'nvme fw-commit' [--slot= | -s ] [--action= | -a ] [--bpid= | -b ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -79,17 +78,7 @@ the BPID field as active and update 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-fw-download.txt b/Documentation/nvme-fw-download.txt index 33dd048040..9ed7d8a51e 100644 --- a/Documentation/nvme-fw-download.txt +++ b/Documentation/nvme-fw-download.txt @@ -11,8 +11,7 @@ SYNOPSIS 'nvme fw-download' [--fw= | -f ] [--xfer= | -x ] [--offset= | -O ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -71,17 +70,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-fw-log.txt b/Documentation/nvme-fw-log.txt index d95754802f..b57ca85576 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -30,14 +30,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-gen-dhchap-key.txt b/Documentation/nvme-gen-dhchap-key.txt index 1e5f9696ed..dbb58bbebe 100644 --- a/Documentation/nvme-gen-dhchap-key.txt +++ b/Documentation/nvme-gen-dhchap-key.txt @@ -12,7 +12,7 @@ SYNOPSIS [--secret= | -s ] [--key-length= | -l ] [--nqn= | -n ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -44,14 +44,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-gen-hostnqn.txt b/Documentation/nvme-gen-hostnqn.txt index 7b7d776d35..0fa92a4b22 100644 --- a/Documentation/nvme-gen-hostnqn.txt +++ b/Documentation/nvme-gen-hostnqn.txt @@ -8,7 +8,8 @@ nvme-gen-hostnqn - Generate a host NVMe Qualified Name SYNOPSIS -------- [verse] -'nvme gen-hostnqn' [--output-format= | -o ] [--verbose | -v] +'nvme gen-hostnqn' + [] DESCRIPTION ----------- @@ -18,14 +19,8 @@ and prints it 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. --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-gen-tls-key.txt b/Documentation/nvme-gen-tls-key.txt index d474e64f6f..858f90e276 100644 --- a/Documentation/nvme-gen-tls-key.txt +++ b/Documentation/nvme-gen-tls-key.txt @@ -18,7 +18,7 @@ SYNOPSIS [--insert | -i] [--compat | -C] [--keyfile= | -f ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -94,14 +94,7 @@ OPTIONS Append the resulting TLS key to keyfile. This command line option is depending on --insert. --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-feature.txt b/Documentation/nvme-get-feature.txt index 85d9e4dd00..79fbfc7543 100644 --- a/Documentation/nvme-get-feature.txt +++ b/Documentation/nvme-get-feature.txt @@ -14,9 +14,9 @@ SYNOPSIS [--data-len= | -l ] [--sel=] [--raw-binary | -b] [--cdw11= | -c ] - [--human-readable | -H] [--changed | -C] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [--human-readable | -H] + [--changed | -C] + [] DESCRIPTION ----------- @@ -130,24 +130,14 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) -C:: --changed:: This option will show feature changed. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-lba-status.txt b/Documentation/nvme-get-lba-status.txt index dacc17ccee..db299cafcb 100644 --- a/Documentation/nvme-get-lba-status.txt +++ b/Documentation/nvme-get-lba-status.txt @@ -13,8 +13,7 @@ SYNOPSIS [--max-dw= | -m ] [--action= | -a ] [--range-len= | -l ] - [--timeout=] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -53,17 +52,7 @@ OPTIONS --range-len=:: Range Length(RL) specifies the length of the range of contiguous LBAs beginning at SLBA ---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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-log.txt b/Documentation/nvme-get-log.txt index b4233b4608..bf8b6d0209 100644 --- a/Documentation/nvme-get-log.txt +++ b/Documentation/nvme-get-log.txt @@ -20,7 +20,7 @@ SYNOPSIS [--csi= | -y ] [--ot= | -O ] [--xfer-len= | -x ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -147,14 +147,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-ns-id.txt b/Documentation/nvme-get-ns-id.txt index 8516cb89a2..bc4ea3cdb7 100644 --- a/Documentation/nvme-get-ns-id.txt +++ b/Documentation/nvme-get-ns-id.txt @@ -8,7 +8,8 @@ nvme-get-ns-id - Retrieves the namespace ID for an NVMe block device SYNOPSIS -------- [verse] -'nvme get-ns-id' [--output-format= | -o ] [--verbose | -v] +'nvme get-ns-id' + [] DESCRIPTION ----------- @@ -17,14 +18,8 @@ is mandatory and must be an NVMe block device (ex: /dev/nvme0n1). 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt index c3d4e5a7f1..4ae029ed02 100644 --- a/Documentation/nvme-get-property.txt +++ b/Documentation/nvme-get-property.txt @@ -11,8 +11,7 @@ SYNOPSIS [verse] 'nvme get-property' [--offset= | -O ] [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -25,20 +24,11 @@ OPTIONS 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 +--human-readable:: + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-get-reg.txt b/Documentation/nvme-get-reg.txt index 5511a346d3..f051f4d557 100644 --- a/Documentation/nvme-get-reg.txt +++ b/Documentation/nvme-get-reg.txt @@ -8,15 +8,15 @@ nvme-get-reg - Read and show the defined NVMe controller register SYNOPSIS -------- [verse] -'nvme get-reg' [--offset=, -O ] [--human-readable | -H] +'nvme get-reg' [--offset=, -O ] [--cap] [--vs] [--cmbloc] [--cmbsz] [--bpinfo] [--cmbsts] [--cmbebs] [--cmbswtp] [--crto] [--pmrcap] [--pmrsts] [--pmrebs] [--pmrswtp] [--intms] [--intmc] [--cc] [--csts] [--nssr] [--aqa] [--asq] [--acq] [--bprsel] [--bpmbl] [--cmbmsc] [--nssd] [--pmrctl] [--pmrmscl] [--pmrmscu] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -31,10 +31,6 @@ OPTIONS --offset=:: offset of the requested register --H:: ---human-readable:: - show register in readable format - --cap:: CAP=0x0 register offset @@ -119,17 +115,12 @@ OPTIONS --pmrmscu:: PMRMSCU=0xe18 register offset --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. +-H:: +--human-readable:: + Display values in a human-readable format where possible. + (deprecated, use --verbose) ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-help.txt b/Documentation/nvme-help.txt index 0c0c4cd8bb..c01ec3ba0a 100644 --- a/Documentation/nvme-help.txt +++ b/Documentation/nvme-help.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme help' [] + [] DESCRIPTION ----------- @@ -18,6 +19,8 @@ OPTIONS ------- No Options +include::global-options.txt[] + EXAMPLES -------- * Show help for nvme smart log: diff --git a/Documentation/nvme-host-discovery-log.txt b/Documentation/nvme-host-discovery-log.txt index eaa9fe279c..5cfd52f0b0 100644 --- a/Documentation/nvme-host-discovery-log.txt +++ b/Documentation/nvme-host-discovery-log.txt @@ -9,8 +9,7 @@ SYNOPSIS -------- [verse] 'nvme host-discovery-log' [--all-host-entries | -a] [--rae | -r] - [--verbose | -v] [--output-format= | -o ] - [--timeout=] + [] DESCRIPTION ----------- @@ -31,17 +30,7 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-huawei-id-ctrl.txt b/Documentation/nvme-huawei-id-ctrl.txt index 47225d1a68..1e16612685 100644 --- a/Documentation/nvme-huawei-id-ctrl.txt +++ b/Documentation/nvme-huawei-id-ctrl.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme huawei id-ctrl' [--vendor-specific | -v] [--raw-binary | -b] - [--output-format= | -o ] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -44,13 +45,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or - 'binary'. Only one output format can be used at a time. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-huawei-list.txt b/Documentation/nvme-huawei-list.txt index 95f1099927..6db1d01caa 100644 --- a/Documentation/nvme-huawei-list.txt +++ b/Documentation/nvme-huawei-list.txt @@ -8,7 +8,8 @@ nvme-huawei-list - List all recognized Huawei NVMe devices SYNOPSIS -------- [verse] -'nvme huawei list' [--output-format= | -o ] +'nvme huawei list' + [] DESCRIPTION ----------- @@ -17,10 +18,8 @@ for those Huawei 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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt index 3667c63471..fb9c79cc66 100644 --- a/Documentation/nvme-id-ctrl.txt +++ b/Documentation/nvme-id-ctrl.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme id-ctrl' [--vendor-specific | -V] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -38,17 +39,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-domain.txt b/Documentation/nvme-id-domain.txt index 27e1d755ea..116c5f28bd 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 ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -26,14 +26,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt index bb85aef1e4..3b15e3dd6e 100644 --- a/Documentation/nvme-id-iocs.txt +++ b/Documentation/nvme-id-iocs.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme id-iocs' [--controller-id= | -c ] - [--output-format= | -o ] [--verbose | -v] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -25,19 +26,13 @@ OPTIONS --controller-id=:: Retrieve the identify I/O Command set data structure for the given cntid. If this value is not given, cntid will be 0xffff. + -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. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-ns-granularity.txt b/Documentation/nvme-id-ns-granularity.txt index 67006c333d..fbf3181e6e 100644 --- a/Documentation/nvme-id-ns-granularity.txt +++ b/Documentation/nvme-id-ns-granularity.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'nvme id-ns-granularity' - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -24,14 +24,8 @@ On success it returns 0, error code otherwise. 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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-ns-lba-format.txt b/Documentation/nvme-id-ns-lba-format.txt index 514ba48999..7edc51f98c 100644 --- a/Documentation/nvme-id-ns-lba-format.txt +++ b/Documentation/nvme-id-ns-lba-format.txt @@ -10,8 +10,7 @@ SYNOPSIS [verse] 'nvme id-ns' [--uuid-index= | -U ] [--lba-format-index= | -i ] - [--verbose | -v] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -37,14 +36,7 @@ OPTIONS This field specifies the index into the LBA Format list identifying the LBA Format capabilities that are to be returned --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-ns.txt b/Documentation/nvme-id-ns.txt index d75ea5062e..c8482f4542 100644 --- a/Documentation/nvme-id-ns.txt +++ b/Documentation/nvme-id-ns.txt @@ -11,7 +11,7 @@ SYNOPSIS 'nvme id-ns' [--vendor-specific | -V] [--raw-binary | -b] [--namespace-id= | -n ] [--force] [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -59,17 +59,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-nvmset.txt b/Documentation/nvme-id-nvmset.txt index e2894e3715..c55016da5d 100644 --- a/Documentation/nvme-id-nvmset.txt +++ b/Documentation/nvme-id-nvmset.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-nvmset' [--nvmset_id= | -i ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -31,14 +31,7 @@ OPTIONS 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-id-uuid.txt b/Documentation/nvme-id-uuid.txt index f7cc1c0b6e..11c434822e 100644 --- a/Documentation/nvme-id-uuid.txt +++ b/Documentation/nvme-id-uuid.txt @@ -8,8 +8,9 @@ nvme-id-uuid - Send a Identify UUID List command to the specified device SYNOPSIS -------- [verse] -'nvme id-uuid' [--raw-binary | -b] [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] +'nvme id-uuid' [--raw-binary | -b] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -30,17 +31,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-inspur-nvme-vendor-log.txt b/Documentation/nvme-inspur-nvme-vendor-log.txt index c860497269..df8cc0b1c0 100644 --- a/Documentation/nvme-inspur-nvme-vendor-log.txt +++ b/Documentation/nvme-inspur-nvme-vendor-log.txt @@ -8,7 +8,8 @@ nvme-inspur-nvme-vendor-log - Send NVMe Inspur Device Vendor log page request, r SYNOPSIS -------- [verse] -'nvme inspur nvme-vendor-log' +'nvme inspur nvme-vendor-log' + [] DESCRIPTION ----------- @@ -23,6 +24,8 @@ OPTIONS ------- none +include::global-options.txt[] + 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 469d60ea2f..8789d33a6b 100644 --- a/Documentation/nvme-intel-id-ctrl.txt +++ b/Documentation/nvme-intel-id-ctrl.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme intel id-ctrl' [--vendor-specific | -v] [--raw-binary | -b] - [--output-format= | -o ] + [] DESCRIPTION ----------- @@ -39,15 +39,7 @@ OPTIONS the vendor specific region of the structure in hex with ascii interpretation. --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-intel-internal-log.txt b/Documentation/nvme-intel-internal-log.txt index a1e1792d29..569f4d713c 100644 --- a/Documentation/nvme-intel-internal-log.txt +++ b/Documentation/nvme-intel-internal-log.txt @@ -13,6 +13,7 @@ SYNOPSIS [--nlognum=, m ] [--namespace-id=, -n ] [--output-file=, -o ] + [] DESCRIPTION ----------- @@ -53,6 +54,8 @@ OPTIONS When used with 'nlog', this specifies which nlog to read. -1 for all, if supported by the device. +include::global-options.txt[] + EXAMPLES -------- * Gets the nlog from the device and saves to default file: diff --git a/Documentation/nvme-intel-lat-stats.txt b/Documentation/nvme-intel-lat-stats.txt index 767cf92165..161121d747 100644 --- a/Documentation/nvme-intel-lat-stats.txt +++ b/Documentation/nvme-intel-lat-stats.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme intel lat-stats' [--write | -w] [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -33,6 +34,8 @@ OPTIONS --write:: Get write statistics. Read statistics are returned by default. +include::global-options.txt[] + EXAMPLES -------- * Get the read statistics diff --git a/Documentation/nvme-intel-market-name.txt b/Documentation/nvme-intel-market-name.txt index 0b4b96ab69..b62614fe2b 100644 --- a/Documentation/nvme-intel-market-name.txt +++ b/Documentation/nvme-intel-market-name.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme intel market-name' [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -30,6 +31,8 @@ OPTIONS Print the raw buffer to stdout. Structure is not parsed by program. This overrides the vendor specific and human readable options. +include::global-options.txt[] + EXAMPLES -------- * Get the marketing name diff --git a/Documentation/nvme-intel-smart-log-add.txt b/Documentation/nvme-intel-smart-log-add.txt index 0ed1f10cda..58a0fc6a7e 100644 --- a/Documentation/nvme-intel-smart-log-add.txt +++ b/Documentation/nvme-intel-smart-log-add.txt @@ -11,6 +11,7 @@ SYNOPSIS [verse] 'nvme intel smart-log-add' [--namespace-id= | -n ] [--raw-binary | -b] [--json | -j] + [] DESCRIPTION ----------- @@ -43,6 +44,8 @@ OPTIONS --json:: Dump output in json format. +include::global-options.txt[] + EXAMPLES -------- * Print the Intel Additional SMART log page in a human readable format: diff --git a/Documentation/nvme-intel-temp-stats.txt b/Documentation/nvme-intel-temp-stats.txt index 656422f6c8..e870f6366a 100644 --- a/Documentation/nvme-intel-temp-stats.txt +++ b/Documentation/nvme-intel-temp-stats.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme intel temp-stats' [--raw-binary | -b] + [] DESCRIPTION ----------- @@ -29,6 +30,8 @@ OPTIONS --raw-binary:: Print the raw temperature stats log buffer to stdout. +include::global-options.txt[] + EXAMPLES -------- * Print the temperature stats log page in a human readable format: diff --git a/Documentation/nvme-io-mgmt-recv.txt b/Documentation/nvme-io-mgmt-recv.txt index c4fe9a58ce..4afd163614 100644 --- a/Documentation/nvme-io-mgmt-recv.txt +++ b/Documentation/nvme-io-mgmt-recv.txt @@ -12,8 +12,7 @@ SYNOPSIS [--mos= | -s ] [--mo= | -m ] [--data= | -d ] [--data-len= | -l ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -50,17 +49,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-io-mgmt-send.txt b/Documentation/nvme-io-mgmt-send.txt index 4e799b5e7b..4f187611da 100644 --- a/Documentation/nvme-io-mgmt-send.txt +++ b/Documentation/nvme-io-mgmt-send.txt @@ -12,8 +12,7 @@ SYNOPSIS [--mos= | -s ] [--mo= | -m ] [--data= | -d ] [--data-len= | -l ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -49,17 +48,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] NVME ---- diff --git a/Documentation/nvme-io-passthru.txt b/Documentation/nvme-io-passthru.txt index b2e87d96fa..0b3f5bbfd5 100644 --- a/Documentation/nvme-io-passthru.txt +++ b/Documentation/nvme-io-passthru.txt @@ -20,11 +20,11 @@ SYNOPSIS [--read | -r] [--write | -w] [--input-file= | -i ] [--metadata= | -M ] - [--timeout=] [--show-command | -s] + [--show-command | -s] [--dry-run | -d] [--raw-binary | -b] [--prefill= | -p ] [--latency | -T] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -122,17 +122,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-lba-status-log.txt b/Documentation/nvme-lba-status-log.txt index 7d6efbd781..1fab71fd82 100644 --- a/Documentation/nvme-lba-status-log.txt +++ b/Documentation/nvme-lba-status-log.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme lba-status-log' [--rae | -r] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -30,14 +30,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list-ctrl.txt b/Documentation/nvme-list-ctrl.txt index 6cd5c015a5..d5df381547 100644 --- a/Documentation/nvme-list-ctrl.txt +++ b/Documentation/nvme-list-ctrl.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme list-ctrl' [--cntid= | -c ] [--namespace-id= | -n ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -39,14 +39,7 @@ 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', 'json' or 'binary'. Only one - output format can be used at a time. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list-endgrp.txt b/Documentation/nvme-list-endgrp.txt index 2d7724d9c2..3a274b689f 100644 --- a/Documentation/nvme-list-endgrp.txt +++ b/Documentation/nvme-list-endgrp.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'nvme list-endgrp' [--endgrp-id= | -i ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -30,14 +30,7 @@ OPTIONS 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list-ns.txt b/Documentation/nvme-list-ns.txt index 76c0211a9e..a01fb3ebfb 100644 --- a/Documentation/nvme-list-ns.txt +++ b/Documentation/nvme-list-ns.txt @@ -11,8 +11,7 @@ SYNOPSIS 'nvme list-ns' [--namespace-id= | -n ] [--csi= | -y ] [--all | -a] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -43,17 +42,7 @@ 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', 'json' or 'binary'. Only one - output format can be used at a time. - --v:: ---verbose:: - Increase the information detail in the output. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list-secondary.txt b/Documentation/nvme-list-secondary.txt index 88fbf420cb..d381277865 100644 --- a/Documentation/nvme-list-secondary.txt +++ b/Documentation/nvme-list-secondary.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme list-secondary' [--cntid= | -c ] [--num-entries= | -e ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -32,14 +32,7 @@ OPTIONS --num-entries=:: Number of entries to retrieve. --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list-subsys.txt b/Documentation/nvme-list-subsys.txt index a5d2d480a2..cd580c8b72 100644 --- a/Documentation/nvme-list-subsys.txt +++ b/Documentation/nvme-list-subsys.txt @@ -8,7 +8,8 @@ nvme-list-subsys - List all NVMe subsystems SYNOPSIS -------- [verse] -'nvme list-subsys' [--output-format= | -o ] [--verbose | -v] +'nvme list-subsys' + [] DESCRIPTION ----------- @@ -19,14 +20,8 @@ and subsystems leading to the device. 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt index 04eaecf061..b245a775cf 100644 --- a/Documentation/nvme-list.txt +++ b/Documentation/nvme-list.txt @@ -8,7 +8,8 @@ nvme-list - List all recognized NVMe devices SYNOPSIS -------- [verse] -'nvme list' [--output-format= | -o ] [--verbose | -v] +'nvme list' + [] DESCRIPTION ----------- @@ -18,16 +19,8 @@ Namespace usage printed in powers of 1,000 with SI prefixes. (e.g., 1.02 TB) 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 in the output, showing nvme subsystems, - controllers and namespaces separately and how they're related to each - other. +include::global-options.txt[] ENVIRONMENT ----------- diff --git a/Documentation/nvme-lockdown.txt b/Documentation/nvme-lockdown.txt index 22e91061f1..c9566cb81b 100644 --- a/Documentation/nvme-lockdown.txt +++ b/Documentation/nvme-lockdown.txt @@ -13,8 +13,7 @@ SYNOPSIS [--prhbt= | -p ] [--scp= | -s ] [--uuid= | -U ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -48,17 +47,7 @@ OPTIONS 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-mangoboost-id-ctrl.txt b/Documentation/nvme-mangoboost-id-ctrl.txt index ade33d24aa..c9f43ee423 100644 --- a/Documentation/nvme-mangoboost-id-ctrl.txt +++ b/Documentation/nvme-mangoboost-id-ctrl.txt @@ -9,7 +9,8 @@ SYNOPSIS -------- [verse] 'nvme mangoboost id-ctrl' [--vendor-specific | -V] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -41,17 +42,10 @@ OPTIONS -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-media-unit-stat-log.txt b/Documentation/nvme-media-unit-stat-log.txt index 997a497421..51146163ae 100644 --- a/Documentation/nvme-media-unit-stat-log.txt +++ b/Documentation/nvme-media-unit-stat-log.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'nvme media-unit-stat-log' [--dom-id | -d] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -24,12 +24,6 @@ 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. - -d:: --dom-id:: To get the domain ID. @@ -38,6 +32,8 @@ OPTIONS --raw-binary:: To show raw binary data. +include::global-options.txt[] + EXAMPLES -------- No examples provided yet. diff --git a/Documentation/nvme-mgmt-addr-list-log.txt b/Documentation/nvme-mgmt-addr-list-log.txt index e381bc4514..f010eb35df 100644 --- a/Documentation/nvme-mgmt-addr-list-log.txt +++ b/Documentation/nvme-mgmt-addr-list-log.txt @@ -8,8 +8,8 @@ nvme-mgmt-addr-list-log - Retrieve Management Address List Log, show it SYNOPSIS -------- [verse] -'nvme mgmt-addr-list-log' [--verbose | -v] - [--output-format= | -o ] [--timeout=] +'nvme mgmt-addr-list-log' + [] DESCRIPTION ----------- @@ -21,17 +21,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt index 22218040ff..f1d6880278 100644 --- a/Documentation/nvme-mi-cmd-support-effects-log.txt +++ b/Documentation/nvme-mi-cmd-support-effects-log.txt @@ -9,8 +9,8 @@ returns results and structure SYNOPSIS -------- [verse] -'nvme-mi-cmd-support-effects-log' [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] +'nvme-mi-cmd-support-effects-log' + [] DESCRIPTION ----------- @@ -26,19 +26,8 @@ raw buffer may be printed to stdout. OPTIONS ------- --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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-micron-clear-pcie-errors.txt b/Documentation/nvme-micron-clear-pcie-errors.txt index 4df0e8a29e..1f8ff4ec03 100644 --- a/Documentation/nvme-micron-clear-pcie-errors.txt +++ b/Documentation/nvme-micron-clear-pcie-errors.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme micron clear-pcie-correctable-errors' + [] DESCRIPTION ----------- @@ -25,6 +26,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Retrieve NAND statistics information diff --git a/Documentation/nvme-micron-id-ctrl.txt b/Documentation/nvme-micron-id-ctrl.txt index b5b4edfe1f..c523af1397 100644 --- a/Documentation/nvme-micron-id-ctrl.txt +++ b/Documentation/nvme-micron-id-ctrl.txt @@ -8,7 +8,8 @@ nvme-micron-id-ctrl - Send NVMe Identify Controller with Micron vendor-specific SYNOPSIS -------- [verse] -'nvme micron id-ctrl' [--output-format= | -o ] +'nvme micron id-ctrl' + [] DESCRIPTION ----------- @@ -35,10 +36,8 @@ MSMT (Maximum Stop Measurement Time):: OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. - Default is 'normal'. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-micron-internal-log.txt b/Documentation/nvme-micron-internal-log.txt index b8e92281dc..d75d4c0388 100644 --- a/Documentation/nvme-micron-internal-log.txt +++ b/Documentation/nvme-micron-internal-log.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme micron vs-internal-log' [--package=, -p ] + [] DESCRIPTION ----------- @@ -32,6 +33,8 @@ OPTIONS --package=:: name of the file (with .zip extension) to save the device logs +include::global-options.txt[] + EXAMPLES -------- * Gets the logs from the device and saves to micron_logs.zip file diff --git a/Documentation/nvme-micron-nand-stats.txt b/Documentation/nvme-micron-nand-stats.txt index 68e211ef55..7036097bef 100644 --- a/Documentation/nvme-micron-nand-stats.txt +++ b/Documentation/nvme-micron-nand-stats.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme micron vs-nand-stats' + [] DESCRIPTION ----------- @@ -26,6 +27,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Retrieve NAND statistics information diff --git a/Documentation/nvme-micron-pcie-stats.txt b/Documentation/nvme-micron-pcie-stats.txt index f58257ae57..c6d5e81918 100644 --- a/Documentation/nvme-micron-pcie-stats.txt +++ b/Documentation/nvme-micron-pcie-stats.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme micron vs-pcie-stats' + [] DESCRIPTION ----------- @@ -26,6 +27,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Retrieve PCIe error information diff --git a/Documentation/nvme-micron-selective-download.txt b/Documentation/nvme-micron-selective-download.txt index c20af74fe3..d676e97e7b 100644 --- a/Documentation/nvme-micron-selective-download.txt +++ b/Documentation/nvme-micron-selective-download.txt @@ -12,6 +12,7 @@ SYNOPSIS [verse] 'nvme micron selective-download' [--fw=, -f ] [--select=, -s ] + [] DESCRIPTION ----------- @@ -39,6 +40,8 @@ OPTIONS EEP:: This updates the eeprom and main firmware\n" ALL:: This updates the eeprom, OOB, and main firmware"; +include::global-options.txt[] + EXAMPLES -------- * Update OOB and main firmware diff --git a/Documentation/nvme-micron-smart-add-log.txt b/Documentation/nvme-micron-smart-add-log.txt index 13e0d968d1..3e7e515916 100644 --- a/Documentation/nvme-micron-smart-add-log.txt +++ b/Documentation/nvme-micron-smart-add-log.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme micron vs-smart-add-log' -f + [] DESCRIPTION ----------- @@ -35,6 +36,8 @@ OPTIONS -f :: Controls the format of displayed output. +include::global-options.txt[] + EXAMPLES -------- * Retrieve NAND/extended SMART data and display in json format diff --git a/Documentation/nvme-micron-smart-log.txt b/Documentation/nvme-micron-smart-log.txt index 34e9351c0c..1718c4f1a7 100644 --- a/Documentation/nvme-micron-smart-log.txt +++ b/Documentation/nvme-micron-smart-log.txt @@ -8,7 +8,8 @@ nvme-micron-smart-log - Retrieve SMART/Health log with Micron vendor-specific fi SYNOPSIS -------- [verse] -'nvme micron smart-log' [--output-format= | -o ] +'nvme micron smart-log' + [] DESCRIPTION ----------- @@ -30,10 +31,8 @@ IPM (Interval Power Measurement):: OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' or 'json'. - Default is 'normal'. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-micron-temperature-stats.txt b/Documentation/nvme-micron-temperature-stats.txt index 8b013d9ba8..0e1f675b33 100644 --- a/Documentation/nvme-micron-temperature-stats.txt +++ b/Documentation/nvme-micron-temperature-stats.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme micron vs-temperature-stats' + [] DESCRIPTION ----------- @@ -26,6 +27,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Retrieve temperature information diff --git a/Documentation/nvme-netapp-ontapdevices.txt b/Documentation/nvme-netapp-ontapdevices.txt index e56bae571d..333344c88d 100644 --- a/Documentation/nvme-netapp-ontapdevices.txt +++ b/Documentation/nvme-netapp-ontapdevices.txt @@ -8,7 +8,8 @@ nvme-netapp-ontapdevices - Display information about ONTAP devices SYNOPSIS -------- [verse] -'nvme netapp ontapdevices' [--output-format= | -o ] [--verbose | -v] +'nvme netapp ontapdevices' + [] DESCRIPTION ----------- @@ -17,14 +18,8 @@ identified using the Identify Controller data. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' (default), 'column', or - 'json'. Only one output format can be used at a time. --v:: ---verbose:: - Display additional information of ONTAP devices on the host. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-netapp-smdevices.txt b/Documentation/nvme-netapp-smdevices.txt index c135ff0ce1..5bdf2741d3 100644 --- a/Documentation/nvme-netapp-smdevices.txt +++ b/Documentation/nvme-netapp-smdevices.txt @@ -8,7 +8,8 @@ nvme-netapp-smdevices - Display information for each NVMe path to an E-Series vo SYNOPSIS -------- [verse] -'nvme netapp smdevices' [--output-format= | -o ] [--verbose | -v] +'nvme netapp smdevices' + [] DESCRIPTION ----------- @@ -18,14 +19,8 @@ NVMe nodes in /dev by sending an Identify Controller. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal' (default), 'column', or - 'json'. Only one output format can be used at a time. --v:: ---verbose:: - Display additional information of E-Series devices on the host. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ns-descs.txt b/Documentation/nvme-ns-descs.txt index 04c6e51ecf..b58140cc4d 100644 --- a/Documentation/nvme-ns-descs.txt +++ b/Documentation/nvme-ns-descs.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'nvme ns-descs' [--namespace-id= | -n ] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -42,14 +42,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ns-rescan.txt b/Documentation/nvme-ns-rescan.txt index 5681eabfbf..73fa005c8a 100644 --- a/Documentation/nvme-ns-rescan.txt +++ b/Documentation/nvme-ns-rescan.txt @@ -8,7 +8,8 @@ nvme-ns-rescan - Rescans the nvme namespaces. SYNOPSIS -------- [verse] -'nvme ns-rescan' [--output-format= | -o ] [--verbose | -v] +'nvme ns-rescan' + [] DESCRIPTION ----------- @@ -17,14 +18,8 @@ be an NVMe character device (ex: /dev/nvme0). 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ctrl.txt b/Documentation/nvme-nvm-id-ctrl.txt index eabc4b1f05..27096cc257 100644 --- a/Documentation/nvme-nvm-id-ctrl.txt +++ b/Documentation/nvme-nvm-id-ctrl.txt @@ -8,7 +8,8 @@ nvme-nvm-id-ctrl - Send NVMe Identify Controller, return NVM command set structu SYNOPSIS -------- [verse] -'nvme nvm-id-ctrl' [--output-format= | -o ] [--verbose | -v] +'nvme nvm-id-ctrl' + [] DESCRIPTION ----------- @@ -23,14 +24,8 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ns-lba-format.txt b/Documentation/nvme-nvm-id-ns-lba-format.txt index 1048995ce3..f751600e0d 100644 --- a/Documentation/nvme-nvm-id-ns-lba-format.txt +++ b/Documentation/nvme-nvm-id-ns-lba-format.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns-lba-format' [--uuid-index= | -U ] [--lba-format-index= | -i ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -36,14 +36,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-nvm-id-ns.txt b/Documentation/nvme-nvm-id-ns.txt index 5a8cb09043..5e93104b89 100644 --- a/Documentation/nvme-nvm-id-ns.txt +++ b/Documentation/nvme-nvm-id-ns.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme nvm-id-ns' [--uuid-index= | -U ] [--namespace-id= | -n ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -36,14 +36,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-nvme-mi-recv.txt b/Documentation/nvme-nvme-mi-recv.txt index c2df630289..787b75214f 100644 --- a/Documentation/nvme-nvme-mi-recv.txt +++ b/Documentation/nvme-nvme-mi-recv.txt @@ -14,7 +14,7 @@ SYNOPSIS [--nmimt= | -m ] [--nmd0= | -0 ] [--nmd1= | -1 ] [--input-file= | -i ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -58,14 +58,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-nvme-mi-send.txt b/Documentation/nvme-nvme-mi-send.txt index 8e356011e9..4130fc6cc2 100644 --- a/Documentation/nvme-nvme-mi-send.txt +++ b/Documentation/nvme-nvme-mi-send.txt @@ -14,7 +14,7 @@ SYNOPSIS [--nmimt= | -m ] [--nmd0= | -0 ] [--nmd1= | -1 ] [--input-file= | -i ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -58,14 +58,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-clear-fw-activate-history.txt b/Documentation/nvme-ocp-clear-fw-activate-history.txt index 335a2288fd..b4332f1a56 100644 --- a/Documentation/nvme-ocp-clear-fw-activate-history.txt +++ b/Documentation/nvme-ocp-clear-fw-activate-history.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp clear-fw-activate-history' [--no-uuid | -n] + [] DESCRIPTION ----------- @@ -36,6 +37,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Clears OCP Firmware Activation History Log for the device: diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt index 3d5706d908..7a1d3ade04 100644 --- a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt +++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp clear-pcie-correctable-error-counters' [--no-uuid | -n] + [] DESCRIPTION ----------- @@ -36,6 +37,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Clears PCIe correctable error counters Log for the device: diff --git a/Documentation/nvme-ocp-device-capability-log.txt b/Documentation/nvme-ocp-device-capability-log.txt index d2f07613ec..54adaf57a7 100644 --- a/Documentation/nvme-ocp-device-capability-log.txt +++ b/Documentation/nvme-ocp-device-capability-log.txt @@ -8,7 +8,8 @@ nvme-ocp-device-capability-log - Retrieves OCP Device Capability Log Page SYNOPSIS -------- [verse] -'nvme ocp device-capability-log' [--output-format= | -o ] +'nvme ocp device-capability-log' + [] DESCRIPTION ----------- @@ -24,10 +25,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.txt b/Documentation/nvme-ocp-eol-plp-failure-mode.txt index 16939250c8..88388f3700 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.txt +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.txt @@ -12,6 +12,7 @@ SYNOPSIS 'nvme ocp eol-plp-failure-mode' [--mode= | -m ] [--no-uuid | -n] [--save | -s] [--sel=] + [] DESCRIPTION ----------- @@ -59,6 +60,8 @@ OPTIONS |4-7|Reserved |================== +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a eol-plp-failure-mode to retrieve the 0xC2 get features. diff --git a/Documentation/nvme-ocp-error-recovery-log.txt b/Documentation/nvme-ocp-error-recovery-log.txt index 7a261503dc..7f27f76128 100644 --- a/Documentation/nvme-ocp-error-recovery-log.txt +++ b/Documentation/nvme-ocp-error-recovery-log.txt @@ -1,42 +1,41 @@ -nvme-ocp-error-recovery-log(1) -============================== - -NAME ----- -nvme-ocp-error-recovery-log - Retrieves OCP Error Recovery Log Page - -SYNOPSIS --------- -[verse] -'nvme ocp error-recovery-log' [--output-format= | -o ] - -DESCRIPTION ------------ -For the NVMe device given, retrieves OCP Error Recovery Log Page - -The parameter is mandatory and may be either the NVMe character -device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). - -This will only work on OCP compliant devices supporting this feature. -Results for any other device are undefined. - -On success it returns 0, error code otherwise. - -OPTIONS -------- --o :: ---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. - -EXAMPLES --------- -* Has the program issue a error-recovery-log command to retrieve the 0xC1 log page. -+ ------------- -# nvme ocp error-recovery-log /dev/nvme0 -o normal ------------- - -NVME ----- -Part of the nvme-user suite. +nvme-ocp-error-recovery-log(1) +============================== + +NAME +---- +nvme-ocp-error-recovery-log - Retrieves OCP Error Recovery Log Page + +SYNOPSIS +-------- +[verse] +'nvme ocp error-recovery-log' + [] + +DESCRIPTION +----------- +For the NVMe device given, retrieves OCP Error Recovery Log Page + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- + +include::global-options.txt[] + +EXAMPLES +-------- +* Has the program issue a error-recovery-log command to retrieve the 0xC1 log page. ++ +------------ +# nvme ocp error-recovery-log /dev/nvme0 -o normal +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-get-clear-pcie-correctable-errors.txt b/Documentation/nvme-ocp-get-clear-pcie-correctable-errors.txt index dce716bdd0..47823d12b8 100644 --- a/Documentation/nvme-ocp-get-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-ocp-get-clear-pcie-correctable-errors.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme ocp get-clear-pcie-correctable-errors' [--sel=] [--namespace-id | -n ] [--no-uuid | -u] + [] DESCRIPTION ----------- @@ -49,6 +50,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-clear-pcie-correctable-errors to retrieve the 0xC3 get features. diff --git a/Documentation/nvme-ocp-get-dssd-async-event-config.txt b/Documentation/nvme-ocp-get-dssd-async-event-config.txt index 225481890c..ccecda6da1 100644 --- a/Documentation/nvme-ocp-get-dssd-async-event-config.txt +++ b/Documentation/nvme-ocp-get-dssd-async-event-config.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp get-dssd-async-event-config' [--sel=] + [] DESCRIPTION ----------- @@ -40,6 +41,8 @@ OPTIONS |4-7|Reserved |================== +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-dssd-async-event-config to retrieve the saved 0xC9 get features. diff --git a/Documentation/nvme-ocp-get-dssd-power-state-feature.txt b/Documentation/nvme-ocp-get-dssd-power-state-feature.txt index 716de055da..26d8d34d2e 100644 --- a/Documentation/nvme-ocp-get-dssd-power-state-feature.txt +++ b/Documentation/nvme-ocp-get-dssd-power-state-feature.txt @@ -11,6 +11,7 @@ SYNOPSIS 'nvme ocp get-dssd-power-state-feature' [--sel=] [--all | -a] [--no-uuid | -n] + [] DESCRIPTION ----------- @@ -53,6 +54,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-dssd-power-state-feature command to get the Curent DSSD Power State in watts. diff --git a/Documentation/nvme-ocp-get-error-injection.txt b/Documentation/nvme-ocp-get-error-injection.txt index 188c6b3f6a..cae5f83e4e 100644 --- a/Documentation/nvme-ocp-get-error-injection.txt +++ b/Documentation/nvme-ocp-get-error-injection.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme ocp get-error-injection' [--no-uuid | -n] [--sel=] [--all-ns | -a] + [] DESCRIPTION ----------- @@ -49,6 +50,8 @@ OPTIONS Send the command to all namespaces. This option is used to specify whether to target all namespaces or no specific namespace. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-error-injection to retrieve the 0xC0 get features. diff --git a/Documentation/nvme-ocp-get-idle-wakeup-time.txt b/Documentation/nvme-ocp-get-idle-wakeup-time.txt index 7749ab8a5b..33f8c16f6d 100644 --- a/Documentation/nvme-ocp-get-idle-wakeup-time.txt +++ b/Documentation/nvme-ocp-get-idle-wakeup-time.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp get-idle-wakeup-time' [--sel=] [--namespace-id= | -n ] + [] DESCRIPTION ----------- @@ -46,6 +47,8 @@ OPTIONS |4-7|Reserved |================== +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-idle-wakeup-time to retrieve the 0xCA get features. diff --git a/Documentation/nvme-ocp-get-latency-monitor.txt b/Documentation/nvme-ocp-get-latency-monitor.txt index 218c21e7d6..46995759c6 100644 --- a/Documentation/nvme-ocp-get-latency-monitor.txt +++ b/Documentation/nvme-ocp-get-latency-monitor.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme ocp get-latency-monitor' [--sel=] [--namespace-id | -n ] [--no-uuid | -u] + [] DESCRIPTION ----------- @@ -49,6 +50,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-latency-monitor to retrieve the 0xC5 get features. diff --git a/Documentation/nvme-ocp-get-plp-health-check-interval.txt b/Documentation/nvme-ocp-get-plp-health-check-interval.txt index e72411d3f9..6720204235 100644 --- a/Documentation/nvme-ocp-get-plp-health-check-interval.txt +++ b/Documentation/nvme-ocp-get-plp-health-check-interval.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp get-plp-health-check-interval' [--sel=] + [] DESCRIPTION ----------- @@ -41,6 +42,8 @@ OPTIONS |4-7|Reserved |================== +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-plp-health-check-interval to retrieve the 0xC6 get features. diff --git a/Documentation/nvme-ocp-get-telemetry-profile.txt b/Documentation/nvme-ocp-get-telemetry-profile.txt index 93caa0a046..b124fa8016 100644 --- a/Documentation/nvme-ocp-get-telemetry-profile.txt +++ b/Documentation/nvme-ocp-get-telemetry-profile.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme ocp get-telemetry-profile' [--sel=] [--namespace-id | -n ] [--no-uuid | -u] + [] DESCRIPTION ----------- @@ -49,6 +50,8 @@ OPTIONS Do not try to automatically detect UUID index for this command (required for old OCP 1.0 support) +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a get-telemetry-profile to retrieve the 0xC8 get features. diff --git a/Documentation/nvme-ocp-hardware-component-log.txt b/Documentation/nvme-ocp-hardware-component-log.txt index c084f641df..4abc6310bc 100644 --- a/Documentation/nvme-ocp-hardware-component-log.txt +++ b/Documentation/nvme-ocp-hardware-component-log.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'nvme ocp hardware-component-log' [--comp-id= | -i ] - [--list | -l] [--verbose | -v] - [--output-format= | -o ] [--timeout=] + [--list | -l] + [] DESCRIPTION ----------- @@ -53,17 +53,7 @@ OPTIONS --list:: list component descriptions --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-internal-log.txt b/Documentation/nvme-ocp-internal-log.txt index ed9330fe37..80c17fde55 100644 --- a/Documentation/nvme-ocp-internal-log.txt +++ b/Documentation/nvme-ocp-internal-log.txt @@ -15,9 +15,9 @@ SYNOPSIS [--telemetry-log= | -l ] [--string-log= | -s ] [--output-file= | -f ] - [--output-format= | -o ] [--data-area= | -a ] [--telemetry-type= | -t ] + [] DESCRIPTION ----------- @@ -53,11 +53,6 @@ OPTIONS Filepath name used as the prefix for the telemetry and string log bin files along with the human-readable parsed output file. --o :: ---output-format=:: - Set the reporting format to 'normal', 'json'. Only one output format can be - used at a time, the default value is 'json'. - -a :: --data-area=:: Retrieves the specific data area requested. Valid inputs are 1, 2, 3, or 4. @@ -71,6 +66,8 @@ OPTIONS Get Log Page command is processed. If set to host0, controller shall not update this data. +include::global-options.txt[] + EXAMPLES -------- diff --git a/Documentation/nvme-ocp-latency-monitor-log.txt b/Documentation/nvme-ocp-latency-monitor-log.txt index a67c52378f..d41ccdddcf 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.txt +++ b/Documentation/nvme-ocp-latency-monitor-log.txt @@ -9,7 +9,8 @@ readable format SYNOPSIS -------- [verse] -'nvme ocp latency-monitor-log' [--output-format= | -o ] +'nvme ocp latency-monitor-log' + [] DESCRIPTION ----------- @@ -26,10 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-persistent-event-log.txt b/Documentation/nvme-ocp-persistent-event-log.txt index 4cb1f42ddb..153b834df0 100644 --- a/Documentation/nvme-ocp-persistent-event-log.txt +++ b/Documentation/nvme-ocp-persistent-event-log.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme ocp persistent-event-log' [--action= | -a ] [--log-len= | -l ] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -48,14 +48,7 @@ OPTIONS --raw-binary:: 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-set-dssd-async-event-config.txt b/Documentation/nvme-ocp-set-dssd-async-event-config.txt index de60bbf6f5..3111082268 100644 --- a/Documentation/nvme-ocp-set-dssd-async-event-config.txt +++ b/Documentation/nvme-ocp-set-dssd-async-event-config.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp set-dssd-async-event-config' [--enable-panic-notices | -e] [--save | -s] + [] DESCRIPTION @@ -33,6 +34,7 @@ OPTIONS --save:: Save the attribute so that it persists through all power states and resets. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt index c9ae578333..3beddb6784 100644 --- a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt +++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt @@ -11,6 +11,7 @@ SYNOPSIS 'nvme ocp set-dssd-power-state-feature' [--power-state= | -p ] [--no-uuid | -n] [--save | -s] + [] DESCRIPTION ----------- @@ -30,6 +31,8 @@ OPTIONS --power-state=:: DSSD Power State to set in watts. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a set-dssd-power-state-feature command to set DSSD Power State to set in watts. diff --git a/Documentation/nvme-ocp-set-error-injection.txt b/Documentation/nvme-ocp-set-error-injection.txt index 937cc3a8c1..1154436842 100644 --- a/Documentation/nvme-ocp-set-error-injection.txt +++ b/Documentation/nvme-ocp-set-error-injection.txt @@ -11,7 +11,8 @@ SYNOPSIS 'nvme ocp set-error-injection' [--data= | -d ] [--number= | -n ] [--no-uuid | -N] [--all-ns | -a] [--type= | -t ] - [--nrtdp= | -r ] [--timeout=] + [--nrtdp= | -r ] + [] DESCRIPTION ----------- @@ -51,8 +52,7 @@ OPTIONS --nrtdp=:: Number of reads to trigger device panic ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-set-plp-health-check-interval.txt b/Documentation/nvme-ocp-set-plp-health-check-interval.txt index c53c219a19..16bde17074 100644 --- a/Documentation/nvme-ocp-set-plp-health-check-interval.txt +++ b/Documentation/nvme-ocp-set-plp-health-check-interval.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme ocp set-plp-health-check-interval' [--plp_health_interval= | -p ] [--save | -s] [--no-uuid | -n] + [] DESCRIPTION @@ -39,6 +40,7 @@ OPTIONS --save:: Save the attribute so that it persists through all power states and resets. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-set-telemetry-profile.txt b/Documentation/nvme-ocp-set-telemetry-profile.txt index bc244cf903..69b4900a72 100644 --- a/Documentation/nvme-ocp-set-telemetry-profile.txt +++ b/Documentation/nvme-ocp-set-telemetry-profile.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme ocp set-telemetry-profile' [--telemetry-profile-select= | -t ] + [] DESCRIPTION ----------- @@ -30,6 +31,8 @@ OPTIONS Telemetry Profile Select. The device shall collect debug data per the specified profile number. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue a set-telemetry-profile command to use profile five. diff --git a/Documentation/nvme-ocp-smart-add-log.txt b/Documentation/nvme-ocp-smart-add-log.txt index a5614d242c..b9c8d784ec 100644 --- a/Documentation/nvme-ocp-smart-add-log.txt +++ b/Documentation/nvme-ocp-smart-add-log.txt @@ -9,8 +9,8 @@ compliant device SYNOPSIS -------- [verse] -'nvme ocp smart-add-log' [--output-format= | -o ] - [--output-format-version=] +'nvme ocp smart-add-log' + [] DESCRIPTION ----------- @@ -27,15 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. - ---output-format-version=:: - Set the field labels in the reporting format to either '1' - (the original) or '2'. The default is 2 to generate field names - for the outputs that are easier to process via scripts. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-tcg-configuration-log.txt b/Documentation/nvme-ocp-tcg-configuration-log.txt index 41312ea460..682fd357b4 100644 --- a/Documentation/nvme-ocp-tcg-configuration-log.txt +++ b/Documentation/nvme-ocp-tcg-configuration-log.txt @@ -9,7 +9,8 @@ compliant device SYNOPSIS -------- [verse] -'nvme ocp tcg-configuration-log' [--output-format= | -o ] +'nvme ocp tcg-configuration-log' + [] DESCRIPTION ----------- @@ -26,10 +27,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-telemetry-string-log.txt b/Documentation/nvme-ocp-telemetry-string-log.txt index 1b12bf4918..4ee66c442f 100644 --- a/Documentation/nvme-ocp-telemetry-string-log.txt +++ b/Documentation/nvme-ocp-telemetry-string-log.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'nvme ocp telemetry-string-log' - [--output-format= | -o ] [--output-file= | -f ] + [] DESCRIPTION ----------- @@ -26,14 +26,11 @@ On success it returns 0, error code otherwise. 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. -f :: --output-file=:: Filepath name to where binary output data will be saved to. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-ocp-unsupported-reqs-log.txt b/Documentation/nvme-ocp-unsupported-reqs-log.txt index 3eecf60017..530b0be30f 100644 --- a/Documentation/nvme-ocp-unsupported-reqs-log.txt +++ b/Documentation/nvme-ocp-unsupported-reqs-log.txt @@ -8,7 +8,8 @@ nvme-ocp-unsupported-reqs-log - Retrieves unsupported requirements log page of g SYNOPSIS -------- [verse] -'nvme ocp unsupported-reqs-log' [--output-format= | -o ] +'nvme ocp unsupported-reqs-log' + [] DESCRIPTION ----------- @@ -26,10 +27,7 @@ On success it returns 0, error code otherwise. 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-persistent-event-log.txt b/Documentation/nvme-persistent-event-log.txt index cf1cbad1b2..5145a37375 100644 --- a/Documentation/nvme-persistent-event-log.txt +++ b/Documentation/nvme-persistent-event-log.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme persistent-event-log' [--action= | -a ] [--log-len= | -l ] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -48,14 +48,7 @@ OPTIONS --raw-binary:: 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-phy-rx-eom-log.txt b/Documentation/nvme-phy-rx-eom-log.txt index 8a311313a3..8b8e95e763 100644 --- a/Documentation/nvme-phy-rx-eom-log.txt +++ b/Documentation/nvme-phy-rx-eom-log.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'nvme phy-rx-eom-log' [--lsp= | -s ] [--controller= | -c ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -35,19 +35,7 @@ OPTIONS Controller ID of the controller associated with 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-pred-lat-event-agg-log.txt b/Documentation/nvme-pred-lat-event-agg-log.txt index 6fb8accbee..0be9225f64 100644 --- a/Documentation/nvme-pred-lat-event-agg-log.txt +++ b/Documentation/nvme-pred-lat-event-agg-log.txt @@ -12,7 +12,7 @@ SYNOPSIS 'nvme pred-lat-event-agg-log' [--log-entries= | -e ] [--rae | -r] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -46,10 +46,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-predictable-lat-log.txt b/Documentation/nvme-predictable-lat-log.txt index f0b2ad3500..1f1ea4512a 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -39,14 +39,7 @@ OPTIONS --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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-primary-ctrl-caps.txt b/Documentation/nvme-primary-ctrl-caps.txt index 0300383e39..3ae63ebee8 100644 --- a/Documentation/nvme-primary-ctrl-caps.txt +++ b/Documentation/nvme-primary-ctrl-caps.txt @@ -8,7 +8,9 @@ nvme-primary-ctrl-caps - Send identify Primary Controller Caps, return result an SYNOPSIS -------- [verse] -'nvme primary-ctrl-caps' [--output-format= | -o ] [--verbose | -v] +'nvme primary-ctrl-caps' + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -26,17 +28,10 @@ OPTIONS ------- -H:: --human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-pull-model-ddr-req-log.txt b/Documentation/nvme-pull-model-ddr-req-log.txt index d9d7af6c26..66498331be 100644 --- a/Documentation/nvme-pull-model-ddr-req-log.txt +++ b/Documentation/nvme-pull-model-ddr-req-log.txt @@ -8,8 +8,8 @@ nvme-pull-model-ddr-req-log - Retrieve Pull Model DDC Request Log, show it SYNOPSIS -------- [verse] -'nvme pull-model-ddr-req-log' [--rae | -r] [--verbose | -v] - [--output-format= | -o ] [--timeout=] +'nvme pull-model-ddr-req-log' [--rae | -r] + [] DESCRIPTION ----------- @@ -25,17 +25,7 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-reachability-associations-log.txt b/Documentation/nvme-reachability-associations-log.txt index 0c83a7685c..66626078c8 100644 --- a/Documentation/nvme-reachability-associations-log.txt +++ b/Documentation/nvme-reachability-associations-log.txt @@ -9,8 +9,7 @@ SYNOPSIS -------- [verse] 'nvme reachability-associations-log' [--associations-only | -a] [--rae | -r] - [--verbose | -v] [--output-format= | -o ] - [--timeout=] + [] DESCRIPTION ----------- @@ -30,17 +29,7 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-reachability-groups-log.txt b/Documentation/nvme-reachability-groups-log.txt index 5d43762a3f..3403441e76 100644 --- a/Documentation/nvme-reachability-groups-log.txt +++ b/Documentation/nvme-reachability-groups-log.txt @@ -9,8 +9,7 @@ SYNOPSIS -------- [verse] 'nvme reachability-groups-log' [--groups-only | -g] [--rae | -r] - [--verbose | -v] [--output-format= | -o ] - [--timeout=] + [] DESCRIPTION ----------- @@ -30,17 +29,7 @@ OPTIONS --rae:: Retain an Asynchronous Event. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index f8f59ae12d..bb1c78f50c 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -25,8 +25,7 @@ SYNOPSIS [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag | -g ] [--storage-tag-check | -C] [--force] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -148,17 +147,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-reset.txt b/Documentation/nvme-reset.txt index 20fcbb1072..785cdc842f 100644 --- a/Documentation/nvme-reset.txt +++ b/Documentation/nvme-reset.txt @@ -8,7 +8,8 @@ nvme-reset - Reset the nvme controller. SYNOPSIS -------- [verse] -'nvme reset' [--output-format= | -o ] [--verbose | -v] +'nvme reset' + [] DESCRIPTION ----------- @@ -17,14 +18,8 @@ be an NVMe character device (ex: /dev/nvme0). 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-resv-acquire.txt b/Documentation/nvme-resv-acquire.txt index 63af1959f4..87f9e517a9 100644 --- a/Documentation/nvme-resv-acquire.txt +++ b/Documentation/nvme-resv-acquire.txt @@ -13,8 +13,7 @@ SYNOPSIS [--prkey= | -p ] [--rtype= | -t ] [--racqa= | -a ] [--iekey | -i] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -84,17 +83,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-resv-notif-log.txt b/Documentation/nvme-resv-notif-log.txt index f8d828bc7b..041c54dcf7 100644 --- a/Documentation/nvme-resv-notif-log.txt +++ b/Documentation/nvme-resv-notif-log.txt @@ -9,7 +9,8 @@ return result and log SYNOPSIS -------- [verse] -'nvme resv-notif-log' [--output-format= | -o ] [--verbose | -v] +'nvme resv-notif-log' + [] DESCRIPTION ----------- @@ -26,14 +27,8 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-resv-register.txt b/Documentation/nvme-resv-register.txt index b6881f749e..ff0c5e60a6 100644 --- a/Documentation/nvme-resv-register.txt +++ b/Documentation/nvme-resv-register.txt @@ -13,8 +13,7 @@ SYNOPSIS [--nrkey= | -k ] [--rrega= | -r ] [--cptpl= | -p ] [--iekey | -i] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -85,17 +84,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt index 2d859a3023..8b51da9417 100644 --- a/Documentation/nvme-resv-release.txt +++ b/Documentation/nvme-resv-release.txt @@ -12,8 +12,7 @@ SYNOPSIS [--crkey= | -c ] [--rtype= | -t ] [--rrela= | -a ] [--iekey | -i] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -76,17 +75,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-resv-report.txt b/Documentation/nvme-resv-report.txt index 4967145771..76e3b65edd 100644 --- a/Documentation/nvme-resv-report.txt +++ b/Documentation/nvme-resv-report.txt @@ -11,8 +11,7 @@ SYNOPSIS 'nvme resv-report' [--namespace-id= | -n ] [--numd= | -d ] [--eds | -e] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -48,17 +47,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-rotational-media-info-log.txt b/Documentation/nvme-rotational-media-info-log.txt index b5f1b12fa0..2a89e05463 100644 --- a/Documentation/nvme-rotational-media-info-log.txt +++ b/Documentation/nvme-rotational-media-info-log.txt @@ -9,8 +9,7 @@ SYNOPSIS -------- [verse] 'nvme rotational-media-info-log' [--endg-id= | -e ] - [--verbose | -v] [--output-format= | -o ] - [--timeout=] + [] DESCRIPTION ----------- @@ -26,17 +25,7 @@ OPTIONS --endg-id=:: This field specifies the identifier of the endurance group. --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-rpmb.txt b/Documentation/nvme-rpmb.txt index 9dc954db91..2fee716d7a 100644 --- a/Documentation/nvme-rpmb.txt +++ b/Documentation/nvme-rpmb.txt @@ -15,7 +15,7 @@ SYNOPSIS [--address= | -o ] [--blocks=<512 byte sectors> | -b ] [--target= | -t ] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -105,14 +105,7 @@ 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sanitize-log.txt b/Documentation/nvme-sanitize-log.txt index af45e9fc68..08fb1dd945 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] [--human-readable | -H] +'nvme sanitize-log' [--rae | -r] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -58,24 +58,12 @@ OPTIONS --rae:: Retain an Asynchronous Event. --H:: ---human-readable:: - This option will parse and format many of the bit fields - into human-readable formats. - -b:: --raw-binary:: 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sanitize.txt b/Documentation/nvme-sanitize.txt index 182213b5f4..851ebdcf02 100644 --- a/Documentation/nvme-sanitize.txt +++ b/Documentation/nvme-sanitize.txt @@ -13,7 +13,8 @@ SYNOPSIS [--ause | -u] [--sanact= | -a ] [--ovrpat= | -p ] [--emvs | -e] [--force] - [--output-format= | -o ] [--verbose | -v] + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -97,14 +98,12 @@ OPTIONS 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. +-H:: +--human-readable:: + Display values in a human-readable format where possible. + (deprecated, use --verbose) --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-seagate-clear-fw-activate-history.txt b/Documentation/nvme-seagate-clear-fw-activate-history.txt index 01f018b76e..f33b4b717f 100644 --- a/Documentation/nvme-seagate-clear-fw-activate-history.txt +++ b/Documentation/nvme-seagate-clear-fw-activate-history.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate clear-fw-activate-history [OPTIONS]' + [] DESCRIPTION ----------- @@ -24,6 +25,8 @@ OPTIONS --save:: specifies that the controller shall save the attribute. +include::global-options.txt[] + EXAMPLES -------- Clear the FW Activation History for the given Seagate device. diff --git a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt index 1239f83f94..95e749c5fc 100644 --- a/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-seagate-clear-pcie-correctable-errors.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate clear-pcie-correctable-errors [] [OPTIONS]' + [] DESCRIPTION ----------- @@ -25,6 +26,8 @@ OPTIONS --save:: Specifies that the controller shall save the attribute +include::global-options.txt[] + EXAMPLES -------- Clears the PCIe error statistics from the device. diff --git a/Documentation/nvme-seagate-cloud-SSD-plugin-version.txt b/Documentation/nvme-seagate-cloud-SSD-plugin-version.txt index f9a92af90a..57258d0dcc 100644 --- a/Documentation/nvme-seagate-cloud-SSD-plugin-version.txt +++ b/Documentation/nvme-seagate-cloud-SSD-plugin-version.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate cloud-SSD-plugin-version' + [] DESCRIPTION ----------- @@ -18,6 +19,8 @@ OPTIONS ------- No Options +include::global-options.txt[] + EXAMPLES -------- Get the OCP plugin version of the specific nvme device. diff --git a/Documentation/nvme-seagate-get-ctrl-tele.txt b/Documentation/nvme-seagate-get-ctrl-tele.txt index 4bb7362eb9..bd52119359 100644 --- a/Documentation/nvme-seagate-get-ctrl-tele.txt +++ b/Documentation/nvme-seagate-get-ctrl-tele.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate get-ctrl-tele [OPTIONS]' + [] DESCRIPTION ----------- @@ -29,6 +30,8 @@ OPTIONS --raw-binary:: Output in raw format +include::global-options.txt[] + EXAMPLES -------- Get the controller initiated telemetry log in hexdump or binary format for the specified device. diff --git a/Documentation/nvme-seagate-get-host-tele.txt b/Documentation/nvme-seagate-get-host-tele.txt index 83cdefc95a..7264283e75 100644 --- a/Documentation/nvme-seagate-get-host-tele.txt +++ b/Documentation/nvme-seagate-get-host-tele.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate get-host-tele [OPTIONS]' + [] DESCRIPTION ----------- @@ -35,6 +36,8 @@ OPTIONS --raw-binary:: output in raw format +include::global-options.txt[] + EXAMPLES -------- Get the host initiated telemetry log in hexdump or binary format for the specified device. diff --git a/Documentation/nvme-seagate-help.txt b/Documentation/nvme-seagate-help.txt index 0a077a85d9..271b99bce6 100644 --- a/Documentation/nvme-seagate-help.txt +++ b/Documentation/nvme-seagate-help.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate help' + [] DESCRIPTION ----------- @@ -18,6 +19,8 @@ OPTIONS ------- No Options +include::global-options.txt[] + EXAMPLES -------- Get help information for specific seagate sub-commands. diff --git a/Documentation/nvme-seagate-plugin-version.txt b/Documentation/nvme-seagate-plugin-version.txt index 5e4a759e1e..c21af6fa93 100644 --- a/Documentation/nvme-seagate-plugin-version.txt +++ b/Documentation/nvme-seagate-plugin-version.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate plugin-version' + [] DESCRIPTION ----------- @@ -18,6 +19,8 @@ OPTIONS ------- No Options +include::global-options.txt[] + EXAMPLES -------- Get the plugin version of the specific nvme device. diff --git a/Documentation/nvme-seagate-version.txt b/Documentation/nvme-seagate-version.txt index 2d5c7cefcf..56bb52bf16 100644 --- a/Documentation/nvme-seagate-version.txt +++ b/Documentation/nvme-seagate-version.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme seagate version' + [] DESCRIPTION ----------- @@ -18,6 +19,8 @@ OPTIONS ------- No Options +include::global-options.txt[] + EXAMPLES -------- Get the Seagate version information for nvme-cli. diff --git a/Documentation/nvme-seagate-vs-fw-activate-history.txt b/Documentation/nvme-seagate-vs-fw-activate-history.txt index 8df58b4623..7cab3c734c 100644 --- a/Documentation/nvme-seagate-vs-fw-activate-history.txt +++ b/Documentation/nvme-seagate-vs-fw-activate-history.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-fw-activate-history [OPTIONS]' + [] DESCRIPTION ----------- @@ -29,6 +30,8 @@ OPTIONS --dump-file=:: Dump file +include::global-options.txt[] + EXAMPLES -------- Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device. diff --git a/Documentation/nvme-seagate-vs-internal-log.txt b/Documentation/nvme-seagate-vs-internal-log.txt index 4a895bcb7d..1800faa152 100644 --- a/Documentation/nvme-seagate-vs-internal-log.txt +++ b/Documentation/nvme-seagate-vs-internal-log.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-internal-log [OPTIONS]' + [] DESCRIPTION ----------- @@ -29,6 +30,8 @@ OPTIONS --dump-file=:: Dump file +include::global-options.txt[] + EXAMPLES -------- Get the Seagate vendor specific Controller-Initiated telemetry log for the diff --git a/Documentation/nvme-seagate-vs-log-page-sup.txt b/Documentation/nvme-seagate-vs-log-page-sup.txt index 55c65fd13e..e1d4b4e9ea 100644 --- a/Documentation/nvme-seagate-vs-log-page-sup.txt +++ b/Documentation/nvme-seagate-vs-log-page-sup.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-log-page-sup [OPTIONS]' + [] DESCRIPTION ----------- @@ -21,9 +22,8 @@ NVMe block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-pcie-stats.txt b/Documentation/nvme-seagate-vs-pcie-stats.txt index 86f87a3d7a..450b287625 100644 --- a/Documentation/nvme-seagate-vs-pcie-stats.txt +++ b/Documentation/nvme-seagate-vs-pcie-stats.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-pcie-stats [OPTIONS]' + [] DESCRIPTION ----------- @@ -21,9 +22,8 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-seagate-vs-smart-add-log.txt b/Documentation/nvme-seagate-vs-smart-add-log.txt index 836220a61e..2504a20ef3 100644 --- a/Documentation/nvme-seagate-vs-smart-add-log.txt +++ b/Documentation/nvme-seagate-vs-smart-add-log.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-smart-add-log [OPTIONS]' + [] DESCRIPTION ----------- @@ -42,6 +43,8 @@ OPTIONS --output-file=:: Output in binary format. Defaults to text-formatted dump to stdout +include::global-options.txt[] + EXAMPLES -------- Get the vendor specific extended SMART information for the specified device. diff --git a/Documentation/nvme-seagate-vs-temperature-stats.txt b/Documentation/nvme-seagate-vs-temperature-stats.txt index 58a9f116d6..2f803c637f 100644 --- a/Documentation/nvme-seagate-vs-temperature-stats.txt +++ b/Documentation/nvme-seagate-vs-temperature-stats.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme seagate vs-temperature-stats [OPTIONS]' + [] DESCRIPTION ----------- @@ -21,9 +22,8 @@ nvme block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: ---output-format=:: - Output in binary format + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-security-recv.txt b/Documentation/nvme-security-recv.txt index 3977a140f7..7f6afbbea2 100644 --- a/Documentation/nvme-security-recv.txt +++ b/Documentation/nvme-security-recv.txt @@ -14,8 +14,7 @@ SYNOPSIS [--nssf= | -N ] [--al= | -t ] [--namespace-id= | -n ] [--raw-binary | -b] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -72,17 +71,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-security-send.txt b/Documentation/nvme-security-send.txt index 5893e15a24..0feb5d3d5b 100644 --- a/Documentation/nvme-security-send.txt +++ b/Documentation/nvme-security-send.txt @@ -14,8 +14,7 @@ SYNOPSIS [--tl= | -t ] [--nssf= | -N ] [--namespace-id= | -n ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -65,17 +64,7 @@ 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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sed-discover.txt b/Documentation/nvme-sed-discover.txt index b6e99b2aae..cbd115ba68 100644 --- a/Documentation/nvme-sed-discover.txt +++ b/Documentation/nvme-sed-discover.txt @@ -8,7 +8,8 @@ nvme-sed-discover - Discover SED Opal Locking Features SYNOPSIS -------- [verse] -'nvme sed discover' [--verbose | -v] [--udev | -u] +'nvme sed discover' [--udev | -u] + [] DESCRIPTION ----------- @@ -16,14 +17,12 @@ Query the NVMe device given to determine its SED Opal capabilities. OPTIONS ------- --v:: ---verbose:: - Print extended feature discovery information. - -u:: --udev:: Print locking information in form suitable for udev rules. +include::global-options.txt[] + EXAMPLES -------- nvme sed discover /dev/nvme5n1 diff --git a/Documentation/nvme-sed-initialize.txt b/Documentation/nvme-sed-initialize.txt index 4e3db8a341..9a17ac6ffa 100644 --- a/Documentation/nvme-sed-initialize.txt +++ b/Documentation/nvme-sed-initialize.txt @@ -8,7 +8,8 @@ nvme-sed-initialize - Initialize a SED Opal Device for locking SYNOPSIS -------- [verse] -'nvme sed initialize' [ --read-only, -r ] +'nvme sed initialize' [ --read-only, -r ] + [] DESCRIPTION ----------- @@ -20,6 +21,8 @@ OPTIONS --read-only:: Set locking range to read-only. +include::global-options.txt[] + EXAMPLES -------- nvme sed initialize /dev/nvme5n1 diff --git a/Documentation/nvme-sed-lock.txt b/Documentation/nvme-sed-lock.txt index 02699afc8d..beebaab728 100644 --- a/Documentation/nvme-sed-lock.txt +++ b/Documentation/nvme-sed-lock.txt @@ -8,7 +8,8 @@ nvme-sed-lock - Lock a SED Opal Device SYNOPSIS -------- [verse] -'nvme sed lock' [--read-only | -r] [--ask-key | -k] +'nvme sed lock' [--read-only | -r] [--ask-key | -k] + [] DESCRIPTION ----------- @@ -24,6 +25,7 @@ OPTIONS --ask-key:: Prompt for SED authentication key. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sed-password.txt b/Documentation/nvme-sed-password.txt index 722ff1b791..d40727f137 100644 --- a/Documentation/nvme-sed-password.txt +++ b/Documentation/nvme-sed-password.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sed password' + [] DESCRIPTION ----------- @@ -17,6 +18,8 @@ Change the locking password of a SED device. OPTIONS ------- +include::global-options.txt[] + EXAMPLES -------- nvme sed password /dev/nvme5n1 diff --git a/Documentation/nvme-sed-revert.txt b/Documentation/nvme-sed-revert.txt index 7ea019baea..93ebb123e6 100644 --- a/Documentation/nvme-sed-revert.txt +++ b/Documentation/nvme-sed-revert.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sed revert' [ --destructive, -e ] [ --psid, -p ] + [] DESCRIPTION ----------- @@ -24,6 +25,7 @@ OPTIONS --psid:: Destructively revert drive using its PSID. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sed-unlock.txt b/Documentation/nvme-sed-unlock.txt index aaa63d1ddc..dd1f5eb70b 100644 --- a/Documentation/nvme-sed-unlock.txt +++ b/Documentation/nvme-sed-unlock.txt @@ -8,7 +8,8 @@ nvme-sed-unlock - Unlock a SED Opal Device SYNOPSIS -------- [verse] -'nvme sed unlock' [--read-only | -r] [--ask-key | -k] +'nvme sed unlock' [--read-only | -r] [--ask-key | -k] + [] DESCRIPTION ----------- @@ -24,6 +25,7 @@ OPTIONS --ask-key:: Prompt for SED authentication key. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-self-test-log.txt b/Documentation/nvme-self-test-log.txt index d4600e8ae4..6a61aeb572 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -35,14 +35,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-set-feature.txt b/Documentation/nvme-set-feature.txt index 0c7f258e4a..a4ea4c26f7 100644 --- a/Documentation/nvme-set-feature.txt +++ b/Documentation/nvme-set-feature.txt @@ -13,9 +13,8 @@ SYNOPSIS [--uuid-index= | -U ] [--data-len= | -l ] [--data= | -d ] [--save | -s] - [--output-format= | -o ] [--verbose | -v] [--cdw12= | -c ] - [--timeout=] + [] DESCRIPTION ----------- @@ -115,21 +114,11 @@ 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. - -c :: --cdw12=:: The value for command dword 12, if applicable. ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt index ba6e9207f2..2d5fd59f8a 100644 --- a/Documentation/nvme-set-property.txt +++ b/Documentation/nvme-set-property.txt @@ -11,8 +11,7 @@ SYNOPSIS [verse] 'nvme set-property' [--offset= | -O ] [--value= | -V ] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -28,17 +27,7 @@ OPTIONS --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-set-reg.txt b/Documentation/nvme-set-reg.txt index d3134f9b89..0f2c4aeabe 100644 --- a/Documentation/nvme-set-reg.txt +++ b/Documentation/nvme-set-reg.txt @@ -15,8 +15,7 @@ SYNOPSIS [--asq=] [--acq=] [--bprsel=] [--bpmbl=] [--cmbmsc=] [--nssd=] [--pmrctl=] [--pmrmscl=] [--pmrmscu=] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] + [] DESCRIPTION ----------- @@ -84,17 +83,7 @@ OPTIONS --pmrmscu=:: PMRMSCU=0xe18 register offset --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-show-hostnqn.txt b/Documentation/nvme-show-hostnqn.txt index 5074e2c8e9..7aeb87beb0 100644 --- a/Documentation/nvme-show-hostnqn.txt +++ b/Documentation/nvme-show-hostnqn.txt @@ -8,7 +8,8 @@ nvme-show-hostnqn - Show the host NQN configured for the system SYNOPSIS -------- [verse] -'nvme show-hostnqn' [--output-format= | -o ] [--verbose | -v] +'nvme show-hostnqn' + [] DESCRIPTION ----------- @@ -18,14 +19,8 @@ this will show the systemd-generated host NQN for the system. 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-show-regs.txt b/Documentation/nvme-show-regs.txt index 0cda34a147..64e6a8b58c 100644 --- a/Documentation/nvme-show-regs.txt +++ b/Documentation/nvme-show-regs.txt @@ -9,9 +9,9 @@ NVMe over PCIe or the controller properties for NVMe over Fabrics. SYNOPSIS -------- [verse] -'nvme show-regs' [--human-readable | -H] - [--output-format= | -o ] [--verbose | -v] - [--timeout=] +'nvme show-regs' + [--human-readable | -H] + [] DESCRIPTION ----------- @@ -31,19 +31,10 @@ OPTIONS ------- -H:: --human-readable:: - Display registers or supported properties in human readable format. + Display values in a human-readable format where possible. + (deprecated, use --verbose) --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. - ---timeout=:: - Override default timeout value. In milliseconds. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-show-topology.txt b/Documentation/nvme-show-topology.txt index 32ffad1e75..319a95d75d 100644 --- a/Documentation/nvme-show-topology.txt +++ b/Documentation/nvme-show-topology.txt @@ -8,7 +8,8 @@ nvme-show-topology - Show topology of all NVMe subsystems SYNOPSIS -------- [verse] -'nvme show-topology' [--output-format= | -o ] [--verbose | -v] +'nvme show-topology' + [] DESCRIPTION ----------- @@ -16,31 +17,13 @@ Show the topology of all NVMe subsystems. OPTIONS ------- --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 in the output, showing nvme subsystems, - controllers and namespaces separately and how they're related to each - other. - -r :: --ranking=:: Set the ranking orer to 'namespace' (default) or 'ctrl'. This option 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. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-smart-log.txt b/Documentation/nvme-smart-log.txt index c08f523cb2..7cc8ce241a 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 ] [--verbose | -v] + [] DESCRIPTION ----------- @@ -38,14 +38,7 @@ 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. - --v:: ---verbose:: - Increase the information detail in the output. +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-capabilities.txt b/Documentation/nvme-sndk-capabilities.txt index 00fc2adabc..27fceb6f3c 100644 --- a/Documentation/nvme-sndk-capabilities.txt +++ b/Documentation/nvme-sndk-capabilities.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk capabilities' + [] DESCRIPTION ----------- @@ -19,6 +20,10 @@ The parameter is mandatory NVMe character device (ex: /dev/nvme0). On success it returns 0, error code otherwise. +OPTIONS +------- +include::global-options.txt[] + EXAMPLES -------- * Displays the capabilities for the device: diff --git a/Documentation/nvme-sndk-clear-assert-dump.txt b/Documentation/nvme-sndk-clear-assert-dump.txt index 9a6d4d06ae..03928ad3f6 100644 --- a/Documentation/nvme-sndk-clear-assert-dump.txt +++ b/Documentation/nvme-sndk-clear-assert-dump.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk clear-assert-dump' + [] DESCRIPTION ----------- @@ -25,6 +26,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Clears the assert dump (if present): diff --git a/Documentation/nvme-sndk-clear-fw-activate-history.txt b/Documentation/nvme-sndk-clear-fw-activate-history.txt index 7a447d9fe9..27a71b8f78 100644 --- a/Documentation/nvme-sndk-clear-fw-activate-history.txt +++ b/Documentation/nvme-sndk-clear-fw-activate-history.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk clear-fw-activate-history' + [] DESCRIPTION ----------- @@ -24,6 +25,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Clears the firmware activate history table: diff --git a/Documentation/nvme-sndk-clear-pcie-correctable-errors.txt b/Documentation/nvme-sndk-clear-pcie-correctable-errors.txt index 281848574e..33742d32bf 100644 --- a/Documentation/nvme-sndk-clear-pcie-correctable-errors.txt +++ b/Documentation/nvme-sndk-clear-pcie-correctable-errors.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk clear-pcie-correctable-errors' + [] DESCRIPTION ----------- @@ -26,6 +27,8 @@ OPTIONS ------- None +include::global-options.txt[] + EXAMPLES -------- * Clears the PCIe Correctable Error Count field returned in the smart-log-add command: diff --git a/Documentation/nvme-sndk-cloud-SSD-plugin-version.txt b/Documentation/nvme-sndk-cloud-SSD-plugin-version.txt index 380d7bc1db..1847918740 100644 --- a/Documentation/nvme-sndk-cloud-SSD-plugin-version.txt +++ b/Documentation/nvme-sndk-cloud-SSD-plugin-version.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk cloud-SSD-plugin-version' + [] DESCRIPTION ----------- @@ -20,6 +21,10 @@ The parameter is mandatory NVMe character device (ex: /dev/nvme0). On success it returns 0, error code otherwise. +OPTIONS +------- +include::global-options.txt[] + EXAMPLES -------- * Displays the cloud ssd plugin version for the device: diff --git a/Documentation/nvme-sndk-cloud-boot-SSD-version.txt b/Documentation/nvme-sndk-cloud-boot-SSD-version.txt index 8859735823..b1e443b8f3 100644 --- a/Documentation/nvme-sndk-cloud-boot-SSD-version.txt +++ b/Documentation/nvme-sndk-cloud-boot-SSD-version.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk cloud-boot-SSD-version' + [] DESCRIPTION ----------- @@ -20,6 +21,10 @@ The parameter is mandatory NVMe character device (ex: /dev/nvme0). On success it returns 0, error code otherwise. +OPTIONS +------- +include::global-options.txt[] + EXAMPLES -------- * Displays the cloud boot ssd version for the device: diff --git a/Documentation/nvme-sndk-cu-smart-log.txt b/Documentation/nvme-sndk-cu-smart-log.txt index 74c4bf44ea..6b26e70510 100644 --- a/Documentation/nvme-sndk-cu-smart-log.txt +++ b/Documentation/nvme-sndk-cu-smart-log.txt @@ -8,8 +8,9 @@ nvme-sndk-cu-smart-log - Send NVMe Sandisk cu-smart-log Vendor Unique Command, r SYNOPSIS -------- [verse] -'nvme sndk cu-smart-log' [--output-format= -o ] +'nvme sndk cu-smart-log' [--uuid-index= | -u ] + [] DESCRIPTION ----------- @@ -25,17 +26,13 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. - -u :: --uuid-index=:: Sets the uuid-index of the log page to be retrieved. Defaults to 0 if not given. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue Sandisk cu-smart-log plugin Command : diff --git a/Documentation/nvme-sndk-drive-resize.txt b/Documentation/nvme-sndk-drive-resize.txt index 1485338017..fec17f3390 100644 --- a/Documentation/nvme-sndk-drive-resize.txt +++ b/Documentation/nvme-sndk-drive-resize.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme sndk drive-resize' [--size= | -s ] + [] DESCRIPTION ----------- @@ -29,6 +30,8 @@ OPTIONS --size=:: The new size (in GB) to resize the drive to. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue sndk Resize Vendor Unique Command : diff --git a/Documentation/nvme-sndk-get-dev-capabilities-log.txt b/Documentation/nvme-sndk-get-dev-capabilities-log.txt index c0a8cdd60d..7e7e7dd670 100644 --- a/Documentation/nvme-sndk-get-dev-capabilities-log.txt +++ b/Documentation/nvme-sndk-get-dev-capabilities-log.txt @@ -9,7 +9,8 @@ plugin command, return parsed log output SYNOPSIS -------- [verse] -'nvme sndk get-dev-capabilities-log' [--output-format= | -o ] +'nvme sndk get-dev-capabilities-log' + [] DESCRIPTION ----------- @@ -28,11 +29,8 @@ code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-get-drive-status.txt b/Documentation/nvme-sndk-get-drive-status.txt index b6dee8055d..667ce8a12e 100644 --- a/Documentation/nvme-sndk-get-drive-status.txt +++ b/Documentation/nvme-sndk-get-drive-status.txt @@ -10,6 +10,7 @@ SYNOPSIS -------- [verse] 'nvme sndk get-drive-status' + [] DESCRIPTION ----------- @@ -47,6 +48,10 @@ Output Explanation |=== +OPTIONS +------- +include::global-options.txt[] + EXAMPLES -------- * Has the program issue sndk get-drive-status command : diff --git a/Documentation/nvme-sndk-get-error-recovery-log.txt b/Documentation/nvme-sndk-get-error-recovery-log.txt index 7e027d364d..07f9b278a8 100644 --- a/Documentation/nvme-sndk-get-error-recovery-log.txt +++ b/Documentation/nvme-sndk-get-error-recovery-log.txt @@ -11,6 +11,7 @@ SYNOPSIS [verse] 'nvme sndk get-error-recovery-log' [--output-format= -o ] + [] DESCRIPTION ----------- @@ -29,11 +30,8 @@ code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-get-latency-monitor-log.txt b/Documentation/nvme-sndk-get-latency-monitor-log.txt index f9333cc3fc..c79cfc0e42 100644 --- a/Documentation/nvme-sndk-get-latency-monitor-log.txt +++ b/Documentation/nvme-sndk-get-latency-monitor-log.txt @@ -8,7 +8,8 @@ nvme-sndk-get-latency-monitor-log - Display latency monitor log page data in hum SYNOPSIS -------- [verse] -'nvme sndk get-latency-monitor-log' [--output-format= -o ] +'nvme sndk get-latency-monitor-log' + [] DESCRIPTION ----------- @@ -24,10 +25,8 @@ On success it returns 0, error code otherwise. OPTIONS ------- --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. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-get-unsupported-reqs-log.txt b/Documentation/nvme-sndk-get-unsupported-reqs-log.txt index b3ec3447ed..16a913b402 100644 --- a/Documentation/nvme-sndk-get-unsupported-reqs-log.txt +++ b/Documentation/nvme-sndk-get-unsupported-reqs-log.txt @@ -11,6 +11,7 @@ SYNOPSIS [verse] 'nvme sndk get-unsupported-reqs-log' [--output-format= -o ] + [] DESCRIPTION ----------- @@ -29,11 +30,8 @@ code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-log-page-directory.txt b/Documentation/nvme-sndk-log-page-directory.txt index 52db8fa1b3..082e997021 100644 --- a/Documentation/nvme-sndk-log-page-directory.txt +++ b/Documentation/nvme-sndk-log-page-directory.txt @@ -8,7 +8,8 @@ nvme-sndk-log-page-directory - Retrieves the list of Log IDs supported by the dr SYNOPSIS -------- [verse] -'nvme sndk log-page-directory' [--output-format= -o ] +'nvme sndk log-page-directory' + [] DESCRIPTION ----------- @@ -25,10 +26,8 @@ On success it returns the log page directory information, error code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', 'json', or 'binary'. Only one output format - can be used at a time. The default is normal. + +include::global-options.txt[] EXAMPLES -------- diff --git a/Documentation/nvme-sndk-namespace-resize.txt b/Documentation/nvme-sndk-namespace-resize.txt index b632b19fc2..3eab9ec69a 100644 --- a/Documentation/nvme-sndk-namespace-resize.txt +++ b/Documentation/nvme-sndk-namespace-resize.txt @@ -10,6 +10,7 @@ SYNOPSIS [verse] 'nvme sndk namespace-resize' [--nsid=, -n ] [--op_option=, -o ] + [] DESCRIPTION ----------- @@ -38,6 +39,8 @@ OPTIONS 0xF - 0% of Original TNVMCAP reported value (original config) All other values - reserved +include::global-options.txt[] + EXAMPLES -------- * Resizes namespace 1 to 50% of the original TNVMCAP reported value: diff --git a/Documentation/nvme-sndk-set-latency-monitor-feature.txt b/Documentation/nvme-sndk-set-latency-monitor-feature.txt index 142af08483..71808386de 100644 --- a/Documentation/nvme-sndk-set-latency-monitor-feature.txt +++ b/Documentation/nvme-sndk-set-latency-monitor-feature.txt @@ -19,6 +19,7 @@ SYNOPSIS [--debug_log_trigger_enable= | -r ] [--discard_debug_log= | -l ] [--latency_monitor_feature_enable= | -e ] + [] DESCRIPTION ----------- @@ -86,6 +87,8 @@ OPTIONS Feature is enabled. When cleared to 00h the Latency Monitor Feature is disabled. +include::global-options.txt[] + EXAMPLES -------- * Set NVMe sndk latency monitor feature options enabled with default value values: diff --git a/Documentation/nvme-sndk-vs-cloud-log.txt b/Documentation/nvme-sndk-vs-cloud-log.txt index 0537f6601a..a7f1a09fab 100644 --- a/Documentation/nvme-sndk-vs-cloud-log.txt +++ b/Documentation/nvme-sndk-vs-cloud-log.txt @@ -8,8 +8,9 @@ nvme-sndk-vs-cloud-log - Send NVMe sndk vs-cloud-log Vendor Unique Command, retu SYNOPSIS -------- [verse] -'nvme sndk vs-cloud-log' [--output-format= -o ] +'nvme sndk vs-cloud-log' [--namespace-id= | -n ] + [] DESCRIPTION ----------- @@ -26,12 +27,6 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. - -n :: --namespace-id=:: Sets the command's nsid value to the given nsid. Defaults to @@ -39,6 +34,8 @@ OPTIONS depending on the log page, which may or may not be specific to a namespace. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue sndk vs-cloud-log Vendor Unique Command : diff --git a/Documentation/nvme-sndk-vs-device-waf.txt b/Documentation/nvme-sndk-vs-device-waf.txt index 06360bab77..929a3560cd 100644 --- a/Documentation/nvme-sndk-vs-device-waf.txt +++ b/Documentation/nvme-sndk-vs-device-waf.txt @@ -9,8 +9,9 @@ prints both TLC and SLC results SYNOPSIS -------- [verse] -'nvme sndk vs-device-waf' [--output-format= -o ] +'nvme sndk vs-device-waf' [--namespace-id= | -n ] + [] DESCRIPTION ----------- @@ -27,12 +28,6 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: ---output-format=:: - Set the reporting format to 'normal', or - 'json'. Only one output format can be used at a time. - Default is normal. - -n :: --namespace-id=:: Sets the command's nsid value to the given nsid. Defaults to @@ -40,6 +35,8 @@ OPTIONS depending on the log page, which may or may not be specific to a namespace. +include::global-options.txt[] + EXAMPLES -------- * Has the program issue sndk vs-device-waf plugin Command : diff --git a/Documentation/nvme-sndk-vs-drive-info.txt b/Documentation/nvme-sndk-vs-drive-info.txt index 64f7876eee..71104b97db 100644 --- a/Documentation/nvme-sndk-vs-drive-info.txt +++ b/Documentation/nvme-sndk-vs-drive-info.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk vs-drive-info' + [] DESCRIPTION ----------- @@ -42,6 +43,10 @@ EXAMPLE -------- # nvme sndk vs-drive-info /dev/nvme0 +OPTIONS +------- +include::global-options.txt[] + NVME ---- Part of the nvme-user suite. diff --git a/Documentation/nvme-sndk-vs-error-reason-identifier.txt b/Documentation/nvme-sndk-vs-error-reason-identifier.txt index e6b50c33da..ac771352d8 100644 --- a/Documentation/nvme-sndk-vs-error-reason-identifier.txt +++ b/Documentation/nvme-sndk-vs-error-reason-identifier.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme sndk vs-error-reason-identifier' [--log-id=, -i ] [--file=, -o ] + [] DESCRIPTION ----------- @@ -38,6 +39,8 @@ OPTIONS the host generated log or "_error_reason_identifier_ctlr__