Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_openpgp_key_file2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_openpgp_key_file2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_openpgp_key_file2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/openpgp.h>
7 .sp
8 .BI "int gnutls_certificate_set_openpgp_key_file2(gnutls_certificate_credentials_t                                           " res ", const char * " certfile ", const char * " keyfile ", const char * " subkey_id ", 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 "const char * subkey_id" 12
17 a hex encoded subkey id
18 .IP "gnutls_openpgp_crt_fmt_t format" 12
19 the format of the keys
20 .SH "DESCRIPTION"
21 This funtion is used to load OpenPGP keys into the GnuTLS credential 
22 structure. The file should contain at least one valid non encrypted subkey.
23
24 The special keyword "auto" is also accepted as \fIsubkey_id\fP.  In that
25 case the \fBgnutls_openpgp_crt_get_auth_subkey()\fP will be used to
26 retrieve the subkey.
27 .SH "RETURNS"
28 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
29 negative error value.
30 .SH "SINCE"
31 2.4.0
32 .SH "REPORTING BUGS"
33 Report bugs to <bug-gnutls@gnu.org>.
34 GnuTLS home page: http://www.gnu.org/software/gnutls/
35 General help using GNU software: http://www.gnu.org/gethelp/
36 .SH COPYRIGHT
37 Copyright \(co 2008 Free Software Foundation.
38 .br
39 Copying and distribution of this file, with or without modification,
40 are permitted in any medium without royalty provided the copyright
41 notice and this notice are preserved.
42 .SH "SEE ALSO"
43 The full documentation for
44 .B gnutls
45 is maintained as a Texinfo manual.  If the
46 .B info
47 and
48 .B gnutls
49 programs are properly installed at your site, the command
50 .IP
51 .B info gnutls
52 .PP
53 should give you access to the complete manual.