summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-id-iocs.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:49:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:49:35 +0000
commitf2c543b4ccad3b9f8871d952cddf66b3b438595b (patch)
treec3c363d1cc72514221685c42a79a19b320114acc /Documentation/nvme-id-iocs.txt
parentAdding debian version 1.12-8. (diff)
downloadnvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.tar.xz
nvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.zip
Merging upstream version 1.14.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-id-iocs.txt')
-rw-r--r--Documentation/nvme-id-iocs.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt
new file mode 100644
index 0000000..9e53207
--- /dev/null
+++ b/Documentation/nvme-id-iocs.txt
@@ -0,0 +1,39 @@
+nvme-id-iocs(1)
+===============
+
+NAME
+----
+nvme-id-iocs - Send NVMe Identify I/O Command Set, return result and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme id-iocs' <device> [--controller-id=<cntid> | -c <cntid>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send an identify command and return the Identify I/O
+Command Set data structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-c <cntid>::
+--controller-id=<cntid>::
+ Retrieve the identify I/O Command set data structure for the given
+ cntid. If this value is not given, cntid will be 0xffff.
+
+EXAMPLES
+--------
+* Have the program interpret the returned buffer and display the known
+fields in a human readable format:
++
+------------
+# nvme id-iocs /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite