diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
| commit | 82afa682cfaaa09c3564299fc9f709e80081c661 (patch) | |
| tree | 572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_behex_upper.3 | |
| parent | bump year and change e-mail (diff) | |
| download | libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.gz libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.bz2 libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.xz | |
Work on man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libkeccak_behex_upper.3 | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/doc/man/libkeccak_behex_upper.3 b/doc/man/libkeccak_behex_upper.3 index aad1cc9..7925efc 100644 --- a/doc/man/libkeccak_behex_upper.3 +++ b/doc/man/libkeccak_behex_upper.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_BEHEX_UPPER 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_BEHEX_UPPER 3 LIBKECCAK .SH NAME libkeccak_behex_upper - Converts a binary hashsum to uppercase hexadecimal .SH SYNOPSIS @@ -6,25 +6,34 @@ libkeccak_behex_upper - Converts a binary hashsum to uppercase hexadecimal .nf #include <libkeccak.h> .P -void libkeccak_behex_upper(char *restrict \fIoutput\fP, - const char *restrict \fIhashsum\fP, - size_t \fIn\fP); +void +libkeccak_behex_upper(char *restrict \fIoutput\fP, + const char *restrict \fIhashsum\fP, size_t \fIn\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_behex_upper () function -converts a binary hashsum, stored in \fIhashsum\fP, +converts a binary hashsum, stored in +.IR hashsum , to uppercase hexadecimal, and stores the -hexadecimal representation in \fIoutput\fP. +hexadecimal representation in +.IR output . .PP -\fIoutput\fP will be terminated by a NUL-character. +.I output +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). +The +.I n +parameter specifies the number of bytes +the binary hashsum is comprised. +.I output +needs an allocation size of (2 * +.I n ++ 1). .SH RETURN VALUES The .BR libkeccak_behex_upper () @@ -36,9 +45,6 @@ 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@kth.se |