aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_duplicate.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_state_duplicate.332
1 files changed, 19 insertions, 13 deletions
diff --git a/doc/man/libkeccak_state_duplicate.3 b/doc/man/libkeccak_state_duplicate.3
index c579adc..54c9be3 100644
--- a/doc/man/libkeccak_state_duplicate.3
+++ b/doc/man/libkeccak_state_duplicate.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_STATE_DUPLICATE 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_STATE_DUPLICATE 3 LIBKECCAK
.SH NAME
libkeccak_state_duplicate - Allocate a duplicate hash state
.SH SYNOPSIS
@@ -6,24 +6,33 @@ libkeccak_state_duplicate - Allocate a duplicate hash state
.nf
#include <libkeccak.h>
.P
-libkeccak_state_t *libkeccak_state_duplicate(const libkeccak_state_t *\fIsrc\fP);
+libkeccak_state_t *
+libkeccak_state_duplicate(const libkeccak_state_t *\fIsrc\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak P.
.SH DESCRIPTION
The
.BR libkeccak_state_duplicate ()
-function allocates a new hash state and initialises it to be identical
-to \fI*src\fP. This includes all members of the \fBlibkeccak_state_t\fP
-structure, including the state of the sponge and the message
-chunk buffer.
+function allocates a new hash state and initialises it
+to be identical to
+.IR *src .
+This includes all members of the
+.B libkeccak_state_t
+structure, including the state of the sponge and the
+message chunk buffer.
.SH RETURN VALUES
The
.BR libkeccak_state_duplicate ()
-function returns a newly allocated \fIlibkeccak_state_t*\fP
+function returns a newly allocated
+.I libkeccak_state_t*
(of one initialised element) upon successful completion.
-On error, \fINULL\fP is returned and \fIerrno\fP is set to
-describe the error.
+On error,
+.I NULL
+is returned and
+.I errno
+is set to describe the error.
.SH ERRORS
The
.BR libkeccak_state_duplicate ()
@@ -32,9 +41,6 @@ function may fail for any specified for the function
.SH SEE ALSO
.BR libkeccak_state_copy (3),
.BR libkeccak_state_create (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