diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_cipher_init.3 | |
parent | Initial commit. (diff) | |
download | gnutls28-upstream.tar.xz gnutls28-upstream.zip |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_cipher_init.3')
-rw-r--r-- | doc/manpages/gnutls_cipher_init.3 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_cipher_init.3 b/doc/manpages/gnutls_cipher_init.3 new file mode 100644 index 0000000..3a44563 --- /dev/null +++ b/doc/manpages/gnutls_cipher_init.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_init \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_init(gnutls_cipher_hd_t * " handle ", gnutls_cipher_algorithm_t " cipher ", const gnutls_datum_t * " key ", const gnutls_datum_t * " iv ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t * handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "gnutls_cipher_algorithm_t cipher" 12 +the encryption algorithm to use +.IP "const gnutls_datum_t * key" 12 +the key to be used for encryption/decryption +.IP "const gnutls_datum_t * iv" 12 +the IV to use (if not applicable set NULL) +.SH "DESCRIPTION" +This function will initialize the \fIhandle\fP context to be usable +for encryption/decryption of data. This will effectively use the +current crypto backend in use by gnutls or the cryptographic +accelerator in use. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP |