aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_unhex.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/libkeccak_unhex.3')
-rw-r--r--doc/man/libkeccak_unhex.337
1 files changed, 21 insertions, 16 deletions
diff --git a/doc/man/libkeccak_unhex.3 b/doc/man/libkeccak_unhex.3
index 33e091a..93cde63 100644
--- a/doc/man/libkeccak_unhex.3
+++ b/doc/man/libkeccak_unhex.3
@@ -1,4 +1,4 @@
-.TH LIBKECCAK_UNHEX 3 LIBKECCAK-%VERSION%
+.TH LIBKECCAK_UNHEX 3 LIBKECCAK
.SH NAME
libkeccak_unhex - Converts a hexadecimal hashsum to binary
.SH SYNOPSIS
@@ -6,26 +6,33 @@ libkeccak_unhex - Converts a hexadecimal hashsum to binary
.nf
#include <libkeccak.h>
.P
-void libkeccak_unhex(char *restrict \fIoutput\fP,
- const char *restrict \fIhashsum\fP);
+void
+libkeccak_unhex(char *restrict \fIoutput\fP, const char *restrict \fIhashsum\fP);
.fi
.P
-Link with \fI-lkeccak\fP.
+Link with
+.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_unhex ()
function
-converts a hexadecimal hashsum, stored in \fIhashsum\fP,
+converts a hexadecimal hashsum, stored in
+.IR hashsum ,
to binary, and stores the binary representation in
-\fIoutput\fP.
+.IR output .
.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.
+.I hashsum
+must be terminated by a NUL-character. It may be
+in either lowercase or uppercase, or a mixture
+thereof.
+.I output
+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.
+(\fBstrlen\fP(\fIhashsum\fP) / 2) bytes will be
+written to the beginning of
+.IR Ioutput .
+It should therefore have an allocation of at least
+that number of bytes.
.SH RETURN VALUES
The
.BR libkeccak_unhex ()
@@ -35,14 +42,12 @@ The
.BR libkeccak_unhex ()
function cannot fail.
.SH NOTES
-\fIhashsum\fP must have an even number of digits
+.I hashsum
+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@kth.se