aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_initialise.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_state_initialise.325
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index bb0f90a..2620686 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_STATE_INITIALISE 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_STATE_INITIALISE 3 LIBKECCAK
.SH NAME
libkeccak_state_initialise - Initialise hash state
.SH SYNOPSIS
@@ -6,22 +6,28 @@ libkeccak_state_initialise - Initialise hash state
.nf
#include <libkeccak.h>
.P
-int libkeccak_state_initialise(libkeccak_state_t *\fIstate\fP,
- const libkeccak_spec_t *\fIspec\fP);
+int
+libkeccak_state_initialise(libkeccak_state_t *\fIstate\fP,
+ const libkeccak_spec_t *\fIspec\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_state_initialise ()
-function initialises \fI*state\fP and sets the algorithm
-tuning parameters to those specified by \fI*spec\fP.
+function initialises
+.I *state
+and sets the algorithm tuning parameters to those
+specified by
+.IR *spec .
.SH RETURN VALUES
The
.BR libkeccak_state_initialise ()
function returns 0 upon successful completion.
-On error, -1 is returned and \fIerrno\fP is set to describe
-the error.
+On error, -1 is returned and
+.I errno
+is set to describe the error.
.SH ERRORS
The
.BR libkeccak_state_initialise ()
@@ -49,9 +55,6 @@ function may fail for any specified for the function
.BR libkeccak_generalised_spec_initialise (3),
.BR libkeccak_state_marshal_size (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