]> git.ipfire.org Git - thirdparty/cups.git/blame - man/ppdcfile.man
Merge pull request #5112 from paulmenzel/remove-libgcrypt-detection
[thirdparty/cups.git] / man / ppdcfile.man
CommitLineData
ac884b6a 1.\"
53480915 2.\" ppdcfile man page for CUPS.
ac884b6a 3.\"
8be431f2 4.\" Copyright 2007-2016 by Apple Inc.
53480915 5.\" Copyright 1997-2007 by Easy Software Products.
ac884b6a 6.\"
53480915
MS
7.\" These coded instructions, statements, and computer programs are the
8.\" property of Apple Inc. and are protected by Federal copyright
9.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
10.\" which should have been included with this file. If this file is
11.\" file is missing or damaged, see the license at "http://www.cups.org/".
ac884b6a 12.\"
8be431f2 13.TH ppdcfile 5 "CUPS" "5 March 2016" "Apple Inc."
ac884b6a
MS
14.SH NAME
15ppdcfile \- cups ppd compiler source file format
16.SH DESCRIPTION
53480915
MS
17The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by
18.BR ppdc (1).
19This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS.
ac884b6a 20.PP
53480915 21The source file format is plain ASCII text that can be edited using your favorite text editor. Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms.
ac884b6a 22.PP
53480915 23Printer 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.
ac884b6a 24.PP
53480915 25Directives may be placed anywhere on a line and are followed by one or more values. The following is a list of the available directives and the values they accept:
ac884b6a 26.TP 5
53480915 27\fB#define \fIname value\fR
ac884b6a 28.TP 5
53480915 29\fB#elif \fR{\fIname \fR| \fIvalue\fR}
bdd6c45b
MS
30.TP 5
31\fB#else\fR
32.TP 5
33\fB#endif\fR
34.TP 5
53480915 35\fB#font \fIname encoding "version" charset status\fR
ac884b6a 36.TP 5
53480915 37\fB#if \fR{\fIname \fR| \fIvalue\fR}
bdd6c45b 38.TP 5
53480915 39\fB#include <\fIfilename\fB>\fR
ac884b6a 40.TP 5
53480915 41\fB#include "\fIfilename\fB"\fR
ac884b6a 42.TP 5
53480915 43\fB#media \fIname width length\fR
ac884b6a 44.TP 5
53480915 45\fB#media "\fIname\fB/\fItext\fB" \fIwidth length\fR
ac884b6a 46.TP 5
53480915 47\fB#po \fIlocale \fB"\fIfilename\fB"\fR
ac884b6a 48.TP 5
53480915 49\fBAttribute \fIname \fB"" \fIvalue\fR
ac884b6a 50.TP 5
53480915 51\fBAttribute \fIname keyword value\fR
ac884b6a 52.TP 5
53480915 53\fBAttribute \fIname \fB"\fIkeyword\fB/\fItext\fB" \fIvalue\fR
ac884b6a 54.TP 5
53480915 55\fBChoice \fIname \fB"\fIcode\fB"\fR
ac884b6a 56.TP 5
53480915 57\fBChoice \fB"\fIname\fB/\fItext\fB" "\fIcode\fB"\fR
ac884b6a 58.TP 5
53480915 59\fBColorDevice \fIboolean-value\fR
ac884b6a 60.TP 5
53480915 61\fBColorModel \fIname colorspace colororder compression\fR
ac884b6a 62.TP 5
53480915 63\fBColorModel "\fIname\fB/\fItext\fB" \fIcolorspace colororder compression\fR
ac884b6a 64.TP 5
53480915 65\fBColorProfile \fIresolution\fB/\fImediatype gamma density matrix\fR
ac884b6a 66.TP 5
53480915 67\fBCopyright "\fItext\fR"
ac884b6a 68.TP 5
53480915 69\fBCustomMedia \fIname width length left bottom right top \fB"\fIsize-code\fB" "\fIregion-code\fB"\fR
ac884b6a 70.TP 5
53480915 71\fBCustomMedia "\fIname\fB/\fItext\fB" \fIwidth length left bottom right top \fB"\fIsize-code\fB" "\fIregion-code\fB"\fR
ac884b6a 72.TP 5
53480915 73\fBCutter \fIboolean-value\fR
ac884b6a 74.TP 5
53480915 75\fBDarkness \fItemperature name\fR
ac884b6a 76.TP 5
53480915 77\fBDarkness \fItemperature \fB"\fIname\fB/\fItext\fB"\fR
ac884b6a 78.TP 5
53480915 79\fBDriverType \fItype\fR
ac884b6a 80.TP 5
53480915 81\fBDuplex \fItype\fR
ac884b6a 82.TP 5
8be431f2 83\fBFilter \fImime-type cost program\fR
ac884b6a 84.TP 5
53480915 85\fBFinishing \fIname\fR
ac884b6a 86.TP 5
53480915 87\fBFinishing "\fIname\fB/\fItext\fB"\fR
ac884b6a 88.TP 5
53480915 89\fBFont *\fR
ac884b6a 90.TP 5
53480915 91\fBFont \fIname encoding \fB"\fIversion\fB" \fIcharset status\fR
ac884b6a 92.TP 5
53480915 93\fBGroup \fIname\fR
ac884b6a 94.TP 5
53480915 95\fBGroup "\fIname\fB/\fItext\fB"\fR
ac884b6a 96.TP 5
53480915 97\fBHWMargins \fIleft bottom right top\fR
ac884b6a 98.TP 5
53480915 99\fBInputSlot \fIposition name\fR
ac884b6a 100.TP 5
53480915 101\fBInputSlot \fIposition \fB"\fIname\fB/\fItext\fB"\fR
ac884b6a 102.TP 5
53480915 103\fBInstallable \fIname\fR
ac884b6a 104.TP 5
53480915 105\fBInstallable "\fIname\fB/\fItext\fB"\fR
ac884b6a 106.TP 5
53480915 107\fBLocAttribute \fIname \fB"\fIkeyword\fB/\fItext\fB" \fIvalue\fR
bdd6c45b 108.TP 5
53480915 109\fBManualCopies \fIboolean-value\fR
ac884b6a 110.TP 5
53480915 111\fBManufacturer "\fIname\fB"\fR
ac884b6a 112.TP 5
53480915 113\fBMaxSize \fIwidth length\fR
ac884b6a 114.TP 5
53480915 115\fBMediaSize \fIname\fR
ac884b6a 116.TP 5
53480915 117\fBMediaType \fItype name\fR
ac884b6a 118.TP 5
53480915 119\fBMediaType \fItype \fB"\fIname\fB/\fItext\fB"\fR
ac884b6a 120.TP 5
53480915 121\fBMinSize \fIwidth length\fR
ac884b6a 122.TP 5
53480915 123\fBModelName "\fIname\fB"\fR
ac884b6a 124.TP 5
53480915 125\fBModelNumber \fInumber\fR
ac884b6a 126.TP 5
53480915 127\fBOption \fIname type section order\fR
ac884b6a 128.TP 5
53480915 129\fBOption "\fIname\fB/\fItext\fB" \fItype section order\fR
ac884b6a 130.TP 5
53480915 131\fBPCFileName "\fIfilename.ppd\fB"\fR
ac884b6a 132.TP 5
53480915 133\fBResolution \fIcolorspace bits-per-color row-count row-feed row-step name\fR
ac884b6a 134.TP 5
53480915 135\fBResolution \fIcolorspace bits-per-color row-count row-feed row-step \fB"\fIname\fB/\fItext\fB"\fR
ac884b6a 136.TP 5
53480915 137\fBSimpleColorProfile \fIresolution\fB/\fImediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust\fR
ac884b6a 138.TP 5
53480915 139\fBThroughput \fIpages-per-minute\fR
ac884b6a 140.TP 5
53480915 141\fBUIConstraints "\fI*Option1 *Option2\fB"\fR
ac884b6a 142.TP 5
53480915 143\fBUIConstraints "\fI*Option1 Choice1 *Option2\fB"\fR
ac884b6a 144.TP 5
53480915 145\fBUIConstraints "\fI*Option1 *Option2 Choice2\fB"\fR
ac884b6a 146.TP 5
53480915 147\fBUIConstraints "\fI*Option1 Choice1 *Option2 Choice2\fB"\fR
ac884b6a 148.TP 5
53480915 149\fBVariablePaperSize \fIboolean-value\fR
ac884b6a 150.TP 5
53480915 151\fBVersion \fInumber\fR
ac884b6a 152.SH SEE ALSO
53480915
MS
153.BR ppdc (1),
154.BR ppdhtml (1),
155.BR ppdi (1),
156.BR ppdmerge (1),
157.BR ppdpo (1),
158CUPS Online Help (http://localhost:631/help)
ac884b6a 159.SH COPYRIGHT
bd5a2f28 160Copyright \[co] 2007-2017 by Apple Inc.