summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-get-log.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-get-log.1
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-get-log.1')
-rw-r--r--Documentation/nvme-get-log.143
1 files changed, 29 insertions, 14 deletions
diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1
index 804e18c..66a3573 100644
--- a/Documentation/nvme-get-log.1
+++ b/Documentation/nvme-get-log.1
@@ -2,12 +2,12 @@
.\" Title: nvme-get-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/21/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -33,17 +33,18 @@ nvme-get-log \- Retrieves a log page from an NVMe device
.sp
.nf
\fInvme get\-log\fR <device> [\-\-log\-id=<log\-id> | \-i <log\-id>]
- [\-\-log\-len=<log\-len> | \-l <log\-len>]
- [\-\-aen=<aen> | \-a <aen>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-raw\-binary | \-b]
- [\-\-lpo=<offset> | \-o <offset>]
- [\-\-lsp=<field> | \-s <field>]
- [\-\-lsi=<field> | \-S <field>]
- [\-\-rae | \-r]
- [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
- [\-\-ot=<offset_type> | \-O <offset_type>]
- [\-\-xfer\-len=<length> | \-x <length>]
+ [\-\-log\-len=<log\-len> | \-l <log\-len>]
+ [\-\-aen=<aen> | \-a <aen>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-raw\-binary | \-b]
+ [\-\-lpo=<offset> | \-L <offset>]
+ [\-\-lsp=<field> | \-s <field>]
+ [\-\-lsi=<field> | \-S <field>]
+ [\-\-rae | \-r]
+ [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
+ [\-\-ot=<offset_type> | \-O <offset_type>]
+ [\-\-xfer\-len=<length> | \-x <length>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
@@ -79,7 +80,7 @@ Sets the command\(cqs nsid value to the given nsid\&. Defaults to 0xffffffff if
Print the raw log buffer to stdout\&.
.RE
.PP
-\-o <offset>, \-\-lpo=<offset>
+\-L <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
@@ -113,6 +114,20 @@ This field specifies the offset type\&. If set to false, the Log Page Offset Low
.RS 4
\-\-xfer\-len <length>: Specify the read chunk size\&. The length argument is expected to be a multiple of 4096\&. The default size is 4096\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4