summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_open.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:22:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:22:29 +0000
commit068a45420f2c98887e220b45e946cc7074da550e (patch)
treec5b54e8b4b235232b057a9c534d9a16d2208463d /doc/man/nvme_open.2
parentInitial commit. (diff)
downloadlibnvme-068a45420f2c98887e220b45e946cc7074da550e.tar.xz
libnvme-068a45420f2c98887e220b45e946cc7074da550e.zip
Adding upstream version 1.8.upstream/1.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_open.2')
-rw-r--r--doc/man/nvme_open.215
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/man/nvme_open.2 b/doc/man/nvme_open.2
new file mode 100644
index 0000000..56f266f
--- /dev/null
+++ b/doc/man/nvme_open.2
@@ -0,0 +1,15 @@
+.TH "nvme_open" 9 "nvme_open" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_open \- Open an nvme controller or namespace device
+.SH SYNOPSIS
+.B "int" nvme_open
+.BI "(const char *name " ");"
+.SH ARGUMENTS
+.IP "name" 12
+The basename of the device to open
+.SH "DESCRIPTION"
+This will look for the handle in /dev/ and validate the name and filetype
+match linux conventions.
+.SH "RETURN"
+A file descriptor for the device on a successful open, or -1 with
+errno set otherwise.