sbin/nvmectl/nvmectl.8

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