Applies to EscapeE 'eE' iconEscapeE Professional and Batch Automation editions only

The syntax and description of each command is listed below. For convenience, the commands are grouped into tables:

Down arrow glyphMain options

Down arrow glyphPrinter configuration options

Down arrow glyphOther options

Down arrow glyphComposite document options


Down arrow glyphSpecial/obsolete options


There is also a list of the commands, in alphabetical order, which link directly to that command's entry in its table; see Command line syntax index.

Command line options may be of the form:


i.e. a symbol that opens with a / character, or:

/<option> <parameterstring>

where a parameter string follows the symbol and is separated from it by a space character. The parameter may be composed of several values, generally separated by a comma. There should be no spaces before or after a comma separator. If a value contains a space character, that value must be enclosed in quotes.

/<option> <value1>,<value2>,<'value three'>

Options may be concatenated on the command line. Use a space character to end one option before starting the next option with its opening / character, as in this example command line:

escapee C:\MyDocuments\Design.pdf /HP /LOG AV

Alternatively, the options may be contained in an "options" file specified using the /OPTIONS syntax: see Options file.

Click to expand/collapse hidden textMain (export) command line options


Export file to IBM-AFP datastream.


Generate FormDef and export file to IBM-AFP datastream.


Export data fields to comma separated values.
See also /CSVQUOTE and /CSVSEPARATOR below.


Where q specifies the character (other than the default double-quote) in which data-values are enclosed when outputting CSV records.

To specify the single-quote character, set q to "'".
To specify that the data-values are not to be enclosed within quotes, set q to N.

See also /CSV above and /CSVSEPARATOR below.


Where s specifies a character (other than the default comma) which separates data-values when outputting CSV records.
To specify the Tab character as the separator, set s to the value T.
See also /CSV and /CSVQUOTE above.


Export file to Forms Description Language.

/FONTFILE filename

When exporting to HP-PCL®, the /FONTFILE option requests a separate file containing the downloaded fonts. Each font is marked as "Permanent" and assigned a unique font "ID". Wildcards may be used in the filename e.g.


See also /HP below.


Export file to Hewlett-Packard® Printer Command Language format.
This option produces entirely new PCL output, incorporating any header pages, overlays or plugin amendments.
See also /FONTFILE above and /SUBSET below.


Export file to Xerox® IMG format.


Defines the specification for input files when used in timed mode, e.g.


See also /FILE, /OUTSPEC below.


Export file to JPEG format.

/MACRO nnn

Exports a range of pages as a macro with the Permanent Macro flag set in the PCL export options. The macro number defaults to 100 (maximum value 2147483647).
Tip:  you can use a batch file to create a PCL macro from a non-PCL file by specifying a subsequent /HP option.


Defines the default specification for output files when used in timed mode. It is ignored if a format (e.g. /TIFF) is specified on the command line.
See also /INSPEC above and /TO below.


Export file to Adobe® Portable Document Format.


Export file to Portable Networks Graphic image.

/PRINT [option [,option...]]

Printer options can be any of:

D formats the output and sends it directly to the printer, bypassing the driver.

The output format may be appended, see example below;

I images the page in memory before printing (useful for printer drivers which handle fonts with difficulty);

N used to inhibit immediate printing while setting the defaults for future printing.

S scales to fit on the paper when printing. EscapeE chooses an appropriate integer factor automatically.

? to prompt for printer selection.

In addition, you may specify:

the name of the driver/printer to be used; this may contain field names enclosed in curly brackets. The whole string should be enclosed in quotes.
option /TO: this sends the print file to a file (instead of the printer) but using the printer's driver.



ESCAPEE MyDocument.pcl /PRINT 'HP Color Laserjet CP2025,I' /to c:\temp\temp.prn

ESCAPEE TEST.PRN /PRINT 'HP LaserJet 4 {field1},S'

See also Run from the command line.


Processes the whole file without outputting the document.
Plugins are called for each page when required, as if in a normal print-run. No output is selected: Configuration is shown as <none>.

See 'No output' note.


Export Postscript® Format level 2.


Export Postscript® Format level 3.

See also PostScript: levels and types.





/RESIZE x,y"



This exports the image file in the specified format and scaled to fit the specified size.

To specify the size in pixels, width n and height m must be integers. E.g.:

ESCAPEE  C:\Images\background.bmp /RESIZE 1500,250 /TIFF

To specify the size in centimeters, width x and height y must be real (i.e. contain a decimal point). E.g.:

ESCAPEE  C:\Images\background.bmp /RESIZE 2.54,2 /TIFF

To specify the size in inches, add a double quote; x and y may be integer or real. E.g.:

ESCAPEE  C:\Images\background.bmp /RESIZE 0.67,2" /PNG

To specify that the whole image be scaled by a percentage, add % (p may be integer or real). E.g.:

ESCAPEE  C:\Images\background.bmp /RESIZE 33.3% /PNG


Exports a subset of the file as HP-PCL.

See also /HP above.


Export file to plain text format. These text options may be used in combination:

Y Extract text.
N Do not extract text.

If any options other than Y or N are specified then any default settings are ignored.

T Extracted text is to be in UTF8 Unicode.
U Extracted text is to be in 16-bit Unicode.
X Extracted text is to be in the user's original symbol set.

If none of the options T, U or X is specified, the text is extracted in default Windows® Codepage (19U).

_ (Underscore character) Retain underlining.
H Use the font's cell width for determining the spacing when extracting text.
I Reverse the order of the characters in inverse fonts.
L Left justify.
M Use character mapping derived from the TTLIB character database.
O Obsolete option for backwards-compatibility.
P Plain, with no Form Feeds between pages.
R Right justify.
S Nulls are treated as spaces.
V Use the top of the character cell as the reference point rather than the baseline when extracting text.
W Ignore downloaded character widths and recalculate based on raster dimensions.

