filter/api-raster.shtml

   1 <!--
   2   "$Id$"
   3
   4   Raster 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 raster API provides a standard interface for reading
  28 and writing CUPS raster streams which are used for printing to
  29 raster printers. Because the raster format is updated from time
  30 to time, it is important to use this API to avoid
  31 incompatibilities with newer versions of CUPS.</p>
  32
  33 <h2 class='title'>General Usage</h2>
  34
  35 <p>The <var>&lt;cups/raster.h&gt;</var> header file must be
  36 included to use the <tt>cupsRaster</tt> functions.</p>
  37
  38 <p>Programs using these functions must be linked to the CUPS
  39 imaging library: <var>libcupsimage.a</var>,
  40 <var>libcupsimage.so.2</var>, <var>libcupsimage.2.dylib</var>,
  41 <var>libcupsimage_s.a</var>, or <var>libcupsimage2.lib</var>
  42 depending on the platform. The following command compiles
  43 <var>myprogram.c</var> using GCC and the CUPS imaging
  44 library:</p>
  45
  46 <pre class='command'>
  47 <kbd>gcc -o myprogram myprogram.c -lcupsimage</kbd>
  48 </pre>
  49
  50 <h2 class='title'>Compatibility</h2>
  51
  52 <p>Unless otherwise specified, the raster API functions require
  53 CUPS 1.1 or higher.</p>
  54
  55 <h2 class='title'>Licensing</h2>
  56
  57 <p>The CUPS raster API is provided under the terms of the GNU
  58 General Public License, with exceptions for MacOS X-based
  59 programs. Please see the CUPS license agreement for more
  60 information.</p>