Work on man pages

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

6 files changed, 118 insertions, 6 deletions

diff --git a/TODO b/TODO
index d8e11b3..59e86b7 100644
--- a/TODO
+++ b/TODO
@@ -11,7 +11,4 @@ Test parallelisation and acceleration.
 Measure cycles per byte.
 
 Fix todos in the texinfo file.
-Add man pages:
-  libkeccak_hmac_fast_update
-  libkeccak_hmac_update
 
diff --git a/doc/man/libkeccak_hmac_digest.3 b/doc/man/libkeccak_hmac_digest.3
index bd50b2c..66d35d4 100644
--- a/doc/man/libkeccak_hmac_digest.3
+++ b/doc/man/libkeccak_hmac_digest.3
@@ -97,7 +97,7 @@ function may fail for any reason specified by the function
 .BR libkeccak_hmac_create (3),
 .BR libkeccak_hmac_initialise (3),
 .BR libkeccak_hmac_update (3),
-.BR libkeccak_hmac_fast_digest (3),
+.BR libkeccak_hmac_fast_digest (3)
 .SH BUGS
 Please report bugs to https://github.com/maandree/libkeccak/issues or to
 maandree@kth.se
diff --git a/doc/man/libkeccak_hmac_fast_digest.3 b/doc/man/libkeccak_hmac_fast_digest.3
index f717c4f..008477c 100644
--- a/doc/man/libkeccak_hmac_fast_digest.3
+++ b/doc/man/libkeccak_hmac_fast_digest.3
@@ -98,7 +98,7 @@ function may fail for any reason specified by the function
 .BR libkeccak_hmac_create (3),
 .BR libkeccak_hmac_initialise (3),
 .BR libkeccak_hmac_fast_update (3),
-.BR libkeccak_hmac_fast_digest (3),
+.BR libkeccak_hmac_fast_digest (3)
 .SH BUGS
 Please report bugs to https://github.com/maandree/libkeccak/issues or to
 maandree@kth.se
diff --git a/doc/man/libkeccak_hmac_fast_update.3 b/doc/man/libkeccak_hmac_fast_update.3
new file mode 100644
index 0000000..43077d3
--- /dev/null
+++ b/doc/man/libkeccak_hmac_fast_update.3
@@ -0,0 +1,59 @@
+.TH LIBKECCAK_HMAC_FAST_UPDATE 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_fast_update - Partially HMAC-hash a message without erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int
+libkeccak_hmac_fast_update(libkeccak_state_t *\fIstate\fP, const char *\fImsg\fP,
+                           size_t \fImsglen\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_fast_update ()
+function continues (or starts) HMAC-hashing a message.
+The current state of the hashing is stored in
+.IR *state ,
+and will be updated. The message specified by the
+.I msg
+parameter with the byte-size specified by the
+.I msglen
+parameter, will be hashed.
+.PP
+The
+.BR libkeccak_hmac_fast_update ()
+function may reallocate the state's message chunk buffer.
+When doing so, it attempts to do so as securely as possible,
+rather than as fast as possible.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_fast_update ()
+function returns 0 upon successful completion. On error,
+-1 is returned and
+.I errno
+is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_hmac_fast_update ()
+function may reallocate the state's message chunk buffer.
+When doing so, it attempts to do so as quickly as possible,
+rather than ensuring that the information in the old
+allocation is securely removed if a new allocation is required.
+.BR realloc (3).
+.SH NOTES
+Neither parameter by be
+.I NULL
+or 0.
+.SH SEE ALSO
+.BR libkeccak_hmac_create (3),
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_fast_digest (3),
+.BR libkeccak_hmac_update (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se
diff --git a/doc/man/libkeccak_hmac_update.3 b/doc/man/libkeccak_hmac_update.3
new file mode 100644
index 0000000..daaf3fb
--- /dev/null
+++ b/doc/man/libkeccak_hmac_update.3
@@ -0,0 +1,56 @@
+.TH LIBKECCAK_HMAC_UPDATE 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_update - Partially HMAC-hash a message with erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int
+libkeccak_hmac_update(libkeccak_state_t *\fIstate\fP, const char *\fImsg\fP,
+                      size_t \fImsglen\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_update ()
+function continues (or starts) HMAC-hashing a message.
+The current state of the hashing is stored in
+.IR *state ,
+and will be updated. The message specified by the
+.I msg
+parameter with the byte-size specified by the
+.I msglen
+parameter, will be hashed.
+.PP
+The
+.BR libkeccak_hmac_update ()
+function may reallocate the state's message chunk buffer.
+When doing so, it attempts to do so as securely as possible,
+rather than as fast as possible.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_update ()
+function returns 0 upon successful completion. On error,
+-1 is returned and
+.I errno
+is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_hmac_update ()
+function may fail for any reason specified by the function
+.BR malloc (3).
+.SH NOTES
+Neither parameter by be
+.I NULL
+or 0.
+.SH SEE ALSO
+.BR libkeccak_hmac_create (3),
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_digest (3),
+.BR libkeccak_hmac_fast_update (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se
diff --git a/doc/man/libkeccak_update.3 b/doc/man/libkeccak_update.3
index c291ed9..d83f74b 100644
--- a/doc/man/libkeccak_update.3
+++ b/doc/man/libkeccak_update.3
@@ -44,7 +44,7 @@ function may fail for any reason specified by the function
 .BR malloc (3).
 .SH NOTES
 Neither parameter by be
-.O NULL
+.I NULL
 or 0.
 .SH EXAMPLE
 This example calculates the Keccak[b = 1024, c = 576, n = 256]