add libkeccak_state_reset.3

Signed-off-by: Mattias Andrée <maandree@operamail.com>

2 files changed, 34 insertions, 0 deletions

diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index 2845036..788117d 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -28,6 +28,7 @@ The
 function may fail for any specified for the function
 .BR malloc (3).
 .SH SEE ALSO
+.BR libkeccak_state_reset (3),
 .BR libkeccak_generalised_sum_fd (3),
 .BR libkeccak_keccaksum_fd (3),
 .BR libkeccak_sha3sum_fd (3),
diff --git a/doc/man/libkeccak_state_reset.3 b/doc/man/libkeccak_state_reset.3
new file mode 100644
index 0000000..c44a83f
--- /dev/null
+++ b/doc/man/libkeccak_state_reset.3
@@ -0,0 +1,33 @@
+.TH LIBKECCAK_STATE_RESET 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_reset - Reinitialise hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_state_reset(libkeccak_state_t *\fIstate\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_reset ()
+reinitialises \fI*state\fP, but keeps the tuning, so it
+can be used to hash another message.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_reset ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_state_reset ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_initialise (3)
+.SH AUTHORS
+Principal author, Mattias Andrée.  See the LICENSE file for the full
+list of authors.
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@member.fsf.org