aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_hmac_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-02-10 15:46:21 +0100
committerMattias Andrée <maandree@kth.se>2017-02-10 15:46:21 +0100
commit82afa682cfaaa09c3564299fc9f709e80081c661 (patch)
tree572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_hmac_marshal.3
parentbump year and change e-mail (diff)
downloadlibkeccak-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 'doc/man/libkeccak_hmac_marshal.3')
-rw-r--r--doc/man/libkeccak_hmac_marshal.324
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/man/libkeccak_hmac_marshal.3 b/doc/man/libkeccak_hmac_marshal.3
index b5dbb27..b7270f6 100644
--- a/doc/man/libkeccak_hmac_marshal.3
+++ b/doc/man/libkeccak_hmac_marshal.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_HMAC_MARSHAL 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_HMAC_MARSHAL 3 LIBKECCAK
.SH NAME
libkeccak_hmac_marshal - Marshals an HMAC-hashing state
.SH SYNOPSIS
@@ -6,24 +6,31 @@ libkeccak_hmac_marshal - Marshals an HMAC-hashing state
.nf
#include <libkeccak.h>
.P
-size_t libkeccak_hmac_marshal(const libkeccak_hmac_state_t *\fIstate\fP, char *\fIdata\fP);
+size_t
+libkeccak_hmac_marshal(const libkeccak_hmac_state_t *\fIstate\fP,
+ char *\fIdata\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_hmac_marshal ()
-function marshals \fI*state\fP into the beginning
-of \fIdata\fP.
+function marshals
+.I *state
+into the beginning of
+.IR data .
.PP
Use the
.BR libkeccak_hmac_marshal_size (3)
function to get minimum usable allocation size
-for \fIdata\fP.
+for
+.IR data .
.SH RETURN VALUES
The
.BR libkeccak_hmac_marshal ()
-returns the number of bytes written to \fIdata\fP.
+returns the number of bytes written to
+.IR data .
.SH ERRORS
The
.BR libkeccak_hmac_marshal ()
@@ -32,9 +39,6 @@ function cannot fail.
.BR libkeccak_hmac_marshal_size (3),
.BR libkeccak_hmac_unmarshal (3),
.BR libkeccak_hmac_unmarshal_skip (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