]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/man-ppdcfile.html
Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-ppdcfile.html
1 <!DOCTYPE HTML>
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>ppdcfile(5)</title>
7 </head>
8 <body>
9 <h1 class="title">ppdcfile(5)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 ppdcfile - cups ppd compiler source file format (deprecated)
12 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13 The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by
14 <b>ppdc</b>(1).
15 This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS.
16 <p>The 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.
17 <p>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.
18 <p>Directives 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:
19 <dl class="man">
20 <dt><b>#define </b><i>name value</i>
21 <dd style="margin-left: 5.0em"><dt><b>#elif </b>{<i>name </i>| <i>value</i>}
22 <dd style="margin-left: 5.0em"><dt><b>#else</b>
23 <dd style="margin-left: 5.0em"><dt><b>#endif</b>
24 <dd style="margin-left: 5.0em"><dt><b>#font </b><i>name encoding "version" charset status</i>
25 <dd style="margin-left: 5.0em"><dt><b>#if </b>{<i>name </i>| <i>value</i>}
26 <dd style="margin-left: 5.0em"><dt><b>#include &lt;</b><i>filename</i><b>></b>
27 <dd style="margin-left: 5.0em"><dt><b>#include "</b><i>filename</i><b>"</b>
28 <dd style="margin-left: 5.0em"><dt><b>#media </b><i>name width length</i>
29 <dd style="margin-left: 5.0em"><dt><b>#media "</b><i>name</i><b>/</b><i>text</i><b>" </b><i>width length</i>
30 <dd style="margin-left: 5.0em"><dt><b>#po </b><i>locale </i><b>"</b><i>filename</i><b>"</b>
31 <dd style="margin-left: 5.0em"><dt><b>Attribute </b><i>name </i><b>"" </b><i>value</i>
32 <dd style="margin-left: 5.0em"><dt><b>Attribute </b><i>name keyword value</i>
33 <dd style="margin-left: 5.0em"><dt><b>Attribute </b><i>name </i><b>"</b><i>keyword</i><b>/</b><i>text</i><b>" </b><i>value</i>
34 <dd style="margin-left: 5.0em"><dt><b>Choice </b><i>name </i><b>"</b><i>code</i><b>"</b>
35 <dd style="margin-left: 5.0em"><dt><b>Choice "</b><i>name</i><b>/</b><i>text</i><b>" "</b><i>code</i><b>"</b>
36 <dd style="margin-left: 5.0em"><dt><b>ColorDevice </b><i>boolean-value</i>
37 <dd style="margin-left: 5.0em"><dt><b>ColorModel </b><i>name colorspace colororder compression</i>
38 <dd style="margin-left: 5.0em"><dt><b>ColorModel "</b><i>name</i><b>/</b><i>text</i><b>" </b><i>colorspace colororder compression</i>
39 <dd style="margin-left: 5.0em"><dt><b>ColorProfile </b><i>resolution</i><b>/</b><i>mediatype gamma density matrix</i>
40 <dd style="margin-left: 5.0em"><dt><b>Copyright "</b><i>text</i>"
41 <dd style="margin-left: 5.0em"><dt><b>CustomMedia </b><i>name width length left bottom right top </i><b>"</b><i>size-code</i><b>" "</b><i>region-code</i><b>"</b>
42 <dd style="margin-left: 5.0em"><dt><b>CustomMedia "</b><i>name</i><b>/</b><i>text</i><b>" </b><i>width length left bottom right top </i><b>"</b><i>size-code</i><b>" "</b><i>region-code</i><b>"</b>
43 <dd style="margin-left: 5.0em"><dt><b>Cutter </b><i>boolean-value</i>
44 <dd style="margin-left: 5.0em"><dt><b>Darkness </b><i>temperature name</i>
45 <dd style="margin-left: 5.0em"><dt><b>Darkness </b><i>temperature </i><b>"</b><i>name</i><b>/</b><i>text</i><b>"</b>
46 <dd style="margin-left: 5.0em"><dt><b>DriverType </b><i>type</i>
47 <dd style="margin-left: 5.0em"><dt><b>Duplex </b><i>type</i>
48 <dd style="margin-left: 5.0em"><dt><b>Filter </b><i>mime-type cost program</i>
49 <dd style="margin-left: 5.0em"><dt><b>Finishing </b><i>name</i>
50 <dd style="margin-left: 5.0em"><dt><b>Finishing "</b><i>name</i><b>/</b><i>text</i><b>"</b>
51 <dd style="margin-left: 5.0em"><dt><b>Font *</b>
52 <dd style="margin-left: 5.0em"><dt><b>Font </b><i>name encoding </i><b>"</b><i>version</i><b>" </b><i>charset status</i>
53 <dd style="margin-left: 5.0em"><dt><b>Group </b><i>name</i>
54 <dd style="margin-left: 5.0em"><dt><b>Group "</b><i>name</i><b>/</b><i>text</i><b>"</b>
55 <dd style="margin-left: 5.0em"><dt><b>HWMargins </b><i>left bottom right top</i>
56 <dd style="margin-left: 5.0em"><dt><b>InputSlot </b><i>position name</i>
57 <dd style="margin-left: 5.0em"><dt><b>InputSlot </b><i>position </i><b>"</b><i>name</i><b>/</b><i>text</i><b>"</b>
58 <dd style="margin-left: 5.0em"><dt><b>Installable </b><i>name</i>
59 <dd style="margin-left: 5.0em"><dt><b>Installable "</b><i>name</i><b>/</b><i>text</i><b>"</b>
60 <dd style="margin-left: 5.0em"><dt><b>LocAttribute </b><i>name </i><b>"</b><i>keyword</i><b>/</b><i>text</i><b>" </b><i>value</i>
61 <dd style="margin-left: 5.0em"><dt><b>ManualCopies </b><i>boolean-value</i>
62 <dd style="margin-left: 5.0em"><dt><b>Manufacturer "</b><i>name</i><b>"</b>
63 <dd style="margin-left: 5.0em"><dt><b>MaxSize </b><i>width length</i>
64 <dd style="margin-left: 5.0em"><dt><b>MediaSize </b><i>name</i>
65 <dd style="margin-left: 5.0em"><dt><b>MediaType </b><i>type name</i>
66 <dd style="margin-left: 5.0em"><dt><b>MediaType </b><i>type </i><b>"</b><i>name</i><b>/</b><i>text</i><b>"</b>
67 <dd style="margin-left: 5.0em"><dt><b>MinSize </b><i>width length</i>
68 <dd style="margin-left: 5.0em"><dt><b>ModelName "</b><i>name</i><b>"</b>
69 <dd style="margin-left: 5.0em"><dt><b>ModelNumber </b><i>number</i>
70 <dd style="margin-left: 5.0em"><dt><b>Option </b><i>name type section order</i>
71 <dd style="margin-left: 5.0em"><dt><b>Option "</b><i>name</i><b>/</b><i>text</i><b>" </b><i>type section order</i>
72 <dd style="margin-left: 5.0em"><dt><b>PCFileName "</b><i>filename.ppd</i><b>"</b>
73 <dd style="margin-left: 5.0em"><dt><b>Resolution </b><i>colorspace bits-per-color row-count row-feed row-step name</i>
74 <dd style="margin-left: 5.0em"><dt><b>Resolution </b><i>colorspace bits-per-color row-count row-feed row-step </i><b>"</b><i>name</i><b>/</b><i>text</i><b>"</b>
75 <dd style="margin-left: 5.0em"><dt><b>SimpleColorProfile </b><i>resolution</i><b>/</b><i>mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust</i>
76 <dd style="margin-left: 5.0em"><dt><b>Throughput </b><i>pages-per-minute</i>
77 <dd style="margin-left: 5.0em"><dt><b>UIConstraints "</b><i>*Option1 *Option2</i><b>"</b>
78 <dd style="margin-left: 5.0em"><dt><b>UIConstraints "</b><i>*Option1 Choice1 *Option2</i><b>"</b>
79 <dd style="margin-left: 5.0em"><dt><b>UIConstraints "</b><i>*Option1 *Option2 Choice2</i><b>"</b>
80 <dd style="margin-left: 5.0em"><dt><b>UIConstraints "</b><i>*Option1 Choice1 *Option2 Choice2</i><b>"</b>
81 <dd style="margin-left: 5.0em"><dt><b>VariablePaperSize </b><i>boolean-value</i>
82 <dd style="margin-left: 5.0em"><dt><b>Version </b><i>number</i>
83 <dd style="margin-left: 5.0em"></dl>
84 <h2 class="title"><a name="NOTES">Notes</a></h2>
85 PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
86 Printers that do not support IPP can be supported using applications such as
87 <b>ippeveprinter</b>(1).
88 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
89 <b>ppdc</b>(1),
90 <b>ppdhtml</b>(1),
91 <b>ppdi</b>(1),
92 <b>ppdmerge</b>(1),
93 <b>ppdpo</b>(1),
94 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
95 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
96 Copyright &copy; 2007-2019 by Apple Inc.
97
98 </body>
99 </html>