Processing
Profiles
Optional parameters are marked with [ ].
Run a profile:
pdfToolbox [-r=r] [-l=l] [-p=p] [--hitsperpage=hitsperpage] [--hitsperdoc=hitsperdoc] [--setvariable=setvariable] [-t] [--cachefolder=cachefolder] [-o=o] [-f=f] [--analyze] [-w] [--incremental] [--noprogress] [--nosummary] [--nohits] [--uncompressimg] [--password] [--timeout=timeout] [-s=s] <profile> <input file> [<input file> [...] ]
Run an action:
pdfToolbox <action> [--cachefolder=cachefolder] [-o=o] [-f=f ] [-s=s]
[--incremental] [-w] [-t] {action specific parameters} <input file> [<input file> [...] ]
On Unix systems, if the environment variable TMPDIR is
defined, its value is used instead of the default /tmp directory for storing
temporary files.
Processing files to PDF
pdfToolbox CLI is able to convert common file formats directly to PDF. To simply convert a file format to PDF, the command --topdf can be used. If a Profile or an Action is used, the file format is automatically converted to PDF before processing.
For more information have a look at the following article: Requirements for conversions to PDF.
- Using Linux, Office file conversion requires an OpenOffice or LibreOffice installation on the respective system.
Conversion options for Office files
The following switches do only apply for Office files and must be set in combination with a Profile, Action or the --topdf command.
OpenOffice
--topdf_forceopenoffice
When defined, Microsoft Office files are processed with OpenOffice.
Start page
--topdf_startpage
Defines the first page in the given Office document which should be converted to PDF. This is set to 1 by default.
End page
--topdf_endpage
Defines the last page in the given Office document which should be converted to PDF. This is set to the last page by default.
Create PDF for screen
--topdf_screen
The images of the created PDF file have a lower quality, the resulting file size is smaller. Comments/Annotations (e.g. for tracking of changes) will be included.
Excel-Sheets without removing white space
--topdf_useexcelpagelayout
Uses the Excel page layout for creating the PDF, white space will not be removed.
Special handling for MS Office files
--topdf_parameter=[ShowHiddenColumns|ShrinkToFit|PrintQualityAndComments|UpdateChangedFields|DoNotHideOffice|NoMemoryOptimization]
Parameters
| ShowHiddenColumns |
Show columns which are not visible due to small width or other settings. (for Office files processed with MS Excel only). Note: When --topdf_useexcelpagelayout is used, this parameter will not be respected. |
| ShrinkToFit |
Shrinks the content of a cell so that the content fits inside. (for Office files processed with MS Excel only). Note: When --topdf_useexcelpagelayout is used, this parameter will not be respected. |
| PrintQualityAndComments |
Images will have bigger resolutions and comments/annotations (e.g. from tracking changes) will be included as well (for Office files processed with MS Word only; can not be combined with --topdf_print). |
| UpdateChangedFields |
Updates the changed fields like automatically generated Table of contents. By default, such fields are not updated (for Office files processed with MS Word only) |
| DoNotHideOffice |
Parameter to avoid hiding Office application for a successful conversion to PDF |
| NoMemoryOptimization |
Parameter to to disable internal memory optimization during processing for improved performance |
Logging of dialogs in defined log file
--topdf_guiactionslog=<path>
Parameters
| path |
Path to folder or logfile. |
All dialogs occuring during processing the office file will be logged within this file. See internet page (listed above) for further information about handling of dialogs from office applications.
Conversion options for Postscript files
The following switches do only apply for Postscript files.
Define folders used for font search
--topdf_psaddfonts=<path>
Parameters
| path |
Path to addtional font folder for PS to PDF conversion which will be additionally used for font search. |
System font folders will also be used.
--topdf_psfontsonly=<path>
Parameters
| path |
Path to font folder for PS to PDF conversion, no usage of system fonts will take place. |
--topdf_pdfsetting=<path>
Parameters
| path |
Path to PDF settings file to be used for conversion of PS and EPS files only, must be a Distiller .joboptions file |
Define a prolgoue and/or an epilogue file
--topdf_psprologue=<path>
Parameters
| path |
Path to an addtional prologue file, which is taken into account when converting files to PDF, must be a .ps file with prologue content |
--topdf_psepilogue=<path>
Parameters
| path |
Path to an addtional epilogue file, which is taken into account when converting files to PDF, must be a .ps file with epilogue content |