summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-virtium-show-identify.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
commitf26f66d866ba1a9f3204e6fdfe2b07e67b5492ad (patch)
treec953c007cbe4f60a147ab62f97937d58abb2e9ca /Documentation/nvme-virtium-show-identify.txt
parentInitial commit. (diff)
downloadnvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.tar.xz
nvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.zip
Adding upstream version 2.8.upstream/2.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-virtium-show-identify.txt')
-rw-r--r--Documentation/nvme-virtium-show-identify.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/nvme-virtium-show-identify.txt b/Documentation/nvme-virtium-show-identify.txt
new file mode 100644
index 0000000..881824c
--- /dev/null
+++ b/Documentation/nvme-virtium-show-identify.txt
@@ -0,0 +1,38 @@
+nvme-virtium-show-identify(1)
+=============================
+
+NAME
+----
+nvme-virtium-show-identify - Show a complete detail of identify device information in json format.
+
+SYNOPSIS
+--------
+[verse]
+'nvme virtium show-identify' <device>
+
+DESCRIPTION
+-----------
+This command prints complete detail of the identify device information. The
+details include settings and description of each feature. The descriptions are
+based on NVM Express Revision 1.3c specification.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the command prints identify device in human readable format.
+
+OPTIONS
+-------
+none
+
+EXAMPLES
+--------
+* Show Identify Device:
++
+------------
+# nvme virtium show-identify /dev/nvme0n1
+------------
+
+NVME
+----
+Part of the nvme-user suite