summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_nbft_read.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-06-30 22:36:07 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-06-30 22:36:07 +0000
commit97e3d220503a676acd81839dea289f4e700d8bd8 (patch)
tree69791901e1ca15319c5c63ffb52fe9cc686f8bee /doc/man/nvme_nbft_read.2
parentAdding upstream version 1.4. (diff)
downloadlibnvme-97e3d220503a676acd81839dea289f4e700d8bd8.tar.xz
libnvme-97e3d220503a676acd81839dea289f4e700d8bd8.zip
Adding upstream version 1.5.upstream/1.5
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_nbft_read.2')
-rw-r--r--doc/man/nvme_nbft_read.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_nbft_read.2 b/doc/man/nvme_nbft_read.2
new file mode 100644
index 0000000..0c8534a
--- /dev/null
+++ b/doc/man/nvme_nbft_read.2
@@ -0,0 +1,17 @@
+.TH "nvme_nbft_read" 9 "nvme_nbft_read" "June 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_nbft_read \- Read and parse contents of an ACPI NBFT table
+.SH SYNOPSIS
+.B "int" nvme_nbft_read
+.BI "(struct nbft_info **nbft " ","
+.BI "const char *filename " ");"
+.SH ARGUMENTS
+.IP "nbft" 12
+Parsed NBFT table data.
+.IP "filename" 12
+Filename of the raw NBFT table to read.
+.SH "DESCRIPTION"
+Read and parse the specified NBFT file into a struct nbft_info.
+Free with \fBnvme_nbft_free\fP.
+.SH "RETURN"
+0 on success, errno otherwise.