summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-seagate-vs-pcie-stats.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-seagate-vs-pcie-stats.1')
-rw-r--r--Documentation/nvme-seagate-vs-pcie-stats.163
1 files changed, 63 insertions, 0 deletions
diff --git a/Documentation/nvme-seagate-vs-pcie-stats.1 b/Documentation/nvme-seagate-vs-pcie-stats.1
new file mode 100644
index 0000000..03dace8
--- /dev/null
+++ b/Documentation/nvme-seagate-vs-pcie-stats.1
@@ -0,0 +1,63 @@
+'\" t
+.\" Title: nvme-seagate-vs-pcie-stats
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 11/02/2022
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-SEAGATE\-VS\-P" "1" "11/02/2022" "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-vs-pcie-stats \- Retrieve Seagate vendor specific PCIe error statistics
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme seagate vs\-pcie\-stats <device> [OPTIONS]\fR
+.fi
+.SH "DESCRIPTION"
+.sp
+This command will only work on Seagate devices supporting this feature\&. Not all commands work across all product families\&.
+.sp
+The \fI<device>\fR parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&.
+.SH "OPTIONS"
+.PP
+\-o <FMT>, \-\-output\-format=<FMT>
+.RS 4
+Output in binary format
+.RE
+.SH "EXAMPLES"
+.sp
+Get the vendor specific PCIe error statistics for the specified device\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme seagate vs\-pcie\-stats /dev/nvme0
+.fi
+.if n \{\
+.RE
+.\}
+.SH "NVME"
+.sp
+Part of the nvme\-user suite