summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_read.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
commit3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch)
tree7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvme_read.2
parentInitial commit. (diff)
downloadlibnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz
libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--doc/man/nvme_read.212
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/man/nvme_read.2 b/doc/man/nvme_read.2
new file mode 100644
index 0000000..7e25fe3
--- /dev/null
+++ b/doc/man/nvme_read.2
@@ -0,0 +1,12 @@
+.TH "nvme_read" 9 "nvme_read" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_read \- Submit an nvme user read command
+.SH SYNOPSIS
+.B "int" nvme_read
+.BI "(struct nvme_io_args *args " ");"
+.SH ARGUMENTS
+.IP "args" 12
+\fIstruct nvme_io_args\fP argument structure
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.