aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_create.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /doc/man/libkeccak_state_create.3
parentChange style and license (diff)
downloadlibkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libkeccak_state_create.3')
-rw-r--r--doc/man/libkeccak_state_create.346
1 files changed, 0 insertions, 46 deletions
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3
deleted file mode 100644
index 77880a3..0000000
--- a/doc/man/libkeccak_state_create.3
+++ /dev/null
@@ -1,46 +0,0 @@
-.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK
-.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
-.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