aboutsummaryrefslogtreecommitdiff
path: root/b3sum/README.md
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2020-05-14 14:02:37 -0400
committerJack O'Connor <[email protected]>2020-05-14 18:35:31 -0400
commitae8cf2f924f10bf882ee140ab25e4ccc4310ba8e (patch)
tree8bb97db12082f08048ae22ddbe6c36ae2ef65ca1 /b3sum/README.md
parent5651ce7ee0b0ad2f577beef7efcef87e2f39fbe2 (diff)
start documenting the --check flag
Diffstat (limited to 'b3sum/README.md')
-rw-r--r--b3sum/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/b3sum/README.md b/b3sum/README.md
index ea8cf67..d8bf0c2 100644
--- a/b3sum/README.md
+++ b/b3sum/README.md
@@ -11,10 +11,12 @@ USAGE:
b3sum [FLAGS] [OPTIONS] [file]...
FLAGS:
+ -c, --check Reads BLAKE3 sums from the [file]s and checks them
-h, --help Prints help information
--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-mmap Disables memory mapping. Currently this also disables
+ multithreading.
--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
@@ -35,6 +37,9 @@ ARGS:
<file>...
```
+See also [this document about how the `--check` flag
+works](./what_does_check_do.md).
+
# Example
Hash the file `foo.txt`: