Command line syntax

Top  Previous  Next

(Applies to EscapeE Professional and EscapeE Batch Automation editions only)

The main (export) command line options are:


Export file to IBM-AFP datastream.


Generate FormDef and export file to IBM-AFP datastream.


Export data fields to comma separated values.


Export file to Forms Description Language.


Export file to Hewlett-Packard Printer Control Language format.
This option produces entirely new PCL output, incorporating any header pages, overlays or plugin amendments.


Export file to Xerox IMG format.


Define the input specification for files.

/MACRO nnn

Exports a range of pages as a macro. The macro number defaults to 100.


Define the default output specification for files (equivalent to /TO).


Export to Adobe Portable Document Format.


Export file to Portable Networks Graphic image.

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

The 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.

or the name of a Windows printer driver to be used. In this case the whole option string should be enclosed in quotes, see example below.





Export Postscript Format level 2.


Export Postscript Format level 3.


Exports a subset of the file as PCL.


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

Extract text.
Do not extract text.
If any options other than Y or N are specified then any default settings are ignored.

Extracted text is to be in UTF8 Unicode.
Extracted text is to be in 16-bit Unicode.
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).

Use the font's cell width for determining the spacing when extracting text.
Reverse the order of the characters in inverse fonts.
Left justify.
Use character mapping derived from the TTLIB character database.
Obsolete option for backwards-compatibility.
Plain, with no Form Feeds between pages.
Right justify.
Nulls are treated as spaces.
Ignore downloaded character widths and recalculate based on raster dimensions.

For plain text Log files, use
to show the number of sides output.
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.
If no parameters follow /TEXT, the current text settings are retained.


Export file to Adobe Tagged Image File Format. Values of n can be:

to create a single page TIFF (the default) or

to create a multi page TIFF.


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 command /PCL (for exporting files to Hewlett-Packard Printer Control Language format) is now obsolete. Use /SUBSET instead or /HP to create the PCL output afresh.

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.:


Printer 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.


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.

/CUSTOM width,height

Sets up a custom paper size. Width and height are in inches e.g.

/CUSTOM 11.3,17.1


Requests duplex output, where e = L for long-edge binding, S for short-edge binding. The default is to print both sides of the current page.


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

/HPGL y|n|r

To configure EscapeE to start in HP-GL mode to emulate a plotter, use HPGL Y. If embedded graphics are rotated, use HPGL R instead.


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. /MEDIALETTERHEAD 2


Causes HP-GL mode to default to monochrome rather than colour.


Set x=P for portrait,
     L for landscape,
     I for inverted portrait, or
     J for journal (inverted landscape)
Use * to force that orientation: e.g. /ORIENT *L


Set the paper size, where p is one of:
A0, A1, A2, A3, A4, A5, A6,

/RES x,y

Sets 'x' and 'y' resolutions in the range 25 to 600dpi. E.g.

/RES 204,198


Define default font f where f can be the name of an RFF font or an HP selection sequence with escape replaced by the ^^ character. Default is Courier 10 pitch in PC character set (10U).


PCL shading patterns, where s is:

gray-scale solid colour.


Define spot colour as RGB.

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


Sets the default input 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 tray 2. For Postscript printing it may be necessary to define trays corresponding to the PCL numbers. The symbols PSTRAYS1, PSTRAYS2 etc. define the input tray names associated with PCL trays 1, 2 etc.


Composite document options


Used in conjunction with the the 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:


For example, a Job titled My document with ID 1234 creates a PDF named My document1234.pdf by default. This may be overriden using the /TO option. See also Filenames and widcards.

/FROM filename

Read the named control file. If it is a CSV file then the component files will be treated as if they were a single file with reset commands at file boundaries. Other control files process a list of files and the default is to export them separately unless the /JOIN command is used.


Use to treat a list of files as a single (composite) document. This is the default for control files which are in CSV format.

/SORT sortorder

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).


Other options


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

/BORDER left,top,right,bottom

Adds borders of specified widths to all four edges when exporting an image or PDF. If only two values are specified, the first is used to set the left and right border 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 centimetres 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.


Copies any existing PJL comments to the output file when exporting to PCL.

/DEFINE fieldname='string'

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.
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.


Use the printer driver's defaults when printing a file. This means that the paper type, duplexing and bin selection are all as chosen by the user from File | Printer Setup... Properties... rather than what is in the original PCL file.

/DROP y|n

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


Timed mode only: erase data files after successful processing (the default is to rename them as *.BAK).

/ERRORLOG y|n|<file>

EscapeE creates an error log file to report errors. The value of the ERRORLOG symbol can be Y (the default - creates the file in the current folder) or N (to avoid writing a file) or the name of a file to be used as the error log, e.g.

ERRORLOG c:\temp\error.log

creates the error log file in the temp folder.


When creating FDL forms convert the page into a single RIF image.


Defines the colour of field data area - such that c is the colour number:
c = 65536 * blue + 256 * green + red
where R, G, B values run from 0 to 255.
Defaults to green.


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


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

/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 '1/300"'


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.


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



Where x=

   I  ignores images,
  S  ignores shading,
  W  ignores white areas,
  P  ignores paper specifications,
  F  ignores downloaded fonts,
  K  ignores downloaded fonts if they have a substitute defined.
For example /IGNORE IS sets printer to ignore images and shading.


Set x to B to omit blank pages.
Set x to M to omit monochrome pages.
For example, to suppress the printing of blank pages and also pages containing only monochrome images, use:



