summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-seagate-help.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-seagate-help.txt')
-rw-r--r--Documentation/nvme-seagate-help.txt49
1 files changed, 49 insertions, 0 deletions
diff --git a/Documentation/nvme-seagate-help.txt b/Documentation/nvme-seagate-help.txt
new file mode 100644
index 0000000..0a077a8
--- /dev/null
+++ b/Documentation/nvme-seagate-help.txt
@@ -0,0 +1,49 @@
+nvme-seagate-help(1)
+====================
+
+NAME
+----
+nvme-seagate-help - Shows the Seagate plugin's help information
+
+SYNOPSIS
+--------
+[verse]
+'nvme seagate help'
+
+DESCRIPTION
+-----------
+Provides the help information for the Seagate plugin.
+
+OPTIONS
+-------
+No Options
+
+EXAMPLES
+--------
+Get help information for specific seagate sub-commands.
+
+Seagate vendor specific extensions::
+
+The following are all implemented sub-commands:
+
+ vs-temperature-stats Retrieve Seagate temperature statistics
+ vs-log-page-sup Retrieve Seagate Supported Log-pages Information
+ vs-smart-add-log Retrieve Seagate extended-SMART Information
+ vs-pcie-stats Retrieve Seagate PCIe error statistics
+ clear-pcie-correctable-errors Clear Seagate PCIe error statistics
+ get-host-tele Retrieve Seagate Host-Initiated Telemetry
+ get-ctrl-tele Retrieve Seagate Controller-Initiated Telemetry
+ vs-internal-log Retrieve Seagate Controller-Initiated Telemetry in binary format
+ plugin-version Shows Seagate plugin's version information
+ version Shows the program version
+ help Display this help
+
+See 'nvme seagate help <command>' for more information on a specific command
+
+------------
+# nvme seagate help
+------------
+
+NVME
+----
+Part of the nvme-user suite