cups/api-cups.shtml

   1 <!--
   2   "$Id: api-cups.shtml 6649 2007-07-11 21:46:42Z mike $"
   3
   4   CUPS 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 library provides a whole collection of interfaces
  19 needed to support the internal needs of the CUPS software as well
  20 as the needs of applications, filters, printer drivers, and
  21 backends.</p>
  22
  23 <p>Unlike the rest of CUPS, the CUPS API library is provided
  24 under the GNU Library General Public License. This means that you
  25 can use the CUPS API library in both proprietary and open-source
  26 programs.</p>
  27
  28 <h2 class='title'>General Usage</h2>
  29
  30 <p>The <var>&lt;cups/cups.h&gt;</var> header file must be included to
  31 use the CUPS functions.</p>
  32
  33 <p>Programs using these functions must be linked to the CUPS
  34 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  35 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  36 <var>libcups2.lib</var> depending on the platform. The following
  37 command compiles <var>myprogram.c</var> using GCC and the CUPS
  38 library:</p>
  39
  40 <pre class='command'>
  41 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  42 </pre>
  43
  44 <h2 class='title'>Compatibility</h2>
  45
  46 <p>Unless otherwise specified, the CUPS API functions require
  47 CUPS 1.1 or higher.</p>