Add README

This commit is contained in:
Dan Church 2022-10-31 16:37:58 -05:00
parent 8da1867f3e
commit 18515e5794
Signed by: h3xx
GPG Key ID: EA2BF379CD2CDBD0
1 changed files with 32 additions and 0 deletions

32
README.md Normal file
View File

@ -0,0 +1,32 @@
# optipdf - optimize PDF files for size
Uses [qpdf](https://qpdf.sourceforge.io/) to optimize PDF files for size.
## Options
| Option | Meaning
| - | -
| --backup=SUFFIX | Keep a backup of un-optimized PDF files.
| --no-backup | Turn off backups (default).
| --careful | Stop if there are warnings in the PDF (default).
| --no-careful | Don't stop if there are warnings in the PDF.
| --force, -f | Force overwriting backups. No effect if --no-backup.
| --no-force | Prompt when overwriting backups (default). No effect if --no-backup.
| --lossy | Let qpdf(1) try to optimize images for size. MAY LEAD TO IMAGE QUALITY DEGRADATION. See qpdf(1) for more information.
| --no-lossy | Don't optimize images (default). This is safer.
| --preserve-timestamp | Copy timestamp from original file.
| --no-preserve-timestamp | Omit timestamp from original file (default).
## License
Copyright (C) 2021-2022 Dan Church.
License GPLv3: GNU GPL version 3.0 (https://www.gnu.org/licenses/gpl-3.0.html)
with Commons Clause 1.0 (https://commonsclause.com/).
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
You may NOT use this software for commercial purposes.