~ubuntu-branches/ubuntu/raring/gnutls26/raring

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_hmac_init.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2011-05-20 13:07:18 UTC
  • mfrom: (12.1.11 sid)
  • Revision ID: james.westby@ubuntu.com-20110520130718-db41dybbanzfvlji
Tags: 2.10.5-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - Fix build failure with --no-add-needed.
  - Build for multiarch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_hmac_init" 3 "2.10.5" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_hmac_init \- API function
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/gnutls.h>
 
7
.sp
 
8
.BI "int gnutls_hmac_init(gnutls_hmac_hd_t * " dig ", gnutls_digest_algorithm_t " algorithm ", const void * " key ", size_t " keylen ");"
 
9
.SH ARGUMENTS
 
10
.IP "gnutls_hmac_hd_t * dig" 12
 
11
is a \fBgnutls_hmac_hd_t\fP structure.
 
12
.IP "gnutls_digest_algorithm_t algorithm" 12
 
13
the HMAC algorithm to use
 
14
.IP "const void * key" 12
 
15
The key to be used for encryption
 
16
.IP "size_t keylen" 12
 
17
The length of the key
 
18
.SH "DESCRIPTION"
 
19
This function will initialize an context that can be used to
 
20
produce a Message Authentication Code (MAC) of data.  This will
 
21
effectively use the current crypto backend in use by gnutls or the
 
22
cryptographic accelerator in use.
 
23
.SH "RETURNS"
 
24
Zero or a negative value on error.
 
25
.SH "SINCE"
 
26
2.10.0
 
27
.SH "REPORTING BUGS"
 
28
Report bugs to <bug-gnutls@gnu.org>.
 
29
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
30
General help using GNU software: http://www.gnu.org/gethelp/
 
31
.SH COPYRIGHT
 
32
Copyright \(co 2008 Free Software Foundation.
 
33
.br
 
34
Copying and distribution of this file, with or without modification,
 
35
are permitted in any medium without royalty provided the copyright
 
36
notice and this notice are preserved.
 
37
.SH "SEE ALSO"
 
38
The full documentation for
 
39
.B gnutls
 
40
is maintained as a Texinfo manual.  If the
 
41
.B info
 
42
and
 
43
.B gnutls
 
44
programs are properly installed at your site, the command
 
45
.IP
 
46
.B info gnutls
 
47
.PP
 
48
should give you access to the complete manual.