cups/api-cups.shtml

   1 <!--
   2   "$Id$"
   3
   4   CUPS API introduction for the Common UNIX Printing System (CUPS).
   5
   6   Copyright 1997-2006 by Easy Software Products.
   7
   8   These coded instructions, statements, and computer programs are the
   9   property of Easy Software Products and are protected by Federal
  10   copyright law.  Distribution and use rights are outlined in the file
  11   "LICENSE.txt" which should have been included with this file.  If this
  12   file is missing or damaged please contact Easy Software Products
  13   at:
  14
  15       Attn: CUPS Licensing Information
  16       Easy Software Products
  17       44141 Airport View Drive, Suite 204
  18       Hollywood, Maryland 20636 USA
  19
  20       Voice: (301) 373-9600
  21       EMail: cups-info@cups.org
  22         WWW: http://www.cups.org
  23 -->
  24
  25 <h2 class='title'>Introduction</h2>
  26
  27 <p>The CUPS library provides a whole collection of interfaces
  28 needed to support the internal needs of the CUPS software as well
  29 as the needs of applications, filters, printer drivers, and
  30 backends.</p>
  31
  32 <p>Unlike the rest of CUPS, the CUPS API library is provided
  33 under the GNU Library General Public License. This means that you
  34 can use the CUPS API library in both proprietary and open-source
  35 programs.</p>
  36
  37 <h2 class='title'>General Usage</h2>
  38
  39 <p>The <var>&lt;cups/cups.h&gt;</var> header file must be included to
  40 use the CUPS functions.</p>
  41
  42 <p>Programs using these functions must be linked to the CUPS
  43 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  44 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  45 <var>libcups2.lib</var> depending on the platform. The following
  46 command compiles <var>myprogram.c</var> using GCC and the CUPS
  47 library:</p>
  48
  49 <pre class='command'>
  50 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  51 </pre>
  52
  53 <h2 class='title'>Compatibility</h2>
  54
  55 <p>Unless otherwise specified, the CUPS API functions require
  56 CUPS 1.1 or higher.</p>