Adding upstream version 1.12.upstream/1.12

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 70 insertions, 0 deletions

diff --git a/Documentation/nvme-list-ctrl.1 b/Documentation/nvme-list-ctrl.1
new file mode 100644
index 0000000..516f1e8
--- /dev/null
+++ b/Documentation/nvme-list-ctrl.1
@@ -0,0 +1,70 @@
+'\" t
+.\"     Title: nvme-id-ns
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 04/24/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ID\-NS" "1" "04/24/2020" "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-list-ctrl \- Send NVMe Identify List Controllers, return result and structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme list\-ctrl\fR <device> [\-\-cntid=<cntid> | \-c <cntid>]
+                        [\-\-namespace\-id=<nsid> | \-n <nsid>]
+DESCRIPTION
+.fi
+.sp
+.nf
+For the NVMe device given, sends an identify command for controller list
+and provides the result and returned structure\&. This uses either mode
+12h or 13h depending on the requested namespace identifier\&.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
+The starting controller in the list always begins with 0 unless the
+`\*(Aq\-\-cntid\*(Aq` option is given to override\&.
+
+On success, the controller array is printed for each index and controller
+identifier\&.
+
+OPTIONS
+.fi
+.PP
+\-c <cntid>, \-\-cntid=<cntid>
+.RS 4
+Retrieve the identify list structure starting with the given controller id\&.
+.RE
+.PP
+\-n <nsid>, \-\-namespace\-id=<nsid>
+.RS 4
+If provided, will request the controllers attached to the specified namespace\&. If no namespace is given, or set to 0, the command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s)\&.
+.RE
+.SH "EXAMPLES"
+.sp
+No examples yet\&.
+.SH "NVME"
+.sp
+Part of the nvme\-user suite