summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-seagate-help.1
blob: f7706867d8d9d9b3753086e7de90b923cff56692 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
'\" 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: 03/31/2023
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-SEAGATE\-HELP" "1" "03/31/2023" "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 seagate help\fR
.fi
.SH "DESCRIPTION"
.sp
Provides the help information for the Seagate plugin\&.
.SH "OPTIONS"
.sp
No Options
.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