Blame Documentation/nvme-intel-temp-stats.1

Packit Service b7b338
'\" t
Packit Service b7b338
.\"     Title: nvme-intel-temp-stats
Packit Service b7b338
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
Packit Service b7b338
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
Packit Service b7b338
.\"      Date: 04/24/2020
Packit Service b7b338
.\"    Manual: NVMe Manual
Packit Service b7b338
.\"    Source: NVMe
Packit Service b7b338
.\"  Language: English
Packit Service b7b338
.\"
Packit Service b7b338
.TH "NVME\-INTEL\-TEMP\-S" "1" "04/24/2020" "NVMe" "NVMe Manual"
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.\" * Define some portability stuff
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit Service b7b338
.\" http://bugs.debian.org/507673
Packit Service b7b338
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit Service b7b338
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit Service b7b338
.ie \n(.g .ds Aq \(aq
Packit Service b7b338
.el       .ds Aq '
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.\" * set default formatting
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.\" disable hyphenation
Packit Service b7b338
.nh
Packit Service b7b338
.\" disable justification (adjust text to left margin only)
Packit Service b7b338
.ad l
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.\" * MAIN CONTENT STARTS HERE *
Packit Service b7b338
.\" -----------------------------------------------------------------
Packit Service b7b338
.SH "NAME"
Packit Service b7b338
nvme-intel-temp-stats \- Send NVMe SMART log page request, returns result and log
Packit Service b7b338
.SH "SYNOPSIS"
Packit Service b7b338
.sp
Packit Service b7b338
.nf
Packit Service b7b338
\fInvme intel temp\-stats\fR <device> [\-\-raw\-binary | \-b]
Packit Service b7b338
.fi
Packit Service b7b338
.SH "DESCRIPTION"
Packit Service b7b338
.sp
Packit Service b7b338
Retrieves the NVMe Intel Additional SMART log page from the device and provides the returned structure\&.
Packit Service b7b338
.sp
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
Packit Service b7b338
.sp
Packit Service b7b338
On success, the returned smart log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer may be printed to stdout for another program to parse\&.
Packit Service b7b338
.SH "OPTIONS"
Packit Service b7b338
.PP
Packit Service b7b338
\-b, \-\-raw\-binary
Packit Service b7b338
.RS 4
Packit Service b7b338
Print the raw temperature stats log buffer to stdout\&.
Packit Service b7b338
.RE
Packit Service b7b338
.SH "EXAMPLES"
Packit Service b7b338
.sp
Packit Service b7b338
.RS 4
Packit Service b7b338
.ie n \{\
Packit Service b7b338
\h'-04'\(bu\h'+03'\c
Packit Service b7b338
.\}
Packit Service b7b338
.el \{\
Packit Service b7b338
.sp -1
Packit Service b7b338
.IP \(bu 2.3
Packit Service b7b338
.\}
Packit Service b7b338
Print the temperature stats log page in a human readable format:
Packit Service b7b338
.sp
Packit Service b7b338
.if n \{\
Packit Service b7b338
.RS 4
Packit Service b7b338
.\}
Packit Service b7b338
.nf
Packit Service b7b338
# nvme intel temp\-stats /dev/nvme0
Packit Service b7b338
.fi
Packit Service b7b338
.if n \{\
Packit Service b7b338
.RE
Packit Service b7b338
.\}
Packit Service b7b338
.RE
Packit Service b7b338
.sp
Packit Service b7b338
.RS 4
Packit Service b7b338
.ie n \{\
Packit Service b7b338
\h'-04'\(bu\h'+03'\c
Packit Service b7b338
.\}
Packit Service b7b338
.el \{\
Packit Service b7b338
.sp -1
Packit Service b7b338
.IP \(bu 2.3
Packit Service b7b338
.\}
Packit Service b7b338
Print the raw SMART log to a file:
Packit Service b7b338
.sp
Packit Service b7b338
.if n \{\
Packit Service b7b338
.RS 4
Packit Service b7b338
.\}
Packit Service b7b338
.nf
Packit Service b7b338
# nvme intel temp\-stats /dev/nvme0 \-\-raw\-binary > temp_stats_log\&.raw
Packit Service b7b338
.fi
Packit Service b7b338
.if n \{\
Packit Service b7b338
.RE
Packit Service b7b338
.\}
Packit Service b7b338
.sp
Packit Service b7b338
It is probably a bad idea to not redirect stdout when using this mode\&.
Packit Service b7b338
.RE
Packit Service b7b338
.SH "NVME"
Packit Service b7b338
.sp
Packit Service b7b338
Part of the nvme\-user suite