aboutsummaryrefslogtreecommitdiff
path: root/b3sum/README.md
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2020-03-16 12:26:16 -0400
committerJack O'Connor <[email protected]>2020-03-16 12:26:16 -0400
commit470d42a05a130216395e7b91c36d7c0a76519d29 (patch)
tree1fe4f045823d9b09cc694729e782b0ed8a6be42b /b3sum/README.md
parenta0355ba8e075de0f552eae808e9445717943c996 (diff)
update b3sum/README.md
Diffstat (limited to 'b3sum/README.md')
-rw-r--r--b3sum/README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/b3sum/README.md b/b3sum/README.md
index 8e9d8a4..92d5d93 100644
--- a/b3sum/README.md
+++ b/b3sum/README.md
@@ -12,16 +12,24 @@ USAGE:
FLAGS:
-h, --help Prints help information
- --keyed Uses the keyed mode, with the raw 32-byte key read from stdin
+ --keyed Uses the keyed mode. The secret key is read from standard
+ input, and it must be exactly 32 raw bytes.
--no-mmap Disables memory mapping
--no-names Omits filenames in the output
- --raw Writes raw output bytes to stdout, rather than hex. --no-names is implied.
- In this case, only a single input is allowed
+ --raw Writes raw output bytes to stdout, rather than hex.
+ --no-names is implied. In this case, only a single
+ input is allowed.
-V, --version Prints version information
OPTIONS:
- --derive-key <CONTEXT> Uses the key derivation mode, with the input as key material
- -l, --length <LEN> The number of output bytes, prior to hex encoding (default 32)
+ --derive-key <CONTEXT> Uses the key derivation mode, with the given
+ context string. Cannot be used with --keyed.
+ -l, --length <LEN> The number of output bytes, prior to hex
+ encoding (default 32)
+ --num-threads <NUM> The maximum number of threads to use. By
+ default, this is the number of logical cores.
+ If this flag is omitted, or if its value is 0,
+ RAYON_NUM_THREADS is also respected.
ARGS:
<file>...