cups/api-filter.shtml

   1 <!--
   2   "$Id$"
   3
   4   Filter and backend 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 filter and backend APIs define standard exit codes
  28 and provide access to the backchannel data stream. They are only
  29 used when writing backends, filters, and port monitors.</p>
  30
  31 <h2 class='title'>General Usage</h2>
  32
  33 <p>The <var>&lt;cups/backend.h&gt;</var> and
  34 <var>&lt;cups/cups.h&gt;</var> header files must be included to
  35 use the <tt>CUPS_BACKEND_</tt> constants and
  36 <tt>cupsBackChannel</tt> functions, respectively.</p>
  37
  38 <p>Programs using these functions must be linked to the CUPS
  39 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  40 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  41 <var>libcups2.lib</var> depending on the platform. The following
  42 command compiles <var>myprogram.c</var> using GCC and the CUPS
  43 library:</p>
  44
  45 <pre class='command'>
  46 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  47 </pre>
  48
  49 <h2 class='title'>Compatibility</h2>
  50
  51 <p>All of these functions require CUPS 1.2 or higher.</p>