]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/api-overview.html
Update all references to OS X to macOS.
[thirdparty/cups.git] / doc / help / api-overview.html
index 151f3c90b4d6540ef739c32c437c6cb3964b829f..d6d51402f427f763322b5679e41f3297df7136e4 100644 (file)
@@ -1,10 +1,11 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <!-- SECTION: Programming -->
 <head>
-<title>Introduction to CUPS Programming</title>
-<meta name="keywords" content="Programming">
-<meta name="creator" content="Mini-XML v2.5">
+       <title>Introduction to CUPS Programming </title>
+       <meta name="keywords" content="Programming">
+       <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+       <meta name="creator" content="Mini-XML v2.7">
 <style type="text/css"><!--
 BODY {
   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
@@ -24,14 +25,37 @@ PRE {
 }
 
 PRE.command {
+  border: dotted thin #7f7f7f;
   margin-left: 36pt;
+  padding: 10px;
+}
+
+P.compact {
+  margin: 0;
+}
+
+P.example {
+  font-style: italic;
+  margin-left: 36pt;
+}
+
+DL.man DD {
+  margin-left: 5em;
+}
+
+DL.man DT {
+  margin-left: 0;
+}
+
+PRE.man {
+  margin: 0;
 }
 
 PRE.example {
   background: #eeeeee;
   border: dotted thin #999999;
   margin-left: 36pt;
-  padding: 10px;
+  padding: 10pt;
 }
 
 PRE.command EM, PRE.example EM {
@@ -49,25 +73,47 @@ P.formula {
 }
 
 BLOCKQUOTE {
-  background: #cccccc;
+  background: #eeeeee;
   border: solid thin #999999;
   padding: 10pt;
 }
 
+A IMG {
+  border: none;
+}
+
+A:link:hover IMG {
+  background: #f0f0f0;
+  border-radius: 10px;
+  -moz-border-radius: 10px;
+}
+
 A:link, A:visited {
+  font-weight: inherit;
   text-decoration: none;
-  font-weight: bold;
 }
 
 A:link:hover, A:visited:hover, A:active {
   text-decoration: underline;
-  font-weight: bold;
 }
 
 SUB, SUP {
   font-size: 50%;
 }
 
+TR.data, TD.data, TR.data TD {
+  margin-top: 10pt;
+  padding: 5pt;
+  border-bottom: solid 1pt #999999;
+}
+
+TR.data TH {
+  border-bottom: solid 1pt #999999;
+  padding-top: 10pt;
+  padding-left: 5pt;
+  text-align: left;
+}
+
 DIV.table TABLE {
   border: solid thin #999999;
   border-collapse: collapse;
@@ -111,19 +157,23 @@ DIV.figure CAPTION {
 }
 
 TH.label {
-  padding-top: 5pt;
   text-align: right;
   vertical-align: top;
 }
 
+TH.sublabel {
+  text-align: right;
+  font-weight: normal;
+}
+
 HR {
   border: solid thin;
 }
 
 SPAN.info {
-  background: #000000;
-  border: thin solid #000000;
-  color: #ffffff;
+  background: black;
+  border: thin solid black;
+  color: white;
   font-size: 80%;
   font-style: italic;
   font-weight: bold;
@@ -135,10 +185,64 @@ H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
   font-size: 100%;
 }
 
+H1.title {
+}
+
 H2.title, H3.title {
   border-bottom: solid 2pt #000000;
 }
 
+DIV.indent, TABLE.indent {
+  margin-top: 2em;
+  margin-left: auto;
+  margin-right: auto;
+  width: 90%;
+}
+
+TABLE.indent {
+  border-collapse: collapse;
+}
+
+TABLE.indent TD, TABLE.indent TH {
+  padding: 0;
+}
+
+TABLE.list {
+  border-collapse: collapse;
+  margin-left: auto;
+  margin-right: auto;
+  width: 90%;
+}
+
+TABLE.list TH {
+  background: white;
+  border-bottom: solid thin #cccccc;
+  color: #444444;
+  padding-top: 10pt;
+  padding-left: 5pt;
+  text-align: left;
+  vertical-align: bottom;
+  white-space: nowrap;
+}
+
+TABLE.list TH A {
+  color: #4444cc;
+}
+
+TABLE.list TD {
+  border-bottom: solid thin #eeeeee;
+  padding-top: 5pt;
+  padding-left: 5pt;
+}
+
+TABLE.list TR:nth-child(even) {
+  background: #f8f8f8;
+}
+
+TABLE.list TR:nth-child(odd) {
+  background: #f4f4f4;
+}
+
 DT {
   margin-left: 36pt;
   margin-top: 12pt;
@@ -157,11 +261,6 @@ P.summary {
   font-family: monaco, courier, monospace;
 }
 
-SPAN.message {
-  font-style: italic;
-  font-size: smaller;
-}
-
 DIV.summary TABLE {
   border: solid thin #999999;
   border-collapse: collapse;
@@ -245,17 +344,18 @@ div.contents h2 {
 div.contents ul.contents {
   font-size: 80%;
 }
+div.contents ul.subcontents li {
+  margin-left: 1em;
+  text-indent: -1em;
+}
 --></style>
 </head>
 <body>
 <div class='body'>
 <!--
-  "$Id: api-cups.header 7279 2008-01-31 01:50:44Z mike $"
+  Introduction to CUPS programming header for CUPS.
 
-  Introduction to CUPS programming header for the Common UNIX Printing System
-  (CUPS).
-
-  Copyright 2008 by Apple Inc.
+  Copyright 2008-2016 by Apple Inc.
 
   These coded instructions, statements, and computer programs are the
   property of Apple Inc. and are protected by Federal copyright
@@ -264,57 +364,61 @@ div.contents ul.contents {
   file is missing or damaged, see the license at "http://www.cups.org/".
 -->
 
-<h1 class="title">Introduction to CUPS Programming</h1>
+<h1 class='title'>Introduction to CUPS Programming</h1>
 
 <div class='summary'><table summary='General Information'>
 <thead>
 <tr>
        <th>Headers</th>
        <th>cups/cups.h<br>
+       cups/adminutil.h<br>
        cups/array.h<br>
-       cups/backend.h<br>
        cups/dir.h<br>
        cups/file.h<br>
+       cups/http.h<br>
+       cups/ipp.h<br>
+       cups/language.h<br>
        cups/ppd.h<br>
-       cups/raster.h<br>
-       cups/sidechannel.h</th>
+       cups/pwg.h<br>
+       cups/raster.h</th>
 </tr>
 </thead>
 <tbody>
 <tr>
        <th>Libraries</th>
-       <td>-lcups<br>
-       -lcupsimage</td>
+       <td>-lcups</td>
 </tr>
 <tr>
        <th>See Also</th>
-       <td>Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br>
+       <td>Programming: <a href='raster-driver.html' target='_top'>Developing Raster Printer Drivers</a><br>
+       Programming: <a href='postscript-driver.html' target='_top'>Developing PostScript Printer Drivers</a><br>
+       Programming: <a href='api-filter.html' target='_top'>Filter and Backend Programming</a><br>
+       Programming: <a href='ppd-compiler.html' target='_top'>Introduction to the PPD Compiler</a><br>
+       Programming: <a href='api-admin.html' target='_top'>Administrative APIs</a><br>
        Programming: <a href='api-array.html' target='_top'>Array API</a><br>
+       Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br>
        Programming: <a href='api-filedir.html' target='_top'>File and Directory APIs</a><br>
-       Programming: <a href='api-filter.html' target='_top'>Filter and Backend Programming</a><br>
        Programming: <a href='api-httpipp.html' target='_top'>HTTP and IPP APIs</a><br>
-       Programming: <a href='api-ppd.html' target='_top'>PPD API</a><br>
-       Programming: <a href='api-raster.html' target='_top'>Raster API</a></td>
+       Programming: <a href='api-ppd.html' target='_top'>PPD API (DEPRECATED)</a><br>
+       Programming: <a href='api-raster.html' target='_top'>Raster API</a><br>
+       References: <a href='ref-ppdcfile.html' target='_top'>PPD Compiler Driver Information File Reference</a><br>
+       Specifications: <a href='spec-ppd.html' target='_top'>CUPS PPD Extensions</a></td>
 </tr>
 </tbody>
 </table></div>
 <h2 class="title">Contents</h2>
 <ul class="contents">
-</li>
 <li><a href="#OVERVIEW">Overview</a></li>
 <li><a href="#COMPILING">Compiling Programs</a><ul class="subcontents">
-<li><a href="#XCODE">Compiling with Xcode</a></li>
-<li><a href="#COMMANDLINE">Compiling with GCC</a></li>
-</ul class="subcontents"></li>
+       <li><a href="#XCODE">Compiling with Xcode</a></li>
+       <li><a href="#COMMANDLINE">Compiling with GCC</a></li>
+</ul></li>
 <li><a href="#WHERETOGO">Where to Go Next</a></li>
 </ul>
 <!--
-  "$Id: api-cups.header 7279 2008-01-31 01:50:44Z mike $"
-
-  Introduction to CUPS programming content for the Common UNIX Printing System
-  (CUPS).
+  Introduction to CUPS programming content for CUPS.
 
-  Copyright 2008 by Apple Inc.
+  Copyright 2008-2011 by Apple Inc.
 
   These coded instructions, statements, and computer programs are the
   property of Apple Inc. and are protected by Federal copyright