diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:06:51 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:06:51 +0000 |
commit | 46f46dcc0ad7d0cda2f41c1ccfa137d2413ff209 (patch) | |
tree | 156a2dcee1cbe550b5014eb6a0833a1cee6bda65 /doc/man/nvme_read_key.2 | |
parent | Adding debian version 1.8-3. (diff) | |
download | libnvme-46f46dcc0ad7d0cda2f41c1ccfa137d2413ff209.tar.xz libnvme-46f46dcc0ad7d0cda2f41c1ccfa137d2413ff209.zip |
Merging upstream version 1.9.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_read_key.2')
-rw-r--r-- | doc/man/nvme_read_key.2 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_read_key.2 b/doc/man/nvme_read_key.2 new file mode 100644 index 0000000..4556a7d --- /dev/null +++ b/doc/man/nvme_read_key.2 @@ -0,0 +1,23 @@ +.TH "nvme_read_key" 9 "nvme_read_key" "May 2024" "libnvme API manual" LINUX +.SH NAME +nvme_read_key \- Read key raw data +.SH SYNOPSIS +.B "unsigned char *" nvme_read_key +.BI "(long keyring_id " "," +.BI "long key_id " "," +.BI "int *len " ");" +.SH ARGUMENTS +.IP "keyring_id" 12 +Id of the keyring holding key_id +.IP "key_id" 12 +Key id +.IP "len" 12 +Length of the returned data +.SH "DESCRIPTION" +Links the keyring specified by \fIkeyring_id\fP into the session +keyring and reads the payload of the key specified by \fIkey_id\fP. +\fIlen\fP holds the size of the returned buffer. +If \fIkeyring\fP is 0 the default keyring '.nvme' is used. +.SH "RETURN" +Pointer to the payload on success, +or NULL with errno set otherwise. |