Fill in missing options in the IO commands.
Signed-off-by: Keith Busch <keith.busch@intel.com>
.\" Title: nvme-read
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" 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
.\" -----------------------------------------------------------------
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=<nlb>, \-c <nlb>
+.RS 4
+Number of logical blocks to write\&.
+.RE
+.PP
+\-\-data\-size=<size>, \-z <size>
+.RS 4
+Size of data, in bytes\&.
+.RE
+.PP
+\-\-metadata\-size=<size>, \-y <size>
+.RS 4
+Size of metadata in bytes\&.
+.RE
+.PP
+\-\-data=<data\-file>, \-d <data\-file>
+.RS 4
+Data file\&. If none provided, contents are sent to STDOUT\&.
+.RE
+.PP
+\-\-metadata=<metadata\-file>, \-M <metadata\-file>
+.RS 4
+Metadata file, if necessary\&.
+.RE
+.PP
+\-\-prinfo=<prinfo>, \-p <prinfo>
+.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=<reftag>, \-r <reftag>
+.RS 4
+Optional reftag when used with protection information\&.
+.RE
+.PP
+\-\-app\-tag\-mask=<appmask>, \-m <appmask>
+.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)\&.
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.7" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
<title>nvme-read(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
ul > li { color: #aaa; }\r
ul > li > * { color: black; }\r
\r
-pre {\r
+.monospaced, code, pre {\r
+ font-family: "Courier New", Courier, monospace;\r
+ font-size: inherit;\r
+ color: navy;\r
padding: 0;\r
margin: 0;\r
}\r
\r
+\r
#author {\r
color: #527bbd;\r
font-weight: bold;\r
*\r
* */\r
\r
-tt {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
div.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
*\r
* */\r
\r
-.monospaced {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
table.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
@media print {\r
body.manpage div#toc { display: none; }\r
}\r
+\r
+\r
</style>\r
<script type="text/javascript">\r
/*<![CDATA[*/\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+--block-count=<nlb>\r
+</dt>\r
+<dt class="hdlist1">\r
+-c <nlb>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of logical blocks to write.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--data-size=<size>\r
+</dt>\r
+<dt class="hdlist1">\r
+-z <size>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of data, in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--metadata-size=<size>\r
+</dt>\r
+<dt class="hdlist1">\r
+-y <size>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of metadata in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--data=<data-file>\r
+</dt>\r
+<dt class="hdlist1">\r
+-d <data-file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Data file. If none provided, contents are sent to STDOUT.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--metadata=<metadata-file>\r
+</dt>\r
+<dt class="hdlist1">\r
+-M <metadata-file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Metadata file, if necessary.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--prinfo=<prinfo>\r
+</dt>\r
+<dt class="hdlist1">\r
+-p <prinfo>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Protection Information field defintion.\r
+</p>\r
+<div class="tableblock">\r
+<table rules="all"\r
+width="100%"\r
+frame="border"\r
+cellspacing="0" cellpadding="4">\r
+<col width="50%" />\r
+<col width="50%" />\r
+<tbody>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">Bit</p></td>\r
+<td align="left" valign="top"><p class="table">Description</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">3</p></td>\r
+<td align="left" valign="top"><p class="table">PRACT: Protection Information Action. When set to 1, PI is stripped/inserted\r
+on read/write when the block format’s metadata size is 8. When set to 0,\r
+metadata is passes.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2:0</p></td>\r
+<td align="left" valign="top"><p class="table">PRCHK: Protection Information Check:</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the guard tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">1</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the application tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the reference tag</p></td>\r
+</tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+</dd>\r
+<dt class="hdlist1">\r
+--ref-tag=<reftag>\r
+</dt>\r
+<dt class="hdlist1">\r
+-r <reftag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional reftag when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--app-tag-mask=<appmask>\r
+</dt>\r
+<dt class="hdlist1">\r
+-m <appmask>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional application tag mask when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--force-unit-access\r
+</dt>\r
+<dt class="hdlist1">\r
+-f\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the force-unit access flag.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
--latency\r
</dt>\r
<dt class="hdlist1">\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-06-20 17:02:08 MDT\r
+Last updated 2016-11-15 18:08:16 EST\r
</div>\r
</div>\r
</body>\r
align with the kernel's use of this field. (ie. 0 means transfer
1 block).
+--block-count=<nlb>::
+-c <nlb>::
+ Number of logical blocks to write.
+
+--data-size=<size>::
+-z <size>::
+ Size of data, in bytes.
+
+--metadata-size=<size>::
+-y <size>::
+ Size of metadata in bytes.
+
+--data=<data-file>::
+-d <data-file>::
+ Data file. If none provided, contents are sent to STDOUT.
+
+--metadata=<metadata-file>::
+-M <metadata-file>::
+ Metadata file, if necessary.
+
+--prinfo=<prinfo>::
+-p <prinfo>::
+ Protection Information field defintion.
++
+[]
+|=================
+|Bit|Description
+|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted
+on read/write when the block format's metadata size is 8. When set to 0,
+metadata is passes.
+|2:0|PRCHK: Protection Information Check:
+|2|Set to 1 enables checking the guard tag
+|1|Set to 1 enables checking the application tag
+|0|Set to 1 enables checking the reference tag
+|=================
+
+--ref-tag=<reftag>::
+-r <reftag>::
+ Optional reftag when used with protection information.
+
+--app-tag-mask=<appmask>::
+-m <appmask>::
+ Optional application tag mask when used with protection information.
+
+--force-unit-access::
+-f::
+ Set the force-unit access flag.
+
--latency::
-t::
Print out the latency the IOCTL took (in us).
.\" Title: nvme-uncor
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 11/11/2016
+.\" Date: 11/15/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-UNCOR" "1" "11/11/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-UNCOR" "1" "11/15/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.RS 4
Start block\&.
.RE
+.PP
+\-\-block\-count=<nlb>, \-c
+.RS 4
+Number of logical blocks to write uncorrectable\&.
+.RE
+.PP
+\-\-namespace\-id=<nsid>, \-n <nsid>
+.RS 4
+Namespace ID use in the command\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
Start block.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+--block-count=<nlb>\r
+</dt>\r
+<dt class="hdlist1">\r
+-c\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of logical blocks to write uncorrectable.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--namespace-id=<nsid>\r
+</dt>\r
+<dt class="hdlist1">\r
+-n <nsid>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Namespace ID use in the command.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-11-11 10:26:26 EST\r
+Last updated 2016-11-15 16:34:32 EST\r
</div>\r
</div>\r
</body>\r
-s <slba>::
Start block.
+--block-count=<nlb>::
+-c::
+ Number of logical blocks to write uncorrectable.
+
+--namespace-id=<nsid>::
+-n <nsid>::
+ Namespace ID use in the command.
+
EXAMPLES
--------
No examples yet.
.\" Title: nvme-zeroes
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 10/21/2016
+.\" Date: 11/15/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZEROES" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-ZEROES" "1" "11/15/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.RS 4
Start block\&.
.RE
-.SH "EXAMPLES"
+.PP
+\-\-block\-count=<nlb>, \-c <nlb>
+.RS 4
+Number of logical blocks to write zeroes\&.
+.RE
+.PP
+\-\-prinfo=<prinfo>, \-p <prinfo>
+.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=<reftag>, \-r <reftag>
+.RS 4
+Optional reftag when used with protection information\&.
+.RE
+.PP
+\-\-app\-tag\-mask=<appmask>, \-m <appmask>
+.RS 4
+Optional application tag mask when used with protection information\&.
+.RE
+.PP
+\-\-app\-tag=<apptag>, \-a <apptag>
+.RS 4
+Optional application tag when used with protection information\&.
+.RE
+.PP
+\-\-limited\-retry, \-l
+.RS 4
+Sets the limited retry flag\&.
+.RE
+.PP
+\-\-force\-unit\-access, \-f
+.RS 4
+Set the force\-unit access flag\&.
+.RE
+.PP
+\-\-namespace\-id=<nsid>, \-n <nsid>
+.RS 4
+Namespace ID use in the command\&.
+.RE
.sp
+EXAMPLES EXAMPLES
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
No examples yet\&.
-.SH "NVME"
+
+NVME
+.fi
+.if n \{\
+.RE
+.\}
.sp
Part of the nvme\-user suite
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.7" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
<title>nvme-zeroes(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
ul > li { color: #aaa; }\r
ul > li > * { color: black; }\r
\r
-pre {\r
+.monospaced, code, pre {\r
+ font-family: "Courier New", Courier, monospace;\r
+ font-size: inherit;\r
+ color: navy;\r
padding: 0;\r
margin: 0;\r
}\r
\r
+\r
#author {\r
color: #527bbd;\r
font-weight: bold;\r
*\r
* */\r
\r
-tt {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
div.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
*\r
* */\r
\r
-.monospaced {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
table.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
@media print {\r
body.manpage div#toc { display: none; }\r
}\r
+\r
+\r
</style>\r
<script type="text/javascript">\r
/*<![CDATA[*/\r
Start block.\r
</p>\r
</dd>\r
-</dl></div>\r
-</div>\r
-</div>\r
-<div class="sect1">\r
-<h2 id="_examples">EXAMPLES</h2>\r
-<div class="sectionbody">\r
-<div class="paragraph"><p>No examples yet.</p></div>\r
-</div>\r
+<dt class="hdlist1">\r
+--block-count=<nlb>\r
+</dt>\r
+<dt class="hdlist1">\r
+-c <nlb>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of logical blocks to write zeroes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--prinfo=<prinfo>\r
+</dt>\r
+<dt class="hdlist1">\r
+-p <prinfo>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Protection Information field defintion.\r
+</p>\r
+<div class="tableblock">\r
+<table rules="all"\r
+width="100%"\r
+frame="border"\r
+cellspacing="0" cellpadding="4">\r
+<col width="50%" />\r
+<col width="50%" />\r
+<tbody>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">Bit</p></td>\r
+<td align="left" valign="top"><p class="table">Description</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">3</p></td>\r
+<td align="left" valign="top"><p class="table">PRACT: Protection Information Action. When set to 1, PI is stripped/inserted\r
+on read/write when the block format’s metadata size is 8. When set to 0,\r
+metadata is passes.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2:0</p></td>\r
+<td align="left" valign="top"><p class="table">PRCHK: Protection Information Check:</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the guard tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">1</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the application tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the reference tag</p></td>\r
+</tr>\r
+</tbody>\r
+</table>\r
</div>\r
-<div class="sect1">\r
-<h2 id="_nvme">NVME</h2>\r
-<div class="sectionbody">\r
+</dd>\r
+<dt class="hdlist1">\r
+--ref-tag=<reftag>\r
+</dt>\r
+<dt class="hdlist1">\r
+-r <reftag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional reftag when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--app-tag-mask=<appmask>\r
+</dt>\r
+<dt class="hdlist1">\r
+-m <appmask>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional application tag mask when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--app-tag=<apptag>\r
+</dt>\r
+<dt class="hdlist1">\r
+-a <apptag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional application tag when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--limited-retry\r
+</dt>\r
+<dt class="hdlist1">\r
+-l\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sets the limited retry flag.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--force-unit-access\r
+</dt>\r
+<dt class="hdlist1">\r
+-f\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the force-unit access flag.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--namespace-id=<nsid>\r
+</dt>\r
+<dt class="hdlist1">\r
+-n <nsid>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Namespace ID use in the command.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+<div class="paragraph"><p>EXAMPLES\r
+EXAMPLES</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code>No examples yet.\r
+\r
+NVME</code></pre>\r
+</div></div>\r
<div class="paragraph"><p>Part of the nvme-user suite</p></div>\r
</div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-03-02 08:24:55 MST\r
+Last updated 2016-11-15 18:10:54 EST\r
</div>\r
</div>\r
</body>\r
-s <slba>::
Start block.
+--block-count=<nlb>::
+-c <nlb>::
+ Number of logical blocks to write zeroes.
+
+--prinfo=<prinfo>::
+-p <prinfo>::
+ Protection Information field defintion.
++
+[]
+|=================
+|Bit|Description
+|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted
+on read/write when the block format's metadata size is 8. When set to 0,
+metadata is passes.
+|2:0|PRCHK: Protection Information Check:
+|2|Set to 1 enables checking the guard tag
+|1|Set to 1 enables checking the application tag
+|0|Set to 1 enables checking the reference tag
+|=================
+
+--ref-tag=<reftag>::
+-r <reftag>::
+ Optional reftag when used with protection information.
+
+--app-tag-mask=<appmask>::
+-m <appmask>::
+ Optional application tag mask when used with protection information.
+
+--app-tag=<apptag>::
+-a <apptag>::
+ Optional application tag when used with protection information.
+
+--limited-retry::
+-l::
+ Sets the limited retry flag.
+
+--force-unit-access::
+-f::
+ Set the force-unit access flag.
+
+--namespace-id=<nsid>::
+-n <nsid>::
+ Namespace ID use in the command.
+
+EXAMPLES
EXAMPLES
--------
No examples yet.
.\" Title: nvme-write
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 10/21/2016
+.\" Date: 11/15/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WRITE" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE" "1" "11/15/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-block\-count=<nlb> | \-c <nlb>]
[\-\-data\-size=<size> | \-z <size>]
[\-\-metadata\-size=<size> | \-y <size>]
- [\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-data=<data\-file> | \-d <data\-file>]
[\-\-metadata=<metadata\-file> | \-M <metadata\-file>]
[\-\-prinfo=<prinfo> | \-p <prinfo>]
+ [\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
[\-\-limited\-retry | \-l]
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=<nlb>, \-c <nlb>
+.RS 4
+Number of logical blocks to write\&.
+.RE
+.PP
+\-\-data\-size=<size>, \-z <size>
+.RS 4
+Size of data, in bytes\&.
+.RE
+.PP
+\-\-metadata\-size=<size>, \-y <size>
+.RS 4
+Size of metadata in bytes\&.
+.RE
+.PP
+\-\-data=<data\-file>, \-d <data\-file>
+.RS 4
+Data file\&. If none provided, contents are sent from STDIN\&.
+.RE
+.PP
+\-\-metadata=<metadata\-file>, \-M <metadata\-file>
+.RS 4
+Metadata file, if necessary\&.
+.RE
+.PP
+\-\-prinfo=<prinfo>, \-p <prinfo>
+.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=<reftag>, \-r <reftag>
+.RS 4
+Optional reftag when used with protection information\&.
+.RE
+.PP
+\-\-app\-tag\-mask=<appmask>, \-m <appmask>
+.RS 4
+Optional application tag mask when used with protection information\&.
+.RE
+.PP
+\-\-app\-tag=<apptag>, \-a <apptag>
+.RS 4
+Optional application tag when used with protection information\&.
+.RE
+.PP
+\-\-limited\-retry, \-l
+.RS 4
+Sets the limited retry flag\&.
+.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)\&.
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.7" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
<title>nvme-write(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
ul > li { color: #aaa; }\r
ul > li > * { color: black; }\r
\r
-pre {\r
+.monospaced, code, pre {\r
+ font-family: "Courier New", Courier, monospace;\r
+ font-size: inherit;\r
+ color: navy;\r
padding: 0;\r
margin: 0;\r
}\r
\r
+\r
#author {\r
color: #527bbd;\r
font-weight: bold;\r
*\r
* */\r
\r
-tt {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
div.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
*\r
* */\r
\r
-.monospaced {\r
- font-family: "Courier New", Courier, monospace;\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
table.tableblock {\r
margin-top: 1.0em;\r
margin-bottom: 1.5em;\r
@media print {\r
body.manpage div#toc { display: none; }\r
}\r
+\r
+\r
</style>\r
<script type="text/javascript">\r
/*<![CDATA[*/\r
[--block-count=<nlb> | -c <nlb>]\r
[--data-size=<size> | -z <size>]\r
[--metadata-size=<size> | -y <size>]\r
- [--ref-tag=<reftag> | -r <reftag>]\r
[--data=<data-file> | -d <data-file>]\r
[--metadata=<metadata-file> | -M <metadata-file>]\r
[--prinfo=<prinfo> | -p <prinfo>]\r
+ [--ref-tag=<reftag> | -r <reftag>]\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
[--app-tag=<apptag> | -a <apptag>]\r
[--limited-retry | -l]\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+--block-count=<nlb>\r
+</dt>\r
+<dt class="hdlist1">\r
+-c <nlb>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of logical blocks to write.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--data-size=<size>\r
+</dt>\r
+<dt class="hdlist1">\r
+-z <size>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of data, in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--metadata-size=<size>\r
+</dt>\r
+<dt class="hdlist1">\r
+-y <size>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of metadata in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--data=<data-file>\r
+</dt>\r
+<dt class="hdlist1">\r
+-d <data-file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Data file. If none provided, contents are sent from STDIN.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--metadata=<metadata-file>\r
+</dt>\r
+<dt class="hdlist1">\r
+-M <metadata-file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Metadata file, if necessary.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--prinfo=<prinfo>\r
+</dt>\r
+<dt class="hdlist1">\r
+-p <prinfo>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Protection Information field defintion.\r
+</p>\r
+<div class="tableblock">\r
+<table rules="all"\r
+width="100%"\r
+frame="border"\r
+cellspacing="0" cellpadding="4">\r
+<col width="50%" />\r
+<col width="50%" />\r
+<tbody>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">Bit</p></td>\r
+<td align="left" valign="top"><p class="table">Description</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">3</p></td>\r
+<td align="left" valign="top"><p class="table">PRACT: Protection Information Action. When set to 1, PI is stripped/inserted\r
+on read/write when the block format’s metadata size is 8. When set to 0,\r
+metadata is passes.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2:0</p></td>\r
+<td align="left" valign="top"><p class="table">PRCHK: Protection Information Check:</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">2</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the guard tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">1</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the application tag</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0</p></td>\r
+<td align="left" valign="top"><p class="table">Set to 1 enables checking the reference tag</p></td>\r
+</tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+</dd>\r
+<dt class="hdlist1">\r
+--ref-tag=<reftag>\r
+</dt>\r
+<dt class="hdlist1">\r
+-r <reftag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional reftag when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--app-tag-mask=<appmask>\r
+</dt>\r
+<dt class="hdlist1">\r
+-m <appmask>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional application tag mask when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--app-tag=<apptag>\r
+</dt>\r
+<dt class="hdlist1">\r
+-a <apptag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional application tag when used with protection information.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--limited-retry\r
+</dt>\r
+<dt class="hdlist1">\r
+-l\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sets the limited retry flag.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--force-unit-access\r
+</dt>\r
+<dt class="hdlist1">\r
+-f\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the force-unit access flag.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
--latency\r
</dt>\r
<dt class="hdlist1">\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-08-05 14:45:10 MDT\r
+Last updated 2016-11-15 18:08:07 EST\r
</div>\r
</div>\r
</body>\r
[--block-count=<nlb> | -c <nlb>]
[--data-size=<size> | -z <size>]
[--metadata-size=<size> | -y <size>]
- [--ref-tag=<reftag> | -r <reftag>]
[--data=<data-file> | -d <data-file>]
[--metadata=<metadata-file> | -M <metadata-file>]
[--prinfo=<prinfo> | -p <prinfo>]
+ [--ref-tag=<reftag> | -r <reftag>]
[--app-tag-mask=<appmask> | -m <appmask>]
[--app-tag=<apptag> | -a <apptag>]
[--limited-retry | -l]
align with the kernel's use of this field. (ie. 0 means transfer
1 block).
+--block-count=<nlb>::
+-c <nlb>::
+ Number of logical blocks to write.
+
+--data-size=<size>::
+-z <size>::
+ Size of data, in bytes.
+
+--metadata-size=<size>::
+-y <size>::
+ Size of metadata in bytes.
+
+--data=<data-file>::
+-d <data-file>::
+ Data file. If none provided, contents are sent from STDIN.
+
+--metadata=<metadata-file>::
+-M <metadata-file>::
+ Metadata file, if necessary.
+
+--prinfo=<prinfo>::
+-p <prinfo>::
+ Protection Information field defintion.
++
+[]
+|=================
+|Bit|Description
+|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted
+on read/write when the block format's metadata size is 8. When set to 0,
+metadata is passes.
+|2:0|PRCHK: Protection Information Check:
+|2|Set to 1 enables checking the guard tag
+|1|Set to 1 enables checking the application tag
+|0|Set to 1 enables checking the reference tag
+|=================
+
+--ref-tag=<reftag>::
+-r <reftag>::
+ Optional reftag when used with protection information.
+
+--app-tag-mask=<appmask>::
+-m <appmask>::
+ Optional application tag mask when used with protection information.
+
+--app-tag=<apptag>::
+-a <apptag>::
+ Optional application tag when used with protection information.
+
+--limited-retry::
+-l::
+ Sets the limited retry flag.
+
+--force-unit-access::
+-f::
+ Set the force-unit access flag.
+
--latency::
-t::
Print out the latency the IOCTL took (in us).
projects / users / sagi / nvme-cli.git / commitdiff