diff options
author | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
commit | 82afa682cfaaa09c3564299fc9f709e80081c661 (patch) | |
tree | 572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_hmac_copy.3 | |
parent | bump year and change e-mail (diff) | |
download | libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.gz libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.bz2 libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.xz |
Work on man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | doc/man/libkeccak_hmac_copy.3 | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/doc/man/libkeccak_hmac_copy.3 b/doc/man/libkeccak_hmac_copy.3 index 742f528..f3939f5 100644 --- a/doc/man/libkeccak_hmac_copy.3 +++ b/doc/man/libkeccak_hmac_copy.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_HMAC_COPY 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_HMAC_COPY 3 LIBKECCAK .SH NAME libkeccak_hmac_copy - Copies an HMAC-hashing state .SH SYNOPSIS @@ -6,24 +6,31 @@ libkeccak_hmac_copy - Copies an HMAC-hashing state .nf #include <libkeccak.h> .P -int libkeccak_hmac_copy(libkeccak_hmac_state_t *\fIdest\fP, - const libkeccak_hmac_state_t *\fIsrc\fP); +int +libkeccak_hmac_copy(libkeccak_hmac_state_t *\fIdest\fP, + const libkeccak_hmac_state_t *\fIsrc\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_hmac_copy () -function initialises \fI*dest\fP to be identical to \fI*src\fP. -This includes all members of the \fBlibkeccak_hmac_state_t\fP +function initialises +.I *dest +to be identical to +.IR *src . +This includes all members of the +.B libkeccak_hmac_state_t structure, including the state of the sponge and the message chunk buffer. .SH RETURN VALUES The .BR libkeccak_hmac_copy () function returns 0 upon successful completion. -On error, -1 is returned and \fIerrno\fP is set to describe -the error. +On error, -1 is returned and +.I errno +is set to describe the error. .SH ERRORS The .BR libkeccak_hmac_copy () @@ -32,9 +39,6 @@ function may fail for any specified for the function .SH SEE ALSO .BR libkeccak_hmac_duplicate (3), .BR libkeccak_hmac_initialise (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 |