EscapeE

Command line syntax

Command line syntax

Previous topic Next topic No expanding text in this topic  

Command line syntax

Previous topic Next topic JavaScript is required for expanding text  

(Applies to EscapeE Professional and Batch Automation editions only)

Command line syntax index

Main options

Printer configuration options

Other options

Composite document options

Command line options may be of the form:

/<option>

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

 

The main (export) command line options are:

/AFP

Export file to IBM-AFP datastream.

/AFP M

Generate FormDef and export file to IBM-AFP datastream.

/CSV

Export data fields to comma separated values.

/FDL

Export file to Forms Description Language.

/HP

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

/IMG

Export file to Xerox IMG format.

/INSPEC

Defines the input specification for files. See also /OUTSPEC

/MACRO nnn

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

/OUTSPEC f

Defines the default output specification for files (it is equivalent to /TO). See also /INSPEC

/PDF

Export file to Adobe® Portable Document Format.

/PNG

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.

Examples:

ESCAPEE TEST.PRN /PRINT 'My printer,S'

ESCAPEE TEST.PRN /PRINT D /HP

/PROCESS

Processes the whole file without producing any output.
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 also 'No output' note.

/PS

Export Postscript Format level 2.

/PS3

Export Postscript Format level 3.

/SUBSET

Exports a subset of the file as PCL. See also /HP

/TEXT

Export file to plain text format. These text options may be used in any 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).

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

/TIFF n

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

1 to create a single page TIFF (the default) or
2 to create a multi page TIFF.

/XML

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

ESCAPEE *.LSH /TIFF V5

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.

/COPIES n

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.

/CR
r_low,r_high, g_low,g_high, b_low,b_high

Sets the colour 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 colours 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

/DUPLEX e

Requests duplex output (the default is to print both sides of the current page); e may take these values:

L Long-edge binding

S Short-edge binding

-L override print file settings, Long-edge binding

-S override print file settings, Short-edge binding.

See also /DUPSIM, below.

/DUPSIM e

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

L Long-edge binding

S Short-edge binding

See also /DUPLEX, above.

/EDGE

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.

/L

Set landscape orientation.

/LINEEND

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

/LINES n

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

/MONO

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

/NP n

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

/ORIENT x

Set x equal to:

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

/PAPER p

Set the paper size, where p is one of:
A0, A1, A2, A3, A4, A5, A6,
ARCHA, ARCHB, ARCHC, ARCHD, ARCHE, ARCH30,
LETTER, LEDGER, ANSIC, ANSID, ANSIE,
C5, DL, COMMERCIAL, EXECUTIVE, LEGAL, MONARCH.
See also /CUSTOM.

/PCn r,g,b

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

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

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

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

/SELECT f

Define default font f where f can be the name of an RFF font or an HP-PCL font selection sequence. 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).

See also /PNUMFONT, below.

/SHADING s

PCL shading patterns, where s is:

0 standard
1 fine
2 gray-scale solid colour.

/SPOT n

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.

/TRAY n

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

/CAPTURE

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
,filenamefield
[,startpagefield
,endpagefield]

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. 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. Other control files process a list of files and the default is to export them separately unless the /JOIN command is used.
See also /PAGES below, _numpages.

/JOIN

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

/SORT s

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

/BLANKPAGES y|n

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.

/CALCHDR

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.

/CLIP

Set the Unprintable area with parameters as follows:

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

/COMMENTS x

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

/DEFINE
fieldname='string'

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

/DISPLAY

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

/DRAW x

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.

/DRIVERDEFAULTS

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.

/ERASE

Erase input files after successful processing (otherwise the default is to rename them; see /RENAME).
/ERASE is always honored; when exporting in timed mode it overrides the ERASE configuration symbol setting.

/ERRORLOG <file>

Use to create an error log file for recording errors (a /REPORT is also generated to place an error summary in the Document Information notebook). For example,
/ERRORLOG c:\temp\error.log
creates an error log file named error.log in the temp folder. To suppress error log creation, just use
/ERRORLOG
without specifying a file.

See also Running EscapeE from a program.

/ERROROK a,b,c...

or

/ERROROK ALL

Use to ignore specified errors, where a, b, c etc. are return codes that are to be treated as acceptable and ignored when setting the error return code from EscapeE. In the special case of /ERROROK ALL, all non-vital errors are ignored.

See Return codes.

/FDLRIF

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

/FIELDCLR c

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.

/FIELDDEF f

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

/FIELDS f

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'
or
/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"'

/FLOW

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

or

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

/HISTORY n

To extend the 'History list' at the foot of the 'File' menu, specify the number of files n to be shown. If n is set to 0, the history list is empty.

/HOST h

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

/HOST \\mainserver\ourprinter

or

/HOST 192.168.7.15

/IGNORE x

Where x equal to:

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.
See also Optimizing the output.

/IMAGE x

Set 'x' to B to omit blank pages.
Set 'x' to W to create transparent white backgrounds (only relevant to PNG, TIFF).
Set 'x' to M to force monochrome pages using default halftone shading.
Set 'x' to MD for monochrome output using dithering.
Set 'x' to 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.

