PDF Checker

Command Syntax

The command syntax for PDF Checker includes these values:

Required pdfchecker The executable name
Required -i [--input] The name and path of the PDF input file to review
Required -j [--profile] The name and path of the JSON profile file
Optional -o [--output] The name and path to assign to the output results file
Optional -p [--password] Password needed to open a protected PDF input file
Optional -n [--nopath] Remove the system paths to the input PDF or JSON file

For each command line option, you can use either the short (“-i”) or the long (“–input”) notation.

The only value in the command line statement that does not require a matching argument is the last one listed above, “–nopath” for removing the path from the input file name.

The command syntax for PDF Checker with the required values looks like this:

pdfchecker –-input test.pdf –-profile everything.json

In this command you are telling the system to inspect the PDF file called “test.pdf” using the JSON profile “everything.json.”

PDF Checker will display the results of the review on your command line screen by default.  If you would also like the product to export the results to a text file, use the “-o” option. And you can enter a password for opening a PDF document if the PDF input file is password protected.

Finally, if you don’t want the path name for the input PDF document or of the JSON Profile file to appear in your output text file, or in the standard output provided by your command line tool, add the value “-n” to the end of your command line statement. You may want to suppress the place where you store your PDF input files or your JSON profile for security reasons.

The full command syntax for PDF Checker looks like this:

pdfchecker –-input test.pdf –-profile everything.json --output PDFChecker_results.txt –-password mypassword --nopath

This command tells PDF Checker to export the results to a text file called PDFChecker_results.txt. Note that you need to add the prefix “–output” before the file name and the prefix “–password” before the password.

The Windows installation program for PDF Checker adds the location of the PDF Checker executable to the PATH in the Windows Environment Variables. That means that you can run the executable, pdfchecker.exe, from anywhere.

You don’t need to include a path name for any of the files mentioned in the command statement as long as the input file and profile are stored in the same directory as the executable pdfchecker.exe, and as long as you want to save the PDF Checker results file to the same directory. But you of course might want to draw an input file from one directory and save the output to another, and maybe store your JSON Profile files in a third.

In that event you need to provide the path as well as the file name:

pdfchecker –-input C:\Datalogics\CheckerFiles\AnnualReport2016.pdf –-profile everything.json –-output C:\Datalogics\PDFChecker_results.txt

If any of the file or path names include spaces, use quotes around the name:

pdfchecker –-input C:\Datalogics\CheckerFiles\AnnualReport2016.pdf –-profile everything.json –-output "C:\Datalogics\PDFChecker results.txt"

And you can provide a path name for the JSON profile file, just as you would for the input PDF document and the output results file:

pdfchecker –-input C:\Datalogics\CheckerFiles\AnnualReport2016.pdf –-profile C:\Datalogics\JSONProfiles\everything.json –-output C:\Datalogics\PDFChecker_results.txt

If you don’t enter a path name for the JSON profile file as part of the “-j” value, PDF Checker will look for the JSON profile file to use. It will first search the CheckerProfiles folder, which is part of the directory structure for your PDF Checker software installation package and where the standard JSON Profile file, everything.json, the file we provide with the software, is stored. If the file is not in the CheckerProfiles directory, PDF Checker will treat the “-j” input value in the command statement as a path to the profile, and try to load the profile from that location.

This makes the product easier for you to use after you install it. All you need to do is provide the name of the JSON Profile file. PDF Checker can find the file for you.

You can use the JSON profile we provide, everything.json, from the command line, like this:

pdfchecker –-input test.pdf –-profile everything.json --output PDFChecker_results.txt –-password mypassword --nopath