From 66e4b69042cd3b44acd42f1fad2109180c1bc48b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 24 Dec 2023 08:57:54 +0100 Subject: Merging upstream version 2.7.1. Signed-off-by: Daniel Baumann --- Documentation/nvme-read.1 | 54 ++++++++++++++++++++++++++++------------------- 1 file changed, 32 insertions(+), 22 deletions(-) (limited to 'Documentation/nvme-read.1') diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index 4d9d9f7..338c904 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -2,12 +2,12 @@ .\" Title: nvme-read .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 06/30/2023 +.\" Date: 12/21/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "06/30/2023" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "12/21/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,54 +42,50 @@ nvme-read \- Send an NVMe Read command, provide results [\-\-prinfo= | \-p ] [\-\-app\-tag\-mask= | \-m ] [\-\-app\-tag= | \-a ] - [\-\-limited\-retry | \-l] - [\-\-force\-unit\-access | \-f] + [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-dir\-type= | \-T ] - [\-\-dir\-spec= | \-S ] - [\-\-dsm= | \-D ] - [\-\-show\-command | \-v] - [\-\-dry\-run | \-w] - [\-\-latency | \-t] + [\-\-dir\-spec= | \-S ] [\-\-dsm= | \-D ] + [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t] [\-\-storage\-tag | \-g ] - [\-\-storage\-tag\-check | \-C ] - [\-\-force] + [\-\-storage\-tag\-check | \-C] [\-\-force] + [\-\-output\-format= | \-o ] [\-\-verbose | \-v] .fi .SH "DESCRIPTION" .sp The Read command reads the logical blocks specified by the command from the medium and copies to the data data buffer provided\&. Will use stdout by default if you don\(cqt provide a file\&. .SH "OPTIONS" .PP -\-\-start\-block=, \-s +\-s , \-\-start\-block= .RS 4 Start block\&. .RE .PP -\-\-block\-count, \-c +\-c, \-\-block\-count .RS 4 The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&. .RE .PP -\-\-data\-size=, \-z +\-z , \-\-data\-size= .RS 4 Size of data, in bytes\&. .RE .PP -\-\-metadata\-size=, \-y +\-y , \-\-metadata\-size= .RS 4 Size of metadata in bytes\&. .RE .PP -\-\-data=, \-d +\-d , \-\-data= .RS 4 Data file\&. If none provided, contents are sent to STDOUT\&. .RE .PP -\-\-metadata=, \-M +\-M , \-\-metadata= .RS 4 Metadata file, if necessary\&. .RE .PP -\-\-prinfo=, \-p +\-p , \-\-prinfo= .RS 4 Protection Information field definition\&. .TS @@ -134,17 +130,17 @@ T} .sp 1 .RE .PP -\-\-ref\-tag=, \-r +\-r , \-\-ref\-tag= .RS 4 Optional reftag when used with protection information\&. .RE .PP -\-\-app\-tag\-mask=, \-m +\-m , \-\-app\-tag\-mask= .RS 4 Optional application tag mask when used with protection information\&. .RE .PP -\-\-force\-unit\-access, \-f +\-f, \-\-force\-unit\-access .RS 4 Set the force\-unit access flag\&. .RE @@ -164,7 +160,7 @@ Optional field for directive specifics\&. When used with write streams, this val The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&. .RE .PP -\-v, \-\-show\-cmd +\-V, \-\-show\-cmd .RS 4 Print out the command to be sent\&. .RE @@ -196,6 +192,20 @@ This flag enables Storage Tag field checking as part of end\-to\-end data protec .RS 4 Ignore namespace is currently busy and performed the operation even though\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR +or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. -- cgit v1.2.3