aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_spec_shake.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_spec_shake.328
1 files changed, 16 insertions, 12 deletions
diff --git a/doc/man/libkeccak_spec_shake.3 b/doc/man/libkeccak_spec_shake.3
index c07704f..692897f 100644
--- a/doc/man/libkeccak_spec_shake.3
+++ b/doc/man/libkeccak_spec_shake.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK
.SH NAME
libkeccak_spec_shake - Configure SHAKE hashing parameters
.SH SYNOPSIS
@@ -6,17 +6,23 @@ libkeccak_spec_shake - Configure SHAKE hashing parameters
.nf
#include <libkeccak.h>
.P
-void libkeccak_spec_shake(libkeccak_spec_t *\fIspec\fP, long \fIx\fP, long \fId\fP);
+void
+libkeccak_spec_shake(libkeccak_spec_t *\fIspec\fP, long int \fIx\fP, long int \fId\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_spec_shake ()
-function sets \fI*spec\fP to specify the Keccak parameters
-used for SHAKE hashing with the semicapacity specified,
-in bits, via the \fIx\fP parameter, and the output size
-specified, in bits, via the \fId\fP parameter.
+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 ()
@@ -26,8 +32,9 @@ The
.BR libkeccak_spec_shake ()
function cannot fail.
.SH EXAMPLE
-This examples configure a \fBlibkeccak_spec_t\fP to specify
-the Keccak parameters used for SHAKE256(, 512):
+This examples configure a
+.B libkeccak_spec_t
+to specify the Keccak parameters used for SHAKE256(, 512):
.LP
.nf
libkeccak_spec_t spec;
@@ -40,9 +47,6 @@ libkeccak_spec_shake(&spec, 256, 512);
.BR libkeccak_generalised_spec_initialise (3),
.BR libkeccak_state_initialise (3),
.BR libkeccak_hmac_initialise (3)
-.SH AUTHORS
-Principal author, Mattias Andrée. See the LICENSE file for the full
-list of authors.
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se