From 3e1864aa14a33a3c917537a241f6a032cfcacf78 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 14 Oct 2017 01:01:14 +0200 Subject: General improvements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/libkeccak_state_create.3 | 46 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 man/libkeccak_state_create.3 (limited to 'man/libkeccak_state_create.3') diff --git a/man/libkeccak_state_create.3 b/man/libkeccak_state_create.3 new file mode 100644 index 0000000..77880a3 --- /dev/null +++ b/man/libkeccak_state_create.3 @@ -0,0 +1,46 @@ +.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK +.SH NAME +libkeccak_state_create - Allocate and initialise hash state +.SH SYNOPSIS +.LP +.nf +#include +.P +libkeccak_state_t * +libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP); +.fi +.P +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_state_create () +function allocates a new +.I libkeccak_state_t* +with one initialised element, and sets the algorithm +tuning parameters to those specified by +.IR *spec . +.SH RETURN VALUES +The +.BR libkeccak_state_create () +function returns a newly allocated +.I libkeccak_state_t* +(of one initialised element) upon successful completion. +On error, +.I NULL +is returned and +.I errno +is set to describe the error. +.SH ERRORS +The +.BR libkeccak_state_create () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_state_initialise (3), +.BR libkeccak_state_free (3), +.BR libkeccak_state_fast_free (3) +.BR libkeccak_state_duplicate (3) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se -- cgit v1.2.3-70-g09d2