]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: add extension plugins' command format
authorMinwoo Im <minwoo.im.dev@gmail.com>
Tue, 23 Jul 2019 15:34:24 +0000 (00:34 +0900)
committerMinwoo Im <minwoo.im.dev@gmail.com>
Tue, 23 Jul 2019 15:39:39 +0000 (00:39 +0900)
If user wants to take a extension plugin, then it should be like:
nvme <plugin> <command> <device> [<args>]

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
Documentation/nvme.1
Documentation/nvme.html
Documentation/nvme.txt

index 0b2a8bad89435c8092eb4c9095e8057520baea5a..f8d10c58abb154d19737358f5a3962aa3bebdf33 100644 (file)
 nvme \- the NVMe storage command line interface utility (nvme\-cli)
 .SH "SYNOPSIS"
 .sp
+bulit\-in plugin:
+.sp
 .nf
 \fInvme\fR <command> <device> [<args>]
 .fi
+.sp
+extension plugins:
+.sp
+.nf
+\fInvme\fR <plugin> <command> <device> [<args>]
+.fi
 .SH "DESCRIPTION"
 .sp
 NVM\-Express is a fast, scalable host controller interface designed to address the needs for not only PCI Express based solid state drives, but also NVMe\-oF(over fabrics)\&.
index bad6f1c1b41200c217b5f3cec5158eb711635e13..c2ee5f0aa0035aa0a47dc9d3b1d436149f088f46 100644 (file)
@@ -748,10 +748,16 @@ nvme(1) Manual Page
 <div class="sect1">\r
 <h2 id="_synopsis">SYNOPSIS</h2>\r
 <div class="sectionbody">\r
+<div class="paragraph"><p>bulit-in plugin:</p></div>\r
 <div class="verseblock">\r
 <pre class="content"><em>nvme</em> &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>\r
 <div class="attribution">\r
 </div></div>\r
+<div class="paragraph"><p>extension plugins:</p></div>\r
+<div class="verseblock">\r
+<pre class="content"><em>nvme</em> &lt;plugin&gt; &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>\r
+<div class="attribution">\r
+</div></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
index 0092be79a745d35dc7f95660d99048cdaf0ce773..e8ead9ea99daa3e30a3e590bef74504380d029e4 100644 (file)
@@ -7,8 +7,13 @@ nvme - the NVMe storage command line interface utility (nvme-cli)
 
 SYNOPSIS
 --------
+bulit-in plugin:
 [verse]
-'nvme' <command> <device> [<args>] 
+'nvme' <command> <device> [<args>]
+
+extension plugins:
+[verse]
+'nvme' <plugin> <command> <device> [<args>]
 
 DESCRIPTION
 -----------