From: Keith Busch Date: Tue, 15 Nov 2016 23:11:06 +0000 (-0500) Subject: Update documentation X-Git-Tag: v1.0~1 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=3319bf063c2174edaadfe6cb35f77f9744cea92b;p=users%2Fsagi%2Fnvme-cli.git Update documentation Fill in missing options in the IO commands. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index 8a37c2e9..f0474377 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -2,12 +2,12 @@ .\" Title: nvme-read .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 10/21/2016 +.\" Date: 11/15/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "10/21/2016" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "11/15/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -61,6 +61,91 @@ Start block\&. 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 +\-\-block\-count=, \-c +.RS 4 +Number of logical blocks to write\&. +.RE +.PP +\-\-data\-size=, \-z +.RS 4 +Size of data, in bytes\&. +.RE +.PP +\-\-metadata\-size=, \-y +.RS 4 +Size of metadata in bytes\&. +.RE +.PP +\-\-data=, \-d +.RS 4 +Data file\&. If none provided, contents are sent to STDOUT\&. +.RE +.PP +\-\-metadata=, \-M +.RS 4 +Metadata file, if necessary\&. +.RE +.PP +\-\-prinfo=, \-p +.RS 4 +Protection Information field defintion\&. +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Bit +T}:T{ +Description +T} +T{ +3 +T}:T{ +PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&. +T} +T{ +2:0 +T}:T{ +PRCHK: Protection Information Check: +T} +T{ +2 +T}:T{ +Set to 1 enables checking the guard tag +T} +T{ +1 +T}:T{ +Set to 1 enables checking the application tag +T} +T{ +0 +T}:T{ +Set to 1 enables checking the reference tag +T} +.TE +.sp 1 +.RE +.PP +\-\-ref\-tag=, \-r +.RS 4 +Optional reftag when used with protection information\&. +.RE +.PP +\-\-app\-tag\-mask=, \-m +.RS 4 +Optional application tag mask when used with protection information\&. +.RE +.PP +\-\-force\-unit\-access, \-f +.RS 4 +Set the force\-unit access flag\&. +.RE +.PP \-\-latency, \-t .RS 4 Print out the latency the IOCTL took (in us)\&. diff --git a/Documentation/nvme-read.html b/Documentation/nvme-read.html index 7b6f5cdf..2bf0f44e 100644 --- a/Documentation/nvme-read.html +++ b/Documentation/nvme-read.html @@ -3,7 +3,7 @@ - + nvme-read(1)