1
0
mirror of https://github.com/BLAKE3-team/BLAKE3 synced 2025-01-21 15:50:01 +01:00
BLAKE3/b3sum/README.md
Jack O'Connor 0de4412884 version 0.1.4
Changes since 0.1.3:
- Hasher supports the reset() method.
- Hasher implements several traits from the `digest` and `crypto_mac`
  crates.
- Bug fixes in the C implementation for MSVC and for 32-bit x86.
2020-02-03 12:05:26 -05:00

45 lines
1.4 KiB
Markdown

# b3sum
```
b3sum 0.1.4
USAGE:
b3sum [FLAGS] [OPTIONS] [file]...
FLAGS:
-h, --help Prints help information
--keyed Uses the keyed mode, with the raw 32-byte key read from stdin
--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
-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)
ARGS:
<file>...
```
# Building
The standard way to install `b3sum` is:
```
cargo install b3sum
```
On Linux for example, Cargo will put the compiled binary in
`~/.cargo/bin`. You might want to add that directory to your `$PATH`, or
`rustup` might have done it for you when you installed Cargo.
If you want to install directly from this directory, you can run `cargo
install --path .`. Or you can just build with `cargo build --release`,
which puts the binary at `./target/release/b3sum`.
AVX-512 support (via C FFI, with dynamic CPU feature detection) and
multi-threading (via Rayon) are enabled by default. Note that the
underlying `blake3` crate does not enable those by default.