For plain text Log files, use

C to show the number of sides output.
E to show the number of sheets output.

The information is put at the end of the output file. The side count, if requested, is given first: No pages produced (if nothing has been output), 1 page or n pages.
Next, if requested, comes the sheet count: 1 sheet or n sheets.
Note that the words will be translated into the selected language.
If no parameters follow /TEXT, the current text settings are retained.


Export file to Adobe® Tagged Image File Format. An optional parameter may be specified:

Y sets TIFF as the default output,

N shows that TIFF is not the default output and n is:
N1 to create a single page TIFF (the default) or
N2 to create a multi page TIFF.

E.g. /TIFF N2


Export file to HTML5 UberEd format for subsequent editing and document creation purposes.


Export data fields to Extensible Markup Language values.

For convenience, files exported using any of these main options are named, assigned the appropriate extension and placed in the originating folder automatically. Used in conjunction with the /TO option, however, you may set up other names and/or destination folders instead.
The main command line options may be followed by a parameter which may begin with V to request that the pages are shown on screen also. It may also specify a time, t, for continuous operation where a scan is made every t seconds, e.g.:


Click to expand/collapse hidden textPrinter configuration options

The following options can be used to initialize some of the parameters that could have been set manually using the printer's front panel:

/BIN n

Sets the default output bin.
If n is negative then it forces this bin regardless of what is specified in any data files, e.g. /BIN -2 forces the output to be sent to bin 2. For Postscript printing it may be necessary to define bins corresponding to the PCL numbers. The symbols PSBINS1, PSBINS2 etc. define the output bin names associated with PCL bins 1, 2 etc.


To print four 'pages' on each sheet: EscapeE switches the orientation (see /L) of the paper (size /PAPER). The pages are scaled, rotated and composed so that they are printed in the appropriate order to fold into a booklet.
Note: any plugins which print 'on the back' cannot be honored, and (because pages will be processed out of order) fields relying on sequentiality may fail.


n is the number of copies required.
If n is positive the copies are collated.
If n is negative they are uncollated.
Note that collated copies may result in up to an n-fold increase in file size though fonts and images will only occur once.

r_low,r_high, g_low,g_high, b_low,b_high

Sets the color range for HP-GL plotter pens defined by /PC, below. Expressed as three pairs of real numbers defining the lower and upper limits of the red, green and blue values. The default values are 0 and 255, i.e.

/CR 0,255,0,255,0,255

Only valid when the number of pen colors is also defined: see /NP below.

/CUSTOM [type,] width,height

Sets up a custom paper size; width and height are in inches.  For example, you may define paper for a letter (portrait) as:

/CUSTOM 11.3,17.1

When a paper type is included in the command, the specified PAPER size is redefined. So a "DL" (landscape) envelope may be changed to 8.4in wide, 3.5in high by:

/CUSTOM DL,8.4,3.5


Specifies whether to print on one side of the paper only (simplex) or both sides (duplex). A minus character may be used to override the print file setting, so e may take these values:

L Long-edge binding duplex.

N Simplex (default).

S Short-edge binding duplex.

U Undefined duplex.

-L force Long-edge binding duplex.

-N force Simplex.

-S force Short-edge binding duplex.

-U force Undefined: removes any duplex specifications from the file, allowing any output document to be printed either simplex or duplex as required.

See also Setting the printer defaults and /DUPSIM, below.


Simulates simplex output using duplex; e may take these values:

L Long-edge binding

S Short-edge binding

See also /DUPLEX, above.


Request edge-to-edge printing, so that coordinates are measured from the physical edge of the paper.


Where p specifies the parameter(s) for setting up EscapeE HP-GL plotter emulation mode:

Y Engage HP-GL mode

N Engage PCL mode

If neither N nor Y are specified, EscapeE defaults to engaging HP-GL mode (equivalent to HPGL Y)

Supplementary options:

R Specify when rotated embedded bitmapped graphics are required

