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_spec_check.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_spec_check.3 | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/man/libkeccak_spec_check.3 b/doc/man/libkeccak_spec_check.3 index cfdb580..9fc70f6 100644 --- a/doc/man/libkeccak_spec_check.3 +++ b/doc/man/libkeccak_spec_check.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_SPEC_CHECK 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_SPEC_CHECK 3 LIBKECCAK .SH NAME libkeccak_spec_check - Validate hashing parameters .SH SYNOPSIS @@ -6,14 +6,17 @@ libkeccak_spec_check - Validate hashing parameters .nf #include <libkeccak.h> .P -int libkeccak_spec_check(const libkeccak_spec_t *\fIspec\fP); +int +libkeccak_spec_check(const libkeccak_spec_t *\fIspec\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_spec_check () -function validates the parameters of \fI*spec\fP, +function validates the parameters of +.IR *spec , so that unusable configurations can be detected. It is recommended to call this function after calling .BR libkeccak_spec_sha3 (3), @@ -24,9 +27,9 @@ manually for Keccak hashing. .PP .nf typedef struct libkeccak_spec { - long bitrate; /* bitrate (in bits) */ - long capacity; /* capacity (in bits) */ - long output; /* output size (in bits) */ + long int bitrate; /* bitrate (in bits) */ + long int capacity; /* capacity (in bits) */ + long int output; /* output size (in bits) */ } libkeccak_spec_t; .fi .SH RETURN VALUES @@ -87,9 +90,6 @@ function cannot fail. .BR libkeccak_generalised_spec_initialise (3), .BR libkeccak_state_initialise (3), .BR libkeccak_hmac_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 |