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-wdc-purge.txt | |
| parent | Initial commit. (diff) | |
| download | nvme-cli-upstream/2.4+really2.3.tar.xz nvme-cli-upstream/2.4+really2.3.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 '')
| -rw-r--r-- | Documentation/nvme-wdc-purge.txt | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-purge.txt b/Documentation/nvme-wdc-purge.txt new file mode 100644 index 0000000..95c2dd2 --- /dev/null +++ b/Documentation/nvme-wdc-purge.txt @@ -0,0 +1,40 @@ +nvme-wdc-purge(1) +================= + +NAME +---- +nvme-wdc-purge - Send NVMe WDC Purge Vendor Unique Command, return result + +SYNOPSIS +-------- +[verse] +'nvme wdc purge' <device> + +DESCRIPTION +----------- +For the NVMe device given, sends a Vendor Unique WDC Purge command and +provides the result. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +No options yet. + +EXAMPLES +-------- +* Has the program issue WDC Purge Vendor Unique Command : ++ +------------ +# nvme wdc purge /dev/nvme0n1 +------------ + +NVME +---- +Part of the nvme-user suite. |