summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-read.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-read.txt
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-read.txt')
-rw-r--r--Documentation/nvme-read.txt45
1 files changed, 25 insertions, 20 deletions
diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt
index 3ceeba1..cecaa71 100644
--- a/Documentation/nvme-read.txt
+++ b/Documentation/nvme-read.txt
@@ -18,17 +18,13 @@ SYNOPSIS
[--prinfo=<prinfo> | -p <prinfo>]
[--app-tag-mask=<appmask> | -m <appmask>]
[--app-tag=<apptag> | -a <apptag>]
- [--limited-retry | -l]
- [--force-unit-access | -f]
+ [--limited-retry | -l] [--force-unit-access | -f]
[--dir-type=<type> | -T <type>]
- [--dir-spec=<spec> | -S <spec>]
- [--dsm=<dsm> | -D <dsm>]
- [--show-command | -v]
- [--dry-run | -w]
- [--latency | -t]
+ [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>]
+ [--show-command | -V] [--dry-run | -w] [--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
- [--storage-tag-check | -C ]
- [--force]
+ [--storage-tag-check | -C] [--force]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
@@ -38,34 +34,34 @@ by default if you don't provide a file.
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block.
---block-count::
-c::
+--block-count::
The number of blocks to transfer. This is a zeroes based value to
align with the kernel's use of this field. (ie. 0 means transfer
1 block).
---data-size=<size>::
-z <size>::
+--data-size=<size>::
Size of data, in bytes.
---metadata-size=<size>::
-y <size>::
+--metadata-size=<size>::
Size of metadata in bytes.
---data=<data-file>::
-d <data-file>::
+--data=<data-file>::
Data file. If none provided, contents are sent to STDOUT.
---metadata=<metadata-file>::
-M <metadata-file>::
+--metadata=<metadata-file>::
Metadata file, if necessary.
---prinfo=<prinfo>::
-p <prinfo>::
+--prinfo=<prinfo>::
Protection Information field definition.
+
[]
@@ -80,16 +76,16 @@ metadata is passes.
|0|Set to 1 enables checking the reference tag
|=================
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
Optional reftag when used with protection information.
---app-tag-mask=<appmask>::
-m <appmask>::
+--app-tag-mask=<appmask>::
Optional application tag mask when used with protection information.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
-T <type>::
@@ -117,7 +113,7 @@ metadata is passes.
consult the NVMe specification for detailed breakdown of how to
use this field.
--v::
+-V::
--show-cmd::
Print out the command to be sent.
@@ -144,6 +140,15 @@ metadata is passes.
Ignore namespace is currently busy and performed the operation
even though.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.