cups/api-ppd.shtml

   1 <!--
   2   "$Id: api-ppd.shtml 6649 2007-07-11 21:46:42Z mike $"
   3
   4   PPD API introduction for the Common UNIX Printing System (CUPS).
   5
   6   Copyright 2007 by Apple Inc.
   7   Copyright 1997-2006 by Easy Software Products, all rights reserved.
   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
  16 <h2 class='title'>Introduction</h2>
  17
  18 <p>The CUPS PPD API provides read-only access the data in
  19 PostScript Printer Description ("PPD") files. With it you can
  20 display printer options to users, mark option choices and check
  21 for conflicting choices, and output marked choices in PostScript
  22 output.</p>
  23
  24 <h2 class='title'>General Usage</h2>
  25
  26 <p>The <var>&lt;cups/ppd.h&gt;</var> header file must be included
  27 to use the <tt>ppd</tt> functions.</p>
  28
  29 <p>Programs using these functions must be linked to the CUPS
  30 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  31 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  32 <var>libcups2.lib</var> depending on the platform. The following
  33 command compiles <var>myprogram.c</var> using GCC and the CUPS
  34 library:</p>
  35
  36 <pre class='command'>
  37 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  38 </pre>
  39
  40 <h2 class='title'>Compatibility</h2>
  41
  42 <p>Unless otherwise specified, the PPD API functions require CUPS
  43 1.1 or higher.</p>