Skip to content

Commit 032cc2e

Browse files
jeff-lien-sndkkeithbusch
authored andcommitted
Add documentation files for new wdc plugin command - vs-drive-info
1 parent d559650 commit 032cc2e

3 files changed

Lines changed: 894 additions & 0 deletions

File tree

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
'\" t
2+
.\" Title: nvme-wdc-vs-drive-info
3+
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4+
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5+
.\" Date: 02/21/2020
6+
.\" Manual: NVMe Manual
7+
.\" Source: NVMe
8+
.\" Language: English
9+
.\"
10+
.TH "NVME\-WDC\-VS\-DRIVE" "1" "02/21/2020" "NVMe" "NVMe Manual"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
nvme-wdc-vs-drive-info \- Send the NVMe WDC vs\-drive\-info command, return result
32+
.SH "SYNOPSIS"
33+
.sp
34+
.nf
35+
\fInvme wdc vs\-drive\-info\fR <device>
36+
.fi
37+
.SH "DESCRIPTION"
38+
.sp
39+
For the NVMe device given, send the unique WDC vs\-drive\-info command and provide the additional drive information\&.
40+
.sp
41+
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&.
42+
.sp
43+
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
44+
.sp
45+
On success it returns 0, error code otherwise\&.
46+
.SH "OUTPUT EXPLANATION"
47+
.sp
48+
There are 2 fields returned from this command:
49+
.sp
50+
Drive HW Revision
51+
.sp
52+
FTL Unit Size
53+
.SH "EXAMPLE"
54+
.sp
55+
# nvme wdc vs\-drive\-info /dev/nvme0
56+
.SH "NVME"
57+
.sp
58+
Part of the nvme\-user suite\&.

0 commit comments

Comments
 (0)