diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-10-05 14:50:41 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-10-05 14:50:41 +0200 |
| commit | 2c5b6f3e0d0cc9154aecdd2b5da7b8e8f6ee28c9 (patch) | |
| tree | 09e9dc70738a09fb8c610b99b23e0921878e2802 /doc | |
| parent | add libkeccak_spec_sha3.3 (diff) | |
| download | libkeccak-2c5b6f3e0d0cc9154aecdd2b5da7b8e8f6ee28c9.tar.gz libkeccak-2c5b6f3e0d0cc9154aecdd2b5da7b8e8f6ee28c9.tar.bz2 libkeccak-2c5b6f3e0d0cc9154aecdd2b5da7b8e8f6ee28c9.tar.xz | |
add libkeccak_spec_rawshake.3 and libkeccak_spec_shake.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/libkeccak_spec_rawshake.3 | 45 | ||||
| -rw-r--r-- | doc/man/libkeccak_spec_shake.3 | 45 |
2 files changed, 90 insertions, 0 deletions
diff --git a/doc/man/libkeccak_spec_rawshake.3 b/doc/man/libkeccak_spec_rawshake.3 new file mode 100644 index 0000000..0da15db --- /dev/null +++ b/doc/man/libkeccak_spec_rawshake.3 @@ -0,0 +1,45 @@ +.TH LIBKECCAK_SPEC_RAWSHAKE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_spec_rawshake - Configure RawSHAKE hashing parameters +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void libkeccak_spec_rawshake(libkeccak_spec_t *\fIspec\fP, long \fIx\fP, long \fId\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_spec_rawshake () +sets \fI*spec\fP to specify the Keccak parameters used for RawSHAKE +hashing with the semicapacity specified, in bits, via the \fIx\fP +parameter, and the output size specified, in bits, via the \fId\fP +parameter. +.SH RETURN VALUES +The +.BR libkeccak_spec_rawshake () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_spec_rawshake () +function cannot fail. +.SH EXAMPLES +This examples configure a \fBlibkeccak_spec_t\fP to specify +the Keccak parameters used for RawSHAKE256(, 512): +.LP +.nf +libkeccak_spec_t spec; +libkeccak_spec_rawshake(&spec, 256, 512); +.fi +.SH SEE ALSO +.BR libkeccak_spec_sha3 (3), +.BR libkeccak_spec_shake (3), +.BR libkeccak_spec_check (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/bus/issues or to +maandree@member.fsf.org diff --git a/doc/man/libkeccak_spec_shake.3 b/doc/man/libkeccak_spec_shake.3 new file mode 100644 index 0000000..4e7a7ef --- /dev/null +++ b/doc/man/libkeccak_spec_shake.3 @@ -0,0 +1,45 @@ +.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_spec_shake - Configure SHAKE hashing parameters +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void libkeccak_spec_shake(libkeccak_spec_t *\fIspec\fP, long \fIx\fP, long \fId\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_spec_shake () +sets \fI*spec\fP to specify the Keccak parameters used for SHAKE +hashing with the semicapacity specified, in bits, via the \fIx\fP +parameter, and the output size specified, in bits, via the \fId\fP +parameter. +.SH RETURN VALUES +The +.BR libkeccak_spec_shake () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_spec_shake () +function cannot fail. +.SH EXAMPLES +This examples configure a \fBlibkeccak_spec_t\fP to specify +the Keccak parameters used for SHAKE256(, 512): +.LP +.nf +libkeccak_spec_t spec; +libkeccak_spec_shake(&spec, 256, 512); +.fi +.SH SEE ALSO +.BR libkeccak_spec_sha3 (3), +.BR libkeccak_spec_rawshake (3), +.BR libkeccak_spec_check (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/bus/issues or to +maandree@member.fsf.org |