TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/apache/pdfbox/llms.txt
Use this file to discover all available pages before exploring further.
render command uses PDFBox’s PDFRenderer to rasterize each page of a PDF into an image file. Output filenames follow the pattern <prefix>-<pageNumber>.<format>. You can target a single page, a range of pages, or all pages in one pass, and control resolution, color depth, and output quality independently.
Usage
Options
| Option | Default | Description |
|---|---|---|
-i, --input | (required) | Path to the input PDF file |
-password | (none) | Password to decrypt the document |
-format | jpg | Output image format (e.g. jpg, png, gif, bmp) |
-prefix, -outputPrefix | (auto) | Filename prefix for output images; defaults to the input path without extension |
-page | (all pages) | Render only this single page (1-based); overrides -startPage/-endPage |
-startPage | 1 | First page to render (1-based) |
-endPage | (last page) | Last page to render (inclusive) |
-dpi, -resolution | screen DPI or 96 | Output image resolution in dots per inch |
-color | RGB | Color depth: RGB, RGBA, GRAY, BINARY, ARGB, BGR, GRAY |
-quality | 0 (PNG) / 1 (other) | Compression quality between 0.0 and 1.0 |
-cropbox | (none) | Override crop box for all pages: four integers llx lly urx ury in user-space units |
-subsampling | false | Enable subsampling for PDFs containing very large images (reduces memory use) |
-time | false | Print render time statistics to stderr |