aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_generalised_spec_initialise.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /doc/man/libkeccak_generalised_spec_initialise.3
parentChange style and license (diff)
downloadlibkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libkeccak_generalised_spec_initialise.3')
-rw-r--r--doc/man/libkeccak_generalised_spec_initialise.346
1 files changed, 0 insertions, 46 deletions
diff --git a/doc/man/libkeccak_generalised_spec_initialise.3 b/doc/man/libkeccak_generalised_spec_initialise.3
deleted file mode 100644
index 42bd62f..0000000
--- a/doc/man/libkeccak_generalised_spec_initialise.3
+++ /dev/null
@@ -1,46 +0,0 @@
-.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