ref: 57741d473f9d5165d142b165bd837984f6428c66
dir: /sys/src/cmd/gs/doc/Language.htm/
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Ghostscript and the PostScript language</title>
<!-- $Id: Language.htm,v 1.98 2005/10/20 19:46:23 ray Exp $ -->
<!-- Originally: language.txt -->
<link rel="stylesheet" type="text/css" href="gs.css" title="Ghostscript Style">
</head>
<body>
<!-- [1.0 begin visible header] ============================================ -->
<!-- [1.1 begin headline] ================================================== -->
<h1>Ghostscript and the PostScript language</h1>
<!-- [1.1 end headline] ==================================================== -->
<!-- [1.2 begin table of contents] ========================================= -->
<h2>Table of contents</h2>
<blockquote><ul>
<li><a href="#Capabilities">Ghostscript's capabilities in relation to PostScript</a>
<li><a href="#Implementation_limits">Implementation limits</a>
<ul>
<li><a href="#Architectural_limits">Architectural limits</a>
<li><a href="#Typical_memory_limits">Typical memory limits in LanguageLevel 1</a>
<li><a href="#VM_consumption">Other differences in VM consumption</a>
</ul>
<li><a href="#Additional_operators">Additional operators in Ghostscript</a>
<ul>
<li><a href="#Graphics_and_text">Graphics and text operators</a>
<ul>
<li><a href="#Transparency">Transparency</a>
<ul>
<li><a href="#Transparency_graphics_state_operators">Graphics state operators</a>
<li><a href="#Transparency_rendering_stack_operators">Rendering stack operators</a>
<li><a href="#Transparency_ImageType">New ImageType</a>
</ul>
<li><a href="#Graphics_state">Other graphics state operators</a>
<li><a href="#Path">Path operators</a>
<li><a href="#Painting">Painting operators</a>
<li><a href="#Character">Character operators</a>
</ul>
<li><a href="#Other">Other operators</a>
<ul>
<li><a href="#Mathematical">Mathematical operators</a>
<li><a href="#Dictionary">Dictionary operators</a>
<li><a href="#String">String and name operators</a>
<li><a href="#Relational">Relational operators</a>
<li><a href="#File">File operators</a>
<li><a href="#Virtual_memory">Virtual memory operators</a>
<li><a href="#Miscellaneous">Miscellaneous operators</a>
<li><a href="#Device">Device operators</a>
</ul>
</ul>
<li><a href="#Filters">Filters</a>
<ul>
<li><a href="#Standard_filters">Standard filters</a>
<li><a href="#Non_standard_filters">Non-standard filters</a>
<li><a href="#Unstable_filters">Unstable filters</a>
</ul>
<li><a href="#Device_parameters">Device parameters</a>
<li><a href="#User_parameters">User parameters</a>
<li><a href="#Miscellaneous_additions">Miscellaneous additions</a>
<ul>
<li><a href="#Extended_semantics_of_run">Extended semantics of 'run'</a>
<li><a href="#DecodingResources">Decoding resources</a>
<li><a href="#CIDDecodingResources">CIDDecoding resources</a>
<li><a href="#GlyphNames2Unicode">GlyphNames2Unicode</a>
<li><a href="#MultipleResourceDirectories">Multiple Resource directories</a>
</ul>
</ul></blockquote>
<!-- [1.2 end table of contents] =========================================== -->
<!-- [1.3 begin hint] ====================================================== -->
<p>For other information, see the <a href="Readme.htm">Ghostscript
overview</a>.
<!-- [1.3 end hint] ======================================================== -->
<hr>
<!-- [1.0 end visible header] ============================================== -->
<!-- [2.0 begin contents] ================================================== -->
<h2><a name="Capabilities"></a>Ghostscript's capabilities in relation to PostScript</h2>
<p>
The Ghostscript interpreter, except as noted below, is intended to execute
properly any source program written in the (LanguageLevel 3)
<b>PostScript</b> language as defined in the <cite>PostScript
Language Reference, Third Edition</cite> (ISBN 0-201-37922-8) published by
Addison-Wesley in mid-1999. However, the interpreter is configurable in
ways that can restrict it to various subsets of this language.
Specifically, the base interpreter accepts the Level 1 subset of the
PostScript language, as defined in the first edition of the <cite>PostScript
Language Reference Manual</cite> (ISBN 0-201-10174-2) Addison-Wesley 1985,
plus the file system, version 25.0 language, and miscellaneous additions
listed in sections A.1.6, A.1.7, and A.1.8 of the Second Edition
respectively, including allowing a string operand for the
"<b><tt>status</tt></b>" operator. The base interpreter may be configured
(see the <a href="Make.htm">documentation on building Ghostscript</a> for
how to configure it) by adding any combination of the following:
<ul>
<li>The ability to process PostScript Type 1 fonts. This facility is
normally included in the interpreter.
<li>The CMYK color extensions listed in section A.1.4 of the Second Edition
(including <b><tt>colorimage</tt></b>). These facilities are available
only if the <b><tt>color</tt></b>, <b><tt>dps</tt></b>, or
<b><tt>level2</tt></b> feature was selected when Ghostscript was built.
<li>The Display PostScript extensions listed in section A.1.3 of the Second
Edition, but excluding the operators listed in section A.1.2. These
facilities are available only if the <b><tt>dps</tt></b> feature or the
<b><tt>level2</tt></b> feature was selected when Ghostscript was built.
<li>The composite font extensions listed in section A.1.5 of the Second
Edition, and the ability to handle Type 0 fonts. These facilities are
available only if the <b><tt>compfont</tt></b> feature or the
<b><tt>level2</tt></b> feature was selected when Ghostscript was built.
<li>The ability to load TrueType fonts and to handle PostScript Type 42
(encapsulated TrueType) fonts. These facilities are available only if the
<b><tt>ttfont</tt></b> feature was selected when Ghostscript was built.
<li>The PostScript Level 2 "filter" facilities except the
<b><tt>DCTEncode</tt></b> and <b><tt>DCTDecode</tt></b> filters. These
facilities are available only if the <b><tt>filter</tt></b>,
<b><tt>dps</tt></b>, or <b><tt>level2</tt></b> feature was selected when
Ghostscript was built.
<li>The PostScript Level 2 <b><tt>DCTEncode</tt></b> and
<b><tt>DCTDecode</tt></b> filters. These facilities are available only if
the <b><tt>dct</tt></b> or <b><tt>level2</tt></b> feature was selected when
Ghostscript was built.
<li>All the other PostScript Level 2 operators and facilities listed in
section A.1.1 of the Second Edition and not listed in any of the other
A.1.n sections. These facilities are available only if the
<b><tt>level2</tt></b> feature was selected when Ghostscript was built.
<li>All PostScript LanguageLevel 3 operators and facilities listed in the
Third Edition, except as noted below. These facilities are available only
if the <b><tt>psl3</tt></b> feature was selected when Ghostscript was built.
<li>The ability to recognize DOS EPSF files and process only the PostScript
part, ignoring bitmap previews or other information. This facility is
available only if the <b><tt>epsf</tt></b> feature was selected when
Ghostscript was built.
</ul>
<p>
Ghostscript currently does not implement the following PostScript
LanguageLevel 3 facilities:
<ul>
<li>Native <b><tt>Separation</tt></b> and <b><tt>DeviceN</tt></b> color
spaces -- the alternate space is always used.
<li>Settable <b><tt>ProcessColorModel</tt></b> for page devices, except for
a very few special devices.
<li><b><tt>IODevice</tt></b>s other than <b><tt>%stdin</tt></b>,
<b><tt>%stdout</tt></b>, <b><tt>%stderr</tt></b>, <b><tt>%lineedit</tt></b>,
<b><tt>%statementedit</tt></b>, <b><tt>%os%</tt></b>, and (if configured)
<b><tt>%pipe%</tt></b> and <b><tt>%disk0%</tt></b> through <b><tt>%disk0%</tt></b>.
</ul>
<p>
Ghostscript can also interpret files in the Portable Document Format (PDF)
1.3 format defined in the <a
href="http://partners.adobe.com/asn/developer/PDFS/TN/PLRM.pdf"><em>Portable
Document Format Reference Manual</em> Version 1.3</a> of March 11, 1999,
distributed by <a href="http://www.adobe.com/">Adobe Systems
Incorporated</a>, except as noted below. This facility is available only if
the <b><tt>pdf</tt></b> feature was selected when Ghostscript was built.
<p>
Ghostscript currently does not implement the following PDF 1.3 facilities:
<ul>
<li>Native <b><tt>Separation</tt></b> and <b><tt>DeviceN</tt></b> color
spaces, as noted above for PostScript.
<li>Native <b><tt>ICCBased</tt></b> color spaces -- these too always use the
alternate space.
</ul>
<p>
Ghostscript also includes a number of
<a href="#Additional_operators">additional operators</a> defined below that
are not in the PostScript language defined by Adobe.
<hr>
<h2><a name="Implementation_limits"></a>Implementation limits</h2>
<p>
The implementation limits show here correspond to those in Tables B.1 and
B.2 of the Second and Third Editions, which describe the quantities fully.
Where Ghostscript's limits are different from those of Adobe's
implementations (as shown in the Third Edition), Adobe's limits are also
shown.
<h3><a name="Architectural_limits"></a>Architectural limits</h3>
<blockquote><table cellpadding=0 cellspacing=0>
<tr><th colspan=7 bgcolor="#CCCC00"><hr><font size="+1">Architectural limits (corresponds to Adobe table B.1)</font><hr>
<tr valign=bottom>
<th align=left>Quantity
<td>
<th align=left>Limit
<td>
<th align=left>Type
<td>
<th align=left>Adobe
<tr> <td colspan=7><hr>
<tr valign=top> <td>integer
<td>
<td>32-bit
<td>
<td>twos complement integer
<td>
<td>
<tr valign=top> <td>real
<td>
<td>single-precision
<td>
<td>IEEE float
<td>
<td>
<tr valign=top> <td>array
<td>
<td>65535
<td>
<td>elements
<td>
<td>
<tr valign=top> <td>dictionary
<td>
<td>65534
<td>
<td>elements
<td>
<td>65535
<tr valign=top> <td>string
<td>
<td>65535
<td>
<td>characters
<td>
<td>
<tr valign=top> <td>name
<td>
<td>16383
<td>
<td>characters
<td>
<td>127
<tr valign=top> <td>filename
<td>
<td>128*
<td>
<td>characters
<td>
<td>
<tr valign=top> <td><b><tt>save</tt></b> level
<td>
<td>none
<td>
<td>(capacity of memory)
<td>
<td>15
<tr valign=top> <td><b><tt>gsave</tt></b> level
<td>
<td>none
<td>
<td>(capacity of memory)
<td>
<td>13
</table></blockquote>
<p>
* The limit on the length of a file name is 128 characters if the name
starts with a %...% IODevice designation, or 124 characters if it does not.
<h3><a name="Typical_memory_limits"></a>Typical memory limits in LanguageLevel 1</h3>
<blockquote><table cellpadding=0 cellspacing=0>
<tr><th colspan=7 bgcolor="#CCCC00"><hr><font size="+1">Memory limits (corresponds to Adobe table B.2)</font><hr>
<tr valign=bottom>
<th align=left>Quantity
<td>
<th align=left>Limit
<td>
<th align=left>Type
<td>
<th align=left>Adobe
<tr> <td colspan=7><hr>
<tr valign=top> <td><b><tt>userdict</tt></b>
<td>
<td>200
<td>
<td>
<td>
<td>
<tr valign=top> <td><b><tt>FontDirectory</tt></b>
<td>
<td>100
<td>
<td>
<td>
<td>
<tr valign=top> <td>operand stack
<td>
<td>800
<td>
<td>
<td>
<td>500
<tr valign=top> <td>dictionary stack
<td>
<td>20
<td>
<td>
<tr valign=top> <td>execution stack
<td>
<td>250
<td>
<td>
<tr valign=top> <td>interpreter level
<td>
<td>none
<td>
<td>(capacity of memory)
<td>
<td>10
<tr valign=top> <td>path
<td>
<td>none
<td>
<td>(capacity of memory)
<td>
<td>1500
<tr valign=top> <td>dash
<td>
<td>11
<td>
<td>
<tr valign=top> <td>VM
<td>
<td>none
<td>
<td>(capacity of memory)
<td>
<td>240000
<tr valign=top> <td>file
<td>
<td>none
<td>
<td>(determined by operating system)
<td>
<td>6
<tr valign=top> <td>image
<td>
<td>65535
<td>
<td>values (samples × components)<br>for1-, 2-, 4-, or 8-bit samples
<td>
<td>3300
<tr valign=top> <td>
<td>
<td>32767
<td>
<td>values for 12-bit samples
<td>
<td>3300
</table></blockquote>
<h3><a name="VM_consumption"></a>Other differences in VM consumption</h3>
<p>
Packed array elements occupy either 2 bytes or 8 bytes. The average
element size is probably about 5 bytes. Names occupy 12 bytes plus the
space for the string.
<p>
The garbage collector doesn't reclaim portions of arrays obtained with
<tt>getinterval</tt>, rather it collects entire arrays.
<hr>
<h2><a name="Additional_operators"></a>Additional operators in Ghostscript</h2>
<h3><a name="Graphics_and_text"></a>Graphics and text operators</h3>
<h4><a name="Transparency"></a>Transparency</h4>
<p>
Ghostscript provides a set of operators for implementing the transparency
and compositing facilities of PDF 1.4. These are defined only if the
<b><tt>transpar</tt></b> option was selected when Ghostscript was built. We
do not attempt to explain the underlying graphics model here: for details,
see <a
href="http://partners.adobe.com/asn/developer/technotes.html#acrobat-pdf"
class="offsite">Adobe
Technical Note</a> #5407, "<a
href="http://partners.adobe.com/asn/developer/acrosdk/DOCS/PDF_Transparency.pdf"
class="offsite">Transparency
in PDF</a>". Note, however, that
Ghostscript's model generalizes that of PDF 1.4 in that Ghostscript
maintains separate alpha and mask values for opacity and shape, rather than
a single value with a Boolean that says whether it represents opacity or
shape. EVERYTHING IN THIS SECTION IS SUBJECT TO CHANGE.
<h5><a name="Transparency_graphics_state_operators"></a>Graphics state
operators</h5>
<dl>
<dt><b><tt><modename> .setblendmode -</tt></b>
<dd>Sets the blending mode in the graphics state. If the mode name is not
recognized, causes a <b><tt>rangecheck</tt></b> error. The initial value of
the blending mode is <b><tt>/Compatible</tt></b>.
</dl>
<dl>
<dt><b><tt>- .currentblendmode <modename></tt></b>
<dd>Returns the current blending mode.
</dl>
<dl>
<dt><b><tt><0..1> .setopacityalpha -</tt></b>
<dd>Sets the opacity alpha value in the graphics state.
The initial opacity alpha value is 1.
</dl>
<dl>
<dt><b><tt>- .currentopacityalpha <0..1></tt></b>
<dd>Returns the current opacity alpha value.
</dl>
<dl>
<dt><b><tt><0..1> .setshapealpha -</tt></b>
<dd>Sets the shape alpha value in the graphics state.
The initial shape alpha value is 1.
</dl>
<dl>
<dt><b><tt>- .currentshapealpha <0..1></tt></b>
<dd>Returns the current shape alpha value.
</dl>
<dl>
<dt><b><tt><bool> .settextknockout -</tt></b>
<dd>Sets the text knockout flag in the graphics state.
The initial value of the text knockout flag is <b><tt>true</tt></b>.
</dl>
<dl>
<dt><b><tt>- .currenttextknockout <bool></tt></b>
<dd>Returns the current text knockout flag.
</dl>
<h5><a name="Transparency_rendering_stack_operators"></a>Rendering stack
operators</h5>
<p>
The interpreter state is extended to include a (per-context) rendering stack
for handling transparency groups and masks (generically, "layers"). Groups
accumulate a full value for each pixel (paint plus transparency); masks
accumulate only a coverage value. Layers must be properly nested, i.e., the
'end' or 'discard' operator must match the corresponding 'begin' operator.
<p>
Beginning and ending layers must nest properly with respect to
<b><tt>save</tt></b> and <b><tt>restore</tt></b>: <b><tt>save</tt></b> and
<b><tt>restore</tt></b> do not save and restore the layer stack. Currently,
layers are not required to nest with respect to <b><tt>gsave</tt></b> and
<b><tt>grestore</tt></b>, except that the device that is current in the
graphics state when ending a layer must be the same as the device that was
current when beginning the layer. THIS AREA IS SUBJECT TO CHANGE.
<dl>
<dt><b><tt><paramdict> <llx> <lly> <urx> <ury>
.begintransparencygroup -</tt></b>
<dd>Begins a new transparency group. The <b><tt>ll/ur</tt></b> coordinates
are the bounding box of the group in the current user coordinate system.
<b><tt>paramdict</tt></b> has the following keys:
<dl>
<dt><b><tt>/Isolated</tt></b>
<dd>(optional) Boolean; default value = <b><tt>false</tt></b>.
<dt><b><tt>/Knockout</tt></b>
<dd>(optional) Boolean; default value = <b><tt>false</tt></b>.
</dl>
</dl>
<dl>
<dt><b><tt>- .discardtransparencygroup -</tt></b>
<dd>Ends and discards the current transparency group.
</dl>
<dl>
<dt><b><tt>- .endtransparencygroup -</tt></b>
<dd>Ends the current transparency group, compositing the group being ended
onto the group that now becomes current.
</dl>
<dl>
<dt><b><tt><paramdict> <llx> <lly> <urx> <ury>
.begintransparencymaskgroup -</tt></b>
<dd>Begins a new transparency mask, which is represented as a group.
The <b><tt>ll/ur</tt></b> coordinates
are the bounding box of the mask in the current user coordinate system.
<b><tt>paramdict</tt></b> has the following keys:
<dl>
<dt><b><tt>/Subtype</tt></b>
<dd>(required) Name, either <b><tt>/Alpha</tt></b> or
<b><tt>/Luminosity</tt></b>.
<dt><b><tt>/Background</tt></b>
<dd>(optional) Array of number.
<dt><b><tt>/TransferFunction</tt></b>
<dd>(optional) Function object (produced by applying
<b><tt>.buildfunction</tt></b> to a Function dictionary).
</dl>
</dl>
<dl>
<dt><b><tt>- .begintransparencymaskimage -</tt></b>
<dd>Begins a new transparency mask, which is represented as a single image.
</dl>
</dl>
<dl>
<dt><b><tt>- .discardtransparencymask -</tt></b>
<dd>Ends and discards the current transparency mask.
</dl>
<dl>
<dt><b><tt><masknum> .endtransparencymask -</tt></b>
<dd>Ends the current transparency mask, installing it as the current opacity
(<b><tt>masknum</tt></b> = 0) or shape (<b><tt>masknum</tt></b> = 1) mask in
the graphics state.
</dl>
<dl>
<dt><b><tt><masknum> .inittransparencymask -</tt></b>
<dd>Resets the current opacity (<b><tt>masknum</tt></b> = 0) or shape
(<b><tt>masknum</tt></b> = 1) mask to an infinite mask with alpha = 1
everywhere.
</dl>
<h5><a name="Transparency_ImageType"></a>New ImageType</h5>
<p>
The transparency extension defines a new ImageType 103, similar to ImageType
3 with the following differences:
<ul>
<li>The required <b><tt>MaskDict</tt></b> is replaced by two optional
dictionaries, <b><tt>OpacityMaskDict</tt></b> and
<b><tt>ShapeMaskDict</tt></b>. If present, these dictionaries must have a
<b><tt>BitsPerComponent</tt></b> entry, whose value may be greater than 1.
Note that in contrast to ImageType 3, where any non-zero chunky mask value
is equivalent to 1, ImageType 103 simply takes the low-order bits of chunky
mask values.
<li>A <b><tt>Matte</tt></b> entry may be present in one or both mask
dictionaries, indicating premultiplication of the data values. If both
<b><tt>MaskDict</tt></b>s have a <b><tt>Matte</tt></b> entry and the values
of the two <b><tt>Matte</tt></b> entries are different, a
<b><tt>rangecheck</tt></b> error occurs.
<li><b><tt>InterleaveType</tt></b> appears in the <b><tt>MaskDict</tt></b>s,
not the <b><tt>DataDict</tt></b>, because each mask has its own
<b><tt>InterleaveType</tt></b>. <b><tt>InterleaveType</tt></b> 2
(interlaced scan lines) is not supported.
</ul>
<h4><a name="Graphics_state"></a>Other graphics state operators</h4>
<dl>
<dt><b><tt><bool> .setaccuratecurves -</tt></b>
<dd>Sets a graphics state flag that determines whether curves and arcs,
when flattened, always start and end with a line that is a segment of the
tangent; this also causes butt and square caps to be properly perpendicular
to the tangent. <b><tt>initgraphics</tt></b> sets this flag to false, to
match other PostScript implementations.
</dl>
<dl>
<dt><b><tt>- .currentaccuratecurves <bool></tt></b>
<dd>Returns the current value of the accurate curves flag.
</dl>
<dl>
<dt><b><tt><int> .setcurvejoin -</tt></b>
<dd>Obsolete, left for backward compatibility.
<dd>Sets a graphics state parameter that determines how to treat the joins
between the line segments produced when a curve is flattened. The parameter
value may be either -1 or a value acceptable to <b><tt>setlinejoin</tt></b>.
If the parameter value is -1, the join used for flattened curve line
segments is given by the current line join parameter in the graphics state
(except that if the line join value is "none", a bevel join is used), which
matches the Adobe Red Book, but not some old Adobe implementations; if the curve
join parameter value is a line join value, that type of join is used for
flattened curve line segments, regardless of the value of the graphics state
line join parameter. The initial (and default) value of the curve join
parameter is -1, causing the compatibility to Red Book and to modern Adobe
implementations. <b><tt>initgraphics</tt></b> sets the parameter to its
default value.
</dl>
<dl>
<dt><b><tt>- .currentcurvejoin <int></tt></b>
<dd>Obsolete, left for backward compatibility.
<dd>Returns the current value of the curve join parameter.
</dl>
<dl>
<dt><b><tt><bool> .setdashadapt -</tt></b>
<dd>Sets a graphics state flag that determines whether dash patterns do
(true) or do not (false) automatically scale themselves so that each line
segment consists of an integral number of pattern repetitions.
<b><tt>initgraphics</tt></b> sets this flag to false.
</dl>
<dl>
<dt><b><tt>- .currentdashadapt <bool></tt></b>
<dd>Returns the current value of the dash adaptation flag.
</dl>
<dl>
<dt><b><tt><matrix> .setdefaultmatrix -</tt></b>
<dd>Sets the default matrix that is returned by
<b><tt>defaultmatrix</tt></b> and installed by <b><tt>initmatrix</tt></b>.
Ordinary programs should not use this operator.
</dl>
<dl>
<dt><b><tt><num> <bool> .setdotlength -</tt></b>
<dd>Sets a graphics state parameter that determines the handling of
zero-length lines (dots). If the dot length is zero, dots are painted as
circles if round line caps are in effect, otherwise they are not painted at
all. If the dot length is non-zero, dots are treated exactly like lines of
the given length: the length is specified in user coordinates (like line
width) if <b><tt>bool</tt></b> is false, or in default user coordinates of
points (units of 1/72in; see the <a href="Devices.htm#Measurements">notes
on measurements</a> in the documentation on devices) if
<b><tt>bool</tt></b> is true. Dots occurring as part of dash patterns will
be oriented correctly; isolated dots will be oriented as though they were
part of a vertical line. <b><tt>initgraphics</tt></b> sets the dot length
to zero.
</dl>
<dl>
<dt><b><tt>- .currentdotlength <num> <bool></tt></b>
<dd>Returns the current dot length and dot length mode.
</dl>
<dl>
<dt><b><tt><dx> <dy> .setfilladjust2 -</tt></b>
<dd>Sets graphics state parameters that cause all filled and stroked
regions to be "fattened" by the given amount relative to an algorithm that
only paints pixels whose centers fall within the region to be painted.
<b><tt>dx</tt></b> and <b><tt>dy</tt></b> are numbers between 0 and 0.5,
measured in device space. The only two values that are likely to be useful
are 0, which gives a pure center-of-pixel rule, and 0.5, which gives
Adobe's any-part-of-pixel rule. (0.5 is treated slightly specially in
order to create half-open pixels per Adobe's specification.)
</dl>
<dl>
<dt><b><tt>- .currentfilladjust2 <dx> <dy></tt></b>
<dd>Returns the current fill adjustment values.
</dl>
<dl>
<dt><b><tt><bool> .setlimitclamp -</tt></b>
<dd>Sets a graphics state flag that determines whether attempts to set the
current point outside the internally representable range should clamp the
value to the largest representable value (true) or give a
<b><tt>limitcheck</tt></b> error (false). <b><tt>initgraphics</tt></b> sets
this flag to false, to match other PostScript implementations.
</dl>
<dl>
<dt><b><tt>- .currentlimitclamp <bool></tt></b>
<dd>Returns the current value of the limit clamp flag.
</dl>
<dl>
<dt><b><tt><int> .setoverprintmode -</tt></b>
<dd>Sets the overprint mode in the graphics state. Legal values are 0 or 1.
Per the PDF 1.3 specification, if the overprint mode is 1, then when the
current color space is <b><tt>DeviceCMYK</tt></b>, color components whose
value is 0 do not write into the target, rather than writing a 0 value.
THIS BEHAVIOR IS NOT IMPLEMENTED YET. The initial value of the overprint
mode is 0.
</dl>
<dl>
<dt><b><tt>- .currentoverprintmode <int></tt></b>
<dd>Returns the current overprint mode.
</dl>
<h4><a name="Path"></a>Path operators</h4>
<dl>
<dt><b><tt>- .dashpath -</tt></b>
<dd>If there is no current dash pattern, does nothing. Otherwise, does the
equivalent of <b><tt>flattenpath</tt></b> and then chops up the path as
determined by the dash pattern.
</dl>
<dl>
<dt><b><tt><x> <y> <width> <height> .rectappend -</tt></b>
<dt><b><tt><numarray> .rectappend -</tt></b>
<dt><b><tt><numstring> .rectappend -</tt></b>
<dd>Appends a rectangle or rectangles to the current path, in the same
manner as <b><tt>rectfill</tt></b>, <b><tt>rectclip</tt></b>, etc. Defined
only if the <b><tt>dps</tt></b> or <b><tt>level2</tt></b> option was
selected when Ghostscript was built.
</dl>
<h4><a name="Painting"></a>Painting operators</h4>
<p>
Ghostscript supports an experimental extension of the PostScript imaging
model to include <b><tt>RasterOp</tt></b> and some related facilities.
This extension is available only if the <b><tt>rasterop</tt></b> option was
selected when building Ghostscript.
<p>
With the <b><tt>RasterOp</tt></b> extension, imaging operations compute a
function <b>D = f(D,S,T)</b> in RGB space, where <b>f</b> is an
arbitrary 3-input Boolean function, <b>D</b> is the destination (frame
buffer or print buffer), <b>S</b> is the source (described below), and
<b>T</b> is the texture (the current PostScript color, which may be a
pattern). The source and texture depend on the PostScript imaging
operation:
<ul>
<li>For <b><tt>fill</tt></b> and <b><tt>stroke</tt></b>, the source is
solid black, covering the region to be painted; the texture is the current
PostScript color.
<li>For <b><tt>show</tt></b> and <b><tt>imagemask</tt></b>, the source is
solid black, covering the pixels to be painted; the texture is the current
PostScript color.
<li>For <b><tt>image</tt></b> and <b><tt>colorimage</tt></b>, the source is
the image data; the texture depends on an optional Boolean parameter,
<b><tt>CombineWithColor</tt></b>, in the image dictionary. If
<b><tt>CombineWithColor</tt></b> is false (the default), the texture is
solid black. If <b><tt>CombineWithColor</tt></b> is true, the texture is
the current color. For the non-dictionary form of the image operator,
<b><tt>CombineWithColor</tt></b> is considered to be false.
</ul>
<p>
The <b><tt>rasterop</tt></b> option adds the following operators:
<dl>
<dt><b><tt><int8> .setrasterop -</tt></b>
<dd>Sets the <b><tt>RasterOp</tt></b> function in the graphics state. The
default function is 252, Source | Texture.
</dl>
<dl>
<dt><b><tt>- .currentrasterop <int8></tt></b>
<dd>Returns the current <b><tt>RasterOp</tt></b> function.
</dl>
<dl>
<dt><b><tt><bool> .setsourcetransparent -</tt></b>
<dd>Sets source transparency in the graphics state. When source
transparency is true, white source pixels prevent storing into the
destination, regardless of what the <b><tt>RasterOp</tt></b> function
returns. The default source transparency is false.
</dl>
<dl>
<dt><b><tt>- .currentsourcetransparent <bool> -</tt></b>
<dd>Returns the current source transparency.
</dl>
<dl>
<dt><b><tt><bool> .settexturetransparent -</tt></b>
<dd>Sets texture transparency in the graphics state. When texture
transparency is true, white texture pixels prevent storing into the
destination, regardless of what the <b><tt>RasterOp</tt></b> function
returns. The default texture transparency is false.
</dl>
<dl>
<dt><b><tt>- .currenttexturetransparent <bool> -</tt></b>
<dd>Returns the current texture transparency.
</dl>
<p>
For more information on RasterOp and transparency, please consult chapter 5
of the "PCL 5 Color Technical Reference Manual",
<a href="http://www.hp.com/cposupport/printers/support_doc/bpl01354.html">Hewlett-Packard
Manual Part No. 5961-0635</a>.
<h4><a name="Character"></a>Character operators</h4>
<dl>
<dt><b><tt><string> <bool> .charboxpath -</tt></b>
<dd>For each character <b>C</b> in the rendering of <string>, let the
bounding box of <b>C</b> <b><em>in device space</em></b> be the four
<b><em>user-space</em></b> points p1x/y, p2x/y, p3x/y, and p4x/y. For each
character in order, <b><tt>.charboxpath</tt></b> appends the following to
the current path:
<ul><li>If <b><tt><bool></tt></b> is true, the equivalent of:
<blockquote>
p1x p1y <b><tt>moveto</tt></b><br>
p2x p2y <b><tt>lineto</tt></b><br>
p3x p3y <b><tt>lineto</tt></b><br>
p4x p4y <b><tt>lineto</tt></b><br>
<b><tt>closepath</tt></b>
</blockquote>
</ul>
<p>
This creates a path whose <b><tt>pathbbox</tt></b> is the
<b><tt>bbox</tt></b> of the string.
<ul><li>If <b><tt><bool></tt></b> is false, the equivalent of:
<blockquote>
p1x p1y <b><tt>moveto</tt></b><br>
p3x p3y <b><tt>lineto</tt></b>
</blockquote>
</ul>
<p>
If the CTM is well-behaved (consists only of reflection, scaling, and
rotation by multiples of 90 degrees), this too creates a (simpler) path
whose <b><tt>pathbbox</tt></b> is the <b><tt>bbox</tt></b> of the string.
</dl>
<dl>
<dt><b><tt><font> <charname|charcode> <charname> <charstring> .type1execchar -</tt></b>
<dd>Does all the work for rendering a Type 1 outline. This operator, like
<b><tt>setcharwidth</tt></b> and <b><tt>setcachedevice</tt></b>, is valid
only in the context of a show operator -- that is, it must only be called
from within a <b><tt>BuildChar</tt></b> or <b><tt>BuildGlyph</tt></b>
procedure.
</dl>
<dl>
<dt><b><tt><font> <charcode> %Type1BuildChar -</tt></b>
<dd>This is not a new operator: rather, it is a name known specially to the
interpreter. Whenever the interpreter needs to render a character (during
a ...<b><tt>show</tt></b>, <b><tt>stringwidth</tt></b>, or
<b><tt>charpath</tt></b>), it looks up the name <b><tt>BuildChar</tt></b>
in the font dictionary to find a procedure to run. If it does not find
this name, and if the <b><tt>FontType</tt></b> is 1, the interpreter
instead uses the value (looked up on the dictionary stack in the usual way)
of the name <b><tt>%Type1BuildChar</tt></b>.
<p>
The standard definition of <b><tt>%Type1BuildChar</tt></b> is in the
initialization file <b><tt>gs_type1.ps</tt></b>. Users should not need to
redefine <b><tt>%Type1BuildChar</tt></b>, except perhaps for tracing or
debugging.
</dl>
<dl>
<dt><b><tt><font> <charname> %Type1BuildGlyph -</tt></b>
<dd>Provides the Type 1 implementation of <b><tt>BuildGlyph</tt></b>.
</dl>
<h3><a name="Other"></a>Other operators</h3>
<h4><a name="Mathematical"></a>Mathematical operators</h4>
<dl>
<dt><b><tt><number> arccos <number></tt></b>
<dd>Computes the arc cosine of a number between -1 and 1.
</dl>
<dl>
<dt><b><tt><number> arcsin <number></tt></b>
<dd>Computes the arc sine of a number between -1 and 1.
</dl>
<h4><a name="Dictionary"></a>Dictionary operators</h4>
<dl>
<dt><b><tt>mark <key1> <value1> <key2> <value2> ... .dicttomark <dict></tt></b>
<dd>Creates and returns a dictionary with the given keys and values. This
is the same as the PostScript Level 2 <b><tt>>></tt></b> operator,
but is available even in Level 1 configurations.
</dl>
<dl>
<dt><b><tt><dict> <key> <value> .forceput - </tt></b>
<dd>Equivalent to <b><tt>put</tt></b>, but works even if
<b><tt>dict</tt></b> is not writable, and (if <b><tt>dict</tt></b> is
<b><tt>systemdict</tt></b> or the current save level is 0) even if
<b><tt>dict</tt></b> is in global VM and <b><tt>key</tt></b> and/or
<b><tt>value</tt></b> is in local VM. <strong>This operator should be used
only initialization code, and only in executeonly procedures: it must not be
accessible after initialization.</strong>
</dl>
<dl>
<dt><b><tt><dict> <key> .forceundef - </tt></b>
<dd>Equivalent to <b><tt>undef</tt></b>, but works even if
<b><tt>dict</tt></b> is not writable. <strong>This operator should be used
only initialization code, and only in executeonly procedures: it must not be
accessible after initialization.</strong>
</dl>
<dl>
<dt><b><tt><dict> <key> .knownget <value> true</tt></b>
<dt><b><tt><dict> <key> .knownget false</tt></b>
<dd>Combines <b><tt>known</tt></b> and <b><tt>get</tt></b> in the
obvious way.
</dl>
<dl>
<dt><b><tt><dict> <integer> .setmaxlength -</tt></b>
<dd>Sets the capacity (<b><tt>maxlength</tt></b>) of a dictionary.
Causes a <b><tt>dictfull</tt></b> error if the dictionary has more
occupied entries than the requested capacity.
</dl>
<h4><a name="String"></a>String and name operators</h4>
<dl>
<dt><b><tt><integer> .bytestring <bytestring></tt></b>
<dd>Allocates and returns a bytestring, a special data type that can be
larger than the maximum size of a string (64K-1 bytes) and can be used in
place of a string with a very few operators.
</dl>
<dl>
<dt><b><tt><name> .namestring <string></tt></b>
<dd>Returns the (read-only) string for a name.
</dl>
<dl>
<dt><b><tt><string> <charstring> .stringbreak <index|null></tt></b>
<dd>Searches for a character in <b><tt>string</tt></b> that appears
somewhere in <b><tt>charstring</tt></b>. If such a character is found,
returns the index of the first such character; if no such character is
found, returns <b><tt>null</tt></b>.
</dl>
<dl>
<dt><b><tt><obj> <pattern> .stringmatch <bool></tt></b>
<dd>Matches <b><tt>obj</tt></b> against a pattern in which '*' matches 0 or
more characters and '?' matches any single character. If
<b><tt>obj</tt></b> is a string or a name, matches its characters against
the pattern; if <b><tt>obj</tt></b> is of any other type, the result is
<b><tt>true</tt></b> if the pattern is the single character "*" and
<b><tt>false</tt></b> otherwise.
</dl>
<dl>
<dt><b><tt><state> <fromString> <toString> .type1encrypt <newState> <toSubstring></tt></b>
<dd>Encrypts <b><tt>fromString</tt></b> according to the algorithm for
Adobe Type 1 fonts, writing the result into <b><tt>toString</tt></b>.
<b><tt>toString</tt></b> must be at least as long as
<b><tt>fromString</tt></b>, or a rangecheck error occurs.
<b><tt>state</tt></b> is the initial state of the encryption algorithm (a
16-bit non-negative integer); <b><tt>newState</tt></b> is the new state of
the algorithm.
</dl>
<dl>
<dt><b><tt><state> <fromString> <toString> .type1decrypt <newState> <toSubstring></tt></b>
<dd>Decrypts <b><tt>fromString</tt></b> according to the algorithm for
Adobe Type 1 fonts, writing the result into <b><tt>toString</tt></b>.
Other specifications are as for <b><tt>type1encrypt</tt></b>.
</dl>
<h4><a name="Relational"></a>Relational operators</h4>
<dl>
<dt><b><tt><number|string> <number|string> max <number|string></tt></b>
<dd>Returns the larger of two numbers or strings.
</dl>
<dl>
<dt><b><tt><number|string> <number|string> min <number|string></tt></b>
<dd>Returns the smaller of two numbers or strings.
</dl>
<h4><a name="File"></a>File operators</h4>
<dl>
<dt><b><tt><file> .filename <string> true</tt></b>
<dt><b><tt><file> .filename false</tt></b>
<dd>If the file was opened by the <b><tt>file</tt></b> or
<b><tt>.tempfile</tt></b> operator, returns the file name and
<b><tt>true</tt></b>; if the file is a filter, returns
<b><tt>false</tt></b>.
</dl>
<dl>
<dt><b><tt><file> .fileposition <integer> true</tt></b>
<dd>Returns the position of <b><tt>file</tt></b>. Unlike the standard
<b><tt>fileposition</tt></b> operator, which causes an error if the file is
not positionable, <b><tt>.fileposition</tt></b> works on all files,
including filters: for non-positionable files, it returns the total number
of bytes read or written since the file was opened.
</dl>
<dl>
<dt><b><tt><string> findlibfile <foundstring> <file> true</tt></b>
<dt><b><tt><string> findlibfile <string> false</tt></b>
<dd>Opens the file of the given name for reading, searching through
directories <a href="Use.htm#Finding_files">as described in the usage
documentation</a>. If the search fails, <b><tt>findlibfile</tt></b> simply
pushes false on the stack and returns, rather than causing an error.
</dl>
<dl>
<dt><b><tt><file> <string> .peekstring <substring> <filled_bool></tt></b>
<dd>Reads bytes from a file like <b><tt>readstring</tt></b>, but also leaves
the bytes in the file buffer so they will be read again by a subsequent read
operation. Currently gives a <b><tt>rangecheck</tt></b> error if
<b><tt>string</tt></b> is larger than the file's buffer.
</dl>
<a name=Tempfile></a>
<dl>
<dt><b><tt><prefix_string|null> <access_string> .tempfile
<string> <file></tt></b>
<dd>Creates and opens a temporary file
like the <b><tt>file</tt></b> operator, also returning the file name. There
are three cases for the <b><tt><prefix_string|null></tt></b> operand:
<ul>
<p>
<li><b><tt>null</tt></b>: create the file in the same directory and with the
same name conventions as other temporary files created by the Ghostscript
implementation on this platform. E.g., the temporary file might be named
<b><tt>/tmp/gs_a1234</tt></b>.
<p>
<li>A string that contains only alphanumeric characters, underline,
and dash: create the file in the standard temporary directory, but use
the
<b><tt><prefix_string></tt></b> as the first part of the file name.
E.g., if <b><tt><prefix_string></tt></b> is <b><tt>xx</tt></b>, the
temporary file might be named <b><tt>/tmp/xxa1234</tt></b>.
<p>
<li>A string that is the beginning of an absolute file name: use the
<b><tt><prefix_string></tt></b> as the first part of the file name.
E.g., if <b><tt><prefix_string></tt></b> is
<b><tt>/my/tmpdir/zz</tt></b>, the temporary file might be named
<b><tt>/my/tmpdir/zza1234</tt></b>.
<p>
When running in <b><tt>SAFER</tt></b> mode, the absolute path must
be one of the strings on the list given by the <b><tt>PermitFileWriting</tt></b>
userparameter. Temporary files created with <b><tt>.tempfile</tt></b> can
be deleted when in SAFER mode, and can be renamed to one of the paths
that is on <b>both</b> the PermitFileControl and PermitFileWriting
paths.
</ul>
</dl>
<dl>
<dt><b><tt><file> <integer> .unread -</tt></b>
<dd>Pushes back the last-read character onto the front of the file. If the
file is open only for writing, or if the integer argument is not the same
as the last character read from the file, causes an <b><tt>ioerror</tt></b>
error. May also cause an <b><tt>ioerror</tt></b> if the last operation on
the file was not a reading operation. This operator is now deprecated:
use <b><tt>.peekstring</tt></b> in new code.
</dl>
<p>
Ghostscript also supports the following <b><tt>IODevice</tt></b> in
addition to a subset of those defined in the Adobe documentation:
<ul>
<li>
<b><tt>%pipe%command</tt></b>, which opens a pipe on the given command.
This is supported only on operating systems that provide
<b><tt>popen</tt></b> (primarily Unix systems, and not all of those).
<p>
<li>
<b><tt>%disk#%</tt></b>, which emulates the %disk0
through %disk9 devices on some Adobe PostScript printers. This pseudo
device provides a flat filenaming system with a user definable location
for the files (/Root). These devices will only be present if the
diskn.dev feature is specified during the build.
<p>
This feature is intended to allow compatibility with font downloaders
that expect to store fonts on the %disk device of the printer.
<p>
Use of the %disk#% devices requires that the location of files be given
by the user setting the /Root device parameter. The syntax for setting
the /Root parameter is:<pre>
mark /Root (directory_specification) (%disk#) .putdevparams
</pre>
For example, to store the files of the %disk0 device on the directory
/tmp/disk0, use:<pre>
mark /Root (/tmp/disk0/) (%disk0) .putdevparams
</pre>
The files will be stored in the specified directory with arbitrary names.
A mapping file is used to store the association between the file
names given for the file operations on the %diskn# device and the file
that resides in the /Root directory.
</ul>
<h4><a name="Virtual_memory"></a>Virtual memory operators</h4>
<dl>
<dt><b><tt><save> .forgetsave -</tt></b>
<dd>Cancels the effect of a save, making it as though the save never
happened.
</dl>
<h4><a name="Miscellaneous"></a>Miscellaneous operators</h4>
<dl>
<dt><b><tt><array> bind <array></tt></b>
<dd>Depending on the command line parameters <b><tt>bind</tt></b> is redefined as:
</dl>
<blockquote><table cellpadding=0 cellspacing=0>
<tr valign=bottom>
<th valign=bottom align=left>Flag
<td>
<th valign=bottom align=left>Definition
<tr> <td colspan=3><hr>
<tr valign=top> <td>NOBIND
<td>
<td>/bind {} def ;
no operation, returns the argument
<tr valign=top> <td>DELAYBIND
<td>
<td>returns the argument, stores the argument for later use by <b><tt>.bindnow</b></tt>
</table></blockquote>
<dl>
<dt><b><tt><array> .bind <array></tt></b>
<dd>Performs standard <b><tt>bind</tt></b> operation as defined in PLRM regardless of
NOBIND or DELAYBIND flags.
</dl>
<a name="bindnow"></a>
<dl>
<dt><b><tt>- .bindnow -</tt></b>
<dd>Applies <b><tt>bind</tt></b> operator to all savad procedures after binding has been
deferred through -dDELAYBIND. Note that idiom recognition has no effect for the deferred
binding because the value returned from <b><tt>bind</tt></b> is discarded.
<p>
Since v. 8.12 <b><tt>.bindnow</tt></b> undefines itself and restores standard definition of
<b><tt>bind</tt></b> operator. In earlier versions after calling <b><tt>.bindnow</tt></b>,
the postscript <b><tt>bind</tt></b> operator needs to be rebound to the internal implementation
<b><tt>.bind</tt></b>, as in this fragment from the ps2ascii script:
<blockquote><pre><tt>DELAYBIND {
.bindnow
/bind /.bind load def
} if
</tt></pre></blockquote>
This is necessary for correct behavior with later code that uses the <b><tt>bind</tt></b> operator.
</dl>
<dl>
<dt><b><tt><obj1> <obj2> ... <objn> <n> .execn ...</tt></b>
<dd>This executes <b><tt>obj1</tt></b> through <b><tt>objn</tt></b> in that
order, essentially equivalent to
<blockquote><pre>
<obj1> <obj2> ... <objn> <n> array astore {exec} forall
</pre></blockquote>
<p>
except that it doesn't actually create the array.
</dl>
<dl>
<dt><b><tt><string> getenv <string> true</tt></b>
<dt><b><tt><string> getenv false</tt></b>
<dd>Looks up a name in the shell environment. If the name is found,
returns the corresponding value and true; if the name is not found, returns
false.
</dl>
<dl>
<dt><b><tt><name> <array> .makeoperator <operator></tt></b>
<dd>Constructs and returns a new operator that is actually the given
procedure in disguise. The name is only used for printing. The operator
has the executable attribute.
<p>
Operators defined in this way do one other thing besides running the
procedure: if an error occurs during the execution of the procedure, and
there has been no net reduction in operand or dictionary stack depth, the
operand or dictionary stack pointer respectively is reset to its position
at the beginning of the procedure.
</dl>
<dl>
<dt><b><tt><string> <boolean> .setdebug -</tt></b>
<dd>If the Ghostscript interpreter was built with the <b><tt>DEBUG</tt></b>
flag set, sets or resets any subset of the debugging flags normally
controlled by <b><tt>-Z</tt></b> in the command line. Has no effect
otherwise.
</dl>
<dl>
<dt><b><tt>- .oserrno <errno></tt></b>
<dd>Returns the error code for the most recent operating system error.
</dl>
<dl>
<dt><b><tt>- .oserrorstring <string></tt></b>
<dd>Returns the error string for the most recent operating system error.
</dl>
<a name="Runandhide"></a>
<dl>
<dt><b><tt><array> <procedure> .runandhide ... <array></tt></b>
<dd>Runs the <i><tt><procedure></tt></i> after removing the
<i><tt><array></tt></i> from the stack. As long as <i><tt><array></tt></i>
is not contained in any readable dictionaries or elsewhere on stacks, it
will not be accessible to <i><tt><procedure></tt></i>.
<p>
This operator is intended to allow hiding a <i><tt><save></tt></i> object
during execution of procedures or files that run in <b>SAFER</b> mode.
If a <b><tt>save</tt></b> is performed prior to entering <b>SAFER</b> mode
with <b><tt>.setsafe</tt></b>, using the save object as the operand to
<b><tt>restore</tt></b> will return to <b>NOSAFER</b> mode. In order to
prevent the procedures running in <b>SAFER</b> mode from being able to
return to <b>NOSAFER</b> mode, this operator should be used.
Upon return from the file or procedure <b><tt>restore</tt></b> can be used
to return to <b>NOSAFER</b> mode.
<p>
<b>Note:</b> The array operand hidden during the execution of the file or
procedure will be placed at the top of the operand stack which may be on
top of objects that the file or procedure leaves on top of the stack.
Thus removing objects below the array may be needed to prevent an
<b><tt>invalidrestore</tt></b> error.
<p>
For example, in order for a script or job server to execute a file
<tt>somefile.ps</tt> with the <b>SAFER</b> mode restrictions in place, returning
to unrestricted <b>NOSAFER</b> mode when the procedure exits is as follows:
<pre>
Start Ghostscript with <b>-dNOSAFER</b>
... % perform any device set up w/o restrictions
[ save ] % create a save object before SAFER
(somefile.ps) (r) file cvx % open the file to process
.setsafe % enter SAFER mode
.runandhide % run the file hiding the save object
count 1 roll % place array below anything left over
count 1 sub { pop } repeat % pop left over stuff
cleardictstack % prevent invalidrestore from dicts
0 get restore % go back to NOSAFER mode
</pre>
Another refinement on the above would be to execute <b><tt>.runandhide</tt></b>
using <b><tt>stopped</tt></b> in order to report errors but continue processing.
</dl>
<dl>
<dt><b><tt>- .setsafe -</tt></b>
<dd>If Ghostscript is started with <b><tt>-dNOSAFER</tt></b> or
<b><tt>-dDELAYSAFER</tt></b>, this operator can be used to enter <b>SAFER</b>
mode (see <a href="Use.htm#Safer"><b>-dSAFER</b></a>)
<p>
Since <b>SAFER</b> mode is implemented with userparameters and device parameters,
it is possible to use <b><tt>save</tt></b> and <b><tt>restore</tt></b> before
and after <b><tt>.setsafe</tt></b> to return to <b>NOSAFER</b> mode, but care
should be taken to ensure that the <i><tt>save</tt></i> object is not
accessible to any procedures or file run in <b>SAFER</b> mode (see
<a href="#Runandhide"><b>.runandhide</b></a> above).
<p>
<b>Note: This uses setpagedevice to change .LockSafetyParams, so the page
will be erased as a side effect of this operator</b>
</dl>
<dl>
<dt><b><tt>- .locksafe -</tt></b>
<dd>
This operator sets the current device's <b><tt>.LockSafetyParams</tt></b>
and the <b><tt>LockFilePermissions</tt></b> userparameter true as well as
adding the paths on LIBPATH and FONTPATH and the paths given by the
system params /GenericResourceDir and /FontResourceDir to the current
PermitFileReading list of paths.
<p>
If Ghostscript is started with <b><tt>-dNOSAFER</tt></b> or
<b><tt>-dDELAYSAFER</tt></b>, this operator can be used to enter <b>SAFER</b>
mode with the current set of <b><tt>PermitFile...</tt></b> user parameters
in effect. Since <b><tt>.setsafe</tt></b> sets the <b><tt>PermitFile...</tt></b>
user parameters to empty arrays, a script or job server that needs to
enable certain paths for file Reading, Writing and/or Control can use this
operator to perform the locking needed to enter <b>SAFER</b> mode.
<p>
For example, to enable reading everywhere, but disallow writing and file
control (deleting and renaming files), the following can be used:
<pre>
{ << /PermitFileReading [ (*) ]
/PermitFileWriting [ ]
/PermitFileControl [ ]
>> setuserparams
.locksafe
} stopped pop
</pre>
In the above example, use of stopped will allow the use of this sequence on
older versions of Ghostscript where <b><tt>.locksafe</tt></b> was not an operator.
<p>
<b>Note: This uses setpagedevice to change .LockSafetyParams, so the page
will be erased as a side effect of this operator</b>
<p>
See also <a href="#LockSafetyParams">.LockSafetyParams</a> and
<a href="#User_parameters">User Parameters</a>.
<p>
</dl>
<dl><a name=".setpdfwrite"></a>
<dt><b><tt>.setpdfwrite</tt></b></dt>
<dd>This operator conditions the environment for the <tt>pdfwrite</tt> output device.
It is a shorthand for setting parameters that have been deemed benificial. While not strictly necessary, it is usually helpful to set call this when using the pdfwrite device.
For example, this is how the ps2pdf script calls Ghostscript:
<blockquote><b><tt>
gs -q -dSAFER -dNOPAUSE -dBATCH -sOutputFile=file.pdf </tt></b><em>[more options]</em><b><tt> \<br>
-sDEVICE=pdfwrite -c .setpdfwrite -f </b></tt><em>source1.ps [more files]</em>
</blockquote>
<p>Currently, the operator just sets a minimum 3 MB vmthreshold to allow for
accumulating shared object data and to reduce the incidence of garbage
collection as a performance improvement. Additional settings may be added in the future.
</dl>
<dl>
<dt><b><tt>.color_test</tt></b> and <b><tt>.color_test_all</tt></b></dt>
<dd>These operators are used for the verification of device encode_color and
decode_color routines. They are for internal use only. Their function
can, and probably will, change as Artifex's requirements change.
<p>
<dd>Currently these operators loop through a set of possible values for the inputs
to the encode_color routine and then veify that the decode_color routines produce
values that match the input set to within a tolerance which is based upon the number
of bits used to encode a pixel. The operators also verify that if the device
is 'separable' then that the values produced by gx_default_encode_color and
gx_default_decode_color (the default encode/decode color handlers for a separable
device) are consistent to within the same tolerance.
</dl>
<h4><a name="Device"></a>Device operators</h4>
<dl>
<dt><b><tt><device> copydevice <device></tt></b>
<dd>Copies a device. The copy is writable and installable. The copy is
created in the current VM (local or global), usually local VM for executing
ordinary PostScript files.
</dl>
<dl>
<dt><b><tt><devicename> finddevice <device></tt></b>
<dd>Creates a default instance of a device specified by name. The instance
is created in global VM. If <b><tt>finddevice</tt></b> is called more than
once with the same device name, it creates the default instance the first
time, and returns the same instance thereafter.
</dl>
<dl>
<dt><b><tt><devicename> findprotodevice <device></tt></b>
<dd>Finds the prototype of a device specified by name. A prototype can be
used with <b><tt>.getdeviceparams</tt></b> or other parameter-reading
operators, but it is read-only and cannot be set with
<b><tt>setdevice</tt></b>: it must be copied first.
</dl>
<dl>
<dt><b><tt><device> <x> <y> <width> <max_height> <alpha?> <std_depth|null> <string> .getbitsrect <height> <substring></tt></b>
<dd>Reads a rectangle of rendered bits back from a device. This is only
guaranteed to be implemented for image devices (see below).
<b><tt>alpha?</tt></b> is 0 for no alpha, -1 for alpha first, 1 for alpha
last. <b><tt>std_depth</tt></b> is null for native pixels, number of bits
per component for a standard color space.
</dl>
<dl>
<dt><b><tt><index> .getdevice <device></tt></b>
<dd>Returns a device from the set of devices known to the system. The
first device, which is the default, is numbered 0. If the
<b><tt>index</tt></b> is out of range, causes a <b><tt>rangecheck</tt></b>
error. This device is actually a prototype, not a directly usable device,
and is marked read-only; it cannot have its parameters changed or be
installed as the current device.
</dl>
<dl>
<dt><b><tt><matrix> <width> <height> <palette> makeimagedevice <device></tt></b>
<dd>Makes a new device that accumulates an image in memory. <b><tt>
matrix</tt></b> is the initial transformation matrix: it must be orthogonal
(that is, [a 0 0 b x y] or
[0 a b 0 x y]). <b><tt>palette</tt></b> is a
string of 2^<small><sup><b>N</b></sup></small> or
3 × 2^<small><sup><b>N</b></sup></small> elements,
specifying how the 2^<small><sup><b>N</b></sup></small> possible pixel
values will be interpreted. Each element is interpreted as a gray value,
or as RGB values, multiplied by 255. For example, if you want a monochrome
image for which 0=white and 1=black, the palette should be
<b><tt><ff 00></tt></b>; if you want a 3-bit deep image with
just the primary colors and their complements (ignoring the fact that 3-bit
images are not supported), the palette might be <b><tt><000000 0000ff
00ff00 00ffff ff0000 ff00ff ffff00 ffffff></tt></b>. At present, the
palette must contain exactly 2, 4, 16, or 256 entries, and must contain an
entry for black and an entry for white; if it contains any entries that
aren't black, white, or gray, it must contain at least the six primary
colors (red, green, blue, and their complements cyan, magenta, and yellow);
aside from this, its contents are arbitrary.
<p>
Alternatively, palette can be 16, 24, 32, or null (equivalent to 24).
These are interpreted as:
<blockquote><table cellpadding=0 cellspacing=0>
<tr valign=bottom>
<th valign=bottom align=left>Palette
<td>
<th valign=bottom align=left>Bits allocated per color
<tr> <td colspan=3><hr>
<tr valign=top> <td>16
<td>
<td>5 red, 6 green, 5 blue
<tr valign=top> <td>24
<td>
<td>8 red, 8 green, 8 blue
<tr valign=top> <td>32
<td>
<td>8C, 8M, 8Y, 8K
</table></blockquote>
<p>
Note that one can also make an image device (with the same palette as an
existing image device) by copying a device using the
<b><tt>copydevice</tt></b> operator.
</dl>
<dl>
<dt><b><tt><matrix> <width> <height> <palette> <word?> makewordimagedevice <device></tt></b>
<dd>Makes an image device as described above. <b><tt>word?</tt></b> is a
Boolean value indicating whether the data should be stored in a
word-oriented format internally. No ordinary PostScript programs should
use this operator.
</dl>
<dl>
<dt><b><tt><device> <index> <string> copyscanlines <substring></tt></b>
<dd>Copies one or more scan lines from an image device into a string,
starting at a given scan line in the image. The data is in the same format
as for the <b><tt>image</tt></b> operator. It is an error if the device is
not an image device or if the string is too small to hold at least one
complete scan line. Always copies an integral number of scan lines.
</dl>
<dl>
<dt><b><tt><device> setdevice -</tt></b>
<dd>
<p>
Sets the current device to the specified device. Also resets the
transformation and clipping path to the initial values for the device.
Signals an <b><tt>invalidaccess</tt></b> error if the device is a
prototype or if <a href="Language.htm#LockSafetyParams">.LockSafetyParams</a>
is true for the current device.
<p>
Some device properties may need to be set with <tt>putdeviceprops</tt> before
<b><tt>setdevice</tt></b> is called. For example, the pdfwrite device will try
to open its output file, causing an <tt>undefinedfilename</tt> error if
<tt>OutputFile</tt> hasn't been set to a valid filename. Another method in such
cases is to use the level 2 operator instead:
<tt><< /OutputDevice /pdfwrite /OutputFile (MyPDF.pdf) >> <b>setpagedevice</b></tt>.
</dl>
<dl>
<dt><b><tt>- currentdevice <device></tt></b>
<dd>Gets the current device from the graphics state.
</dl>
<dl>
<dt><b><tt><device> getdeviceprops <mark> <name1> <value1> ... <namen> <valuen></tt></b>
<dd>Gets the properties of a device. See the section on
<a href="#Device_parameters">device parameters</a> below for details.
</dl>
<dl>
<dt><b><tt><mark> <name1> <value1> ... <namen> <valuen> <device> putdeviceprops <device></tt></b>
<dd>Sets properties of a device. May cause <b><tt>undefined</tt></b>,
<b><tt>invalidaccess</tt></b>, <b><tt>typecheck</tt></b>, <b><tt>rangecheck</tt></b>, or
<b><tt>limitcheck</tt></b> errors.
</dl>
<dl>
<dt><b><tt>- flushpage -</tt></b>
<dd>On displays, flushes any buffered output, so that it is guaranteed to
show up on the screen; on printers, has no effect.
</dl>
<hr>
<h2><a name="Filters"></a>Filters</h2>
<h3><a name="Standard_filters"></a>Standard filters</h3>
<p>
In its usual configuration, Ghostscript supports all the standard PostScript
LanguageLevel 3 filters, both encoding and decoding, except that it does not
currently support:
<ul>
<li>the <b><tt>EarlyChange</tt></b> key in the <b><tt>LZWEncode</tt></b>
filter.
</ul>
<p>
Ghostscript also supports additional keys in the optional dictionary
operands for some filters. For the <b><tt>LZWDecode</tt></b> filter:
<dl>
<dt><b><tt>InitialCodeLength <integer></tt></b> (default 8)
<dd>An integer between 2 and 11 specifying the initial number of data bits
per code. Note that the actual initial code length is 1 greater than this,
to allow for the reset and end-of-data code values.
</dl>
<dl>
<dt><b><tt>FirstBitLowOrder <boolean></tt></b> (default false)
<dd>If true, codes appear with their low-order bit first.
</dl>
<dl>
<dt><b><tt>BlockData <boolean></tt></b> (default false)
<dd>If true, the data is broken into blocks in the manner specified for the
GIF file format.
</dl>
<p>
For the <b><tt>CCITTFaxEncode</tt></b> and <b><tt>CCITTFaxDecode</tt></b>
filters:
<dl>
<dt><b><tt>DecodedByteAlign <integer></tt></b> (default 1)
<dd>An integer <b>N</b> with the value 1, 2, 4, 8, or 16, specifying that
decoded data scan lines are always a multiple of <b>N</b> bytes. The
encoding filter skips data in each scan line from Columns to the next
multiple of <b>N</b> bytes; the decoding filter pads each scan line to a
multiple of <b>N</b> bytes.
</dl>
<h3><a name="Non_standard_filters"></a>Non-standard filters</h3>
<p>
In addition to the standard PostScript LanguageLevel 3 filters, Ghostscript
supports the following non-standard filters. Many of these filters are used
internally to implement standard filters or facilities; they are almost
certain to remain, in their present form or a backward-compatible one, in
future Ghostscript releases.
<dl>
<dt><b><tt><target> /BCPEncode filter <file></tt></b>
<dt><b><tt><source> /BCPDecode filter <file></tt></b>
<dd>Create filters that implement the Adobe Binary Communications Protocol.
See Adobe documentation for details.
</dl>
<dl>
<dt><b><tt><target> <seed_integer> /eexecEncode filter <file></tt></b>
<dd>Creates a filter for encrypting data into the encrypted format described
in the Adobe Type 1 Font Format documentation. The
<b><tt>seed_integer</tt></b> must be 55665 for the <b><tt>eexec</tt></b>
section of a font, or 4330 for a <b><tt>CharString</tt></b>. Note that for
the <b><tt>eexec</tt></b> section of a font, this filter produces binary
output and does not include the initial 4 (or <b><tt>lenIV</tt></b>) garbage
bytes.
</dl>
<dl>
<dt><b><tt><source> <seed_integer> /eexecDecode filter <file></tt></b>
<dt><b><tt><source> <dict> /eexecDecode filter <file></tt></b>
<dd>Creates a filter for decrypting data encrypted as described in the Adobe
Type 1 Font Format documentation. The <b><tt>seed_integer</tt></b> must be
55665 or 4330 as described just above. Recognized dictionary keys are:
<blockquote>
<b><tt>seed <16-bit integer></tt></b> (required)<br>
<b><tt>lenIV <non-negative integer></tt></b> (default=4)<br>
<b><tt>eexec <bool></tt></b> (default=<b><tt>false</b></tt>)
</blockquote>
</dl>
<dl>
<dt><b><tt><target> /MD5Encode filter <file></tt></b>
<dd>Creates a filter that produces the 16-byte MD5 digest of the input.
Note that no output is produced until the filter is closed.
</dl>
<dl>
<dt><b><tt><source> <hex_boolean> /PFBDecode filter <file></tt></b>
<dd>Creates a filter that decodes data in <b><tt>.PFB</tt></b> format, the
usual semi-binary representation for Type 1 font files on IBM PC and
compatible systems. If <b><tt>hex_boolean</tt></b> is true, binary packets
are converted to hex; if false, binary packets are not converted.
</dl>
<dl>
<dt><b><tt><target> <dict> /PixelDifferenceEncode filter <file></tt></b>
<dt><b><tt><source> <dict> /PixelDifferenceDecode filter <file></tt></b>
<dd>Implements the Predictor=2 pixel-differencing option of the LZW
filters. Recognized keys are:
<blockquote>
<b><tt>Colors <integer></tt></b> (1 to 4, default=1)<br>
<b><tt>BitsPerComponent <integer></tt></b> (1, 2, 4, or 8, default=8)<br>
<b><tt>Columns <integer></tt></b> (>= 0, required)
</blockquote>
<p>
See the Adobe <a
href="http://partners.adobe.com/asn/developer/acrosdk/DOCS/pdfspec.pdf"><em>Portable
Document Format Reference Manual</em></a> for details.
</dl>
<dl>
<dt><b><tt><target> <dict> /PNGPredictorEncode filter <file></tt></b>
<dt><b><tt><source> <dict> /PNGPredictorDecode filter <file></tt></b>
<dd>Implements the "filter" algorithms of the
<a href="http://www.libpng.org/pub/png/">Portable Network Graphics (PNG)
graphics format</a>. Recognized keys are:
<blockquote><table cellpadding=0 cellspacing=0>
<tr><th colspan=5 bgcolor="#CCCC00"><hr><font size="+1">Keys recognized in PNG filter algorithms</font><hr>
<tr valign=bottom>
<th align=left>Key
<td>
<th align=left>Range
<td>
<th align=left>Default
<tr> <td colspan=5><hr>
<tr valign=top> <td><b><tt>Colors <integer></tt></b>
<td>
<td>1 to 16
<td>
<td>16
<tr valign=top> <td><b><tt>BitsPerComponent <integer></tt></b>
<td>
<td>1, 2, 4, 8, or 16
<td>
<td>8
<tr valign=top> <td><b><tt>Columns <integer></tt></b>
<td>
<td>>= 0
<td>
<td>1
<tr valign=top> <td><b><tt>Predictor <integer></tt></b>
<td>
<td>10 to 15
<td>
<td>15
</table></blockquote>
<p>
The <b><tt>Predictor</tt></b> is the PNG algorithm number + 10 for the
<b><tt>Encoding</tt></b> filter; the <b><tt>Decoding</tt></b> filter
ignores <b><tt>Predictor</tt></b>. 15 means the encoder attempts to
optimize the choice of algorithm. For more details see the PNG
specification
<blockquote>
<a href="http://www.w3.org/TR/WD-png-960128.html">http://www.w3.org/TR/WD-png-960128.html</a>
</blockquote>
</dl>
<dl>
<dt><b><tt><target> /TBCPEncode filter <file></tt></b>
<dt><b><tt><source> /TBCPDecode filter <file></tt></b>
<dd>Create filters that implement the Adobe Tagged Binary Communications
Protocol. See Adobe documentation for details.
</dl>
<dl>
<dt><b><tt><target> /zlibEncode filter <file></tt></b>
<dt><b><tt><source> /zlibDecode filter <file></tt></b>
<dd>Creates filters that use the data compression method variously known as
'zlib' (the name of a popular library that implements it), 'Deflate' (as in
<a href="http://www.ietf.org/rfc/rfc1951.txt">RFC 1951</a>, which is a
detailed specification for the method), 'gzip' (the name of a popular
compression application that uses it), or 'Flate' (Adobe's name). Note that
the PostScript <b><tt>Flate</tt></b> filters are actually a combination of
this filter with an optional predictor filter.
</dl>
<h3><a name="Unstable_filters"></a>Unstable filters</h3>
<p>
Some versions of Ghostscript may also support other non-standard filters for
experimental purposes. The current version includes the following such
filters, which are not documented further. No code should assume that these
filters will exist in compatible form, or at all, in future versions.
<dl>
<dt><b><tt><target/source> <string> ByteTranslateEncode/Decode filter <file></tt></b>
<dd><b><tt>string</tt></b> must be a string of exactly 256 bytes. Creates a
filter that converts each input byte <em>b</em> to
<b><tt>string</tt></b>[<em>b</em>]. Note that the <b><tt>Encode</tt></b>
and <b><tt>Decode</tt></b> filters operate identically: the client must
provide a <b><tt>string</tt></b> for the <b><tt>Decode</tt></b> filter that
is the inverse mapping of the <b><tt>string</tt></b> for the
<b><tt>Encode</tt></b> filter.
</dl>
<dl>
<dt><b><tt><target/source> <dict> BoundedHuffmanEncode/Decode filter <file></tt></b>
<dd>These filters encode and decode data using Huffman codes. Since these
filters aren't used anywhere, we don't document them further, except to note
the recognized dictionary keys, which must be set identically for encoding
and decoding:
<blockquote>
<b><tt>FirstBitLowOrder <bool></tt></b> (default=false)<br>
<b><tt>MaxCodeLength <int></tt></b> (default=16)<br>
<b><tt>EndOfData <bool></tt></b> (default=true)<br>
<b><tt>EncodeZeroRuns <int></tt></b> (default=256)<br>
<b><tt>Tables <int_array></tt></b>
</blockquote>
</dl>
<dl>
<dt><b><tt><target/source> <dict> BWBlockSortEncode/Decode filter <file></tt></b>
<dd>This filter implements the Burroughs-Wheeler block sorting compression
method, which we've heard is also used in the popular <b><tt>bzip2</tt></b>
compression application. See <a
href="http://sources.redhat.com/bzip2/">http://sources.redhat.com/bzip2/</a>
for more information. The only recognized dictionary key is:
<blockquote>
<b><tt>BlockSize <integer></tt></b> (default=16384)
</blockquote>
</dl>
<dl>
<dt><b><tt><target/source> MoveToFrontEncode/Decode filter <file></tt></b>
<dd>The <b><tt>Encode</tt></b> filter starts by initializing an internal
256-byte array <b><tt>a</tt></b> to the values 0 .. 255. This array will
always hold a permutation of these values. Then for each input byte
<em>b</em>, the filter outputs the index <em>i</em> such that
<b><tt>a</tt></b>[<em>i</em>] = <em>b</em>, and moves that element to the
front (element 0) of <b><tt>a</tt></b>, moving elements 0 .. <em>i-1</em> to
positions 1 .. <em>i</em>. The <b><tt>Decode</tt></b> filter inverts this
process.
</dl>
<hr>
<h2><a name="Device_parameters"></a>Device parameters</h2>
Ghostscript supports the concept of device parameters for all devices, not
just page devices. (For non-page devices, these are accessible through
<b><tt>getdeviceprops</tt></b> and <b><tt>putdeviceprops</tt></b>, as
indicated above.) Here are the currently defined parameters for all
devices:
<dl>
<a name="LockSafetyParams"></a>
<dt><b><tt>.LockSafetyParams <boolean></tt></b>
<dd>This parameter allows for improved system security by preventing
PostScript programs from being able to change potentially dangerous
device paramters such as OutputFile. This parameter cannot be set false
if it is already true.
<p>
If this parameter is true for the current device, attempt to set a new
device that has <b><tt>.LockSafetyParams</tt></b> false will signal an
<tt><b> invalidaccess</b></tt> error.
</dl>
<dl>
<dt><b><tt>BitsPerPixel <integer> (usually read-only)</tt></b>
<dd>Number of bits per pixel.
</dl>
<dl>
<dt><b><tt>.HWMargins [<four floats>]</tt></b>
<dd>Size of non-imageable regions around the edges of the page, in points
(units of 1/72in; see the <a href="Devices.htm#Measurements">notes on
measurements</a> in the documentation on devices).
</dl>
<dl>
<dt><b><tt>HWSize [<integer> <integer>]</tt></b>
<dd>X and Y size in pixels.
</dl>
<dl>
<dt><b><tt>Name <string> (read-only)</tt></b>
<dd>The device name. Currently the same as <b><tt>OutputDevice</tt></b>.
</dl>
<dl>
<dt><b><tt>Colors, GrayValues, RedValues, GreenValues, BlueValues, ColorValues (usually read-only)</tt></b>
<dd>As for the <b><tt>deviceinfo</tt></b> operator of Display PostScript.
<b><tt>Red</tt></b>, <b><tt>Green</tt></b>, <b><tt>Blue</tt></b>, and
<b><tt>ColorValues</tt></b> are only defined if
<b><tt>Colors</tt></b> > 1.
</dl>
<dl>
<dt><b><tt>TextAlphaBits, GraphicsAlphaBits (usually read-only)</tt></b>
<dd>The number of bits of anti-aliasing information for text or graphics
respectively. Legal values are 1 (no anti-aliasing, the default for most
devices), 2, or 4.
</dl>
<p>
Ghostscript also supports the following read-only parameter that is not a
true device parameter:
<dl>
<dt><b><tt>.EmbedFontObjects <integer></tt></b>
<dd>If non-zero, indicates that the device may embed font objects (as
opposed to bitmaps for individual characters) in the output. The purpose of
this parameter is to disable third-party font renderers for such devices.
(This is zero for almost all devices.)
</dl>
<p>
In addition, the following are defined per Adobe's documentation for the
<b><tt>setpagedevice</tt></b> operator:
<blockquote>
<b><tt>Duplex</tt></b> (if supported)<br>
<b><tt>HWResolution</tt></b><br>
<b><tt>ImagingBBox</tt></b><br>
<b><tt>Margins</tt></b><br>
<b><tt>NumCopies</tt></b> (for printers only)<br>
<b><tt>Orientation</tt></b> (if supported)<br>
<b><tt>OutputDevice</tt></b><br>
<b><tt>PageOffset</tt></b> (write-only)<br>
<b><tt>PageSize</tt></b><br>
<b><tt>ProcessColorModel</tt></b> (usually read-only)<br>
</blockquote>
<p>
Some devices may only allow certain values for <b><tt>HWResolution</tt></b>
and <b><tt>PageSize</tt></b>. The null device ignores attempts to set
<b><tt>PageSize</tt></b>; its size is always <b><tt>[0 0]</tt></b>.
<p>
It should be noted that calling <tt>setpagedevice</tt> with one of the above keys may reset the effects of any <b><tt>pdfmark</tt></b> commands up to that point. In particular this is true of HWResolution, a behavior that differs from Adobe Distiller.
<p>
For printers these are also defined:
<dl>
<dt><b><tt>BufferSpace <integer></tt></b>
<dd>Buffer space for band lists, if the bitmap is too big to fit in memory.
</dl>
<dl>
<dt><b><tt>MaxBitmap <integer></tt></b>
<dd>Maximum space for a full bitmap in memory.
</dl>
<dl>
<dt><b><tt>OutputFile <string></tt></b>
<dd>An empty string means "send to printer directly", otherwise specifies
the file name for output; <b><tt>%d</tt></b> is replaced by the page number
for page-oriented output devices;
on Unix systems <b><tt>%pipe%</tt></b><em>command</em> writes to a pipe.
(<b><tt>|</tt></b><em>command</em> also writes to a pipe, but is now
deprecated.)
<p>
Attempts to set this parameter if <tt><b>.LockSafetyParams</b></tt> is true
will signal an <tt><b>invalidaccess</b></tt> error.
</dl>
<dl>
<dt><b><tt>OpenOutputFile <boolean></tt></b>
<dd>If true, open the device's output file when the device is opened,
rather than waiting until the first page is ready to print.
</dl>
<dl>
<dt><b><tt>PageCount <integer> (read-only)</tt></b>
<dd>Counts the number of pages printed on the device.
</dl>
<p>
The following parameters are for use only by very specialized applications
that separate band construction from band rasterization. Improper use may
cause unpredictable errors. In particular, if you only want to allocate
more memory for banding, to increase band size and improve performance, use
the <b><tt>BufferSpace</tt></b> parameter, not
<b><tt>BandBufferSpace</tt></b>.
<dl>
<dt><b><tt>BandHeight <integer></tt></b>
<dd>The height of bands when banding. 0 means use the largest band height
that will fit within the BandBufferSpace (or BufferSpace, if
BandBufferSpace is not specified).
</dl>
<dl>
<dt><b><tt>BandWidth <integer></tt></b>
<dd>The width of bands in the rasterizing pass, in pixels. 0 means use the
actual page width.
</dl>
<dl>
<dt><b><tt>BandBufferSpace <integer></tt></b>
<dd>The size of the band buffer in the rasterizing pass, in bytes. 0 means
use the same buffer size as for the interpretation pass.
</dl>
<p>
Ghostscript supports the following parameter for
<b><tt>setpagedevice</tt></b> and <b><tt>currentpagedevice</tt></b> that is
not a device parameter per se:
<dl>
<dt><b><tt>ViewerPreProcess <procedure></tt></b>
<dd>Specifies a procedure to be applied to the page device dictionary
before any other processing is done. The procedure may not alter the
dictionary, but it may return a modified copy. This "hook" is provided for
use by viewing programs such as GSview.
</dl>
<hr>
<h2><a name="User_parameters"></a>User parameters</h2>
Ghostscript supports the following non-standard user parameters:
<dl>
<dt><b><tt>ProcessDSCComment <procedure|null></tt></b>
<dd>If not null, this procedure is called whenever the scanner detects a DSC
comment (comment beginning with <b><tt>%%</tt></b> or <b><tt>%!</tt></b>).
There are two operands, the file and the comment (minus any terminating
EOL), which the procedure must consume.
</dl>
<dl>
<dt><b><tt>ProcessComment <procedure|null></tt></b>
<dd>If not null, this procedure is called whenever the scanner detects a
comment (or, if <b><tt>ProcessDSCComment</tt></b> is also not null, a
comment other than a DSC comment). The operands are the same as for
<b><tt>ProcessDSCComment</tt></b>.
</dl>
<dl>
<dt><b><tt>LockFilePermissions <boolean></tt></b>
<dd>If <tt>true</tt>, this parameter and the three <tt>PermitFile...</tt>
parameters cannot be changed. Attempts to change any of the values
when LockFilePermissions is <tt>true</tt> will signal <b><tt>invalidaccess</tt></b>.
Also, when this value is <tt>true</tt>, the <b><tt>file</tt></b> operator
will give <b><tt>invalidaccess</tt></b> when attempting to open files
(processes) using the <b><tt>%pipe</tt></b> device.
<p>
Also when <b><tt>LockFilePermissions</tt></b> is <tt>true</tt>, strings
cannot reference the parent directory (platform specific). For example
<b><tt>(../../xyz)</tt></b> is illegal on unix, Windows
and Macintosh, and <b><tt>([.#.#.XYZ])</tt></b> is illegal on VMS.
<p>
This parameter is set <tt>true</tt> by the <b><tt>.setsafe</tt></b> and
<b><tt>.locksafe</tt></b> operators.
</dl>
<dl>
<dt><b><tt>PermitFileReading <array of strings></tt></b>
<dt><b><tt>PermitFileWriting <array of strings></tt></b>
<dt><b><tt>PermitFileControl <array of strings></tt></b>
<dd>These parameters specify paths where file reading, writing and the
'control' operations are permitted, respectively. File control
operations are <b><tt>deletefile</tt></b> and <b><tt>renamefile</tt></b>.
For <b><tt>renamefile</tt></b>, the filename for the current filename
must match one of the paths on the PermitFileControl list, and the
new filename must be on <b>both</b> the PermitFileControl and the
PermitFileWriting lists of paths.
<p>
The strings can contain wildcard characters as for the <b><tt>filenameforall</tt></b>
operator and unless specifying a single file, will end with a <b>*</b>
for directories (folders) to allow access to all files and sub-directories
in that directory.
<p>
<b>Note:</b> The strings are used for stringmatch operations similar
to <b><tt>filenameforall</tt></b>, thus on MS Windows platforms, use the '/'
character to separate directories and filenames or use '\\\\' to
have the string contain '\\' which will match a single '\' in the
target filename (use of '/' is strongly recommended).
<p>
The <a href=Use.htm#Safer><b>SAFER</b></a> mode and the
<b><tt>.setsafe</tt></b> operator set all three lists to empty arrays,
thus the only files that can be read are the <b><tt>%stdin</tt></b> device and
on LIBPATH or FONTPATH or the Resource paths specified by the /FontResourceDir
or /GenericResourceDir system params. Files cannot be opened for writing
anywhere and cannot be deleted or renamed except for files created with the
<a href=#Tempfile><b>.tempfile</b></a> operator).
<p>
<b>Note: </b>Limiting file reading as above is <b>NOT</b> compatible with
SAFER mode in release versions before 7.11 and corresponds to the use of
<b><tt>-dPARANOIDSAFER</tt></b> in version 7.04 (up to and not including
version 7.10) and GPL versions 6.53 (up to and not including 6.60).
</dl>
<dl>
<dt><b><tt>AlignToPixels <integer></tt></b>
<dd>Control sub-pixel positioning of character glyphs (where
applicable). A value of 1 specifies alignment of text characters to
pixels boundaries. A value of 0 to subpixels where the division factor
is set by the device parameter <b><tt>TextAlphaBits</tt></b>. If the
latter is 1, the same rendering results regardless of the value of
<b><tt>AlignToPixels</tt></b>. The initial value defaults to 1, but this
may be overridden by the command line argument
<b><tt>-dAlignToPixels</tt></b>.
</dl>
<dl>
<a name="GridFitTT"></a>
<dt><b><tt>GridFitTT <integer></tt></b>
<dd>Control the use of True Type grid fitting.
Ghostscript implements a reduced True Type bytecode interpreter,
which can interpret the subset of True Type glyph instructions
not covered by Apple's patents. This allows proper rasterization
of the Dynalab fonts.
<p>
The reduced interpreter can't properly grid fit
fonts with patented instructions. Therefore Ghostscript implements
another grid fitting method for True Type fonts, based on a spot topology analysis.
<p>
This parameter controls the action of the reduced interpreter and the grid fitter:
<ul>
<li>
A value of 0 disables grid fitting for all True Type fonts. This is a backward compatibility mode.
</li>
<li>
A value of 1 enables the grid fitting for glyphs that don't involve
patented instructions, using the reduced True Type bytecode interpreter.
When a patented instruction is encountered, a warning is printed to stderr,
and the glyph is rendered ignoring the entire grid fitting program.
</li>
<li>
A value of 2 invokes the topological grid fitter. This value is recommended
for common use.
</li>
<li>
A value of 3 specifies that the bytecode interpreter to be used
to grid fit glyphs that have no patented instructions,
and other glyphs are grid fitted topologically. This mode may
improve the rendering of some fonts, but in general the best result
is not guaranteed.
</li>
</ul>
<p>
This parameter defaults to 2, but this
may be overridden on the command line with
<b><tt>-dGridFitTT=n</tt></b>.
<p>
The reduced bytecode interpreter is based in part of the work of the
<a href="http://freetype.org/">FreeType</a> Team.
The topological grid fitting is a new original Ghostscript method.
</dl>
<dl>
<dt><b><tt>UseWTS <boolean></tt></b>
<dd>If <tt>true</tt>, and if AccurateScreens are specified (either as
a user parameter, or as a type 1 halftone dictionary parameter), then
the Well Tempered Screening algorithm is used for
halftoning. Otherwise, a rational tangent algorithm is chosen, which
will typically result in significant differences between the screen
angle and ruling requested, and actually rendered. Currently, the
performance of WTS is reasonably good when rendering to a full page
buffer, but not optimized for banded mode. Thus, when using WTS,
disable banding (setting
<b><tt>-dMaxBitmap=500000000</tt></b> should work). In a future
version, WTS will be optimized for banded mode, and
<b><tt>UseWTS</tt></b> will be <tt>true</tt> by default.
<p>
<b>Note:</b> Currently, <b><tt>UseWTS</tt></b> can only be set using
the PostScript user parameters mechanism, not on the command line with
a <b><tt>-d</tt></b> switch. Use this code to enable it:
<blockquote><pre>
<< /UseWTS true >> setuserparams
</pre></blockquote>
</dl>
<hr>
<h2><a name="Miscellaneous_additions"></a>Miscellaneous additions</h2>
<h3><a name="Extended_semantics_of_run"></a>Extended semantics of 'run'</h3>
<p>
The operator <b><tt>run</tt></b> can take either a string or a file as its argument. In
the latter case, it just runs the file, closing it at the end, and trapping
errors just as for the string case.
<h3><a name="DecodingResources"></a>Decoding resources</h3>
<p>
<b><tt>Decoding</tt></b> is a Ghostscript-specific resource category. It contains
various resources for emulating PostScript fonts with other font technologies.
Instances of the <tt>Decoding</tt> category are tables which map PostScript glyph
names to character codes used with TrueType, Intellifont, Microtype and other font formats.
<p>
Currently Ghostscript is capable of PostScript font emulation in 2 ways :
<li>
1. Through <a href="./Use.htm#FAPI_run">FAPI</a> plugins, and
</li>
<li>
2. With TrueType font files, using the native font renderer, by
specifying TrueType font names or files in <a href="../lib/Fontmap">lib/Fontmap</a>.
</li>
<p>
<b><tt>Decoding</tt></b> resources are not current used by the native font renderer.
<p>
An instance of the <b><tt>Decoding</tt></b> resource category is
a dictionary. The dictionary keys are PostScript glyph names and the
values are character codes. The name of the resource instance should
reflect the character set for which it maps. For example,
<b><tt>/Unicode</tt></b> <b><tt>/Decoding</tt></b> resource maps to
Unicode UTF-16.
<p>
The rules for using <b><tt>Decoding</tt></b> resources in particular
cases are specified in the configuration file
<a href="../lib/xlatmap">lib/xlatmap</a>. See the file itself for more
information.
<p>
The file format for <b><tt>Decoding</tt></b> resource files is
generic PostScript.
Users may want to define custom <b><tt>Decoding</tt></b> resources.
The <b><tt>ParseDecoding</tt></b> procset defined in
<a href="../lib/gs_ciddc.ps">lib/gs_ciddc.ps</a> allows representation
of the table in a comfortable form.
<h3><a name="CIDDecodingResources"></a>CIDDecoding resources</h3>
<p>
<b><tt>CIDDecoding</tt></b> resources are similar to <b><tt>Decoding</tt></b>
resources, except they map Charaacter Identifiers (CIDs) rather than glyph names.
Another difference is that the native Ghostscript font renderer already uses
<b><tt>CIDDecoding</tt></b> resources while emulate CID fonts with TrueType.
<p>
An instance of the <b><tt>CIDDecoding</tt></b> resource category is
a dictionary of strings. Keys in the dictionary are integers,
which correspond to high order byte of a CID. Values are
512-bytes strings. Each string represents 256 character codes,
corresponding various values of the lower byte of CID.
Each character code ocupies 2 bytes, high order byte first.
Two zero bytes represent mapping to the default character.
<p>
The Ghostscript library is capable of generating some <b><tt>CIDDecoding</tt></b>
instances automatically, using the appropriate <b><tt>CMap</tt></b> (character map)
resources. This covers most of practical cases if the neccessary <b><tt>CMap</tt></b>
resources are provided. See the table <b><tt>.CMapChooser</tt></b> in
<a href="../lib/gs_ciddc.ps">lib/gs_ciddc.ps</a>
for the names of automatically gerenated resources and associated <b><tt>CMap</tt></b>s.
They allow to mapping CNS1, GB1, Japan1, Japan2 and Korea1 CID sets to TrueType
character sets known as Unicode (exactly UTF-16), Big5,
GB1213, ShiftJIS, Johab and Wansung.
<p>
The file format for <b><tt>CIDDecoding</tt></b> resource file is
generic PostScript.
Users may want to define custom resources to <b><tt>CIDDecoding</tt></b>
resource category.
<h3><a name="GlyphNames2Unicode"></a>GlyphNames2Unicode</h3>
<p>
<b><tt>GlyphNames2Unicode</tt></b> is an undocumented dictionary which Adobe
PostScript printer driver uses to communicate with Adobe Distiller.
In this dictionary the keys are glyph names, the values are Unicode UTF-16 codes for them.
The dictionaly is stored in the <b><tt>FontInfo</tt></b> dictionary under
the key <b><tt>GlyphNames2Unicode</tt></b>. Ghostscript recognises it and uses
to generate <b><tt>ToUnicode</tt></b> CMaps with pdfwrite.
<p>
<h3><a name="MultipleResourceDirectories"></a>Multiple Resource directories</h3>
<p>
Since 8.10 release Ghostscript maintains multiple resource directories.
<p>
Ghostscript does not distinguish <b><tt>lib</b></tt> and <b><tt>Resource</b></tt> directories.
There is no file name conflicts because
<b><tt>lib</b></tt> does not contain subdirectories, but <b><tt>Resource</b></tt>
always store files in subdirectories.
<p>
The search method with multiple resource directories
appears not fully conforming to PLRM. We cannot unconditionally call
<b><tt>ResourceFileName</b></tt> while executing <b><tt>findresource</b></tt>
or <b><tt>resourcestatus</b></tt>, <b><tt>resourceforall</b></tt>, because per PLRM it always
returns a single path. Therefore Ghostscript implements
an extended search method in <b><tt>findresource</b></tt>,
<b><tt>resourcestatus</b></tt> and <b><tt>resourceforall</b></tt>, which first calls
<b><tt>ResourceFileName</b></tt> and checks whether the returned path
points to an existing file. If yes, the file is used,
othervise Ghostscript searches all directories specified in
<b><tt>LIB_PATH</tt></b>. With a single resource directory
it appears conforming to PLRM and equivalent to Adobe implementations.
<p>
<b><tt>ResourceFileName</b></tt> may be used for obtaining a path
where a resource file to be installed. In this case
Ghostscript to be invoked with <b><tt>-sGenericResourceDir=path</b></tt>,
specifying an absolute path. The default value for
<b><tt>GenericResourceDir</b></tt> is a relative path. Therefore
a default invocation with a PostScript installer
will install resource files into <b><tt>/gs/Resource</tt></b>.
<p>
<!-- [2.0 end contents] ==================================================== -->
<!-- [3.0 begin visible trailer] =========================================== -->
<hr>
<p>
<small>Copyright © 1996-2005 artofcode LLC. All rights
reserved.</small>
<p>
This software is provided AS-IS with no warranty, either express or
implied.
This software is distributed under license and may not be copied,
modified or distributed except as expressly authorized under the terms
of the license contained in the file LICENSE in this distribution.
For more information about licensing, please refer to
http://www.ghostscript.com/licensing/. For information on
commercial licensing, go to http://www.artifex.com/licensing/ or
contact Artifex Software, Inc., 101 Lucas Valley Road #110,
San Rafael, CA 94903, U.S.A., +1(415)492-9861.
<p>
<small>Ghostscript version 8.53, 20 October 2005
<!-- [3.0 end visible trailer] ============================================= -->
</body>
</html>