add libkeccak_generalised_spec_initialise.3

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

1 files changed, 40 insertions, 0 deletions

diff --git a/doc/man/libkeccak_generalised_spec_initialise.3 b/doc/man/libkeccak_generalised_spec_initialise.3
new file mode 100644
index 0000000..2c61273
--- /dev/null
+++ b/doc/man/libkeccak_generalised_spec_initialise.3
@@ -0,0 +1,40 @@
+.TH LIBKECCAK_GENERALISED_SPEC_INITIALISE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_generalised_spec_initialise - Set all specification parameters to automatic
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_generalised_spec_initialise(libkeccak_generalised_spec_t *\fIspec\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_generalised_spec_initialise ()
+initialises \fI*spec\fP, so that all parameters
+are configured to be automatically selected.
+.PP
+Automatic selection means that value will be set
+to the default, which depends on the other settings.
+.SH RETURN VALUES
+The
+.BR libkeccak_generalised_spec_initialise ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_generalised_spec_initialise ()
+function cannot fail.
+.fi
+.SH SEE ALSO
+.BR libkeccak_degeneralise_spec (3),
+.BR libkeccak_spec_sha3 (3),
+.BR libkeccak_spec_rawshake (3),
+.BR libkeccak_spec_shake (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