diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-11-20 07:04:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-11-20 07:04:39 +0000 |
commit | b8210b1af6dd369a577b2ea2c2fa0f25bffaa3f4 (patch) | |
tree | 0f8475e9ba10b301bd87788e60d1759e8855e414 /Documentation/nvme-boot-part-log.1 | |
parent | Releasing debian version 1.15-4. (diff) | |
download | nvme-cli-b8210b1af6dd369a577b2ea2c2fa0f25bffaa3f4.tar.xz nvme-cli-b8210b1af6dd369a577b2ea2c2fa0f25bffaa3f4.zip |
Merging upstream version 1.16.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-boot-part-log.1 | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/Documentation/nvme-boot-part-log.1 b/Documentation/nvme-boot-part-log.1 new file mode 100644 index 0000000..d618825 --- /dev/null +++ b/Documentation/nvme-boot-part-log.1 @@ -0,0 +1,89 @@ +'\" t +.\" Title: nvme-boot-part-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 11/11/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-BOOT\-PART\-LO" "1" "11/11/2021" "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-boot-part-log \- Retrieves a Boot Partition log page from an NVMe device +.SH "SYNOPSIS" +.sp +.nf +\fInvme boot\-part\-log\fR <device> [\-\-lsp=<field> | \-s <field>] + [\-\-output\-file=<file> | \-o <file>] + [\-\-output\-format=<fmt> | \-o <fmt>] +.fi +.SH "DESCRIPTION" +.sp +Retrieves an Boot Partition log page from an NVMe device and provides the 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)\&. +.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 +\-s <field>, \-\-lsp=<field> +.RS 4 +The log specified field of LID\&. +.RE +.PP +\-o <file>, \-\-output\-file=<file> +.RS 4 +File name to which raw binary data will be saved to\&. +.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 +.\} +Retrieve Boot Partition data to boot_part_log\&.bin +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme boot\-part\-log /dev/nvme0 \-\-output\-file=boot_part_log\&.bin +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite |