Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_openpgp_key_file.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_openpgp_key_file" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_openpgp_key_file \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/openpgp.h>
7 .sp
8 .BI "int gnutls_certificate_set_openpgp_key_file(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", gnutls_openpgp_crt_fmt_t " format ");"
9 .SH ARGUMENTS
10 .IP "gnutls_certificate_credentials_t res" 12
11 the destination context to save the data.
12 .IP "const char * certfile" 12
13 the file that contains the public key.
14 .IP "const char * keyfile" 12
15 the file that contains the secret key.
16 .IP "gnutls_openpgp_crt_fmt_t format" 12
17 the format of the keys
18 .SH "DESCRIPTION"
19 This funtion is used to load OpenPGP keys into the GnuTLS
20 credentials structure. The file should contain at least one valid non encrypted subkey.
21 .SH "RETURNS"
22 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
23 negative error value.
24 .SH "REPORTING BUGS"
25 Report bugs to <bug-gnutls@gnu.org>.
26 GnuTLS home page: http://www.gnu.org/software/gnutls/
27 General help using GNU software: http://www.gnu.org/gethelp/
28 .SH COPYRIGHT
29 Copyright \(co 2008 Free Software Foundation.
30 .br
31 Copying and distribution of this file, with or without modification,
32 are permitted in any medium without royalty provided the copyright
33 notice and this notice are preserved.
34 .SH "SEE ALSO"
35 The full documentation for
36 .B gnutls
37 is maintained as a Texinfo manual.  If the
38 .B info
39 and
40 .B gnutls
41 programs are properly installed at your site, the command
42 .IP
43 .B info gnutls
44 .PP
45 should give you access to the complete manual.