aboutsummaryrefslogtreecommitdiffstats
path: root/libar2_encode_params.3
diff options
context:
space:
mode:
Diffstat (limited to 'libar2_encode_params.3')
-rw-r--r--libar2_encode_params.313
1 files changed, 12 insertions, 1 deletions
diff --git a/libar2_encode_params.3 b/libar2_encode_params.3
index 9f654a4..ad86115 100644
--- a/libar2_encode_params.3
+++ b/libar2_encode_params.3
@@ -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 created string will have the following format
.RS
.B \(dq$%s$v=%i$m=%lu,t=%lu,p=%lu$%s$\(dq,
@@ -84,6 +84,17 @@ The created string will have the following format:
.RI < "base64 encoded salt" >
.RE
+if the version is explicitly specified, and otherwise
+
+.RS
+.B \(dq$%s$m=%lu,t=%lu,p=%lu$%s$\(dq,
+.RI < type >\fB,\fP
+.RI < "memory cost" >\fB,\fP
+.RI < "time cost" >\fB,\fP
+.RI < "parallelism" >\fB,\fP
+.RI < "base64 encoded salt" >
+.RE
+
The string does not encode the \(dqsecret\(dq
(pepper), \(dqassociated data\(dq, or the
\(dqtag\(dq (message hash) length. This string