diff options
Diffstat (limited to '')
-rw-r--r-- | doc/man/libkeccak_hmac_create.3 | 36 |
1 files changed, 22 insertions, 14 deletions
diff --git a/doc/man/libkeccak_hmac_create.3 b/doc/man/libkeccak_hmac_create.3 index 66f25d9..fcb99cb 100644 --- a/doc/man/libkeccak_hmac_create.3 +++ b/doc/man/libkeccak_hmac_create.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK .SH NAME libkeccak_hmac_create - Allocate and initialise HMAC-hashing state .SH SYNOPSIS @@ -6,25 +6,36 @@ libkeccak_hmac_create - Allocate and initialise HMAC-hashing state .nf #include <libkeccak.h> .P -libkeccak_hmac_state_t *libkeccak_hmac_create(const libkeccak_spec_t *\fIspec\fP, - const char *\fIkey\fP, size_t \fIkey_length\fP); +libkeccak_hmac_state_t * +libkeccak_hmac_create(const libkeccak_spec_t *\fIspec\fP, const char *\fIkey\fP, + size_t \fIkey_length\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_hmac_create () -function allocates a new \fIlibkeccak_hmac_state_t*\fP with one -initialised element, and sets the algorithm tuning parameters to -those specified by \fI*spec\fP, and the key to \fIkey\fP of -length \fIkey_length\fP. +function allocates a new +.I libkeccak_hmac_state_t* +with one initialised element, and sets the +algorithm tuning parameters to those specified by +.IR *spec , +and the key to +.I key +of length +.IR key_length . .SH RETURN VALUES The .BR libkeccak_hmac_create () -function returns a newly allocated \fIlibkeccak_hmac_state_t*\fP +function returns a newly allocated +.I libkeccak_hmac_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_hmac_create () @@ -37,9 +48,6 @@ and .BR libkeccak_hmac_free (3), .BR libkeccak_hmac_fast_free (3), .BR libkeccak_hmac_duplicate (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 |