From 278713ffe097f9c3205e13c3b5a5cc686472870d Mon Sep 17 00:00:00 2001 From: Sascha Wildner Date: Sat, 3 Dec 2016 14:12:58 +0100 Subject: [PATCH] Add a minimal nvmectl(8) manual page. --- sbin/nvmectl/Makefile | 3 +- sbin/nvmectl/nvmectl.8 | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++ share/man/man4/nvme.4 | 3 +- 3 files changed, 80 insertions(+), 3 deletions(-) create mode 100644 sbin/nvmectl/nvmectl.8 diff --git a/sbin/nvmectl/Makefile b/sbin/nvmectl/Makefile index 48a3871719..c578c3741d 100644 --- a/sbin/nvmectl/Makefile +++ b/sbin/nvmectl/Makefile @@ -1,9 +1,8 @@ # # PROG= nvmectl -#MAN= nvmectl.8 -NOMAN=TRUE SRCS= nvmectl.c subs.c +MAN= nvmectl.8 CFLAGS+= -I${.CURDIR}/../../sys LDADD= -lutil diff --git a/sbin/nvmectl/nvmectl.8 b/sbin/nvmectl/nvmectl.8 new file mode 100644 index 0000000000..21951c2967 --- /dev/null +++ b/sbin/nvmectl/nvmectl.8 @@ -0,0 +1,77 @@ +.\" +.\" Copyright (c) 2016 The DragonFly Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" 3. Neither the name of The DragonFly Project nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific, prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 3, 2016 +.Dt NVMECTL 8 +.Os +.Sh NAME +.Nm nvmectl +.Nd NVM Express (NVMe) userland utility +.Sh SYNOPSIS +.Nm +.Op Fl v +.Ar command +.Ar device +.Sh DESCRIPTION +The +.Nm +utility interacts with the +.Xr nvme 4 +controller specified in the +.Ar device +argument (for example +.Pa nvme0 ) . +.Pp +It supports the following options: +.Bl -tag -width indent +.It Fl v +Currently, this option is a no-op. +.El +.Pp +The following commands are available: +.Bl -tag -width indent +.It Ic errors +Displays errors from the controller's log. +.It Ic info +Displays S.M.A.R.T. information from the controller's log. +.El +.Sh EXAMPLES +.Dl nvmectl errors nvme0 +.Pp +.Dl nvmectl info nvme0 +.Sh SEE ALSO +.Xr nvme 4 +.Sh HISTORY +The +.Nm +utility first appeared in +.Dx 4.5 . +.Sh AUTHORS +.An Matthew Dillon diff --git a/share/man/man4/nvme.4 b/share/man/man4/nvme.4 index e841146982..43da066365 100644 --- a/share/man/man4/nvme.4 +++ b/share/man/man4/nvme.4 @@ -170,7 +170,8 @@ configuring. So take this into consideration as well. .Xr ahci 4 , .Xr intro 4 , .Xr pci 4 , -.Xr loader.conf 5 +.Xr loader.conf 5 , +.Xr nvmectl 8 .Sh HISTORY The .Nm -- 2.11.4.GIT