summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ctrl_identify.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_ctrl_identify.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
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..d2e37eb
--- /dev/null
+++ b/doc/man/nvme_ctrl_identify.2
@@ -0,0 +1,17 @@
+.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "January 2023" "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.