General improvements

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

1 files changed, 46 insertions, 0 deletions

diff --git a/man/libkeccak_hmac_duplicate.3 b/man/libkeccak_hmac_duplicate.3
new file mode 100644
index 0000000..70c994c
--- /dev/null
+++ b/man/libkeccak_hmac_duplicate.3
@@ -0,0 +1,46 @@
+.TH LIBKECCAK_HMAC_DUPLICATE 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_duplicate - Allocate a duplicate an HMAC-hashing state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+libkeccak_hmac_state_t *
+libkeccak_hmac_duplicate(const libkeccak_hmac_state_t *\fIsrc\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_duplicate ()
+function allocates a new hash state and initialises
+it to be identical to
+.IR *src .
+This includes all members of the
+.B libkeccak_hmac_state_t
+structure, including the state of the sponge and the
+message chunk buffer.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_duplicate ()
+function returns a newly allocated
+.I libkeccak_hmac_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_duplicate ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_hmac_copy (3),
+.BR libkeccak_hmac_create (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se