summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_create_ctrl.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_create_ctrl.2')
-rw-r--r--doc/man/nvme_create_ctrl.231
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/man/nvme_create_ctrl.2 b/doc/man/nvme_create_ctrl.2
new file mode 100644
index 0000000..8cab856
--- /dev/null
+++ b/doc/man/nvme_create_ctrl.2
@@ -0,0 +1,31 @@
+.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_create_ctrl \- Allocate an unconnected NVMe controller
+.SH SYNOPSIS
+.B "nvme_ctrl_t" nvme_create_ctrl
+.BI "(nvme_root_t r " ","
+.BI "const char *subsysnqn " ","
+.BI "const char *transport " ","
+.BI "const char *traddr " ","
+.BI "const char *host_traddr " ","
+.BI "const char *host_iface " ","
+.BI "const char *trsvcid " ");"
+.SH ARGUMENTS
+.IP "r" 12
+NVMe root element
+.IP "subsysnqn" 12
+Subsystem NQN
+.IP "transport" 12
+Transport type
+.IP "traddr" 12
+Transport address
+.IP "host_traddr" 12
+Host transport address
+.IP "host_iface" 12
+Host interface name
+.IP "trsvcid" 12
+Transport service ID
+.SH "DESCRIPTION"
+Creates an unconnected controller to be used for \fBnvme_add_ctrl\fP.
+.SH "RETURN"
+Controller instance