Marking Text – Command Line Options
Introduction
This section describes the command-line options for marking text for redaction and explains how to use the options to accomplish specific tasks.
The examples provided use the sample files contained in the samples subdirectory where Redax Enterprise Server was installed. In Windows, the default installation directory is C:\Appligent\RedaxServer. In UNIX, it is wherever you installed it.
Command syntax
$redaxserver -o <output> [options] input1.pdf [input2.pdf ...]
Options for marking text — summary
| Type | Option | Parameter | Description |
|---|---|---|---|
| Preferences | -pref | <preferences.xml> | Read preferences from an XML file |
| Find and Mark | -fbracket | Find bracketed text | |
| -markpages | <pages> | Mark single page or list of pages for redaction | |
| -flist | <listfile.txt> | Find using list file | |
| -fpattern | <pattern_listfile.txt> | Find using list file of pattern names | |
| -fregex | <regular_expression_listfile.txt> | Find using list file of regular expressions | |
| -exemptpat | Use the matching pattern name as the exemption code | ||
| -ignorecase | Ignore case during -flist or -fregex operations | ||
| Convert Acrobat- Selected Text |
-cm | Convert all Acrobat-selected text without exemption codes | |
| -ch | Convert Acrobat highlights without an exemption code | ||
| -chc | <exemption> | Convert Acrobat highlights using specified exemption code | |
| -cs | Convert Acrobat crossouts without an exemption code | ||
| -csc | <exemption> | Convert Acrobat crossouts using specified exemption code | |
| -cu | Convert Acrobat underlines with an exemption code | ||
| -cuc | <exemption> | Convert Acrobat underlines using specified exemption code | |
| -cr | Convert Reader XI Rectangle annotation markups | ||
| -crc | <exemption> | Convert Reader XI Rectangle annotation markups using specified exemption code | |
| -crem | Remove Acrobat annotations when using any convert option |
Note: A related option, -rmarkup, enables you to redact Acrobat markups at conversion time.
Options for marking text — details
-pref <preferences.xml> — Read preferences from an XML file
Reads preferences for Redax boxes, redactions, and processing options from the XML file specified by preferences.xml (see example prefs.xml). Preferences are established in the RedaxESconfig utility, supplied with Redax Enterprise Server. If you do not specify a preferences file, Redax Enterprise Server applies the default Redax box and markup processing option preferences described in the table below.
Note: If you specify a preferences file and one or more deprecated options on the command line, the settings in the preferences file will override the deprecated options. The deprecated options are described in Deprecated Command Line Options.
| Type | Property | Description | Default |
|---|---|---|---|
| Redax Boxes | Author | The name of the author to be associated with Redax boxes and Full Page tags. | No author |
| Category | A redaction classification to be associated with Redax boxes and Full-Page tags. | No category | |
| Exemption | An exemption code assigned to Full-Page tags and Redax boxes. | No exemption code | |
| Note | A note to be associated with Redax boxes and Full-Page tags. | No note | |
| Box Color | The border color of Redax boxes. | Red | |
Note: This option applies to Redax boxes only; it does not apply to Full-Page tags. |
|||
| Markup Processing | Remove brackets when finding bracketed text | Indicates whether or not to mark the brackets for removal, along with the enclosed text, during a find bracketed text operation (-fbracket). | Do not mark brackets for removal |
-fbracket — Find bracketed text
Finds all text areas between brackets [ ] and draws Redax boxes around them. The brackets themselves are not marked unless you also specify a preferences file that indicates to Remove Brackets when Finding Bracketed Text.
-markpages <pages> — Mark single page or list of pages
Places a Full-page tag on each page specified in <pages> to mark the entire page for redaction. Either specify a single page or a list of pages. In a list, use a comma to separate pages and a dash to indicate a range of pages, as in the following examples. If you include spaces, enclose the list in quotes.
-markpages 6,14,17-20 -markpages “6, 14, 17-20”
-flist <listfile.txt> — Find using list file
Searches the document for all words and phrases in the redaction list file <listfile.txt>, marks them with Redax boxes, and applies the exemption code specified in the list. See Creating list files for more information about redaction list files.
-fpattern <pattern_listfile.txt> — Find using pre-defined patterns
Searches the document for patterns defined in a text file and marks them with Redax boxes. See the list of available patterns. To set an exemption code for an -fpattern process, use a preferences XML file with your desired exemption code set as the default.
-fregex <regex_listfile.txt> — Find using list file of regular expressions
Searches the document for words or phrases matching regular expressions as defined in a list file <regular_expressions_listfile.txt>, marks them with Redax boxes and applies the exemption code specified in the list. See creating list files for more information.
-exemptpat — Use the matching pattern name as the exemption code
Any Redax box created via -fpattern will have an exemption code that is the label of the pattern. For example, if you are looking for “Email” when Redax Enterprise Server finds the information in a file, the word “email” will be applied as the exemption code for these areas.
-ignorecase — Ignore case during find-using-list and find-using-a-regular-expression
Performs a case-insensitive search during the -flist and -fregex operations. By default, -flist and -fregex perform a case-sensitive search.
-cm — Convert all Acrobat highlights, underlines, and crossouts
Converts all Acrobat-highlighted, -underlined, and -crossed-out text to Redax markup but does not apply any exemption codes.
Note: If you specify the -ch, -cs, or -cu option with the -cm option, the -cm option is ignored.
-ch — Convert Acrobat highlights
Converts all Acrobat-highlighted text to Redax markup but does not apply an exemption code.
-chc <exemption> — Convert Acrobat highlights using exemption code
Converts all Acrobat-highlighted text to Redax markup and applies the specified exemption code.
-cs — Convert Acrobat crossouts
Converts all Acrobat-crossed-out text to Redax markup but does not apply an exemption code.
Note: Crossout in Acrobat 6 is the same as strikeout in Acrobat 5.
-csc <exemption> — Convert Acrobat crossouts using exemption code
Converts all Acrobat-crossed-out text to Redax markup and applies the specified exemption code.
-cu — convert Acrobat underlines
Converts all Acrobat-underlined text to Redax markup but does not apply an exemption code.
-cuc <exemption> — Convert Acrobat underlines using exemption code
Converts all Acrobat-underlined text to Redax markup and applies the specified exemption code.
-cr — Convert Adobe Reader XI Rectangle annotations
Converts all Reader XI Rectangle annotations to Redax markup but does not apply an exemption code.
-crc <exemption> — Convert Adobe Reader XI Rectangle annotations using exemption code
Converts all Reader XI Rectangle annotations to Redax markup and applies the specified exemption code.
-crem — Remove Acrobat annotations when using any convert option
Removes all Acrobat highlights, crossouts, and underlines—and any notes associated with them—following conversion to Redax boxes.
Note: You should always remove Acrobat annotations before releasing a document, because they might contain sensitive information. You can do this now with the -crem option or the -rmarkup option, or during redaction with the -remall option.