Install the PDF Toolbox SDK

Depending on the language you want to use, the PDF Toolbox SDK can be installed in various ways.

Steps to install the PDF Toolbox SDK:

1. Install the package.
2. Set a color profile.
3. Install fonts.
4. Set the license key.
5. Locate the temp files directory and cache directory.

Install the package

Select the interface language of the library for specific instructions on how to install the package.

.NET

NuGet package

NuGet is a package manager that facilitates the integration of libraries for software development in .NET. The NuGet package for the PDF Toolbox SDK contains all the libraries needed, managed and native, for all supported operating systems.

You can get the NuGet package PdfTools.PdfToolbox.4.0.1.nupkg directly from https://www.nuget.org/ or download it from the Pdftools website. In Microsoft Visual Studio, this is the default location for downloading packages.

The PdfTools.PdfToolbox.4.0.1.nupkg package contains .NET libraries with version .NET Standard 2.0, and native libraries for Windows, macOS and Linux.

The required native libraries are loaded automatically. All project platforms are supported, including AnyCPU.

To use the SDK, you need to register your license key.

note

This NuGet package is only supported on a subset of the operating systems supported by .NET Core. See operating systems

Java

info

The PDF Toolbox SDK requires Java version 7 or higher.
For more information on compilation and execution with the Java interface, see PDF Toolbox SDK for Java.

ZIP package

You install the PDF Toolbox SDK for Java using a ZIP archive.

caution

Ensure that your system matches one of the supported operating systems.

Windows

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g. C:\Program Files\PDF Tools AG\.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries and runtime import libraries: win-x86\PdfToolbox.dll and win-x86\PdfToolbox.lib for 32-bit Windows win-x64\PdfToolbox.dll and win-x64\PdfToolbox.lib for 64-bit Windows
doc	Contains documentation
jar	Contains Java archive file com.pdf_tools.fourheights.pdftoolbox.jar.

3. You may want to add the lib\win-x64 or lib\win-x86 subdirectory to the %PATH% environment variable.
4. To use the SDK, you need to register your license key.

Linux

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g, /opt/pdftools.com/.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries: linux-x64/libPdfToolbox.so for 64-bit Linux
doc	Contains documentation
jar	Contains Java archive file com.pdf_tools.fourheights.pdftoolbox.jar.

3. You may want to create a link to the shared library from one of the standard library directories. For example,

ln -s /opt/pdf-tools.com/lib/linux-x86/libPdfToolbox.so /usr/lib

4. To use the SDK, you need to register your license key.

macOS

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g. /opt/pdftools.com/.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries: osx-x64/libPdfToolbox.dylib for 64-bit (Intel) macOS osx-arm64/libPdfToolbox.dylib for ARM (Apple Silicon) macOS
doc	Contains documentation
jar	Contains Java archive file com.pdf_tools.fourheights.pdftoolbox.jar.

3. The library must have the extension .jnilib for use with Java. You may want to create a file link for this purpose. For example,

ln libPdfToolbox.dylib libPdfToolbox.jnilib

4. To use the SDK, you need to register your license key.

C

The PDF Toolbox SDK for C comes as a ZIP archive.

important

Ensure that your system matches one of the supported operating systems.

Windows

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g. C:\Program Files\PDF Tools AG\.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries and runtime import libraries: win-x86\PdfToolbox.dll and win-x86\PdfToolbox.lib for 32-bit Windows win-x64\PdfToolbox.dll and win-x64\PdfToolbox.lib for 64-bit Windows
include	Contains the header files to include in your C/C++ project. The main header PdfToolbox.h includes all the other headers.

3. You may want to add the lib\win-x64 or lib\win-x86 subdirectory to the %PATH% environment variable.
4. To use the SDK, you need to register your license key.

Linux

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g. /opt/pdftools.com/.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries: linux-x64/libPdfToolbox.so for 64-bit Linux
include	Contains the header files to include in your C/C++ project. The main header PdfToolbox.h includes all the other headers.

3. You may want to create a link to the shared library from one of the standard library directories. For example:

ln -s /opt/pdf-tools.com/lib/linux-x64/libPdfToolbox.so /usr/lib

4. To use the SDK, you need to register your license key.

macOS

1. Log in to your account on Pdftools website and download the ZIP archive and the license key for the PDF Toolbox SDK.
2. Unzip the archive to a local directory, e.g. /opt/pdftools.com/.
   This creates the following subdirectories:

Subdirectory	Description
lib	Contains the runtime executable binaries: osx-x64/libPdfToolbox.dylib for 64-bit (Intel) macOS osx-arm64/libPdfToolbox.dylib for ARM (Apple Silicon) macOS
include	Contains the header files to include in your C/C++ project. The main header PdfToolbox.h includes all the other headers.

3. You may want to create a link to the shared library from one of the standard library directories. For example (for an Intel processor Mac):

ln -s /opt/pdf-tools.com/lib/osx-x64/libPdfToolbox.dylib /usr/lib

4. To use the SDK, you need to register your license key.

Install color profiles

Most systems have pre­installed color profiles available. If no color profiles are available, default profiles for both RGB and CMYK are generated on the fly by the PDF Toolbox SDK.

Color profiles can also be downloaded from the following websites:

• http://www.pdf-tools.com/public/downloads/resources/colorprofiles.zip
• http://www.color.org/srgbprofiles.html
• https://www.adobe.com/support/downloads/iccprofiles/iccprofiles_win.html

For device RGB colors, a color profile sRGB Color Space Profile.icm, and for device CMYK, a profile USWebCoatedSWOP.icc are searched for in the following directories (recursively, in the order specified).

To install a color profile, download and copy the profile to the corresponding folder:

Windows

1. %SystemRoot%\System32\spool\drivers\color
2. Directory Icc, which must be a direct sub­directory of where the PdfToolboxAPI.dll resides.

Linux

1. $PDF_ICC_PATH if the environment variable is defined
2. The current working directory

macOS

1. $PDF_ICC_PATH if the environment variable is defined
2. The current working directory

Temp files directory

This directory for temporary files is used for data specific to one instance of a program. The data is not shared between different invocations and deleted after termination of the program.

The directory depends on the operating system. The product checks for the existence of environment variables in the following order and uses the first path found:

Windows

1. The path specified by the %TMP% environment variable.
2. The path specified by the %TEMP% environment variable.
3. The path specified by the %USERPROFILE% environment variable.
4. The Windows directory.

Linux

1. The path specified by the $PDFTMPDIR environment variable.
2. The path specified by the $TMP environment variable.
3. The /tmp directory.

macOS

1. The path specified by the $PDFTMPDIR environment variable.
2. The path specified by the $TMP environment variable.
3. The /tmp directory.

Cache directory

The cache directory is used for data that is persisted and shared between different invocations of a program. The actual caches are created in subdirectories. The content of this directory can safely be deleted to clean all caches.

This directory should be writable by the application. Otherwise, caches cannot be created or updated and performance degrades significantly.

Windows

• If the user has a profile: %LOCAL_APPDATA%\PDF Tools AG\Caches
• If the user has no profile: <TempDirectory>\PDF Tools AG\Caches

Linux

• If the user has a home directory: ~/.pdf-tools/Caches
• If the user has no home directory: <TempDirectory>/pdf-tools/Caches where <TempDirectory> refers to the directory for temporary files

macOS

• If the user has a home directory: ~/.pdf-tools/Caches
• If the user has no home directory: <TempDirectory>/pdf-tools/Caches where <TempDirectory> refers to the directory for temporary files