Update all documentations to sync up with built-in plugin subcommands.
Not only options supported by subcommands, But few descriptions have not
been updated with implementations.
Sync-up documentation with subcommands implementations.
Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
linknvme:nvme-get-log[1]::
Generic Get Log
+linknvme:nvme-telemetry-log[1]::
+ Telemetry Host-Initiated Log
+
linknvme:nvme-smart-log[1]::
Retrieve Smart Log
linknvme:nvme-list-ns[1]::
List all nvme namespaces
+linknvme:nvme-ns-descs[1]::
+ Identify Namespace Identification Descriptor
+
linknvme:nvme-list[1]::
List all nvme controllers
.\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-input\-file=<file> | \-f <file>]
[\-\-read | \-r ] [\-\-write | \-w]
[\-\-timeout=<to> | \-t <to>]
- [\-\-show\-command | \-\-dry\-run | \-s]
+ [\-\-show\-command | \-s]
+ [\-\-dry\-run | \-d]
[\-\-raw\-binary | \-b]
[\-\-prefill=<prefill> | \-p <prefill>]
.fi
The metadata length for the buffer used for this command\&.
.RE
.PP
-\-s, \-\-show\-cmd, \-\-dry\-run
+\-s, \-\-show\-cmd
.RS 4
-Do not actually send the command; print out the command that would be sent\&.
+Print out the command to be sent\&.
+.RE
+.PP
+\-d, \-\-dry\-run
+.RS 4
+Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
+\fImust\fR
+be set\&. Otherwise \-\-dry\-run optionn will be
+\fIignored\fR\&.
.RE
.PP
\-b, \-\-raw\-binary
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-admin-passthru(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--input-file=<file> | -f <file>]\r
[--read | -r ] [--write | -w]\r
[--timeout=<to> | -t <to>]\r
- [--show-command | --dry-run | -s]\r
+ [--show-command | -s]\r
+ [--dry-run | -d]\r
[--raw-binary | -b]\r
[--prefill=<prefill> | -p <prefill>]</pre>\r
<div class="attribution">\r
<dt class="hdlist1">\r
--show-cmd\r
</dt>\r
+<dd>\r
+<p>\r
+ Print out the command to be sent.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-d\r
+</dt>\r
<dt class="hdlist1">\r
--dry-run\r
</dt>\r
<dd>\r
<p>\r
- Do not actually send the command; print out the command that\r
- would be sent.\r
+ Do not actually send the command. If want to use --dry-run option,\r
+ --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be\r
+ <em>ignored</em>.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-02-27 10:11:57 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--input-file=<file> | -f <file>]
[--read | -r ] [--write | -w]
[--timeout=<to> | -t <to>]
- [--show-command | --dry-run | -s]
+ [--show-command | -s]
+ [--dry-run | -d]
[--raw-binary | -b]
[--prefill=<prefill> | -p <prefill>]
-s::
--show-cmd::
+ Print out the command to be sent.
+
+-d::
--dry-run::
- Do not actually send the command; print out the command that
- would be sent.
+ Do not actually send the command. If want to use --dry-run option,
+ --show-cmd option _must_ be set. Otherwise --dry-run optionn will be
+ _ignored_.
-b::
--raw-binary::
.\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-COMPARE" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-COMPARE" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
\fInvme\-compare\fR <device> [\-\-start\-block=<slba> | \-s <slba>]
[\-\-block\-count=<nlb> | \-c <nlb>]
[\-\-data\-size=<size> | \-z <size>]
+ [\-\-metadata\-size=<metasize> | \-y <metasize>]
[\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-data=<data\-file> | \-d <data\-file>]
+ [\-\-metadata=<meta> | \-M <meta>]
[\-\-prinfo=<prinfo> | \-p <prinfo>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
[\-\-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]
.fi
.SH "DESCRIPTION"
.sp
The Compare command reads the logical blocks specified by the command from the medium and compares the data read to a comparison data buffer transferred as part of the command\&. If the data read from the controller and the comparison data buffer are equivalent with no miscompares, then the command completes successfully\&. If there is any miscompare, the command completes with an error of Compare Failure\&. If metadata is provided, then a comparison is also performed for the metadata\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
-Start block\&.
+64\-bit address of the first block to access\&.
+.RE
+.PP
+\-c <nlb>, \-\-block\-count=<nlb>
+.RS 4
+Number of blocks to be accessed (zero\-based)\&.
+.RE
+.PP
+\-z <size>, \-\-data\-size=<size>
+.RS 4
+Size of data to be compared in bytes\&.
+.RE
+.PP
+\-y <metasize>, \-\-metadata\-size=<metasize>
+.RS 4
+Size of metadata to be trasnferred in bytes\&.
+.RE
+.PP
+\-r <reftag>, \-\-ref\-tag=<regtag>
+.RS 4
+Reference Tag for Protection Information
+.RE
+.PP
+\-d <data\-file>, \-\-data=<data\-file>
+.RS 4
+Data file\&.
+.RE
+.PP
+\-M <meta>, \-\-metadata=<meta>
+.RS 4
+Metadata file\&.
+.RE
+.PP
+\-p <prinfo>, \-\-prinfo=<prinfo>
+.RS 4
+Protection Information and check field\&.
+.RE
+.sp
++
+.TS
+allbox tab(:);
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt.
+T{
+.sp
+Bit
+T}:T{
+.sp
+Description
+T}
+T{
+.sp
+3
+T}:T{
+.sp
+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{
+.sp
+2:0
+T}:T{
+.sp
+PRCHK: Protection Information Check:
+T}
+T{
+.sp
+2
+T}:T{
+.sp
+Set to 1 enables checking the guard tag
+T}
+T{
+.sp
+1
+T}:T{
+.sp
+Set to 1 enables checking the application tag
+T}
+T{
+.sp
+0
+T}:T{
+.sp
+Set to 1 enables checking the reference tag
+T}
+.TE
+.sp 1
+.PP
+\-m <appmask>, \-\-app\-tag\-mask=<appmask>
+.RS 4
+App Tag Mask for Protection Information
+.RE
+.PP
+\-a <apptag>, \-\-app\-tag=<apptag>
+.RS 4
+App Tag for Protection Information
+.RE
+.PP
+\-l, \-\-limited\-retry
+.RS 4
+Number of limited attempts to media\&.
+.RE
+.PP
+\-f, \-\-force\-unit\-access
+.RS 4
+FUA option to guarantee that data is stored to media\&.
+.RE
+.PP
+\-T <type>, \-\-dir\-type=<type>
+.RS 4
+Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specifcation (1\&.3a) defines only one directive, 01h, for write stream idenfiers\&.
+.RE
+.PP
+\-S <spec>, \-\-dir\-spec=<spec>
+.RS 4
+Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
+.RE
+.PP
+\-D <dsm>, \-\-dsm=<dsm>
+.RS 4
+The optional data set management attributes for this command\&. The argument for this is the lower 16 bits of the DSM field in a write command; the upper 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
+.RS 4
+Print out the command to be sent\&.
+.RE
+.PP
+\-w, \-\-dry\-run
+.RS 4
+Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
+\fImust\fR
+be set\&. Otherwise \-\-dry\-run optionn will be
+\fIignored\fR\&.
+.RE
+.PP
+\-t, \-\-latency
+.RS 4
+Print out the latency the IOCTL took (in us)\&.
.RE
.SH "EXAMPLES"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-compare(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<pre class="content"><em>nvme-compare</em> <device> [--start-block=<slba> | -s <slba>]\r
[--block-count=<nlb> | -c <nlb>]\r
[--data-size=<size> | -z <size>]\r
+ [--metadata-size=<metasize> | -y <metasize>]\r
[--ref-tag=<reftag> | -r <reftag>]\r
[--data=<data-file> | -d <data-file>]\r
+ [--metadata=<meta> | -M <meta>]\r
[--prinfo=<prinfo> | -p <prinfo>]\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
[--app-tag=<apptag> | -a <apptag>]\r
[--limited-retry | -l]\r
- [--force-unit-access | -f]</pre>\r
+ [--force-unit-access | -f]\r
+ [--dir-type=<type> | -T <type>]\r
+ [--dir-spec=<spec> | -S <spec>]\r
+ [--dsm=<dsm> | -D <dsm>]\r
+ [--show-command | -v]\r
+ [--dry-run | -w]\r
+ [--latency | -t]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
+-s <slba>\r
+</dt>\r
+<dt class="hdlist1">\r
--start-block=<slba>\r
</dt>\r
+<dd>\r
+<p>\r
+ 64-bit address of the first block to access.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-c <nlb>\r
+</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--block-count=<nlb>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of blocks to be accessed (zero-based).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-z <size>\r
+</dt>\r
+<dt class="hdlist1">\r
+--data-size=<size>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of data to be compared in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-y <metasize>\r
+</dt>\r
+<dt class="hdlist1">\r
+--metadata-size=<metasize>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Size of metadata to be trasnferred in bytes.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-r <reftag>\r
+</dt>\r
+<dt class="hdlist1">\r
+--ref-tag=<regtag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Reference Tag for Protection Information\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-d <data-file>\r
+</dt>\r
+<dt class="hdlist1">\r
+--data=<data-file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Data file.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-M <meta>\r
+</dt>\r
+<dt class="hdlist1">\r
+--metadata=<meta>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Metadata file.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-p <prinfo>\r
+</dt>\r
+<dt class="hdlist1">\r
+--prinfo=<prinfo>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Protection Information and check field.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+<div class="paragraph"><p>+</p></div>\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="dlist"><dl>\r
+<dt class="hdlist1">\r
+-m <appmask>\r
+</dt>\r
+<dt class="hdlist1">\r
+--app-tag-mask=<appmask>\r
+</dt>\r
+<dd>\r
+<p>\r
+ App Tag Mask for Protection Information\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-a <apptag>\r
+</dt>\r
+<dt class="hdlist1">\r
+--app-tag=<apptag>\r
+</dt>\r
+<dd>\r
+<p>\r
+ App Tag for Protection Information\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-l\r
+</dt>\r
+<dt class="hdlist1">\r
+--limited-retry\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of limited attempts to media.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-f\r
+</dt>\r
+<dt class="hdlist1">\r
+--force-unit-access\r
+</dt>\r
+<dd>\r
+<p>\r
+ FUA option to guarantee that data is stored to media.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-T <type>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dir-type=<type>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional directive type. The nvme-cli only enforces the value\r
+ be in the defined range for the directive type, though the NVMe\r
+ specifcation (1.3a) defines only one directive, 01h, for write\r
+ stream idenfiers.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-S <spec>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dir-spec=<spec>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional field for directive specifics. When used with\r
+ write streams, this value is defined to be the write stream\r
+ identifier. The nvme-cli will not validate the stream requested\r
+ is within the controller’s capabilities.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-D <dsm>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dsm=<dsm>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The optional data set management attributes for this command. The\r
+ argument for this is the lower 16 bits of the DSM field in a write\r
+ command; the upper 16 bits of the field come from the directive\r
+ specific field, if used. This may be used to set attributes for\r
+ the LBAs being written, like access frequency, type, latency,\r
+ among other things, as well as yet to be defined types. Please\r
+ consult the NVMe specification for detailed breakdown of how to\r
+ use this field.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--show-cmd\r
+</dt>\r
+<dd>\r
+<p>\r
+ Print out the command to be sent.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-w\r
+</dt>\r
+<dt class="hdlist1">\r
+--dry-run\r
+</dt>\r
+<dd>\r
+<p>\r
+ Do not actually send the command. If want to use --dry-run option,\r
+ --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be\r
+ <em>ignored</em>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-t\r
+</dt>\r
+<dt class="hdlist1">\r
+--latency\r
</dt>\r
<dd>\r
<p>\r
- Start block.\r
+ Print out the latency the IOCTL took (in us).\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
'nvme-compare' <device> [--start-block=<slba> | -s <slba>]
[--block-count=<nlb> | -c <nlb>]
[--data-size=<size> | -z <size>]
+ [--metadata-size=<metasize> | -y <metasize>]
[--ref-tag=<reftag> | -r <reftag>]
[--data=<data-file> | -d <data-file>]
+ [--metadata=<meta> | -M <meta>]
[--prinfo=<prinfo> | -p <prinfo>]
[--app-tag-mask=<appmask> | -m <appmask>]
[--app-tag=<apptag> | -a <apptag>]
[--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]
DESCRIPTION
-----------
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
- Start block.
+--start-block=<slba>::
+ 64-bit address of the first block to access.
+
+-c <nlb>::
+--block-count=<nlb>::
+ Number of blocks to be accessed (zero-based).
+
+-z <size>::
+--data-size=<size>::
+ Size of data to be compared in bytes.
+
+-y <metasize>::
+--metadata-size=<metasize>::
+ Size of metadata to be trasnferred in bytes.
+
+-r <reftag>::
+--ref-tag=<regtag>::
+ Reference Tag for Protection Information
+
+-d <data-file>::
+--data=<data-file>::
+ Data file.
+
+-M <meta>::
+--metadata=<meta>::
+ Metadata file.
+
+-p <prinfo>::
+--prinfo=<prinfo>::
+ Protection Information and check field.
+
++
+[]
+|=================
+|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
+|=================
+
+-m <appmask>::
+--app-tag-mask=<appmask>::
+ App Tag Mask for Protection Information
+
+-a <apptag>::
+--app-tag=<apptag>::
+ App Tag for Protection Information
+
+-l::
+--limited-retry::
+ Number of limited attempts to media.
+
+-f::
+--force-unit-access::
+ FUA option to guarantee that data is stored to media.
+
+-T <type>::
+--dir-type=<type>::
+ Optional directive type. The nvme-cli only enforces the value
+ be in the defined range for the directive type, though the NVMe
+ specifcation (1.3a) defines only one directive, 01h, for write
+ stream idenfiers.
+
+-S <spec>::
+--dir-spec=<spec>::
+ Optional field for directive specifics. When used with
+ write streams, this value is defined to be the write stream
+ identifier. The nvme-cli will not validate the stream requested
+ is within the controller's capabilities.
+
+-D <dsm>::
+--dsm=<dsm>::
+ The optional data set management attributes for this command. The
+ argument for this is the lower 16 bits of the DSM field in a write
+ command; the upper 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.
+
+-v::
+--show-cmd::
+ Print out the command to be sent.
+
+-w::
+--dry-run::
+ Do not actually send the command. If want to use --dry-run option,
+ --show-cmd option _must_ be set. Otherwise --dry-run optionn will be
+ _ignored_.
+
+-t::
+--latency::
+ Print out the latency the IOCTL took (in us).
EXAMPLES
--------
.\" Title: nvme-format
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FORMAT" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-FORMAT" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-pi=<pi> | \-i <pi>]
[\-\-ms=<ms> | \-m <ms>]
[\-\-reset | \-r ]
- [\-\-timeout | \-t ]
+ [\-\-timeout=<timeout> | \-t <timeout> ]
.fi
.SH "DESCRIPTION"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-format(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--pi=<pi> | -i <pi>]\r
[--ms=<ms> | -m <ms>]\r
[--reset | -r ]\r
- [--timeout | -t ]</pre>\r
+ [--timeout=<timeout> | -t <timeout> ]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-02-27 10:11:57 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--pi=<pi> | -i <pi>]
[--ms=<ms> | -m <ms>]
[--reset | -r ]
- [--timeout | -t ]
+ [--timeout=<timeout> | -t <timeout> ]
DESCRIPTION
-----------
.\" Title: nvme-get-feature
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-FEATURE" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-FEATURE" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-data\-len=<data\-len> | \-l <data\-len>]
[\-\-sel=<select> | \-s <select>]
[\-\-raw\-binary | \-b]
+ [\-\-human\-readable | \-H]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Print the raw feature buffer to stdout if the feature returns a structure\&.
.RE
+.PP
+\-H, \-\-human\-readable
+.RS 4
+This option will parse and format many of the bit fields into human\-readable formats\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-get-feature(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>]\r
[--data-len=<data-len> | -l <data-len>]\r
[--sel=<select> | -s <select>]\r
- [--raw-binary | -b]</pre>\r
+ [--raw-binary | -b]\r
+ [--human-readable | -H]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
a structure.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-H\r
+</dt>\r
+<dt class="hdlist1">\r
+--human-readable\r
+</dt>\r
+<dd>\r
+<p>\r
+ This option will parse and format many of the bit fields\r
+ into human-readable formats.\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 2017-06-23 12:34:32 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--data-len=<data-len> | -l <data-len>]
[--sel=<select> | -s <select>]
[--raw-binary | -b]
+ [--human-readable | -H]
DESCRIPTION
-----------
Print the raw feature buffer to stdout if the feature returns
a structure.
+-H::
+--human-readable::
+ This option will parse and format many of the bit fields
+ into human-readable formats.
+
EXAMPLES
--------
* Retrieves the feature for Number of Queues, or feature id 7:
.\" Title: nvme-get-log
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-LOG" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-LOG" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-aen=<aen> | \-a <aen>]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-raw\-binary | \-b]
+ [\-\-lpo=<offset> | \-o <offset>]
+ [\-\-lsp=<field> | \-s <field>]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Print the raw log buffer to stdout\&.
.RE
+.PP
+\-o <offset>, \-\-lpo=<offset>
+.RS 4
+The log page offset specifies the location within a log page to start returning data from\&. It\(cqs Dword\-aligned and 64\-bits\&.
+.RE
+.PP
+\-s <field>, \-\-lsp=<field>
+.RS 4
+The log specified field of LID\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-get-log(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--log-len=<log-len> | -l <log-len>]\r
[--aen=<aen> | -a <aen>]\r
[--namespace-id=<nsid> | -n <nsid>]\r
- [--raw-binary | -b]</pre>\r
+ [--raw-binary | -b]\r
+ [--lpo=<offset> | -o <offset>]\r
+ [--lsp=<field> | -s <field>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Print the raw log buffer to stdout.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <offset>\r
+</dt>\r
+<dt class="hdlist1">\r
+--lpo=<offset>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The log page offset specifies the location within a log page to start\r
+ returning data from. It’s Dword-aligned and 64-bits.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-s <field>\r
+</dt>\r
+<dt class="hdlist1">\r
+--lsp=<field>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The log specified field of LID.\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 2017-10-20 15:09:05 MDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--aen=<aen> | -a <aen>]
[--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
+ [--lpo=<offset> | -o <offset>]
+ [--lsp=<field> | -s <field>]
DESCRIPTION
-----------
--raw-binary::
Print the raw log buffer to stdout.
+-o <offset>::
+--lpo=<offset>::
+ The log page offset specifies the location within a log page to start
+ returning data from. It's Dword-aligned and 64-bits.
+
+-s <field>::
+--lsp=<field>::
+ The log specified field of LID.
+
EXAMPLES
--------
* Get 512 bytes from log page 2
.\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme id\-ns\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
[\-\-namespace\-id=<nsid> | \-n <nsid>] [\-f | \-\-force]
+ [\-\-human\-readable | \-H]
[\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-id-ns(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<div class="verseblock">\r
<pre class="content"><em>nvme id-ns</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
[--namespace-id=<nsid> | -n <nsid>] [-f | --force]\r
+ [--human-readable | -H]\r
[--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-02-27 10:11:58 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[verse]
'nvme id-ns' <device> [-v | --vendor-specific] [-b | --raw-binary]
[--namespace-id=<nsid> | -n <nsid>] [-f | --force]
+ [--human-readable | -H]
[--output-format=<fmt> | -o <fmt>]
DESCRIPTION
.\" Title: nvme-io-passthru
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-IO\-PASSTHRU" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-IO\-PASSTHRU" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-data\-len=<data\-len> | \-l <data\-len>]
[\-\-metadata\-len=<len> | \-m <len>]
[\-\-read | \-r ] [\-\-write | \-w]
- [\-\-input\-file=<file> | \-f <file>]
+ [\-\-input\-file=<file> | \-i <file>]
[\-\-timeout=<to> | \-t <to>]
- [\-\-show\-command | \-\-dry\-run | \-s]
+ [\-\-show\-command | \-s]
+ [\-\-dry\-run | \-d]
[\-\-raw\-binary | \-b]
[\-\-prefill=<prefill> | \-p <prefill>]
.fi
.PP
\-d, \-\-dry\-run
.RS 4
-Do not actually send the command\&.
+Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
+\fImust\fR
+be set\&. Otherwise \-\-dry\-run optionn will be
+\fIignored\fR\&.
.RE
.PP
\-b, \-\-raw\-binary
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-io-passthru(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--data-len=<data-len> | -l <data-len>]\r
[--metadata-len=<len> | -m <len>]\r
[--read | -r ] [--write | -w]\r
- [--input-file=<file> | -f <file>]\r
+ [--input-file=<file> | -i <file>]\r
[--timeout=<to> | -t <to>]\r
- [--show-command | --dry-run | -s]\r
+ [--show-command | -s]\r
+ [--dry-run | -d]\r
[--raw-binary | -b]\r
[--prefill=<prefill> | -p <prefill>]</pre>\r
<div class="attribution">\r
</dt>\r
<dd>\r
<p>\r
- Do not actually send the command.\r
+ Do not actually send the command. If want to use --dry-run option,\r
+ --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be\r
+ <em>ignored</em>.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-02-27 10:11:58 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--data-len=<data-len> | -l <data-len>]
[--metadata-len=<len> | -m <len>]
[--read | -r ] [--write | -w]
- [--input-file=<file> | -f <file>]
+ [--input-file=<file> | -i <file>]
[--timeout=<to> | -t <to>]
- [--show-command | --dry-run | -s]
+ [--show-command | -s]
+ [--dry-run | -d]
[--raw-binary | -b]
[--prefill=<prefill> | -p <prefill>]
-d::
--dry-run::
- Do not actually send the command.
+ Do not actually send the command. If want to use --dry-run option,
+ --show-cmd option _must_ be set. Otherwise --dry-run optionn will be
+ _ignored_.
-b::
--raw-binary::
.\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme list\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-all | \-a]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Retrieve the identify list structure starting with the given nsid\&.
.RE
+.PP
+\-a, \-\-all
+.RS 4
+Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-id-ns(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre>\r
+<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--all | -a]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Retrieve the identify list structure starting with the given nsid.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-a\r
+</dt>\r
+<dt class="hdlist1">\r
+--all\r
+</dt>\r
+<dd>\r
+<p>\r
+ Retrieve the identify list structure for all namespaces in the\r
+ subsystem, whether attached or inactive.\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 2017-04-18 09:19:59 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
--------
[verse]
'nvme list-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--all | -a]
DESCRIPTION
-----------
--namespace-id=<nsid>::
Retrieve the identify list structure starting with the given nsid.
+-a::
+--all::
+ Retrieve the identify list structure for all namespaces in the
+ subsystem, whether attached or inactive.
+
EXAMPLES
--------
No examples yet.
--- /dev/null
+'\" t
+.\" Title: nvme-ns-descs
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 01/30/2018
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-NS\-DESCS" "1" "01/30/2018" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-ns-descs \- Send NVMe Identify for a list of Namespace Identification Descriptor structure, return result and structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme ns\-descs\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends an identify for a list of namespace identification descriptor structures command and provides the result and returned structure\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. If the character device is given, the \*(Aq\-\-namespace\-id\*(Aq option is mandatory, otherwise it will use the ns\-id of the namespace for the block device you opened\&. For block devices, the ns\-id used can be overridden with the same option\&.
+.sp
+On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&.
+.SH "OPTIONS"
+.PP
+\-n <nsid>, \-\-namespace\-id=<nsid>
+.RS 4
+Retrieve the identify namespace identification descriptor structure for the given nsid\&. This is required for the character devices, or overrides the block nsid if given\&.
+.RE
+.PP
+\-b, \-\-raw\-binary
+.RS 4
+Print the raw buffer to stdout\&. Structure is not parsed by program\&.
+.RE
+.PP
+\-o <format>, \-\-output\-format=<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
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+If using the character device or overriding namespace #2:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme ns\-descs /dev/nvme0 \-n 1
+# nvme ns\-descs /dev/nvme0n1 \-n 2
+# nvme ns\-descs /dev/nvme0 \-\-namespace\-id=1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Have the program return the raw structure in binary:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme ns\-descs /dev/nvme0n1 \-\-raw\-binary > ns_descs\&.raw
+# nvme ns\-descs /dev/nvme0n1 \-b > ns_descs\&.raw
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+It is probably a bad idea to not redirect stdout when using this mode\&.
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<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.9" />\r
+<title>nvme-ns-descs(1)</title>\r
+<style type="text/css">\r
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
+\r
+/* Default font. */\r
+body {\r
+ font-family: Georgia,serif;\r
+}\r
+\r
+/* Title font. */\r
+h1, h2, h3, h4, h5, h6,\r
+div.title, caption.title,\r
+thead, p.table.header,\r
+#toctitle,\r
+#author, #revnumber, #revdate, #revremark,\r
+#footer {\r
+ font-family: Arial,Helvetica,sans-serif;\r
+}\r
+\r
+body {\r
+ margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a {\r
+ color: blue;\r
+ text-decoration: underline;\r
+}\r
+a:visited {\r
+ color: fuchsia;\r
+}\r
+\r
+em {\r
+ font-style: italic;\r
+ color: navy;\r
+}\r
+\r
+strong {\r
+ font-weight: bold;\r
+ color: #083194;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+ color: #527bbd;\r
+ margin-top: 1.2em;\r
+ margin-bottom: 0.5em;\r
+ line-height: 1.3;\r
+}\r
+\r
+h1, h2, h3 {\r
+ border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+ padding-top: 0.5em;\r
+}\r
+h3 {\r
+ float: left;\r
+}\r
+h3 + * {\r
+ clear: left;\r
+}\r
+h5 {\r
+ font-size: 1.0em;\r
+}\r
+\r
+div.sectionbody {\r
+ margin-left: 0;\r
+}\r
+\r
+hr {\r
+ border: 1px solid silver;\r
+}\r
+\r
+p {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0.5em;\r
+}\r
+\r
+ul, ol, li > p {\r
+ margin-top: 0;\r
+}\r
+ul > li { color: #aaa; }\r
+ul > li > * { color: black; }\r
+\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
+pre {\r
+ white-space: pre-wrap;\r
+}\r
+\r
+#author {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ font-size: 1.1em;\r
+}\r
+#email {\r
+}\r
+#revnumber, #revdate, #revremark {\r
+}\r
+\r
+#footer {\r
+ font-size: small;\r
+ border-top: 2px solid silver;\r
+ padding-top: 0.5em;\r
+ margin-top: 4.0em;\r
+}\r
+#footer-text {\r
+ float: left;\r
+ padding-bottom: 0.5em;\r
+}\r
+#footer-badges {\r
+ float: right;\r
+ padding-bottom: 0.5em;\r
+}\r
+\r
+#preamble {\r
+ margin-top: 1.5em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+ margin-top: 2.0em;\r
+ margin-bottom: 2.0em;\r
+ margin-right: 10%;\r
+ color: #606060;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+ padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ text-align: left;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+ margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+ margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+ background: #ffffee;\r
+ border: 1px solid #dddddd;\r
+ border-left: 4px solid #f0f0f0;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+ border: 1px solid #dddddd;\r
+ border-left: 5px solid #f0f0f0;\r
+ background: #f8f8f8;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.quoteblock, div.verseblock {\r
+ padding-left: 1.0em;\r
+ margin-left: 1.0em;\r
+ margin-right: 10%;\r
+ border-left: 5px solid #f0f0f0;\r
+ color: #888;\r
+}\r
+\r
+div.quoteblock > div.attribution {\r
+ padding-top: 0.5em;\r
+ text-align: right;\r
+}\r
+\r
+div.verseblock > pre.content {\r
+ font-family: inherit;\r
+ font-size: inherit;\r
+}\r
+div.verseblock > div.attribution {\r
+ padding-top: 0.75em;\r
+ text-align: left;\r
+}\r
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
+div.verseblock + div.attribution {\r
+ text-align: left;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+ vertical-align: top;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ text-decoration: underline;\r
+ color: #527bbd;\r
+ padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+ padding-left: 0.5em;\r
+ border-left: 3px solid #dddddd;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+ border-left: 3px solid #dddddd;\r
+ padding-left: 0.5em;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
+a.image:visited { color: white; }\r
+\r
+dl {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+dt {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0;\r
+ font-style: normal;\r
+ color: navy;\r
+}\r
+dd > *:first-child {\r
+ margin-top: 0.1em;\r
+}\r
+\r
+ul, ol {\r
+ list-style-position: outside;\r
+}\r
+ol.arabic {\r
+ list-style-type: decimal;\r
+}\r
+ol.loweralpha {\r
+ list-style-type: lower-alpha;\r
+}\r
+ol.upperalpha {\r
+ list-style-type: upper-alpha;\r
+}\r
+ol.lowerroman {\r
+ list-style-type: lower-roman;\r
+}\r
+ol.upperroman {\r
+ list-style-type: upper-roman;\r
+}\r
+\r
+div.compact ul, div.compact ol,\r
+div.compact p, div.compact p,\r
+div.compact div, div.compact div {\r
+ margin-top: 0.1em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+tfoot {\r
+ font-weight: bold;\r
+}\r
+td > div.verse {\r
+ white-space: pre;\r
+}\r
+\r
+div.hdlist {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+div.hdlist tr {\r
+ padding-bottom: 15px;\r
+}\r
+dt.hdlist1.strong, td.hdlist1.strong {\r
+ font-weight: bold;\r
+}\r
+td.hdlist1 {\r
+ vertical-align: top;\r
+ font-style: normal;\r
+ padding-right: 0.8em;\r
+ color: navy;\r
+}\r
+td.hdlist2 {\r
+ vertical-align: top;\r
+}\r
+div.hdlist.compact tr {\r
+ margin: 0;\r
+ padding-bottom: 0;\r
+}\r
+\r
+.comment {\r
+ background: yellow;\r
+}\r
+\r
+.footnote, .footnoteref {\r
+ font-size: 0.8em;\r
+}\r
+\r
+span.footnote, span.footnoteref {\r
+ vertical-align: super;\r
+}\r
+\r
+#footnotes {\r
+ margin: 20px 0 20px 0;\r
+ padding: 7px 0 0 0;\r
+}\r
+\r
+#footnotes div.footnote {\r
+ margin: 0 0 5px 0;\r
+}\r
+\r
+#footnotes hr {\r
+ border: none;\r
+ border-top: 1px solid silver;\r
+ height: 1px;\r
+ text-align: left;\r
+ margin-left: 0;\r
+ width: 20%;\r
+ min-width: 100px;\r
+}\r
+\r
+div.colist td {\r
+ padding-right: 0.5em;\r
+ padding-bottom: 0.3em;\r
+ vertical-align: top;\r
+}\r
+div.colist td img {\r
+ margin-top: 0.3em;\r
+}\r
+\r
+@media print {\r
+ #footer-badges { display: none; }\r
+}\r
+\r
+#toc {\r
+ margin-bottom: 2.5em;\r
+}\r
+\r
+#toctitle {\r
+ color: #527bbd;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
+ margin-top: 0;\r
+ margin-bottom: 0;\r
+}\r
+div.toclevel2 {\r
+ margin-left: 2em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel3 {\r
+ margin-left: 4em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel4 {\r
+ margin-left: 6em;\r
+ font-size: 0.9em;\r
+}\r
+\r
+span.aqua { color: aqua; }\r
+span.black { color: black; }\r
+span.blue { color: blue; }\r
+span.fuchsia { color: fuchsia; }\r
+span.gray { color: gray; }\r
+span.green { color: green; }\r
+span.lime { color: lime; }\r
+span.maroon { color: maroon; }\r
+span.navy { color: navy; }\r
+span.olive { color: olive; }\r
+span.purple { color: purple; }\r
+span.red { color: red; }\r
+span.silver { color: silver; }\r
+span.teal { color: teal; }\r
+span.white { color: white; }\r
+span.yellow { color: yellow; }\r
+\r
+span.aqua-background { background: aqua; }\r
+span.black-background { background: black; }\r
+span.blue-background { background: blue; }\r
+span.fuchsia-background { background: fuchsia; }\r
+span.gray-background { background: gray; }\r
+span.green-background { background: green; }\r
+span.lime-background { background: lime; }\r
+span.maroon-background { background: maroon; }\r
+span.navy-background { background: navy; }\r
+span.olive-background { background: olive; }\r
+span.purple-background { background: purple; }\r
+span.red-background { background: red; }\r
+span.silver-background { background: silver; }\r
+span.teal-background { background: teal; }\r
+span.white-background { background: white; }\r
+span.yellow-background { background: yellow; }\r
+\r
+span.big { font-size: 2em; }\r
+span.small { font-size: 0.6em; }\r
+\r
+span.underline { text-decoration: underline; }\r
+span.overline { text-decoration: overline; }\r
+span.line-through { text-decoration: line-through; }\r
+\r
+div.unbreakable { page-break-inside: avoid; }\r
+\r
+\r
+/*\r
+ * xhtml11 specific\r
+ *\r
+ * */\r
+\r
+div.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.tableblock > table {\r
+ border: 3px solid #527bbd;\r
+}\r
+thead, p.table.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.table {\r
+ margin-top: 0;\r
+}\r
+/* Because the table frame attribute is overriden by CSS in most browsers. */\r
+div.tableblock > table[frame="void"] {\r
+ border-style: none;\r
+}\r
+div.tableblock > table[frame="hsides"] {\r
+ border-left-style: none;\r
+ border-right-style: none;\r
+}\r
+div.tableblock > table[frame="vsides"] {\r
+ border-top-style: none;\r
+ border-bottom-style: none;\r
+}\r
+\r
+\r
+/*\r
+ * html5 specific\r
+ *\r
+ * */\r
+\r
+table.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+thead, p.tableblock.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.tableblock {\r
+ margin-top: 0;\r
+}\r
+table.tableblock {\r
+ border-width: 3px;\r
+ border-spacing: 0px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+ border-collapse: collapse;\r
+}\r
+th.tableblock, td.tableblock {\r
+ border-width: 1px;\r
+ padding: 4px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+}\r
+\r
+table.tableblock.frame-topbot {\r
+ border-left-style: hidden;\r
+ border-right-style: hidden;\r
+}\r
+table.tableblock.frame-sides {\r
+ border-top-style: hidden;\r
+ border-bottom-style: hidden;\r
+}\r
+table.tableblock.frame-none {\r
+ border-style: hidden;\r
+}\r
+\r
+th.tableblock.halign-left, td.tableblock.halign-left {\r
+ text-align: left;\r
+}\r
+th.tableblock.halign-center, td.tableblock.halign-center {\r
+ text-align: center;\r
+}\r
+th.tableblock.halign-right, td.tableblock.halign-right {\r
+ text-align: right;\r
+}\r
+\r
+th.tableblock.valign-top, td.tableblock.valign-top {\r
+ vertical-align: top;\r
+}\r
+th.tableblock.valign-middle, td.tableblock.valign-middle {\r
+ vertical-align: middle;\r
+}\r
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
+ vertical-align: bottom;\r
+}\r
+\r
+\r
+/*\r
+ * manpage specific\r
+ *\r
+ * */\r
+\r
+body.manpage h1 {\r
+ padding-top: 0.5em;\r
+ padding-bottom: 0.5em;\r
+ border-top: 2px solid silver;\r
+ border-bottom: 2px solid silver;\r
+}\r
+body.manpage h2 {\r
+ border-style: none;\r
+}\r
+body.manpage div.sectionbody {\r
+ margin-left: 3em;\r
+}\r
+\r
+@media print {\r
+ body.manpage div#toc { display: none; }\r
+}\r
+\r
+\r
+</style>\r
+<script type="text/javascript">\r
+/*<+'])');\r
+ // Function that scans the DOM tree for header elements (the DOM2\r
+ // nodeIterator API would be a better technique but not supported by all\r
+ // browsers).\r
+ var iterate = function (el) {\r
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
+ var mo = re.exec(i.tagName);\r
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
+ }\r
+ iterate(i);\r
+ }\r
+ }\r
+ }\r
+ iterate(el);\r
+ return result;\r
+ }\r
+\r
+ var toc = document.getElementById("toc");\r
+ if (!toc) {\r
+ return;\r
+ }\r
+\r
+ // Delete existing TOC entries in case we're reloading the TOC.\r
+ var tocEntriesToRemove = [];\r
+ var i;\r
+ for (i = 0; i < toc.childNodes.length; i++) {\r
+ var entry = toc.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div'\r
+ && entry.getAttribute("class")\r
+ && entry.getAttribute("class").match(/^toclevel/))\r
+ tocEntriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < tocEntriesToRemove.length; i++) {\r
+ toc.removeChild(tocEntriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild TOC entries.\r
+ var entries = tocEntries(document.getElementById("content"), toclevels);\r
+ for (var i = 0; i < entries.length; ++i) {\r
+ var entry = entries[i];\r
+ if (entry.element.id == "")\r
+ entry.element.id = "_toc_" + i;\r
+ var a = document.createElement("a");\r
+ a.href = "#" + entry.element.id;\r
+ a.appendChild(document.createTextNode(entry.text));\r
+ var div = document.createElement("div");\r
+ div.appendChild(a);\r
+ div.className = "toclevel" + entry.toclevel;\r
+ toc.appendChild(div);\r
+ }\r
+ if (entries.length == 0)\r
+ toc.parentNode.removeChild(toc);\r
+},\r
+\r
+\r
+/////////////////////////////////////////////////////////////////////\r
+// Footnotes generator\r
+/////////////////////////////////////////////////////////////////////\r
+\r
+/* Based on footnote generation code from:\r
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
+ */\r
+\r
+footnotes: function () {\r
+ // Delete existing footnote entries in case we're reloading the footnodes.\r
+ var i;\r
+ var noteholder = document.getElementById("footnotes");\r
+ if (!noteholder) {\r
+ return;\r
+ }\r
+ var entriesToRemove = [];\r
+ for (i = 0; i < noteholder.childNodes.length; i++) {\r
+ var entry = noteholder.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
+ entriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < entriesToRemove.length; i++) {\r
+ noteholder.removeChild(entriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild footnote entries.\r
+ var cont = document.getElementById("content");\r
+ var spans = cont.getElementsByTagName("span");\r
+ var refs = {};\r
+ var n = 0;\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnote") {\r
+ n++;\r
+ var note = spans[i].getAttribute("data-note");\r
+ if (!note) {\r
+ // Use [\s\S] in place of . so multi-line matches work.\r
+ // Because JavaScript has no s (dotall) regex flag.\r
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
+ spans[i].innerHTML =\r
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ spans[i].setAttribute("data-note", note);\r
+ }\r
+ noteholder.innerHTML +=\r
+ "<div class='footnote' id='_footnote_" + n + "'>" +\r
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
+ n + "</a>. " + note + "</div>";\r
+ var id =spans[i].getAttribute("id");\r
+ if (id != null) refs["#"+id] = n;\r
+ }\r
+ }\r
+ if (n == 0)\r
+ noteholder.parentNode.removeChild(noteholder);\r
+ else {\r
+ // Process footnoterefs.\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnoteref") {\r
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
+ href = href.match(/#.*/)[0]; // Because IE return full URL.\r
+ n = refs[href];\r
+ spans[i].innerHTML =\r
+ "[<a href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ }\r
+ }\r
+ }\r
+},\r
+\r
+install: function(toclevels) {\r
+ var timerId;\r
+\r
+ function reinstall() {\r
+ asciidoc.footnotes();\r
+ if (toclevels) {\r
+ asciidoc.toc(toclevels);\r
+ }\r
+ }\r
+\r
+ function reinstallAndRemoveTimer() {\r
+ clearInterval(timerId);\r
+ reinstall();\r
+ }\r
+\r
+ timerId = setInterval(reinstall, 500);\r
+ if (document.addEventListener)\r
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
+ else\r
+ window.onload = reinstallAndRemoveTimer;\r
+}\r
+\r
+}\r
+asciidoc.install();\r
+/*]]>*/\r
+</script>\r
+</head>\r
+<body class="manpage">\r
+<div id="header">\r
+<h1>\r
+nvme-ns-descs(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>nvme-ns-descs -\r
+ Send NVMe Identify for a list of Namespace Identification Descriptor structure, return result and structure\r
+</p>\r
+</div>\r
+</div>\r
+<div id="content">\r
+<div class="sect1">\r
+<h2 id="_synopsis">SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="verseblock">\r
+<pre class="content"><em>nvme ns-descs</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
+<div class="attribution">\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>For the NVMe device given, sends an identify for a list of namespace\r
+identification descriptor structures command and provides the result and\r
+returned structure.</p></div>\r
+<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).\r
+If the character device is given, the <code>'--namespace-id'</code> option is\r
+mandatory, otherwise it will use the ns-id of the namespace for the block\r
+device you opened. For block devices, the ns-id used can be overridden\r
+with the same option.</p></div>\r
+<div class="paragraph"><p>On success, the structure may be returned in one of several ways depending\r
+on the option flags; the structure may be parsed by the program or the\r
+raw buffer may be printed to stdout.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-n <nsid>\r
+</dt>\r
+<dt class="hdlist1">\r
+--namespace-id=<nsid>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Retrieve the identify namespace identification descriptor structure\r
+ for the given nsid. This is required for the character devices, or\r
+ overrides the block nsid if given.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-b\r
+</dt>\r
+<dt class="hdlist1">\r
+--raw-binary\r
+</dt>\r
+<dd>\r
+<p>\r
+ Print the raw buffer to stdout. Structure is not parsed by\r
+ program.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o <format>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<format>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
+ Only one output format can be used at a time.\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="ulist"><ul>\r
+<li>\r
+<p>\r
+If using the character device or overriding namespace #2:\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme ns-descs /dev/nvme0 -n 1\r
+# nvme ns-descs /dev/nvme0n1 -n 2\r
+# nvme ns-descs /dev/nvme0 --namespace-id=1</code></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+Have the program return the raw structure in binary:\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme ns-descs /dev/nvme0n1 --raw-binary > ns_descs.raw\r
+# nvme ns-descs /dev/nvme0n1 -b > ns_descs.raw</code></pre>\r
+</div></div>\r
+<div class="paragraph"><p>It is probably a bad idea to not redirect stdout when using this mode.</p></div>\r
+</li>\r
+</ul></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_nvme">NVME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Part of the nvme-user suite</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
--- /dev/null
+nvme-ns-descs(1)
+================
+
+NAME
+----
+nvme-ns-descs - Send NVMe Identify for a list of Namespace Identification
+ Descriptor structure, return result and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme ns-descs' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends an identify for a list of namespace
+identification descriptor structures command and provides the result and
+returned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+If the character device is given, the `'--namespace-id'` option is
+mandatory, otherwise it will use the ns-id of the namespace for the block
+device you opened. For block devices, the ns-id used can be overridden
+with the same option.
+
+On success, the structure may be returned in one of several ways depending
+on the option flags; the structure may be parsed by the program or the
+raw buffer may be printed to stdout.
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+ Retrieve the identify namespace identification descriptor structure
+ for the given nsid. This is required for the character devices, or
+ overrides the block nsid if given.
+
+-b::
+--raw-binary::
+ Print the raw buffer to stdout. Structure is not parsed by
+ program.
+
+-o <format>::
+--output-format=<format>::
+ Set the reporting format to 'normal', 'json', or 'binary'.
+ Only one output format can be used at a time.
+
+
+EXAMPLES
+--------
+* If using the character device or overriding namespace #2:
++
+------------
+# nvme ns-descs /dev/nvme0 -n 1
+# nvme ns-descs /dev/nvme0n1 -n 2
+# nvme ns-descs /dev/nvme0 --namespace-id=1
+------------
++
+
+* Have the program return the raw structure in binary:
++
+------------
+# nvme ns-descs /dev/nvme0n1 --raw-binary > ns_descs.raw
+# nvme ns-descs /dev/nvme0n1 -b > ns_descs.raw
+------------
++
+It is probably a bad idea to not redirect stdout when using this mode.
+
+NVME
+----
+Part of the nvme-user suite
.\" Title: nvme-read
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-READ" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-READ" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
[\-\-limited\-retry | \-l]
- [\-\-latency | \-t]
[\-\-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]
.fi
.SH "DESCRIPTION"
.sp
Set the force\-unit access flag\&.
.RE
.PP
-\-\-latency, \-t
+\-T <type>, \-\-dir\-type=<type>
+.RS 4
+Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specifcation (1\&.3a) defines only one directive, 01h, for write stream idenfiers\&.
+.RE
+.PP
+\-S <spec>, \-\-dir\-spec=<spec>
+.RS 4
+Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
+.RE
+.PP
+\-D <dsm>, \-\-dsm=<dsm>
+.RS 4
+The optional data set management attributes for this command\&. The argument for this is the lower 16 bits of the DSM field in a write command; the upper 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
+.RS 4
+Print out the command to be sent\&.
+.RE
+.PP
+\-w, \-\-dry\-run
+.RS 4
+Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
+\fImust\fR
+be set\&. Otherwise \-\-dry\-run optionn will be
+\fIignored\fR\&.
+.RE
+.PP
+\-t, \-\-latency
.RS 4
Print out the latency the IOCTL took (in us)\&.
.RE
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-read(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
[--app-tag=<apptag> | -a <apptag>]\r
[--limited-retry | -l]\r
- [--latency | -t]\r
- [--force-unit-access | -f]</pre>\r
+ [--force-unit-access | -f]\r
+ [--dir-type=<type> | -T <type>]\r
+ [--dir-spec=<spec> | -S <spec>]\r
+ [--dsm=<dsm> | -D <dsm>]\r
+ [--show-command | -v]\r
+ [--dry-run | -w]\r
+ [--latency | -t]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---latency\r
+-T <type>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dir-type=<type>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional directive type. The nvme-cli only enforces the value\r
+ be in the defined range for the directive type, though the NVMe\r
+ specifcation (1.3a) defines only one directive, 01h, for write\r
+ stream idenfiers.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-S <spec>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dir-spec=<spec>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Optional field for directive specifics. When used with\r
+ write streams, this value is defined to be the write stream\r
+ identifier. The nvme-cli will not validate the stream requested\r
+ is within the controller’s capabilities.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-D <dsm>\r
+</dt>\r
+<dt class="hdlist1">\r
+--dsm=<dsm>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The optional data set management attributes for this command. The\r
+ argument for this is the lower 16 bits of the DSM field in a write\r
+ command; the upper 16 bits of the field come from the directive\r
+ specific field, if used. This may be used to set attributes for\r
+ the LBAs being written, like access frequency, type, latency,\r
+ among other things, as well as yet to be defined types. Please\r
+ consult the NVMe specification for detailed breakdown of how to\r
+ use this field.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--show-cmd\r
+</dt>\r
+<dd>\r
+<p>\r
+ Print out the command to be sent.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-w\r
</dt>\r
<dt class="hdlist1">\r
+--dry-run\r
+</dt>\r
+<dd>\r
+<p>\r
+ Do not actually send the command. If want to use --dry-run option,\r
+ --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be\r
+ <em>ignored</em>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
-t\r
</dt>\r
+<dt class="hdlist1">\r
+--latency\r
+</dt>\r
<dd>\r
<p>\r
Print out the latency the IOCTL took (in us).\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-02-27 10:11:58 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[--app-tag-mask=<appmask> | -m <appmask>]
[--app-tag=<apptag> | -a <apptag>]
[--limited-retry | -l]
- [--latency | -t]
[--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]
DESCRIPTION
-----------
-f::
Set the force-unit access flag.
---latency::
+-T <type>::
+--dir-type=<type>::
+ Optional directive type. The nvme-cli only enforces the value
+ be in the defined range for the directive type, though the NVMe
+ specifcation (1.3a) defines only one directive, 01h, for write
+ stream idenfiers.
+
+-S <spec>::
+--dir-spec=<spec>::
+ Optional field for directive specifics. When used with
+ write streams, this value is defined to be the write stream
+ identifier. The nvme-cli will not validate the stream requested
+ is within the controller's capabilities.
+
+-D <dsm>::
+--dsm=<dsm>::
+ The optional data set management attributes for this command. The
+ argument for this is the lower 16 bits of the DSM field in a write
+ command; the upper 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.
+
+-v::
+--show-cmd::
+ Print out the command to be sent.
+
+-w::
+--dry-run::
+ Do not actually send the command. If want to use --dry-run option,
+ --show-cmd option _must_ be set. Otherwise --dry-run optionn will be
+ _ignored_.
+
-t::
+--latency::
Print out the latency the IOCTL took (in us).
EXAMPLES
.\" Title: nvme-resv-acquire
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-ACQUIRE" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-ACQUIRE" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme resv\-acquire\fR <device>
+\fInvme resv\-acquire\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-prkey=<prkey> | \-p <prkey>]
+ [\-\-rtype=<rtype> | \-t <rtype>]
+ [\-\-racqa=<racqa> | \-a <racqa>]
+ [\-\-iekey | \-i]
.fi
.SH "DESCRIPTION"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-resv-acquire(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme resv-acquire</em> <device></pre>\r
+<pre class="content"><em>nvme resv-acquire</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--prkey=<prkey> | -p <prkey>]\r
+ [--rtype=<rtype> | -t <rtype>]\r
+ [--racqa=<racqa> | -a <racqa>]\r
+ [--iekey | -i]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme resv-acquire' <device>
+'nvme resv-acquire' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--crkey=<crkey> | -c <crkey>]
+ [--prkey=<prkey> | -p <prkey>]
+ [--rtype=<rtype> | -t <rtype>]
+ [--racqa=<racqa> | -a <racqa>]
+ [--iekey | -i]
DESCRIPTION
-----------
.\" Title: nvme-resv-register
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-REGISTER" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-REGISTER" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme resv\-register\fR <device>
+\fInvme resv\-register\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-nrkey=<nrkey> | \-k <nrkey>]
+ [\-\-rrega=<rrega> | \-r <rrega>]
+ [\-\-cptpl=<cptpl> | \-p <cptpl>]
+ [\-\-iekey | \-i]
.fi
.SH "DESCRIPTION"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-resv-register(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme resv-register</em> <device></pre>\r
+<pre class="content"><em>nvme resv-register</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--nrkey=<nrkey> | -k <nrkey>]\r
+ [--rrega=<rrega> | -r <rrega>]\r
+ [--cptpl=<cptpl> | -p <cptpl>]\r
+ [--iekey | -i]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme resv-register' <device>
+'nvme resv-register' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--crkey=<crkey> | -c <crkey>]
+ [--nrkey=<nrkey> | -k <nrkey>]
+ [--rrega=<rrega> | -r <rrega>]
+ [--cptpl=<cptpl> | -p <cptpl>]
+ [--iekey | -i]
DESCRIPTION
-----------
.\" Title: nvme-resv-release
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-RELEASE" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-RELEASE" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme resv\-release\fR <device>
+\fInvme resv\-release\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-rtype=<rtype> | \-t <rtype>]
+ [\-\-rrela=<rrela> | \-a <rrela>]
+ [\-\-iekey | \-i]
.fi
.SH "DESCRIPTION"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-resv-release(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme resv-release</em> <device></pre>\r
+<pre class="content"><em>nvme resv-release</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--rtype=<rtype> | -t <rtype>]\r
+ [--rrela=<rrela> | -a <rrela>]\r
+ [--iekey | -i]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme resv-release' <device>
+'nvme resv-release' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--crkey=<crkey> | -c <crkey>]
+ [--rtype=<rtype> | -t <rtype>]
+ [--rrela=<rrela> | -a <rrela>]
+ [--iekey | -i]
DESCRIPTION
-----------
.\" Title: nvme-resv-report
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-REPORT" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-REPORT" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme resv\-report\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-numd=<num\-dwords> | \-d <num\-dwords>]
- [\-b | \-\-raw\-binary]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+ [\-\-cdw11=<cdw11> | \-c <cdw11>]
+ [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-resv-report(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<div class="verseblock">\r
<pre class="content"><em>nvme resv-report</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
[--numd=<num-dwords> | -d <num-dwords>]\r
- [-b | --raw-binary]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+ [--cdw11=<cdw11> | -c <cdw11>]\r
+ [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-06-28 15:53:33 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
[verse]
'nvme resv-report' <device> [--namespace-id=<nsid> | -n <nsid>]
[--numd=<num-dwords> | -d <num-dwords>]
- [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]
+ [--cdw11=<cdw11> | -c <cdw11>]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
.\" Title: nvme-sanitize-log
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SANITIZE\-LOG" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-SANITIZE\-LOG" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme sanitize\-log\fR <device>
+\fInvme sanitize\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-human\-readable | \-H]
+ [\-\-raw\-binary | \-b]
.fi
.SH "DESCRIPTION"
.sp
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
-.sp
-No options yet\&.
+.PP
+\-o <format>, \-\-output\-format=<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
+\-H, \-\-human\-readable
+.RS 4
+This option will parse and format many of the bit fields into human\-readable formats\&.
+.RE
+.PP
+\-b, \-\-raw\-binary
+.RS 4
+Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
- "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.9" />
-<title>nvme-sanitize-log(1)</title>
-<style type="text/css">
-/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
-
-/* Default font. */
-body {
- font-family: Georgia,serif;
-}
-
-/* Title font. */
-h1, h2, h3, h4, h5, h6,
-div.title, caption.title,
-thead, p.table.header,
-#toctitle,
-#author, #revnumber, #revdate, #revremark,
-#footer {
- font-family: Arial,Helvetica,sans-serif;
-}
-
-body {
- margin: 1em 5% 1em 5%;
-}
-
-a {
- color: blue;
- text-decoration: underline;
-}
-a:visited {
- color: fuchsia;
-}
-
-em {
- font-style: italic;
- color: navy;
-}
-
-strong {
- font-weight: bold;
- color: #083194;
-}
-
-h1, h2, h3, h4, h5, h6 {
- color: #527bbd;
- margin-top: 1.2em;
- margin-bottom: 0.5em;
- line-height: 1.3;
-}
-
-h1, h2, h3 {
- border-bottom: 2px solid silver;
-}
-h2 {
- padding-top: 0.5em;
-}
-h3 {
- float: left;
-}
-h3 + * {
- clear: left;
-}
-h5 {
- font-size: 1.0em;
-}
-
-div.sectionbody {
- margin-left: 0;
-}
-
-hr {
- border: 1px solid silver;
-}
-
-p {
- margin-top: 0.5em;
- margin-bottom: 0.5em;
-}
-
-ul, ol, li > p {
- margin-top: 0;
-}
-ul > li { color: #aaa; }
-ul > li > * { color: black; }
-
-.monospaced, code, pre {
- font-family: "Courier New", Courier, monospace;
- font-size: inherit;
- color: navy;
- padding: 0;
- margin: 0;
-}
-pre {
- white-space: pre-wrap;
-}
-
-#author {
- color: #527bbd;
- font-weight: bold;
- font-size: 1.1em;
-}
-#email {
-}
-#revnumber, #revdate, #revremark {
-}
-
-#footer {
- font-size: small;
- border-top: 2px solid silver;
- padding-top: 0.5em;
- margin-top: 4.0em;
-}
-#footer-text {
- float: left;
- padding-bottom: 0.5em;
-}
-#footer-badges {
- float: right;
- padding-bottom: 0.5em;
-}
-
-#preamble {
- margin-top: 1.5em;
- margin-bottom: 1.5em;
-}
-div.imageblock, div.exampleblock, div.verseblock,
-div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
-div.admonitionblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-div.admonitionblock {
- margin-top: 2.0em;
- margin-bottom: 2.0em;
- margin-right: 10%;
- color: #606060;
-}
-
-div.content { /* Block element content. */
- padding: 0;
-}
-
-/* Block element titles. */
-div.title, caption.title {
- color: #527bbd;
- font-weight: bold;
- text-align: left;
- margin-top: 1.0em;
- margin-bottom: 0.5em;
-}
-div.title + * {
- margin-top: 0;
-}
-
-td div.title:first-child {
- margin-top: 0.0em;
-}
-div.content div.title:first-child {
- margin-top: 0.0em;
-}
-div.content + div.title {
- margin-top: 0.0em;
-}
-
-div.sidebarblock > div.content {
- background: #ffffee;
- border: 1px solid #dddddd;
- border-left: 4px solid #f0f0f0;
- padding: 0.5em;
-}
-
-div.listingblock > div.content {
- border: 1px solid #dddddd;
- border-left: 5px solid #f0f0f0;
- background: #f8f8f8;
- padding: 0.5em;
-}
-
-div.quoteblock, div.verseblock {
- padding-left: 1.0em;
- margin-left: 1.0em;
- margin-right: 10%;
- border-left: 5px solid #f0f0f0;
- color: #888;
-}
-
-div.quoteblock > div.attribution {
- padding-top: 0.5em;
- text-align: right;
-}
-
-div.verseblock > pre.content {
- font-family: inherit;
- font-size: inherit;
-}
-div.verseblock > div.attribution {
- padding-top: 0.75em;
- text-align: left;
-}
-/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
-div.verseblock + div.attribution {
- text-align: left;
-}
-
-div.admonitionblock .icon {
- vertical-align: top;
- font-size: 1.1em;
- font-weight: bold;
- text-decoration: underline;
- color: #527bbd;
- padding-right: 0.5em;
-}
-div.admonitionblock td.content {
- padding-left: 0.5em;
- border-left: 3px solid #dddddd;
-}
-
-div.exampleblock > div.content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
-}
-
-div.imageblock div.content { padding-left: 0; }
-span.image img { border-style: none; vertical-align: text-bottom; }
-a.image:visited { color: white; }
-
-dl {
- margin-top: 0.8em;
- margin-bottom: 0.8em;
-}
-dt {
- margin-top: 0.5em;
- margin-bottom: 0;
- font-style: normal;
- color: navy;
-}
-dd > *:first-child {
- margin-top: 0.1em;
-}
-
-ul, ol {
- list-style-position: outside;
-}
-ol.arabic {
- list-style-type: decimal;
-}
-ol.loweralpha {
- list-style-type: lower-alpha;
-}
-ol.upperalpha {
- list-style-type: upper-alpha;
-}
-ol.lowerroman {
- list-style-type: lower-roman;
-}
-ol.upperroman {
- list-style-type: upper-roman;
-}
-
-div.compact ul, div.compact ol,
-div.compact p, div.compact p,
-div.compact div, div.compact div {
- margin-top: 0.1em;
- margin-bottom: 0.1em;
-}
-
-tfoot {
- font-weight: bold;
-}
-td > div.verse {
- white-space: pre;
-}
-
-div.hdlist {
- margin-top: 0.8em;
- margin-bottom: 0.8em;
-}
-div.hdlist tr {
- padding-bottom: 15px;
-}
-dt.hdlist1.strong, td.hdlist1.strong {
- font-weight: bold;
-}
-td.hdlist1 {
- vertical-align: top;
- font-style: normal;
- padding-right: 0.8em;
- color: navy;
-}
-td.hdlist2 {
- vertical-align: top;
-}
-div.hdlist.compact tr {
- margin: 0;
- padding-bottom: 0;
-}
-
-.comment {
- background: yellow;
-}
-
-.footnote, .footnoteref {
- font-size: 0.8em;
-}
-
-span.footnote, span.footnoteref {
- vertical-align: super;
-}
-
-#footnotes {
- margin: 20px 0 20px 0;
- padding: 7px 0 0 0;
-}
-
-#footnotes div.footnote {
- margin: 0 0 5px 0;
-}
-
-#footnotes hr {
- border: none;
- border-top: 1px solid silver;
- height: 1px;
- text-align: left;
- margin-left: 0;
- width: 20%;
- min-width: 100px;
-}
-
-div.colist td {
- padding-right: 0.5em;
- padding-bottom: 0.3em;
- vertical-align: top;
-}
-div.colist td img {
- margin-top: 0.3em;
-}
-
-@media print {
- #footer-badges { display: none; }
-}
-
-#toc {
- margin-bottom: 2.5em;
-}
-
-#toctitle {
- color: #527bbd;
- font-size: 1.1em;
- font-weight: bold;
- margin-top: 1.0em;
- margin-bottom: 0.1em;
-}
-
-div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
- margin-top: 0;
- margin-bottom: 0;
-}
-div.toclevel2 {
- margin-left: 2em;
- font-size: 0.9em;
-}
-div.toclevel3 {
- margin-left: 4em;
- font-size: 0.9em;
-}
-div.toclevel4 {
- margin-left: 6em;
- font-size: 0.9em;
-}
-
-span.aqua { color: aqua; }
-span.black { color: black; }
-span.blue { color: blue; }
-span.fuchsia { color: fuchsia; }
-span.gray { color: gray; }
-span.green { color: green; }
-span.lime { color: lime; }
-span.maroon { color: maroon; }
-span.navy { color: navy; }
-span.olive { color: olive; }
-span.purple { color: purple; }
-span.red { color: red; }
-span.silver { color: silver; }
-span.teal { color: teal; }
-span.white { color: white; }
-span.yellow { color: yellow; }
-
-span.aqua-background { background: aqua; }
-span.black-background { background: black; }
-span.blue-background { background: blue; }
-span.fuchsia-background { background: fuchsia; }
-span.gray-background { background: gray; }
-span.green-background { background: green; }
-span.lime-background { background: lime; }
-span.maroon-background { background: maroon; }
-span.navy-background { background: navy; }
-span.olive-background { background: olive; }
-span.purple-background { background: purple; }
-span.red-background { background: red; }
-span.silver-background { background: silver; }
-span.teal-background { background: teal; }
-span.white-background { background: white; }
-span.yellow-background { background: yellow; }
-
-span.big { font-size: 2em; }
-span.small { font-size: 0.6em; }
-
-span.underline { text-decoration: underline; }
-span.overline { text-decoration: overline; }
-span.line-through { text-decoration: line-through; }
-
-div.unbreakable { page-break-inside: avoid; }
-
-
-/*
- * xhtml11 specific
- *
- * */
-
-div.tableblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-div.tableblock > table {
- border: 3px solid #527bbd;
-}
-thead, p.table.header {
- font-weight: bold;
- color: #527bbd;
-}
-p.table {
- margin-top: 0;
-}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
-div.tableblock > table[frame="void"] {
- border-style: none;
-}
-div.tableblock > table[frame="hsides"] {
- border-left-style: none;
- border-right-style: none;
-}
-div.tableblock > table[frame="vsides"] {
- border-top-style: none;
- border-bottom-style: none;
-}
-
-
-/*
- * html5 specific
- *
- * */
-
-table.tableblock {
- margin-top: 1.0em;
- margin-bottom: 1.5em;
-}
-thead, p.tableblock.header {
- font-weight: bold;
- color: #527bbd;
-}
-p.tableblock {
- margin-top: 0;
-}
-table.tableblock {
- border-width: 3px;
- border-spacing: 0px;
- border-style: solid;
- border-color: #527bbd;
- border-collapse: collapse;
-}
-th.tableblock, td.tableblock {
- border-width: 1px;
- padding: 4px;
- border-style: solid;
- border-color: #527bbd;
-}
-
-table.tableblock.frame-topbot {
- border-left-style: hidden;
- border-right-style: hidden;
-}
-table.tableblock.frame-sides {
- border-top-style: hidden;
- border-bottom-style: hidden;
-}
-table.tableblock.frame-none {
- border-style: hidden;
-}
-
-th.tableblock.halign-left, td.tableblock.halign-left {
- text-align: left;
-}
-th.tableblock.halign-center, td.tableblock.halign-center {
- text-align: center;
-}
-th.tableblock.halign-right, td.tableblock.halign-right {
- text-align: right;
-}
-
-th.tableblock.valign-top, td.tableblock.valign-top {
- vertical-align: top;
-}
-th.tableblock.valign-middle, td.tableblock.valign-middle {
- vertical-align: middle;
-}
-th.tableblock.valign-bottom, td.tableblock.valign-bottom {
- vertical-align: bottom;
-}
-
-
-/*
- * manpage specific
- *
- * */
-
-body.manpage h1 {
- padding-top: 0.5em;
- padding-bottom: 0.5em;
- border-top: 2px solid silver;
- border-bottom: 2px solid silver;
-}
-body.manpage h2 {
- border-style: none;
-}
-body.manpage div.sectionbody {
- margin-left: 3em;
-}
-
-@media print {
- body.manpage div#toc { display: none; }
-}
-
-
-</style>
-<script type="text/javascript">
-/*<+'])');
- // Function that scans the DOM tree for header elements (the DOM2
- // nodeIterator API would be a better technique but not supported by all
- // browsers).
- var iterate = function (el) {
- for (var i = el.firstChild; i != null; i = i.nextSibling) {
- if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
- var mo = re.exec(i.tagName);
- if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
- result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
- }
- iterate(i);
- }
- }
- }
- iterate(el);
- return result;
- }
-
- var toc = document.getElementById("toc");
- if (!toc) {
- return;
- }
-
- // Delete existing TOC entries in case we're reloading the TOC.
- var tocEntriesToRemove = [];
- var i;
- for (i = 0; i < toc.childNodes.length; i++) {
- var entry = toc.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div'
- && entry.getAttribute("class")
- && entry.getAttribute("class").match(/^toclevel/))
- tocEntriesToRemove.push(entry);
- }
- for (i = 0; i < tocEntriesToRemove.length; i++) {
- toc.removeChild(tocEntriesToRemove[i]);
- }
-
- // Rebuild TOC entries.
- var entries = tocEntries(document.getElementById("content"), toclevels);
- for (var i = 0; i < entries.length; ++i) {
- var entry = entries[i];
- if (entry.element.id == "")
- entry.element.id = "_toc_" + i;
- var a = document.createElement("a");
- a.href = "#" + entry.element.id;
- a.appendChild(document.createTextNode(entry.text));
- var div = document.createElement("div");
- div.appendChild(a);
- div.className = "toclevel" + entry.toclevel;
- toc.appendChild(div);
- }
- if (entries.length == 0)
- toc.parentNode.removeChild(toc);
-},
-
-
-/////////////////////////////////////////////////////////////////////
-// Footnotes generator
-/////////////////////////////////////////////////////////////////////
-
-/* Based on footnote generation code from:
- * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
- */
-
-footnotes: function () {
- // Delete existing footnote entries in case we're reloading the footnodes.
- var i;
- var noteholder = document.getElementById("footnotes");
- if (!noteholder) {
- return;
- }
- var entriesToRemove = [];
- for (i = 0; i < noteholder.childNodes.length; i++) {
- var entry = noteholder.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
- entriesToRemove.push(entry);
- }
- for (i = 0; i < entriesToRemove.length; i++) {
- noteholder.removeChild(entriesToRemove[i]);
- }
-
- // Rebuild footnote entries.
- var cont = document.getElementById("content");
- var spans = cont.getElementsByTagName("span");
- var refs = {};
- var n = 0;
- for (i=0; i<spans.length; i++) {
- if (spans[i].className == "footnote") {
- n++;
- var note = spans[i].getAttribute("data-note");
- if (!note) {
- // Use [\s\S] in place of . so multi-line matches work.
- // Because JavaScript has no s (dotall) regex flag.
- note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
- spans[i].innerHTML =
- "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
- "' title='View footnote' class='footnote'>" + n + "</a>]";
- spans[i].setAttribute("data-note", note);
- }
- noteholder.innerHTML +=
- "<div class='footnote' id='_footnote_" + n + "'>" +
- "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
- n + "</a>. " + note + "</div>";
- var id =spans[i].getAttribute("id");
- if (id != null) refs["#"+id] = n;
- }
- }
- if (n == 0)
- noteholder.parentNode.removeChild(noteholder);
- else {
- // Process footnoterefs.
- for (i=0; i<spans.length; i++) {
- if (spans[i].className == "footnoteref") {
- var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
- href = href.match(/#.*/)[0]; // Because IE return full URL.
- n = refs[href];
- spans[i].innerHTML =
- "[<a href='#_footnote_" + n +
- "' title='View footnote' class='footnote'>" + n + "</a>]";
- }
- }
- }
-},
-
-install: function(toclevels) {
- var timerId;
-
- function reinstall() {
- asciidoc.footnotes();
- if (toclevels) {
- asciidoc.toc(toclevels);
- }
- }
-
- function reinstallAndRemoveTimer() {
- clearInterval(timerId);
- reinstall();
- }
-
- timerId = setInterval(reinstall, 500);
- if (document.addEventListener)
- document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
- else
- window.onload = reinstallAndRemoveTimer;
-}
-
-}
-asciidoc.install();
-/*]]>*/
-</script>
-</head>
-<body class="manpage">
-<div id="header">
-<h1>
-nvme-sanitize-log(1) Manual Page
-</h1>
-<h2>NAME</h2>
-<div class="sectionbody">
-<p>nvme-sanitize-log -
- Send NVMe sanitize-log Command, return result
-</p>
-</div>
-</div>
-<div id="content">
-<div class="sect1">
-<h2 id="_synopsis">SYNOPSIS</h2>
-<div class="sectionbody">
-<div class="verseblock">
-<pre class="content"><em>nvme sanitize-log</em> <device></pre>
-<div class="attribution">
-</div></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_description">DESCRIPTION</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Retrieves the NVMe Sanitize log page from an NVMe device and provides the
-status of sanitize command.</p></div>
-<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>
-<div class="paragraph"><p>Expected status and description :-</p></div>
-<div class="tableblock">
-<table rules="all"
-width="100%"
-frame="border"
-cellspacing="0" cellpadding="4">
-<col width="50%" />
-<col width="50%" />
-<thead>
-<tr>
-<th align="left" valign="top">Status Code </th>
-<th align="left" valign="top">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td align="left" valign="top"><p class="table">0x0000</p></td>
-<td align="left" valign="top"><p class="table">NVM subsystem has never been sanitized.</p></td>
-</tr>
-<tr>
-<td align="left" valign="top"><p class="table">0x0001</p></td>
-<td align="left" valign="top"><p class="table">The most recent sanitize operation completed successfully.</p></td>
-</tr>
-<tr>
-<td align="left" valign="top"><p class="table">0x0002</p></td>
-<td align="left" valign="top"><p class="table">A sanitize operation is currently in progress.</p></td>
-</tr>
-<tr>
-<td align="left" valign="top"><p class="table">0x0003</p></td>
-<td align="left" valign="top"><p class="table">The most recent sanitize operation failed.</p></td>
-</tr>
-<tr>
-<td align="left" valign="top"><p class="table">0x0100</p></td>
-<td align="left" valign="top"><p class="table">Global Data Erased bit
-If set to 1 then non-volatile storage in the NVM subsystem has
-not been written to:
- a) since being manufactured and the NVM subsystem has never been sanitized; or
- b) since the most recent successful sanitize operation.
-If cleared to 0, then non-volatile storage in the NVM subsystem has been written to:
- a) since being manufactured and the NVM subsystem has never been sanitized; or
- b) since the most recent successful sanitize operation of the NVM subsystem.</p></td>
-</tr>
-</tbody>
-</table>
-</div>
-<div class="paragraph"><p>Sanitize Progress - percentage complete</p></div>
-<div class="paragraph"><p>On success it returns 0, error code otherwise.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_options">OPTIONS</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>No options yet.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_examples">EXAMPLES</h2>
-<div class="sectionbody">
-<div class="ulist"><ul>
-<li>
-<p>
-Has the program issue Sanitize-log Command :
-</p>
-<div class="listingblock">
-<div class="content">
-<pre><code># nvme sanitize-log /dev/nvme0</code></pre>
-</div></div>
-</li>
-</ul></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_nvme">NVME</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Part of the nvme-user suite.</p></div>
-</div>
-</div>
-</div>
-<div id="footnotes"><hr /></div>
-<div id="footer">
-<div id="footer-text">
-Last updated
- 2017-06-28 11:25:21 PDT
-</div>
-</div>
-</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<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.9" />\r
+<title>nvme-sanitize-log(1)</title>\r
+<style type="text/css">\r
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
+\r
+/* Default font. */\r
+body {\r
+ font-family: Georgia,serif;\r
+}\r
+\r
+/* Title font. */\r
+h1, h2, h3, h4, h5, h6,\r
+div.title, caption.title,\r
+thead, p.table.header,\r
+#toctitle,\r
+#author, #revnumber, #revdate, #revremark,\r
+#footer {\r
+ font-family: Arial,Helvetica,sans-serif;\r
+}\r
+\r
+body {\r
+ margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a {\r
+ color: blue;\r
+ text-decoration: underline;\r
+}\r
+a:visited {\r
+ color: fuchsia;\r
+}\r
+\r
+em {\r
+ font-style: italic;\r
+ color: navy;\r
+}\r
+\r
+strong {\r
+ font-weight: bold;\r
+ color: #083194;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+ color: #527bbd;\r
+ margin-top: 1.2em;\r
+ margin-bottom: 0.5em;\r
+ line-height: 1.3;\r
+}\r
+\r
+h1, h2, h3 {\r
+ border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+ padding-top: 0.5em;\r
+}\r
+h3 {\r
+ float: left;\r
+}\r
+h3 + * {\r
+ clear: left;\r
+}\r
+h5 {\r
+ font-size: 1.0em;\r
+}\r
+\r
+div.sectionbody {\r
+ margin-left: 0;\r
+}\r
+\r
+hr {\r
+ border: 1px solid silver;\r
+}\r
+\r
+p {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0.5em;\r
+}\r
+\r
+ul, ol, li > p {\r
+ margin-top: 0;\r
+}\r
+ul > li { color: #aaa; }\r
+ul > li > * { color: black; }\r
+\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
+pre {\r
+ white-space: pre-wrap;\r
+}\r
+\r
+#author {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ font-size: 1.1em;\r
+}\r
+#email {\r
+}\r
+#revnumber, #revdate, #revremark {\r
+}\r
+\r
+#footer {\r
+ font-size: small;\r
+ border-top: 2px solid silver;\r
+ padding-top: 0.5em;\r
+ margin-top: 4.0em;\r
+}\r
+#footer-text {\r
+ float: left;\r
+ padding-bottom: 0.5em;\r
+}\r
+#footer-badges {\r
+ float: right;\r
+ padding-bottom: 0.5em;\r
+}\r
+\r
+#preamble {\r
+ margin-top: 1.5em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+ margin-top: 2.0em;\r
+ margin-bottom: 2.0em;\r
+ margin-right: 10%;\r
+ color: #606060;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+ padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ text-align: left;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+ margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+ margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+ background: #ffffee;\r
+ border: 1px solid #dddddd;\r
+ border-left: 4px solid #f0f0f0;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+ border: 1px solid #dddddd;\r
+ border-left: 5px solid #f0f0f0;\r
+ background: #f8f8f8;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.quoteblock, div.verseblock {\r
+ padding-left: 1.0em;\r
+ margin-left: 1.0em;\r
+ margin-right: 10%;\r
+ border-left: 5px solid #f0f0f0;\r
+ color: #888;\r
+}\r
+\r
+div.quoteblock > div.attribution {\r
+ padding-top: 0.5em;\r
+ text-align: right;\r
+}\r
+\r
+div.verseblock > pre.content {\r
+ font-family: inherit;\r
+ font-size: inherit;\r
+}\r
+div.verseblock > div.attribution {\r
+ padding-top: 0.75em;\r
+ text-align: left;\r
+}\r
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
+div.verseblock + div.attribution {\r
+ text-align: left;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+ vertical-align: top;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ text-decoration: underline;\r
+ color: #527bbd;\r
+ padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+ padding-left: 0.5em;\r
+ border-left: 3px solid #dddddd;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+ border-left: 3px solid #dddddd;\r
+ padding-left: 0.5em;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
+a.image:visited { color: white; }\r
+\r
+dl {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+dt {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0;\r
+ font-style: normal;\r
+ color: navy;\r
+}\r
+dd > *:first-child {\r
+ margin-top: 0.1em;\r
+}\r
+\r
+ul, ol {\r
+ list-style-position: outside;\r
+}\r
+ol.arabic {\r
+ list-style-type: decimal;\r
+}\r
+ol.loweralpha {\r
+ list-style-type: lower-alpha;\r
+}\r
+ol.upperalpha {\r
+ list-style-type: upper-alpha;\r
+}\r
+ol.lowerroman {\r
+ list-style-type: lower-roman;\r
+}\r
+ol.upperroman {\r
+ list-style-type: upper-roman;\r
+}\r
+\r
+div.compact ul, div.compact ol,\r
+div.compact p, div.compact p,\r
+div.compact div, div.compact div {\r
+ margin-top: 0.1em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+tfoot {\r
+ font-weight: bold;\r
+}\r
+td > div.verse {\r
+ white-space: pre;\r
+}\r
+\r
+div.hdlist {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+div.hdlist tr {\r
+ padding-bottom: 15px;\r
+}\r
+dt.hdlist1.strong, td.hdlist1.strong {\r
+ font-weight: bold;\r
+}\r
+td.hdlist1 {\r
+ vertical-align: top;\r
+ font-style: normal;\r
+ padding-right: 0.8em;\r
+ color: navy;\r
+}\r
+td.hdlist2 {\r
+ vertical-align: top;\r
+}\r
+div.hdlist.compact tr {\r
+ margin: 0;\r
+ padding-bottom: 0;\r
+}\r
+\r
+.comment {\r
+ background: yellow;\r
+}\r
+\r
+.footnote, .footnoteref {\r
+ font-size: 0.8em;\r
+}\r
+\r
+span.footnote, span.footnoteref {\r
+ vertical-align: super;\r
+}\r
+\r
+#footnotes {\r
+ margin: 20px 0 20px 0;\r
+ padding: 7px 0 0 0;\r
+}\r
+\r
+#footnotes div.footnote {\r
+ margin: 0 0 5px 0;\r
+}\r
+\r
+#footnotes hr {\r
+ border: none;\r
+ border-top: 1px solid silver;\r
+ height: 1px;\r
+ text-align: left;\r
+ margin-left: 0;\r
+ width: 20%;\r
+ min-width: 100px;\r
+}\r
+\r
+div.colist td {\r
+ padding-right: 0.5em;\r
+ padding-bottom: 0.3em;\r
+ vertical-align: top;\r
+}\r
+div.colist td img {\r
+ margin-top: 0.3em;\r
+}\r
+\r
+@media print {\r
+ #footer-badges { display: none; }\r
+}\r
+\r
+#toc {\r
+ margin-bottom: 2.5em;\r
+}\r
+\r
+#toctitle {\r
+ color: #527bbd;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
+ margin-top: 0;\r
+ margin-bottom: 0;\r
+}\r
+div.toclevel2 {\r
+ margin-left: 2em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel3 {\r
+ margin-left: 4em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel4 {\r
+ margin-left: 6em;\r
+ font-size: 0.9em;\r
+}\r
+\r
+span.aqua { color: aqua; }\r
+span.black { color: black; }\r
+span.blue { color: blue; }\r
+span.fuchsia { color: fuchsia; }\r
+span.gray { color: gray; }\r
+span.green { color: green; }\r
+span.lime { color: lime; }\r
+span.maroon { color: maroon; }\r
+span.navy { color: navy; }\r
+span.olive { color: olive; }\r
+span.purple { color: purple; }\r
+span.red { color: red; }\r
+span.silver { color: silver; }\r
+span.teal { color: teal; }\r
+span.white { color: white; }\r
+span.yellow { color: yellow; }\r
+\r
+span.aqua-background { background: aqua; }\r
+span.black-background { background: black; }\r
+span.blue-background { background: blue; }\r
+span.fuchsia-background { background: fuchsia; }\r
+span.gray-background { background: gray; }\r
+span.green-background { background: green; }\r
+span.lime-background { background: lime; }\r
+span.maroon-background { background: maroon; }\r
+span.navy-background { background: navy; }\r
+span.olive-background { background: olive; }\r
+span.purple-background { background: purple; }\r
+span.red-background { background: red; }\r
+span.silver-background { background: silver; }\r
+span.teal-background { background: teal; }\r
+span.white-background { background: white; }\r
+span.yellow-background { background: yellow; }\r
+\r
+span.big { font-size: 2em; }\r
+span.small { font-size: 0.6em; }\r
+\r
+span.underline { text-decoration: underline; }\r
+span.overline { text-decoration: overline; }\r
+span.line-through { text-decoration: line-through; }\r
+\r
+div.unbreakable { page-break-inside: avoid; }\r
+\r
+\r
+/*\r
+ * xhtml11 specific\r
+ *\r
+ * */\r
+\r
+div.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.tableblock > table {\r
+ border: 3px solid #527bbd;\r
+}\r
+thead, p.table.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.table {\r
+ margin-top: 0;\r
+}\r
+/* Because the table frame attribute is overriden by CSS in most browsers. */\r
+div.tableblock > table[frame="void"] {\r
+ border-style: none;\r
+}\r
+div.tableblock > table[frame="hsides"] {\r
+ border-left-style: none;\r
+ border-right-style: none;\r
+}\r
+div.tableblock > table[frame="vsides"] {\r
+ border-top-style: none;\r
+ border-bottom-style: none;\r
+}\r
+\r
+\r
+/*\r
+ * html5 specific\r
+ *\r
+ * */\r
+\r
+table.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+thead, p.tableblock.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.tableblock {\r
+ margin-top: 0;\r
+}\r
+table.tableblock {\r
+ border-width: 3px;\r
+ border-spacing: 0px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+ border-collapse: collapse;\r
+}\r
+th.tableblock, td.tableblock {\r
+ border-width: 1px;\r
+ padding: 4px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+}\r
+\r
+table.tableblock.frame-topbot {\r
+ border-left-style: hidden;\r
+ border-right-style: hidden;\r
+}\r
+table.tableblock.frame-sides {\r
+ border-top-style: hidden;\r
+ border-bottom-style: hidden;\r
+}\r
+table.tableblock.frame-none {\r
+ border-style: hidden;\r
+}\r
+\r
+th.tableblock.halign-left, td.tableblock.halign-left {\r
+ text-align: left;\r
+}\r
+th.tableblock.halign-center, td.tableblock.halign-center {\r
+ text-align: center;\r
+}\r
+th.tableblock.halign-right, td.tableblock.halign-right {\r
+ text-align: right;\r
+}\r
+\r
+th.tableblock.valign-top, td.tableblock.valign-top {\r
+ vertical-align: top;\r
+}\r
+th.tableblock.valign-middle, td.tableblock.valign-middle {\r
+ vertical-align: middle;\r
+}\r
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
+ vertical-align: bottom;\r
+}\r
+\r
+\r
+/*\r
+ * manpage specific\r
+ *\r
+ * */\r
+\r
+body.manpage h1 {\r
+ padding-top: 0.5em;\r
+ padding-bottom: 0.5em;\r
+ border-top: 2px solid silver;\r
+ border-bottom: 2px solid silver;\r
+}\r
+body.manpage h2 {\r
+ border-style: none;\r
+}\r
+body.manpage div.sectionbody {\r
+ margin-left: 3em;\r
+}\r
+\r
+@media print {\r
+ body.manpage div#toc { display: none; }\r
+}\r
+\r
+\r
+</style>\r
+<script type="text/javascript">\r
+/*<+'])');\r
+ // Function that scans the DOM tree for header elements (the DOM2\r
+ // nodeIterator API would be a better technique but not supported by all\r
+ // browsers).\r
+ var iterate = function (el) {\r
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
+ var mo = re.exec(i.tagName);\r
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
+ }\r
+ iterate(i);\r
+ }\r
+ }\r
+ }\r
+ iterate(el);\r
+ return result;\r
+ }\r
+\r
+ var toc = document.getElementById("toc");\r
+ if (!toc) {\r
+ return;\r
+ }\r
+\r
+ // Delete existing TOC entries in case we're reloading the TOC.\r
+ var tocEntriesToRemove = [];\r
+ var i;\r
+ for (i = 0; i < toc.childNodes.length; i++) {\r
+ var entry = toc.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div'\r
+ && entry.getAttribute("class")\r
+ && entry.getAttribute("class").match(/^toclevel/))\r
+ tocEntriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < tocEntriesToRemove.length; i++) {\r
+ toc.removeChild(tocEntriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild TOC entries.\r
+ var entries = tocEntries(document.getElementById("content"), toclevels);\r
+ for (var i = 0; i < entries.length; ++i) {\r
+ var entry = entries[i];\r
+ if (entry.element.id == "")\r
+ entry.element.id = "_toc_" + i;\r
+ var a = document.createElement("a");\r
+ a.href = "#" + entry.element.id;\r
+ a.appendChild(document.createTextNode(entry.text));\r
+ var div = document.createElement("div");\r
+ div.appendChild(a);\r
+ div.className = "toclevel" + entry.toclevel;\r
+ toc.appendChild(div);\r
+ }\r
+ if (entries.length == 0)\r
+ toc.parentNode.removeChild(toc);\r
+},\r
+\r
+\r
+/////////////////////////////////////////////////////////////////////\r
+// Footnotes generator\r
+/////////////////////////////////////////////////////////////////////\r
+\r
+/* Based on footnote generation code from:\r
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
+ */\r
+\r
+footnotes: function () {\r
+ // Delete existing footnote entries in case we're reloading the footnodes.\r
+ var i;\r
+ var noteholder = document.getElementById("footnotes");\r
+ if (!noteholder) {\r
+ return;\r
+ }\r
+ var entriesToRemove = [];\r
+ for (i = 0; i < noteholder.childNodes.length; i++) {\r
+ var entry = noteholder.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
+ entriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < entriesToRemove.length; i++) {\r
+ noteholder.removeChild(entriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild footnote entries.\r
+ var cont = document.getElementById("content");\r
+ var spans = cont.getElementsByTagName("span");\r
+ var refs = {};\r
+ var n = 0;\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnote") {\r
+ n++;\r
+ var note = spans[i].getAttribute("data-note");\r
+ if (!note) {\r
+ // Use [\s\S] in place of . so multi-line matches work.\r
+ // Because JavaScript has no s (dotall) regex flag.\r
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
+ spans[i].innerHTML =\r
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ spans[i].setAttribute("data-note", note);\r
+ }\r
+ noteholder.innerHTML +=\r
+ "<div class='footnote' id='_footnote_" + n + "'>" +\r
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
+ n + "</a>. " + note + "</div>";\r
+ var id =spans[i].getAttribute("id");\r
+ if (id != null) refs["#"+id] = n;\r
+ }\r
+ }\r
+ if (n == 0)\r
+ noteholder.parentNode.removeChild(noteholder);\r
+ else {\r
+ // Process footnoterefs.\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnoteref") {\r
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
+ href = href.match(/#.*/)[0]; // Because IE return full URL.\r
+ n = refs[href];\r
+ spans[i].innerHTML =\r
+ "[<a href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ }\r
+ }\r
+ }\r
+},\r
+\r
+install: function(toclevels) {\r
+ var timerId;\r
+\r
+ function reinstall() {\r
+ asciidoc.footnotes();\r
+ if (toclevels) {\r
+ asciidoc.toc(toclevels);\r
+ }\r
+ }\r
+\r
+ function reinstallAndRemoveTimer() {\r
+ clearInterval(timerId);\r
+ reinstall();\r
+ }\r
+\r
+ timerId = setInterval(reinstall, 500);\r
+ if (document.addEventListener)\r
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
+ else\r
+ window.onload = reinstallAndRemoveTimer;\r
+}\r
+\r
+}\r
+asciidoc.install();\r
+/*]]>*/\r
+</script>\r
+</head>\r
+<body class="manpage">\r
+<div id="header">\r
+<h1>\r
+nvme-sanitize-log(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>nvme-sanitize-log -\r
+ Send NVMe sanitize-log Command, return result\r
+</p>\r
+</div>\r
+</div>\r
+<div id="content">\r
+<div class="sect1">\r
+<h2 id="_synopsis">SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="verseblock">\r
+<pre class="content"><em>nvme sanitize-log</em> <device> [--output-format=<fmt> | -o <fmt>]\r
+ [--human-readable | -H]\r
+ [--raw-binary | -b]</pre>\r
+<div class="attribution">\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Retrieves the NVMe Sanitize log page from an NVMe device and provides the\r
+status of sanitize command.</p></div>\r
+<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>\r
+<div class="paragraph"><p>Expected status and description :-</p></div>\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
+<thead>\r
+<tr>\r
+<th align="left" valign="top">Status Code </th>\r
+<th align="left" valign="top">Description</th>\r
+</tr>\r
+</thead>\r
+<tbody>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0x0000</p></td>\r
+<td align="left" valign="top"><p class="table">NVM subsystem has never been sanitized.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0x0001</p></td>\r
+<td align="left" valign="top"><p class="table">The most recent sanitize operation completed successfully.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0x0002</p></td>\r
+<td align="left" valign="top"><p class="table">A sanitize operation is currently in progress.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0x0003</p></td>\r
+<td align="left" valign="top"><p class="table">The most recent sanitize operation failed.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">0x0100</p></td>\r
+<td align="left" valign="top"><p class="table">Global Data Erased bit\r
+If set to 1 then non-volatile storage in the NVM subsystem has\r
+not been written to:\r
+ a) since being manufactured and the NVM subsystem has never been sanitized; or\r
+ b) since the most recent successful sanitize operation.\r
+If cleared to 0, then non-volatile storage in the NVM subsystem has been written to:\r
+ a) since being manufactured and the NVM subsystem has never been sanitized; or\r
+ b) since the most recent successful sanitize operation of the NVM subsystem.</p></td>\r
+</tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="paragraph"><p>Sanitize Progress - percentage complete</p></div>\r
+<div class="paragraph"><p>On success it returns 0, error code otherwise.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <format>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<format>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-H\r
+</dt>\r
+<dt class="hdlist1">\r
+--human-readable\r
+</dt>\r
+<dd>\r
+<p>\r
+ This option will parse and format many of the bit fields\r
+ into human-readable formats.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-b\r
+</dt>\r
+<dt class="hdlist1">\r
+--raw-binary\r
+</dt>\r
+<dd>\r
+<p>\r
+ Print the raw buffer to stdout. Structure is not parsed by\r
+ program. This overrides the vendor specific and human readable options.\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="ulist"><ul>\r
+<li>\r
+<p>\r
+Has the program issue Sanitize-log Command :\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme sanitize-log /dev/nvme0</code></pre>\r
+</div></div>\r
+</li>\r
+</ul></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_nvme">NVME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Part of the nvme-user suite.</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
SYNOPSIS
--------
[verse]
-'nvme sanitize-log' <device>
+'nvme sanitize-log' <device> [--output-format=<fmt> | -o <fmt>]
+ [--human-readable | -H]
+ [--raw-binary | -b]
DESCRIPTION
-----------
OPTIONS
-------
-No options yet.
+-o <format>::
+--output-format=<format>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
+
+-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.
EXAMPLES
--------
.\" Title: nvme-security-recv
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SECURITY\-RECV" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-RECV" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme security\-recv\fR [<device>] [\-\-size=<size> | \-x <size>]
+\fInvme security\-recv\fR <device> [\-\-size=<size> | \-x <size>]
[\-\-secp=<security\-protocol> | \-p <security\-protocol>]
[\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
[\-\-nssf=<nvme\-specific> | \-N <nvme\-specific>]
- [\-\-tl=<transfer\-length> | \-t <transfer\-length>]
+ [\-\-al=<allocation\-length> | \-t <allocation\-length>]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-b | \-\-raw\-binary]
+ [\-\-raw\-binary | \-b]
.fi
.SH "DESCRIPTION"
.sp
SP Specific: The value of this field is specific to the Security Protocol as defined in SPC\-4\&.
.RE
.PP
-\-
a <allocation\-length>, \-\-al=<allocation\-length>
+\-
t <allocation\-length>, \-\-al=<allocation\-length>
.RS 4
Allocation Length: The value of this field is specific to the Security Protocol as defined in SPC\-4\&.
.RE
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-security-recv(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme security-recv</em> [<device>] [--size=<size> | -x <size>]\r
+<pre class="content"><em>nvme security-recv</em> <device> [--size=<size> | -x <size>]\r
[--secp=<security-protocol> | -p <security-protocol>]\r
[--spsp=<protocol-specific> | -s <protocol-specific>]\r
[--nssf=<nvme-specific> | -N <nvme-specific>]\r
- [--tl=<transfer-length> | -t <transfer-length>]\r
+ [--al=<allocation-length> | -t <allocation-length>]\r
[--namespace-id=<nsid> | -n <nsid>]\r
- [-b | --raw-binary]</pre>\r
+ [--raw-binary | -b]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--a <allocation-length>\r
+-t <allocation-length>\r
</dt>\r
<dt class="hdlist1">\r
--al=<allocation-length>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme security-recv' [<device>] [--size=<size> | -x <size>]
+'nvme security-recv' <device> [--size=<size> | -x <size>]
[--secp=<security-protocol> | -p <security-protocol>]
[--spsp=<protocol-specific> | -s <protocol-specific>]
[--nssf=<nvme-specific> | -N <nvme-specific>]
- [--tl=<transfer-length> | -t <transfer-length>]
+ [--al=<allocation-length> | -t <allocation-length>]
[--namespace-id=<nsid> | -n <nsid>]
- [-b | --raw-binary]
+ [--raw-binary | -b]
DESCRIPTION
-----------
SP Specific: The value of this field is specific to the Security
Protocol as defined in SPC-4.
--
a <allocation-length>::
+-
t <allocation-length>::
--al=<allocation-length>::
Allocation Length: The value of this field is specific to the
Security Protocol as defined in SPC-4.
.\" Title: nvme-security-send
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SECURITY\-SEND" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-SEND" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme security\-send\fR [<device>] [\-\-file=<file> | \-f <file>]
+\fInvme security\-send\fR <device> [\-\-file=<file> | \-f <file>]
[\-\-secp=<security\-protocol> | \-p <security\-protocol>]
[\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
[\-\-tl=<transfer\-length> | \-t <transfer\-length>]
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-security-send(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme security-send</em> [<device>] [--file=<file> | -f <file>]\r
+<pre class="content"><em>nvme security-send</em> <device> [--file=<file> | -f <file>]\r
[--secp=<security-protocol> | -p <security-protocol>]\r
[--spsp=<protocol-specific> | -s <protocol-specific>]\r
[--tl=<transfer-length> | -t <transfer-length>]\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2016-05-16 12:47:42 EDT\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme security-send' [<device>] [--file=<file> | -f <file>]
+'nvme security-send' <device> [--file=<file> | -f <file>]
[--secp=<security-protocol> | -p <security-protocol>]
[--spsp=<protocol-specific> | -s <protocol-specific>]
[--tl=<transfer-length> | -t <transfer-length>]
--- /dev/null
+'\" t
+.\" Title: nvme-telemetry-log
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 01/30/2018
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-TELEMETRY\-LOG" "1" "01/30/2018" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-telemetry-log \- Retrieves a Telemetry Host\-Initiated log page from an NVMe device
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme telemetry\-log\fR <device> [\-\-output\-file=<file> | \-o <file>]
+ [\-\-host\-generate=<gen> | \-h <gen>]
+.fi
+.SH "DESCRIPTION"
+.sp
+Retrieves an Telemetry Host\-Initiated log page from an NVMe device and provides the retuned structure\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
+.sp
+On success, the returned log structure will be in raw binary format \fIonly\fR with \-\-output\-file option which is mandatory\&.
+.SH "OPTIONS"
+.PP
+\-o <file>, \-\-output\-file=<file>
+.RS 4
+File name to which raw binary data will be saved to\&.
+.RE
+.PP
+\-h <gen>, \-\-host\-generate=<gen>
+.RS 4
+If set to 1, controller shall capture the Telemetry Host\-Initiated data representing the internal state of the controller at the time the associated Get Log Page command is processed\&. If cleated to 0, controller shall
+\fInot\fR
+update this data\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Retrieve Telemetry Host\-Initiated data to telemetry_log\&.bin
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme telemetry\-log /dev/nvme0 \-\-output\-file=telemetry_log\&.bin
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<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.9" />\r
+<title>nvme-telemetry-log(1)</title>\r
+<style type="text/css">\r
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
+\r
+/* Default font. */\r
+body {\r
+ font-family: Georgia,serif;\r
+}\r
+\r
+/* Title font. */\r
+h1, h2, h3, h4, h5, h6,\r
+div.title, caption.title,\r
+thead, p.table.header,\r
+#toctitle,\r
+#author, #revnumber, #revdate, #revremark,\r
+#footer {\r
+ font-family: Arial,Helvetica,sans-serif;\r
+}\r
+\r
+body {\r
+ margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a {\r
+ color: blue;\r
+ text-decoration: underline;\r
+}\r
+a:visited {\r
+ color: fuchsia;\r
+}\r
+\r
+em {\r
+ font-style: italic;\r
+ color: navy;\r
+}\r
+\r
+strong {\r
+ font-weight: bold;\r
+ color: #083194;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+ color: #527bbd;\r
+ margin-top: 1.2em;\r
+ margin-bottom: 0.5em;\r
+ line-height: 1.3;\r
+}\r
+\r
+h1, h2, h3 {\r
+ border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+ padding-top: 0.5em;\r
+}\r
+h3 {\r
+ float: left;\r
+}\r
+h3 + * {\r
+ clear: left;\r
+}\r
+h5 {\r
+ font-size: 1.0em;\r
+}\r
+\r
+div.sectionbody {\r
+ margin-left: 0;\r
+}\r
+\r
+hr {\r
+ border: 1px solid silver;\r
+}\r
+\r
+p {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0.5em;\r
+}\r
+\r
+ul, ol, li > p {\r
+ margin-top: 0;\r
+}\r
+ul > li { color: #aaa; }\r
+ul > li > * { color: black; }\r
+\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
+pre {\r
+ white-space: pre-wrap;\r
+}\r
+\r
+#author {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ font-size: 1.1em;\r
+}\r
+#email {\r
+}\r
+#revnumber, #revdate, #revremark {\r
+}\r
+\r
+#footer {\r
+ font-size: small;\r
+ border-top: 2px solid silver;\r
+ padding-top: 0.5em;\r
+ margin-top: 4.0em;\r
+}\r
+#footer-text {\r
+ float: left;\r
+ padding-bottom: 0.5em;\r
+}\r
+#footer-badges {\r
+ float: right;\r
+ padding-bottom: 0.5em;\r
+}\r
+\r
+#preamble {\r
+ margin-top: 1.5em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+ margin-top: 2.0em;\r
+ margin-bottom: 2.0em;\r
+ margin-right: 10%;\r
+ color: #606060;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+ padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+ color: #527bbd;\r
+ font-weight: bold;\r
+ text-align: left;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+ margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+ margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+ margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+ background: #ffffee;\r
+ border: 1px solid #dddddd;\r
+ border-left: 4px solid #f0f0f0;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+ border: 1px solid #dddddd;\r
+ border-left: 5px solid #f0f0f0;\r
+ background: #f8f8f8;\r
+ padding: 0.5em;\r
+}\r
+\r
+div.quoteblock, div.verseblock {\r
+ padding-left: 1.0em;\r
+ margin-left: 1.0em;\r
+ margin-right: 10%;\r
+ border-left: 5px solid #f0f0f0;\r
+ color: #888;\r
+}\r
+\r
+div.quoteblock > div.attribution {\r
+ padding-top: 0.5em;\r
+ text-align: right;\r
+}\r
+\r
+div.verseblock > pre.content {\r
+ font-family: inherit;\r
+ font-size: inherit;\r
+}\r
+div.verseblock > div.attribution {\r
+ padding-top: 0.75em;\r
+ text-align: left;\r
+}\r
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
+div.verseblock + div.attribution {\r
+ text-align: left;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+ vertical-align: top;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ text-decoration: underline;\r
+ color: #527bbd;\r
+ padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+ padding-left: 0.5em;\r
+ border-left: 3px solid #dddddd;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+ border-left: 3px solid #dddddd;\r
+ padding-left: 0.5em;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
+a.image:visited { color: white; }\r
+\r
+dl {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+dt {\r
+ margin-top: 0.5em;\r
+ margin-bottom: 0;\r
+ font-style: normal;\r
+ color: navy;\r
+}\r
+dd > *:first-child {\r
+ margin-top: 0.1em;\r
+}\r
+\r
+ul, ol {\r
+ list-style-position: outside;\r
+}\r
+ol.arabic {\r
+ list-style-type: decimal;\r
+}\r
+ol.loweralpha {\r
+ list-style-type: lower-alpha;\r
+}\r
+ol.upperalpha {\r
+ list-style-type: upper-alpha;\r
+}\r
+ol.lowerroman {\r
+ list-style-type: lower-roman;\r
+}\r
+ol.upperroman {\r
+ list-style-type: upper-roman;\r
+}\r
+\r
+div.compact ul, div.compact ol,\r
+div.compact p, div.compact p,\r
+div.compact div, div.compact div {\r
+ margin-top: 0.1em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+tfoot {\r
+ font-weight: bold;\r
+}\r
+td > div.verse {\r
+ white-space: pre;\r
+}\r
+\r
+div.hdlist {\r
+ margin-top: 0.8em;\r
+ margin-bottom: 0.8em;\r
+}\r
+div.hdlist tr {\r
+ padding-bottom: 15px;\r
+}\r
+dt.hdlist1.strong, td.hdlist1.strong {\r
+ font-weight: bold;\r
+}\r
+td.hdlist1 {\r
+ vertical-align: top;\r
+ font-style: normal;\r
+ padding-right: 0.8em;\r
+ color: navy;\r
+}\r
+td.hdlist2 {\r
+ vertical-align: top;\r
+}\r
+div.hdlist.compact tr {\r
+ margin: 0;\r
+ padding-bottom: 0;\r
+}\r
+\r
+.comment {\r
+ background: yellow;\r
+}\r
+\r
+.footnote, .footnoteref {\r
+ font-size: 0.8em;\r
+}\r
+\r
+span.footnote, span.footnoteref {\r
+ vertical-align: super;\r
+}\r
+\r
+#footnotes {\r
+ margin: 20px 0 20px 0;\r
+ padding: 7px 0 0 0;\r
+}\r
+\r
+#footnotes div.footnote {\r
+ margin: 0 0 5px 0;\r
+}\r
+\r
+#footnotes hr {\r
+ border: none;\r
+ border-top: 1px solid silver;\r
+ height: 1px;\r
+ text-align: left;\r
+ margin-left: 0;\r
+ width: 20%;\r
+ min-width: 100px;\r
+}\r
+\r
+div.colist td {\r
+ padding-right: 0.5em;\r
+ padding-bottom: 0.3em;\r
+ vertical-align: top;\r
+}\r
+div.colist td img {\r
+ margin-top: 0.3em;\r
+}\r
+\r
+@media print {\r
+ #footer-badges { display: none; }\r
+}\r
+\r
+#toc {\r
+ margin-bottom: 2.5em;\r
+}\r
+\r
+#toctitle {\r
+ color: #527bbd;\r
+ font-size: 1.1em;\r
+ font-weight: bold;\r
+ margin-top: 1.0em;\r
+ margin-bottom: 0.1em;\r
+}\r
+\r
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
+ margin-top: 0;\r
+ margin-bottom: 0;\r
+}\r
+div.toclevel2 {\r
+ margin-left: 2em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel3 {\r
+ margin-left: 4em;\r
+ font-size: 0.9em;\r
+}\r
+div.toclevel4 {\r
+ margin-left: 6em;\r
+ font-size: 0.9em;\r
+}\r
+\r
+span.aqua { color: aqua; }\r
+span.black { color: black; }\r
+span.blue { color: blue; }\r
+span.fuchsia { color: fuchsia; }\r
+span.gray { color: gray; }\r
+span.green { color: green; }\r
+span.lime { color: lime; }\r
+span.maroon { color: maroon; }\r
+span.navy { color: navy; }\r
+span.olive { color: olive; }\r
+span.purple { color: purple; }\r
+span.red { color: red; }\r
+span.silver { color: silver; }\r
+span.teal { color: teal; }\r
+span.white { color: white; }\r
+span.yellow { color: yellow; }\r
+\r
+span.aqua-background { background: aqua; }\r
+span.black-background { background: black; }\r
+span.blue-background { background: blue; }\r
+span.fuchsia-background { background: fuchsia; }\r
+span.gray-background { background: gray; }\r
+span.green-background { background: green; }\r
+span.lime-background { background: lime; }\r
+span.maroon-background { background: maroon; }\r
+span.navy-background { background: navy; }\r
+span.olive-background { background: olive; }\r
+span.purple-background { background: purple; }\r
+span.red-background { background: red; }\r
+span.silver-background { background: silver; }\r
+span.teal-background { background: teal; }\r
+span.white-background { background: white; }\r
+span.yellow-background { background: yellow; }\r
+\r
+span.big { font-size: 2em; }\r
+span.small { font-size: 0.6em; }\r
+\r
+span.underline { text-decoration: underline; }\r
+span.overline { text-decoration: overline; }\r
+span.line-through { text-decoration: line-through; }\r
+\r
+div.unbreakable { page-break-inside: avoid; }\r
+\r
+\r
+/*\r
+ * xhtml11 specific\r
+ *\r
+ * */\r
+\r
+div.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+div.tableblock > table {\r
+ border: 3px solid #527bbd;\r
+}\r
+thead, p.table.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.table {\r
+ margin-top: 0;\r
+}\r
+/* Because the table frame attribute is overriden by CSS in most browsers. */\r
+div.tableblock > table[frame="void"] {\r
+ border-style: none;\r
+}\r
+div.tableblock > table[frame="hsides"] {\r
+ border-left-style: none;\r
+ border-right-style: none;\r
+}\r
+div.tableblock > table[frame="vsides"] {\r
+ border-top-style: none;\r
+ border-bottom-style: none;\r
+}\r
+\r
+\r
+/*\r
+ * html5 specific\r
+ *\r
+ * */\r
+\r
+table.tableblock {\r
+ margin-top: 1.0em;\r
+ margin-bottom: 1.5em;\r
+}\r
+thead, p.tableblock.header {\r
+ font-weight: bold;\r
+ color: #527bbd;\r
+}\r
+p.tableblock {\r
+ margin-top: 0;\r
+}\r
+table.tableblock {\r
+ border-width: 3px;\r
+ border-spacing: 0px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+ border-collapse: collapse;\r
+}\r
+th.tableblock, td.tableblock {\r
+ border-width: 1px;\r
+ padding: 4px;\r
+ border-style: solid;\r
+ border-color: #527bbd;\r
+}\r
+\r
+table.tableblock.frame-topbot {\r
+ border-left-style: hidden;\r
+ border-right-style: hidden;\r
+}\r
+table.tableblock.frame-sides {\r
+ border-top-style: hidden;\r
+ border-bottom-style: hidden;\r
+}\r
+table.tableblock.frame-none {\r
+ border-style: hidden;\r
+}\r
+\r
+th.tableblock.halign-left, td.tableblock.halign-left {\r
+ text-align: left;\r
+}\r
+th.tableblock.halign-center, td.tableblock.halign-center {\r
+ text-align: center;\r
+}\r
+th.tableblock.halign-right, td.tableblock.halign-right {\r
+ text-align: right;\r
+}\r
+\r
+th.tableblock.valign-top, td.tableblock.valign-top {\r
+ vertical-align: top;\r
+}\r
+th.tableblock.valign-middle, td.tableblock.valign-middle {\r
+ vertical-align: middle;\r
+}\r
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
+ vertical-align: bottom;\r
+}\r
+\r
+\r
+/*\r
+ * manpage specific\r
+ *\r
+ * */\r
+\r
+body.manpage h1 {\r
+ padding-top: 0.5em;\r
+ padding-bottom: 0.5em;\r
+ border-top: 2px solid silver;\r
+ border-bottom: 2px solid silver;\r
+}\r
+body.manpage h2 {\r
+ border-style: none;\r
+}\r
+body.manpage div.sectionbody {\r
+ margin-left: 3em;\r
+}\r
+\r
+@media print {\r
+ body.manpage div#toc { display: none; }\r
+}\r
+\r
+\r
+</style>\r
+<script type="text/javascript">\r
+/*<+'])');\r
+ // Function that scans the DOM tree for header elements (the DOM2\r
+ // nodeIterator API would be a better technique but not supported by all\r
+ // browsers).\r
+ var iterate = function (el) {\r
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
+ var mo = re.exec(i.tagName);\r
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
+ }\r
+ iterate(i);\r
+ }\r
+ }\r
+ }\r
+ iterate(el);\r
+ return result;\r
+ }\r
+\r
+ var toc = document.getElementById("toc");\r
+ if (!toc) {\r
+ return;\r
+ }\r
+\r
+ // Delete existing TOC entries in case we're reloading the TOC.\r
+ var tocEntriesToRemove = [];\r
+ var i;\r
+ for (i = 0; i < toc.childNodes.length; i++) {\r
+ var entry = toc.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div'\r
+ && entry.getAttribute("class")\r
+ && entry.getAttribute("class").match(/^toclevel/))\r
+ tocEntriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < tocEntriesToRemove.length; i++) {\r
+ toc.removeChild(tocEntriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild TOC entries.\r
+ var entries = tocEntries(document.getElementById("content"), toclevels);\r
+ for (var i = 0; i < entries.length; ++i) {\r
+ var entry = entries[i];\r
+ if (entry.element.id == "")\r
+ entry.element.id = "_toc_" + i;\r
+ var a = document.createElement("a");\r
+ a.href = "#" + entry.element.id;\r
+ a.appendChild(document.createTextNode(entry.text));\r
+ var div = document.createElement("div");\r
+ div.appendChild(a);\r
+ div.className = "toclevel" + entry.toclevel;\r
+ toc.appendChild(div);\r
+ }\r
+ if (entries.length == 0)\r
+ toc.parentNode.removeChild(toc);\r
+},\r
+\r
+\r
+/////////////////////////////////////////////////////////////////////\r
+// Footnotes generator\r
+/////////////////////////////////////////////////////////////////////\r
+\r
+/* Based on footnote generation code from:\r
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
+ */\r
+\r
+footnotes: function () {\r
+ // Delete existing footnote entries in case we're reloading the footnodes.\r
+ var i;\r
+ var noteholder = document.getElementById("footnotes");\r
+ if (!noteholder) {\r
+ return;\r
+ }\r
+ var entriesToRemove = [];\r
+ for (i = 0; i < noteholder.childNodes.length; i++) {\r
+ var entry = noteholder.childNodes[i];\r
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
+ entriesToRemove.push(entry);\r
+ }\r
+ for (i = 0; i < entriesToRemove.length; i++) {\r
+ noteholder.removeChild(entriesToRemove[i]);\r
+ }\r
+\r
+ // Rebuild footnote entries.\r
+ var cont = document.getElementById("content");\r
+ var spans = cont.getElementsByTagName("span");\r
+ var refs = {};\r
+ var n = 0;\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnote") {\r
+ n++;\r
+ var note = spans[i].getAttribute("data-note");\r
+ if (!note) {\r
+ // Use [\s\S] in place of . so multi-line matches work.\r
+ // Because JavaScript has no s (dotall) regex flag.\r
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
+ spans[i].innerHTML =\r
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ spans[i].setAttribute("data-note", note);\r
+ }\r
+ noteholder.innerHTML +=\r
+ "<div class='footnote' id='_footnote_" + n + "'>" +\r
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
+ n + "</a>. " + note + "</div>";\r
+ var id =spans[i].getAttribute("id");\r
+ if (id != null) refs["#"+id] = n;\r
+ }\r
+ }\r
+ if (n == 0)\r
+ noteholder.parentNode.removeChild(noteholder);\r
+ else {\r
+ // Process footnoterefs.\r
+ for (i=0; i<spans.length; i++) {\r
+ if (spans[i].className == "footnoteref") {\r
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
+ href = href.match(/#.*/)[0]; // Because IE return full URL.\r
+ n = refs[href];\r
+ spans[i].innerHTML =\r
+ "[<a href='#_footnote_" + n +\r
+ "' title='View footnote' class='footnote'>" + n + "</a>]";\r
+ }\r
+ }\r
+ }\r
+},\r
+\r
+install: function(toclevels) {\r
+ var timerId;\r
+\r
+ function reinstall() {\r
+ asciidoc.footnotes();\r
+ if (toclevels) {\r
+ asciidoc.toc(toclevels);\r
+ }\r
+ }\r
+\r
+ function reinstallAndRemoveTimer() {\r
+ clearInterval(timerId);\r
+ reinstall();\r
+ }\r
+\r
+ timerId = setInterval(reinstall, 500);\r
+ if (document.addEventListener)\r
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
+ else\r
+ window.onload = reinstallAndRemoveTimer;\r
+}\r
+\r
+}\r
+asciidoc.install();\r
+/*]]>*/\r
+</script>\r
+</head>\r
+<body class="manpage">\r
+<div id="header">\r
+<h1>\r
+nvme-telemetry-log(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>nvme-telemetry-log -\r
+ Retrieves a Telemetry Host-Initiated log page from an NVMe device\r
+</p>\r
+</div>\r
+</div>\r
+<div id="content">\r
+<div class="sect1">\r
+<h2 id="_synopsis">SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="verseblock">\r
+<pre class="content"><em>nvme telemetry-log</em> <device> [--output-file=<file> | -o <file>]\r
+ [--host-generate=<gen> | -h <gen>]</pre>\r
+<div class="attribution">\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Retrieves an Telemetry Host-Initiated log page from an NVMe device and provides\r
+the retuned structure.</p></div>\r
+<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>\r
+<div class="paragraph"><p>On success, the returned log structure will be in raw binary format <em>only</em> with\r
+--output-file option which is mandatory.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <file>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-file=<file>\r
+</dt>\r
+<dd>\r
+<p>\r
+ File name to which raw binary data will be saved to.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-h <gen>\r
+</dt>\r
+<dt class="hdlist1">\r
+--host-generate=<gen>\r
+</dt>\r
+<dd>\r
+<p>\r
+ If set to 1, controller shall capture the Telemetry Host-Initiated data\r
+ representing the internal state of the controller at the time the\r
+ associated Get Log Page command is processed.\r
+ If cleated to 0, controller shall <em>not</em> update this data.\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="ulist"><ul>\r
+<li>\r
+<p>\r
+Retrieve Telemetry Host-Initiated data to telemetry_log.bin\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme telemetry-log /dev/nvme0 --output-file=telemetry_log.bin</code></pre>\r
+</div></div>\r
+</li>\r
+</ul></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_nvme">NVME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Part of the nvme-user suite</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
--- /dev/null
+nvme-telemetry-log(1)
+=====================
+
+NAME
+----
+nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe device
+
+SYNOPSIS
+--------
+[verse]
+'nvme telemetry-log' <device> [--output-file=<file> | -o <file>]
+ [--host-generate=<gen> | -h <gen>]
+
+DESCRIPTION
+-----------
+Retrieves an Telemetry Host-Initiated log page from an NVMe device and provides
+the retuned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the returned log structure will be in raw binary format _only_ with
+--output-file option which is mandatory.
+
+OPTIONS
+-------
+-o <file>::
+--output-file=<file>::
+ File name to which raw binary data will be saved to.
+
+-h <gen>::
+--host-generate=<gen>::
+ If set to 1, controller shall capture the Telemetry Host-Initiated data
+ representing the internal state of the controller at the time the
+ associated Get Log Page command is processed.
+ If cleated to 0, controller shall _not_ update this data.
+
+EXAMPLES
+--------
+* Retrieve Telemetry Host-Initiated data to telemetry_log.bin
++
+------------
+# nvme telemetry-log /dev/nvme0 --output-file=telemetry_log.bin
+------------
+
+NVME
+----
+Part of the nvme-user suite
.\" Title: nvme-wdc-id-ctrl
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-ID\-CTRL" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-ID\-CTRL" "1" "01/30/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme wdc id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
+ [\-H | \-\-human\-readable]
[\-o <fmt> | \-\-output\-format=<fmt>]
.fi
.SH "DESCRIPTION"
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-wdc-id-ctrl(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme wdc id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
+ [-H | --human-readable]\r
[-o <fmt> | --output-format=<fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-03-01 10:14:21 EST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\r
</div>\r
</div>\r
</body>\r
--------
[verse]
'nvme wdc id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
+ [-H | --human-readable]
[-o <fmt> | --output-format=<fmt>]
DESCRIPTION
'\" t
.\" Title: nvme-write
-.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 12/13/2017
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 01/30/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WRITE" "1" "12/13/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE" "1" "01/30/2018" "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>]
- [\-\-dtype=<dtype> | \-T <dtype>]
- [\-\-dspec=<dspec> | \-S <dspec>]
- [\-\-dsm=<dsm> | \-D <dsm>]
[\-\-limited\-retry | \-l]
- [\-\-latency | \-t]
[\-\-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]
.fi
.SH "DESCRIPTION"
.sp
.sp 1
.RE
.PP
-\-\-dtype=<dtype>, \-T <dtype>
-.RS 4
-Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specifcation (1\&.3a) defines only one directive, 01h, for write stream idenfiers\&.
-.RE
-.PP
-\-\-dspec=<dspec>, \-S <dspec>
-.RS 4
-Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
-.RE
-.PP
-\-\-dsm=<dsm>, \-D <dsm>
-.RS 4
-The optional data set management attributes for this command\&. The argument for this is the lower 16 bits of the DSM field in a write command; the upper 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
\-\-ref\-tag=<reftag>, \-r <reftag>
.RS 4
Optional reftag when used with protection information\&.
Set the force\-unit access flag\&.
.RE
.PP
-\-\-latency, \-t
+\-T <type>, \-\-dir\-type=<type>
+.RS 4
+Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specifcation (1\&.3a) defines only one directive, 01h, for write stream idenfiers\&.
+.RE
+.PP
+\-S <spec>, \-\-dir\-spec=<spec>
+.RS 4
+Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
+.RE
+.PP
+\-D <dsm>, \-\-dsm=<dsm>
+.RS 4
+The optional data set management attributes for this command\&. The argument for this is the lower 16 bits of the DSM field in a write command; the upper 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
+.RS 4
+Print out the command to be sent\&.
+.RE
+.PP
+\-w, \-\-dry\-run
+.RS 4
+Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
+\fImust\fR
+be set\&. Otherwise \-\-dry\-run optionn will be
+\fIignored\fR\&.
+.RE
+.PP
+\-t, \-\-latency
.RS 4
Print out the latency the IOCTL took (in us)\&.
.RE
<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.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>nvme-write(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\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
- [--dtype=<dtype> | -T <dtype>]\r
- [--dspec=<dspec> | -S <dspec>]\r
- [--dsm=<dsm> | -D <dsm>]\r
[--limited-retry | -l]\r
- [--latency | -t]\r
- [--force-unit-access | -f]</pre>\r
+ [--force-unit-access | -f]\r
+ [--dir-type=<type> | -T <type>]\r
+ [--dir-spec=<spec> | -S <spec>]\r
+ [--dsm=<dsm> | -D <dsm>]\r
+ [--show-command | -v]\r
+ [--dry-run | -w]\r
+ [--latency | -t]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</div>\r
</dd>\r
<dt class="hdlist1">\r
---dtype=<dtype>\r
+--ref-tag=<reftag>\r
</dt>\r
<dt class="hdlist1">\r
--T <dtype>\r
+-r <reftag>\r
</dt>\r
<dd>\r
<p>\r
- Optional directive type. The nvme-cli only enforces the value\r
- be in the defined range for the directive type, though the NVMe\r
- specifcation (1.3a) defines only one directive, 01h, for write\r
- stream idenfiers.\r
+ Optional reftag when used with protection information.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---dspec=<dspec>\r
+--app-tag-mask=<appmask>\r
</dt>\r
<dt class="hdlist1">\r
--S <dspec>\r
+-m <appmask>\r
</dt>\r
<dd>\r
<p>\r
- Optional field for directive specifics. When used with\r
- write streams, this value is defined to be the write stream\r
- identifier. The nvme-cli will not validate the stream requested\r
- is within the controller’s capabilities.\r
+ Optional application tag mask when used with protection information.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---dsm=<dsm>\r
+--app-tag=<apptag>\r
</dt>\r
<dt class="hdlist1">\r
--D <dsm>\r
+-a <apptag>\r
</dt>\r
<dd>\r
<p>\r
- The optional data set management attributes for this command. The\r
- argument for this is the lower 16 bits of the DSM field in a write\r
- command; the upper 16 bits of the field come from the directive\r
- specific field, if used. This may be used to set attributes for\r
- the LBAs being written, like access frequency, type, latency,\r
- among other things, as well as yet to be defined types. Please\r
- consult the NVMe specification for detailed breakdown of how to\r
- use this field.\r
+ Optional application tag when used with protection information.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+--limited-retry\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+-l\r
</dt>\r
<dd>\r
<p>\r
- Optional reftag when used with protection information.\r
+ Sets the limited retry flag.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag-mask=<appmask>\r
+--force-unit-access\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+-f\r
</dt>\r
<dd>\r
<p>\r
- Optional application tag mask when used with protection information.\r
+ Set the force-unit access flag.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag=<apptag>\r
+-T <type>\r
</dt>\r
<dt class="hdlist1">\r
--a <apptag>\r
+--dir-type=<type>\r
</dt>\r
<dd>\r
<p>\r
- Optional application tag when used with protection information.\r
+ Optional directive type. The nvme-cli only enforces the value\r
+ be in the defined range for the directive type, though the NVMe\r
+ specifcation (1.3a) defines only one directive, 01h, for write\r
+ stream idenfiers.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---limited-retry\r
+-S <spec>\r
</dt>\r
<dt class="hdlist1">\r
--l\r
+--dir-spec=<spec>\r
</dt>\r
<dd>\r
<p>\r
- Sets the limited retry flag.\r
+ Optional field for directive specifics. When used with\r
+ write streams, this value is defined to be the write stream\r
+ identifier. The nvme-cli will not validate the stream requested\r
+ is within the controller’s capabilities.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-D <dsm>\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--dsm=<dsm>\r
</dt>\r
<dd>\r
<p>\r
- Set the force-unit access flag.\r
+ The optional data set management attributes for this command. The\r
+ argument for this is the lower 16 bits of the DSM field in a write\r
+ command; the upper 16 bits of the field come from the directive\r
+ specific field, if used. This may be used to set attributes for\r
+ the LBAs being written, like access frequency, type, latency,\r
+ among other things, as well as yet to be defined types. Please\r
+ consult the NVMe specification for detailed breakdown of how to\r
+ use this field.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---latency\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--show-cmd\r
+</dt>\r
+<dd>\r
+<p>\r
+ Print out the command to be sent.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-w\r
</dt>\r
<dt class="hdlist1">\r
+--dry-run\r
+</dt>\r
+<dd>\r
+<p>\r
+ Do not actually send the command. If want to use --dry-run option,\r
+ --show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be\r
+ <em>ignored</em>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
-t\r
</dt>\r
+<dt class="hdlist1">\r
+--latency\r
+</dt>\r
<dd>\r
<p>\r
Print out the latency the IOCTL took (in us).\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-12-10 09:41:18 MST\r
+Last updated\r
+ 2018-01-30 19:28:39 KST\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>]
- [--dtype=<dtype> | -T <dtype>]
- [--dspec=<dspec> | -S <dspec>]
- [--dsm=<dsm> | -D <dsm>]
[--limited-retry | -l]
- [--latency | -t]
[--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]
DESCRIPTION
-----------
|0|Set to 1 enables checking the reference tag
|=================
---dtype=<dtype>::
--T <dtype>::
+--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.
+
+-T <type>::
+--dir-type=<type>::
Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe
specifcation (1.3a) defines only one directive, 01h, for write
stream idenfiers.
---dspec=<dspec>::
--S <dspec>::
+-S <spec>::
+--dir-spec=<spec>::
Optional field for directive specifics. When used with
write streams, this value is defined to be the write stream
identifier. The nvme-cli will not validate the stream requested
is within the controller's capabilities.
---dsm=<dsm>::
-D <dsm>::
+--dsm=<dsm>::
The optional data set management attributes for this command. The
argument for this is the lower 16 bits of the DSM field in a write
command; the upper 16 bits of the field come from the directive
consult the NVMe specification for detailed breakdown of how to
use this field.
---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.
+-v::
+--show-cmd::
+ Print out the command to be sent.
---force-unit-access::
--f::
- Set the force-unit access flag.
+-w::
+--dry-run::
+ Do not actually send the command. If want to use --dry-run option,
+ --show-cmd option _must_ be set. Otherwise --dry-run optionn will be
+ _ignored_.
---latency::
-t::
+--latency::
Print out the latency the IOCTL took (in us).
EXAMPLES
projects / users / hch / nvme-cli.git / commitdiff