From 9b52d4e04c306529427bdd2e489b01bd1d423156 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 6 Oct 2015 20:10:48 +0200 Subject: add libkeccak_state_marshal.3, libkeccak_state_marshal_size.3, libkeccak_state_unmarshal.3, and libkeccak_state_unmarshal_skip.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libkeccak_state_marshal.3 | 40 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 doc/man/libkeccak_state_marshal.3 (limited to 'doc/man/libkeccak_state_marshal.3') diff --git a/doc/man/libkeccak_state_marshal.3 b/doc/man/libkeccak_state_marshal.3 new file mode 100644 index 0000000..52c8502 --- /dev/null +++ b/doc/man/libkeccak_state_marshal.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_marshal - Marshals a hash state +.SH SYNOPSIS +.LP +.nf +#include +.P +size_t libkeccak_state_marshal(const libkeccak_state_t *\fIstate\fP, char *\fIdata\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_marshal () +function marshals \fI*state\fP into the beginning +of \fIdata\fP. +.PP +Use the +.BR libkeccak_state_marshal_size (3) +function to get minimum usable allocation size +for \fIdata\fP. +.SH RETURN VALUES +The +.BR libkeccak_state_marshal () +returns the number of bytes written to \fIdata\fP. +.SH ERRORS +The +.BR libkeccak_state_marshal () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_state_marshal_size (3), +.BR libkeccak_state_unmarshal (3), +.BR libkeccak_state_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@member.fsf.org -- cgit v1.2.3-70-g09d2