1 files changed, 60 insertions, 0 deletions
diff --git a/man/libkeccak_state_initialise.3 b/man/libkeccak_state_initialise.3
new file mode 100644
index 0000000..2620686
--- /dev/null
+++ b/man/libkeccak_state_initialise.3
@@ -0,0 +1,60 @@
+.TH LIBKECCAK_STATE_INITIALISE 3 LIBKECCAK
+.SH NAME
+libkeccak_state_initialise - Initialise hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int
+libkeccak_state_initialise(libkeccak_state_t *\fIstate\fP,
+                           const libkeccak_spec_t *\fIspec\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_initialise ()
+function initialises
+.I *state
+and sets the algorithm tuning parameters to those
+specified by
+.IR *spec .
+.SH RETURN VALUES
+The
+.BR libkeccak_state_initialise ()
+function returns 0 upon successful completion.
+On error, -1 is returned and
+.I errno
+is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_state_initialise ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_state_create (3),
+.BR libkeccak_state_reset (3),
+.BR libkeccak_state_destroy (3),
+.BR libkeccak_state_fast_destroy (3),
+.BR libkeccak_state_copy (3),
+.BR libkeccak_fast_update (3),
+.BR libkeccak_update (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_digest (3),
+.BR libkeccak_generalised_sum_fd (3),
+.BR libkeccak_keccaksum_fd (3),
+.BR libkeccak_sha3sum_fd (3),
+.BR libkeccak_rawshakesum_fd (3),
+.BR libkeccak_shakesum_fd (3),
+.BR libkeccak_spec_sha3 (3),
+.BR libkeccak_spec_shake (3),
+.BR libkeccak_spec_rawshake (3),
+.BR libkeccak_spec_check (3),
+.BR libkeccak_generalised_spec_initialise (3),
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_hmac_initialise (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se