From: Keith Busch Date: Wed, 12 Oct 2016 19:17:14 +0000 (-0400) Subject: Man page updates X-Git-Tag: v1.0~18 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=e301c73bf7456b31d16fc227eb2a05273f6b264a;p=users%2Fsagi%2Fnvme-cli.git Man page updates Fix the connect-all manpage header section and regenerate all the manpages. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index f9fb34e2..1dce7d72 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: 09/29/2016 +.\" Date: 10/12/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "09/29/2016" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "10/12/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index abf0f4c3..750ad969 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: 09/22/2016 +.\" Date: 10/12/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "09/22/2016" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "10/12/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index 0b62aede..7cc7b778 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: 09/29/2016 +.\" Date: 10/12/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "09/29/2016" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "10/12/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 new file mode 100644 index 00000000..2beb29b2 --- /dev/null +++ b/Documentation/nvme-connect-all.1 @@ -0,0 +1,160 @@ +'\" t +.\" Title: nvme-connect-all +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/12/2016 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-CONNECT\-ALL" "1" "10/12/2016" "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-connect-all \- Discover and Connect to Fabrics controllers\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme connect\-all\fR + [\-\-transport= | \-t ] + [\-\-traddr= | \-a ] + [\-\-trsvcid= | \-s ] + [\-\-hostnqn= | \-q ] + [\-\-raw= | \-r ] +.fi +.SH "DESCRIPTION" +.sp +Send one or more Discovery requests to a NVMe over Fabrics Discovery Controller, and create controllers for the returned discovery records\&. +.sp +If no parameters are given, then \fInvme connect\-all\fR will attempt to find a /etc/nvme/discovery\&.conf file to use to supply a list of Connect\-all commands to run\&. If no /etc/nvme/discovery\&.conf file exists, the command will quit with an error\&. +.sp +Otherwise a specific Discovery Controller should be specified using the \-\-transport, \-\-traddr and if nessecary the \-\-trsvcid and a Diѕcovery request will be sent to the specified Discovery Controller\&. +.sp +See the documentation for the nvme\-discover(1) command for further background\&. +.SH "OPTIONS" +.PP +\-t , \-\-transport= +.RS 4 +This field specifies the network fabric being used for a NVMe\-over\-Fabrics network\&. Current string values include: +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt. +T{ +Value +T}:T{ +Definition +T} +T{ +rdma +T}:T{ +The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) +T} +T{ +fc +T}:T{ +\fBWIP\fR +The network fabric is a Fibre Channel network\&. +T} +T{ +loop +T}:T{ +Connect to a NVMe over Fabrics target on the local host +T} +.TE +.sp 1 +.RE +.PP +\-a , \-\-traddr= +.RS 4 +This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IPv4 address\&. +.RE +.PP +\-s , \-\-trsvcid= +.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\&. +.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 or autogenerated by the kernel (in that order)\&. 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 +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Connect to all records returned by the Discover Controller with IP4 address 192\&.168\&.1\&.3 for all resources allocated for NVMe Host name host1\-rogue\-nqn on the RDMA network\&. Port 4420 is used by default: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme connect\-all \-\-transport=rdma \-\-traddr=192\&.168\&.1\&.3 \e +\-\-hostnqn=host1\-rogue\-nqn +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Issue a +\fInvme connect\-all\fR +command using a /etc/nvme/discovery\&.conf file: +.RE +.sp +.if n \{\ +.RS 4 +.\} +.nf +# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the +# Discovery Controller\*(Aqs two ports (some resources may only +# be accessible on a single port)\&. Note an official +# nqn (Host) name defined in the NVMe specification is being used +# in this example\&. +\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 +\-t rdma \-a 192\&.168\&.1\&.4 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 + +At the prompt type "nvme connect\-all"\&. +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.sp +nvme\-discover(1) nvme\-connect(1) +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html new file mode 100644 index 00000000..1ef0a7eb --- /dev/null +++ b/Documentation/nvme-connect-all.html @@ -0,0 +1,920 @@ + + + + + +nvme-connect-all(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme connect-all
+                [--transport=<trtype> | -t <trtype>]
+                [--traddr=<traddr>    | -a <traddr>]
+                [--trsvcid=<trsvcid>  | -s <trsvcid>]
+                [--hostnqn=<hostnqn>  | -q <hostnqn>]
+                [--raw=<filename>     | -r <filename>]
+
+
+
+
+
+

