93c3e7dfae
This PR brings a big overhaul to oxipng's help, with new long form
descriptions of many options.
The full output (--help) is added as a text file MANUAL.txt. Critiques
welcome.
The short output (-h) is simplified and appears as follows:
```
Losslessly improve compression of PNG files
Usage: oxipng [OPTIONS] <files>...
Arguments:
<files>... File(s) to compress (use '-' for stdin)
Options:
-o, --opt <level> Optimization level (0-6, or max) [default: 2]
-r, --recursive Recurse input directories, optimizing all PNG files
--dir <directory> Write output file(s) to <directory>
--out <file> Write output file to <file>
--stdout Write output to stdout
-p, --preserve Preserve file permissions and timestamps if possible
-P, --pretend Do not write any files, only show compression results
-s Strip safely-removable chunks, same as '--strip safe'
--strip <mode> Strip metadata (safe, all, or comma-separated list)
CAUTION: 'all' will convert APNGs to standard PNGs
--keep <list> Strip all metadata except in the comma-separated list
-a, --alpha Perform additional alpha channel optimization
-i, --interlace <type> Set PNG interlacing type (0, 1, keep) [default: 0]
--scale16 Forcibly reduce 16-bit images to 8-bit (lossy)
-v, --verbose... Run in verbose mode (use twice to increase verbosity)
-q, --quiet Run in quiet mode
-f, --filters <list> Filters to try (0-9; see '--help' for details)
--fast Use fast filter evaluation
--zc <level> Deflate compression level (1-12)
--nb Do not change bit depth
--nc Do not change color type
--np Do not change color palette
--ng Do not change to or from grayscale
--nx Do not perform any transformations
--nz Do not recompress unless transformations occur
--fix Disable checksum validation
--force Write the output even if it is larger than the input
-Z, --zopfli Use the much slower but stronger Zopfli compressor
--timeout <secs> Maximum amount of time to spend on optimizations
-t, --threads <num> Set number of threads to use [default: num CPU cores]
-h, --help Print help (see more with '--help')
-V, --version Print version
Run `oxipng --help` to see full details of all options
```
---------
Co-authored-by: Alejandro González <me@alegon.dev>
93 lines
1.9 KiB
TOML
93 lines
1.9 KiB
TOML
[package]
|
|
authors = ["Joshua Holmer <jholmer.in@gmail.com>"]
|
|
categories = ["command-line-utilities", "compression"]
|
|
description = "A lossless PNG compression optimizer"
|
|
documentation = "https://docs.rs/oxipng"
|
|
edition = "2021"
|
|
exclude = ["tests/*", "bench/*"]
|
|
homepage = "https://github.com/shssoichiro/oxipng"
|
|
license = "MIT"
|
|
name = "oxipng"
|
|
repository = "https://github.com/shssoichiro/oxipng"
|
|
version = "8.0.0"
|
|
rust-version = "1.66.0"
|
|
|
|
[badges]
|
|
travis-ci = { repository = "shssoichiro/oxipng", branch = "master" }
|
|
maintenance = { status = "actively-developed" }
|
|
|
|
[[bin]]
|
|
doc = false
|
|
name = "oxipng"
|
|
path = "src/main.rs"
|
|
required-features = ["binary"]
|
|
|
|
[[bench]]
|
|
name = "zopfli"
|
|
required-features = ["zopfli"]
|
|
|
|
[dependencies]
|
|
zopfli = { version = "0.8.0", optional = true, default-features = false, features = ["std", "zlib"] }
|
|
rgb = "0.8.36"
|
|
indexmap = "2.0.0"
|
|
libdeflater = "1.19.0"
|
|
log = "0.4.19"
|
|
bitvec = "1.0.1"
|
|
rustc-hash = "1.1.0"
|
|
|
|
[dependencies.env_logger]
|
|
optional = true
|
|
default-features = false
|
|
features = ["auto-color"]
|
|
version = "0.10.0"
|
|
|
|
[dependencies.crossbeam-channel]
|
|
optional = true
|
|
version = "0.5.8"
|
|
|
|
[dependencies.filetime]
|
|
optional = true
|
|
version = "0.2.21"
|
|
|
|
[dependencies.rayon]
|
|
optional = true
|
|
version = "1.7.0"
|
|
|
|
[dependencies.clap]
|
|
optional = true
|
|
version = "4.3.8"
|
|
features = ["wrap_help"]
|
|
|
|
[target.'cfg(windows)'.dependencies.glob]
|
|
optional = true
|
|
version = "0.3.1"
|
|
|
|
[dependencies.image]
|
|
optional = true
|
|
default-features = false
|
|
features = ["png"]
|
|
version = "0.24.6"
|
|
|
|
[build-dependencies]
|
|
rustc_version = "0.4.0"
|
|
|
|
[features]
|
|
binary = ["clap", "glob", "env_logger"]
|
|
default = ["binary", "filetime", "parallel", "zopfli"]
|
|
parallel = ["rayon", "indexmap/rayon", "crossbeam-channel"]
|
|
freestanding = ["libdeflater/freestanding"]
|
|
sanity-checks = ["image"]
|
|
|
|
[lib]
|
|
name = "oxipng"
|
|
path = "src/lib.rs"
|
|
|
|
[profile.dev]
|
|
opt-level = 2
|
|
|
|
[profile.release]
|
|
lto = "thin"
|
|
strip = "symbols"
|
|
|
|
[profile.dev.package.bitvec]
|
|
opt-level = 3
|