tUpdate manpage to reflect latest flag update - cream - Stream encryption utility
(HTM) git clone git://git.z3bra.org/cream.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit 8d667bc595bfca39c48b21899dadd903096918b8
(DIR) parent 658ef59f5638a92ebd1b33195edc74134a379e34
(HTM) Author: Willy Goiffon <contact@z3bra.org>
Date: Tue, 20 Sep 2022 15:40:43 +0200
Update manpage to reflect latest flag update
Diffstat:
M cream.1 | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+), 0 deletions(-)
---
(DIR) diff --git a/cream.1 b/cream.1
t@@ -7,6 +7,10 @@
.Sh SYNOPSIS
.Nm
.Op Fl deh
+.Op Fl b Ar size
+.Op Fl j Ar thread
+.Op Fl t Ar time
+.Op Fl m Ar memory
.Op Fl s Ar salt
.Op Fl f Ar file
.Sh DESCRIPTION
t@@ -29,6 +33,17 @@ Encryption mode (default). Read plaintext data from
.Ar file
or
.Pa stdout .
+.It Fl b Ar size
+Change internal buffer length to
+.Ar size .
+Default: 8 Kib.
+.It Fl j Ar thread
+Number of thread(s) to use when computing the key. Default: 2.
+.It Fl t Ar time
+Number of iterations to use when computing the key. This effectively
+increases the time cost of computing the key. Default: 2.
+.It Fl m Ar memory
+Memory to use when computing the key. Default: 64 Mib.
.It Fl f Ar file
Read/write encrypted data from/to
.Ar file ,
t@@ -42,6 +57,14 @@ for details about the salt.
.It Fl h
Print a quick usage text.
.El
+.Sh CRYPTOGRAPHIC CONSIDERATIONS
+Most cryptographic parameters can be changed from the command line.
+These values can increase or decrease the time it takes to compute the
+key, or the memory used when dealing with long streams.
+.Pp
+However, changing any of these values will change the produced key,
+or the stream. The same values must be used in order to successfully
+decrypt a stream.
.Sh EXAMPLES
Encrypt a file, then decrypt it (you will be prompted for a password
for each command).