General Options
Introduction to General Options
The common options discussed in this chapter deal with product information, progress messages, and file maintenance. The following sections detail the use of these options.
Note: See Command-Line Options for Digital Signatures for detail about options specific to SecurSign.
Command Syntax
$ secursign [options] [-o outFilePath] inPDFFile
General options — summary
The following table provides a summary of the general command-line options.
| Option | Parameter | Description |
|---|---|---|
| -r | <string> | Pass registration number to SecurSign. |
| -l | <string> | Write progress information to the given log file name. |
| -p | Provide progress messages. | |
| -v | Display version information. | |
| -h or -help | Display usage information. | |
| -o | <string> | Name of new output file or, for multiple inputs, an existing directory name (required). |
| -w | Linearize the file upon save. | |
| -nomod | Retain current file modification date | |
| -optimize | Optimize the output file to try to reduce file size | |
| -nocomp | Do not compress using Object Streams (resulting file is compatible with all versions of Acrobat) (SecurSign 4 & 5). | |
| -comp | Compress using Object Streams (resulting file requires Acrobat 6 and later) (SecurSign 4 & 5). | |
| -iso32000 | Set file for ISO 32000 compliance (PDF 1.7) (SecurSign 4 & 5). |
General options — detailed
The following sections provide details on using the general command-line options.
-r <string> — Pass registration number to SecurSign
This option can be used to supply your registration number to SecurSign from a script or another application:
$ secursignapp -r XXXX-XXXX-XXXX-XXXX-XXXX-XXXX [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 <string> — Write progress information to log file
Write to a text file any errors and/or progress messages. This option is helpful for debugging. The -l 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. Your log file will look different if you are also using the -p option.
-p — Provide progress messages
Write progress messages to the screen (STDOUT, the standard output of your system). This option is helpful for debugging and for understanding how SecurSign works.
A note on using the -p and -l options together
As outlined in the above sections, the -p option displays progress messages on your screen, and the -l 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 | Result |
|---|---|---|---|
| ✔ | Nothing is written to the screen or to the log file you specify. | ||
| ✔ | Progress messages are written to the screen and secursign.log. | ||
| ✔ | ✔ | Progress messages are written to the screen and to the log file you specify. | |
| ✔ | Errors are written to the secursign.log file, which is created in your working directory. | ||
| ✔ | ✔ | Errors are written to the log file you specify. | |
| ✔ | ✔ | Errors are written to secursign.log and your screen. | |
| ✔ | ✔ | ✔ | Both progress and error messages are written to the screen and to the log file you specify. |
Therefore, -l used on its own only goes into action if there are errors. With -p and -l combined, you get a text file with full details on SecurSign operations, whether there are errors or not.
-v — Display version information
Display the version of SecurSign you are running. This is important when corresponding with support@appligent.com. In order to best understand your problem, we must know what version of the software you have. SecurSign does not do any other processing when the -v option is specified.
-h or -help — Display usage information
Display all available command-line options. SecurSign does not do any other processing when the -h or -help option is specified.
-o <string> — Name of new output file or, for multiple inputs, an existing directory (required)
If you are processing one input file, specify an output file to save the results. If you are processing more than one input file at a time, specify an existing directory to save the resulting files.
Note: If you do not specify an output file, the original file will be overwritten which is not recommended. If running multiple files and an output directory is not specified, the command will fail.
-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 of large, multipage documents. Individual pages can be rendered before the entire document has downloaded, so the user can start reading the document sooner.
Note: There are four new options available in SecurSign 4.x and later.
-nomod — Retain current file modification date
Do not change the Modified date of the document.
-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).