Deprecated Command Line Options

In this chapter…

…we describe some command-line options that have been deprecated.  The deprecated options are still functional to preserve backward compatibility of existing code, but they should not be used in new code. Most of these options were used to establish preferences in prior versions of Redax Enterprise Server. They were deprecated in favor of the RedaxESconfig, which is described in Preparing for Redaction.

Important! If you are new to Redax Enterprise Server, do not use command-line options to establish preferences. Use RedaxESconfig instead.

Deprecated options — summary

Type Option Parameter Description
Redax Boxes -author <string> Assign author name to Redax boxes
-blank   Replace marked text with blank space
-char <c> Use specified redaction character; default is ‘-“
-color <string> Assign border color to Redax boxes
-exemption <string> Redax box exemption code for “find” operation
Redactions -exemptioncode <value> Placement of exemption code after redaction
-fillrectangle <transparency> Fill rectangle with transparent color
-showrectangle   Display rectangle where content has been redacted
Options -b   Preserve bookmarks in redacted document
-noexempt   Allow redaction without exemption
-rembracket   Mark brackets for removal with -fbracket option
Other -debugpref   Write preferences values to log file
-markpage <pagenumber> Mark entire page for redaction

Deprecated options — detail

-author <string> — assign author name to Redax boxes

Specifies an author name to be associated with the Redax boxes. If the name contains one or more spaces, enclose it in quotes.

-blank — fill Redax boxes with blank space

Replaces text marked for redaction with blank space (white space) instead of a redaction character.

-char <c> — use specified redaction character; default is “-”

Specifies a redaction character to replace the text in Redax boxes. Choose a character that is already present in the document (in other words, part of the embedded font subset). If the character is not embedded, white space might be used in its place, and the line spacing in the redacted document could shift to the left.

-color <string> — assign border color to Redax boxes

Designates a border color for the Redax boxes (default=red). Options are:

red, orange, yellow, lemon, green, clover, olive, blue, violet, orchid

-exemption <code> — Redax box exemption code for “find” operations

A default exemption code assigned to Full-Page tags and to Redax boxes that are manually drawn or applied to any of the following: all bracketed text, all text areas, all image areas, and all path areas. Leave this field blank if you do not want to use a default exemption code.

-exemptioncode <value> — handling of exemption code after redaction

Determines the placement of exemption codes following redaction. Possible values are:

  • present (default) — exemption code is stamped over the redacted area, but is not clipped or wrapped. Long exemption codes may run outside the redacted area or obscure unredacted text
  • clip — exemption code is stamped over the redaction area, but is clipped so that the code does not run outside the redacted area and obscure unredacted text.
  • wrap — exemption code is stamped over the redaction area, but is wrapped so that the code does not run outside the redacted area and obscure unredacted text.
  • remove — no exemption codes are placed in the document.
  • atbottom — all exemption codes for the page are stamped on the bottom left of the page.

-fillrectangle <transparency> — fill rectangle with transparent color

Fills the redacted area with the color assigned to Redax boxes at the specified transparency level. The minimum transparency level is 50 (midway between completely opaque and completely transparent) and the maximum value is 100 (completely transparent).

-showrectangle — display rectangle where content has been redacted

Permanently stamps a black rectangle around the redacted area.

-b — preserve bookmarks in redacted document

Keeps the bookmarks that were in the document. If -b is not specified, the bookmarks are removed.

-noexempt — allow redaction without exemption

Allows the contents of Redax boxes to be redacted, even if they do not have exemption codes. If you do not include this option, the text in Redax boxes without exemption codes is not redacted.

-rembracket — mark brackets for removal with -fbracket option

Extends Redax boxes to cover brackets, as well as the enclosed text, during the -fbracket operation. If you do not specify -rembracket, the Redax boxes cover only the text enclosed within brackets, not the brackets themselves.

-debugpref — write preferences values to log file

Adds the values of preference settings to the log file. A log file is created with the -l option.

-markpage — mark entire page for redaction

Mark a full page for redaction.

For example:

redaxserver -o outfile.pdf -markpage “2” input.pdf

marks page 2 for redaction. By default, no exemption code is applied. Use -exemption to assign an exemption code, or use -noexempt when redacting to allow redaction without exemption codes.

Note: Although -markpage is deprecated, -markpages is not. Use -markpages to mark a single page or a list of pages for redaction. See Marking one or more pages.