General improvements

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 40 insertions, 0 deletions

diff --git a/man/libkeccak_state_unmarshal_skip.3 b/man/libkeccak_state_unmarshal_skip.3
new file mode 100644
index 0000000..b87386c
--- /dev/null
+++ b/man/libkeccak_state_unmarshal_skip.3
@@ -0,0 +1,40 @@
+.TH LIBKECCAK_STATE_UNMARSHAL_SKIP 3 LIBKECCAK
+.SH NAME
+libkeccak_state_unmarshal_skip - Calculates the marshal-size of a marshalled hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t
+libkeccak_state_unmarshal_skip(const char *\fIdata\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_unmarshal_skip ()
+function gets the number of bytes with which
+the hash state in the beginning of
+.I data
+is store stored. This is useful if you do not
+want to unmarshal the state.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_unmarshal_skip ()
+returns a positive value: the number of
+bytes to skip forward to skip pass the
+hash state stored at the beginning of
+the buffer.
+.SH ERRORS
+The
+.BR libkeccak_state_unmarshal_skip ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_state_marshal (3),
+.BR libkeccak_state_unmarshal (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se