The command syntax for PDF CHECKER includes these values:
- Required: The executable name
- Required: The name of the PDF input file you want to review, with the prefix “-i”
- Required: The name of your profile file, with the prefix “-j”
- Optional: The name you want to assign to the PDF CHECKER results output file, with the prefix “-o” (default is standard output)
- Optional: Password for opening the PDF input file, with the prefix “-p”
- Optional: Remove the full path from the input file name by adding the value “-n”
The command syntax for PDF CHECKER with the required values looks like this:
pdfchecker –i input.pdf –j everything.json
In this command you are telling the system to inspect the PDF file called “input.pdf” using the JSON profile “everything.json.”
You can also enter the name of a text file where you want PDF CHECKER to export the results of the review. 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 –i input.pdf –j everything.json -o PDFCHECKER_results.txt –p mypassword -n
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 “-o” before the file name and the prefix “-p” 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 –i C:\Datalogics\CHECKERFiles\AnnualReport2016.pdf –j everything.json –o C:\Datalogics\PDFCHECKER_results.txt
If any of the file or path names include spaces, use quotes around the name:
pdfchecker –i C:\Datalogics\CHECKERFiles\AnnualReport2016.pdf –j everything.json –o “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 –i C:\Datalogics\CHECKERFiles\AnnualReport2016.pdf –j C:\Datalogics\JSONProfiles\everything.json –o 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 –i input.pdf –j everything.json -o PDFCHECKER _results.txt –p mypassword -n