summaryrefslogtreecommitdiffstats
path: root/pdftool.py
diff options
context:
space:
mode:
authorSadeep Madurange <sadeep@asciimx.com>2023-09-24 15:47:26 +0800
committerSadeep Madurange <sadeep@asciimx.com>2023-09-24 15:47:26 +0800
commit2f66d5b00df062813c6535f76f4fee86d0746e36 (patch)
tree10f1c614109485c4819f3d11284da1a0d33d25b5 /pdftool.py
parent1e7edd062bc009ec33b48d45886954f3677d7ce4 (diff)
downloadesp32-e-reader-2f66d5b00df062813c6535f76f4fee86d0746e36.tar.gz
Add description to pdftool.
Diffstat (limited to 'pdftool.py')
-rw-r--r--pdftool.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/pdftool.py b/pdftool.py
index c4786cb..48500d5 100644
--- a/pdftool.py
+++ b/pdftool.py
@@ -1,12 +1,14 @@
"""
Converts PDF documents to bitmaps and generates a C header file
-that can be rendered on Waveshare E-paper displays.
+that can be used to render PDFs on Waveshare E-paper displays. This script uses
+Poppler and ImageMagick to perform the conversions.
+
Usage: python -m pdftool [document] [first page] [last page] [crop page]
document: path to PDF document
first page: start conversion at this page
last page: stop conversion at this page (inclusive)
- crop page: an optional page number to use when determining area to crop. If not specified
- each page is croppped to minimize white borders.
+ crop page: an optional page number to use when determining area to crop.
+ If not specified, each page is croppped to minimize white borders.
"""
import os