]> git.ipfire.org Git - thirdparty/cups.git/blob - man/ppdcfile.man
Merge changes from CUPS 1.7svn-r10791.
[thirdparty/cups.git] / man / ppdcfile.man
1 .\"
2 .\" "$Id: ppdcfile.man 7607 2008-05-21 01:06:23Z mike $"
3 .\"
4 .\" ppdcfile man page for CUPS.
5 .\"
6 .\" Copyright 2007-2013 by Apple Inc.
7 .\" Copyright 1997-2007 by Easy Software Products.
8 .\"
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
14 .\"
15 .TH ppdcfile 5 "CUPS" "3 December 2012" "Apple Inc."
16 .SH NAME
17 ppdcfile \- cups ppd compiler source file format
18 .SH DESCRIPTION
19 The CUPS PPD compiler reads meta files that contain descriptions
20 of one or more PPD files to be generated by \fIppdc\fR. This man
21 page provides a quick reference to the supported keywords and
22 should be used in conjunction with the online help for CUPS.
23 .PP
24 The source file format is plain ASCII text that can be edited
25 using your favorite text editor. Comments are supported using
26 the C (/* ... */) and C++ (// ...) comment mechanisms.
27 .PP
28 Printer driver information can be grouped and shared using
29 curly braces ({ ... }); PPD files are written when a close
30 brace or end-of-file is seen and a PCFileName directive has been
31 defined.
32 .PP
33 Directives may be placed anywhere on a line and are followed by
34 one or more values. The following is a list of the available
35 directives and the values they accept:
36 .TP 5
37 \fB#define\fR name value
38 .TP 5
39 \fB#elif\fR {name | value}
40 .TP 5
41 \fB#else\fR
42 .TP 5
43 \fB#endif\fR
44 .TP 5
45 \fB#font\fR name encoding "version" charset status
46 .TP 5
47 \fB#if\fR {name | value}
48 .TP 5
49 \fB#include\fR <filename>
50 .TP 5
51 \fB#include\fR "filename"
52 .TP 5
53 \fB#media\fR name width length
54 .TP 5
55 \fB#media\fR "name/text" width length
56 .TP 5
57 \fB#po\fR locale "filename.po"
58 .TP 5
59 \fBAttribute\fR name "" value
60 .TP 5
61 \fBAttribute\fR name keyword value
62 .TP 5
63 \fBAttribute\fR name "keyword/text" value
64 .TP 5
65 \fBChoice\fR name "code"
66 .TP 5
67 \fBChoice\fR "name/text" "code"
68 .TP 5
69 \fBColorDevice\fR boolean-value
70 .TP 5
71 \fBColorModel\fR name colorspace colororder compression
72 .TP 5
73 \fBColorModel\fR "name/text" colorspace colororder compression
74 .TP 5
75 \fBColorProfile\fR resolution/mediatype gamma density matrix
76 .TP 5
77 \fBCopyright\fR "text"
78 .TP 5
79 \fBCustomMedia\fR name width length left bottom right top "size-code" "region-code"
80 .TP 5
81 \fBCustomMedia\fR "name/text" width length left bottom right top "size-code" "region-code"
82 .TP 5
83 \fBCutter\fR boolean-value
84 .TP 5
85 \fBDarkness\fR temperature name
86 .TP 5
87 \fBDarkness\fR temperature "name/text"
88 .TP 5
89 \fBDriverType\fR type
90 .TP 5
91 \fBDuplex\fR type
92 .TP 5
93 \fBFilter\fR mime-type cost program
94 .TP 5
95 \fBFinishing\fR name
96 .TP 5
97 \fBFinishing\fR "name/text"
98 .TP 5
99 \fBFont\fR *
100 .TP 5
101 \fBFont\fR name encoding "version" charset status
102 .TP 5
103 \fBGroup\fR name
104 .TP 5
105 \fBGroup\fR "name/text"
106 .TP 5
107 \fBHWMargins\fR left bottom right top
108 .TP 5
109 \fBInputSlot\fR position name
110 .TP 5
111 \fBInputSlot\fR position "name/text"
112 .TP 5
113 \fBInstallable\fR name
114 .TP 5
115 \fBInstallable\fR "name/text"
116 .TP 5
117 \fBLocAttribute\fR name "keyword/text" value
118 .TP 5
119 \fBManualCopies\fR boolean-value
120 .TP 5
121 \fBManufacturer\fR "name"
122 .TP 5
123 \fBMaxSize\fR width length
124 .TP 5
125 \fBMediaSize\fR name
126 .TP 5
127 \fBMediaType\fR type name
128 .TP 5
129 \fBMediaType\fR type "name/text"
130 .TP 5
131 \fBMinSize\fR width length
132 .TP 5
133 \fBModelName\fR "name"
134 .TP 5
135 \fBModelNumber\fR number
136 .TP 5
137 \fBOption\fR name type section order
138 .TP 5
139 \fBOption\fR "name/text" type section order
140 .TP 5
141 \fBPCFileName\fR "filename.ppd"
142 .TP 5
143 \fBResolution\fR colorspace bits-per-color row-count row-feed row-step name
144 .TP 5
145 \fBResolution\fR colorspace bits-per-color row-count row-feed row-step "name/text"
146 .TP 5
147 \fBSimpleColorProfile\fR resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust
148 .TP 5
149 \fBThroughput\fR pages-per-minute
150 .TP 5
151 \fBUIConstraints\fR "*Option1 *Option2"
152 .TP 5
153 \fBUIConstraints\fR "*Option1 Choice1 *Option2"
154 .TP 5
155 \fBUIConstraints\fR "*Option1 *Option2 Choice2"
156 .TP 5
157 \fBUIConstraints\fR "*Option1 Choice1 *Option2 Choice2"
158 .TP 5
159 \fBVariablePaperSize\fR boolean-value
160 .TP 5
161 \fBVersion\fR number
162 .SH SEE ALSO
163 ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1)
164 .br
165 http://localhost:631/help
166 .SH COPYRIGHT
167 Copyright 2007-2013 by Apple Inc.
168 .\"
169 .\" End of "$Id: ppdcfile.man 7607 2008-05-21 01:06:23Z mike $".
170 .\"