aboutsummaryrefslogtreecommitdiffstats
path: root/libsha2_behex_upper.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-09 20:02:16 +0100
committerMattias Andrée <maandree@kth.se>2019-02-09 20:02:16 +0100
commit9475c19921162986119ee69eba8bfa2a9832d551 (patch)
tree285c9cbd0a824d2bfb480431b33099e2a80e35bf /libsha2_behex_upper.3
parentAdd HMAC to TODO (diff)
downloadlibsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.gz
libsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.bz2
libsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.xz
Minor changes, add man pages, rename libsha2_state_initialise to libsha2_init
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libsha2_behex_upper.3')
-rw-r--r--libsha2_behex_upper.349
1 files changed, 49 insertions, 0 deletions
diff --git a/libsha2_behex_upper.3 b/libsha2_behex_upper.3
new file mode 100644
index 0000000..6faaae2
--- /dev/null
+++ b/libsha2_behex_upper.3
@@ -0,0 +1,49 @@
+.TH LIBSHA2_BEHEX_UPPER 3 2019-02-09 libjson
+.SH NAME
+libsha2_behex_upper \- Convert binary to upper case hexadecimal
+.SH SYNOPSIS
+.nf
+#include <libsha2.h>
+
+void libsha2_behex_upper(char *restrict \fIoutput\fP, const char *restrict \fIhashsum\fP, size_t \fIn\fP);
+.fi
+.PP
+Link with
+.IR \-lsha2 .
+.SH DESCRIPTION
+The
+.BR libsha2_behex_upper ()
+function converts the
+.I n
+first bytes of
+.I hashsum
+to upper case hexadecimal, as exactly
+.I 2*n
+characters, and stores the result, with
+NUL byte termination, to
+.IR output .
+.PP
+The user must make sure that
+.I output
+is at least
+.I 2*n+1
+bytes large.
+.SH RETURN VALUE
+None.
+.SH ERRORS
+None.
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsha2_behex_lower (3),
+.BR libsha2_unhex (3)