summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-copy.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-copy.163
1 files changed, 45 insertions, 18 deletions
diff --git a/Documentation/nvme-copy.1 b/Documentation/nvme-copy.1
index 4228451..b3fe795 100644
--- a/Documentation/nvme-copy.1
+++ b/Documentation/nvme-copy.1
@@ -2,12 +2,12 @@
.\" Title: nvme-copy
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/21/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-COPY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-COPY" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -35,6 +35,8 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results
\fInvme\-copy\fR <device> [\-\-sdlba=<sdlba> | \-d <sdlba>]
[\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
[\-\-slbs=<slbas,> | \-s <slbas,>]
+ [\-\-snsids=<snsids,> | \-N <snsids,>]
+ [\-\-sopts=<sopts,> | \-O <sopts,>]
[\-\-limited\-retry | \-l]
[\-\-force\-unit\-access | \-f]
[\-\-prinfow=<prinfow> | \-p <prinfow>]
@@ -48,91 +50,116 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results
[\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-format=<entry\-format> | \-F <entry\-format>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&.
.SH "OPTIONS"
.PP
-\-\-sdlba=<sdlba>, \-d <sdlba>
+\-d <sdlba>, \-\-sdlba=<sdlba>
.RS 4
64\-bit addr of first destination logical block
.RE
.PP
-\-\-blocks=<nlb\-list,>, \-b <nlb\-list,>
+\-b <nlb\-list,>, \-\-blocks=<nlb\-list,>
.RS 4
Comma separated list of the number of blocks in each range
.RE
.PP
-\-\-slbs=<slbas,>, \-s <slbas,>
+\-s <slbas,>, \-\-slbs=<slbas,>
.RS 4
Comma separated list of the starting blocks in each range
.RE
.PP
-\-\-limited\-retry, \-l
+\-\-snsids=<snsids,>, \-N <snsids,>
+.RS 4
+Comma separated list of the source namespace identifiers in each range
+.RE
+.PP
+\-\-sopts=<sopts,>, \-O <sopts,>
+.RS 4
+Comma separated list of the source options in each range
+.RE
+.PP
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
-\-\-prinfow=<prinfow>, \-p <prinfow>
+\-p <prinfow>, \-\-prinfow=<prinfow>
.RS 4
Protection Information field write definition\&.
.RE
.PP
-\-\-prinfor=<prinfor>, \-P <prinfor>
+\-P <prinfor>, \-\-prinfor=<prinfor>
.RS 4
Protection Information field read definition\&.
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
initial lba reference tag\&.
.RE
.PP
-\-\-expected\-ref\-tags=<reftag,>, \-R <reftag,>
+\-R <reftag,>, \-\-expected\-ref\-tags=<reftag,>
.RS 4
expected lba reference tags (comma\-separated list)\&.
.RE
.PP
-\-\-app\-tag=<apptag>, \-a <apptag>
+\-a <apptag>, \-\-app\-tag=<apptag>
.RS 4
lba app tag
.RE
.PP
-\-\-expected\-app\-tags=<apptag,>, \-A <apptag,>
+\-A <apptag,>, \-\-expected\-app\-tags=<apptag,>
.RS 4
expected lba app tags (comma\-separated list)
.RE
.PP
-\-\-app\-mask=<appmask>, \-m <appmask>
+\-m <appmask>, \-\-app\-mask=<appmask>
.RS 4
lba tag mask
.RE
.PP
-\-\-expected\-app\-masks=<appmask,>, \-M <appmask,>
+\-M <appmask,>, \-\-expected\-app\-masks=<appmask,>
.RS 4
expected lba tag masks (comma\-separated list)
.RE
.PP
-\-\-dir\-type=<type>, \-T <type>
+\-T <type>, \-\-dir\-type=<type>
.RS 4
Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&.
.RE
.PP
-\-\-dir\-spec=<spec>, \-S <spec>
+\-S <spec>, \-\-dir\-spec=<spec>
.RS 4
Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
.RE
.PP
-\-\-format=<entry\-format>, \-F <entry\-format>
+\-F <entry\-format>, \-\-format=<entry\-format>
.RS 4
source range entry format
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.