add libkeccak_spec_sha3.3

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

1 files changed, 43 insertions, 0 deletions

diff --git a/doc/man/libkeccak_spec_sha3.3 b/doc/man/libkeccak_spec_sha3.3
new file mode 100644
index 0000000..b9d3dce
--- /dev/null
+++ b/doc/man/libkeccak_spec_sha3.3
@@ -0,0 +1,43 @@
+.TH LIBKECCAK_SPEC_SHA3 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_spec_sha3 - Configure SHA-3 hashing parameters
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_spec_sha3(libkeccak_spec_t *\fIspec\fP, long \fIx\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_spec_sha3 ()
+sets \fI*spec\fP to specify the Keccak parameters used for SHA-3
+hashing with the output size specified, in bits, via the \fIx\fP parameter.
+.SH RETURN VALUES
+The
+.BR libkeccak_spec_sha3 ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_spec_sha3 ()
+function cannot fail.
+.SH EXAMPLES
+This examples configure a \fBlibkeccak_spec_t\fP to specify
+the Keccak parameters used for SHA3-256:
+.LP
+.nf
+libkeccak_spec_t spec;
+libkeccak_spec_sha3(&spec, 256);
+.fi
+.SH SEE ALSO
+.BR libkeccak_spec_rawshake (3),
+.BR libkeccak_spec_shake (3),
+.BR libkeccak_spec_check (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/bus/issues or to
+maandree@member.fsf.org