man/ppdcfile.man

   1 .\"
   2 .\" "$Id: ppdcfile.man 343 2007-07-13 19:52:48Z mike $"
   3 .\"
   4 .\"   ppdcfile man page for the CUPS Driver Development Kit.
   5 .\"
   6 .\"   Copyright 2007 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 Driver Development Kit" "14 February 2007" "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 conjuction with the CUPS Driver Development Kit
  23 Developers Manual.
  24 .PP
  25 The source file format is plain ASCII text that can be edited
  26 using your favorite text editor. Comments are supported using
  27 the C (/* ... */) and C++ (// ...) comment mechanisms.
  28 .PP
  29 Printer driver information can be grouped and shared using
  30 curley braces ({ ... }); PPD files are written when a close
  31 brace or end-of-file is seen and a PCFileName directive has been
  32 defined.
  33 .PP
  34 Directives may be placed anywhere on a line and are followed by
  35 one or more values. The following is a list of the available
  36 directives and the values they accept:
  37 .TP 5
  38 \fB#define\fR name value
  39 .TP 5
  40 \fB#font\fR name encoding "version" charset status
  41 .TP 5
  42 \fB#include\fR <filename>
  43 .TP 5
  44 \fB#include\fR "filename"
  45 .TP 5
  46 \fB#media\fR name width length
  47 .TP 5
  48 \fB#media\fR "name/text" width length
  49 .TP 5
  50 \fB#po\fR locale "filename.po"
  51 .TP 5
  52 \fBAttribute\fR name "" value
  53 .TP 5
  54 \fBAttribute\fR name keyword value
  55 .TP 5
  56 \fBAttribute\fR name "keyword/text" value
  57 .TP 5
  58 \fBChoice\fR name "code"
  59 .TP 5
  60 \fBChoice\fR "name/text" "code"
  61 .TP 5
  62 \fBColorDevice\fR boolean-value
  63 .TP 5
  64 \fBColorModel\fR name colorspace colororder compression
  65 .TP 5
  66 \fBColorModel\fR "name/text" colorspace colororder compression
  67 .TP 5
  68 \fBColorProfile\fR resolution/mediatype gamma density matrix
  69 .TP 5
  70 \fBCopyright\fR "text"
  71 .TP 5
  72 \fBCustomMedia\fR name width length left bottom right top "size-code" "region-code"
  73 .TP 5
  74 \fBCustomMedia\fR "name/text" width length left bottom right top "size-code" "region-code"
  75 .TP 5
  76 \fBCutter\fR boolean-value
  77 .TP 5
  78 \fBDarkness\fR temperature name
  79 .TP 5
  80 \fBDarkness\fR temperature "name/text"
  81 .TP 5
  82 \fBDriverType\fR type
  83 .TP 5
  84 \fBDuplex\fR type
  85 .TP 5
  86 \fBFilter\fR mime-type cost program
  87 .TP 5
  88 \fBFinishing\fR name
  89 .TP 5
  90 \fBFinishing\fR "name/text"
  91 .TP 5
  92 \fBFont\fR *
  93 .TP 5
  94 \fBFont\fR name encoding "version" charset status
  95 .TP 5
  96 \fBGroup\fR name
  97 .TP 5
  98 \fBGroup\fR "name/text"
  99 .TP 5
 100 \fBHWMargins\fR left bottom right top
 101 .TP 5
 102 \fBInputSlot\fR position name
 103 .TP 5
 104 \fBInputSlot\fR position "name/text"
 105 .TP 5
 106 \fBInstallable\fR name
 107 .TP 5
 108 \fBInstallable\fR "name/text"
 109 .TP 5
 110 \fBManualCopies\fR boolean-value
 111 .TP 5
 112 \fBManufacturer\fR "name"
 113 .TP 5
 114 \fBMaxSize\fR width length
 115 .TP 5
 116 \fBMediaSize\fR name
 117 .TP 5
 118 \fBMediaType\fR type name
 119 .TP 5
 120 \fBMediaType\fR type "name/text"
 121 .TP 5
 122 \fBMinSize\fR width length
 123 .TP 5
 124 \fBModelName\fR "name"
 125 .TP 5
 126 \fBModelNumber\fR number
 127 .TP 5
 128 \fBOption\fR name type section order
 129 .TP 5
 130 \fBOption\fR "name/text" type section order
 131 .TP 5
 132 \fBPCFileName\fR "filename.ppd"
 133 .TP 5
 134 \fBResolution\fR colorspace bits-per-color row-count row-feed row-step name
 135 .TP 5
 136 \fBResolution\fR colorspace bits-per-color row-count row-feed row-step "name/text"
 137 .TP 5
 138 \fBSimpleColorProfile\fR resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust
 139 .TP 5
 140 \fBThroughput\fR pages-per-minute
 141 .TP 5
 142 \fBUIConstraints\fR "*Option1 *Option2"
 143 .TP 5
 144 \fBUIConstraints\fR "*Option1 Choice1 *Option2"
 145 .TP 5
 146 \fBUIConstraints\fR "*Option1 *Option2 Choice2"
 147 .TP 5
 148 \fBUIConstraints\fR "*Option1 Choice1 *Option2 Choice2"
 149 .TP 5
 150 \fBVariablePaperSize\fR boolean-value
 151 .TP 5
 152 \fBVersion\fR number
 153 .SH SEE ALSO
 154 cupsprofile(1), ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1),
 155 CUPS Driver Developer Kit Manual,
 156 .br
 157 http://localhost:631/help/ref-ppdc.html
 158 .SH COPYRIGHT
 159 Copyright 2007 by Apple Inc.
 160 .\"
 161 .\" End of "$Id: ppdcfile.man 343 2007-07-13 19:52:48Z mike $".
 162 .\"