wanderer/ BLAKE3
1
0
Fork 0
mirror of https://github.com/BLAKE3-team/BLAKE3 synced 2024-05-08 06:36:11 +02:00
Code Issues Releases Activity

clean up b3sum help strings and increase max_term_width to 100

This commit is contained in:
Jack O'Connor 2022-11-20 12:39:12 -08:00
parent f10d41924a
commit c6a25d7c97
2 changed files with 22 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
b3sum/README.md
View File

@ -11,28 +11,17 @@ Arguments:
[FILE]... Files to hash, or checkfiles to check
Options:
-l, --length <LEN>
The number of output bytes, prior to hex encoding [default: 32]
--num-threads <NUM>
The maximum number of threads to use
--keyed
Uses the keyed mode
--derive-key <CONTEXT>
Uses the key derivation mode, with the given context string
--no-mmap
Disables memory mapping
--no-names
Omits filenames in the output
--raw
Writes raw output bytes to stdout, rather than hex
-c, --check
Reads BLAKE3 sums from the [FILE]s and checks them
--quiet
Skips printing OK for each successfully verified file
-h, --help
Print help information (use `--help` for more detail)
-V, --version
Print version information
-l, --length <LEN> The number of output bytes, before hex encoding [default: 32]
--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 checks 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
```
See also [this document about how the `--check` flag

22
b3sum/src/main.rs
View File

@ -20,14 +20,14 @@ const RAW_ARG: &str = "raw";
const CHECK_ARG: &str = "check";
#[derive(Parser)]
#[command(version, max_term_width(80))]
#[command(version, max_term_width(100))]
struct Inner {
/// Files to hash, or checkfiles to check.
/// Files to hash, or checkfiles to check
///
/// When no file is given, or when - is given, read standard input.
file: Vec<PathBuf>,
/// The number of output bytes, prior to hex encoding.
/// The number of output bytes, before hex encoding
#[arg(
short,
long,
@ -36,43 +36,43 @@ struct Inner {
)]
length: u64,
/// The maximum number of threads to use.
/// 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.
#[arg(long, value_name("NUM"))]
num_threads: Option<usize>,
/// Uses the keyed mode.
/// Use the keyed mode
///
/// The secret key is read from standard input, and it must be exactly 32
/// raw bytes.
#[arg(long, requires("file"))]
keyed: bool,
/// Uses the key derivation mode, with the given context string.
/// Use the key derivation mode, with the given context string
///
/// Cannot be used with --keyed.
#[arg(long, value_name("CONTEXT"), conflicts_with(KEYED_ARG))]
derive_key: Option<String>,
/// Disables memory mapping.
/// Disable memory mapping
///
/// Currently this also disables multithreading.
#[arg(long)]
no_mmap: bool,
/// Omits filenames in the output.
/// Omit filenames in the output
#[arg(long)]
no_names: bool,
/// Writes raw output bytes to stdout, rather than hex.
/// Write raw output bytes to stdout, rather than hex
///
/// --no-names is implied. In this case, only a single input is allowed.
#[arg(long)]
raw: bool,
/// Reads BLAKE3 sums from the [FILE]s and checks them.
/// Read BLAKE3 sums from the [FILE]s and checks them
#[arg(
short,
long,
@ -84,7 +84,7 @@ struct Inner {
)]
check: bool,
/// Skips printing OK for each successfully verified file.
/// Skip printing OK for each successfully verified file
///
/// Must be used with --check.
#[arg(long, requires(CHECK_ARG))]