summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-transcend-healthvalue.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-transcend-healthvalue.txt')
-rw-r--r--Documentation/nvme-transcend-healthvalue.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/nvme-transcend-healthvalue.txt b/Documentation/nvme-transcend-healthvalue.txt
new file mode 100644
index 0000000..90340ce
--- /dev/null
+++ b/Documentation/nvme-transcend-healthvalue.txt
@@ -0,0 +1,38 @@
+nvme-transcend-healthvalue(1)
+=============================
+
+NAME
+----
+nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of
+Transcend device.
+
+SYNOPSIS
+--------
+[verse]
+'nvme transcend healthvalue' <device>
+
+DESCRIPTION
+-----------
+Retrieves the NVMe Device SMART log page from the Transcend device and evaluate
+health status of Transcend device.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the returned value would print health percentage value.
+
+OPTIONS
+-------
+none
+
+EXAMPLES
+--------
+* Print the Transcend Device health value in a human readable format:
++
+------------
+# nvme transcend healthvalue /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite