Load cups into easysw/current.
[thirdparty/cups.git] / 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-2005 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 provide...</p>
28
29 <h2 class='title'>General Usage</h2>
30
31 <p>The <var>&lt;cups/backend.h&gt;</var> and
32 <var>&lt;cups/cups.h&gt;</var> header files must be included to
33 use the <tt>CUPS_BACKEND_</tt> constants and
34 <tt>cupsBackchannel</tt> functions, respectively.</p>
35
36 <p>Programs using these functions must be linked to the CUPS
37 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
38 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
39 <var>libcups2.lib</var> depending on the platform. The following
40 command compiles <var>myprogram.c</var> using GCC and the CUPS
41 library:</p>
42
43 <pre class='command'>
44 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
45 </pre>
46
47 <h2 class='title'>Compatibility</h2>
48
49 <p>All of these functions require CUPS 1.2 or higher.</p>