General Options
Introduction
These options deal with product information, progress messages, and file maintenance. The following sections detail the use of these options.
General options — summary
The following table provides a summary of the general command-line options.
| Option | Parameter | Description |
|---|---|---|
| -r | RegNum | Pass registration number to Redax Enterprise Server |
| -d | oPassword | Enter Owner password to open this document |
| -l | logFile | Write progress information to logfile |
| -p | Provide progress messages | |
| -n | Do not write information to screen | |
| -v | Display version information | |
| -h or -help | Display current usage information | |
| -o | outFile.pdf | Save output to a new file or directory |
| -w | Linearize the file upon save | |
| -optimize | Optimize the output file to try to reduce file size | |
| -iso32000 | Set file for ISO 32000 compliance (PDF 1.7) | |
| -cmds | CommandFile.txt | Process multiple commands and files. Compatible with -l, -p, -r, -h or -help and -n |
General options — detailed
The following sections provide details on using the general command-line options.
-r RegNum — Pass registration number to Redax Enterprise Server
This option can be used to supply your registration number to Redax Enterprise Server from a script or another application:
$ redaxserverapp -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.
-d <oPassword> — Owner password to open encrypted document
Supplies the current Owner password to open an encrypted document. You can then mark up, redact, or apply new encryption options to the document, but you cannot remove encryption.
Note: If you log your transaction (see the -p and -l options, below) the Owner password is not written to the log; random characters are used instead.
-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 Redax Enterprise Server works.
Note: Please see the sections below: A note on using -p and -l <logfile> together for more clarification on using log files and writing progress messages to the screen.
-n — Do not write information to screen
Do not write anything to the screen (or STDOUT). This prevents progress message from building up.
A note on using -p and -l <logfile> together
As outlined in the above section 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 found | Result |
|---|---|---|---|
| ✔ | Nothing will be written to the screen or to the log file you specify | ||
| ✔ | Progress message will be written to the screen and redaxserver.log | ||
| ✔ | ✔ | Progress messages will be written to the screen and to the log file | |
| ✔ | A redaxserver.log file will be created with the errors in your working directory | ||
| ✔ | ✔ | Errors will be written to the log file | |
| ✔ | ✔ | Errors will be written to redaxserver.log and your screen | |
| ✔ | ✔ | ✔ | Both progress and error messages will be written to the screen and to the log file |
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 Redax Enterprise Server operations whether there are errors or not.
-v — Print version information
Display the version of Redax Enterprise Server 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. Redax Enterprise Server will not do anything else if you use this option.
-h or -help — Display usage information
Display all current command-line options. Redax Enterprise Server will not do anything else if you use one of these options.
-o outFile.pdf — Save to a new file or directory (required)
If you are processing one input file, specify an output file to save the results to. If you are processing more than one input file at a time, specify an existing directory to save the resulting files to.
Note: If you do not specify an output file or directory, 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. Individual pages can be rendered before the entire document has downloaded, so the user can start reading the document sooner.
-optimize
This option 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.
-iso32000
This option will do the following: Set file for ISO 32000 compliance, resulting in a document that is PDF version 1.7.
-cmds — Allows you to process a collection of files at one time
To process multiple commands quickly and efficiently, use the -cmds <filename> option. The file specified by -cmds, the commands file, should contain one or more single line commands. Each command is just like an ordinary command-line without the executable name. The commands file does not support wildcards in filenames. Example of command line syntax when running with -cmds:
$ ./redaxserverapp -p -l logfile.txt -cmds CommandFile.txt
CommandFile.txt contains a list of commands for Redax Enterprise Server to process. Example of the CommandFile.txt:
-p -redact -pref /appligent/redaxserver/samples/prefs/prefs.xml -o /appligent/redaxserver/samples/out_redacted.pdf /appligent/redaxserver/samples/sample_marked.pdf
-p -flist /appligent/redaxserver/samples/sample_find_list.txt -o /appligent/redaxserver/samples/out_find.pdf /appligent/redaxserver/samples/sample.pdf
-p -redact -iso32000 -o /appligent/redaxserver/samples/out_iso32000.pdf /appligent/redaxserver/samples/sample.pdf