General improvements

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 46 insertions, 0 deletions

diff --git a/man/libkeccak_generalised_spec_initialise.3 b/man/libkeccak_generalised_spec_initialise.3
new file mode 100644
index 0000000..42bd62f
--- /dev/null
+++ b/man/libkeccak_generalised_spec_initialise.3
@@ -0,0 +1,46 @@
+.TH LIBKECCAK_GENERALISED_SPEC_INITIALISE 3 LIBKECCAK
+.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
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_generalised_spec_initialise ()
+function initialises
+.IR *spec ,
+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.
+.PP
+Specifically, all members of
+.IR *spec ,
+will be set to
+.BR LIBKECCAK_GENERALISED_SPEC_AUTOMATIC .
+.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 BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se