Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_openpgp_keyring_file.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_openpgp_keyring_file" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_openpgp_keyring_file \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/openpgp.h>
7 .sp
8 .BI "int gnutls_certificate_set_openpgp_keyring_file(gnutls_certificate_credentials_t                                              " c ", const char * " file ", gnutls_openpgp_crt_fmt_t " format ");"
9 .SH ARGUMENTS
10 .IP "gnutls_certificate_credentials_t                                              c" 12
11 A certificate credentials structure
12 .IP "const char * file" 12
13 filename of the keyring.
14 .IP "gnutls_openpgp_crt_fmt_t format" 12
15 format of keyring.
16 .SH "DESCRIPTION"
17 The function is used to set keyrings that will be used internally
18 by various OpenPGP functions. For example to find a key when it
19 is needed for an operations. The keyring will also be used at the
20 verification functions.
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.