Merging upstream version 1.16.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
e18d879d6d
commit
c8ec5e528c
GPG key ID:
FBB4F0E80A80222F
345 changed files with 7594 additions and 7512 deletions
142
Documentation/nvme-cmdset-ind-id-ns.1
Normal file
142
Documentation/nvme-cmdset-ind-id-ns.1
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
'\" t
|
||||
.\" Title: nvme-cmdset-ind-id-ns
|
||||
.\" 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\-CMDSET\-IND\-I" "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-cmdset-ind-id-ns \- Send NVMe I/O Command Set Independent Identify Namespace, return result and structure\&.
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
.nf
|
||||
\fInvme cmdset\-ind\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
|
||||
[\-b | \-\-raw\-binary]
|
||||
[\-\-human\-readable | \-H]
|
||||
[\-\-output\-format=<fmt> | \-o <fmt>]
|
||||
.fi
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
For the NVMe device given, sends an I/O Command Set Independent identify namespace 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 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\&. This overrides the vendor specific and human readable options\&.
|
||||
.RE
|
||||
.PP
|
||||
\-H, \-\-human\-readable
|
||||
.RS 4
|
||||
This option will parse and format many of the bit fields into human\-readable formats\&.
|
||||
.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
|
||||
.\}
|
||||
Has the program interpret the returned buffer and display the known fields in a human readable format:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
# nvme cmdset\-ind\-id\-ns /dev/nvme0n1
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.RE
|
||||
.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 id:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
# nvme cmdset\-ind\-id\-ns /dev/nvme0 \-n 1
|
||||
# nvme cmdset\-ind\-id\-ns /dev/nvme0n1 \-n 1
|
||||
# nvme cmdset\-ind\-id\-ns /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 cmdset\-ind\-id\-ns /dev/nvme0n1 \-\-raw\-binary > id_ns\&.raw
|
||||
# nvme cmdset\-ind\-id\-ns /dev/nvme0n1 \-b > id_ns\&.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
|
||||
Loading…
Add table
Add a link
Reference in a new issue