From f14ba70de62cbd47e074756b1f1aec1f3b77a02d Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 15 Sep 2024 00:47:51 +0200 Subject: Move man pages into man3/ and man7/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man3/libkeccak_spec_sha3.3 | 47 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 man3/libkeccak_spec_sha3.3 (limited to 'man3/libkeccak_spec_sha3.3') diff --git a/man3/libkeccak_spec_sha3.3 b/man3/libkeccak_spec_sha3.3 new file mode 100644 index 0000000..9cafbf6 --- /dev/null +++ b/man3/libkeccak_spec_sha3.3 @@ -0,0 +1,47 @@ +.TH LIBKECCAK_SPEC_SHA3 3 LIBKECCAK +.SH NAME +libkeccak_spec_sha3 - Configure SHA-3 hashing parameters +.SH SYNOPSIS +.nf +#include + +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) -- cgit v1.2.3-70-g09d2