add libkeccak_state_copy.3 and libkeccak_state_duplicate.3

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

4 files changed, 81 insertions, 0 deletions

diff --git a/doc/man/libkeccak_state_copy.3 b/doc/man/libkeccak_state_copy.3
new file mode 100644
index 0000000..f0b9673
--- /dev/null
+++ b/doc/man/libkeccak_state_copy.3
@@ -0,0 +1,39 @@
+.TH LIBKECCAK_STATE_COPY 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_copy - Copies hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int libkeccak_state_copy(libkeccak_state_t *\fIdest\fP, const libkeccak_state_t *\fIsrc\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_copy ()
+initialises \fI*dest\fP to be identical to \fI*src\fP.
+This includes all members of the \fBlibkeccak_state_t\fP
+structure, including the state of the sponge and the
+message chunk buffer.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_copy ()
+function return 0 upon successful completion.
+On error, -1 is returned and \fIerrno\fP is set to describe
+the error.
+.SH ERRORS
+The
+.BR libkeccak_state_copy ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_state_duplicate (3),
+.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
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3
index ba8b522..c0164fd 100644
--- a/doc/man/libkeccak_state_create.3
+++ b/doc/man/libkeccak_state_create.3
@@ -30,6 +30,7 @@ function may fail for any specified for the function
 .BR libkeccak_state_initialise (3),
 .BR libkeccak_state_free (3),
 .BR libkeccak_state_fast_free (3)
+.BR libkeccak_state_duplicate (3)
 .SH AUTHORS
 Principal author, Mattias Andrée.  See the LICENSE file for the full
 list of authors.
diff --git a/doc/man/libkeccak_state_duplicate.3 b/doc/man/libkeccak_state_duplicate.3
new file mode 100644
index 0000000..b76fed1
--- /dev/null
+++ b/doc/man/libkeccak_state_duplicate.3
@@ -0,0 +1,40 @@
+.TH LIBKECCAK_STATE_DUPLICATE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_duplicate - Allocate a duplicate hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+libkeccak_state_t *libkeccak_state_duplicate(const libkeccak_state_t *\fIsrc\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_duplicate ()
+allocates a new hash state and initialises it to be identical
+to \fI*src\fP. This includes all members of the \fBlibkeccak_state_t\fP
+structure, including the state of the sponge and the message
+chunk buffer.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_duplicate ()
+function return a newly allocated \fIlibkeccak_state_t*\fP
+(of one initialised element) upon successful completion.
+On error, \fINULL\fP is returned and \fIerrno\fP is set to
+describe the error.
+.SH ERRORS
+The
+.BR libkeccak_state_duplicate ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_state_copy (3),
+.BR libkeccak_state_create (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
diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index bf04665..e0260fb 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -32,6 +32,7 @@ function may fail for any specified for the function
 .BR libkeccak_state_reset (3),
 .BR libkeccak_state_destroy (3),
 .BR libkeccak_state_fast_destroy (3),
+.BR libkeccak_state_copy (3),
 .BR libkeccak_generalised_sum_fd (3),
 .BR libkeccak_keccaksum_fd (3),
 .BR libkeccak_sha3sum_fd (3),