Run a profile:

pdfToolbox [-w] [-t] [-o=o] [-f=f] [-s=s] [--incremental] [-p=p] [--hitsperpage=hitsperpage] [--hitsperdoc=hitsperdoc] [--setvariable=setvariable] [-r=r] [-l=l] [--analyze] [--cachefolder=cachefolder] [--noprogress] [--nosummary] [--nohits] [--uncompressimg] [--timeout=timeout] <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> [...] ]

-p --pagerange=<firstpage>[-<lastpage>]

Allows to define a pagerange to process when perfoming the following tasks:

• Running a profile that contains only checks
• Running the action --createeps
• Running the action --saveasimg

Running a profile with the option --analyze also honors this option.

Parameters

--cachefolder=<path>

Sets the cache folder path. This is set by default to:

This option is mandatory when running the CLI as a user without a home directory.

The cachefolder should have sufficient read/write permissions for the executing user. Especially when the license file is only stored in the cachefolder, this file should be readable by other users.

Parameters

--emptyprofilecache [--cachefolder=<path>]

For performance reasons, bigger profiles are unpacked during first usage and containing ICC-profiles and config files are stored in a local profile cache. This command deletes this profile cache.

--emptyfontcache [--cachefolder=<path>]

For performance reasons, fonts found on the respective system are catalogized in an internal font cache. This command deletes this font cache.

--incremental

Allows to modify the input file, only writing the changes to the original PDF. This can increase the speed significantly since pdfToolbox CLI does not need to create a new copy of the file.

When using the action --impose together with option --preprocessingprofile

or the action --mergeimpose, the incremental saving option can be used in conjunction with --outputfile or --outputfolder to speed up the overall processing time, because all file modifications during these multi-step processes are then performed on a single temporary PDF file.

--nooptimization

The internal PDF structure and fonts are not optimized when saving the PDF file.

--password=<password>

To enable Profile-processing of a password-protected PDF. This option can be used for PDFs with restrictions for editing and printing, which will become unsecured. The resulting PDF will have no security setting.

The entered password will be visible and may be grabbed or logged by other processes on the machine.

Parameters

-s --suffix=<suffix>

Defines the suffix that will be appended to the resulting file(s) filename.

The defined suffix is added before the files type suffix (e.g. Output.pdf will become Output_PDFA.pdf when using --suffix=_PDFA).

Parameters

If a font is not embedded and an embedding is required by a profile, pdfToolbox CLI will search the system font directories in order to find the needed font file, which are:

Additionally the font folder installed together with pdfToolbox CLI will be searched.
This folder lies next to the executable in "<callas pdfToolbox CLI directory>\etc\APDFL\Resource\Font".

The following folders are searched for required ICC-profiles, unless they are already contained in the .kfpx-profile already.

These folders lies next to the executable in:

• "<callas pdfToolbox CLI directory>\etc\ICC profiles"
• "<callas pdfToolbox CLI directory>\etc\APDFL\Resource\Color\Profiles"

Some system folders for colors are searched addtionally:

--timeout=<seconds>

Sets the maximum processing time in seconds. If the process exceeds this duration, the execution process will be killed and the processing will result in an error.

--referencexobjectpath=<path to folder with resources>

Referenced, external resources of the PDF are searched in the same folder as the input PDF by default. To define another folder, this parameter can be used.