https://github.com/smittytone/pdfmaker
A macOS command line tool for quickly combining multiple JPEG images into a single PDF file
https://github.com/smittytone/pdfmaker
cli macos pdf pdf-generation swift
Last synced: 9 months ago
JSON representation
A macOS command line tool for quickly combining multiple JPEG images into a single PDF file
- Host: GitHub
- URL: https://github.com/smittytone/pdfmaker
- Owner: smittytone
- License: mit
- Created: 2019-10-16T14:48:42.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T09:54:27.000Z (about 1 year ago)
- Last Synced: 2025-03-27T09:41:07.663Z (10 months ago)
- Topics: cli, macos, pdf, pdf-generation, swift
- Language: Swift
- Homepage: https://smittytone.net/pdfmaker/
- Size: 19.3 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pdfmaker 2.3.8 #
*pdfmaker* is a command line tool for combining multiple images into a single PDF file. It supports JPEG, HEIC, PNG, TIFF, BMP and WebP as source-image formats.
It can also be used to convert a PDF into separate page JPEG images.
For some background on the development of this tool, please see [this blog post](https://smittytone.wordpress.com/2019/10/25/macos-make-pdf-from-images/).
## Installation ##
Build and copy the binary to the `/usr/local/bin` directory.
## Usage ##
### Making PDFs ###
In Terminal, run `pdfmaker --source --destination --compress `
If you omit any of these switches, their default values will be used:
- Source: The directory from which you ran the tool.
- Destination: The Desktop.
- Name: `PDF From Images.pdf`.
- Compression: The native compression of the JPEG source images
You can use `-s`, `-d`, and `-c` as shorthand for the switches above — `pdfmaker --help` has the details.
Use the `--createdirs` switch to cause *pdfmaker* to create intermediate directories to the target. This is not the default. If this switch is not used, *pdfmaker* will exit with a ‘missing directory’ error.
Use the `--name` switch to provide a filename for your file if you are making a PDF and your destination is a directory.
#### Image Compression ####
The compression option will compress images before adding them to the PDF. This allows you to reduce the size of the final PDF, as required. Provide an amount in the range 0.0 to 1.0, where 0.0 is maximum compression (lowest quality) and 1.0 is no compression (highest quality).
**Note** Building a PDF from JPEG files means that you are already using compressed images. If those JPEGs are highly compressed, applying a low compression amount to *pdfmaker* will not increase image quality but will make your PDF file larger.
### ‘Breaking’ PDFs ###
To convert a PDF to a set of images, in Terminal, run `pdfmaker --break --source --destination --resolution `
You can use `-b`, and `-r` as shorthand for the `--break` and `--resolution` switches. The `-c` switch may also be used to compress the output images.
*pdfmaker* does not delete the source file.
#### Image Resolution ####
The default output resolution is 72dpi (dots per inch). PDFs store page dimensions as points, rather than pixels, enabling device-independent resolution. *pdfmaker* determines image pixel dimensions based on the output resolution and the PDF point dimensions. To get correctly sized images out of a PDF, you need to specify the resolution of the images used to source the PDF. You do this be specifying an appropriate output resolution.
For example, a PDF contains a page sourced from a 2600 x 1600, 300dpi image. Output at 72dpi, this will result in an image of 620 x 400 (2600 * 27 / 300). To get the correct pixel size back, add `-r 300` to the command line. This will yield a 2600 x 1600, 300dpi output image.
If you don’t know the source image dpi resolution, experiment with `-r` values until you get output of the size you require.
### Examples ###
```
pdfmaker --source ~/Documents/'Project X'/Images --destination ~/Documents/PDFs/'Project X.pdf'
```
This will merge all of the images files in `~/Documents/Project X/Images` into a file called `Project X.pdf` which is placed in `~/Documents/PDFs`.
```
pdfmaker --source ~/Documents/'Project X'/Images --destination ~/Documents/PDFs/'Project X.pdf' --compress 0.5
```
This will merge all of the images files in `~/Documents/Project X/Images` into a file called `Project X.pdf` which is placed in `~/Documents/PDFs`. The compilation process will compress images to 50% JPEG quality.
```
pdfmaker --source ~/Documents/'Project X'/Images/cover.jpg --destination ~/Documents/PDFs
```
This converts the image `cover.jpg` into a file called `PDF From Images.pdf` (as no destination filename is specified) that is placed in `~/Documents/PDFs`.
```
pdfmaker --break --source ~/Documents/PDFs/'Project X.pdf' --compress 0.4 --resolution 200
```
This converts `Project X.pdf` to a series of images that will be written to the desktop (the default destination). This images will be highly compressed and output at a resolution of 200dpi.
## Contributions ##
Contributions are welcome, but pull requests can only be accepted when they target the `develop` branch. PRs targeting `main` will be rejected.
## Release Notes ##
- 2.3.8 *5 January 2025*
- Support WebP, BMP and HEIC source images.
- Allow compound flags.
- "A little refactoring: make Swift code more idiomatic."
- Clearer function comments.
- 2.3.7 *13 September 2024*
- Catch PDFKit image initialisation errors and hide from console, but report in a *pdfmaker* fashion.
- 2.3.6 *10 August 2023*
- Fix missing `--name` switch.
- 2.3.5 *09 July 2023*
- Maintenance.
- 2.3.4 *14 March 2023*
- Under-the-hood code changes.
- 2.3.3 *24 May 2022*
- `man` page textual changes.
- 2.3.2 *23 May 2022*
- Add `man` page.
- Under-the-hood code changes.
- 2.3.1 *21 July 2021*
- Add async signal safe ctrl-c trapping code.
- 2.3.0 *19 December 2020*
- Add `--createdirs` switch to create intermediate directories to the specified target.
- Improved handling of relative paths.
- Improved argument checking.
- Colourise output for greater visibility.
- Make error reporting consistent with [*imageprep*](https://smittytone.net/imageprep/index.html).
- Fixed a bug in which target PDFs at non-existent locations were not trapped.
- Write all messages to user via `stderr` ([click here to see why](https://clig.dev/#the-basics)).
- Correctly trap `SIGINT`.
- Add test suite.
- 2.2.0 *18 November 2020*
- Apple Silicon version included.
- Support adding PNG and TIFFs to PDFs.
- More informative error reporting.
- 2.1.0 *09 July 2020*
- Better reporting of bad arguments.
- Add '--version' option.
- 2.0.0 *14 November 2019*
- Add PDF-to-images functionality.
- 1.1.0 *28 October 2019*
- Allow the user to select a single source image, not just source directories.
- Allow the user to name the target file as part of the target path.
- Remove the `--name` switch.
- Ignore dot files in the source image search.
- Support easier notarisation.
- 1.0.0 *18 October 2019*
- Initial public release.
## Copyright ##
*pdfmaker* is copyright © 2025, Tony Smith. The source code is licensed under the terms of the MIT licence.