diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:53:09 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:53:09 +0000 |
| commit | 3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch) | |
| tree | 7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvme_open.2 | |
| parent | Initial commit. (diff) | |
| download | libnvme-upstream/1.0.tar.xz libnvme-upstream/1.0.zip | |
Adding upstream version 1.0.upstream/1.0
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.2 | 15 |
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..5d7e7d0 --- /dev/null +++ b/doc/man/nvme_open.2 @@ -0,0 +1,15 @@ +.TH "nvme_open" 9 "nvme_open" "April 2022" "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. |