aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-10-07 00:57:29 +0200
committerMattias Andrée <maandree@operamail.com>2015-10-07 00:57:29 +0200
commit4654545d89c05f8f8891637b0e4a9f4f469b9df6 (patch)
tree0fcec0cdda137306c3317fd11d8e040c2c4495fd /doc/man
parentadd libkeccak_state_marshal.3, libkeccak_state_marshal_size.3, libkeccak_state_unmarshal.3, and libkeccak_state_unmarshal_skip.3 (diff)
downloadlibkeccak-4654545d89c05f8f8891637b0e4a9f4f469b9df6.tar.gz
libkeccak-4654545d89c05f8f8891637b0e4a9f4f469b9df6.tar.bz2
libkeccak-4654545d89c05f8f8891637b0e4a9f4f469b9df6.tar.xz
add libkeccak_behex_lower.3, libkeccak_behex_upper.3, and libkeccak_unhex.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/libkeccak_behex_lower.344
-rw-r--r--doc/man/libkeccak_behex_upper.344
-rw-r--r--doc/man/libkeccak_unhex.348
3 files changed, 136 insertions, 0 deletions
diff --git a/doc/man/libkeccak_behex_lower.3 b/doc/man/libkeccak_behex_lower.3
new file mode 100644
index 0000000..8db34b2
--- /dev/null
+++ b/doc/man/libkeccak_behex_lower.3
@@ -0,0 +1,44 @@
+.TH LIBKECCAK_BEHEX_LOWER 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_behex_lower - Converts a binary hashsum to lowercase hexadecimal
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_behex_lower(char *restrict \fIoutput\fP,
+ const char *restrict \fIhashsum\fP,
+ size_t \fIn\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_behex_lower ()
+function
+converts a binary hashsum, stored in \fIhashsum\fP,
+to lowercase hexadecimal, and stores the
+hexadecimal representation in \fIoutput\fP.
+.PP
+\fIoutput\fP will be terminated by a NUL-character.
+.PP
+The \fIn\fP parameter specifies the number of bytes
+the binary hashsum is comprised. \fIoutput\fP needs
+an allocation size of (2 * \fIn\fP + 1).
+.SH RETURN VALUES
+The
+.BR libkeccak_behex_lower ()
+function does return any value.
+.SH ERRORS
+The
+.BR libkeccak_behex_lower ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_behex_upper (3),
+.BR libkeccak_unhex (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
diff --git a/doc/man/libkeccak_behex_upper.3 b/doc/man/libkeccak_behex_upper.3
new file mode 100644
index 0000000..df9d0cc
--- /dev/null
+++ b/doc/man/libkeccak_behex_upper.3
@@ -0,0 +1,44 @@
+.TH LIBKECCAK_BEHEX_UPPER 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_behex_upper - Converts a binary hashsum to uppercase hexadecimal
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_behex_upper(char *restrict \fIoutput\fP,
+ const char *restrict \fIhashsum\fP,
+ size_t \fIn\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_behex_upper ()
+function
+converts a binary hashsum, stored in \fIhashsum\fP,
+to uppercase hexadecimal, and stores the
+hexadecimal representation in \fIoutput\fP.
+.PP
+\fIoutput\fP will be terminated by a NUL-character.
+.PP
+The \fIn\fP parameter specifies the number of bytes
+the binary hashsum is comprised. \fIoutput\fP needs
+an allocation size of (2 * \fIn\fP + 1).
+.SH RETURN VALUES
+The
+.BR libkeccak_behex_upper ()
+function does return any value.
+.SH ERRORS
+The
+.BR libkeccak_behex_upper ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_behex_lower (3),
+.BR libkeccak_unhex (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
diff --git a/doc/man/libkeccak_unhex.3 b/doc/man/libkeccak_unhex.3
new file mode 100644
index 0000000..f1df9e9
--- /dev/null
+++ b/doc/man/libkeccak_unhex.3
@@ -0,0 +1,48 @@
+.TH LIBKECCAK_UNHEX 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_unhex - Converts a hexadecimal hashsum to binary
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_unhex(char *restrict \fIoutput\fP,
+ const char *restrict \fIhashsum\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_unhex ()
+function
+converts a hexadecimal hashsum, stored in \fIhashsum\fP,
+to binary, and stores the binary representation in
+\fIoutput\fP.
+.PP
+\fIhashsum\fP must be terminated by a NUL-character.
+It may be in either lowercase or uppercase, or a mixture
+thereof. \fIoutput\fP will not be terminated.
+.PP
+(\fBstrlen\fP(\fIhashsum\fP) / 2) bytes will be written to
+the beginning of \fIoutput\fP. It should therefore have
+an allocation of at least that number of bytes.
+.SH RETURN VALUES
+The
+.BR libkeccak_unhex ()
+function does return any value.
+.SH ERRORS
+The
+.BR libkeccak_unhex ()
+function cannot fail.
+.SH NOTES
+\fIhashsum\fP must have an even number of digits
+(characters excluding the terminating NUL-character.)
+.SH SEE ALSO
+.BR libkeccak_behex_lower (3),
+.BR libkeccak_behex_upper (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