aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_generalised_spec_initialise.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
committerMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
commitf14ba70de62cbd47e074756b1f1aec1f3b77a02d (patch)
tree4b4c27260816f553b7a1fe54153c06b122160ffc /libkeccak_generalised_spec_initialise.3
parentSplit libkeccak.h and fix support for architectures that do not allow misaligned memory (diff)
downloadlibkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.gz
libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.bz2
libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.xz
Move man pages into man3/ and man7/
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_generalised_spec_initialise.3')
-rw-r--r--libkeccak_generalised_spec_initialise.342
1 files changed, 0 insertions, 42 deletions
diff --git a/libkeccak_generalised_spec_initialise.3 b/libkeccak_generalised_spec_initialise.3
deleted file mode 100644
index acfa173..0000000
--- a/libkeccak_generalised_spec_initialise.3
+++ /dev/null
@@ -1,42 +0,0 @@
-.TH LIBKECCAK_GENERALISED_SPEC_INITIALISE 3 LIBKECCAK
-.SH NAME
-libkeccak_generalised_spec_initialise - Set all specification parameters to automatic
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-void libkeccak_generalised_spec_initialise(struct libkeccak_generalised_spec *\fIspec\fP);
-.fi
-.PP
-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_cshake (3),
-.BR libkeccak_spec_sha3 (3),
-.BR libkeccak_spec_rawshake (3),
-.BR libkeccak_spec_shake (3)