diff options
Diffstat (limited to 'doc/man/libkeccak_sha3sum_fd.3')
| -rw-r--r-- | doc/man/libkeccak_sha3sum_fd.3 | 58 |
1 files changed, 36 insertions, 22 deletions
diff --git a/doc/man/libkeccak_sha3sum_fd.3 b/doc/man/libkeccak_sha3sum_fd.3 index 1dab281..e8c4fc0 100644 --- a/doc/man/libkeccak_sha3sum_fd.3 +++ b/doc/man/libkeccak_sha3sum_fd.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_SHA3SUM_FD 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_SHA3SUM_FD 3 LIBKECCAK .SH NAME libkeccak_sha3sum_fd - Calculate a SHA-3 hashsum of a file .SH SYNOPSIS @@ -6,39 +6,54 @@ libkeccak_sha3sum_fd - Calculate a SHA-3 hashsum of a file .nf #include <libkeccak.h> .P -int libkeccak_sha3sum_fd(int \fIfd\fP, libkeccak_state_t *\fIstate\fP, - long \fIoutput\fP, char *\fIhashsum\fP); +int +libkeccak_sha3sum_fd(int \fIfd\fP, libkeccak_state_t *\fIstate\fP, long int \fIoutput\fP, + char *\fIhashsum\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_sha3sum_fd () function calculates a SHA-3 hashsum of a file, whose file -desriptor is specified by \fIfd\fP (and should be at the -beginning of the file.) The hash algorithm is tuned by the -\fIoutput\fP parameter; it specifies the output size, in bits. +desriptor is specified by +.I fd +(and should be at the beginning of the file.) The hash +algorithm is tuned by the +.I output +parameter; it specifies the output size, in bits. .PP -The hash is stored in binary form to \fIhashsum\fP. \fIhashsum\fP +The hash is stored in binary form to +.IR hashsum . +.I hashsum should have an allocation size of at least -(((\fIoutput\fP + 7) / 8) * sizeof(char)). +.RI ((( output ++ 7) / 8) * sizeof(char)). .PP -\fI*state\fP should not be initialised. +.I *state +should not be initialised. .BR libkeccak_sha3sum_fd () -initialises \fI*state\fP itself. Therefore there would be a -memory leak if \fI*state\fP is already initialised. +initialises +.I *state +itself. Therefore there would be a memory leak if +.I *state +is already initialised. .SH RETURN VALUES The .BR libkeccak_sha3sum_fd () function returns 0 upon successful completion. -On error, -1 is returned and \fIerrno\fP is set to describe -the error. +On error, -1 is returned and +.I errno +is set to describe the error. .SH ERRORS The .BR libkeccak_sha3sum_fd () -function may fail for any reason, except those resulting -in \fIerrno\fP being set to \fBEINTR\fP, specified for the -functions +function may fail for any reason, except those resulting in +.I errno +being set to +.BR EINTR , +specified for the functions .BR read (2), .BR malloc (3), and @@ -57,8 +72,10 @@ hashing as this could limit what you can do, and make the library more complex. .PP .BR libkeccak_sha3sum_fd () -does not stop if interrupted (\fBread\fP(2) returns -\fBEINTR\fP.) +does not stop if interrupted +.RB ( read (2) +returns +.BR EINTR .) .PP .BR libkeccak_sha3sum_fd () assumes all information is non-sensitive, and will @@ -89,9 +106,6 @@ libkeccak_state_destroy(&state); .BR libkeccak_spec_check (3), .BR libkeccak_generalised_spec_initialise (3), .BR libkeccak_state_initialise (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 |