Blame Documentation/nvme-wdc-vs-drive-info.1

Packit dd4ba5
'\" t
Packit dd4ba5
.\"     Title: nvme-wdc-vs-drive-info
Packit dd4ba5
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
Packit dd4ba5
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
Packit dd4ba5
.\"      Date: 04/24/2020
Packit dd4ba5
.\"    Manual: NVMe Manual
Packit dd4ba5
.\"    Source: NVMe
Packit dd4ba5
.\"  Language: English
Packit dd4ba5
.\"
Packit dd4ba5
.TH "NVME\-WDC\-VS\-DRIVE" "1" "04/24/2020" "NVMe" "NVMe Manual"
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * Define some portability stuff
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit dd4ba5
.\" http://bugs.debian.org/507673
Packit dd4ba5
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit dd4ba5
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit dd4ba5
.ie \n(.g .ds Aq \(aq
Packit dd4ba5
.el       .ds Aq '
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * set default formatting
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" disable hyphenation
Packit dd4ba5
.nh
Packit dd4ba5
.\" disable justification (adjust text to left margin only)
Packit dd4ba5
.ad l
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * MAIN CONTENT STARTS HERE *
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.SH "NAME"
Packit dd4ba5
nvme-wdc-vs-drive-info \- Send the NVMe WDC vs\-drive\-info command, return result
Packit dd4ba5
.SH "SYNOPSIS"
Packit dd4ba5
.sp
Packit dd4ba5
.nf
Packit dd4ba5
\fInvme wdc vs\-drive\-info\fR <device>
Packit dd4ba5
.fi
Packit dd4ba5
.SH "DESCRIPTION"
Packit dd4ba5
.sp
Packit dd4ba5
For the NVMe device given, send the unique WDC vs\-drive\-info command and provide the additional drive information\&.
Packit dd4ba5
.sp
Packit dd4ba5
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&.
Packit dd4ba5
.sp
Packit dd4ba5
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
Packit dd4ba5
.sp
Packit dd4ba5
On success it returns 0, error code otherwise\&.
Packit dd4ba5
.SH "OUTPUT EXPLANATION"
Packit dd4ba5
.sp
Packit dd4ba5
There are 2 fields returned from this command:
Packit dd4ba5
.sp
Packit dd4ba5
Drive HW Revision
Packit dd4ba5
.sp
Packit dd4ba5
FTL Unit Size
Packit dd4ba5
.SH "EXAMPLE"
Packit dd4ba5
.sp
Packit dd4ba5
# nvme wdc vs\-drive\-info /dev/nvme0
Packit dd4ba5
.SH "NVME"
Packit dd4ba5
.sp
Packit dd4ba5
Part of the nvme\-user suite\&.