]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
git add missing files
authorKeith Busch <keith.busch@intel.com>
Wed, 4 Feb 2015 22:38:10 +0000 (15:38 -0700)
committerKeith Busch <keith.busch@intel.com>
Wed, 4 Feb 2015 22:38:10 +0000 (15:38 -0700)
Signed-off-by: Keith Busch <keith.busch@intel.com>
Documentation/nvme-read.txt [new file with mode: 0644]
Documentation/nvme-write.txt [new file with mode: 0644]

diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt
new file mode 100644 (file)
index 0000000..f380c16
--- /dev/null
@@ -0,0 +1,40 @@
+nvme-compare(1)
+===============
+
+NAME
+----
+nvme-read - Send an NVMe Read command, provide results
+
+SYNOPSIS
+--------
+[verse]
+'nvme-read' <device> [--start-block=<slba> | -s <slba>]
+                       [--block-count=<nlb> | -c <nlb>]
+                       [--data-size=<size> | -z <size>]
+                       [--ref-tag=<reftag> | -r <reftag>]
+                       [--data=<data-file> | -d <data-file>]
+                       [--prinfo=<prinfo> | -p <prinfo>]
+                       [--app-tag-mask=<appmask> | -m <appmask>]
+                       [--app-tag=<apptag> | -a <apptag>]
+                       [--limited-retry | -l]
+                       [--force-unit-access | -f]
+
+DESCRIPTION
+-----------
+The Read command reads the logical blocks specified by the command from
+the medium and copies to the data data buffer provided. Will use stdout
+by default if you don't provide a file.
+
+OPTIONS
+-------
+--start-block=<slba>::
+-s <slba>::
+       Start block.
+
+EXAMPLES
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite
diff --git a/Documentation/nvme-write.txt b/Documentation/nvme-write.txt
new file mode 100644 (file)
index 0000000..14533f9
--- /dev/null
@@ -0,0 +1,40 @@
+nvme-compare(1)
+===============
+
+NAME
+----
+nvme-write - Send an NVMe write command, provide results
+
+SYNOPSIS
+--------
+[verse]
+'nvme-write' <device> [--start-block=<slba> | -s <slba>]
+                       [--block-count=<nlb> | -c <nlb>]
+                       [--data-size=<size> | -z <size>]
+                       [--ref-tag=<reftag> | -r <reftag>]
+                       [--data=<data-file> | -d <data-file>]
+                       [--prinfo=<prinfo> | -p <prinfo>]
+                       [--app-tag-mask=<appmask> | -m <appmask>]
+                       [--app-tag=<apptag> | -a <apptag>]
+                       [--limited-retry | -l]
+                       [--force-unit-access | -f]
+
+DESCRIPTION
+-----------
+The Write command writes the logical blocks specified by the command to
+the medium from the data data buffer provided. Will use stdin by default
+if you don't provide a file.
+
+OPTIONS
+-------
+--start-block=<slba>::
+-s <slba>::
+       Start block.
+
+EXAMPLES
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite