.\" Title: nvme-effects-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/13/2018
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-EFFECTS\-LOG" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-EFFECTS\-LOG" "1" "01/13/2018" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme effects\-log\fR <device>
+\fInvme effects\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-human\-readable | \-H]
+ [\-\-raw\-binary | \-b]
.fi
.SH "DESCRIPTION"
.sp
.sp
On success, the returned command effects log structure will be printed for each command that is supported\&.
.SH "OPTIONS"
-.sp
-No options\&.
+.PP
+\-o <format>, \-\-output\-format=<format>
+.RS 4
+This option will set the reporting format to normal, json, or binary\&. 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 a human\-readable format\&.
+.RE
+.PP
+\-b, \-\-raw\-binary
+.RS 4
+This option will print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the human\-readable option\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.if n \{\
.RE
.\}
+.RE
.sp
-Not much to it\&.
+.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 effects\-log /dev/nvme0 \-\-raw\-binary > effects_log\&.raw
+# nvme effects\-log /dev/nvme0 \-b > effects_log\&.raw
+.fi
+.if n \{\
+.RE
+.\}
.RE
.SH "NVME"
.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-effects-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
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme effects-log</em> <device></pre>\r
+<pre class="content"><em>nvme effects-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 class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>No options.</p></div>\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
+ This option will set the reporting format to normal, json, or binary.\r
+ 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 into a\r
+ human-readable format.\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
+ This option will print the raw buffer to stdout. Structure is not\r
+ parsed by program. This overrides the human-readable option.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div class="content">\r
<pre><code># nvme effects-log /dev/nvme0</code></pre>\r
</div></div>\r
-<div class="paragraph"><p>Not much to it.</p></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 effects-log /dev/nvme0 --raw-binary > effects_log.raw\r
+# nvme effects-log /dev/nvme0 -b > effects_log.raw</code></pre>\r
+</div></div>\r
</li>\r
</ul></div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-10-27 10:09:24 MDT\r
+Last updated\r
+ 2018-01-13 21:15:43 KST\r
</div>\r
</div>\r
</body>\r
SYNOPSIS
--------
[verse]
-'nvme effects-log' <device>
+'nvme effects-log' <device> [--output-format=<fmt> | -o <fmt>]
+ [--human-readable | -H]
+ [--raw-binary | -b]
DESCRIPTION
-----------
OPTIONS
-------
-No options.
+-o <format>::
+--output-format=<format>::
+ This option will 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 a
+ human-readable format.
+
+-b::
+--raw-binary::
+ This option will print the raw buffer to stdout. Structure is not
+ parsed by program. This overrides the human-readable option.
EXAMPLES
--------
------------
+
-Not much to it.
+* Have the program return the raw structure in binary:
++
+------------
+# nvme effects-log /dev/nvme0 --raw-binary > effects_log.raw
+# nvme effects-log /dev/nvme0 -b > effects_log.raw
+------------
NVME
----
projects / users / sagi / nvme-cli.git / commitdiff