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