From: Christoph Hellwig <hch@lst.de>
Date: Thu, 17 Nov 2016 16:26:26 +0000 (+0100)
Subject: add a full blown connect man page
X-Git-Tag: v1.1~22
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=6cda5f568765f639f9e6e08d4d3e10fbc530e34f;p=users%2Fsagi%2Fnvme-cli.git

add a full blown connect man page

Mostly based on the wording in connect-all.

Signed-off-by: Christoph Hellwig <hch@lst.de>
[Removed older/duplicate option]
Signed-off-by: Keith Busch <keith.busch@intel.com>
---

diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt
index affcedf0..38fae399 100644
--- a/Documentation/nvme-connect.txt
+++ b/Documentation/nvme-connect.txt
@@ -3,79 +3,102 @@ nvme-connect(1)
 
 NAME
 ----
-nvme-connect - Connect to an NVMe-over-Fabrics subsystem.
+nvme-connect - Connect to a Fabrics controller.
 
 SYNOPSIS
 --------
 [verse]
-'nvme connect'	[device]
-		[--transport=<trtype>  | -t <trtype>]
-		[--traddr=<traddr>     | -a <traddr>]
-		[--host-traddr=<traddr>| -w <host-traddr>]
-		[--trsvcid=<trsvcid>   | -s <trsvcid>]
-		[--hostnqn=<hostnqn>   | -q <hostnqn>]
-		[--nqn=<subnqn>        | -n <subnqn>]
-		[--nr-io-queues=<#>    | -i <#>]
-		[--keep-alive-tmo=<#>  | -k <#>]
-		[--reconnect-delay=<#> | -c <#>]
+'nvme connect'
+		[--transport=<trtype>     | -t <trtype>]
+		[--nqn=<subnqn>           | -n <subnqn>]
+		[--traddr=<traddr>        | -a <traddr>]
+		[--trsvcid=<trsvcid>      | -s <trsvcid>]
+		[--host-traddr=<traddr>   | -w <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--nr-io-queues=<#>       | -i <#>]
+		[--keep-alive-tmo=<#>     | -k <#>]
+		[--reconnect-delay=<#>    | -c <#>]
 
 DESCRIPTION
 -----------
-TBD (note 'device' is optional)
-
-BACKGROUND
-----------
-TBD
+Create a transport connection to a remote system (specified by --traddr and
+--trsvcid) and create a NVMe over Fabrics controller for the NVMe subsystem
+specified by the --nqn option.
 
 OPTIONS
 -------
 -t <trtype>::
 --transport=<trtype>::
-	TBD
+	This field specifies the network fabric being used for
+	a NVMe-over-Fabrics network.  Current string values include:
++
+[]
+|=================
+|Value|Definition
+|rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
+|fc  |*WIP* The network fabric is a Fibre Channel network.
+|loop|Connect to a NVMe over Fabrics target on the local host
+|=================
+
+-n <subnqn>::
+--nqn <subnqn>::
+	This field specifies the name for the NVMe subsystem to connect to.
 
 -a <traddr>::
 --traddr=<traddr>::
-	TBD
+	This field specifies the network address of the Controller.
+	For transports using IP addressing (e.g. rdma) this should be an
+	IP-based address (ex. IPv4).
+
+-s <trsvcid>::
+--trsvcid=<trsvcid>::
+	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.
 
 -w <traddr>::
 --host-traddr=<traddr>::
-	TBD
+	This field specifies the network address used on the host to connect
+	to the Controller.
 
--s <trsvcid>::
---trsvcid=<trsvcid>::
-	TBD
- 
 -q <hostnqn>::
 --hostnqn=<hostnqn>::
-	TBD
-
--n <subnqn>::
---nqn=<subnqn>::
-	TBD
+	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.
 
 -i <#>::
---nr-io-queues<#>::
-	TBD
+--nr-io-queues=<#>::
+	Overrides the default number of I/O queues create by the driver.
 
 -k <#>::
 --keep-alive-tmo=<#>::
-	TBD
+	Overrides the default keep alive timeout (in seconds).
 
 -c <#>::
 --reconnect-delay=<#>::
-	TBD
+	Overrides the default delay (in seconds) before reconnect is attempted
+	after a connect loss.
 
 EXAMPLES
 --------
-* TBD
+* Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+on the IP4 address 192.168.1.3. Port 4420 is used by default:
 +
 ------------
-# nvme connect... 
+# nvme connect --transport=rdma --traddr=192.168.1.3 \
+--nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+------------
+
 ------------
 
 SEE ALSO
 --------
 nvme-discover(1)
+nvme-connect-all(1)
+
 
 AUTHORS
 -------