]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
add a disconnect man page
authorChristoph Hellwig <hch@lst.de>
Thu, 17 Nov 2016 16:26:27 +0000 (17:26 +0100)
committerKeith Busch <keith.busch@intel.com>
Thu, 17 Nov 2016 16:52:18 +0000 (11:52 -0500)
Signed-off-by: Christoph Hellwig <hch@lst.de>
Documentation/nvme-disconnect.txt [new file with mode: 0644]

diff --git a/Documentation/nvme-disconnect.txt b/Documentation/nvme-disconnect.txt
new file mode 100644 (file)
index 0000000..703d901
--- /dev/null
@@ -0,0 +1,58 @@
+nvme-disconnect(1)
+==================
+
+NAME
+----
+nvme-disconnect - Disonnect one or more Fabrics controller(s).
+
+SYNOPSIS
+--------
+[verse]
+'nvme connect'
+               [--nqn=<subnqn>           | -n <subnqn>]
+               [--device=<device>        | -d <device>]
+
+DESCRIPTION
+-----------
+Disconnects and removes one or more existing NVMe over Fabrics controllers.
+If the --nqn option is specified all controllers connecting to the Subsystem
+identified by subnqn will be removed.  If the --device option is specified
+the controller specified by the --device option will be removed.
+
+OPTIONS
+-------
+-n <subnqn>::
+--nqn <subnqn>::
+       Indicates that all controllers for the NVMe subsystems specified
+       should be removed.
+
+-d <device>::
+--device <device>::
+       Indicates that the controller with the specified name should be
+       removed.
+
+EXAMPLES
+--------
+* Disconnect all controllers for a subsystem named
+nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432:
++
+------------
+# nvme disconnect --nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+------------
+
+* Disconnect the controller nvme4
++
+------------
+# nvme disconnect --device=nvme4
+------------
+
+------------
+
+SEE ALSO
+--------
+nvme-connect(1)
+
+
+NVME
+----
+Part of the nvme-user suite