From mboxrd@z Thu Jan 1 00:00:00 1970 From: martinus.gpy@gmail.com (martinus.gpy@gmail.com) Date: Mon, 1 Apr 2019 22:09:57 +0530 Subject: [PATCH 2/2] nvme-cli: add netapp ontapdevices man page In-Reply-To: <20190401163957.2899-1-marting@netapp.com> References: <20190401163957.2899-1-marting@netapp.com> Message-ID: <20190401163957.2899-3-marting@netapp.com> From: Martin George Signed-off-by: Martin George Reviewed-by: Steve Schremmer --- Documentation/nvme-netapp-ontapdevices.1 | 74 ++ Documentation/nvme-netapp-ontapdevices.html | 814 ++++++++++++++++++++ Documentation/nvme-netapp-ontapdevices.txt | 35 + 3 files changed, 923 insertions(+) create mode 100644 Documentation/nvme-netapp-ontapdevices.1 create mode 100644 Documentation/nvme-netapp-ontapdevices.html create mode 100644 Documentation/nvme-netapp-ontapdevices.txt diff --git a/Documentation/nvme-netapp-ontapdevices.1 b/Documentation/nvme-netapp-ontapdevices.1 new file mode 100644 index 0000000..0669457 --- /dev/null +++ b/Documentation/nvme-netapp-ontapdevices.1 @@ -0,0 +1,74 @@ +'\" t +.\" Title: nvme-netapp-ontapdevices +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 01/08/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-NETAPP\-ONTAPDEV" "1" "01/08/2019" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * 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-netapp-ontapdevices \- Display information about ONTAP devices +.SH "SYNOPSIS" +.sp +.nf +\fInvme netapp ontapdevices\fR [\-o | \-\-output\-format=] +.fi +.SH "DESCRIPTION" +.sp +Display information about ONTAP devices on the host\&. The ONTAP devices are identified using the Identify Controller data\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +(default), +\fIcolumn\fR, or +\fIjson\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display information, in a column\-based format, for ONTAP devices\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme netapp ontapdevices \-o column +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-netapp-ontapdevices.html b/Documentation/nvme-netapp-ontapdevices.html new file mode 100644 index 0000000..792801e --- /dev/null +++ b/Documentation/nvme-netapp-ontapdevices.html @@ -0,0 +1,814 @@ + + + + + + +nvme-netapp-ontapdevices(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme netapp ontapdevices [-o <fmt> | --output-format=<fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Display information about ONTAP devices on the host. +The ONTAP devices are identified using the Identify Controller data.

+
+
+
+

OPTIONS

+
+
+
+-o <fmt> +
+
+--output-format=<fmt> +
+
+

+ Set the reporting format to normal (default), column, or + json. Only one output format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Display information, in a column-based format, for ONTAP devices. +

    +
    +
    +
    # nvme netapp ontapdevices -o column
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-netapp-ontapdevices.txt b/Documentation/nvme-netapp-ontapdevices.txt new file mode 100644 index 0000000..09369f1 --- /dev/null +++ b/Documentation/nvme-netapp-ontapdevices.txt @@ -0,0 +1,35 @@ +nvme-netapp-ontapdevices(1) +======================== + +NAME +---- +nvme-netapp-ontapdevices - Display information about ONTAP devices + +SYNOPSIS +-------- +[verse] +'nvme netapp ontapdevices' [-o | --output-format=] + +DESCRIPTION +----------- +Display information about ONTAP devices on the host. The ONTAP devices are +are identified using the Identify Controller data. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' (default), 'column', or + 'json'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Display information, in a column-based format, for ONTAP devices. ++ +------------ +# nvme netapp ontapdevices -o column +------------ + +NVME +---- +Part of the nvme-user suite -- 2.17.1