86
243
Reference
/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 192.168.1.13 /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.:
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.
escapee /LPRQ HeaderPaper.
The string may include field names in braces, e.g.
escapee /LPRQ {queuefield}
/LPRU 'user'
A string
to set LPR User name. The string may include field
names in braces.
/MENU N
Inhibits display of the EscapeE toolbar and menus.
/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.
261
147
272
261
261
261
261
244
274
243
251
274
243
64
Reference
244
/OPTIONS filename
Specifies an options file (the extension .OPT is generally used)
which contains a list of one or more command line options.
Each line of the file specifies one option. The options —
without a preceding / character — should be of the form:
option=value
Options that take values of "yes" or "no" only may be
abbreviated to Y or N, e.g.
DISPLAY=Y
MKDIR=N
Boolean options are simply stated, e.g.
X
A file name can be put in the INI file
using the FILE
option in the options file:
FILE=escapee.prn
(For backward compatibility, the "equals" sign may be omitted
from options statements, but using the = instead is preferred
as it brings the syntax into line with that used in INI files.)
See Examples: Command lines
.
/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.
253
252
264
149
116
76
236
73
245
Reference
/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'
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.
129
130
173
173
173
173
250
89
Reference
246
/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 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
/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.
131
245
131
131
175
131
131
246
246
58
246
235
76
247
Reference
/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 file
Specify the new file path and/or name 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 counter-clockwise.
2 180 degrees (upside down).
3 270 degrees counter-clockwise (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.
138
245
140
237
93
238
253
41
211
92
32
94
92
58
Reference
248
/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.
185
242
242
75
249
Reference
/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 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.
/SELCLR c
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.
See also FIELDCLR
, TAGCLR
, TAGFIELDCLR
.
/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
*
239
250
250
38
249
249
48
89
Reference
250
/TAGCLR c
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.
See also FIELDCLR
, SELCLR
, TAGFIELDCLR
.
/TAGFIELDCLR c
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.
See also FIELDCLR
, SELCLR
, TAGCLR
.
/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 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.
/TIME t
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
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, centimeters (see /BORDER
).
/TTLIB f
Defines a specific database to be used by
EEfonts, e.g.
ESCAPEE /TTLIB TEMP.TTK
/UNINSTALL
Uninstalls
EscapeE.
239
249
250
239
249
250
92
116
173
230
95
237
219
Documents you may be interested
Documents you may be interested