aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/libkeccak_degeneralise_spec.32
-rw-r--r--doc/man/libkeccak_generalised_spec_initialise.34
-rw-r--r--doc/man/libkeccak_generalised_sum_fd.36
-rw-r--r--doc/man/libkeccak_keccaksum_fd.37
-rw-r--r--doc/man/libkeccak_rawshakesum_fd.34
-rw-r--r--doc/man/libkeccak_sha3sum_fd.38
-rw-r--r--doc/man/libkeccak_shakesum_fd.32
-rw-r--r--doc/man/libkeccak_spec_check.36
-rw-r--r--doc/man/libkeccak_spec_rawshake.38
-rw-r--r--doc/man/libkeccak_spec_sha3.35
-rw-r--r--doc/man/libkeccak_spec_shake.38
-rw-r--r--doc/man/libkeccak_state_copy.32
-rw-r--r--doc/man/libkeccak_state_create.35
-rw-r--r--doc/man/libkeccak_state_duplicate.32
-rw-r--r--doc/man/libkeccak_state_initialise.34
-rw-r--r--doc/man/libkeccak_state_reset.34
16 files changed, 40 insertions, 37 deletions
diff --git a/doc/man/libkeccak_degeneralise_spec.3 b/doc/man/libkeccak_degeneralise_spec.3
index a9a147b..0051e54 100644
--- a/doc/man/libkeccak_degeneralise_spec.3
+++ b/doc/man/libkeccak_degeneralise_spec.3
@@ -14,7 +14,7 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_degeneralise_spec ()
-will resolve automatic parameters in \fI*spec\fP
+function will resolve automatic parameters in \fI*spec\fP
and translates the parameters to \fI*output_spec\fP,
so that it can be used for hashing.
.PP
diff --git a/doc/man/libkeccak_generalised_spec_initialise.3 b/doc/man/libkeccak_generalised_spec_initialise.3
index d874cb6..a35d18c 100644
--- a/doc/man/libkeccak_generalised_spec_initialise.3
+++ b/doc/man/libkeccak_generalised_spec_initialise.3
@@ -13,8 +13,8 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_generalised_spec_initialise ()
-initialises \fI*spec\fP, so that all parameters
-are configured to be automatically selected.
+function initialises \fI*spec\fP, so that all
+parameters are configured to be automatically selected.
.PP
Automatic selection means that value will be set
to the default, which depends on the other settings.
diff --git a/doc/man/libkeccak_generalised_sum_fd.3 b/doc/man/libkeccak_generalised_sum_fd.3
index 9e038a7..0f46553 100644
--- a/doc/man/libkeccak_generalised_sum_fd.3
+++ b/doc/man/libkeccak_generalised_sum_fd.3
@@ -15,9 +15,9 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_generalised_sum_fd ()
-calculates the hash of a file, whose file desriptor is specified
-by \fIfd\fP (and should be at the beginning of the file.) The
-hash algorithm is specified by \fI*spec\fP and \fIsuffix\fP,
+function calculates the hash of a file, whose file desriptor is
+specified by \fIfd\fP (and should be at the beginning of the file.)
+The hash algorithm is specified by \fI*spec\fP and \fIsuffix\fP,
where \fI*spec\fP is the tuning of the algorithm and \fIsuffix\fP
is the bits append to the message (or \fINULL\fP if none.)
.PP
diff --git a/doc/man/libkeccak_keccaksum_fd.3 b/doc/man/libkeccak_keccaksum_fd.3
index 44f4414..438c453 100644
--- a/doc/man/libkeccak_keccaksum_fd.3
+++ b/doc/man/libkeccak_keccaksum_fd.3
@@ -14,9 +14,10 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_keccaksum_fd ()
-calculates a Keccak hashsum of a file, whose file desriptor is specified
-by \fIfd\fP (and should be at the beginning of the file.) The
-hash algorithm tuning is specified by \fI*spec\fP.
+function calculates a Keccak hashsum of a file, whose file
+desriptor is specified by \fIfd\fP (and should be at the
+beginning of the file.) The hash algorithm tuning is
+specified by \fI*spec\fP.
.PP
The hash is stored in binary form to \fIhashsum\fP. \fIhashsum\fP
should have an allocation size of at least
diff --git a/doc/man/libkeccak_rawshakesum_fd.3 b/doc/man/libkeccak_rawshakesum_fd.3
index 89e68ec..aac51d8 100644
--- a/doc/man/libkeccak_rawshakesum_fd.3
+++ b/doc/man/libkeccak_rawshakesum_fd.3
@@ -15,8 +15,8 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_rawshakesum_fd ()
-calculates a RawSHAKE hashsum of a file, whose file desriptor is
-specified by \fIfd\fP (and should be at the beginning of the file.)
+function calculates a RawSHAKE 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 \fIsemicapacity\fP and \fIoutput\fP
parameters; they specify the half of the capacity and the output size,
respectively, in bits.
diff --git a/doc/man/libkeccak_sha3sum_fd.3 b/doc/man/libkeccak_sha3sum_fd.3
index b7b0b7f..22e2de0 100644
--- a/doc/man/libkeccak_sha3sum_fd.3
+++ b/doc/man/libkeccak_sha3sum_fd.3
@@ -14,10 +14,10 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_sha3sum_fd ()
-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.
+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.
.PP
The hash is stored in binary form to \fIhashsum\fP. \fIhashsum\fP
should have an allocation size of at least
diff --git a/doc/man/libkeccak_shakesum_fd.3 b/doc/man/libkeccak_shakesum_fd.3
index 506cff6..f17c25e 100644
--- a/doc/man/libkeccak_shakesum_fd.3
+++ b/doc/man/libkeccak_shakesum_fd.3
@@ -15,7 +15,7 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_shakesum_fd ()
-calculates a SHAKE hashsum of a file, whose file desriptor is
+function calculates a SHAKE 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 \fIsemicapacity\fP and \fIoutput\fP
parameters; they specify the half of the capacity and the output size,
diff --git a/doc/man/libkeccak_spec_check.3 b/doc/man/libkeccak_spec_check.3
index 067fb72..1caceaa 100644
--- a/doc/man/libkeccak_spec_check.3
+++ b/doc/man/libkeccak_spec_check.3
@@ -13,9 +13,9 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_spec_check ()
-validates the parameters of \fI*spec\fP, so that
-unusable configurations can be detected. It is
-recommended to call this function after calling
+function validates the parameters of \fI*spec\fP,
+so that unusable configurations can be detected.
+It is recommended to call this function after calling
.BR libkeccak_spec_sha3 (3),
.BR libkeccak_spec_rawshake (3),
.BR libkeccak_spec_shake (3),
diff --git a/doc/man/libkeccak_spec_rawshake.3 b/doc/man/libkeccak_spec_rawshake.3
index 4219b84..93782bb 100644
--- a/doc/man/libkeccak_spec_rawshake.3
+++ b/doc/man/libkeccak_spec_rawshake.3
@@ -13,10 +13,10 @@ 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.
+function 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 ()
diff --git a/doc/man/libkeccak_spec_sha3.3 b/doc/man/libkeccak_spec_sha3.3
index 60f1469..f190982 100644
--- a/doc/man/libkeccak_spec_sha3.3
+++ b/doc/man/libkeccak_spec_sha3.3
@@ -13,8 +13,9 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_spec_sha3 ()
-sets \fI*spec\fP to specify the Keccak parameters used for SHA-3
-hashing with the output size specified, in bits, via the \fIx\fP parameter.
+function sets \fI*spec\fP to specify the Keccak parameters
+used for SHA-3 hashing with the output size specified,
+in bits, via the \fIx\fP parameter.
.SH RETURN VALUES
The
.BR libkeccak_spec_sha3 ()
diff --git a/doc/man/libkeccak_spec_shake.3 b/doc/man/libkeccak_spec_shake.3
index a303476..266b803 100644
--- a/doc/man/libkeccak_spec_shake.3
+++ b/doc/man/libkeccak_spec_shake.3
@@ -13,10 +13,10 @@ 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.
+function 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 ()
diff --git a/doc/man/libkeccak_state_copy.3 b/doc/man/libkeccak_state_copy.3
index f0b9673..42fdc64 100644
--- a/doc/man/libkeccak_state_copy.3
+++ b/doc/man/libkeccak_state_copy.3
@@ -13,7 +13,7 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_copy ()
-initialises \fI*dest\fP to be identical to \fI*src\fP.
+function initialises \fI*dest\fP to be identical to \fI*src\fP.
This includes all members of the \fBlibkeccak_state_t\fP
structure, including the state of the sponge and the
message chunk buffer.
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3
index ec78e76..c7b33aa 100644
--- a/doc/man/libkeccak_state_create.3
+++ b/doc/man/libkeccak_state_create.3
@@ -13,8 +13,9 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_create ()
-allocates a new \fIlibkeccak_state_t*\fP with one initialised element,
-and sets the algorithm tuning parameters to those specified by \fI*spec\fP.
+function allocates a new \fIlibkeccak_state_t*\fP with one
+initialised element, and sets the algorithm tuning parameters
+to those specified by \fI*spec\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_create ()
diff --git a/doc/man/libkeccak_state_duplicate.3 b/doc/man/libkeccak_state_duplicate.3
index b76fed1..546b296 100644
--- a/doc/man/libkeccak_state_duplicate.3
+++ b/doc/man/libkeccak_state_duplicate.3
@@ -13,7 +13,7 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_duplicate ()
-allocates a new hash state and initialises it to be identical
+function allocates a new hash state and initialises it to be identical
to \fI*src\fP. This includes all members of the \fBlibkeccak_state_t\fP
structure, including the state of the sponge and the message
chunk buffer.
diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index e0260fb..6c39f7e 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -14,8 +14,8 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_initialise ()
-initialises \fI*state\fP and sets the algorithm tuning parameters
-to those specified by \fI*spec\fP.
+function initialises \fI*state\fP and sets the algorithm
+tuning parameters to those specified by \fI*spec\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_initialise ()
diff --git a/doc/man/libkeccak_state_reset.3 b/doc/man/libkeccak_state_reset.3
index 51c4a13..8aac777 100644
--- a/doc/man/libkeccak_state_reset.3
+++ b/doc/man/libkeccak_state_reset.3
@@ -13,8 +13,8 @@ Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_reset ()
-reinitialises \fI*state\fP, but keeps the tuning, so it
-can be used to hash another message.
+function reinitialises \fI*state\fP, but keeps the
+tuning, so it can be used to hash another message.
.SH RETURN VALUES
The
.BR libkeccak_state_reset ()
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2024-09-20 04:06:54 +0000