DESCRIPTION

+
+

Send one or more Discovery requests to a NVMe over Fabrics Discovery +Controller, and create controllers for the returned discovery records.

+

If no parameters are given, then nvme connect-all will attempt to +find a /etc/nvme/discovery.conf file to use to supply a list of +Connect-all commands to run. If no /etc/nvme/discovery.conf file exists, +the command will quit with an error.

+

Otherwise a specific Discovery Controller should be specified using the +--transport, --traddr and if nessecary the --trsvcid and a Diѕcovery +request will be sent to the specified Discovery Controller.

+

See the documentation for the nvme-discover(1) command for further +background.

+
+
+
+

OPTIONS

+
+
+
+-t <trtype> +
+
+--transport=<trtype> +
+
+

+ 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

+
+
+
+-a <traddr> +
+
+--traddr=<traddr> +
+
+

+ This field specifies the network address of the Discovery Controller. + For transports using IP addressing (e.g. rdma) this should be an IPv4 + address. +

+
+
+-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. +

+
+
+-q <hostnqn> +
+
+--hostnqn=<hostnqn> +
+
+

+ Overrides the default host NQN that identifies the NVMe Host. If this + option is not specified the default is read from /etc/nvme/hostnqn or + autogenerated by the kernel (in that order). + 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. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Connect to all records returned by the Discover Controller with IP4 address +192.168.1.3 for all resources allocated for NVMe Host name host1-rogue-nqn on +the RDMA network. Port 4420 is used by default: +

    +
    +
    +
    # nvme connect-all --transport=rdma --traddr=192.168.1.3 \
+--hostnqn=host1-rogue-nqn
    +
    +
    • +
  • +

    +Issue a nvme connect-all command using a /etc/nvme/discovery.conf file: +

    +
    • +
+
+
+
# Machine default 'nvme discover' commands.  Query the
+# Discovery Controller's two ports (some resources may only
+# be accessible on a single port).  Note an official
+# nqn (Host) name defined in the NVMe specification is being used
+# in this example.
+-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+-t rdma -a 192.168.1.4   -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+
+At the prompt type "nvme connect-all".
+
+
+
+
+

SEE ALSO

+
+

nvme-discover(1) +nvme-connect(1)

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index fa40b416..f07ef93e 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -1,5 +1,5 @@ nvme-connect-all(1) -============== +=================== NAME ---- diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index c819a4ec..5fca58be 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" Date: 10/10/2016 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/12/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "10/10/2016" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "10/12/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -117,9 +117,6 @@ nvme\-discover(1) .SH "AUTHORS" .sp This was co\-written by \m[blue]\fBJay Freyensee\fR\m[]\&\s-2\u[1]\d\s+2 and \m[blue]\fBChristoph Hellwig\fR\m[]\&\s-2\u[2]\d\s+2 for \m[blue]\fBKeith Busch\fR\m[]\&\s-2\u[3]\d\s+2\&. -.SH "REPORTING BUGS" -.sp -Patches and issues for \fIconnect\fR should be submitted to the Linux kernel email list \m[blue]\fBlinux\-nvme\fR\m[]\&\s-2\u[4]\d\s+2 before merging to \m[blue]\fBhttps://github\&.com/linux\-nvme/nvme\-cli\fR\m[]\&. .SH "NVME" .sp Part of the nvme\-user suite @@ -139,8 +136,3 @@ Keith Busch .RS 4 \%mailto:keith.busch@intel.com .RE -.IP " 4." 4 -linux-nvme -.RS 4 -\%mailto:linux-nvme@lists.infradead.org -.RE diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index d39c7a22..2b8ca327 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -3,7 +3,7 @@ - + nvme-connect(1)