aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_spec_shake.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_spec_shake.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_spec_shake.3')
-rw-r--r--libkeccak_spec_shake.348
1 files changed, 0 insertions, 48 deletions
diff --git a/libkeccak_spec_shake.3 b/libkeccak_spec_shake.3
deleted file mode 100644
index c98962f..0000000
--- a/libkeccak_spec_shake.3
+++ /dev/null
@@ -1,48 +0,0 @@
-.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK
-.SH NAME
-libkeccak_spec_shake - Configure SHAKE hashing parameters
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-void libkeccak_spec_shake(struct libkeccak_spec *\fIspec\fP, long int \fIx\fP, long int \fId\fP);
-.fi
-.PP
-Link with
-.IR -lkeccak .
-.SH DESCRIPTION
-The
-.BR libkeccak_spec_shake ()
-function sets
-.I *spec
-to specify the Keccak parameters used for SHAKE hashing
-with the semicapacity specified, in bits, via the
-.I x
-parameter, and the output size specified, in bits, via the
-.I d
-parameter.
-.SH RETURN VALUES
-The
-.BR libkeccak_spec_shake ()
-function does not return any value.
-.SH ERRORS
-The
-.BR libkeccak_spec_shake ()
-function cannot fail.
-.SH EXAMPLE
-This example configure a
-.B struct libkeccak_spec
-to specify the Keccak parameters used for SHAKE256(, 512):
-.PP
-.nf
-struct libkeccak_spec spec;
-libkeccak_spec_shake(&spec, 256, 512);
-.fi
-.SH SEE ALSO
-.BR libkeccak_spec_cshake (3),
-.BR libkeccak_spec_sha3 (3),
-.BR libkeccak_spec_rawshake (3),
-.BR libkeccak_spec_check (3),
-.BR libkeccak_generalised_spec_initialise (3),
-.BR libkeccak_state_initialise (3),
-.BR libkeccak_hmac_initialise (3)