The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by ppdc(1) or the corresponding driver interface program drv(1). The source file format is plain ASCII text that can be edited using your favorite text editor.
Directives may be placed anywhere on a line and are followed by zero or more values.
Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms.
Directives that accept expressions look for sequences of the form:
Printer driver information can be grouped and shared using curly braces ({ ... }); PPD files are written when a close brace or end-of-file is seen and a PCFileName directive has been defined.
#define name expression
#define FOO 100 #define BAR "Bar, Inc."
The #define directive assigns a value to a name
which can be later referenced using $name. The name is
case-insensitive and can be any sequence of letters, numbers,
and the underscore. The value can be any valid expression.
The following #define names are set by the PPD compiler:
CUPS_VERSION - The full CUPS version string, e.g.
"1.4.0"CUPS_VERSION_MAJOR - The major version number, e.g.
"1"CUPS_VERSION_MINOR - The minor version number, e.g.
"4"CUPS_VERSION_PATCH - The patch version number, e.g.
"0"PLATFORM_NAME - The operating system name used by the
current system as reported by "uname" ("Windows" on Microsoft
Windows)PLATFORM_ARCH - The processor architecture used by the
current system as reported by "uname -m" ("X86" or "X64" on Microsoft
Windows)#elif expression
#if HAVE_FOO ... #elif (HAVE_BAR >= 999) ... #else ... #endif
The #elif directive allows portions of a driver information file
to be used conditionally. #elif directives must appear after a
corresponding #if directive.
#else
#if HAVE_FOO ... #elif (HAVE_BAR >= 999) ... #else ... #endif
The #else directive allows portions of a driver information file
to be used conditionally when the corresponding
#if and #elif
expressions are non-zero.
#endif
#if HAVE_FOO ... #elif (HAVE_BAR >= 999) ... #else ... #endif
The #endif directive ends a conditional block of a driver
information file. It must appear after all of the
#if, #elif,
and #else directives for the current
conditional block.
#font name encoding "version" charset status
#font Courier Standard "(1.05)" Standard ROM #font Symbol Special "(001.005)" Special ROM #font Barcode-Foo Special "(1.0)" Special Disk #font Unicode-Foo Expert "(2.0)" Adobe-Identity ROM
The #font directive defines a "base font" for all
printer drivers. The name is the PostScript font name.
The encoding is the default encoding of the font, usually
Standard, Expert, or Special, as
defined in the Adobe PPD file specification.
The version is the PostScript string definition that corresponds to the font version number.
The charset defines the available characters in the font,
usually Standard or Special, as defined in the
Adobe PPD file specification.
The status is the installation status of the font and must be
either the word ROM or Disk.
Base fonts differ from fonts defined using the Font directive in that they are not
automatically associated with all drivers - you must use the
special Font * directive to include them in a
driver.
Currently the #font directive is used mainly for
defining the standard raster fonts in the
<font.defs> include file.
#if name or expression
#if HAVE_FOO ... #elif (HAVE_BAR >= 999) ... #else ... #endif
The #if directive allows portions of a driver information file
to be used conditionally. When followed by a name, the data that follows is
used only when the name is defined, otherwise the data is ignored.
#if directives can be nested up to 100 times.
#include <filename> #include "filename"
#include <font.defs> #include "myfile.h"
The #include directive reads the named driver
information file. If the filename is included inside angle
brackets (<filename>), then the PPD compiler will
look for the file in all of the include directories it knows
about. Otherwise, the file is opened in the current directory
relative to the current driver information file, and if that
fails then it looks in the include directories for the file.
The #include directive can be nested to as many
files as are allowed by the host operating system, typically at
least 100 files.
#media name width length #media "name/text" width length
#media "Letter/Letter - 8.5x11in" 8.5in 11in #media "A4/A4 - 210x297mm" 210mm 297mm #media "w936h1368/Super B/A3 - 13x19in" 936 1368 #media Photo 4in 6in
The #media directive defines a named media size for
inclusion in a driver. The name with optional user text defines
the name for the media size and is used with the MediaSize directive to associate
the media size with the driver. The name may contain up to 40 ASCII
characters within the range of decimal 33 to decimal 126 inclusive,
except for the characters comma (44), slash (47) and colon (58).
The user text, if supplied, may not exceed 80 bytes in length.
The width and length define the dimensions of the media. Each number is optionally followed by one of the following unit suffixes:
cm - centimetersft - feetin - inchesm - metersmm - millimeterspt - points (72 points = 1 inch)Points are assumed if no units are specified.
#include,
CustomMedia,
MediaSize
#po locale filename
#po es "es.po" #po fr_CA "mydriver-fr_CA.po"
The #po directive defines a message catalog to use for the
given POSIX language abbreviation. Multiple #po directives can be
specified to list multiple catalogs. The filename can be an absolute path or
relative to the driver information file. GNU gettext and macOS .strings
files are supported.
Attribute name "" value Attribute name keyword value Attribute name "keyword/text" value
Attribute cupsInkChannels "" 1 Attribute cupsAllDither 600dpi "1.0" Attribute fooProfile "Photo/Photographic Profile" "photopro.icc"
The Attribute directive creates a PPD attribute. The
name may contain up to 40 ASCII characters within the range of decimal
33 to decimal 126 inclusive, except for the characters comma (44),
slash (47) and colon (58).
The selector can be the empty string ("") or text of up
to 80 bytes.
The value is any string or number; the string may contain multiple lines, however no one line may exceed 255 bytes.
Choice name "code" Choice "name/text" "code"
Choice None "<</MediaType (None)>>setpagedevice" Choice "False/No" "<</cupsCompression 0>>setpagedevice"
The Choice directive adds a single choice to the
current option. The name may contain up to 40 ASCII characters within
the range of decimal 33 to decimal 126 inclusive, except for the
characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The code is any string and may contain multiple lines, however no one line may exceed 255 bytes.
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
ColorDevice boolean-value
ColorDevice no ColorDevice yes
The ColorDevice directive tells the application if
the printer supports color. It is typically used in conjunction
with the ColorModel directive
to provide color printing support.
ColorModel name colorspace colororder compression ColorModel "name/text" colorspace colororder compression
ColorModel Gray/Grayscale w chunky 0 ColorModel RGB/Color rgb chunky 0 ColorModel CMYK cmyk chunky 0
The ColorModel directive is a convenience directive
which creates a ColorModel option and choice for the current
printer driver. The name may contain up to 40 ASCII characters within
the range of decimal 33 to decimal 126 inclusive, except for the
characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The colorspace argument is one of the standard colorspace keywords defined later in this appendix in the section titled, "Colorspace Keywords".
The colororder argument is one of the standard color order keywords defined later in this appendix in the section titled, "Color Order Keywords".
The compression argument is any number and is assigned to the
cupsCompression attribute in the PostScript page device
dictionary.
Choice,
ColorDevice,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
ColorProfile resolution/mediatype gamma density matrix
ColorProfile -/- 1.7 1.0
1.0 0.0 0.0
0.0 1.0 0.0
0.0 0.0 1.0
ColorProfile 360dpi/- 1.6 1.0
1.0 -0.05 -0.3
-0.35 1.0 -0.15
-0.095 -0.238 0.95
ColorProfile 720dpi/Special 1.5 1.0
1.0 0.0 -0.38
-0.4 1.0 0.0
0.0 -0.38 0.9
The ColorProfile directive defines a CMY
transform-based color profile. The resolution and mediatype
arguments specify the Resolution and MediaType
choices which use the profile; the hyphen (-) is used to
specify that any resolution or mediatype can be used with the
profile.
The gamma argument specifies the gamma correction to apply to the color values (P = pg) and is a real number greater than 0. Values larger than 1 cause a general lightening of the print while values smaller than 1 cause a general darkening of the print. A value of 1 disables gamma correction.
The density argument specifies the linear density correction to apply to the color values (P = d * pg) and is a real number greater than 0 and less than or equal to 1. A value 1 of disables density correction while lower values produce proportionately lighter output.
The matrix argument specifies a 3x3 linear transformation matrix in row-major order. The matrix is applied only to the CMY component of a RGB to CMYK transformation and is not used when printing in grayscale or CMYK mode unless the printer only supports printing with 3 colors.
Copyright "text"
Copyright "Copyright 2008 by Foo Enterprises" Copyright "This software is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this software; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA"
The Copyright directive adds text comments to the
top of a PPD file, typically for use in copyright notices. The
text argument can contain multiple lines of text, but no line
may exceed 255 bytes.
CustomMedia name width length left bottom right top
"size-code" "region-code"
CustomMedia "name/text" width length left bottom right top
"size-code" "region-code"
CustomMedia Letter 8.5in 11in 0.25in 0.46in 0.25in 0.04in
"<</PageSize[612 792]/ImagingBBox null/ManualFeed false>>
setpagedevice"
"<</PageSize[612 792]/ImagingBBox null/ManualFeed true>>
setpagedevice"
CustomMedia "A4/A4 - 210x297mm" 210mm 297mm 12 12 12 12
"<</PageSize[595 842]/ImagingBBox null>>setpagedevice"
"<</PageSize[595 842]/ImagingBBox null>>setpagedevice"
The CustomMedia directive adds a custom media size to
the driver. The name may contain up to 40 ASCII characters within the
range of decimal 33 to decimal 126 inclusive, except for the characters
comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The width and length arguments specify the dimensions of the
media as defined for the #media
directive.
The left, bottom, right, and top arguments specify the printable margins of the media.
The size-code and region-code arguments specify the
PostScript commands to run for the PageSize and
PageRegion options, respectively. The commands can
contain multiple lines, however no line may be more than 255
bytes in length.
Cutter boolean-value
Cutter yes Cutter no
The Cutter directive specifies whether the printer
has a built-in media cutter. When a cutter is present, the
printer's PPD file will contain a CutMedia option that
allows the user to control whether the media is cut at the end
of the job.
Choice,
ColorModel,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
Darkness temperature name Darkness temperature "name/text"
Darkness 0 Light Darkness 2 "Normal/Standard"
The Darkness directive defines a choice for the
cupsDarkness option which sets the
cupsCompression attribute in the PostScript page device
dictionary. It is used with the CUPS rastertolabel
sample driver to control the print head temperature and
therefore the darkness of the print.
The temperature argument specifies a temperature value for the Dymo driver from 0 (lowest) to 3 (highest), with 2 representing the normal setting.
The name may contain up to 40 ASCII characters within the range of decimal 33 to decimal 126 inclusive, except for the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
Choice,
ColorModel,
Cutter,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
DriverType type
DriverType custom DriverType escp DriverType pcl DriverType ps
The DriverType directive tells the PPD compiler
which DDK filters to include in the PPD file. The following
types are supported:
custom - Use only those filters that are
defined in the driver information fileepson - Use the CUPS sample Epson driver filter
rastertoepsonescp - Use the ESC/P DDK driver filters
commandtoescpx and
rastertoescpxhp - Use the CUPS sample HP driver filter
rastertohplabel - Use the CUPS sample label driver filter rastertolabelpcl - Use the HP-PCL DDK driver filters
commandtopclx and
rastertopclxps - Use no filters; this driver is for a
standard PostScript deviceDuplex type
Duplex none Duplex normal Duplex flip Duplex rotated Duplex manualtumble
The Duplex directive determines whether double-sided printing
is supported in the current driver. The type argument specifies the type
of duplexing that is supported:
none - double-sided printing is not
supportednormal - double-sided printing is
supportedflip - double-sided printing is supported,
but the back side image needs to be flipped vertically
(used primarily with inkjet printers)rotated - double-sided printing is supported,
but the back side image needs to be rotated 180 degrees for
DuplexNoTumblemanualtumble - double-sided printing is supported,
but the back side image needs to be rotated 180 degrees for
DuplexTumbleChoice,
ColorModel,
Cutter,
Darkness,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
FileName "filename"
FileName "Acme Laser Printer 2000" FileName "Acme Ink Waster 1000"
The FileName attribute specifies the "long" name of the
PPD file for the current driver.
Manufacturer,
ModelName,
PCFileName,
Version
Filter mime-type cost program
Filter application/vnd.cups-raster 50 rastertofoo Filter application/vnd.hp-HPGL 25 /usr/foo/filter/hpgltofoo
The Filter directive adds a filter for the current
driver. The mime-type argument is a valid MIME media type name
as defined in a CUPS mime.types file.
The cost argument specifies the relative cost of the filter. In general, use a number representing the average percentage of CPU time that is used when printing the specified MIME media type.
The program argument specifies the program to run; if the program is not an absolute filename, then CUPS will look for the program in the CUPS filter directory.
Finishing name Finishing "name/text"
Finishing None Finishing "Glossy/Photo Overcoat"
The Finishing directive adds a choice to the
cupsFinishing option. The name may contain up to 40 ASCII
characters within the range of decimal 33 to decimal 126 inclusive,
except for the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The name is stored in the OutputType attribute in the
PostScript page device dictionary.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
Font name encoding "version" charset status Font *
Font * Font Courier Standard "(1.05)" Standard ROM Font Symbol Special "(001.005)" Special ROM Font Barcode-Foo Special "(1.0)" Special Disk Font Unicode-Foo Expert "(2.0)" Adobe-Identity ROM
The Font directive defines a "device font" for the
current printer driver. The name is the PostScript font name.
The encoding is the default encoding of the font, usually
Standard, Expert, or Special, as
defined in the Adobe PPD file specification.
The version is the PostScript string definition that corresponds to the font version number.
The charset defines the available characters in the font,
usually Standard or Special, as defined in the
Adobe PPD file specification.
The status is the installation status of the font and must be
either the word ROM or Disk.
Device fonts differ from fonts defined using the #font directive in that they are
automatically associated with the current driver. Fonts defined
using #font may be imported into the current driver
using the Font * form of this directive.
Group name Group "name/text"
Group General Group "InstallableOptions/Options Installed" Group "Special/Vendor Options"
The Group directive specifies the group for new
Option directives. The name may contain up to 40 ASCII
characters within the range of decimal 33 to decimal 126 inclusive,
except for the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 40 bytes in length. If no text is provided, the name is used.
The names General and InstallableOptions
are predefined for the standard Adobe UI keywords and for installable
options, respectively.
| Note:
Because of certain API binary compatibility issues, CUPS limits the length of PPD group translation strings (text) to 40 bytes, while the PPD specification allows for up to 80 bytes. |
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
InputSlot,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
HWMargins left bottom right top
HWMargins 18 36 18 36 HWMargins 0.25in 0.5in 0.25in 0.5in HWMargins 0.6cm 1.2cm 0.6cm 1.2cm
The HWMargins directive specifies the current
margins for MediaSize that
follow. The left, bottom, right, and top margin values specify
the printable margins.
InputSlot position name InputSlot position "name/text"
InputSlot 0 Auto InputSlot 1 "Upper/Tray 1"
The InputSlot directive adds a new choice to the
InputSlot option. The position argument is a number
from 0 to 232-1 specifying the value that is placed
in the MediaPosition attribute in the PostScript page
device dictionary.
The name may contain up to 40 ASCII characters within the range of decimal 33 to decimal 126 inclusive, except for the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
Installable,
MediaType,
Option,
Resolution,
UIConstraints
Installable name Installable "name/text"
Installable EnvTray Installable "Option1/Duplexer Installed"
The Installable directive adds a new boolean option
to the InstallableOptions group with a default value of
False. The name may contain up to 40 ASCII characters
within the range of decimal 33 to decimal 126 inclusive, except for
the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
LocAttribute name "keyword/text" value
LocAttribute fooProfile "Photo/Photographic Profile" "photopro.icc"
The LocAttribute directive creates a localized PPD
attribute. The name may contain up to 40 ASCII characters within the
range of decimal 33 to decimal 126 inclusive, except for the characters
comma (44), slash (47) and colon (58).
The selector can be the empty string ("") or text of up
to 80 bytes.
The value is any string or number; the string may contain multiple lines, however no one line may exceed 255 bytes.
ManualCopies boolean-value
ManualCopies no ManualCopies yes
The ManualCopies directive specifies whether copies
need to be produced by the RIP filters. The default is
no.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
MediaType,
Option,
Resolution,
UIConstraints
Manufacturer "name"
Manufacturer "Foo" Manufacturer "HP"
The Manufacturer directive specifies the
manufacturer name for the current driver. The name argument must
conform to the manufacturer name requirements in the Adobe PPD
file specification.
FileName,
ModelName,
PCFileName,
Version
MaxSize width length
MaxSize 36in 100ft MaxSize 300cm 30m
The MaxSize directive specifies the maximum width
and length that is supported for custom page sizes.
MediaSize name
MediaSize Letter MediaSize A4
The MediaSize directive adds the named size to the
current printer driver using the current margins defined with
the HWMargins directive. The
name argument must match a media size defined using the #media directive.
MediaType type name MediaType type "name/text"
MediaType 0 Auto MediaType 1 "Plain/Plain Paper"
The MediaType directive adds a new choice to the
MediaType option. The type argument is a number
from 0 to 232-1 specifying the value that is placed
in the cupsMediaType attribute in the PostScript page
device dictionary.
The name may contain up to 40 ASCII characters within the range of decimal 33 to decimal 126 inclusive, except for the characters comma (44), slash (47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The name is placed in the MediaType attribute in the
PostScript page device dictionary.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
Option,
Resolution,
UIConstraints
MinSize width length
MinSize 4in 8in MinSize 10cm 20cm
The MinSize directive specifies the minimum width
and length that is supported for custom page sizes.
ModelName "name"
ModelName "Foo Laser Printer 2000" ModelName "Colorific 123"
The ModelName directive sets the printer name for
the ModelName, NickName, and
ShortNickName attributes for the printer driver. The
name is any string of letters, numbers, spaces, and the
characters ".", "/", "-", and "+" and should not begin with the
manufacturer name since the PPD compiler will add this
automatically for you. The maximum length of the name string is
31 bytes to conform to the Adobe limits on the length of
ShortNickName.
FileName,
Manufacturer,
PCFileName,
Version
ModelNumber expression
ModelNumber 123 ModelNumber ($PCL_PAPER_SIZE $PCL_PJL)
The ModelNumber directive sets the
cupsModelNumber attribute for the printer driver, which
is often used by the printer driver filter to tailor its output
for the current device. The number is any integer or bitwise OR
of integers and constants that is appropriate for the printer
driver filters.
A complete list of printer driver model number constants is available later in this appendix in the section titled, "Printer Driver ModelNumber Constants".
Option name type section order Option "name/text" type section order
Option Punch Boolean AnySetup 10 Option "fooFinish/Finishing Option" PickOne DocumentSetup 10
The Option directive creates a new option in the
current group, by default the General group. The name
may contain up to 40 ASCII characters within the range of decimal 33
to decimal 126 inclusive, except for the characters comma (44), slash
(47) and colon (58).
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
The type argument is one of the following keywords:
Boolean - a true/false optionPickOne - allows the user to pick one
choice from a listPickMany - allows the user to pick zero or
more choices from a listThe section argument is one of the following keywords:
AnySetup - The option can be placed in
either the DocumentSetup or PageSetup sections of the
PostScript documentDocumentSetup - The option must be placed
in the DocumentSetup section of the PostScript document;
this does not allow the option to be overridden on
individual pagesExitServer - The option must be placed in a
separate initialization job prior to the document (not
used for raster printer drivers)JCLSetup - The option contains job control
language commands and must be sent prior to the document
using the JCLBegin and
JCLToPSInterpreter attributes (not used for
raster printer drivers)PageSetup - The option must be placed at the
beginning of each page in the PostScript documentProlog - The option must be placed in the
prolog section of the PostScript document; this is
typically used to add special comments for high-end
typesetters, but can also be used to add CUPS PostScript
job ticket comments.The order argument is a real number greater than or equal to 0.0 and is used to sort the printer commands from many options before sending them to the printer or RIP filter.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Resolution,
UIConstraints
PCFileName "filename.ppd"
PCFileName "foljt2k1.ppd" PCFileName "deskjet.ppd"
The PCFileName attribute specifies the name of the
PPD file for the current driver. The filename argument must
conform to the Adobe PPD file specification and can be no more
than 8 filename characters plus the extension ".ppd".
FileName,
Manufacturer,
ModelName,
Version
Resolution colorspace bits-per-color row-count row-feed row-step name Resolution colorspace bits-per-color row-count row-feed row-step "name/text"
Resolution - 8 0 0 0 300dpi Resolution k 8 0 0 0 "600x300dpi/600 DPI Grayscale"
The Resolution directive creates a new
Resolution option choice which sets the
HWResolution, cupsBitsPerColor,
cupsRowCount, cupsRowFeed,
cupsRowStep, and optionally the cupsColorSpace
page device dictionary attributes. The colorspace argument
specifies a colorspace to use for the specified resolution and
can be the hyphen (-) character to make no change to
the selected color model or any keyword listed in the section
titled, "Colorspace Keywords", to
force the named colorspace.
The bits-per-color argument specifies the number of bits per color to generate when RIP'ing a job. The values 1, 2, 4, and 8 are currently supported by CUPS.
The row-count, row-feed, and row-step argument specify the
driver-dependent values for the cupsRowCount,
cupsRowFeed, and cupsRowStep attributes,
respectively. Most drivers leave these attributes set to 0, but
any number from 0 to 232-1 is allowed.
The name argument must conform to the resolution naming
conventions in the Adobe PPD file specification, either
HHHdpi for symmetric resolutions or HHHxVVVdpi
for asymmetric resolutions. The HHH and VVV in
the examples represent the horizontal and vertical resolutions
which must be positive integer values.
If provided, the text can be any string up to 80 bytes in length. If no text is provided, the name is used.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
UIConstraints
SimpleColorProfile resolution/mediatype density
yellow-density red-density gamma
red-adjust green-adjust blue-adjust
SimpleColorProfile -/- 100 100 200 1.0 0 0 0 SimpleColorProfile 360dpi/- 100 95 150 1.2 5 10 15 SimpleColorProfile 720dpi/Glossy 100 90 120 1.5 -5 5 10
The SimpleColorProfile directive creates a
matrix-based ColorProfile.
The resolution and mediatype arguments specify the
Resolution and MediaType choices which use the
profile; the hyphen (-) is used to specify that any
resolution or mediatype can be used with the profile.
The density argument specifies the linear density correction to apply to the color values (P = d * 0.01 * pg) and is an integer greater than 0 and less than or equal to 100. A value 100 of disables density correction while lower values produce proportionately lighter output. The density value adjusts all color channels equally in all color modes.
The yellow-density argument specifies the density of the yellow channel when printing in grayscale or RGB mode and is an integer greater than 0 and less then or equal to 100. A value of 100 disables yellow density correction while lower values produce proportionately lighter output.
The red-density argument specifies the two-color density limit (e.g. C + M, C + Y, M + Y) when printing in grayscale or RGB mode and is an integer greater than 0 and less then or equal to 200. A value of 200 disables two-color density correction while lower values produce proportionately lighter output.
The gamma argument specifies the gamma correction to apply to the color values (P = pg) and is a real number greater than 0. Values larger than 1 cause a general lightening of the print while values smaller than 1 cause a general darkening of the print. A value of 1 disables gamma correction.
The red-adjust, green-adjust, blue-adjust arguments specify the percentage of color to add or remove. Positive red-adjust values add magenta and negative values add yellow. Positive green-adjust values add cyan and negative values add yellow. Positive blue-adjust values add cyan and negative values add magenta. Values of 0 disable color adjustments.
Throughput pages-per-minute
Throughput 1 Throughput 10
The Throughput directive sets the Throughput
attribute for the current printer driver. The pages-per-minute
argument is a positive integer representing the peak number of
pages per minute that the printer is capable of producing. Use a
value of 1 for printers that produce less than 1 page per
minute.
UIConstraints "*Option1 *Option2" UIConstraints "*Option1 Choice1 *Option2" UIConstraints "*Option1 *Option2 Choice2" UIConstraints "*Option1 Choice1 *Option2 Choice2"
UIConstraints "*Finishing *MediaType" UIConstraints "*Option1 False *Duplex" UIConstraints "*Duplex *MediaType Transparency" UIConstraints "*Resolution 600dpi *ColorModel RGB"
The UIConstraints directive adds a constraint
between two options. Constraints inform the application when a
user has chosen incompatible options. Each option name is
preceded by the asterisk (*). If no choice is given for
an option, then all choices except False and
None will conflict with the other option and choice(s).
Since the PPD compiler automatically adds reciprocal constraints
(option A conflicts with option B, so therefore option B
conflicts with option A), you need only specify the constraint
once.
Choice,
ColorModel,
Cutter,
Darkness,
Duplex,
Finishing,
Group,
InputSlot,
Installable,
MediaType,
Option,
Resolution
VariablePaperSize boolean-value
VariablePaperSize yes VariablePaperSize no
The VariablePaperSize directive specifies whether
the current printer supports variable (custom) page sizes. When
yes is specified, the PPD compiler will include the
standard PPD attributes required to support custom page
sizes.
Version number
Version 1.0 Version 3.7
The Version directive sets the FileVersion
attribute in the PPD file and is also used for the
NickName attribute. The number argument is a positive
real number.
Manufacturer,
ModelName,
PCFileName
Table B-1 shows the standard include files which are provided with the DDK.
| Include File | Description |
|---|---|
<font.defs> |
Defines all of the standard fonts which are included with ESP Ghostscript and the Apple PDF RIP. |
<epson.h> |
Defines all of the CUPS ESC/P sample driver constants. |
<escp.h> |
Defines all of the DDK ESC/P driver constants. |
<hp.h> |
Defines all of the CUPS HP-PCL sample driver constants. |
<label.h> |
Defines all of the CUPS label sample driver constants. |
<media.defs> |
Defines all of the standard media sizes listed in Appendix B of the Adobe PostScript Printer Description File Format Specification. |
<pcl.h> |
Defines all of the DDK HP-PCL driver constants. |
<raster.defs> |
Defines all of the CUPS raster format constants. |
The CUPS DDK and sample drivers use the
cupsModelNumber attribute in the PPD file to tailor
their output to the printer. The following sections describe the
constants for each driver.
The epson driver supports Epson and Okidata
dot-matrix, Epson Stylus Color, and Epson Stylus Photo printers.
Table B-2 lists the constants for the ModelNumber directive.
ModelNumber values should be inserted by referencing
only one of these constants.
| Constant | Description |
|---|---|
EPSON_9PIN |
Epson and Okidata 9-pin dot-matrix printers |
EPSON_24PIN |
Epson and Okidata 24-pin dot-matrix printers |
EPSON_COLOR |
Older Epson Stylus Color
printers that use the ESC . graphics command |
EPSON_PHOTO |
Older Epson Stylus Photo
printers that use the ESC . graphics command |
EPSON_ICOLOR |
Newer Epson Stylus Color
printers that use the ESC i graphics command |
EPSON_IPHOTO |
Newer Epson Stylus Photo
printers that use the ESC i graphics command |
The hp driver supports HP LaserJet and DeskJet
printers. Table B-3 lists the constants
for the ModelNumber
directive. ModelNumber values should be inserted by
referencing only one of these constants.
| Constant | Description |
|---|---|
HP_LASERJET |
HP LaserJet printers supporting PCL 3, 4, or 5 |
HP_DESKJET |
HP DeskJet printers
supporting PCL 3 and using the simple color graphics
command (ESC * r # U) |
HP_DESKJET2 |
HP DeskJet printers
supporting PCL3GUI and using the configure raster graphics
command (ESC * g # W) |
The label driver supports the Dymo Labelwriter, Zebra CPCL, Zebra EPL, and Zebra ZPL, and Intellitech PCL label printers. Table B-4
lists the constants for the ModelNumber directive.
ModelNumber values should be inserted by referencing
only one of these constants.
| Constant | Description |
|---|---|
DYMO_3x0 |
Format output for the Dymo Labelwriter 300, 330, or 330 Turbo. |
INTELLITECH_PCL |
Format output for the Intellitech PCL printers. |
ZEBRA_CPCL |
Format output for the Zebra CPCL printers. |
ZEBRA_EPL_LINE |
Format output for the Zebra EPL line mode (EPL 1) printers. |
ZEBRA_EPL_PAGE |
Format output for the Zebra EPL page mode (EPL 2) printers. |
ZEBRA_ZPL |
Format output for the Zebra ZPL printers. |
The escp driver supports all Epson inkjet printers.
Table B-6 lists the constants for the ModelNumber directive.
ModelNumber values should be specified as the bitwise
OR of one or more of these constants.
| Constant | Description |
|---|---|
ESCP_MICROWEAVE |
Use microweave command? |
ESCP_STAGGER |
Are color jets staggered? |
ESCP_ESCK |
Use print mode command? |
ESCP_EXT_UNITS |
Use extended unit commands? |
ESCP_EXT_MARGINS |
Use extended margin command? |
ESCP_USB |
Send USB packet mode escape |
ESCP_PAGE_SIZE |
Use page size command |
ESCP_RASTER_ESCI |
Use ESC i graphics command |
ESCP_REMOTE |
Use remote mode commands |
ESCP_REMOTE_AC |
Use auto-cutter command |
ESCP_REMOTE_CO |
Use cutter-operation command |
ESCP_REMOTE_EX |
Use media-position command |
ESCP_REMOTE_MS |
Use media-size command |
ESCP_REMOTE_MT |
Use media-type command |
ESCP_REMOTE_PC |
Use paper-check command |
ESCP_REMOTE_PH |
Use paper-thickness command |
ESCP_REMOTE_PP |
Use paper-path command |
ESCP_REMOTE_SN0 |
Use feed-sequence-0 command |
ESCP_REMOTE_SN1 |
Use platten-gap command |
ESCP_REMOTE_SN2 |
Use feed-sequence-2 command |
ESCP_REMOTE_SN6 |
Use eject-delay command |
ESCP_REMOTE_FP |
Use print-position command |
The pcl driver supports all HP LaserJet, DeskJet,
and DesignJet printers. Table B-5 lists
the constants for the ModelNumber directive.
ModelNumber values should be specified as the bitwise
OR of one or more of these constants.
| Constant | Description |
|---|---|
PCL_PAPER_SIZE |
Use paper size command (ESC & l # A) |
PCL_INKJET |
Use inkjet commands |
PCL_RASTER_END_COLOR |
Use new end-raster command (ESC * r C) |
PCL_RASTER_CID |
Use configure-image-data command (ESC * v # W) |
PCL_RASTER_CRD |
Use configure-raster-data command (ESC * g # W) |
PCL_RASTER_SIMPLE |
Use simple-raster-color command (ESC * r # U) |
PCL_RASTER_RGB24 |
Use 24-bit RGB mode |
PCL_PJL |
Use PJL commands |
PCL_PJL_PAPERWIDTH |
Use PJL PAPERWIDTH/LENGTH commands |
PCL_PJL_HPGL2 |
Use PJL ENTER HPGL2 command |
PCL_PJL_PCL3GUI |
Use PJL ENTER PCL3GUI command |
PCL_PJL_RESOLUTION |
Use PJL SET RESOLUTION command |
The PPD compiler defines two types of color keywords: colorspace and color order. The following sections list the supported keywords for each type.
The following colorspace keywords are recognized:
The following color order keywords are recognized: