General improvements

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 53 insertions, 0 deletions

diff --git a/man/libkeccak_hmac_create.3 b/man/libkeccak_hmac_create.3
new file mode 100644
index 0000000..fcb99cb
--- /dev/null
+++ b/man/libkeccak_hmac_create.3
@@ -0,0 +1,53 @@
+.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_create - Allocate and initialise HMAC-hashing state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+libkeccak_hmac_state_t *
+libkeccak_hmac_create(const libkeccak_spec_t *\fIspec\fP, const char *\fIkey\fP,
+                      size_t \fIkey_length\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_create ()
+function allocates a new
+.I libkeccak_hmac_state_t*
+with one initialised element, and sets the
+algorithm tuning parameters to those specified by
+.IR *spec ,
+and the key to
+.I key
+of length
+.IR key_length .
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_create ()
+function returns a newly allocated
+.I libkeccak_hmac_state_t*
+(of one initialised element) upon successful completion.
+On error,
+.I NULL
+is returned and
+.I errno
+is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_hmac_create ()
+function may fail for any specified for the functions
+.BR malloc (3)
+and
+.BR realloc (3).
+.SH SEE ALSO
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_free (3),
+.BR libkeccak_hmac_fast_free (3),
+.BR libkeccak_hmac_duplicate (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se