xref: /dflybsd-src/sbin/nvmectl/nvmectl.8 (revision 278713ffe097f9c3205e13c3b5a5cc686472870d)
1*278713ffSSascha Wildner.\"
2*278713ffSSascha Wildner.\" Copyright (c) 2016 The DragonFly Project.  All rights reserved.
3*278713ffSSascha Wildner.\"
4*278713ffSSascha Wildner.\" Redistribution and use in source and binary forms, with or without
5*278713ffSSascha Wildner.\" modification, are permitted provided that the following conditions
6*278713ffSSascha Wildner.\" are met:
7*278713ffSSascha Wildner.\"
8*278713ffSSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
9*278713ffSSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
10*278713ffSSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
11*278713ffSSascha Wildner.\"    notice, this list of conditions and the following disclaimer in
12*278713ffSSascha Wildner.\"    the documentation and/or other materials provided with the
13*278713ffSSascha Wildner.\"    distribution.
14*278713ffSSascha Wildner.\" 3. Neither the name of The DragonFly Project nor the names of its
15*278713ffSSascha Wildner.\"    contributors may be used to endorse or promote products derived
16*278713ffSSascha Wildner.\"    from this software without specific, prior written permission.
17*278713ffSSascha Wildner.\"
18*278713ffSSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19*278713ffSSascha Wildner.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20*278713ffSSascha Wildner.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21*278713ffSSascha Wildner.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22*278713ffSSascha Wildner.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23*278713ffSSascha Wildner.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24*278713ffSSascha Wildner.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25*278713ffSSascha Wildner.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26*278713ffSSascha Wildner.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27*278713ffSSascha Wildner.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28*278713ffSSascha Wildner.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29*278713ffSSascha Wildner.\" SUCH DAMAGE.
30*278713ffSSascha Wildner.\"
31*278713ffSSascha Wildner.Dd December 3, 2016
32*278713ffSSascha Wildner.Dt NVMECTL 8
33*278713ffSSascha Wildner.Os
34*278713ffSSascha Wildner.Sh NAME
35*278713ffSSascha Wildner.Nm nvmectl
36*278713ffSSascha Wildner.Nd NVM Express (NVMe) userland utility
37*278713ffSSascha Wildner.Sh SYNOPSIS
38*278713ffSSascha Wildner.Nm
39*278713ffSSascha Wildner.Op Fl v
40*278713ffSSascha Wildner.Ar command
41*278713ffSSascha Wildner.Ar device
42*278713ffSSascha Wildner.Sh DESCRIPTION
43*278713ffSSascha WildnerThe
44*278713ffSSascha Wildner.Nm
45*278713ffSSascha Wildnerutility interacts with the
46*278713ffSSascha Wildner.Xr nvme 4
47*278713ffSSascha Wildnercontroller specified in the
48*278713ffSSascha Wildner.Ar device
49*278713ffSSascha Wildnerargument (for example
50*278713ffSSascha Wildner.Pa nvme0 ) .
51*278713ffSSascha Wildner.Pp
52*278713ffSSascha WildnerIt supports the following options:
53*278713ffSSascha Wildner.Bl -tag -width indent
54*278713ffSSascha Wildner.It Fl v
55*278713ffSSascha WildnerCurrently, this option is a no-op.
56*278713ffSSascha Wildner.El
57*278713ffSSascha Wildner.Pp
58*278713ffSSascha WildnerThe following commands are available:
59*278713ffSSascha Wildner.Bl -tag -width indent
60*278713ffSSascha Wildner.It Ic errors
61*278713ffSSascha WildnerDisplays errors from the controller's log.
62*278713ffSSascha Wildner.It Ic info
63*278713ffSSascha WildnerDisplays S.M.A.R.T. information from the controller's log.
64*278713ffSSascha Wildner.El
65*278713ffSSascha Wildner.Sh EXAMPLES
66*278713ffSSascha Wildner.Dl nvmectl errors nvme0
67*278713ffSSascha Wildner.Pp
68*278713ffSSascha Wildner.Dl nvmectl info nvme0
69*278713ffSSascha Wildner.Sh SEE ALSO
70*278713ffSSascha Wildner.Xr nvme 4
71*278713ffSSascha Wildner.Sh HISTORY
72*278713ffSSascha WildnerThe
73*278713ffSSascha Wildner.Nm
74*278713ffSSascha Wildnerutility first appeared in
75*278713ffSSascha Wildner.Dx 4.5 .
76*278713ffSSascha Wildner.Sh AUTHORS
77*278713ffSSascha Wildner.An Matthew Dillon
78