From: Keith Busch
Date: Thu, 17 Nov 2016 16:45:01 +0000 (-0500)
Subject: Update man pages
X-Git-Tag: v1.1~20
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=8af4fabf94acfb4e0d8e75bb8a77097c4cba157c;p=users%2Fsagi%2Fnvme-cli.git
Update man pages
Signed-off-by: Keith Busch
---
diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1
index e40e85aa..9f7cf820 100644
--- a/Documentation/nvme-admin-passthru.1
+++ b/Documentation/nvme-admin-passthru.1
@@ -2,12 +2,12 @@
.\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
-.\" Date: 10/21/2016
+.\" Date: 11/17/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "11/17/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1
index b2893623..e58d83ca 100644
--- a/Documentation/nvme-attach-ns.1
+++ b/Documentation/nvme-attach-ns.1
@@ -2,12 +2,12 @@
.\" Title: nvme-attach-ns
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
-.\" Date: 10/21/2016
+.\" Date: 11/17/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ATTACH\-NS" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-ATTACH\-NS" "1" "11/17/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1
index 57d66c9e..babcc48e 100644
--- a/Documentation/nvme-compare.1
+++ b/Documentation/nvme-compare.1
@@ -2,12 +2,12 @@
.\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
-.\" Date: 10/21/2016
+.\" Date: 11/17/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-COMPARE" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-COMPARE" "1" "11/17/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1
index 79a42139..7ba4659e 100644
--- a/Documentation/nvme-connect-all.1
+++ b/Documentation/nvme-connect-all.1
@@ -2,12 +2,12 @@
.\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
-.\" Date: 10/27/2016
+.\" Date: 11/17/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CONNECT\-ALL" "1" "10/27/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT\-ALL" "1" "11/17/2016" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -33,12 +33,12 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
.sp
.nf
\fInvme connect\-all\fR
- [\-\-transport= | \-t ]
- [\-\-traddr= | \-a ]
- [\-\-host\-traddr=| \-w ]
- [\-\-trsvcid= | \-s ]
- [\-\-hostnqn= | \-q ]
- [\-\-raw= | \-r ]
+ [\-\-transport= | \-t ]
+ [\-\-traddr= | \-a ]
+ [\-\-trsvcid= | \-s ]
+ [\-\-host\-traddr= | \-w ]
+ [\-\-hostnqn= | \-q ]
+ [\-\-raw= | \-r ]
.fi
.SH "DESCRIPTION"
.sp
@@ -90,20 +90,29 @@ T}
This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based address (ex\&. IPv4)\&.
.RE
.PP
-\-w , \-\-host\-traddr=
+\-s , \-\-trsvcid=
.RS 4
-This field specificies the host traddr\&. Eg\&.: FC WWN\(cqs\&.
+This field specifies the transport service id\&. For transports using IP addressing (e\&.g\&. rdma) this field is the port number\&. By default, the IP port number for the RDMA transport is 4420\&.
.RE
.PP
-\-s , \-\-trsvcid=
+\-w , \-\-host\-traddr=
.RS 4
-This field specifies the transport service id\&. For transports using IP addressing (e\&.g\&. rdma) this field is the port number\&. By default, the IP port number for the RDMA transport is 4420\&.
+This field specifies the network address used on the host to connect to the Discovery Controller\&.
.RE
.PP
\-q , \-\-hostnqn=
.RS 4
Overrides the default Host NQN that identifies the NVMe Host\&. If this option is not specified, the default is read from /etc/nvme/hostnqn first\&. If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next\&. The Host NQN uniquely identifies the NVMe Host, and may be used by the the Discovery Controller to control what NVMe Target resources are allocated to the NVMe Host for a connection\&.
.RE
+.PP
+\-r , \-\-raw=
+.RS 4
+This field will take the output of the
+\fInvme connect\-all\fR
+command and dump it to a raw binary file\&. By default
+\fInvme connect\-all\fR
+will dump the output to stdout\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html
index 404caebc..841d2e0f 100644
--- a/Documentation/nvme-connect-all.html
+++ b/Documentation/nvme-connect-all.html
@@ -747,12 +747,12 @@ nvme-connect-all(1) Manual Page
nvme connect-all
- [--transport=<trtype> | -t <trtype>]
- [--traddr=<traddr> | -a <traddr>]
- [--host-traddr=<traddr>| -w <host-traddr>]
- [--trsvcid=<trsvcid> | -s <trsvcid>]
- [--hostnqn=<hostnqn> | -q <hostnqn>]
- [--raw=<filename> | -r <filename>]
+ [--transport=<trtype> | -t <trtype>]
+ [--traddr=<traddr> | -a <traddr>]
+ [--trsvcid=<trsvcid> | -s <trsvcid>]
+ [--host_traddr=<traddr> | -w <traddr>]
+ [--hostnqn=<hostnqn> | -q <hostnqn>]
+ [--raw=<filename> | -r <filename>]
@@ -854,6 +854,18 @@ cellspacing="0" cellpadding="4">
+-s <traddr>
+
+
+--host_traddr=<traddr>
+
+
+
+ This field specifies the network address used on the host to connect
+ to the Discovery Controller.
+
+
+
-q <hostnqn>
@@ -870,6 +882,19 @@ cellspacing="0" cellpadding="4">
allocated to the NVMe Host for a connection.
+
+-r <filename>
+
+
+--raw=<filename>
+
+
+
+ This field will take the output of the nvme connect-all command
+ and dump it to a raw binary file. By default nvme connect-all will
+ dump the output to stdout.
+
+
@@ -926,7 +951,7 @@ nvme-connect(1)