cups/api-httpipp.shtml

   1 <!--
   2   "$Id: api-httpipp.shtml 6649 2007-07-11 21:46:42Z mike $"
   3
   4   HTTP and IPP 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 HTTP and IPP APIs provide low-level access to the
  19 HTTP and IPP protocols and CUPS scheduler. They are typically
  20 used by monitoring and administration programs to perform
  21 specific functions not supported by the high-level CUPS API
  22 functions.</p>
  23
  24 <h2 class='title'>General Usage</h2>
  25
  26 <p>The <var>&lt;cups/cups.h&gt;</var> header file must be included to
  27 use the HTTP and IPP functions.</p>
  28
  29 <p>Programs using these functions must be linked to the CUPS
  30 library: <var>libcups.a</var>, <var>libcups.so.2</var>,
  31 <var>libcups.2.dylib</var>, <var>libcups_s.a</var>, or
  32 <var>libcups2.lib</var> depending on the platform. The following
  33 command compiles <var>myprogram.c</var> using GCC and the CUPS
  34 library:</p>
  35
  36 <pre class='command'>
  37 <kbd>gcc -o myprogram myprogram.c -lcups</kbd>
  38 </pre>
  39
  40 <h2 class='title'>Compatibility</h2>
  41
  42 <p>Unless otherwise specified, the HTTP and IPP API functions
  43 require CUPS 1.1 or higher.</p>