Blame doc/manpages/gnutls_srp_set_client_credentials.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit aea12f
.TH "gnutls_srp_set_client_credentials" 3 "3.6.8" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_srp_set_client_credentials \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t " res ", const char * " username ", const char * " password ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_srp_client_credentials_t res" 12
Packit aea12f
is a \fBgnutls_srp_client_credentials_t\fP type.
Packit aea12f
.IP "const char * username" 12
Packit aea12f
is the user's userid
Packit aea12f
.IP "const char * password" 12
Packit aea12f
is the user's password
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function sets the username and password, in a
Packit aea12f
\fBgnutls_srp_client_credentials_t\fP type.  Those will be used in
Packit aea12f
SRP authentication.   \fIusername\fP should be an ASCII string or UTF\-8
Packit aea12f
string. In case of a UTF\-8 string it is recommended to be following
Packit aea12f
the PRECIS framework for usernames (rfc8265). The password can
Packit aea12f
be in ASCII format, or normalized using \fBgnutls_utf8_password_normalize()\fP.
Packit aea12f
.SH "RETURNS"
Packit aea12f
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an
Packit aea12f
error code.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit aea12f
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP