General Options
Introduction
The following general options deal with reporting, logging, and file maintenance.
Sample command
The following command displays usage information for APCrypt:
$apcrypt -h
Summary
The following table provides a summary of the general command-line options.
| Option | Parameter | Description |
|---|---|---|
| -r | <RegNum> | Pass registration number to APCrypt |
| -l | <logfile> | Write progress information to logfile |
| -p | Provide progress messages | |
| -v | Display version information | |
| -h or -help | Display usage information | |
| -w | Linearize the file upon save | |
| -o | <outfile.pdf> | Save output to a new file or directory |
| -optimize | Optimize the output file to try to reduce file size (APCrypt 4.0 only) | |
| -nocomp | Do not compress using Object Streams; compatible with all versions of Acrobat (APCrypt 4.0 only) | |
| -comp | Compress using Object Streams; Acrobat 6 and later (APCrypt 4.0 only) | |
| -iso32000 | Set file for ISO 32000 compliance (PDF 1.7) (APCrypt 4.0 only) |
Detailed Options
The following sections provide details on using the general command-line options.
-r <RegNum> — Pass registration number to APCrypt
This option can be used to supply your registration number to APCrypt from a script or another application:
$apcryptapp -r XXXX-XXXX-XXXX-XXXX-XXXX-XXXX [other options]
This option is typically not necessary and is available for use in cases where the Appligent License File can not be located by the application because of runtime environment restrictions.
-l <logfile> — Log to a log file
Write to a text file any errors and/or progress messages. This option is helpful for debugging. The -l <logfile> option must be followed by a file name.
Note: If the log file you specify is a read-only file, a warning is displayed and nothing is written to the log file. Make sure that your log file is write-enabled.
Note: Your log file will look different if you are also using the -p option, see A note on using -p and -l <logfile> together.
-p — Show progress
Write progress messages to the screen (STDOUT — the standard output of your system). This option is helpful for debugging and for understanding how the utility works.
Note: Please see the following section for more clarification on using log files and writing progress messages to the screen.
A note on using -p and -l <logfile> together
As outlined in the above sections, the -p option gives you progress messages on your screen and the -l <logfile> option writes error messages to a file if errors occur. The following table provides more detail on using these options alone or together.
| -l | -p | Errors | Results |
|---|---|---|---|
| ✔ | Nothing will be written to the screen or to the log file you specify. | ||
| ✔ | Progress messages will be written to the screen and apcrypt.log. | ||
| ✔ | ✔ | Progress messages will be written to the screen and to the log file you specify. | |
| ✔ | The utility will create an apcrypt.log file with the errors in your working directory. | ||
| ✔ | ✔ | Errors will be written to the log file you specify. | |
| ✔ | ✔ | The utility will create an apcrypt.log file and write the errors and progress messages to the file and your screen. | |
| ✔ | ✔ | ✔ | Both progress and error messages will be written to the screen and to the log file you specify. |
Therefore, -l <logfile> used on its own will only go into action if there are errors. With -p and -l <logfile> combined you will get a text file with full details on the utility operation whether there are errors or not.
-v — Print version information
Display the version of the utility you are running. This is important when corresponding with Appligent support; in order to best understand your problem, we must know what version of the software you have. APCrypt will not do anything else if you use this option.
-h or -help — Show usage
Display all available options for the utility. APCrypt will not do anything else if you use either of these options.
-o <outFile.pdf> — Save to a new file or directory
Save the modified file as a new file. We recommend using this option so you do not overwrite your existing files. If you are processing more than one input file at a time, specify a directory to save the resulting files.
Note: Do not forget to specify the output file or directory, or the command will fail. When you encrypt/secure several files at one time and use the -o option, make sure to specify the name of an existing directory. If you specify a filename, all but the first of your original files will be overwritten.
-w — Linearize the file upon save
Save the output file as a linearized document. Linearization reorganizes the file to make it more efficient for web delivery. Individual pages can be rendered before the entire document has downloaded, so the user can start reading the document sooner.
There are four options available in APCrypt 4.x and later.
-optimize — Optimize the file (optional)
This flag will do the following: 1) encode any non-encoded streams using Flate compression, 2) remove ASCII85 filters from all streams, 3) replace LZW encoded streams with Flate encoding, 4) merge identical XObjects and images, 5) optimize common sequences in page content, and 6) merge identical font descriptors and encodings. This option will usually result in a smaller file size.
-nocomp — Do not compress using Object Streams (optional)
This flag will not compress Object Streams, resulting in a document that is compatible with all versions of Acrobat.
-comp — Compress using Object Streams (optional)
This flag will compress Object Streams, resulting in a document that is compatible with Acrobat 6.0 and later.
-iso32000 — Set file for ISO 32000-1 compliance (optional)
This flag sets the file for compliance with ISO 32000-1:2008 (PDF 1.7).