From 236de28cb781e74e3e3d2a5b653c0a4b80a25865 Mon Sep 17 00:00:00 2001 From: Matteo Paonessa Date: Thu, 21 Nov 2024 10:06:04 +0800 Subject: [PATCH] Doc update --- CHANGELOG.md | 1 + README.md | 23 +++++++++++++---------- src/options.rs | 2 +- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c831d7e..9bd7ff9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ ## CHANGELOG +* 0.22.0 - Same folder as input, suffix options + lossless flag * 0.21.0 - Compress by quality and long/short edge resize options * 0.20.0 - Keep original dates and format conversion * 0.19.0 - Rust migration diff --git a/README.md b/README.md index 5a0e2ca..c674614 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,20 @@ ``` USAGE: - caesiumclt.exe [FLAGS] [OPTIONS] --max-size --output --quality [FILE]... + caesiumclt.exe [FLAGS] [OPTIONS] --quality [FILE]... FLAGS: - -d, --dry-run do not compress files but just show output paths - -e, --exif keeps EXIF info during compression - -h, --help Prints help information - --keep-dates keep original file date information - -S, --keep-structure keep the folder structure, can be used only with -R - -Q, --quiet suppress all output - -R, --recursive if input is a folder, scan subfolders too + -d, --dry-run do not compress files but just show output paths + -e, --exif keeps EXIF info during compression + -h, --help Prints help information + --keep-dates keep original file date information + -S, --keep-structure keep the folder structure, can be used only with -R + -l, --lossless perform lossless compression + -Q, --quiet suppress all output + -R, --recursive if input is a folder, scan subfolders too --same-folder-as-input sets the output folder to be the same as the input folder. Overwrites original files - -V, --version Prints version information - --zopfli use zopfli when optimizing PNG files (it may take a very long time to complete) + -V, --version Prints version information + --zopfli use zopfli when optimizing PNG files (it may take a very long time to complete) OPTIONS: --height height of the output image, if width is not set will preserve aspect ratio @@ -39,6 +40,8 @@ OPTIONS: --png-opt-level select level for PNG optimization, between [0-6] [default: 3] -q, --quality sets output file quality between [0-100], 0 for optimization --short-edge sets the size of the shortest edge of the image + --suffix convert the image to the selected format (jpg, png, webp, tiff) [default: + none] --threads specify the number of parallel jobs (max is the number of processors available) [default: 0] --verbose select how much output you want to see, 0 is equal to -Q, --quiet [default: diff --git a/src/options.rs b/src/options.rs index 7186c8a..b78ee1e 100644 --- a/src/options.rs +++ b/src/options.rs @@ -102,7 +102,7 @@ pub struct Opt { #[structopt(long = "same-folder-as-input", conflicts_with = "output")] pub same_folder_as_input: bool, - /// convert the image to the selected format (jpg, png, webp, tiff) + /// add a suffix to the output filename #[structopt(long = "suffix", default_value = "none")] pub suffix: String,