diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
commit | 2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch) | |
tree | ac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_directive_send.2 | |
parent | Initial commit. (diff) | |
download | libnvme-upstream/1.3.tar.xz libnvme-upstream/1.3.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_directive_send.2')
-rw-r--r-- | doc/man/nvme_directive_send.2 | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/man/nvme_directive_send.2 b/doc/man/nvme_directive_send.2 new file mode 100644 index 0000000..ae5e7c3 --- /dev/null +++ b/doc/man/nvme_directive_send.2 @@ -0,0 +1,18 @@ +.TH "nvme_directive_send" 9 "nvme_directive_send" "January 2023" "libnvme API manual" LINUX +.SH NAME +nvme_directive_send \- Send directive command +.SH SYNOPSIS +.B "int" nvme_directive_send +.BI "(struct nvme_directive_send_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +\fIstruct nvme_directive_send_args\fP argument structure +.SH "DESCRIPTION" +Directives is a mechanism to enable host and NVM subsystem or controller +information exchange. The Directive Send command transfers data related to a +specific Directive Type from the host to the controller. + +See the NVMe specification for more information. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |