veraPDF-library

Definitive PDF/A Validation

Licensing

The veraPDF PDF/A Validation Library is dual-licensed, see:

• GPLv3+
• MPLv2+

CI Status

• Travis-CI: master

• Travis-CI: integration

• OPF Jenkins: release-0.8

• OPF Jenkins: integration

Getting veraPDF software

###Pre-requisites In order to use the GUI you'll need:

• Java 7, which can be downloaded from Oracle, or for Linux users OpenJDK.

###veraPDF GUI ####Download release version You can download a Java-based installer for the latest veraPDF GUI release from our download site. The current installation process requires Java 1.7 to be pre-installed.

####Download latest development version If you want to try the latest development version you can obtain it from our development download site. Be aware that we release development snapshots regularly, often more than once a day. While we try to ensure that development builds are well tested there are no guarantees.

####Install from zip package Once downloaded unzip the archive which contains the installer jar with batch and shell scripts to launch, the zip contents are as follows:

verapdf-0.6.0/verapdf-install.bat
verapdf-0.6.0/verapdf-install.sh
verapdf-0.6.0/verapdf-izpack-installer-0.6.0.jar

Windows users should run the 'verapdf-install.bat' dos batch file, while Linux and OSX users should run the shell script, verapdf-install.sh. It's possible to run the installer directly on any platform:

java - jar <path-to-installer-jar>/verapdf-izpack-installer-0.6.0.jar

####Linux full command line download and install Linux users can download and execute the veraPDF installer using the following commands:

wget http://downloads.verapdf.org/rel/verapdf-installer.zip
unzip verapdf-installer.zip
cd verapdf-<version>
./verapdf-install.sh

####veraPDF GUI manual We've prepared a manual for the GUI which is included in the library project and can be downloaded from GitHub.

####JVM configuration options The startup script found in the install dir, e.g. .../verapdf/verapdf-gui for Linux, or .../verapdf/verapdf-gui.bat for Windows can be used to pass configuration options to the JVM. This is done by setting $JAVA_OPTS for Linux, or %JAVA_OPTS% in the Window batch file. Alternatively these can be passed directly as parameters when calling the shell or batch script.

Building the veraPDF-library from Source

###Pre-requisites If you want to build the code from source you'll require:

• Java 7, which can be downloaded from Oracle, or for Linux users OpenJDK.
• Maven v3+

Life will be easier if you also use Git to obtain and manage the source.

###Building veraPDF First you'll need to obtain a version of the veraPDF-library source code. You can compile either the latest relase version or the latest development source. ####Downloading the latest release source Use Git to clone the repository and ensure that the master branch is checked out:

git clone https://github.com/veraPDF/veraPDF-library
git checkout master

or download the latest tar archive or zip archive from GitHub.

####Downloading the latest development source Use Git to clone the repository and ensure that the integration branch is checked out:

git clone https://github.com/veraPDF/veraPDF-library
git checkout integration

or download the latest tar archive or zip archive from GitHub.

####Use Maven to compile the source Move to the downloaded project directory and call Maven install:

cd veraPDF-library
mvn clean install -P clone-test-resources

####Testing the build You can test your build by running the GUI application from the VeraPDF Library GUI gui sub-module.

java -jar gui/target/gui-${project.version}.jar

Where ${project.version} is the current Maven project version. This should bring up the veraPDF GUI main window if the build was successful.