← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gnutls26/maverick-security

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_crypto_single_mac_register2.3

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2009-04-14 14:23:19 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20090414142319-ok7xejzbqkofno1q
Tags: 2.6.5-1
* Sync sections in debian/control with override file. libgnutls26-dbg is
  section debug, guile-gnutls is section lisp.
* New upstream version. (Needed for Libtasn1-3 2.0)
* New patch 15_tasn1inpc.diff. Make sure libtasn1 is listed in Libs.private.
* Standards-Version: 3.8.1, no changes required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/gnutls_crypto_single_mac_register2.3
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_crypto_single_mac_register2" 3 "2.6.5" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_crypto_single_mac_register2 \- register a MAC algorithm
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/gnutls.h>
 
7
.sp
 
8
.BI "int gnutls_crypto_single_mac_register2(gnutls_mac_algorithm_t " algorithm ", int " priority ", int " version ", gnutls_crypto_single_mac_st * " s ");"
 
9
.SH ARGUMENTS
 
10
.IP "gnutls_mac_algorithm_t algorithm" 12
 
11
is the gnutls algorithm identifier
 
12
.IP "int priority" 12
 
13
is the priority of the algorithm
 
14
.IP "int version" 12
 
15
should be set to \fBGNUTLS_CRYPTO_API_VERSION\fP
 
16
.IP "gnutls_crypto_single_mac_st * s" 12
 
17
is a structure holding new algorithms's data
 
18
.SH "DESCRIPTION"
 
19
This function will register a MAC algorithm to be used by gnutls.
 
20
Any algorithm registered will override the included algorithms and
 
21
by convention kernel implemented algorithms have priority of 90.
 
22
The algorithm with the lowest priority will be used by gnutls.
 
23
 
 
24
This function should be called before \fBgnutls_global_init()\fP.
 
25
 
 
26
For simplicity you can use the convenience
 
27
\fBgnutls_crypto_single_mac_register()\fP macro.
 
28
.SH "RETURNS"
 
29
\fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
 
30
.SH "SINCE"
 
31
2.6.0
 
32
.SH "REPORTING BUGS"
 
33
Report bugs to <bug-gnutls@gnu.org>.
 
34
.SH COPYRIGHT
 
35
Copyright \(co 2008 Free Software Foundation.
 
36
.br
 
37
Permission is granted to make and distribute verbatim copies of this
 
38
manual provided the copyright notice and this permission notice are
 
39
preserved on all copies.
 
40
.SH "SEE ALSO"
 
41
The full documentation for
 
42
.B gnutls
 
43
is maintained as a Texinfo manual.  If the
 
44
.B info
 
45
and
 
46
.B gnutls
 
47
programs are properly installed at your site, the command
 
48
.IP
 
49
.B info gnutls
 
50
.PP
 
51
should give you access to the complete manual.