diff --git a/README.md b/README.md index ee3efc2..8674e7b 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ The SHA2 family and MD5 is also supported but that's only there for compatibilit ## Usage ``` +A CLI frontend to jwalk for blazingly fast filesystem traversal! + Usage: jw [OPTIONS] [directories]... Arguments: @@ -39,12 +41,13 @@ Options: Display results in realtime, rather than collecting first and displaying later. This will result in a significant drop in performance due to the constant terminal output. - -c, --csum + -c, --checksum Output an index containing the hash of every file using the specified algorithm. - Uses the default algorithm. To specify one use --calgo. Note: specifying --calgo makes this redundant. + Uses the default algorithm. To specify one use --calgo. + Note: specifying --calgo makes this redundant. - -C, --calgo - Performs --csum but with the specified hashing algorithm. + -C, --checksum-with + Performs --checksum but with the specified hashing algorithm. Using xxh3 is the recommended choice. Unless you have a reason to use something else, stick with the default. SHA2 and MD5 are provided for compatibility with other tools and existing data. If you're only using jw, you stand to gain a large increase in @@ -53,11 +56,6 @@ Options: [default: xxh3] [possible values: xxh3, sha224, sha256, sha384, sha512, md5] - -t, --threads - The number of threads to use to hash files in parallel. - - [default: 1] - -D, --diff ... Validate hashes from two or more files containing output from `jw --checksum` The first file will be treated as the "correct" one; any discrepant hashes @@ -75,6 +73,9 @@ Options: [possible values: files, dirs, dot, other] + -S, --silent + Suppress output, useful for benchmarking, or just counting files via --stats + -s, --stats Count the number of files, dirs, and other entries, and print at the end. This will decrease performance. Unnoticeable in most cases, but the more diff --git a/src/main.rs b/src/main.rs index ddcecde..8b99bae 100644 --- a/src/main.rs +++ b/src/main.rs @@ -326,7 +326,7 @@ fn main() { This will result in a significant drop in performance due to the constant terminal output.")) .arg(Arg::new("checksum") - .long("csum") + .long("checksum") .short('c') .action(ArgAction::SetTrue) .help("Output an index containing the hash of every file using the specified algorithm.") @@ -334,15 +334,15 @@ This will result in a significant drop in performance due to the constant termin Uses the default algorithm. To specify one use --calgo. Note: specifying --calgo makes this redundant.")) .arg(Arg::new("checksum-algo") - .long("calgo") + .long("checksum-with") .short('C') .value_parser(["xxh3", "sha224", "sha256", "sha384", "sha512", "md5"]) .default_value("xxh3") .ignore_case(true) .value_name("algorithm") .default_value("xxh3") - .help("Performs --csum but with the specified hashing algorithm.") - .long_help("Performs --csum but with the specified hashing algorithm. + .help("Performs --checksum but with the specified hashing algorithm.") + .long_help("Performs --checksum but with the specified hashing algorithm. Using xxh3 is the recommended choice. Unless you have a reason to use something else, stick with the default. SHA2 and MD5 are provided for compatibility with other tools and existing data. If you're only using jw, you stand to gain a large increase in