add libkeccak_fast_update.3 and libkeccak_update.3

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

3 files changed, 103 insertions, 0 deletions

diff --git a/doc/man/libkeccak_fast_update.3 b/doc/man/libkeccak_fast_update.3
new file mode 100644
index 0000000..fb52f45
--- /dev/null
+++ b/doc/man/libkeccak_fast_update.3
@@ -0,0 +1,50 @@
+.TH LIBKECCAK_FAST_UPDATE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_fast_update - Partially hash a message without erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int libkeccak_fast_update(libkeccak_state_t *\fIstate\fP, const char *\fImsg\fP, size_t \fImsglen\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_fast_update ()
+function continues (or starts) hashing a message.
+The current state of the hashing is stored in \fI*state\fP,
+and will be updated. The message specified by the \fImsg\fP
+parameter with the byte-size specified by the \fImsglen\fP
+parameter, will be hashed.
+.PP
+The
+.BR libkeccak_fast_update ()
+function may reallocate the state's message chunk buffer.
+When doing so, it attempts to do so as quickly as possible,
+rather than ensuring that the information in the old
+allocation is securely removed if a new allocation is required.
+.SH RETURN VALUES
+The
+.BR libkeccak_fast_update ()
+function returns 0 upon successful completion. On error,
+-1 is returned and \fIerrno\fP is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_fast_update ()
+function may fail for any reason specified by the function
+.BR realloc (3).
+.SH Notes
+Neither parameter by be \fINULL\fP or 0.
+.SH SEE ALSO
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_update (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_digest (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 be7b577..5618fb8 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -33,6 +33,10 @@ function may fail for any specified for the function
 .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),
diff --git a/doc/man/libkeccak_update.3 b/doc/man/libkeccak_update.3
new file mode 100644
index 0000000..dee71ce
--- /dev/null
+++ b/doc/man/libkeccak_update.3
@@ -0,0 +1,49 @@
+.TH LIBKECCAK_UPDATE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_update - Partially hash a message with erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int libkeccak_update(libkeccak_state_t *\fIstate\fP, const char *\fImsg\fP, size_t \fImsglen\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_update ()
+function continues (or starts) hashing a message.
+The current state of the hashing is stored in \fI*state\fP,
+and will be updated. The message specified by the \fImsg\fP
+parameter with the byte-size specified by the \fImsglen\fP
+parameter, will be hashed.
+.PP
+The
+.BR libkeccak_update ()
+function may reallocate the state's message chunk buffer.
+When doing so, it attempts to do so as securely as possible,
+rather than as fast as possible.
+.SH RETURN VALUES
+The
+.BR libkeccak_update ()
+function returns 0 upon successful completion. On error,
+-1 is returned and \fIerrno\fP is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_update ()
+function may fail for any reason specified by the function
+.BR malloc (3).
+.SH Notes
+Neither parameter by be \fINULL\fP or 0.
+.SH SEE ALSO
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_fast_update (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_digest (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