Blame Documentation/nvme-wdc-purge.txt

Packit Service b7b338
nvme-wdc-purge(1)
Packit Service b7b338
=================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-wdc-purge - Send NVMe WDC Purge Vendor Unique Command, return result
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme wdc purge' <device>
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
For the NVMe device given, sends a Vendor Unique WDC Purge command and
Packit Service b7b338
provides the result.
Packit Service b7b338
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character
Packit Service b7b338
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
Packit Service b7b338
Packit Service b7b338
This will only work on WDC devices supporting this feature.
Packit Service b7b338
Results for any other device are undefined.
Packit Service b7b338
Packit Service b7b338
On success it returns 0, error code otherwise.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
No options yet.
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
* Has the program issue WDC Purge Vendor Unique Command :
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme wdc purge /dev/nvme0n1
Packit Service b7b338
------------
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite.