aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_fast_squeeze.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-02-10 15:46:21 +0100
committerMattias Andrée <maandree@kth.se>2017-02-10 15:46:21 +0100
commit82afa682cfaaa09c3564299fc9f709e80081c661 (patch)
tree572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_fast_squeeze.3
parentbump year and change e-mail (diff)
downloadlibkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.gz
libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.bz2
libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.xz
Work on man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libkeccak_fast_squeeze.3')
-rw-r--r--doc/man/libkeccak_fast_squeeze.318
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/man/libkeccak_fast_squeeze.3 b/doc/man/libkeccak_fast_squeeze.3
index d631492..d782a95 100644
--- a/doc/man/libkeccak_fast_squeeze.3
+++ b/doc/man/libkeccak_fast_squeeze.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK
.SH NAME
libkeccak_fast_squeeze - Runs the squeeze phase a number of times
.SH SYNOPSIS
@@ -6,16 +6,21 @@ libkeccak_fast_squeeze - Runs the squeeze phase a number of times
.nf
#include <libkeccak.h>
.P
-void libkeccak_fast_squeeze(libkeccak_state_t *\fIstate\fP, long \fItimes\fP);
+void
+libkeccak_fast_squeeze(libkeccak_state_t *\fIstate\fP, long int \fItimes\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_fast_squeeze ()
function runs the Keccak squeeze phase, on the the hash
-process described by \fI*state\fP, as many times are
-required to get \fItimes\fP additional digests.
+process described by
+.IR *state ,
+as many times are required to get
+.I times
+additional digests.
.SH RETURN VALUES
The
.BR libkeccak_fast_squeeze ()
@@ -29,9 +34,6 @@ function cannot fail.
.BR libkeccak_fast_digest (3),
.BR libkeccak_simple_squeeze (3),
.BR libkeccak_squeeze (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