'\" t
.\"     Title: nvme-seagate-help
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/18/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-SEAGATE\-HELP" "1" "09/18/2026" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-seagate-help \- Shows the Seagate plugin\*(Aqs help information
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIseagate help\fR
.fi
.SH "DESCRIPTION"
.sp
Provides the help information for the Seagate plugin\&.
.SH "OPTIONS"
.sp
No Options
.SH "GLOBAL OPTIONS"
.sp
The following options are defined at the top\-level nvme command and are available to this subcommand:
.PP
\-\-dry\-run
.RS 4
Print the command that would be executed, but do not actually execute it\&.
.RE
.PP
\-\-no\-ioctl\-probing
.RS 4
Disable probing for 64\-bit IOCTL support\&.
.RE
.PP
\-\-no\-retries
.RS 4
Disable retry logic on transient errors\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fItabular, \*(Aqjson\fR, or
\fIbinary\fR\&. Only one output format may be used at a time\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Select the output format version\&. Version
\fI1\fR
uses the original field naming, while version
\fI2\fR
(default) provides more consistent and script\-friendly field names\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
.RE
.sp
These options can also be set as machine\-wide defaults in nvme\-cli\&.conf(5)\&. A command\-line flag always overrides the file\&.
.SH "EXAMPLES"
.sp
Get help information for specific seagate sub\-commands\&.
.PP
Seagate vendor specific extensions
.RS 4
The following are all implemented sub\-commands:
.sp
.if n \{\
.RS 4
.\}
.nf
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\*(Aqs version information
version                         Shows the program version
help                            Display this help
.fi
.if n \{\
.RE
.\}
.RE
.sp
See \fInvme seagate help <command>\fR for more information on a specific command
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme seagate help
.fi
.if n \{\
.RE
.\}
.SH "NVME"
.sp
Part of the nvme\-user suite