Marown
/
pdf-batch-compressor
mirror of https://github.com/tezzytezzy/pdf-batch-compressor.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added Help section

This commit is contained in:
tezzytezzy 2022-10-11 19:54:13 -07:00 committed by GitHub
parent f753f20021
commit 0d1803dd63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,11 +2,13 @@
## Functionality
This nifty utility compresses PDF files via [Ghostscript](https://www.ghostscript.com/) in the folder where this script resides:
:one: Create a sub-folder, ./compressed, and put the resultant compressed ones in it,
:two: Compress files with any PDF extentions i.e., .pdf, .PDF, .pDf and so on,
:three: Optional compression parameter to be supplied, namely, prepress, ebook (default) and screen - in the descending order of quality, and
:four: Log output with the compressed file names and any error message in the sub-folder
N.B. Make sure to make this script excutable via `chmod +x` or `755`, after downloading!
:four: Log output with the compressed file names and any error message in the sub-folder
N.B. Make sure to make this script excutable via `chmod +x` or `chmod 755`, after downloading!
## Installation
```bash
@ -15,3 +17,19 @@ GNU bash, version 4.4.12(1)-release (x86_64-pc-linux-gnu)
(base) to@mx:~$ gs --help
GPL Ghostscript 9.26 (2018-11-20)
```
## Help
```bash
tezzy@HP:~/Desktop$ ./pdf_batch_compressor.sh -h
NAME
Compress all the PDF files in the same folder as this script resides via
Ghostscript and put them into a newly created "compressed" sub-folder
SYNOPSIS
pdf_batch_compressor.sh [OPTION]
DESCRIPTION
-s, --setting=SETTING
override default ebook; prepress, ebook or screen (in the descending order of quality)
-h, --help
display this help and exit
```