summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ctrl_identify.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_ctrl_identify.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_ctrl_identify.2')
-rw-r--r--doc/man/nvme_ctrl_identify.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_ctrl_identify.2 b/doc/man/nvme_ctrl_identify.2
new file mode 100644
index 0000000..c4ff85b
--- /dev/null
+++ b/doc/man/nvme_ctrl_identify.2
@@ -0,0 +1,17 @@
+.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_ctrl_identify \- Issues an 'identify controller' command
+.SH SYNOPSIS
+.B "int" nvme_ctrl_identify
+.BI "(nvme_ctrl_t c " ","
+.BI "struct nvme_id_ctrl *id " ");"
+.SH ARGUMENTS
+.IP "c" 12
+Controller instance
+.IP "id" 12
+Identify controller data structure
+.SH "DESCRIPTION"
+Issues an 'identify controller' command to \fIc\fP and copies the
+data into \fIid\fP.
+.SH "RETURN"
+0 on success or -1 on failure.