diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-10-06 18:56:32 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-10-06 18:56:32 +0200 |
| commit | cfd5d4d8bc31f00dbe60c08dd687c6c770f37118 (patch) | |
| tree | 95169de73d1dfea6071fd14ac7f76a3547ed22d8 /doc/man/libkeccak_state_create.3 | |
| parent | add libkeccak_state_wipe.3, libkeccak_state_wipe_sponge.3, and libkeccak_state_wipe_message.3 (diff) | |
| download | libkeccak-cfd5d4d8bc31f00dbe60c08dd687c6c770f37118.tar.gz libkeccak-cfd5d4d8bc31f00dbe60c08dd687c6c770f37118.tar.bz2 libkeccak-cfd5d4d8bc31f00dbe60c08dd687c6c770f37118.tar.xz | |
add libkeccak_state_create.3, libkeccak_state_fast_free.3 and libkeccak_state_free.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libkeccak_state_create.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3 new file mode 100644 index 0000000..ba8b522 --- /dev/null +++ b/doc/man/libkeccak_state_create.3 @@ -0,0 +1,38 @@ +.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_create - Allocate and initialise hash state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +libkeccak_state_t *libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_create () +allocates a new \fIlibkeccak_state_t*\fP with one initialised element, +and sets the algorithm tuning parameters to those specified by \fI*spec\fP. +.SH RETURN VALUES +The +.BR libkeccak_state_create () +function return a new allocated \fIlibkeccak_state_t*\fP +(of one initialised element). On error, \fINULL\fP is returned +and \fIerrno\fP 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) +.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@member.fsf.org |