add libkeccak_fast_squeeze.3, libkeccak_simple_squeeze.3, and libkeccak_squeeze.3

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

3 files changed, 118 insertions, 0 deletions

diff --git a/doc/man/libkeccak_fast_squeeze.3 b/doc/man/libkeccak_fast_squeeze.3
new file mode 100644
index 0000000..7d4827b
--- /dev/null
+++ b/doc/man/libkeccak_fast_squeeze.3
@@ -0,0 +1,37 @@
+.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_fast_squeeze - Runs the squeeze phase a number of times
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_fast_squeeze(libkeccak_state_t *\fIstate\fP, long \fItimes\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_fast_squeeze ()
+function runs the Keccak squeeze phase, on the the hash
+process described by \fI*state\fP, as many times are
+required to get \fItimes\fP additional digests.
+.SH RETURN VALUES
+The
+.BR libkeccak_fast_squeeze ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_fast_squeeze ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_digest (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_simple_squeeze (3),
+.BR libkeccak_squeeze (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_simple_squeeze.3 b/doc/man/libkeccak_simple_squeeze.3
new file mode 100644
index 0000000..d151ce5
--- /dev/null
+++ b/doc/man/libkeccak_simple_squeeze.3
@@ -0,0 +1,36 @@
+.TH LIBKECCAK_SIMPLE_SQUEEZE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_simple_squeeze - Runs Keccak-f a number of times
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_simple_squeeze(libkeccak_state_t *\fIstate\fP, long \fItimes\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_simple_squeeze ()
+function runs Keccak-f \fItimes\fP times on the hashing
+process described by \fI*state\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_simple_squeeze ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_simple_squeeze ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_digest (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_fast_squeeze (3),
+.BR libkeccak_squeeze (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_squeeze.3 b/doc/man/libkeccak_squeeze.3
new file mode 100644
index 0000000..ac66c03
--- /dev/null
+++ b/doc/man/libkeccak_squeeze.3
@@ -0,0 +1,45 @@
+.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_squeeze - Runs the squeeze phase
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_squeeze(libkeccak_state_t *\fIstate\fP, char *\fIhashsum\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_squeeze ()
+function runs the Keccak squeeze phase, on the the hash
+process described by \fI*state\fP, on stores a new digest,
+in binary form, in \fIhashsum\fP.
+.PP
+\fIhashsum\fP has the same requirement as for the
+.BR libkeccak_digest (3)
+and
+.BR libkeccak_fast_digest (3)
+functions: it must have an allocation size of at least
+((\fIstate->n\fP + 7) / 8) bytes. However, it may not
+be \fINULL\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_squeeze ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_squeeze ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_digest (3),
+.BR libkeccak_fast_digest (3),
+.BR libkeccak_simple_squeeze (3),
+.BR libkeccak_fast_squeeze (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