X Switch from HP-GL to PCL on encountering any Escape sequence (except Escape%#B for entering HP-GL mode!)

For example, to stay in PCL initially add N:


/HPTRAYS a,b,c,...

Converts the tray numbers specified in the file to those needed by the Windows printer actually being used (see Media definitions). It consists of an ordered list of tray numbers, separated by commas: the 1st number corresponds to "tray 1" specified in the input file, the 2nd number to "tray2" etc..

If the HPTRAYS symbol is not specified then it defaults to



source 1 –> upper

source 2 –> manual

source 3 –> manual envelope feed

source 4 –> lower

source 5 –> large-capacity feeder

source 6 –> envelope feeder

source 7 –> auto

(see Tray and bin numbers); other numbers are passed straight though.

See also /PSTRAYS, /TRAY below.


Set landscape orientation.


The line-ending sequence:

0   CR -> CR,    LF -> LF,    FF -> FF (the default)

1   CR -> CRLF,  LF -> LF,    FF -> FF

2   CR -> CR,    LF -> CRLF,  FF -> CRFF

3   CR -> CRLF,  LF -> CRLF,  FF -> CRFF


Set initial VMI to allow n lines per page (default is 66).

/MEDIA<name> <tray number>

Associate special media with tray number. Note that there is no space between the MEDIA keyword and the name, e.g.



Causes HP-GL mode to default to a two-pen monochrome palette rather than an eight-pen color palette. See also /NP below.

/NP n

Sets up the number n of pen colors for an HP-GL plotter. See also /MONO, /PW and /CR.


Set x equal to:

P for Portrait,
L for Landscape,
I for Inverted portrait,
J for Journal (inverted landscape) and/or
A for Automatic font rotation to match orientation.

Add * to force the specified orientation: e.g. /ORIENT *L


Overrides the duplex/simplex setting on export, where p may take these values:

N simplex.
L Long-edge binding duplex.
S Short-edge binding duplex.
DL Long edge Duplex, with blank page on back to simulate 'simplex' sheets.
DS Short edge Duplex, with blank page on back to simulate 'simplex' sheets
U To remove any 'plex' specification in PDF output, see Simplex and duplex options.

Alternatively, omit p to let the plex parameter specified in the input file pass through to the export file.


Sets up a standard paper size, where p is one of:
A0, A1, A2, A3, A4, A5, A6,
or COMMERCIAL, C5, DL, MONARCH (envelopes).
See also /CUSTOM, /TRAY.

/PCn r,g,b

Where a number of pens have been defined for an HP-GL printer (see /NP), /PCn sets up relative color values for each pen. For example:

/PC1 255,0,255
/PC2 0,128,255

The color values actually used are bounded by the range of values set up using /CR.


Defines the input tray name associated with PCL tray n.
See also /HPTRAYS above, /TRAY below and Tray and bin numbers.

/PW[n] pen_width

Where a number of pens have been defined for an HP-GL printer (see /NP), /PWn sets the width of pen n to the specified value in standard HP-GL units of 1/40 mm (~1/1000 inch). E.g.

/PW1 40.0

/PW2 25.0

If n is omitted, all the pens are set to the specified pen_width.  See also /PCn.


Define default font f where f is an HP-PCL font selection sequence, for example:
/SELECT "^(19U^(s0p12h10vsB"
Note that the ^ character is used in place of the 'Escape' character in a selection sequence, except when used on an MS-DOS® command line with Windows® XP and later systems (a single ^ character has special significance for these systems, so ^^ must be used instead).

Default font is Courier 10 pitch in PC character set (10U).

There is a RedTitan extension of the selection syntax to allow explicit specification of the font name in single quotes instead of a typeface e.g.

/SELECT "^(19U^(s0p11.8h11.73vsb'Lucida Console'"

See also /PNUMFONT, below.


PCL shading patterns, where s is:

0 standard
1 fine
2 gray-scale solid color.


Define spot color as RGB.
n is a three-byte color number: Red (low byte), Green, Blue (high byte) converted to decimal e.g. cyan= 65535.


Sets the default PCL input paper tray.
If n is negative then it forces this tray regardless of what is specified in any data files, e.g. /TRAY -2 forces the input media to be taken from PCL tray 2.

For PostScript printing it may be necessary to define trays corresponding to the PCL numbers.

See also /HPTRAYS, /PSTRAYS above and Tray and bin numbers.

Click to expand/collapse hidden textComposite document options


Used in conjunction with the the RedTitan® CaptuRedTitan generic Windows® print capture utility, this option is used to pre-define some special fields for creating output filenames using the /TO option.
The document title defines the job title (equivalent to specifying /LPRJOB 'job' on the command line) and the special field {_Title}.
The user name defines the user parameter (equivalent to specifying /LPRU 'user' on the command line).
The ID sets the special field {_Id}.
The default output file name is set to {_Title}{_Id}
For example, a Job titled My document with ID 1234 creates a PDF named My document1234.pdf by default. This may be overridden using the /TO option.
See also Filenames and widcards.

/FROM filename

Read the named LOF control file.
The default is to export each file in the list of files separately unless the /JOIN command is used.
Further options may be appended; in the example below, only the first page of each file in the list of files is exported.escapee /from mylist.lof /TIFF /pages 1-1

/FROM filename

Read the named CSV control file.
The component files will be treated as if they were a single file with reset commands at file boundaries. A "start" and "end" page may be specified as well as a "file name".
If a startpagefield is given but no endpagefield, then, if the file name is the same as the previous one, the end page of the previous file is set to one less than the start of the next. In the absence of a filenamefield specification the filename field is used if it exists, otherwise the first field in the CSV file is assumed to contain the filename.
See also /PAGES below and _numpages symbol.

/JOIN [filename]

Use to treat a list of files as a single (composite) document. This is the default for control files which are in CSV format. /JOIN may be followed by the control filename e.g


See also /FROM, above.


Use to define an order for processing a list of files (instead of the default order in which they are presented in the control file). Up to three sort levels may be defined.

A single level sort is simply the value of 's' shown below. To precede this by a second level of sorting, multiply the secondary level 's' value by 16 then add the 's' value for the primary sort. Similarly, a third level requires 256*s to be added to the value.

s      sort in order of

1 file path and name, case sensitive

2 file name, case sensitive

3 file extension

4 file size

5 update  date

6 creation date

7 access  date

8 short 8.3 name

9 uppercase path

10 uppercase name

For example, /SORT 2 orders by filename only, whereas /SORT 163 sorts by uppercase name (16*10) then by extension(3).

Click to expand/collapse hidden textOther options

/ABORT a,b,c...



Use to terminate the processing of the current file if the errors specified occur and take alternative action defined by option /ABORTACTION instead.

The errors ("a", "b", "c" etc.) are specified as a comma-separated list of return codes. For example:


aborts on encountering error code -140 and all the codes in the range (denoted by ..) -134 up to -126 inclusive.

In the special case of /ABORT ALL, all errors not ignored by the /ERROROK specification will cause an abort.

See also /ABORTLOG below


This defines the action on aborting a file (see /ABORT above). p may be either one or both of the parameters:

A to Abort timed processing and exit.
The default is to ignore the file and continue processing the file.

E to Erase the faulty input file.
The default is to rename it when there has been an error.

See also /ABORTLOG below.


Specifies the path of a folder into which aborted output files and error logs are placed: see /ABORT. The input file’s disposition depends on the value of the /ERASE option.


Show blank pages, Y(es) or N(o). The default is to suppress blank pages.

/BORDER wl,wt,wr,wb
/BORDER wlr,wtb

Adds borders of specified widths to all four edges when exporting an image or PDF.

If four values are specified, the first is used to set the left border, the second the top border, the third to set the right border and the fourth the bottom border.
If only two values are specified, the first is used to set the left and right borders and the second to set the top and bottom borders.
If only one value is specified, all four borders are set to that width.

A double quote character in the parameters (integer or real) denotes inches. If " is not specified, dimensions are assumed to be in pixels (independent of resolution) when all the parameters are integers, or else centimeters when there are decimal point(s). For example:

BORDER 1,0.5

gives 1cm wide side borders and top and bottom borders of 0.5cm, whereas:

BORDER 1,0.5"

gives 1inch wide side borders and top and bottom borders of 0.5inches.


Calculate the font header parameters from the font size rather than using the ones supplied. This is sometimes useful (e.g. for FDL forms generation) because some Windows® drivers supply faulty header parameters for download fonts.


Set the Unprintable area with parameters as follows:

Y Crop.
N Outline the valid region.
B Outline if not blank.


Creates up to 26 dedicated fields per page, solely to hold the PJL JOB command line and PJL comment lines. EscapeE assigns each a letter: 'a to z' or 'A to Z'. These are output when exporting to PCL, PDF, PDF/A and PostScript.

N No comments – the default

P Plain text format, e.g.
% COMMENT "HEADER PCL" % COMMENT "Driver version : 02.03"

X XML format, e.g.
% <RT A='JOB NAME=&34;Magic&34;' B='COMMENT &34;This is a comment&34;'/>
(the UNICODE hex code 34 outputs the double quote character).

See also /PJLPREFIX and /REM, below.


Defines a field with the given fieldname and assigns it the specified value.


Display the page whilst outputting TIFFs, PDFs, Postscript etc.


Specifies drawing mode, where x is:

2 rotates images and PDFs through 180°.
R use rectangles to create horizontal or vertical lines instead of drawing with the current pen in HP-GL.
S draw HP-GL lines using strokes with the appropriate ends (round or square).
RS both R and S options.
N neither R nor S options.
M filled areas are merged with the existing page contents.
Q requests EscapeE to perform non-orthogonal image rotation directly rather than using the Windows® coordinate transformation. This technique may be slower, but it handles heavily scaled images better.
X in PCL, this allows cursor commands to set the actual print position to any value, even if it is outside the printable area. Unlike HP-GL printers, PCL printers locate out-of-bounds positions to the boundary of the printable area. This may cause a problem if any marks have been placed in the unprintable area of the page (e.g. comments, layout marks) so that they would not appear on the printed page: kerned characters or rounded positions may protrude into the printable area and show up as visible marks on the page.
/DRAW X may be used to overcome this problem.

The default is to use strokes for all lines and no merge.

This option supersedes the /USELINES option.


Specify /DRIVERDEFAULTS to ignore the settings given in the original input file and use the printer driver's defaults used instead.

You may choose these defaults (paper type, duplexing and bin selection) from the standard 'Print setup' dialog: see Printer Setup....

/DROP y|n

Action on drag-and-drop. Y causes file to be exported, N merely views it.

/ENCRYPT recipient_profile

Sets up the default Security profile for encrypting PDF files. A PDF file which has been encrypted on export may only be viewed by the people cited in that profile. E.g.

/ENCRYPT my_music_group

See also /SIGN below.


When in timed mode (see Setting automatic export options) this specifies how the input files are treated after processing.

/ERASE (i.e. without parameters) simply erases the input files after processing.

/ERASE OK erases the input files only if they have been successfully processed.

/ERASE N renames the processed input files (usually as *.bak: see /RENAME). This is the default action if the erase option has not been specified.

/ERRORLOG <file>

Use to create an error-log file for recording errors (a /REPORT is also generated to place an error summary in the Console notebook), see also Run from a program. For example,
/ERRORLOG c:\temp\error.log
creates an error-log file named error.log in the temp folder. If the error-log file reaches the size of 10 Megabytes it is renamed with a ~ inserted in its extension (~log for the example above, erasing any such previous file) and a new error.log file is started.
To suppress error log creation, just use
without specifying a file.
See also /ERROROK below and Error return codes.

/ERROROK a[,b][,c..d] etc



Use to ignore specified errors, where a, b, c etc. are Error return codes which are to be treated as acceptable and ignored when setting the error return code from EscapeE. For example, to prevent the red warning triangle being shown when an unknown font is encountered, use:
Use .. to denote a range of codes, e.g.
/ERROROK –134..-126,-140
ignores code -140 and all the codes in the range -134 up to -126 inclusive.
In the special case of /ERROROK ALL, all non-vital errors are ignored.
See also /ABORT, /ERRORLOG above and Run from a program.

/FDLRES <res>

Sets the dot resolution for FDL form generation, where <res> may take the values 300 or 600 dpi.

See also /FDLUNITS.

/FDLRIF [option [,option]]

Sets up conversion and format options for exporting a document to FDL.

Conversion options are:

A or Y to convert the whole page to a graphic (default)

G to convert all non-text items to a graphic

Format options are:

P to output images as PNGs

T to output images as TIFFs

When no options are specified, /FDLRIF defaults to converting the whole page into a single image, format RIF.

See FDL export options.


Sets the units used for FDL forms, where n may be:

300 dpi (normally the default) or

600 dpi: this also sets the resolution default to 600, see /FDLRES.


Defines the color of field data area – such that c is the color number:

c = 65536 * blue + 256 * green + red

where R, G, B values run from 0 to 255.
Defaults to green.



file is the name and path of the default field definitions file to be used when no /FIELDS option is given.
May contain wildcards.

/FIELDS file

Use file file as the field definitions file.
Defaults to x.EE where x is the data file name stem, or DEFAULT.EE if x.EE is not found.

See Field definitions files and /FIELDDEF above.


This 'First In First Out' option processes files in the order of their creation date (i.e. oldest first), not ordered by their update date (the default).

See Setting automatic export options.

/FIND 'string'
/FIND "string"

Highlights the first occurrence of the string in the document's text. To include a single quotation mark in the string itself, enclose the string in double quotes. To include a double quotation mark in the string itself, enclose the string in single quotes, e.g.
/FIND '39.37"'
/FIND "The Winter's Tale"


When creating FDL forms generate flowed text rather than using absolute placement. This may result in less than perfect alignment but does allow the text to be changed and reformatted more readily.

/HEADER filename


/HEADER filename+

Allows a file to be processed before the main file. This may contain printable pages but is more often used for defining some fonts or macros to be used by the main file. It overrides the Header file specification in the ".EE" field definitions file as set up in the File page of the Field dialog. If the filename is followed by a "plus" sign then the PCL state is preserved after reading the file. Any fonts defined in a such file are retained when reading subsequent files.

See also To set up a header file.


The History list at the foot of the 'File' menu is set to 8 by default. To extend the list specify the total number of files n to be shown, e.g.

In the special case where n is set to 0, the history list is empty: the file names are never written to the INI file.


Define the host name or IP address for LPR output, e.g.:

/HOST \\mainserver\ourprinter




Where x equal to:

F ignores downloaded fonts,
I ignores images,
K ignores downloaded fonts if they have a substitute defined,
P ignores paper specifications,
S ignores shading,
U ignores fonts downloaded already,
W ignores white areas,
Y ignores Kyocera command !R!.

See Setting General export options.

For example /IGNORE IS sets printer to ignore images and shading.
See also Optimizing the configuration and Configuring the printer defaults.


Where x is set to:

B to omit blank pages.
W to create transparent white backgrounds (only relevant to PNG, TIFF).
M to force monochrome pages using default halftone shading.
MD for monochrome output using dithering.
MT[n] for monochrome output  using threshold shading where n is a value in the range 1 to 254 (if n is omitted, value defaults to 127). For example:
/IMAGE=MT80 forces monochrome output with a threshold value 80.
/IMAGE=MB outputs halftoned monochrome images with any blank pages omitted.

See Image import/export options.


Sets the size, in Mbytes, of the cache which EscapeE may use to retain images in memory so as to be able to have multiple references to a single image when exporting to formats such as PDF.
Default image cache size is 200 Mbytes, maximum 1000.


The default Image resolution, where if n is:

positive it applies to any images whose resolution is zero or unspecified;

negative the resolution –n applies to all images, over-riding any specified resolution.

/INI filename

Uses the specified .ini configuration file.

This is the equivalent to specifying ^^ininame as the first command line parameter but can be configured permanently in the RT.INI file if required.

If the filename is * then it tries for a file with the same name as the data file but with extension .ini.

See also Setting General export options.


Use to log any errors, their date and time, encountered on the EscapeE RT.INI file in a file named escapee.log in the Windows® temporary folder (normally C:\Users\<username>\AppData\Local\Temp).


Define name or number of TCP/IP input port.


The input format, where x may be:


BMP – Bitmap

CAPSL – Canon

DDF – RedTitan DDF language

DICOM – DICOM medical image

ESCP – Epson printer language (supersedes EPSON)

FORM – Field generation for a form*

GIF – Graphic Interchange Format

IDF – Intelligent Document Format

JPEG – JPEG photo format

PCC – Lineprinter Control Codes*

PCL – HP Printer Control Language

PCX – PC Paint format or DCX (supersedes DCX)

PDF – Portable Document Format

PNG – Portable Network Graphic

PS – PostScript

PTRX – Printrex

RS2 – RedTitan Scripting language

RTF – Rich Text Format

STAR – Star POS printer format

TIFF – Tag Image Format

XIMG – Xerox IMG (supersedes IMG)

XL – HP PCL 6 (supersedes PCL6)

ZJS – Zenographics format

This is useful when the extension or initial bytes of a file are non-standard so that the file's format may not be detected. For example, use


*Some import DLLs may take further option(s) given as a string following the import format and separated by a comma.

FORM module options:

ALL – Fields apply to all pages.

CHECKBOX n – Maximum size of a checkbox in 1/600".

KEEP – Save fields on exiting EscapeE.

MINFIELD n – Minimum size of a box to be considered a field.

PAD n – Padding inside the box containing a field.

PCC module option:

ROW – Fields' locations given by the 3-digit line-number in columns 1,2,3; the number of lines to skip before printing given in column 4.

For example:


See Configuring the Input format.

/JPEGOPTS option,[option,...]

This sets up the rules for deciding when to use JPEG compression for an IDF, PDF, PDF/A, PS or JPEG document's image(s) and the compression parameters to be applied.

The option parameter(s) can be any combination of:

LQ low quality colour

LR low resolution colour

JP to retain JPEG compression if, and only if, the image was originally sourced from a JPEG file.

The decision parameter determines whether to use JPEG for images or not, expressed as a percentage:

000 never

100 always

050 'if appropriate' (default) see JPEG compression options

The quantisation parameter determines the fineness of the detail of the image. It is specified as a percentage, where 100 is the highest quality. Values typically range from 40 for a coarse image to 70 for a good quality image, see Compression parameters.


/LIB 1

Define the font library search path.


In TXT, IDF, RTF and UberEd output formats, this defines the minimum vertical distance between the baselines of two words for them to be deemed on different lines. The value of n is measured in the units currently configured: dots, dot600, de, cm or in.

See also /TEXTHEIGHT below.

/LOG f

Specifies which fields are to be logged when outputting documents, see Setting Log file options.

The parameter consists of appropriate combinations of the option 'flags' listed below. (Options may be dependent on the export format and fields that are to be stored; some are retained for backwards compatibility.)

A all defined fields (see also S).
B the log file is to contain Bates page numbers (see also # and $).
C the log file is to be in CSV format.

E write a log record at end of file (see also +1).
F the log file is to contain the filenames.

H header-line containing field-names to be omitted from CSV log files.
L a new log file is to be generated for each output file.
N no log file to be generated.
P suppress page numbers in log file: the default for CSV, TXT (see also #).
R the log file is renamed on completion.
S the selected fields (see also A).
T all text: only applies to log files in TXT format).

V make one log file entry for every page of output: the default for CSV and XML log files (see also -).
X the log file is to be in XML format.

# include page numbers in log file: the default for XML format (see also B, P and $).

$ include sheet numbers in log file: (see also B and #).
? write a log file record only when a field specifies it.
- suppress 'one log entry per page output': the default for TXT (see also V).
~ ignore /LOGTEXT definition when text logging.
1 makes one log file entry for each output file (see also V).
+1 write a log record as if having read the next page after the end of file (see also E).

For example, use /LOG AX to output all fields to XML.

See also /SAVE

/LOGFILE <spec>

Specifies the name of the log file. If the <spec> begins with a plus sign the new data are appended to any existing file. The <spec> can be a full path and name or a wildcard e.g.

/LOGTEXT 'string'

Inserts a message in a TXT log file. The string must be enclosed in a pair of single or double quotes, and may contain Special fields in composed strings within it. See also /LOG, /SAVE and Examples: Command lines.


Used to specify that the size of the file is unknown.

n specifies value (likely user)

0 0 default (Xerox®, nQ)

-1 9999999 (HP®)

-2 hex7fffffff maximum positive integer.

/LPR [hostname]

Where hostname is a string specifing the name or "ip address" of the host providing LPD service. This is usually a network printer or a spooling system e.g.:

escapee test.txt /hp /lpr /x

The string may include field names in braces, e.g.

/LPR {hostname}

/LPRC 'class'

Specifies the LPR job class identifier. The string may include the name of a field from which the class may be derived. Field names must be enclosed in braces. E.g.:


If the field named classfield contains the value 12 when the first page is output then the LPR class would be C12.

/LPRJOB 'job'

Specifies the name of an LPR output job. The string may include field names in braces, e.g.:

/LPRJOB AB{field1}CD{field2}EF

if field1 contains xxxx and field2 contains yyyy, the job name would be ABxxxxCDyyyyEF.

/LPRL 'L field'

A string to set LPRL field in the control file. The string may include field names in braces.

/LPRQ 'queue'

A string defining the name of LPR output queue, e.g.

escapee /LPRQ HeaderPaper.

The string may include field names in braces, e.g.

escapee /LPRQ {queuefield}.

/LPRU 'user'

A string to set LPRL field in the control file. The string may include field names in braces.

See also /LPRL above.


Inhibits display of the EscapeE Tool-bar and menus.


Create a new directory (folder) if necessary when exporting.


Use p as the next page number. A positive number assigns that number to the first page of the file and starts numbering the next document where it left off. A negative value ensures that the page number is not saved for the next document and that the number is adjusted by any offset in the /PAGE option.


Ensures that EscapeE does not cache any images, which may reduce memory requirements in some cases, though possibly at the expense of speed.


Used only for calling EscapeE from the RedTitan spooler nQ. Use /LPRQ to specify destination spooler folder. To force an exit from EscapeE on completion, use the /X option.


If an error is found with a file from an nQ spooler, then /NQERROR moves it to folder 'xxx'. If 'xxx' is null then the output file is left in the input folder, so effectively ignoring the error. See also /NQLOG below.

/NQLOG xxx

Specifies the path of a folder to contain any faulty input file and the error log file. Error log files are created with the extension '.log'; for example, if DFAyyy is the input file name the error log file will be called DFAyyy.log.

/OPTIONS filename

Specifies an options file containing a list of one or more command line options, one command line option per line.

See Options file and Examples: Command lines.


Defines the image data mode, where p is:

0 byte aligned (default: no bits set)

1 unpacked (raw)

3 CCITT group 3 fax compression

4 CCITT group 4 fax compression

5 LZW compression

TIFF options may be set up by adding flag bits to p:

16 bit reversal

64 End Of Line markers

128 single strip

256 carry odd bits over to next row

Use p = -1 to set Packbits compression.

/PAGE n-m*s


/PAGES n-m*s


/PAGES firstpage,lastpage

Process pages n to m inclusive, broken into sets s pages long.
Omit *s to process as one file (cannot apply to Subset output).
If -m is omitted then process just page 'n'.
To process pages from 'n' to the end of the file, use /PAGE n-

Used in conjunction with /FROM, fields containing the numbers of a "starting" and an "ending" page may be specified to process logical sets of pages. E.g.:


See also /NEXTPAGE.


Define PCL options, where n is the decimal number made by adding the required flag bits or a string of mnemonic codes.


Use to output a Preamble in PJL on exporting a document to PCL, see Preamble and PJL options


Define the initial dot resolution (default is 300).

/PDF-A 'name'

Defines the author of a PDF document. The 'name' parameter is terminated by a space, so if a name includes spaces it must be enclosed in quotes.

/PDF-K 'keyword1 keyword2 ...'

Defines the list of keywords associated with a PDF document. The 'keyword' parameter is terminated by a space, so if there is more than a single word the string must be enclosed in quotes.

/PDF-S 'string'

Defines the subject of a PDF document. Since parameters are terminated when a space is encountered, if the description string includes spaces it must be enclosed in quotes.

/PDF-T 'string'

The string defines the title of a PDF document. Since parameters are terminated when a space is encountered, if the title string includes spaces it must be enclosed in quotes.

Superseded by /TITLE, /PDF-T is retained for backward compatibility. If /TITLE and /PDF-T are both defined for a document, /TITLE takes precedence.


Define PDF options, where n is the decimal number made by adding the required flag bits or a string of mnemonic codes


Define password required to have full access to a PDF. PDFs encrypted this way cannot be decoded if the password is lost.


Define password required to have full access to a PDF. RedTitan can recover this type of password if lost.


Defines which features of a PDF reader are to be displayed on the screen. Add the flag values:

1  Hide the tool-bars

2  Hide the menu-bar

4  Hide the window interface, i.e. scroll bars and other navigation tools

8  Resize the window to fit the first page

16  Position window to center of screen

32  Put document title in title-bar instead of filename

64  Use the full-screen display mode

128  Opening display to fit horizontal width

256  Opening display to fit vertical height (use 384 for fit-page)

For example:

ESCAPEE C:\Sales\Accessories1.pdf  /PDFPREF 128

See also PDF Viewer Preferences


Defines a password for PDF input (independent of the password for output).


Define password to have specified access to a PDF; see /PDFOPTS.


Sets up a prefix string such that any PJL comment, PJL JOB and PJL JOBATTR items create fields with a name beginning with the prefix.

See also /COMMENTS above and /PJLSEPARATOR below.


Defines the separator to be used when parsing PJL commands so that prefixed fields may be created: see /PJLPREFIX above. (If no separator is given then separators "colon", "equal" and "space" are sought in that order.)

/PNUM xxx

Define the page number template.

See also /PNUMFONT below.




Defines the font to use for printing the page number.

f is the full HP-PCL font selection sequence, with ^ used to denote the 'Escape' character, e.g.

/PNUMFONT ^(19U^(s0p10h12vsb3T

Note on Windows® XP and later systems, ^^ must be used to denote the 'Escape' character. (A single ^ character has special significance when used on an MS-DOS® command line for these systems.)

* is a special case: it suppresses page-numbering by nullifying the font.

See also /PNUM and /SELECT above.


Define PostScript options, where n is the decimal number made by adding the required flag bits or a string of mnemonic codes.


Used for setting up the preamble when exporting a document in PostScript format, see PS export options. For example, if re-exporting a file originally from a Xerox printer to PostScript format, the XRX commands can be propagated to the output using



This option associates the EscapeE program with its standard file extensions in the Registry. Consequently, if you double-click a file listed in your File manager with with any of these extensions:


EscapeE will be called, the file will be opened and on display.


Automatically reloads a file if it changes (normally the user is asked whether it should reload the file of not).

/REM 'remark'

Enables a comment to be included which is not interpreted by EscapeE.

See also /COMMENTS, above.

/RENAME filename

Specify the new filename to be given to input files after they have been processed e.g.
The default is to rename processed input files *.BAK.
See also /ERASE above.


Puts an error summary into the Error Log when errors occur in batch or automatic mode. This gives more details of errors such as missing fonts, plus the EscapeE version number and calling command line.

/RES x,y

Sets the resolution for image generation (default is 300dpi).
Different resolutions may defined for 'x' and 'y' directions by specifying two numbers in the range 25 to 600dpi. For example
/RES 204,198

/ROT r

Specify that pages are to be rotated as follows:

0   not rotated (default).
1   90 degrees counter-clockwise.
2   180 degrees (upside down).
3   270 degrees counter-clockwise (90 degrees clockwise).

/RUN p

When EscapeE exports a file, it can run the output to another program.

/RUN Y runs the associated program on outputting the file, even in timed mode.

/RUN N does not run the output file to an associated program.

If p is set up to be a program name, that program will be called on completion of the output file and the output file name passed as a parameter. For example:
runs program myprog (which would be found in the EscapeE software folder since no path is specified).
See also /RUNWAIT below.


Waits until the output file is complete before running the associated program.

See also /RUN above.


This parameter defines which fields are to be output during export to CSV, XML or TXT. Most are identical to the /LOG options:

A All defined fields
B the log file is to contain Bates page numbers (see also #)
C the log file is to be in CSV format
E write a log record at End of file
F the log file is to contain the Filenames
H Header-line containing field-names to be omitted from CSV log files
L a new Log file is to be generated for each output file
N No log file to be generated
P suppress Page numbers in log file: the default for CSV, TXT (see also #)
S the Selected fields
T all Text: only applies to log files in TXT format
V make an entry in the log file for every page of output: the default for CSV and XML log files (see also -)
X the log file is to be in XML format
# include page numbers in log file: the default for XML format (see also P)
? write a log file record only if a field specifies it
- suppress 'one log entry per page output ': the default for TXT (see also V)
~ do not use /LOGTEXT definition when doing text logging
1 makes one log file entry for each output file (see also V).

Note that:

R Renames the main output file (not the log file) on completion.

In addition, /SAVE can also take these options:

D Discard list of files previously created; a new output file will overwrite one of the same name created in this run
I for TIFF output: an individual file is created for each page
O a suffix of #1, #2 etc. is added to the filename to make it unique if it would Overwrite an existing file.


Set viewing scale for when a file is first opened. The scale may be defined as a percentage from 20% to 600% or a scale factor where:

-2 View full width of page

-1 View all printed data

0 View full page

1 600%

2 300%

3 200% etc.

/SCALEMENU s1 s2...

Set up Zoom menu scale list. A scale of 1 corresponds to 600 dpi, 2 to 300 dpi etc.


Set up gray-scaling of scaled images to improve appearance when they are scaled down in size, where n = c x 4 + m.
'c' is the mode for color output and 'm' for monochrome. The values of c and m are:

0 simple scaling
1 two-bit scaling
2 four-bit gray shading

For example /SCALING 9 would request four-bit shading for colored output and two-bit for monochrome.


Defines the color of highlighted text such that c is the color number:

c = 65536 * blue + 256 * green + red

where R, G, B values run from 0 to 255.
Defaults to cyan.


/SHIFT r,d

Moves the whole page, where "r" is the distance right and "d" is the distance down. Use negative values to move the page left/up. Units: 1/600 of an inch. Alternatively, use a double-quote character after the number to denote "inches".

For example, /SHIFT 1",-2.5" moves the page 1 inch right and 2.5 inches up.

See Configuring the view.

/SIGN certificate_profile

Sets up the default Security profile for digitally signing PDF files. This enables the recipients of the signed PDF file to verify the authenticity of the document. Example:

/SIGN prof_academy

See also /ENCRYPT above.


Source of data:

R RedTitan software e.g. DDF 'printer' iconDynamic Document Formatter,
W Windows HP driver,
O Other.


In TXT, IDF, RTF and UberEd output formats, this sets the minimum width of space required to separate two words.
n is normally given in 1/600th inch dots; when followed by the % character this indicates that it is a percentage of the width of the space character; if negative it specifies a percentage of the font height.
The default minimum width is 33% of the space width.


Default stem of filename. This is substituted for = in any output file spec if not overridden by a field or special PJL COMMENT.


Gives the name of a file containing font substitutions to be used in the current run, and may contain wildcards.

See also /SUBSTDEF, below.


Gives the default file to be used when no /SUBST option is given.
May contain wildcards.


Set default symbolset.
Commonly used values for s are 2, 3, -29.
To set up automatic symbolset recognition, set s to *


Defines the color of search tag area, such that c is the color number:
c = 65536 * blue + 256 * green + red
where R, G, B values run from 0 to 255.
Defaults to yellow.



Defines the color of tag+field area such that c is the color number:

c = 65536 * blue + 256 * green + red

where R, G, B values run from 0 to 255.

Defaults to yellowish-green.


/TEMP ext

Define the extension to be used for temporary files.


Specifies the inter-line spacing for text extraction, determining whether blank lines are inserted between lines. The line spacing v is expressed in the currently configured units.

See also /LINEHEIGHT above.


Define orientation for TIFFs, where 'r' is:

0   no rotation
1   90 degrees counter-clockwise
2   180 degrees counter-clockwise
3   270 degrees counter-clockwise
p   rotate landscape pages clockwise to become portrait
l   rotate portrait pages clockwise to become landscape.


Define the time, t, for continuous operation where a scan is made every t seconds. See Exporting files automatically.

/TITLE 'string'

Defines the title of a TIFF or PDF document. If the string includes spaces it must be enclosed in quotes.

/TO f

Defines the default specification for output files. For example:

c:\MyFolder\*.pcl /TIFF /TO c:\Images\*.tif

exports PCL files found in MyFolder to the Images folder in TIFF format. If /FROM is also specified then the resulting output files are joined together.

Note that the /OUTSPEC symbol (if defined) in the INI file is unchanged.

See also Filenames and wildcards and /OUTSPEC above.





/TRIM m,w,h

Remove white space from around any generated images (i.e. printed region only).
The value m sets up the trimming mode:

0 No trimming
1 Printed region only
2 Selected region only
3 Printable region only

Specifying w and h too produces an image w units wide, h units high.
The default unit is pixels. Using a " specifies inches; a decimal point specifies centimeters (see /BORDER).


On export to PDF, only that subset of characters actually used in the document are included in any embedded TrueType font. See PDF export options.


Uninstalls EscapeE.


Specifies the dimensions for the mouse coordinates, where x is:

IN for inches
CM for centimeters
DE for decipoints (1/720")
DOTS for 1/300"
DOT600 for 1/600"

If x is preceded by an asterisk then mouse coordinates are not shown on the page view.

/USING file

Allows the name of a script file to be given separately from the data file e.g.



Option(s) to show fields on a page (see Defining fields and tags), where:

A shows All fields,

F shows fields only if Found;

Y is for "Yes, show field names".

For example,

/viewfields AY

shows all the fields and their names.


Turn hints on and off. If v is N then no hints are shown.


Sets the page extent with parameters as follows:

P Printable area.
A Unlimited (All). This is the default for plotter mode.
S Paper size. This is the default for PCL mode.

/WINDOW s,l,t,w,h

Specifies state of window on startup:

s  0=Normal, 1=Minimized, 2=Maximized
l Left offset in pixels
t Top offset in pixels
w Window width in pixels
h Window height in pixels.


Exit after processing the specified file(s).
See Run from a program.


Defines the XML encoding scheme, x, where:

1 = "UTF8"  the most compact Unicode encoding (XML default)
2 = "ASCII" ASCII (strictly 7 bit)
3 = "ANSI"  ISO-8859-1 extended ASCII similar to the Windows® 8-bit codes
4 = "UCS2"  2-byte Unicode as used by Windows NT®
5 = "UCS4"  4-byte Unicode (very bulky).

Click to expand/collapse hidden textSpecial options

These options are obsolete or used for special purposes.


Use Windows® scaling for images rather than 2-bit scaling.


Export to MS Windows BMP format.


Export file to DCX fax file format.

/FILE filename

Specifies the name of a file which EscapeE will process by default, e.g.

/FILE BILLS_0000_1234567890.PRC

It is a rarely used, since specifying ESCAPEE /FILE xxx is equivalent to using the simpler command ESCAPEE xxx.

See also /INSPEC, /OPTIONS, /OUTSPEC above


Do not use the Windows option to camp on a directory (folder) waiting for changes.


Ignore download fonts; use /IGNORE F instead.


Ignore downloaded images; use /IGNORE I instead.


This command for exporting files to Hewlett-Packard Printer Command Language format is now obsolete. Use /HP instead to create the PCL output afresh.


Scan the RedTitan fonts rather than using font information files.


Call up the shortcut creation dialog at once.


Space-fill fields.


Defined the orientation for TIFFs. Default was P for portrait (i.e. no rotation), L (landscape), I (inverse P) or J (inverse L). Use /TIFFORIENT r instead.


A synonym for /RES.


Superseded by /DRAW.