aboutsummaryrefslogtreecommitdiff
path: root/b3sum/README.md
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2023-06-08 12:24:05 -0700
committerJack O'Connor <[email protected]>2023-06-08 13:06:32 -0700
commit65733a753b91f560293b6f9689e1dc55c2c923b9 (patch)
tree3466793aa5d310fd063c4a939e60e0f3a004aeae /b3sum/README.md
parent0c7add10c6a849611f43563a52b87bbcd66edac1 (diff)
version 1.4.01.4.0
Changes since 1.3.3: - The C implementation provides a `CMakeLists.txt` for callers who build with CMake. The CMake build is not yet stable, and callers should expect breaking changes in patch version updates. The "by hand" build will always continue to be supported and documented. - `b3sum` supports the `--seek` flag, to set the starting position in the output stream. - `b3sum --check` prints a summary of errors to stderr. - `Hash::as_bytes` is const. - `Hash` supports `from_bytes`, which is const.
Diffstat (limited to 'b3sum/README.md')
-rw-r--r--b3sum/README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/b3sum/README.md b/b3sum/README.md
index 9f66a60..d1fbc21 100644
--- a/b3sum/README.md
+++ b/b3sum/README.md
@@ -11,17 +11,18 @@ Arguments:
[FILE]... Files to hash, or checkfiles to check
Options:
+ --keyed Use the keyed mode, reading the 32-byte key from stdin
+ --derive-key <CONTEXT> Use the key derivation mode, with the given context string
-l, --length <LEN> The number of output bytes, before hex encoding [default: 32]
+ --seek <SEEK> The starting output byte offset, before hex encoding [default: 0]
--num-threads <NUM> The maximum number of threads to use
- --keyed Use the keyed mode
- --derive-key <CONTEXT> Use the key derivation mode, with the given context string
--no-mmap Disable memory mapping
--no-names Omit filenames in the output
--raw Write raw output bytes to stdout, rather than hex
-c, --check Read BLAKE3 sums from the [FILE]s and check them
- --quiet Skip printing OK for each successfully verified file
- -h, --help Print help information (use `--help` for more detail)
- -V, --version Print version information
+ --quiet Skip printing OK for each checked file
+ -h, --help Print help (see more with '--help')
+ -V, --version Print version
```
See also [this document about how the `--check` flag