NVMe: Add top level man page

Man pages were provided for the sub-commands, but none for the nvme
program itself. Not particularly well documented, but it's there now.

Signed-off-by: Keith Busch <keith.busch@intel.com>

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 1f53bcfe76c0a04faf3dce85e01de9a9df3d3cb9..70efe8df22a1b4407e674c30e7b1b3b976b08dbf 100644 (file)
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -7,7 +7,7 @@ SP_ARTICLES =
 MAN1_TXT += $(filter-out \
                $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
                $(wildcard nvme-*.txt))
-
+MAN1_TXT += nvme.txt
 MAN_TXT = $(MAN1_TXT)
 MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
 

diff --git a/Documentation/nvme.1 b/Documentation/nvme.1
new file mode 100644 (file)
index 0000000..3455f7f
--- /dev/null
+++ b/Documentation/nvme.1
@@ -0,0 +1,72 @@
+'\" t
+.\"     Title: nvme
+.\"    Author: [see the "Authors" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 02/03/2015
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "NVME" "1" "02/03/2015" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme \- the dumb pci\-e storage utility
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme\fR <command> <device> [<args>]
+.fi
+.SH "DESCRIPTION"
+.sp
+NVM\-Express is a fast, scalabale host controller interface designed to address the needs for PCI Express based solida state drives\&.
+.sp
+This \fInvme\fR program is a user space utility to provide standards compliant tooling for NVM\-Express drives\&. It was made specifically for Linux as it relies on the IOCTLs defined by the mailine kernel driver\&.
+.SH "NVME COMMANDS"
+.sp
+The utility has sub\-commands for all admin and io commands defined in the specification and for displaying controller registers\&. There is also an option to submit completely arbitrary commands\&. For a list of commands available, run "nvme help"\&.
+.SH "FURTHER DOCUMENTATION"
+.sp
+See the freely available references on \m[blue]\fBOffical NVM\-Express Site\fR\m[]\&\s-2\u[1]\d\s+2\&.
+.SH "AUTHORS"
+.sp
+This is written and maintained by \m[blue]\fBKeith Busch\fR\m[]\&\s-2\u[2]\d\s+2\&.
+.SH "REPORTING BUGS"
+.sp
+Patches and bugs may be submitted to the \m[blue]\fBLinux NVMe Mailing list\fR\m[]\&\s-2\u[3]\d\s+2\&. While primarily for kernel driver development, we can use it for user space tooling\&.
+.SH "NVME"
+.sp
+Part of the nvme suite
+.SH "NOTES"
+.IP " 1." 4
+Offical NVM-Express Site
+.RS 4
+\%http://nvmexpress.org
+.RE
+.IP " 2." 4
+Keith Busch
+.RS 4
+\%mailto:keith.busch@intel.com
+.RE
+.IP " 3." 4
+Linux NVMe Mailing list
+.RS 4
+\%mailto:linux-nvme@lists.infradead.org
+.RE

diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt
new file mode 100644 (file)
index 0000000..ce3cd24
--- /dev/null
+++ b/Documentation/nvme.txt
@@ -0,0 +1,47 @@
+nvme(1)
+=======
+
+NAME
+----
+nvme - the dumb pci-e storage utility
+
+SYNOPSIS
+--------
+[verse]
+'nvme' <command> <device> [<args>] 
+
+DESCRIPTION
+-----------
+NVM-Express is a fast, scalabale host controller interface designed to
+address the needs for PCI Express based solida state drives.
+
+This 'nvme' program is a user space utility to provide standards compliant
+tooling for NVM-Express drives. It was made specifically for Linux as
+it relies on the IOCTLs defined by the mailine kernel driver.
+
+NVME COMMANDS
+-------------
+The utility has sub-commands for all admin and io commands defined in the
+specification and for displaying controller registers. There is also an
+option to submit completely arbitrary commands. For a list of commands
+available, run "nvme help".
+
+FURTHER DOCUMENTATION
+---------------------
+See the freely available references on the http://nvmexpress.org[Offical
+NVM-Express Site].
+
+Authors
+-------
+This is written and maintained by mailto:keith.busch@intel.com[Keith Busch].
+
+Reporting Bugs
+--------------
+Patches and bugs may be submitted to the
+mailto:linux-nvme@lists.infradead.org[Linux NVMe Mailing list]. While
+primarily for kernel driver development, we can use it for user space
+tooling.
+
+NVME
+----
+Part of the nvme suite