summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_read_config.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_read_config.2')
-rw-r--r--doc/man/nvme_read_config.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_read_config.2 b/doc/man/nvme_read_config.2
new file mode 100644
index 0000000..363647f
--- /dev/null
+++ b/doc/man/nvme_read_config.2
@@ -0,0 +1,17 @@
+.TH "nvme_read_config" 9 "nvme_read_config" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_read_config \- Read NVMe JSON configuration file
+.SH SYNOPSIS
+.B "int" nvme_read_config
+.BI "(nvme_root_t r " ","
+.BI "const char *config_file " ");"
+.SH ARGUMENTS
+.IP "r" 12
+nvme_root_t object
+.IP "config_file" 12
+JSON configuration file
+.SH "DESCRIPTION"
+Read in the contents of \fIconfig_file\fP and merge them with
+the elements in \fIr\fP.
+.SH "RETURN"
+0 on success, -1 on failure with errno set.