diff options
Diffstat (limited to 'doc/manpages/gnutls_srp_base64_encode2.3')
| -rw-r--r-- | doc/manpages/gnutls_srp_base64_encode2.3 | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_srp_base64_encode2.3 b/doc/manpages/gnutls_srp_base64_encode2.3 new file mode 100644 index 0000000..d20d2de --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_encode2.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_encode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_encode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_base64_encode2(const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contains the raw data +.IP "gnutls_datum_t * result" 12 +will hold the newly allocated encoded data +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding. This is the encoding used in SRP password +files. This function will allocate the required memory to hold +the encoded data. + +You should use \fBgnutls_free()\fP to free the returned data. + +Warning! This base64 encoding is not the "standard" encoding, so +do not use it for non\-SRP purposes. +.SH "RETURNS" +0 on success, or an error code. +.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 |