summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-list.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
commitdc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch)
tree55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-list.txt
parentInitial commit. (diff)
downloadnvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz
nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-list.txt')
-rw-r--r--Documentation/nvme-list.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt
new file mode 100644
index 0000000..22e0081
--- /dev/null
+++ b/Documentation/nvme-list.txt
@@ -0,0 +1,42 @@
+nvme-list(1)
+============
+
+NAME
+----
+nvme-list - List all recognized NVMe devices
+
+SYNOPSIS
+--------
+[verse]
+'nvme list' [-o <fmt> | --output-format=<fmt>]
+
+DESCRIPTION
+-----------
+Scan the sysfs tree for NVM Express devices and return the /dev node
+for those devices as well as some pertinent information about them.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+ Set the reporting format to 'normal' or 'json'. Only one output
+ format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information in the output, showing nvme subsystems,
+ controllers and namespaces separately and how they're realted to each
+ other.
+
+ENVIRONMENT
+-----------
+PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in common locations.
+
+
+EXAMPLES
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite