aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_squeeze.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/libkeccak_squeeze.3')
-rw-r--r--doc/man/libkeccak_squeeze.325
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/man/libkeccak_squeeze.3 b/doc/man/libkeccak_squeeze.3
index cc5fcf7..eafbc65 100644
--- a/doc/man/libkeccak_squeeze.3
+++ b/doc/man/libkeccak_squeeze.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK
.SH NAME
libkeccak_squeeze - Runs the squeeze phase
.SH SYNOPSIS
@@ -6,24 +6,30 @@ libkeccak_squeeze - Runs the squeeze phase
.nf
#include <libkeccak.h>
.P
-void libkeccak_squeeze(libkeccak_state_t *\fIstate\fP, char *\fIhashsum\fP);
+void
+libkeccak_squeeze(libkeccak_state_t *\fIstate\fP, char *\fIhashsum\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_squeeze ()
function runs the Keccak squeeze phase, on the the hash
-process described by \fI*state\fP, on stores a new digest,
-in binary form, in \fIhashsum\fP.
+process described by
+.IR *state ,
+on stores a new digest, in binary form, in
+.IR hashsum .
.PP
-\fIhashsum\fP has the same requirement as for the
+.I hashsum
+has the same requirement as for the
.BR libkeccak_digest (3)
and
.BR libkeccak_fast_digest (3)
functions: it must have an allocation size of at least
-((\fIstate->n\fP + 7) / 8) bytes. However, it may not
-be \fINULL\fP.
+.RI (( Istate->n
++ 7) / 8) bytes. However, it may not be
+.IR NULL .
.SH RETURN VALUES
The
.BR libkeccak_squeeze ()
@@ -37,9 +43,6 @@ function cannot fail.
.BR libkeccak_fast_digest (3),
.BR libkeccak_simple_squeeze (3),
.BR libkeccak_fast_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