aboutsummaryrefslogtreecommitdiffstats
path: root/libar2_encode_params.3
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-05-16 22:08:24 +0200
committerMattias Andrée <m@maandree.se>2026-05-16 22:08:24 +0200
commit9ec46ba87daa4ede804b1cb0abd91b85caf6f910 (patch)
tree6de728a336ed007b408f4d5f75a84551ac43cdbe /libar2_encode_params.3
parentAdd sanitizer options to config.mk (diff)
downloadlibar2-9ec46ba87daa4ede804b1cb0abd91b85caf6f910.tar.gz
libar2-9ec46ba87daa4ede804b1cb0abd91b85caf6f910.tar.bz2
libar2-9ec46ba87daa4ede804b1cb0abd91b85caf6f910.tar.xz
Man page fixes
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to 'libar2_encode_params.3')
-rw-r--r--libar2_encode_params.324
1 files changed, 12 insertions, 12 deletions
diff --git a/libar2_encode_params.3 b/libar2_encode_params.3
index b0566ff..d901a75 100644
--- a/libar2_encode_params.3
+++ b/libar2_encode_params.3
@@ -44,7 +44,7 @@ The
.BR libar2_encode_params ()
function encodes the Argon2 hashing parameters
provided via the
-.I param
+.I params
parameter, as a string, in a standardised format,
and stores the string in
.I buf
@@ -56,9 +56,9 @@ and return the number of bytes that was (or would
have been) written to
.IR buf .
.PP
-It is recommended that the
+It is recommended to call the
.BR libar2_encode_params ()
-function is called twice: first with
+function twice: first with
.I buf
set to
.IR NULL ,
@@ -72,7 +72,7 @@ with an allocation size of at least the number
of bytes that was returned by the function in
the previous call to it.
.PP
-The created string will have the following format
+The generated string will have the following format
.RS
.B \(dq$%s$v=%i$m=%lu,t=%lu,p=%lu$%s$\(dq,
@@ -80,8 +80,8 @@ The created string will have the following format
.RI < version >\fB,\fP
.RI < "memory cost" >\fB,\fP
.RI < "time cost" >\fB,\fP
-.RI < "parallelism" >\fB,\fP
-.RI < "base64 encoded salt" >
+.RI < parallelism >\fB,\fP
+.RI < "base64-encoded salt" >
.RE
if the version is explicitly specified, and otherwise
@@ -91,8 +91,8 @@ if the version is explicitly specified, and otherwise
.RI < type >\fB,\fP
.RI < "memory cost" >\fB,\fP
.RI < "time cost" >\fB,\fP
-.RI < "parallelism" >\fB,\fP
-.RI < "base64 encoded salt" >
+.RI < parallelism >\fB,\fP
+.RI < "base64-encoded salt" >
.RE
The string does not encode the \(dqsecret\(dq
@@ -104,11 +104,11 @@ is encoded in base64 and appended to the string
formatted by this function. For information
about the expected contents of the
.I params
-argument, see
+argument, see
.BR libar2_hash (3).
.PP
.I params
-may not be
+must not be
.IR NULL .
.SH RETURN VALUES
@@ -138,7 +138,7 @@ function cannot fail.
.SH EXAMPLES
The following example demonstrates how to
-encode the hashing parameters into a dynamically
+encode hashing parameters into a dynamically
allocated string.
.PP
.nf
@@ -161,7 +161,7 @@ encode_params(const struct libar2_argon2_parameters *params)
.SH NOTES
The
.BR libar2_encode_params ()
-function till note validate its input.
+function will not validate its input.
This has to be done using the
.BR libar2_validate_params (3)
function.