summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ns_read.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_ns_read.2')
-rw-r--r--doc/man/nvme_ns_read.220
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvme_ns_read.2 b/doc/man/nvme_ns_read.2
new file mode 100644
index 0000000..af85e0a
--- /dev/null
+++ b/doc/man/nvme_ns_read.2
@@ -0,0 +1,20 @@
+.TH "nvme_ns_read" 9 "nvme_ns_read" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_ns_read \- Read from a namespace
+.SH SYNOPSIS
+.B "int" nvme_ns_read
+.BI "(nvme_ns_t n " ","
+.BI "void *buf " ","
+.BI "off_t offset " ","
+.BI "size_t count " ");"
+.SH ARGUMENTS
+.IP "n" 12
+Namespace instance
+.IP "buf" 12
+Buffer into which the data will be transferred
+.IP "offset" 12
+LBA offset of \fIn\fP
+.IP "count" 12
+Number of sectors in \fIbuf\fP
+.SH "RETURN"
+Number of sectors read or -1 on error.