/IMAGECACHE n

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.
See also Setting general export options.

/INPORT p

Define name or number of TCP/IP input port.

/INPUT x

The input format, where x is one of:

PCL, PS, PDF, EPSON (or ESCP), RTF, TIFF, DCX, BMP, PNG, GIF, JPEG, IMG, IDF, XL (or PCL6), PCC.

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

ESCAPEE /INPUT PCL

/LIB 1

Define the font library search path.

/LINEHEIGHT n

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

Specifies which fields are to be logged when outputting images or PDFs; 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.
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 #).
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 P and B).
? 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 doing text logging.
1 makes one log file entry for each output file (see also V).

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

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

/LP_DATASIZE n

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

ESCAPEE XX.PCL /PDF /LPR 123.45.67.89 /LPRC C{classfield}

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, e.g.

/LPRQ HeaderPaper.

/LPRU 'user'

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

/MKDIR

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

/NEXTPAGE p

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.

/NOCACHE

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

/NQ

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.

/NQERROR xxx

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 which contains a list of one or more options - see Examples|Command lines. Each line of the file should be of the form:

option=value

/PACK p

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 TIFF images file export.

/PAGE n-m*s

or

/PAGES n-m*s

or

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

ESCAPEE /FROM CONTROL.CSV /PAGES STARTPAGE,LASTPAGE /PDF /X

See also /NEXTPAGE.

/PCLOPTS n

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

256 Compress the output

512 Combine words into longer text strings where possible

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

4096 TrueType fonts are to be included in the output file

8192 Use substitutes instead of any True type fonts

16384 Use substitutes instead of any bitmap fonts

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

65536 Image the whole page as a graphic

131072 Image all but the text

262144 Download fonts before use (not sensible for PDF output)

524288 Allow inverse orientations to be displayed upside down

8388608 Suppress reordering of shading and graphics.

-1 Resets export options to their default values.

/PCLPREAMBLE

Used for PJL preamble in PCL documents, see PCL export options.

/PCLRES r

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.

/PDFOPTS n

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.

/PDFPASS p

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

/PDFPASSR p

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

/PDFPREF

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)

See also PDF Viewer Preferences

/PDFREADPASS p

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

/PDFUSER p

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

/PNUM xxx

Define the page number template.

See also /PNUMFONT below.

/PNUMFONT f

or

/PNUMFONT *

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.

/PSOPTS

Define PostScript options. See /PCLOPTS for flag numbers.

/PSPREAMBLE

Used for XRX preamble in PostScript documents, see PS export options. For example if re-exporting a PS file, the original XRX commands can be propagated to the output using

ESCAPEE filename /PS /PSPREAMBLE {RT_XRX}

/RELOAD

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.
*.done
The default is to rename processed input files *.BAK.

See also /ERASE above and ERASE configuration symbol

/REPORT

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

or

/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 anticlockwise.
2   180 degrees (upside down).
3   270 degrees anticlockwise (90 degrees clockwise).

/RUN p

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

ESCAPEE /RUN myprog
runs program myprog, looking in the EscapeE software folder since no path is specified.

/SAVE f

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.

/SCALE s

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.

/SCALING n

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 simple scaling
1 two-bit scaling
2 four-bit gray shading

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

/SELCLR c

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.

See Configuring the view.

/SOURCE s

Source of data:

R RedTitan software e.g. Dynamic Document Formatter,
W Windows HP driver,
O Other.

/SPACEWIDTH n

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.

/STEM s

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

/SUBST f

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

See also /SUBSTDEF, below.

/SUBSTDEF f

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

/SYMSET s

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

/TAGCLR c

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.

/TAGFIELDCLR c

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.

/TEXTHEIGHT v

Specifies the inter-line spacing for text extraction, where v is the line spacing in the currently configured units.

/TIFFORIENT r

Define orientation for TIFFs, where 'r' 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.

/TIME t

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

/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 /OUTSPEC above and Filenames and wildcards.

/TRIM

or

/TRIM m

or

/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, centimetres (see /BORDER).

/TTLIB f

Defines a specific database to be used by EEfonts, e.g.

ESCAPEE /TTLIB TEMP.TTK

/UNINSTALL

Uninstalls EscapeE.

/UNITS x

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.

/USING file

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

ESCAPEE DFA0001 /USING MAILSHOT.RS2 /NQ /X

/VIEWHINTS v

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

/VIEWPAGE

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.

/X

Exit after processing the specified file(s).

See Running EscapeE from a program

/XMLCODE x

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

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

/1BIT

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

/FIELDCLR c

Colour of field area (default is yellow).

/NOCAMP

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

/NOFONTS

Ignore download fonts; use /IGNORE F instead.

/NOIMAGES

Ignore downloaded images; use /IGNORE I instead.

/PCL

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

/RFFS

Scan the RedTitan fonts rather than using font information files.

/SELCLR c

Colour of highlighted text (default is cyan).

/SHORTCUT

Call up the shortcut creation dialog at once.

/SPACEFILL

Space-fill fields.

/TIFFORIENT O

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.

/TIFFRES

A synonym for /RES.

/USELINES x

Superseded by /DRAW.


Links

Running EscapeE from the command line