diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:41:32 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:41:32 +0000 |
| commit | f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad (patch) | |
| tree | c953c007cbe4f60a147ab62f97937d58abb2e9ca /Documentation/nvme-list.txt | |
| parent | Initial commit. (diff) | |
| download | nvme-cli-upstream/2.8.tar.xz nvme-cli-upstream/2.8.zip | |
Adding upstream version 2.8.upstream/2.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-list.txt')
| -rw-r--r-- | Documentation/nvme-list.txt | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt new file mode 100644 index 0000000..a8c5428 --- /dev/null +++ b/Documentation/nvme-list.txt @@ -0,0 +1,41 @@ +nvme-list(1) +============ + +NAME +---- +nvme-list - List all recognized NVMe devices + +SYNOPSIS +-------- +[verse] +'nvme list' [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +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 <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. 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 related 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 |