Sets the size, in Mbytes, of the cache which ADDIMAGE plugin may use to retain images in the printer after the end of a page.
Default image cache size is 10 Mbytes.

/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.


Define name or number of TCP/IP input port.


The input format, where x is one of:


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


/LIB 1

Define the font library search path.


Define the minimum vertical difference between the baselines of two words for them to be deemed on different lines. The value of 'n' is measured in the currently defined user units: dots, dot600, de, cm or in.

/LOG f

Which fields are to be logged when outputting images or PDFs
The parameter consists of appropriate combinations of the following, depending on the export format and fields that are to be stored:

f     meaning

A    all defined fields

B     the log file is to contain Bates page numbers

C     the log file is to be in comma-separated format

F     the log file is to contain the filenames

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

R     the log file is renamed on completion

S     the selected fields

T     all text (only applies to log files in text format)

X     the log file is to be in XML format

1     makes one log file entry for each output file (not each page)

If XML output is desired, rather than CSV then X should be appended, e.g. /LOG AX

/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. *.INF

/LPR [hostname]

where hostname specifies 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

/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.

/LPRQ 'queue'

A string defining the name of LPR output queue.

/LPRU 'user'

A string to set LPR User name. The string may include field names in braces.


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 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, /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.


Defines the image data mode, where p is:

   0 = byte aligned (default),
   1 = unpacked (raw),
   3 = CCITT group 3 fax compression,
   4 = CCITT group 4 fax compression,
   5 = LZW compression,

Flag bits may be added 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.

See Image Compression and Exporting to TIFF.

/PAGE n-m*s


/PAGES n-m*s

Process page 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-


Define PCL options; n is the number made by adding the following flag values (they are common to PCL, PS and PDF):


Compress the output


Combine words into longer text strings where possible


All fonts are to be substituted by standard Acrobat or Postscript fonts


TrueType fonts are to be included in the output file


Use substitutes instead of any True type fonts


Use substitutes instead of any bitmap fonts


Do not use substitute fonts even a substitute font has been specified in the font library


Image the whole page as a graphic


Image all but the text


Download fonts before use (not sensible for PDF output)


Allow inverse orientations to be displayed upside down


Suppress reordering of shading and graphics.


Resets export options to their default values.


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'

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.


Define PDF options. A number made by adding the following flag values:

     1   Disables printing the document

     2   Disable changing the document other than by adding or changing text notes

     4   Disable copying of text and graphics from the document

     8   Disable adding and changing text notes

256   Compress the PDF using Flate compression

512   Combine words into longer text strings where possible

See /PCLOPTS for other flags






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 centre 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)


Define password to have specified access to a PDF (see PDFOPTS).

/PNUM xxx

Define the page number template.


Nullifies the font.


Define PostScript options. See /PCLOPTS for flag numbers.


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


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.

/RES r

Define the resolution for image generation (default is 300).

/ROT r

Specify that pages are to be rotated as follows:

0         not rotated (default).

1        90 degrees anticlockwise

2        180 degrees (upside down).

3        270 degrees anticlockwise (90 degrees clockwise).


This parameter defines which fields are to be output during export to CSV, XML or text:


all defined fields.


for TIFF output: an individual file is created for each page.


a suffix of #1, #2 etc. is added to the filename to make it unique.


the selected fields.


for text export: all text.


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 colour output and 'm' for monochrome. The values of c and m are:

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

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


Defines the colour of highlighted text such that c is the colour 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.


Source of data: R = RedTitan software e.g. Dynamic Document formatter, W = Windows HP driver, O = other.


Sets the minimum width of space required to separate two words.
n may be followed by the % character to indicate it is a percentage of the width of the space character, otherwise the current units (inches, cm, dots etc.) are used. The default 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.


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 colour of search tag area, such that c is the colour number:
c = 65536 * blue + 256 * green + red
where R, G, B values run from 0 to 255.
Defaults to yellow.


Defines the colour of tag+field area  such that c is the colour 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.


Define orientation for TIFFs, where 'o' is:
   0    no rotation
   1   90 degrees anti-clockwise
   2   180 degrees anti-clockwise
   3   270 degrees anti-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.

/TO f

Define the default output specification. For example:

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

exports PCL files found in MyFolder to the Images folder in TIFF format.

See also Filenames and wildcards.


Remove white space from around any generated images (i.e. printed region only).


The value m sets up the trimming mode, such that:
No trimming
Printed region only
Selected region only
Printable region only

/TRIM m,w,h

Sets up the trimming mode m as above, and produces an image w units wide, h units high.
The default unit is pixels. Using a " specifies inches; a decimal point, centimetres (see /BORDER).


Uninstalls EscapeE.


Specifies the dimensions for the mouse coordinates where x is:
  IN for inches
  CM for centimetres
  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.


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

/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 Running EscapeE from a program


Defines the XML encoding scheme, x, where:

1= UTF8       The most compact Unicode encoding (XML default)

1= UTF16     Windows extended Unicode - not implemented yet

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)

There are a number of options which are obsolete or used for special purposes:


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


Colour of field area (default is yellow).


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.


Scan the RedTitan fonts rather than using font information files.


Colour of highlighted text (default is cyan).


Call up the shortcut creation dialogue 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 o instead.


A synonym for /RES.


Superseded by /DRAW.

See also

Running EscapeE from the command line