diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
commit | 1cc8413aaf5f8fa6595aece1933462c096e88639 (patch) | |
tree | e97b4f25c511372d73bdd96c389c5f468d99138a /Documentation/nvme.txt | |
parent | Initial commit. (diff) | |
download | nvme-cli-upstream.tar.xz nvme-cli-upstream.zip |
Adding upstream version 2.4+really2.3.upstream/2.4+really2.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme.txt')
-rw-r--r-- | Documentation/nvme.txt | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt new file mode 100644 index 0000000..87de7b8 --- /dev/null +++ b/Documentation/nvme.txt @@ -0,0 +1,70 @@ +nvme(1) +======= + +NAME +---- +nvme - the NVMe storage command line interface utility (nvme-cli) + +SYNOPSIS +-------- +built-in plugin: +[verse] +'nvme' <command> <device> [<args>] + +extension plugins: +[verse] +'nvme' <plugin> <command> <device> [<args>] + +DESCRIPTION +----------- +NVM-Express is a fast, scalable host controller interface designed to +address the needs for not only PCI Express based solid state drives, but +also NVMe-oF(over fabrics). + +This 'nvme' program is a user space utility to provide standards compliant +tooling for NVM-Express drives. It was made specifically for Linux as +it relies on the IOCTLs defined by the mainline kernel driver. + +NVME COMMANDS +------------- +The utility has sub-commands for all admin and io commands defined in the +specification and for displaying controller registers. There is also an +option to submit completely arbitrary commands. For a list of commands +available, run "nvme help". + +nvme cli sub-commands +--------------------- + +Main commands +~~~~~~~~~~~~~ + +include::cmds-main.txt[] + +Plugins/Vendor extension commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +include::cmd-plugins.txt[] + +RETURNS +------- +All commands will behave the same, they will return 0 on success and 1 on +failure. + +FURTHER DOCUMENTATION +--------------------- +See the freely available references on the http://nvmexpress.org[Official +NVM-Express Site]. + +Authors +------- +This is written and maintained by mailto:kbusch@kernel.org[Keith Busch]. + +Reporting Bugs +-------------- +Patches and issues may be submitted to the official repository at +https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list +mailto:linux-nvme@lists.infradead.org[linux-nvme] + +NVME +---- +Part of the nvme suite |