From 38b4f1452eb4cb0fc17b57d3e5b84f2025708872 Mon Sep 17 00:00:00 2001 From: Steven Seungcheol Lee Date: Thu, 25 Nov 2021 14:21:51 +0900 Subject: [PATCH] doc: Documentation update (fix doc build error #1257) nvme-check-dhchap-key, nvme-gen-dhchap-key the line of === under title need to be written same length as title -> fix [asciidoc: FAILED: manpage document title is mandatory] nvme-connect-all, nvme-connect, nvme-discover new options are added Signed-off-by: Steven Seungcheol Lee --- Documentation/nvme-check-dhchap-key.1 | 51 ++ Documentation/nvme-check-dhchap-key.html | 800 +++++++++++++++++++++ Documentation/nvme-check-dhchap-key.txt | 2 +- Documentation/nvme-connect-all.1 | 37 +- Documentation/nvme-connect-all.html | 73 +- Documentation/nvme-connect.1 | 43 +- Documentation/nvme-connect.html | 90 ++- Documentation/nvme-discover.1 | 50 +- Documentation/nvme-discover.html | 97 ++- Documentation/nvme-gen-dhchap-key.1 | 69 ++ Documentation/nvme-gen-dhchap-key.html | 842 +++++++++++++++++++++++ Documentation/nvme-gen-dhchap-key.txt | 2 +- 12 files changed, 2110 insertions(+), 46 deletions(-) create mode 100644 Documentation/nvme-check-dhchap-key.1 create mode 100644 Documentation/nvme-check-dhchap-key.html create mode 100644 Documentation/nvme-gen-dhchap-key.1 create mode 100644 Documentation/nvme-gen-dhchap-key.html diff --git a/Documentation/nvme-check-dhchap-key.1 b/Documentation/nvme-check-dhchap-key.1 new file mode 100644 index 00000000..df8df218 --- /dev/null +++ b/Documentation/nvme-check-dhchap-key.1 @@ -0,0 +1,51 @@ +'\" t +.\" Title: nvme-check-dhchap-key +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 11/25/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-CHECK\-DHCHAP\" "1" "11/25/2021" "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-check-dhchap-key \- Check a generated host DH\-HMAC\-CHAP key +.SH "SYNOPSIS" +.sp +.nf +\fInvme check\-dhchap\-key\fR [\-\-key= ] +.fi +.SH "DESCRIPTION" +.sp +Checks if the key is a valid DH\-HMAC\-CHAP host key of the form: DHHC\-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints it to stdout\&. +.SH "OPTIONS" +.PP +\-k , \-\-key= +.RS 4 +Key to be checked\&. +.RE +.SH "EXAMPLES" +.sp +No Examples +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-check-dhchap-key.html b/Documentation/nvme-check-dhchap-key.html new file mode 100644 index 00000000..927ed7e6 --- /dev/null +++ b/Documentation/nvme-check-dhchap-key.html @@ -0,0 +1,800 @@ + + + + + +nvme-check-dhchap-key(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme check-dhchap-key [--key=<key> ]
+
+
+
+
+
+

DESCRIPTION

+
+

Checks if the key is a valid DH-HMAC-CHAP host key of the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout.

+
+
+
+

OPTIONS

+
+
+
+-k <key> +
+
+--key=<key> +
+
+

+ Key to be checked. +

+
+
+
+
+
+

EXAMPLES

+
+

No Examples

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-check-dhchap-key.txt b/Documentation/nvme-check-dhchap-key.txt index 75008c7b..9cfa1f73 100644 --- a/Documentation/nvme-check-dhchap-key.txt +++ b/Documentation/nvme-check-dhchap-key.txt @@ -1,5 +1,5 @@ nvme-check-dhchap-key(1) -=================== +======================== NAME ---- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index a53a0179..f2a03f47 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-connect-all -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 01/20/2021 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 11/25/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "01/20/2021" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "11/25/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,12 +34,15 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&. .nf \fInvme connect\-all\fR [\-\-transport= | \-t ] + [\-\-nqn= | \-n ] [\-\-traddr= | \-a ] [\-\-trsvcid= | \-s ] [\-\-host\-traddr= | \-w ] + [\-\-host\-iface= | \-f ] [\-\-hostnqn= | \-q ] [\-\-hostid= | \-I ] [\-\-raw= | \-r ] + [\-\-cfg\-file= | \-C ] [\-\-keep\-alive\-tmo=<#> | \-k <#>] [\-\-reconnect\-delay=<#> | \-c <#>] [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] @@ -52,6 +55,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&. [\-\-matching | \-m] [\-\-persistent | \-p] [\-\-quiet | \-S] + [\-\-dump\-config | \-O] .fi .SH "DESCRIPTION" .sp @@ -104,6 +108,11 @@ T} .sp 1 .RE .PP +\-n , \-\-nqn +.RS 4 +This field specifies the name for the NVMe subsystem to connect to\&. +.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 IP\-based address (ex\&. IPv4)\&. @@ -116,7 +125,12 @@ This field specifies the transport service id\&. For transports using IP address .PP \-w , \-\-host\-traddr= .RS 4 -This field specifies the network address used on the host to connect to the Discovery Controller\&. +This field specifies the network address used on the host to connect to the Controller\&. For TCP, this sets the source address on the socket\&. +.RE +.PP +\-f , \-\-host\-iface= +.RS 4 +This field specifies the network interface used on the host to connect to the Controller (e\&.g\&. IP eth1, enp2s0, enx78e7d1ea46da)\&. This forces the connection to be made on a specific interface instead of letting the system decide\&. .RE .PP \-q , \-\-hostnqn= @@ -138,6 +152,14 @@ command and dump it to a raw binary file\&. By default will dump the output to stdout\&. .RE .PP +\-C , \-\-config\-file= +.RS 4 +Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or +\fInone\fR +to not read in an existing configuration file\&. The JSON configuration file format is documented in +\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[] +.RE +.PP \-k <#>, \-\-keep\-alive\-tmo=<#> .RS 4 Overrides the default keep alive timeout (in seconds)\&. This option will be ignored for discovery, but will be passed on to the subsequent connect call\&. @@ -197,6 +219,11 @@ Don\(cqt remove the discovery controller after retrieving the discovery log page .RS 4 Suppress error messages\&. .RE +.PP +\-O, \-\-dump\-config +.RS 4 +Print out resulting JSON configuration file to stdout\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html index f779c7b9..8d6448b0 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.html @@ -1,10 +1,9 @@ - - + nvme-connect-all(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme gen-dhchap-key [--hmac=<hmac-id> | -h <hmac-id>]
+                      [--secret=<secret> | -s <secret> ]
+                      [--key-length=<len> | -l <len> ]
+                      [--nqn=<host-nqn> | -n <host-nqn> ]
+
+
+
+
+
+

DESCRIPTION

+
+

Generate a base64-encoded DH-HMAC-CHAP host key in the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout.

+
+
+
+

OPTIONS

+
+
+
+-h <hmac-id> +
+
+--hmac=<hmac-id> +
+
+

+ Select a HMAC algorithm to use. Possible values are: + 0 - No HMAC algorithm + 1 - SHA-256 + 2 - SHA-384 + 3 - SHA-512 +

+
+
+-s <secret> +
+
+--secret=<secret> +
+
+

+ Secret value (in hexadecimal) to be used for the key. If none are + provided a random value is used. +

+
+
+-l <len> +
+
+--key-length=<len> +
+
+

+ Length of the resulting key. Possible values are 32, 48, or 64. +

+
+
+-n <hostnqn> +
+
+--nqn=<hostnqn> +
+
+

+ Host-NQN to be used for the transformation. This parameter is only + valid if a non-zero HMAC function has been specified. +

+
+
+
+
+
+

EXAMPLES

+
+

No Examples

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-gen-dhchap-key.txt b/Documentation/nvme-gen-dhchap-key.txt index eecde761..79e8ed58 100644 --- a/Documentation/nvme-gen-dhchap-key.txt +++ b/Documentation/nvme-gen-dhchap-key.txt @@ -1,5 +1,5 @@ nvme-gen-dhchap-key(1) -=================== +====================== NAME ---- -- 2.50.1