diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2019-05-02 13:04:23 -0400 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2019-05-02 13:04:23 -0400 |
| commit | 957bc1982902ae5515fcb94938ebf842b2018424 (patch) | |
| tree | 137df5a0a241ae9a0edb1615023d85563b6106e4 | |
| parent | 7978a9b5250faa80609d114c433e182e7e46aaac (diff) | |
| download | cups-957bc1982902ae5515fcb94938ebf842b2018424.tar.gz | |
CUPS 2.3b8 release and documentation.
82 files changed, 5733 insertions, 1107 deletions
diff --git a/_posts/2019-05-02-cups-2.3b8.md b/_posts/2019-05-02-cups-2.3b8.md new file mode 100644 index 000000000..b88eb9937 --- /dev/null +++ b/_posts/2019-05-02-cups-2.3b8.md @@ -0,0 +1,11 @@ +--- +title: CUPS 2.3b8 +layout: post +permalink: /blog/:year-:month-:day-:title.html +--- + +CUPS 2.3b8 is now available for download. This is the eighth beta of the CUPS 2.3 series which adopts the new CUPS license, adds support for IPP presets and finishing templates, and fixes a number of bugs and "polish" issues. This beta also includes the new ippeveprinter utility. A detailed list of changes can be found in the change log included in the download. + +Enjoy! + +<a class="btn btn-default" href="https://github.com/apple/cups/releases/tag/v2.3b8">Download CUPS 2.3b8</a> diff --git a/doc/accounting.html b/doc/accounting.html index a0ad0563d..ea37a556d 100644 --- a/doc/accounting.html +++ b/doc/accounting.html @@ -1,7 +1,10 @@ ---- -title: Printer Accounting Basics -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Printer Accounting Basics</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Printer Accounting Basics</H1> @@ -47,3 +50,6 @@ can be used to easily determine that information.</P> <H2 CLASS="title"><A NAME="PAGELOG">Page Logging</A></H2> <P>CUPS can log every page that is printed on a system to the <VAR><A HREF="man-cupsd-logs.html">page_log</A></VAR> file. Page logging must be enabled by setting the <CODE>PageLogFormat</CODE> directive in the <VAR><A HREF="man-cupsd.conf.html">cupsd.conf</A></VAR> file and is only available for drivers that provide page accounting information, typically all PostScript and CUPS raster devices. Raw queues and queues using third-party solutions such as Foomatic generally do not have useful page accounting information available.</P> + +</BODY> +</HTML> diff --git a/doc/admin.html b/doc/admin.html index e98b5e66a..47fee815d 100644 --- a/doc/admin.html +++ b/doc/admin.html @@ -1,8 +1,11 @@ ---- -title: Command-Line Printer Administration -layout: sub ---- - +<!DOCTYPE html> +<html> + <!-- SECTION: Getting Started --> + <head> + <title>Command-Line Printer Administration</title> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + </head> + <body> <h1 class="title">Command-Line Printer Administration</h1> <p>This help document describes how to configure and manage destinations with CUPS.</p> @@ -207,3 +210,5 @@ lpadmin -p bar -o printer-is-shared=true</pre> <p>To disable debug logging, run the same command with the <code>--no-debug-logging</code> option:</p> <pre class="command">cupsctl --no-debug-logging</pre> + </body> +</html> diff --git a/doc/api-admin.html b/doc/api-admin.html index 896841d8b..f9969d4a9 100644 --- a/doc/api-admin.html +++ b/doc/api-admin.html @@ -1,7 +1,463 @@ ---- -title: Administrative APIs -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Administration APIs</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + Administrative API header for CUPS. + + Copyright © 2016 by Apple Inc. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Administrative APIs</h1> @@ -58,7 +514,7 @@ layout: sub <p>The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.</p> -<blockquote><b>Note:<b> +<blockquote><b>Note:</b> <p>Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!</p> </blockquote> @@ -252,3 +708,5 @@ being provided by the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> an typedef void (*cups_device_cb_t)(const char *device_class, const char *device_id, const char *device_info, const char *device_make_and_model, const char *device_uri, const char *device_location, void *user_data); </p> </div> + </body> +</html> diff --git a/doc/api-filter.html b/doc/api-filter.html index 092163ecf..eddd06389 100644 --- a/doc/api-filter.html +++ b/doc/api-filter.html @@ -1,7 +1,463 @@ ---- -title: Filter and Backend Programming -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Filter and Backend Programming</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + Filter and backend programming header for CUPS. + + Copyright © 2008-2016 by Apple Inc. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Filter and Backend Programming</h1> @@ -949,7 +1405,10 @@ void *my_data; </ol> -<blockquote><b>Note:</b> The sandbox profile used in CUPS 2.0 still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.</blockquote> +<blockquote><b>Note:</b> + +<p>The sandbox profile used in CUPS still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.</p> +</blockquote> <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsBackChannelRead">cupsBackChannelRead</a></h3> <p class="description">Read data from the backchannel.</p> @@ -1301,3 +1760,5 @@ typedef void (*cups_sc_walk_func_t)(const char *oid, const char *data, int datal <tr><th>CUPS_SC_STATUS_TOO_BIG </th> <td class="description">Response too big</td></tr> </tbody></table> </div> + </body> +</html> diff --git a/doc/api-ppd.html b/doc/api-ppd.html index f785d1058..4ddb11ae7 100644 --- a/doc/api-ppd.html +++ b/doc/api-ppd.html @@ -1,11 +1,470 @@ ---- -title: PPD API (DEPRECATED) -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>PPD API (DEPRECATED)</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + PPD API header for CUPS. + + Copyright © 2008-2019 by Apple Inc. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>PPD API (DEPRECATED)</h1> -<blockquote>The PPD API is deprecated starting in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the <a href="api-cups.html">CUPS API</a> documentation. These functions will be removed in a future release of CUPS.</blockquote> +<blockquote><b>Note:</b> + +<p>The PPD API was deprecated in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the <a href="cupspm.html">CUPS Programming Manual</a> documentation. These functions will be removed in a future release of CUPS.</p> +</blockquote> <div class='summary'><table summary='General Information'> <thead> @@ -22,7 +481,7 @@ layout: sub <tr> <th>See Also</th> <td>Programming: <a href='api-overview.html' target='_top'>Introduction to CUPS Programming</a><br> - Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br> + Programming: <a href='cupspm.html' target='_top'>CUPS Programming Manual</a><br> Specifications: <a href='spec-ppd.html' target='_top'>CUPS PPD Extensions</a></td> </tr> </tbody> @@ -44,6 +503,7 @@ layout: sub <li><a href="#cupsGetPPD3">cupsGetPPD3</a></li> <li><a href="#cupsGetServerPPD">cupsGetServerPPD</a></li> <li><a href="#cupsMarkOptions">cupsMarkOptions</a></li> + <li><a href="#cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></li> <li><a href="#cupsResolveConflicts">cupsResolveConflicts</a></li> <li><a href="#ppdCollect">ppdCollect</a></li> <li><a href="#ppdCollect2">ppdCollect2</a></li> @@ -79,6 +539,7 @@ layout: sub <li><a href="#ppdPageWidth">ppdPageWidth</a></li> </ul></li> <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#cups_interpret_cb_t">cups_interpret_cb_t</a></li> <li><a href="#ppd_attr_t">ppd_attr_t</a></li> <li><a href="#ppd_choice_t">ppd_choice_t</a></li> <li><a href="#ppd_conform_t">ppd_conform_t</a></li> @@ -130,7 +591,7 @@ layout: sub <!-- PPD API introduction for CUPS. - Copyright © 2007-2018 by Apple Inc. + Copyright © 2007-2019 by Apple Inc. Copyright © 1997-2006 by Easy Software Products, all rights reserved. Licensed under Apache License v2.0. See the file "LICENSE" for more @@ -139,7 +600,10 @@ layout: sub <h2 class='title'><a name='OVERVIEW'>Overview</a></h2> -<blockquote>The PPD API is deprecated starting in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the <a href="cupspm.html">CUPS API</a> documentation. These functions will be removed in a future release of CUPS.</blockquote> +<blockquote><b>Note:</b> + +<p>The PPD API was deprecated in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the <a href="cupspm.html">CUPS Programming Manual</a> documentation. These functions will be removed in a future release of CUPS.</p> +</blockquote> <p>The CUPS PPD API provides read-only access the data in PostScript Printer Description ("PPD") files which are used for all printers with a driver. With @@ -157,6 +621,7 @@ values as case-insensitive strings, so option "InputSlot" and choice "Upper" are equivalent to "inputslot" and "upper", respectively.</p> </blockquote> + <h3><a name="LOADING">Loading a PPD File</a></h3> <p>The <a href="#ppdOpenFile"><code>ppdOpenFile</code></a> function "opens" a @@ -244,6 +709,7 @@ int num_options = cupsParseOptions(argv[5], 0, &options); cupsFreeOptions(num_options, options); </pre> + <h3><a name="CONSTRAINTS">Constraints</a></h3> <p>PPD files support specification of conflict conditions, called @@ -254,6 +720,7 @@ the options and choices that conflict with each other. The how many of the selected options are incompatible. Since constraints are normally specified in pairs, the returned value is typically an even number.</p> + <h3><a name="PAGE_SIZES">Page Sizes</a></h3> <p>Page sizes are special options which have physical dimensions and margins @@ -308,6 +775,7 @@ in points. Custom page size names can also be specified in inches <a href="#ppdPageSize"><code>ppdPageSize</code></a> function will return <code>NULL</code>.</p> + <h3><a name="ATTRIBUTES">Attributes</a></h3> <p>Every PPD file is composed of one or more attributes. Most of these @@ -492,6 +960,51 @@ int cupsMarkOptions(<a href="#ppd_file_t">ppd_file_t</a> *ppd, int num_options, "multiple-document-handling", "output-bin", "print-color-mode", "print-quality", "printer-resolution", and "sides" attributes to their corresponding PPD options and choices.</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></h3> + <p class="description">Interpret PPD commands to create a page header.</p> +<p class="code"> +int cupsRasterInterpretPPD(cups_page_header2_t *h, <a href="#ppd_file_t">ppd_file_t</a> *ppd, int num_options, cups_option_t *options, <a href="#cups_interpret_cb_t">cups_interpret_cb_t</a> func);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>h</th> + <td class="description">Page header to create</td></tr> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +<tr><th>func</th> + <td class="description">Optional page header callback (<code>NULL</code> for none)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function is used by raster image processing (RIP) filters like +cgpdftoraster and imagetoraster when writing CUPS raster data for a page. +It is not used by raster printer driver filters which only read CUPS +raster data.<br> +<br> + +<code>cupsRasterInterpretPPD</code> does not mark the options in the PPD using +the "num_options" and "options" arguments. Instead, mark the options with +<code>cupsMarkOptions</code> and <code>ppdMarkOption</code> prior to calling it - +this allows for per-page options without manipulating the options array.<br> +<br> +The "func" argument specifies an optional callback function that is +called prior to the computation of the final raster data. The function +can make changes to the <a href="#cups_page_header2_t"><code>cups_page_header2_t</code></a> data as needed to use a +supported raster format and then returns 0 on success and -1 if the +requested attributes cannot be supported.<br> +<br> + +<code>cupsRasterInterpretPPD</code> supports a subset of the PostScript language. +Currently only the <code>[</code>, <code>]</code>, <code><<</code>, <code>>></code>, <code>{</code>, +<code>}</code>, <code>cleartomark</code>, <code>copy</code>, <code>dup</code>, <code>index</code>, +<code>pop</code>, <code>roll</code>, <code>setpagedevice</code>, and <code>stopped</code> operators +are supported. + +</p> <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsResolveConflicts">cupsResolveConflicts</a></h3> <p class="description">Resolve conflicts in a marked PPD.</p> <p class="code"> @@ -1069,6 +1582,11 @@ float ppdPageWidth(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name); <h4 class="returnvalue">Return Value</h4> <p class="description">Width of page in points or 0.0</p> <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="cups_interpret_cb_t">cups_interpret_cb_t</a></h3> + <p class="description">cupsRasterInterpretPPD callback function</p> + <p class="code"> +typedef int (*cups_interpret_cb_t)(cups_page_header2_t *header, int preferred_bits); +</p> <h3 class="typedef"><a id="ppd_attr_t"><span class="info"> DEPRECATED </span>ppd_attr_t</a></h3> <p class="description">PPD Attribute Structure </p> <p class="code"> @@ -1296,7 +1814,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t;     float custom_margins[4];<br>     float custom_max[2];<br>     float custom_min[2];<br> -    <a href="#ppd_emul_t">ppd_emul_t</a> *emulations;<br>     char **filters;<br>     int flip_duplex;<br>     char **fonts;<br> @@ -1314,7 +1831,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t;     char *modelname;<br>     char *nickname;<br>     int num_consts;<br> -    int num_emulations;<br>     int num_filters;<br>     int num_fonts;<br>     int num_groups;<br> @@ -1349,8 +1865,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <td class="description">Maximum variable page size</td></tr> <tr><th>custom_min[2] </th> <td class="description">Minimum variable page size</td></tr> -<tr><th>emulations </th> - <td class="description">Emulations and the code to invoke them</td></tr> <tr><th>filters </th> <td class="description">Filter strings...</td></tr> <tr><th>flip_duplex <span class="info"> DEPRECATED </span></th> @@ -1385,8 +1899,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <td class="description">Nickname (specific)</td></tr> <tr><th>num_consts </th> <td class="description">Number of UI/Non-UI constraints</td></tr> -<tr><th>num_emulations </th> - <td class="description">Number of emulations supported</td></tr> <tr><th>num_filters </th> <td class="description">Number of filters</td></tr> <tr><th>num_fonts </th> @@ -1641,6 +2153,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <h4 class="constants">Constants</h4> <table class="list"><tbody> <tr><th>PPD_ALLOC_ERROR </th> <td class="description">Memory allocation error</td></tr> + <tr><th>PPD_BAD_CLOSE_UI </th> <td class="description">Bad CloseUI/JCLCloseUI</td></tr> <tr><th>PPD_BAD_CUSTOM_PARAM </th> <td class="description">Bad custom parameter</td></tr> <tr><th>PPD_BAD_OPEN_GROUP </th> <td class="description">Bad OpenGroup</td></tr> <tr><th>PPD_BAD_OPEN_UI </th> <td class="description">Bad OpenUI/JCLOpenUI</td></tr> @@ -1657,6 +2170,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>PPD_LINE_TOO_LONG </th> <td class="description">Line longer than 255 chars</td></tr> <tr><th>PPD_MISSING_ASTERISK </th> <td class="description">Missing asterisk in column 0</td></tr> <tr><th>PPD_MISSING_CLOSE_GROUP </th> <td class="description">Missing CloseGroup</td></tr> + <tr><th>PPD_MISSING_CLOSE_UI </th> <td class="description">Missing CloseUI/JCLCloseUI</td></tr> <tr><th>PPD_MISSING_OPTION_KEYWORD </th> <td class="description">Missing option keyword</td></tr> <tr><th>PPD_MISSING_PPDADOBE4 </th> <td class="description">Missing PPD-Adobe-4.x header</td></tr> <tr><th>PPD_MISSING_VALUE </th> <td class="description">Missing value string</td></tr> @@ -1674,3 +2188,5 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>PPD_UI_PICKONE </th> <td class="description">Pick one from a list</td></tr> </tbody></table> </div> + </body> +</html> diff --git a/doc/api-raster.html b/doc/api-raster.html index b40179b15..6eccab791 100644 --- a/doc/api-raster.html +++ b/doc/api-raster.html @@ -1,7 +1,463 @@ ---- -title: Raster API -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Raster API</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + Raster API documentation for CUPS. + + Copyright © 2008-2019 by Apple Inc. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Raster API</h1> @@ -15,13 +471,12 @@ layout: sub <tbody> <tr> <th>Library</th> - <td>-lcupsimage</td> + <td>-lcups</td> </tr> <tr> <th>See Also</th> - <td>Programming: <a href='api-overview.html'>Introduction to CUPS Programming</a><br> - Programming: <a href='api-cups.html'>CUPS API</a><br> - Programming: <a href='api-cups.html'>PPD API</a><br> + <td>Programming: <a href='cupspm.html'>CUPS Programming Manual</a><br> + Programming: <a href='api-ppd.html'>PPD API</a><br> References: <a href='spec-ppd.html'>CUPS PPD Specification</a></td> </tr> </tbody> @@ -37,8 +492,8 @@ layout: sub </ul></li> <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> <li><a href="#cupsRasterClose">cupsRasterClose</a></li> + <li><a href="#cupsRasterErrorString">cupsRasterErrorString</a></li> <li><a href="#cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></li> - <li><a href="#cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></li> <li><a href="#cupsRasterOpen">cupsRasterOpen</a></li> <li><a href="#cupsRasterOpenIO">cupsRasterOpenIO</a></li> <li><a href="#cupsRasterReadHeader">cupsRasterReadHeader</a></li> @@ -54,7 +509,6 @@ layout: sub <li><a href="#cups_cspace_t">cups_cspace_t</a></li> <li><a href="#cups_cut_t">cups_cut_t</a></li> <li><a href="#cups_edge_t">cups_edge_t</a></li> - <li><a href="#cups_interpret_cb_t">cups_interpret_cb_t</a></li> <li><a href="#cups_jog_t">cups_jog_t</a></li> <li><a href="#cups_mode_t">cups_mode_t</a></li> <li><a href="#cups_order_t">cups_order_t</a></li> @@ -85,7 +539,7 @@ layout: sub <!-- Raster API introduction for CUPS. - Copyright © 2007-2013 by Apple Inc. + Copyright © 2007-2019 by Apple Inc. Copyright © 1997-2006 by Easy Software Products, all rights reserved. Licensed under Apache License v2.0. See the file "LICENSE" for more @@ -231,7 +685,7 @@ the memory used to read the raster file:</p> <ul class="code"> - <li><a href="#cupsRasterInterpretPPD" title="Interpret PPD commands to create a page header.">cupsRasterInterpretPPD</a></li> + <li><a href="#cupsRasterInitPWGHeader" title="Interpret IPP attributes to create a page header.">cupsRasterInitPWGHeader</a></li> <li><a href="#cupsRasterWriteHeader" title="Write a raster page header from a version 1 page header structure.">cupsRasterWriteHeader</a> <span class="info">Deprecated in CUPS 1.2/macOS 10.5</span></li> <li><a href="#cupsRasterWriteHeader2" title="Write a raster page header from a version 2 page header structure.">cupsRasterWriteHeader2</a></li> <li><a href="#cupsRasterWritePixels" title="Write raster pixels.">cupsRasterWritePixels</a></li> @@ -250,6 +704,16 @@ void cupsRasterClose(<a href="#cups_raster_t">cups_raster_t</a> *r);</p> <h4 class="discussion">Discussion</h4> <p class="discussion">The file descriptor associated with the raster stream must be closed separately as needed.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsRasterErrorString">cupsRasterErrorString</a></h3> + <p class="description">Return the last error from a raster function.</p> +<p class="code"> +const char *cupsRasterErrorString(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Last error or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">If there are no recent errors, <code>NULL</code> is returned. + +</p> <h3 class="function"><span class="info"> CUPS 2.2/macOS 10.12 </span><a id="cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></h3> <p class="description">Initialize a page header for PWG Raster output.</p> <p class="code"> @@ -286,51 +750,6 @@ The "sheet_back" argument specifies a "pwg-raster-document-sheet- to apply for the back side of a page. Pass <code>NULL</code> for the front side. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></h3> - <p class="description">Interpret PPD commands to create a page header.</p> -<p class="code"> -int cupsRasterInterpretPPD(<a href="#cups_page_header2_t">cups_page_header2_t</a> *h, ppd_file_t *ppd, int num_options, cups_option_t *options, <a href="#cups_interpret_cb_t">cups_interpret_cb_t</a> func);</p> -<h4 class="parameters">Parameters</h4> -<table class="list"><tbody> -<tr><th>h</th> - <td class="description">Page header to create</td></tr> -<tr><th>ppd</th> - <td class="description">PPD file</td></tr> -<tr><th>num_options</th> - <td class="description">Number of options</td></tr> -<tr><th>options</th> - <td class="description">Options</td></tr> -<tr><th>func</th> - <td class="description">Optional page header callback (<code>NULL</code> for none)</td></tr> -</tbody></table> -<h4 class="returnvalue">Return Value</h4> - <p class="description">0 on success, -1 on failure</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">This function is used by raster image processing (RIP) filters like -cgpdftoraster and imagetoraster when writing CUPS raster data for a page. -It is not used by raster printer driver filters which only read CUPS -raster data.<br> -<br> - -<code>cupsRasterInterpretPPD</code> does not mark the options in the PPD using -the "num_options" and "options" arguments. Instead, mark the options with -<code>cupsMarkOptions</code> and <code>ppdMarkOption</code> prior to calling it - -this allows for per-page options without manipulating the options array.<br> -<br> -The "func" argument specifies an optional callback function that is -called prior to the computation of the final raster data. The function -can make changes to the <a href="#cups_page_header2_t"><code>cups_page_header2_t</code></a> data as needed to use a -supported raster format and then returns 0 on success and -1 if the -requested attributes cannot be supported.<br> -<br> - -<code>cupsRasterInterpretPPD</code> supports a subset of the PostScript language. -Currently only the <code>[</code>, <code>]</code>, <code><<</code>, <code>>></code>, <code>{</code>, -<code>}</code>, <code>cleartomark</code>, <code>copy</code>, <code>dup</code>, <code>index</code>, -<code>pop</code>, <code>roll</code>, <code>setpagedevice</code>, and <code>stopped</code> operators -are supported. - -</p> <h3 class="function"><a id="cupsRasterOpen">cupsRasterOpen</a></h3> <p class="description">Open a raster stream using a file descriptor.</p> <p class="code"> @@ -519,11 +938,6 @@ typedef enum <a href="#cups_cut_e">cups_cut_e</a> cups_cut_t; <p class="code"> typedef enum <a href="#cups_edge_e">cups_edge_e</a> cups_edge_t; </p> - <h3 class="typedef"><a id="cups_interpret_cb_t">cups_interpret_cb_t</a></h3> - <p class="description">cupsRasterInterpretPPD callback function</p> - <p class="code"> -typedef int (*cups_interpret_cb_t)(<a href="#cups_page_header2_t">cups_page_header2_t</a> *header, int preferred_bits); -</p> <h3 class="typedef"><a id="cups_jog_t">cups_jog_t</a></h3> <p class="description">Jog attribute values</p> <p class="code"> @@ -975,3 +1389,5 @@ factor not applied) </td></tr> <tr><th>CUPS_ORIENT_90 </th> <td class="description">Rotate the page counter-clockwise</td></tr> </tbody></table> </div> + </body> +</html> diff --git a/doc/cgi.html b/doc/cgi.html index 82d0c0f96..34c6debb3 100644 --- a/doc/cgi.html +++ b/doc/cgi.html @@ -1,7 +1,10 @@ ---- -title: Using CGI Programs -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Using CGI Programs</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Using CGI Programs</H1> @@ -74,3 +77,6 @@ following exceptions:</P> <LI>Limited HTTP field support; only the Content-Length (CONTENT_LENGTH), Content-Type (CONTENT_TYPE), Cookie (HTTP_COOKIE), Referrer (HTTP_REFERRER), and User-Agent (HTTP_USER_AGENT) fields are placed in environment variables at this time</LI> </UL> + +</BODY> +</HTML> diff --git a/doc/cupspm.epub b/doc/cupspm.epub Binary files differindex 00b5d1074..5cd742cd1 100644 --- a/doc/cupspm.epub +++ b/doc/cupspm.epub diff --git a/doc/cupspm.html b/doc/cupspm.html index cc35ed599..4c68087f5 100644 --- a/doc/cupspm.html +++ b/doc/cupspm.html @@ -1,11 +1,180 @@ ---- -title: CUPS Programming Manual -layout: sub ---- - +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>CUPS Programming Manual</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Michael R Sweet"> + <meta name="copyright" content="Copyright © 2007-2019 by Apple Inc. All Rights Reserved."> + <meta name="version" content="2.3.0"> + <style type="text/css"><!-- +body, p, h1, h2, h3, h4 { + font-family: sans-serif; +} +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 0px 10px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + font-size: 90%; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h3 span.info, h4 span.info { + border-top-left-radius: 10px; + border-top-right-radius: 10px; + float: right; + padding: 3px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> <h1 class="title">CUPS Programming Manual</h1> <p>Michael R Sweet</p> - <p>Copyright © 2007-2018 by Apple Inc. All Rights Reserved.</p> + <p>Copyright © 2007-2019 by Apple Inc. All Rights Reserved.</p> <div class="contents"> <h2 class="title">Contents</h2> <ul class="contents"> @@ -28,6 +197,7 @@ layout: sub <li><a href="#authentication">Authentication</a></li> </ul></li> <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> + <li><a href="#CF_OPTIONS">CF_OPTIONS</a></li> <li><a href="#cupsAddDest">cupsAddDest</a></li> <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li> <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li> @@ -317,6 +487,9 @@ layout: sub <li><a href="#cups_option_s">cups_option_s</a></li> <li><a href="#cups_size_s">cups_size_s</a></li> </ul></li> + <li><a href="#VARIABLES">Variables</a><ul class="subcontents"> + <li><a href="#kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></li> + </ul></li> <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> <li><a href="#cups_ptype_e">cups_ptype_e</a></li> <li><a href="#http_encoding_e">http_encoding_e</a></li> @@ -351,7 +524,7 @@ layout: sub <p>CUPS provides the "cups" library to talk to the different parts of CUPS and with Internet Printing Protocol (IPP) printers. The "cups" library functions are accessed by including the <code><cups/cups.h></code> header.</p> <p>CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients (applications) to communicate with a server (the scheduler, printers, etc.) to get a list of destinations, send print jobs, and so forth. You identify which server you want to communicate with using a pointer to the opaque structure <code>http_t</code>. The <code>CUPS_HTTP_DEFAULT</code> constant can be used when you want to talk to the CUPS scheduler.</p> <h3><a id="guidelines">Guidelines</a></h3> - <p>When writing software that uses the "cups" library:</p> + <p>When writing software (other than printer drivers) that uses the "cups" library:</p> <ul> <li>Do not use undocumented or deprecated APIs,</li> <li>Do not rely on pre-configured printers,</li> @@ -360,8 +533,12 @@ layout: sub </ul> <p>CUPS is designed to insulate users and developers from the implementation details of printers and file formats. The goal is to allow an application to supply a print file in a standard format with the user intent ("print four copies, two-sided on A4 media, and staple each copy") and have the printing system manage the printer communication and format conversion needed.</p> <p>Similarly, printer and job management applications can use standard query operations to obtain the status information in a common, generic form and use standard management operations to control the state of those printers and jobs.</p> + <blockquote> + <p><strong>Note:</strong></p> + <p>CUPS printer drivers necessarily depend on specific file formats and certain implementation details of the CUPS software. Please consult the Postscript and raster printer driver developer documentation on <a href="https://www.cups.org/documentation.html">CUPS.org</a> for more information.</p> +</blockquote> <h3><a id="terms-used-in-this-document">Terms Used in This Document</a></h3> - <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print</em> <em>Job</em> is one or more documents that are processed by a destination using options supplied when creating the job. A <em>Document</em> is a file (JPEG image, PDF file, etc.) suitable for printing. An <em>Option</em> controls some aspect of printing, such as the media used. <em>Media</em> is the sheets or roll that is printed on. An <em>Attribute</em> is an option encoded for an Internet Printing Protocol (IPP) request.</p> + <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print</em> <em>Job</em> is a collection of one or more documents that are processed by a destination using options supplied when creating the job. A <em>Document</em> is a file (JPEG image, PDF file, etc.) suitable for printing. An <em>Option</em> controls some aspect of printing, such as the media used. <em>Media</em> is the sheets or roll that is printed on. An <em>Attribute</em> is an option encoded for an Internet Printing Protocol (IPP) request.</p> <h3><a id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></h3> <p>The CUPS libraries can be used from any C, C++, or Objective C program. The method of compiling against the libraries varies depending on the operating system and installation of CUPS. The following sections show how to compile a simple program (shown below) in two common environments.</p> <p>The following simple program lists the available destinations:</p> @@ -442,7 +619,8 @@ int main(void) </ul> <p>The callback function returns 0 to stop enumeration or 1 to continue.</p> <blockquote> - <p>Note that the callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.</p> + <p><strong>Note:</strong></p> + <p>The callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.</p> </blockquote> <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> <pre><code>typedef struct @@ -874,7 +1052,8 @@ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, printer_uri); </code></pre> <blockquote> - <p>Note: If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.</p> + <p><strong>Note:</strong></p> + <p>If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.</p> </blockquote> <p>The <code>ippAddString</code> function adds the "printer-uri" attribute the the IPP request. The <code>IPP_TAG_OPERATION</code> argument specifies that the attribute is part of the operation. The <code>IPP_TAG_URI</code> argument specifies that the value is a Universal Resource Identifier (URI) string. The <code>NULL</code> argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the <code>printer_uri</code> argument specifies the string value.</p> <p>The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:</p> @@ -980,6 +1159,19 @@ cups_password_cb2(const char *prompt, http_t *http, <p>The <code>resource</code> argument specifies the path used for the request.</p> <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p> <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><a id="CF_OPTIONS">CF_OPTIONS</a></h3> + <p class="description"></p> +<p class="code"> +typedef CF_OPTIONS(uint32_t, SecKeyUsage);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>uint32_t</th> +</tr> +<tr><th>SecKeyUsage</th> +</tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description"></p> <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3> <p class="description">Add a destination to the list of destinations.</p> <p class="code"> @@ -5879,6 +6071,10 @@ typedef struct _ipp_s ipp_t; <td class="description">Top margin in hundredths of millimeters</td></tr> </tbody></table> + <h2 class="title"><a id="VARIABLES">Variables</a></h2> + <h3 class="variable"><a id="kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></h3> + <p class="description">Constants, very secure stuff...</p> + <p class="code">extern const void *kSecOidOrganizationalUnit;</p> <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> <p class="description">Printer type/capability bit @@ -5938,6 +6134,7 @@ constants</p> <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th> <td class="description">Accept-Language field</td></tr> <tr><th>HTTP_FIELD_ACCEPT_RANGES </th> <td class="description">Accept-Ranges field</td></tr> <tr><th>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Allow field </td></tr> + <tr><th>HTTP_FIELD_AUTHENTICATION_INFO <span class="info"> CUPS 2.2.9) </span></th> <td class="description">Authentication-Info field (</td></tr> <tr><th>HTTP_FIELD_AUTHORIZATION </th> <td class="description">Authorization field</td></tr> <tr><th>HTTP_FIELD_CONNECTION </th> <td class="description">Connection field</td></tr> <tr><th>HTTP_FIELD_CONTENT_ENCODING </th> <td class="description">Content-Encoding field</td></tr> @@ -6424,3 +6621,5 @@ are server-oriented...</p> <tr><th>IPP_TAG_ZERO </th> <td class="description">Zero tag - used for separators</td></tr> </tbody></table> </div> + </body> +</html> diff --git a/doc/encryption.html b/doc/encryption.html index 007a25745..55f4eaf6f 100644 --- a/doc/encryption.html +++ b/doc/encryption.html @@ -1,8 +1,11 @@ ---- -title: Managing Encryption -layout: sub ---- - +<!doctype html> +<html> +<!-- SECTION: Getting Started --> + <head> + <title>Managing Encryption</title> + <link rel="STYLESHEET" type="text/css" href="../cups-printable.css"> + </head> + <body> <h1 class="title">Managing Encryption</h1> <p>CUPS supports TLS encryption in two ways:</p> <ol> @@ -48,3 +51,5 @@ SSLOptions AllowRC4 AllowSSL3 <h3>Other Platforms</h3> <p>Other platforms only use the <var>client.conf</var> file and PEM-encoded certificates (<i>hostname</i>.crt) and private keys (<i>hostname</i>.key) in the <var>/etc/cups/ssl</var> and <var>~/.cups/ssl</var> directories. If present, the <var>/etc/cups/ssl/site.crt</var> file defines a site-wide CA certificate that is used to validate server and printer certificates. Certificates for known servers and printers are stored by CUPS in the corresponding <var>ssl</var> directory so they can be validated for subsequent connections.</p> <p>CUPS also supports certificates created and managed by the popular <a href="https://letsencrypt.org/">Let's Encrypt</a> certificate service, which are stored in the <var>/etc/letsencrypt/live</var> directory.</p> + </body> +</html> diff --git a/doc/firewalls.html b/doc/firewalls.html index f41148dd2..34f14cd21 100644 --- a/doc/firewalls.html +++ b/doc/firewalls.html @@ -1,8 +1,11 @@ ---- -title: Firewalls -layout: sub ---- - +<!DOCTYPE html> +<html> +<!-- SECTION: Getting Started --> + <head> + <title>Firewalls</title> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + </head> + <body> <h1 class="title">Firewalls</h1> <p>This help document describes the ports that CUPS uses so that firewall administrators can allow traffic used for printing.</p> @@ -67,3 +70,5 @@ layout: sub <tr><td>9100-9102</td><td>TCP</td><td>Raw print data stream (AppSocket/JetDirect).</td></tr> </tbody> </table></div> + </body> +</html> diff --git a/doc/glossary.html b/doc/glossary.html index fa7241100..6bd6137c9 100644 --- a/doc/glossary.html +++ b/doc/glossary.html @@ -1,7 +1,10 @@ ---- -title: Glossary -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Glossary</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Glossary</H1> @@ -208,3 +211,6 @@ layout: sub <DD>Unicode Transfer Format 8-Bit </DL> + +</BODY> +</HTML> diff --git a/doc/kerberos.html b/doc/kerberos.html index 2f5ed2ebe..9d5a9ee24 100644 --- a/doc/kerberos.html +++ b/doc/kerberos.html @@ -1,7 +1,10 @@ ---- -title: Using Kerberos Authentication -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Using Kerberos Authentication</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Using Kerberos Authentication</H1> @@ -79,3 +82,6 @@ http://server.example.com:631/admin <P>When doing printing tasks that require authentication, CUPS requests single-use "tickets" from your login session to authenticate who you are. These tickets give CUPS a username of the form "user@REALM", which is then truncated to just "user" for purposes of user and group checks.</P> <P>In order to support printing to a shared printer, CUPS runs the IPP or SMB backend as the owner of the print job so it can obtain the necessary credentials when the job is de-spooled to the server.</P> + +</BODY> +</HTML> diff --git a/doc/license.html b/doc/license.html index 19023e12c..9c98b279a 100644 --- a/doc/license.html +++ b/doc/license.html @@ -1,7 +1,10 @@ ---- -title: Apache License Version 2.0 -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Apache License Version 2.0</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <h1>Apache License</h1> @@ -183,3 +186,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </pre> + +</BODY> +</HTML> diff --git a/doc/man-backend.html b/doc/man-backend.html index 12356c4bc..b1a0385d5 100644 --- a/doc/man-backend.html +++ b/doc/man-backend.html @@ -1,8 +1,11 @@ ---- -title: backend(7) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>backend(7)</title> +</head> +<body> <h1 class="title">backend(7)</h1> <h2 class="title"><a name="NAME">Name</a></h2> backend - cups backend transmission interfaces @@ -44,10 +47,11 @@ backend - cups backend transmission interfaces </pre> <h2 class="title"><a name="DESCRIPTION">Description</a></h2> Backends are a special type of -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7)</a> +<b>filter</b>(7) which is used to send print data to and discover different devices on the system. <p>Like filters, backends must be capable of reading from a filename on the command-line or from the standard input, copying the standard input to a temporary file as required by the physical interface. -<p>The command name (<i>argv[0]</i>) is set to the device URI of the destination printer. Authentication information in +<p>The command name (<i>argv[0]</i>) is set to the device URI of the destination printer. +Authentication information in <i>argv[0]</i> is removed, so backend developers are urged to use the <b>DEVICE_URI</b> @@ -63,7 +67,8 @@ function. The <b>CUPS_SC_FD</b> constant defines the file descriptor that should be monitored for incoming requests. <h3><a name="DEVICE_DISCOVERY">Device Discovery</a></h3> -When run with no arguments, the backend should list the devices and schemes it supports or is advertising to the standard output. The output consists of zero or more lines consisting of any of the following forms: +When run with no arguments, the backend should list the devices and schemes it supports or is advertising to the standard output. +The output consists of zero or more lines consisting of any of the following forms: <pre class="man"> device-class scheme "Unknown" "device-info" @@ -86,19 +91,24 @@ field is one of the following values: <dd style="margin-left: 5.0em">The device-uri refers to a networked device and conforms to the general form for network URIs. <dt><b>serial</b> -<dd style="margin-left: 5.0em">The device-uri refers to a serial device with configurable baud rate and other options. If the device-uri contains a baud value, it represents the maximum baud rate supported by the device. +<dd style="margin-left: 5.0em">The device-uri refers to a serial device with configurable baud rate and other options. +If the device-uri contains a baud value, it represents the maximum baud rate supported by the device. </dl> <p>The <i>scheme</i> -field provides the URI scheme that is supported by the backend. Backends should use this form only when the backend supports any URI using that scheme. The +field provides the URI scheme that is supported by the backend. +Backends should use this form only when the backend supports any URI using that scheme. +The <i>device-uri</i> field specifies the full URI to use when communicating with the device. <p>The <i>device-make-and-model</i> -field specifies the make and model of the device, e.g. "Example Foojet 2000". If the make and model is not known, you must report "Unknown". +field specifies the make and model of the device, e.g. "Example Foojet 2000". +If the make and model is not known, you must report "Unknown". <p>The <i>device-info</i> -field specifies additional information about the device. Typically this includes the make and model along with the port number or network address, e.g. "Example Foojet 2000 USB #1". +field specifies additional information about the device. +Typically this includes the make and model along with the port number or network address, e.g. "Example Foojet 2000 USB #1". <p>The optional <i>device-id</i> field specifies the IEEE-1284 device ID string for the device, which is used to select a matching driver. @@ -106,7 +116,8 @@ field specifies the IEEE-1284 device ID string for the device, which is used to <i>device-location</i> field specifies the physical location of the device, which is often used to pre-populate the printer-location attribute when adding a printer. <h3><a name="PERMISSIONS">Permissions</a></h3> -Backends without world read and execute permissions are run as the root user. Otherwise, the backend is run using an unprivileged user account, typically "lp". +Backends without world read and execute permissions are run as the root user. +Otherwise, the backend is run using an unprivileged user account, typically "lp". <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> The following exit codes are defined for backends: <dl class="man"> @@ -114,28 +125,35 @@ The following exit codes are defined for backends: <dd style="margin-left: 5.0em">The print file was successfully transmitted to the device or remote server. <dt><b>CUPS_BACKEND_FAILED</b> <dd style="margin-left: 5.0em"><br> -The print file was not successfully transmitted to the device or remote server. The scheduler will respond to this by canceling the job, retrying the job, or stopping the queue depending on the state of the +The print file was not successfully transmitted to the device or remote server. +The scheduler will respond to this by canceling the job, retrying the job, or stopping the queue depending on the state of the <i>printer-error-policy</i> attribute. <dt><b>CUPS_BACKEND_AUTH_REQUIRED</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because valid authentication information is required. The scheduler will respond to this by holding the job and adding the 'cups-held-for-authentication' keyword to the "job-reasons" Job Description attribute. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because valid authentication information is required. +The scheduler will respond to this by holding the job and adding the 'cups-held-for-authentication' keyword to the "job-reasons" Job Description attribute. <dt><b>CUPS_BACKEND_HOLD</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by holding the job. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. +The scheduler will respond to this by holding the job. <dt><b>CUPS_BACKEND_STOP</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by stopping the queue. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. +The scheduler will respond to this by stopping the queue. <dt><b>CUPS_BACKEND_CANCEL</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because one or more attributes are not supported or the job was canceled at the printer. The scheduler will respond to this by canceling the job. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because one or more attributes are not supported or the job was canceled at the printer. +The scheduler will respond to this by canceling the job. <dt><b>CUPS_BACKEND_RETRY</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job at a future time - other jobs may print before this one. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. +The scheduler will retry the job at a future time - other jobs may print before this one. <dt><b>CUPS_BACKEND_RETRY_CURRENT</b> -<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job immediately without allowing intervening jobs. +<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. +The scheduler will retry the job immediately without allowing intervening jobs. </dl> <p>All other exit code values are reserved. <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> In addition to the environment variables listed in -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a> +<b>cups</b>(1) and -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a> +<b>filter</b>(7), CUPS backends can expect the following environment variable: <dl class="man"> <dt><b>DEVICE_URI</b> @@ -144,20 +162,28 @@ CUPS backends can expect the following environment variable: <h2 class="title"><a name="FILES">Files</a></h2> <i>/etc/cups/cups-files.conf</i> <h2 class="title"><a name="NOTES">Notes</a></h2> -CUPS backends are not generally designed to be run directly by the user. Aside from the device URI issue ( +CUPS backends are not generally designed to be run directly by the user. +Aside from the device URI issue ( <i>argv[0]</i> and <b>DEVICE_URI</b> -environment variable contain the device URI), CUPS backends also expect specific environment variables and file descriptors, and typically run in a user session that (on macOS) has additional restrictions that affect how it runs. Backends can also be installed with restricted permissions (0500 or 0700) that tell the scheduler to run them as the "root" user instead of an unprivileged user (typically "lp") on the system. -<p>Unless you are a developer and know what you are doing, please do not run backends directly. Instead, use the -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a> +environment variable contain the device URI), CUPS backends also expect specific environment variables and file descriptors, and typically run in a user session that (on macOS) has additional restrictions that affect how it runs. +Backends can also be installed with restricted permissions (0500 or 0700) that tell the scheduler to run them as the "root" user instead of an unprivileged user (typically "lp") on the system. +<p>Unless you are a developer and know what you are doing, please do not run backends directly. +Instead, use the +<b>lp</b>(1) or -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a> +<b>lpr</b>(1) programs to send print jobs or -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> -to query for available printers using the backend. The one exception is the SNMP backend - see +<b>lpinfo</b>(8) +to query for available printers using the backend. +The one exception is the SNMP backend - see <a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8)</a> for more information. +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <i>cups</i>(1), <i>cups-files.conf</i>(5), @@ -170,4 +196,7 @@ for more information. <br> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cancel.html b/doc/man-cancel.html index 7c5cb0400..ef6f3f45d 100644 --- a/doc/man-cancel.html +++ b/doc/man-cancel.html @@ -1,8 +1,11 @@ ---- -title: cancel(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cancel(1)</title> +</head> +<body> <h1 class="title">cancel(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cancel - cancel jobs @@ -75,9 +78,12 @@ Administrators wishing to prevent unauthorized cancellation of jobs via the <i>- <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5).</a> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpmove.html?TOPIC=Man+Pages"><b>lpmove</b>(8),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>lp</b>(1), +<b>lpmove</b>(8), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-classes.conf.html b/doc/man-classes.conf.html index 5c2965538..da5126d60 100644 --- a/doc/man-classes.conf.html +++ b/doc/man-classes.conf.html @@ -1,24 +1,32 @@ ---- -title: classes.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>classes.conf(5)</title> +</head> +<body> <h1 class="title">classes.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> classes.conf - class configuration file for cups <h2 class="title"><a name="DESCRIPTION">Description</a></h2> -The <b>classes.conf</b> file defines the local printer classes that are available. It is normally located in the <i>/etc/cups</i> directory and is maintained by the +The <b>classes.conf</b> file defines the local printer classes that are available. +It is normally located in the <i>/etc/cups</i> directory and is maintained by the <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a> -program. This file is not intended to be edited or managed manually. +program. +This file is not intended to be edited or managed manually. <h2 class="title"><a name="NOTES">Notes</a></h2> The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> -<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>printers.conf</b>(5), +<b>subscriptions.conf</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-client.conf.html b/doc/man-client.conf.html index 6c52effd8..58b091fe0 100644 --- a/doc/man-client.conf.html +++ b/doc/man-client.conf.html @@ -1,11 +1,14 @@ ---- -title: client.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>client.conf(5)</title> +</head> +<body> <h1 class="title">client.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -client.conf - client configuration file for cups +client.conf - client configuration file for cups (deprecated on macos) <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The <b>client.conf</b> file configures the CUPS client and is normally located in the <i>/etc/cups</i> and/or <i>~/.cups</i> directories. Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. @@ -57,6 +60,22 @@ Not all operating systems support TLS 1.3 at this time. The default is "Yes". <dt><b>User </b><i>name</i> <dd style="margin-left: 5.0em">Specifies the default user name to use for requests. +<dt><a name="UserAgentTokens"></a><b>UserAgentTokens None</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens ProductOnly</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Major</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minor</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minimal</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens OS</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Full</b> +<dd style="margin-left: 5.0em">Specifies what information is included in the User-Agent header of HTTP requests. +"None" disables the User-Agent header. +"ProductOnly" reports "CUPS". +"Major" reports "CUPS/major IPP/2". +"Minor" reports "CUPS/major.minor IPP/2.1". +"Minimal" reports "CUPS/major.minor.patch IPP/2.1". +"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1". +"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1". +The default is "Minimal". <dt><b>ValidateCerts Yes</b> <dd style="margin-left: 5.0em"><dt><b>ValidateCerts No</b> <dd style="margin-left: 5.0em">Specifies whether to only allow TLS with certificates whose common name matches the hostname. @@ -75,8 +94,11 @@ defaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption </pre> On Linux and other systems using GNU TLS, the <i>/etc/cups/ssl/site.crl</i> file, if present, provides a list of revoked X.509 certificates and is used when validating certificates. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>cups</b>(1), <b>default</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups-config.html b/doc/man-cups-config.html index 8927484ad..e8d025f73 100644 --- a/doc/man-cups-config.html +++ b/doc/man-cups-config.html @@ -1,8 +1,11 @@ ---- -title: cups-config(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cups-config(1)</title> +</head> +<body> <h1 class="title">cups-config(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cups-config - get cups api, compiler, directory, and link information. @@ -58,9 +61,6 @@ The <b>cups-config</b> command accepts the following command-line options: <dd style="margin-left: 5.0em">Reports the default CUPS data directory. <dt><b>--help</b> <dd style="margin-left: 5.0em">Reports the program usage message. -<dt><b>--image</b> -<dd style="margin-left: 5.0em">When used with <i>--libs</i>, adds the CUPS imaging library to the -list of libraries. <dt><b>--ldflags</b> <dd style="margin-left: 5.0em">Reports the necessary linker options. <dt><b>--libs</b> @@ -87,8 +87,17 @@ Compile a simple one-file CUPS filter: cc `cups-config --cflags --ldflags` -o filter filter.c \ `cups-config --libs` </pre> +<h2 class="title"><a name="DEPRECATED_OPTIONS">Deprecated Options</a></h2> +The following options are deprecated but continue to work for backwards compatibility: +<dl class="man"> +<dt><b>--image</b> +<dd style="margin-left: 5.0em">Formerly used to add the CUPS imaging library to the list of libraries. +</dl> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>cups</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups-files.conf.html b/doc/man-cups-files.conf.html index 894c67d04..27a1b60da 100644 --- a/doc/man-cups-files.conf.html +++ b/doc/man-cups-files.conf.html @@ -1,8 +1,11 @@ ---- -title: cups-files.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cups-files.conf(5)</title> +</head> +<body> <h1 class="title">cups-files.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cups-files.conf - file and directory configuration file for cups @@ -196,14 +199,17 @@ command, while on macOS the <b>launchctl</b>(8) command is used instead. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>classes.conf</b>(5), +<b>cups</b>(1), <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> -<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>printers.conf</b>(5), +<b>subscriptions.conf</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups-lpd.html b/doc/man-cups-lpd.html index 8c0f335b5..7283d7563 100644 --- a/doc/man-cups-lpd.html +++ b/doc/man-cups-lpd.html @@ -1,11 +1,14 @@ ---- -title: cups-lpd(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cups-lpd(8)</title> +</head> +<body> <h1 class="title">cups-lpd(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -cups-lpd - receive print jobs and report printer status to lpd clients +cups-lpd - receive print jobs and report printer status to lpd clients (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>cups-lpd</b> [ @@ -52,6 +55,9 @@ Errors are sent to the system log. <i>/System/Library/LaunchDaemons/org.cups.cups-lpd.plist</i> </pre> <h2 class="title"><a name="NOTES">Notes</a></h2> +The +<b>cups-lpd</b> +program is deprecated and will no longer be supported in a future feature release of CUPS. <h3><a name="PERFORMANCE">Performance</a></h3> <b>cups-lpd</b> performs well with small numbers of clients and printers. @@ -96,7 +102,7 @@ Simply enable the <b>cups-lpd</b> service using the corresponding control program. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>cups</b>(1), <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <b>inetconv</b>(1m), <b>inetd</b>(8), @@ -105,4 +111,7 @@ service using the corresponding control program. CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, RFC 2569 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups-snmp.conf.html b/doc/man-cups-snmp.conf.html index fde2c01e1..fbd2dc4eb 100644 --- a/doc/man-cups-snmp.conf.html +++ b/doc/man-cups-snmp.conf.html @@ -1,11 +1,14 @@ ---- -title: snmp.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>snmp.conf(5)</title> +</head> +<body> <h1 class="title">snmp.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -snmp.conf - snmp configuration file for cups +snmp.conf - snmp configuration file for cups (deprecated) <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The <b>snmp.conf</b> @@ -43,8 +46,15 @@ The default is "off". network for printers. The default is 120 seconds (2 minutes). </dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8),</a> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups-snmp.html b/doc/man-cups-snmp.html index 189467e12..9ff2b9aef 100644 --- a/doc/man-cups-snmp.html +++ b/doc/man-cups-snmp.html @@ -1,11 +1,14 @@ ---- -title: cups-snmp(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cups-snmp(8)</title> +</head> +<body> <h1 class="title">cups-snmp(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -snmp - cups snmp backend +snmp - cups snmp backend (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>/usr/lib/cups/backend/snmp</b> <i>ip-address-or-hostname</i> @@ -24,7 +27,7 @@ Additional queries are then sent to printers that respond in order to determine <p>In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname. This can be used for programs that need to configure print queues where the user has supplied an address but nothing else. <p>In the second form, the SNMP backend is run indirectly using the -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +<b>lpinfo</b>(8) command. The output provides all printers detected via SNMP on the configured broadcast addresses. @@ -42,10 +45,13 @@ version of CUPS. <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a> -<a href="man-cups-snmp.conf.html?TOPIC=Man+Pages"><b>cups-snmp.conf</b>(5),</a> +<b>backend</b>(7), +<b>cups-snmp.conf</b>(5), <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> +<b>lpinfo</b>(8), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cups.html b/doc/man-cups.html index 175d22fd3..769ffe64c 100644 --- a/doc/man-cups.html +++ b/doc/man-cups.html @@ -1,8 +1,11 @@ ---- -title: cups(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cups(1)</title> +</head> +<body> <h1 class="title">cups(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cups - a standards-based, open source printing system @@ -32,9 +35,9 @@ The easiest way to start is by using the web interface to configure your printer <p>After the printer is added you will be asked to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click/press on the Set Default Options button to save them. Some printers also support auto-configuration - click/press on the Query Printer for Default Options button to update the options automatically. <p>Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly. <p>You can also use the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) and -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +<b>lpinfo</b>(8) commands to add printers to <b>CUPS</b>. Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer. @@ -93,21 +96,28 @@ commands use the following environment variables to override the default locatio <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> <b>CUPS</b> conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands. +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> +<b>cancel</b>(1), <a href="man-client.conf.html?TOPIC=Man+Pages"><b>client.conf</b>(7),</a> -<a href="man-cupsctl.html?TOPIC=Man+Pages"><b>cupsctl</b>(8),</a> +<b>cupsctl</b>(8), <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> +<b>lp</b>(1), +<b>lpadmin</b>(8), +<b>lpinfo</b>(8), <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> -<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>lpr</b>(1), +<b>lprm</b>(1), +<b>lpq</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, CUPS Web Site (<a href="http://www.CUPS.org)">http://www.CUPS.org)</a>, PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsaccept.html b/doc/man-cupsaccept.html index 989ce36b8..a8925685d 100644 --- a/doc/man-cupsaccept.html +++ b/doc/man-cupsaccept.html @@ -1,8 +1,11 @@ ---- -title: cupsaccept(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsaccept(8)</title> +</head> +<body> <h1 class="title">cupsaccept(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsaccept/cupsreject - accept/reject jobs sent to a destination @@ -67,12 +70,15 @@ Unlike the System V printing system, CUPS allows printer names to contain any pr Also, printer and class names are <i>not</i> case-sensitive. <p>Finally, the CUPS versions may ask the user for an access password depending on the printing system configuration. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>cancel</b>(1), +<b>cupsenable</b>(8), +<b>lp</b>(1), +<b>lpadmin</b>(8), +<b>lpstat</b>(1), <br> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsctl.html b/doc/man-cupsctl.html index 15c2e95c0..897b0541e 100644 --- a/doc/man-cupsctl.html +++ b/doc/man-cupsctl.html @@ -1,8 +1,11 @@ ---- -title: cupsctl(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsctl(8)</title> +</head> +<body> <h1 class="title">cupsctl(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsctl - configure cupsd.conf options @@ -85,4 +88,7 @@ You cannot set the Listen or Port directives using <b>cupsctl</b>. <br> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsd-helper.html b/doc/man-cupsd-helper.html index 0cee81143..308a3a236 100644 --- a/doc/man-cupsd-helper.html +++ b/doc/man-cupsd-helper.html @@ -1,11 +1,14 @@ ---- -title: cupsd-helper(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsd-helper(8)</title> +</head> +<body> <h1 class="title">cupsd-helper(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -cupsd-helper - cupsd helper programs +cupsd-helper - cupsd helper programs (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>cups-deviced</b> <i>request-id</i> @@ -43,7 +46,7 @@ cupsd-helper - cupsd helper programs The <b>cupsd-helper</b> programs perform long-running operations on behalf of the scheduler, <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a> The <b>cups-deviced</b> helper program runs each CUPS -<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7)</a> +<b>backend</b>(7) with no arguments in order to discover the available printers. <p>The <b>cups-driverd</b> helper program lists all available printer drivers, a subset of "matching" printer drivers, or a copy of a specific driver PPD file. <p>The <b>cups-exec</b> helper program runs backends, filters, and other programs. On macOS these programs are run in a secure sandbox. @@ -65,14 +68,21 @@ program or placed in compressed <b>tar</b>(1) archives to further reduce their size. <p>Driver information files must conform to the format defined in -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5).</a> +<b>ppdcfile</b>(5). +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>backend</b>(7), +<b>cups</b>(1), <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a> -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a> +<b>filter</b>(7), +<b>ppdcfile</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsd-logs.html b/doc/man-cupsd-logs.html index 956ea0a8a..42d06faad 100644 --- a/doc/man-cupsd-logs.html +++ b/doc/man-cupsd-logs.html @@ -1,8 +1,11 @@ ---- -title: cupsd-logs(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsd-logs(5)</title> +</head> +<body> <h1 class="title">cupsd-logs(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsd-logs - cupsd log files (access_log, error_log, and page_log) @@ -175,4 +178,7 @@ The format of this field is identical to the data-time field in the <i>access_lo <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsd.conf.html b/doc/man-cupsd.conf.html index 0e8be938f..f889b866f 100644 --- a/doc/man-cupsd.conf.html +++ b/doc/man-cupsd.conf.html @@ -1,8 +1,11 @@ ---- -title: cupsd.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsd.conf(5)</title> +</head> +<body> <h1 class="title">cupsd.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsd.conf - server configuration file for cups @@ -220,7 +223,7 @@ The value "0" disables log rotation. The default is "1048576" (1MB). <dt><a name="MultipleOperationTimeout"></a><b>MultipleOperationTimeout </b><i>seconds</i> <dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job. -The default is "300" (5 minutes). +The default is "900" (15 minutes). <dt><a name="Policy"></a><b><Policy </b><i>name</i><b>> </b>... <b></Policy></b> <dd style="margin-left: 5.0em">Specifies access control for the named policy. <dt><a name="Port"></a><b>Port </b><i>number</i> @@ -264,13 +267,11 @@ command. <dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses. "None" disables the Server header. "ProductOnly" reports "CUPS". -"Major" reports "CUPS 2". -"Minor" reports "CUPS 2.0". -"Minimal" reports "CUPS 2.0.0". -"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the -<b>uname</b>(1) -command. -"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0". +"Major" reports "CUPS/major IPP/2". +"Minor" reports "CUPS/major.minor IPP/2.1". +"Minimal" reports "CUPS/major.minor.patch IPP/2.1". +"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1". +"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1". The default is "Minimal". <dt><a name="SSLListen"></a><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i> <dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i> @@ -298,7 +299,7 @@ Not all operating systems support TLS 1.3 at this time. The default is "No". <dt><a name="Timeout"></a><b>Timeout </b><i>seconds</i> <dd style="margin-left: 5.0em">Specifies the HTTP request timeout. -The default is "300" (5 minutes). +The default is "900" (15 minutes). <dt><a name="WebInterface"></a><b>WebInterface yes</b> <dd style="margin-left: 5.0em"><dt><b>WebInterface no</b> <dd style="margin-left: 5.0em">Specifies whether the web interface is enabled. @@ -607,13 +608,16 @@ Require authentication for accesses from outside the 10. network: </Location> </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> +<b>classes.conf</b>(5), <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> -<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>printers.conf</b>(5), +<b>subscriptions.conf</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsd.html b/doc/man-cupsd.html index 8d2662384..d99136a1b 100644 --- a/doc/man-cupsd.html +++ b/doc/man-cupsd.html @@ -1,8 +1,11 @@ ---- -title: cupsd(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsd(8)</title> +</head> +<body> <h1 class="title">cupsd(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsd - cups scheduler @@ -98,20 +101,23 @@ in the foreground with a test configuration file called </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a> -<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>backend</b>(7), +<b>classes.conf</b>(5), +<b>cups</b>(1), <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cups-lpd.html?TOPIC=Man+Pages"><b>cups-lpd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-cupsd-helper.html?TOPIC=Man+Pages"><b>cupsd-helper</b>(8),</a> -<a href="man-cupsd-logs.html?TOPIC=Man+Pages"><b>cupsd-logs</b>(8),</a> -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a> +<b>cupsd-helper</b>(8), +<b>cupsd-logs</b>(8), +<b>filter</b>(7), <b>launchd</b>(8), -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>printers.conf</b>(5), <b>systemd</b>(8), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsenable.html b/doc/man-cupsenable.html index e9f3cd769..04279a5fc 100644 --- a/doc/man-cupsenable.html +++ b/doc/man-cupsenable.html @@ -1,8 +1,11 @@ ---- -title: cupsenable(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsenable(8)</title> +</head> +<body> <h1 class="title">cupsenable(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupsdisable, cupsenable - stop/start printers and classes @@ -75,12 +78,15 @@ build-in commands of the same names. <p>The CUPS versions of <b>disable</b> and <b>enable</b> may ask the user for an access password depending on the printing system configuration. This differs from the System V versions which require the root user to execute these commands. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a> +<b>cupsaccept</b>(8), <b>cupsreject</b>(8), -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpadmin</b>(8), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupsfilter.html b/doc/man-cupsfilter.html index 23781dc7a..6e9d81d89 100644 --- a/doc/man-cupsfilter.html +++ b/doc/man-cupsfilter.html @@ -1,11 +1,14 @@ ---- -title: cupsfilter(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupsfilter(8)</title> +</head> +<body> <h1 class="title">cupsfilter(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -cupsfilter - convert a file to another format using cups filters +cupsfilter - convert a file to another format using cups filters (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>cupsfilter</b> [ @@ -89,7 +92,7 @@ generates a PDF file. The converted file is sent to the standard output. returns a non-zero exit status on any error. <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> All of the standard -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a> +<b>cups</b>(1) environment variables affect the operation of <b>cupsfilter</b>. <h2 class="title"><a name="FILES">Files</a></h2> @@ -100,7 +103,10 @@ environment variables affect the operation of /usr/share/cups/mime/*.convs /usr/share/cups/mime/*.types <h2 class="title"><a name="NOTES">Notes</a></h2> -Unlike when printing, filters run using the +CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). +<p>Unlike when printing, filters run using the <b>cupsfilter</b> command use the current user and security session. This may result in different output or unexpected behavior. <h2 class="title"><a name="EXAMPLE">Example</a></h2> @@ -110,11 +116,14 @@ The following command will generate a PDF preview of job 42 for a printer named cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>cups</b>(1), <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <b>filter(7),</b> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(7),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(7),</a> +<b>mime.convs</b>(7), +<b>mime.types</b>(7), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-cupstestppd.html b/doc/man-cupstestppd.html index 6bd6ce805..99701c954 100644 --- a/doc/man-cupstestppd.html +++ b/doc/man-cupstestppd.html @@ -1,8 +1,11 @@ ---- -title: cupstestppd(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>cupstestppd(1)</title> +</head> +<body> <h1 class="title">cupstestppd(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> cupstestppd - test conformance of ppd files @@ -113,9 +116,16 @@ The next command tests all PPD files under the current directory and print detai find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \ -exec cupstestppd -v '{}' \; </pre> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> +<b>lpadmin</b>(8), CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, Adobe PostScript Printer Description File Format Specification, Version 4.3. <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-filter.html b/doc/man-filter.html index a250ad831..c8070497b 100644 --- a/doc/man-filter.html +++ b/doc/man-filter.html @@ -1,8 +1,11 @@ ---- -title: filter(7) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>filter(7)</title> +</head> +<body> <h1 class="title">filter(7)</h1> <h2 class="title"><a name="NAME">Name</a></h2> filter - cups file conversion filter interface @@ -162,19 +165,25 @@ for a regular print file. <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> While the filter interface is compatible with System V interface scripts, CUPS does not support System V interface scripts. <h2 class="title"><a name="NOTES">Notes</a></h2> -CUPS filters are not meant to be run directly by the user. +CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). +<p>CUPS filters are not meant to be run directly by the user. Aside from the legacy System V interface issues (<i>argv[0]</i> is the printer name), CUPS filters also expect specific environment variables and file descriptors, and typically run in a user session that (on macOS) has additional restrictions that affect how it runs. Unless you are a developer and know what you are doing, please do not run filters directly. Instead, use the -<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8)</a> +<b>cupsfilter</b>(8) program to use the appropriate filters to do the conversions you need. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a> -<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> +<b>backend</b>(7), +<b>cups</b>(1), <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a> +<b>cupsfilter</b>(8), <br> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ippevepcl.html b/doc/man-ippevepcl.html new file mode 100644 index 000000000..529f6da80 --- /dev/null +++ b/doc/man-ippevepcl.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ippevepcl/ps(7)</title> +</head> +<body> +<h1 class="title">ippevepcl/ps(7)</h1> +<h2 class="title"><a name="NAME">Name</a></h2> +ippevepcl/ps - pcl and postscript print commands for ippeveprinter +<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> +<b>ippevepcl</b> +[ +<i>filename</i> +] +<br> +<b>ippeveps</b> +[ +<i>filename</i> +] +<h2 class="title"><a name="DESCRIPTION">Description</a></h2> +<b>ippevepcl</b> +and +<b>ippeveps</b> +are print commands for +<b>ippeveprinter</b>(1). +As with all print commands, these commands read either the filename specified on the command-line or from the standard input. +Output is sent to the standard output. +Status and progress messages are sent to the standard error. +<p><b>ippevepcl</b> +prints to B&W HP PCL laser printers and supports printing of HP PCL (application/vnd.hp-pcl), PWG Raster (image/pwg-raster), and Apple Raster (image/urf) print files. +<p><b>ippeveps</b> +print to Adobe PostScript printers and supports printing of PDF (application/pdf), PostScript (application/postscript), JPEG (image/jpeg), PWG Raster (image/pwg-raster), and Apple Raster (image/urf) print files. +Printer-specific commands are read from a supplied PPD file. +If no PPD file is specified, generic commands suitable for any Level 2 or Level 3 PostScript printer are used instead to specify duplex printing and media size. +<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> +These programs return 1 on error and 0 on success. +<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> +These program inherit the environment provided by the +<b>ippeveprinter</b> +program. +<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> +<b>ippeveprinter</b>(8) +<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> +Copyright © 2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ippeveprinter.html b/doc/man-ippeveprinter.html new file mode 100644 index 000000000..7e4b0a94c --- /dev/null +++ b/doc/man-ippeveprinter.html @@ -0,0 +1,221 @@ +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ippeveprinter(1)</title> +</head> +<body> +<h1 class="title">ippeveprinter(1)</h1> +<h2 class="title"><a name="NAME">Name</a></h2> +ippeveprinter - an ipp everywhere printer application for cups +<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> +<b>ippeveprinter</b> +[ +<b>--help</b> +] [ +<b>--no-web-forms</b> +] [ +<b>--version</b> +] [ +<b>-2</b> +] [ +<b>-D</b> +<i>device-uri</i> +] [ +<b>-K</b> +<i>keypath</i> +] [ +<b>-M</b> +<i>manufacturer</i> +] [ +<b>-P</b> +<i>filename.ppd</i> +] [ +<b>-V</b> +<i>ipp-version</i> +] [ +<b>-a</b> +<i>filename.conf</i> +] [ +<b>-c</b> +<i>command</i> +] [ +<b>-d</b> +<i>spool-directory</i> +] [ +<b>-f</b> +<i>type/subtype[,...]</i> +] [ +<b>-i</b> +<i>iconfile.png</i> +] [ +<b>-k</b> +] [ +<b>-l</b> +<i>location</i> +] [ +<b>-m</b> +<i>model</i> +] [ +<b>-n</b> +<i>hostname</i> +] [ +<b>-p</b> +<i>port</i> +] [ +<b>-r</b> +<i>subtype[,subtype]</i> +] [ +<b>-s</b> +<i>speed[,color-speed]</i> +] [ +<b>-v[vvv]</b> +] +<i>service-name</i> +<h2 class="title"><a name="DESCRIPTION">Description</a></h2> +<b>ippeveprinter</b> +is a simple Internet Printing Protocol (IPP) server conforming to the IPP Everywhere (PWG 5100.14) specification. It can be used to test client software or act as a very basic print server that runs a command for every job that is printed. +<h2 class="title"><a name="OPTIONS">Options</a></h2> +The following options are recognized by +<b>ippeveprinter:</b> +<dl class="man"> +<dt><b>--help</b> +<dd style="margin-left: 5.0em">Show program usage. +<dt><b>--no-web-forms</b> +<dd style="margin-left: 5.0em">Disable the web interface forms used to update the media and supply levels. +<dt><b>--version</b> +<dd style="margin-left: 5.0em">Show the CUPS version. +<dt><b>-2</b> +<dd style="margin-left: 5.0em">Report support for two-sided (duplex) printing. +<dt><b>-D </b><i>device-uri</i> +<dd style="margin-left: 5.0em">Set the device URI for print output. +The URI can be a filename, directory, or a network socket URI of the form "socket://ADDRESS[:PORT]" (where the default port number is 9100). +When specifying a directory, +<b>ippeveprinter</b> +will create an output file using the job ID and name. +<dt><b>-M </b><i>manufacturer</i> +<dd style="margin-left: 5.0em">Set the manufacturer of the printer. +The default is "Example". +<dt><b>-P </b><i>filename.ppd</i> +<dd style="margin-left: 5.0em">Load printer attributes from the specified PPD file. +This option is typically used in conjunction with the +<b>ippeveps</b>(7) +printer command ("-c ippeveps"). +<dt><b>-V 1.1</b> +<dd style="margin-left: 5.0em"><dt><b>-V 2.0</b> +<dd style="margin-left: 5.0em">Specifies the maximum IPP version to report. +2.0 is the default. +<dt><b>-c </b><i>command</i> +<dd style="margin-left: 5.0em">Run the specified command for each document that is printed. +If "command" is not an absolute path ("/path/to/command"), +<b>ippeveprinter</b> +looks for the command in the "ippeveprinter" subdirectory of the CUPS binary directory, typically /usr/lib/cups/ippeveprinter or /usr/libexec/cups/ippeveprinter. +The +<b>cups-config</b>(1) +command can be used to discover the correct binary directory ("cups-config --serverbin"). +In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the +<b>cups</b>(1) +man page for more details. +<dt><b>-d </b><i>spool-directory</i> +<dd style="margin-left: 5.0em">Specifies the directory that will hold the print files. +The default is a directory under the user's current temporary directory. +<dt><b>-f </b><i>type/subtype[,...]</i> +<dd style="margin-left: 5.0em">Specifies a list of MIME media types that the server will accept. +The default depends on the type of printer created. +<dt><b>-i </b><i>iconfile.png</i> +<dd style="margin-left: 5.0em">Specifies the printer icon file for the server. +The file must be a PNG format image. +The default is an internally-provided PNG image. +<dt><b>-k</b> +<dd style="margin-left: 5.0em">Keeps the print documents in the spool directory rather than deleting them. +<dt><b>-l </b><i>location</i> +<dd style="margin-left: 5.0em">Specifies the human-readable location string that is reported by the server. +The default is the empty string. +<dt><b>-m </b><i>model</i> +<dd style="margin-left: 5.0em">Specifies the model name of the printer. +The default is "Printer". +<dt><b>-n </b><i>hostname</i> +<dd style="margin-left: 5.0em">Specifies the hostname that is reported by the server. +The default is the name returned by the +<b>hostname</b>(1) +command. +<dt><b>-p </b><i>port</i> +<dd style="margin-left: 5.0em">Specifies the port number to listen on. +The default is a user-specific number from 8000 to 8999. +<dt><b>-r </b><i>subtype[,subtype]</i> +<dd style="margin-left: 5.0em">Specifies the DNS-SD subtype(s) to advertise. +Separate multiple subtypes with a comma. +The default is "_print". +<dt><b>-s </b><i>speed[,color-speed]</i> +<dd style="margin-left: 5.0em">Specifies the printer speed in pages per minute. +If two numbers are specified and the second number is greater than zero, the server will report support for color printing. +The default is "10,0". +<dt><b>-v[vvv]</b> +<dd style="margin-left: 5.0em">Be (very) verbose when logging activity to standard error. +</dl> +<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> +The +<b>ippeveprinter</b> +program returns 1 if it is unable to process the command-line arguments or register the IPP service. +Otherwise +<b>ippeveprinter</b> +will run continuously until terminated. +<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> +The +<b>ippeveprinter</b> +program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification. +<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> +<b>ippeveprinter</b> +adds environment variables starting with "IPP_" for all IPP Job attributes in the print request. +For example, when executing a command for an IPP Job containing the "media" Job Template attribute, the "IPP_MEDIA" environment variable will be set to the value of that attribute. +<p>In addition, all IPP "xxx-default" Printer Description attributes are added to the environment. +For example, the "IPP_MEDIA_DEFAULT" environment variable will be set to the default value for the "media" Job Template attribute. +<p>Enumerated values are converted to their keyword equivalents. +For example, a "print-quality" Job Template attribute with a enum value of 3 will become the "IPP_PRINT_QUALITY" environment variable with a value of "draft". +This string conversion only happens for standard Job Template attributes, currently "finishings", "orientation-requested", and "print-quality". +<p>Finally, the "CONTENT_TYPE" environment variable contains the MIME media type of the document being printed, the "DEVICE_URI" environment variable contains the device URI as specified with the "-D" option, and the "PPD" environment variable contains the PPD filename as specified with the "-P" option. +<h2 class="title"><a name="COMMAND_OUTPUT">Command Output</a></h2> +Unless they communicate directly with a printer, print commands send printer-ready data to the standard output. +<p>Print commands can send messages back to +<b>ippeveprinter</b> +on the standard error with one of the following prefixes: +<dl class="man"> +<dt><b>ATTR: </b><i>attribute=value[ attribute=value]</i> +<dd style="margin-left: 5.0em">Sets the named attribute(s) to the given values. +Currently only the "job-impressions" and "job-impressions-completed" Job Status attributes and the "marker-xxx", "printer-alert", "printer-alert-description", "printer-supply", and "printer-supply-description" Printer Status attributes can be set. +<dt><b>DEBUG: </b><i>Debugging message</i> +<dd style="margin-left: 5.0em">Logs a debugging message if at least two -v's have been specified. +<dt><b>ERROR: </b><i>Error message</i> +<dd style="margin-left: 5.0em">Logs an error message and copies the message to the "job-state-message" attribute. +<dt><b>INFO: </b><i>Informational message</i> +<dd style="margin-left: 5.0em">Logs an informational/progress message if -v has been specified and copies the message to the "job-state-message" attribute unless an error has been reported. +<dt><b>STATE: </b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Sets the printer's "printer-state-reasons" attribute to the listed keywords. +<dt><b>STATE: -</b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Removes the listed keywords from the printer's "printer-state-reasons" attribute. +<dt><b>STATE: +</b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Adds the listed keywords to the printer's "printer-state-reasons" attribute. +</dl> +<h2 class="title"><a name="EXAMPLES">Examples</a></h2> +Run +<b>ippeveprinter</b> +with a service name of My Cool Printer: +<pre class="man"> + + ippeveprinter "My Cool Printer" +</pre> +<p>Run the +<b>file</b>(1) +command whenever a job is sent to the server: +<pre class="man"> + + ippeveprinter -c /usr/bin/file "My Cool Printer" +</pre> +<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> +PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) +<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ippfind.html b/doc/man-ippfind.html index 7e9af191a..7c8529b94 100644 --- a/doc/man-ippfind.html +++ b/doc/man-ippfind.html @@ -1,8 +1,11 @@ ---- -title: ippfind(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ippfind(1)</title> +</head> +<body> <h1 class="title">ippfind(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ippfind - find internet printing protocol printers @@ -196,6 +199,9 @@ Similarly, to send a PostScript test page to every PostScript printer, run: -f onepage-letter.ps '{}' print-job.test \; </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a> +<b>ipptool</b>(1) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2013-2018 by Apple Inc. +Copyright © 2013-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ipptool.html b/doc/man-ipptool.html index f4877288c..5f9b86212 100644 --- a/doc/man-ipptool.html +++ b/doc/man-ipptool.html @@ -1,8 +1,11 @@ ---- -title: ipptool(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ipptool(1)</title> +</head> +<body> <h1 class="title">ipptool(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ipptool - perform internet printing protocol requests @@ -81,7 +84,7 @@ Output is either a plain text, formatted text, CSV, or XML report on the standar The <i>testfile</i> format is described in -<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5).</a> +<b>ipptoolfile</b>(5). <h2 class="title"><a name="OPTIONS">Options</a></h2> The following options are recognized by <b>ipptool:</b> @@ -217,9 +220,12 @@ Get a list of completed jobs for "myprinter": ipp://localhost/printers/myprinter create-printer-subscription.test </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a> +<b>ipptoolfile</b>(5), IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp\-registrations)">http://www.iana.org/assignments/ipp\-registrations)</a>, PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) RFC 8011 (<a href="http://tools.ietf.org/html/rfc8011)">http://tools.ietf.org/html/rfc8011)</a>, <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ipptoolfile.html b/doc/man-ipptoolfile.html index 4b6dc3225..76a57b226 100644 --- a/doc/man-ipptoolfile.html +++ b/doc/man-ipptoolfile.html @@ -1,14 +1,17 @@ ---- -title: ipptoolfile(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ipptoolfile(5)</title> +</head> +<body> <h1 class="title">ipptoolfile(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ipptoolfile - ipptool file format <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a> +<b>ipptool</b>(1) program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curly braces, for example: @@ -84,7 +87,7 @@ The following directives can be used outside of a <i>test</i>: <dd style="margin-left: 5.0em">Defines a test. <dt><b>DEFINE </b><i>variable-name value</i> <dd style="margin-left: 5.0em">Defines the named variable to the given value. This is equivalent to specifying <i>-d variable-name=value</i> on the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) command-line. <dt><b>DEFINE-DEFAULT </b><i>variable-name value</i> <dd style="margin-left: 5.0em">Defines the named variable to the given value if it does not already have a value. @@ -93,22 +96,22 @@ command-line. <dt><b>IGNORE-ERRORS yes</b> <dd style="margin-left: 5.0em"><dt><b>IGNORE-ERRORS no</b> <dd style="margin-left: 5.0em">Specifies whether, by default, -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) will ignore errors and continue with subsequent tests. <dt><b>INCLUDE "</b><i>filename</i><b>"</b> <dd style="margin-left: 5.0em"><dt><b>INCLUDE <</b><i>filename</i><b>></b> <dd style="margin-left: 5.0em">Includes another test file. The first form includes a file relative to the current test file, while the second form includes a file from the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) include directory. <dt><b>INCLUDE-IF-DEFINED </b><i>name </i><b>"</b><i>filename</i><b>"</b> <dd style="margin-left: 5.0em"><dt><b>INCLUDE-IF-DEFINED </b><i>name </i><b><</b><i>filename</i><b>></b> <dd style="margin-left: 5.0em">Includes another test file if the named variable is defined. The first form includes a file relative to the current test file, while the second form includes a file from the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) include directory. <dt><b>INCLUDE-IF-NOT-DEFINED </b><i>name </i><b>"</b><i>filename</i><b>"</b> <dd style="margin-left: 5.0em"><dt><b>INCLUDE-IF-NOT-DEFINED </b><i>name </i><b><</b><i>filename</i><b>></b> <dd style="margin-left: 5.0em">Includes another test file if the named variable is not defined. The first form includes a file relative to the current test file, while the second form includes a file from the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) include directory. <dt><b>SKIP-IF-DEFINED </b><i>variable-name</i> <dd style="margin-left: 5.0em"><dt><b>SKIP-IF-NOT-DEFINED </b><i>variable-name</i> @@ -120,11 +123,11 @@ include directory. <dd style="margin-left: 5.0em">Specifies that tests will, by default, use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files. <dt><b>TRANSFER chunked</b> <dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: chunked" header. This is the default and is equivalent to specifying <i>-c</i> on the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) command-line. Support for chunked requests is required for conformance with all versions of IPP. <dt><b>TRANSFER length</b> <dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" header. This is equivalent to specifying <i>-l</i> on the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) command-line. Support for content length requests is required for conformance with all versions of IPP. <dt><b>VERSION 1.0</b> <dd style="margin-left: 5.0em"><dt><b>VERSION 1.1</b> @@ -170,7 +173,7 @@ test report. <dt><b>IGNORE-ERRORS yes</b> <dd style="margin-left: 5.0em"><dt><b>IGNORE-ERRORS no</b> <dd style="margin-left: 5.0em">Specifies whether -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) will ignore errors and continue with subsequent tests. <dt><b>NAME "</b><i>literal string</i><b>"</b> <dd style="margin-left: 5.0em">Specifies the human-readable name of the test. @@ -183,7 +186,7 @@ will ignore errors and continue with subsequent tests. <dd style="margin-left: 5.0em">Specifies the request-id value to use in the request, either an integer or the word "random" to use a randomly generated value (the default). <dt><b>RESOURCE </b><i>path</i> <dd style="margin-left: 5.0em">Specifies an alternate resource path that is used for the HTTP POST request. The default is the resource from the URI provided to the -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) program. <dt><b>SKIP-IF-DEFINED </b><i>variable-name</i> <dd style="margin-left: 5.0em"><dt><b>SKIP-IF-NOT-DEFINED </b><i>variable-name</i> @@ -191,7 +194,7 @@ program. <dt><b>SKIP-PREVIOUS-ERROR yes</b> <dd style="margin-left: 5.0em"><dt><b>SKIP-PREVIOUS-ERROR no</b> <dd style="margin-left: 5.0em">Specifies whether -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) will skip the current test if the previous test resulted in an error/failure. <dt><b>STATUS </b><i>status-code </i>[ <i>predicate</i> ] <dd style="margin-left: 5.0em">Specifies an expected response status-code value. Additional requirements can be added as predicates - see the "STATUS PREDICATES" section for more information on predicates. @@ -303,7 +306,7 @@ Specifies the maximum number of times to repeat. The default value is 1000. </dl> <h3><a name="OPERATION_CODES">Operation Codes</a></h3> Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of names supported by -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a> +<b>ipptool</b>(8): <pre class="man"> Activate-Printer @@ -376,7 +379,7 @@ Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from RF </pre> <h3><a name="STATUS_CODES">Status Codes</a></h3> Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of the names supported by -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a> +<b>ipptool</b>(8): <pre class="man"> client-error-account-authorization-failed @@ -480,7 +483,7 @@ Value and group tags correspond to the names from RFC 8011 and other IPP extensi </pre> <h3><a name="VARIABLES">Variables</a></h3> The -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) program maintains a list of variables that can be used in any literal string or attribute value by specifying "<i>$variable-name</i>". Aside from variables defined using the <i>-d</i> option or <b>DEFINE</b> directive, the following pre-defined variables are available: <dl class="man"> <dt><b>$$</b> @@ -489,15 +492,15 @@ program maintains a list of variables that can be used in any literal string or <dd style="margin-left: 5.0em">Inserts the value of the named environment variable, or an empty string if the environment variable is not defined. <dt><b>$filename</b> <dd style="margin-left: 5.0em">Inserts the filename provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) with the <i>-f</i> option. <dt><b>$filetype</b> <dd style="margin-left: 5.0em">Inserts the MIME media type for the filename provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> +<b>ipptool</b>(8) with the <i>-f</i> option. <dt><b>$hostname</b> <dd style="margin-left: 5.0em">Inserts the hostname from the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> +<b>ipptool</b>(8). <dt><b>$job-id</b> <dd style="margin-left: 5.0em">Inserts the last "job-id" attribute value returned in a test response or 0 if no "job-id" attribute has been seen. <dt><b>$job-uri</b> @@ -506,27 +509,30 @@ with the <i>-f</i> option. <dd style="margin-left: 5.0em">Inserts the last "notify-subscription-id" attribute value returned in a test response or 0 if no "notify-subscription-id" attribute has been seen. <dt><b>$port</b> <dd style="margin-left: 5.0em">Inserts the port number from the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> +<b>ipptool</b>(8). <dt><b>$resource</b> <dd style="margin-left: 5.0em">Inserts the resource path from the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> +<b>ipptool</b>(8). <dt><b>$scheme</b> <dd style="margin-left: 5.0em">Inserts the scheme from the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> +<b>ipptool</b>(8). <dt><b>$uri</b> <dd style="margin-left: 5.0em">Inserts the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> +<b>ipptool</b>(8). <dt><b>$uriuser</b> <dd style="margin-left: 5.0em">Inserts the username from the URI provided to -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8),</a> +<b>ipptool</b>(8), if any. <dt><b>$user</b> <dd style="margin-left: 5.0em">Inserts the current user's login name. </dl> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1),</a> +<b>ipptool</b>(1), IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp-registrations)">http://www.iana.org/assignments/ipp-registrations)</a>, PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</a>, RFC 8011 (<a href="http://tools.ietf.org/html/rfc8011">http://tools.ietf.org/html/rfc8011</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lp.html b/doc/man-lp.html index 003ffd1ea..09b921fb3 100644 --- a/doc/man-lp.html +++ b/doc/man-lp.html @@ -1,8 +1,11 @@ ---- -title: lp(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lp(1)</title> +</head> +<body> <h1 class="title">lp(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lp - print files @@ -85,7 +88,7 @@ CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b If neither are set, the current default set using the <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> command is used, followed by the default set using the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) command. <h2 class="title"><a name="OPTIONS">Options</a></h2> The following options are recognized by <i>lp</i>: @@ -185,13 +188,16 @@ Print a presentation document 2-up to a printer called "bar": lp -d bar -o number-up=2 filename </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> +<b>cancel</b>(1), +<b>lpadmin</b>(8), <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> -<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>lpq</b>(1), +<b>lpr</b>(1), +<b>lprm</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpadmin.html b/doc/man-lpadmin.html index f15fcf427..1ce68ab29 100644 --- a/doc/man-lpadmin.html +++ b/doc/man-lpadmin.html @@ -1,8 +1,11 @@ ---- -title: lpadmin(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpadmin(8)</title> +</head> +<body> <h1 class="title">lpadmin(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpadmin - configure cups printers and classes @@ -53,9 +56,9 @@ It can also be used to set the server default printer or class. <p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i> options, the <i>-E</i> option forces encryption when connecting to the server. <p>The first form of the command (<i>-d</i>) sets the default printer or class to <i>destination</i>. Subsequent print jobs submitted via the -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a> +<b>lp</b>(1) or -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a> +<b>lpr</b>(1) commands will use this destination unless the user specifies otherwise with the <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> command. @@ -71,7 +74,7 @@ If <i>class</i> does not exist it is created automatically. <dt><b>-m </b><i>model</i> <dd style="margin-left: 5.0em">Sets a standard PPD file for the printer from the <i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i> option with the -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +<b>lpinfo</b>(8) command to get a list of supported models. The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP <i>device-uri</i>. Note: Models other than "everywhere" are deprecated and will not be supported in a future version of CUPS. @@ -135,16 +138,16 @@ Note: The user 'root' is not granted special access - using "-u allow:foo,bar" w <dt><b>-v "</b><i>device-uri</i><b>"</b> <dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i> option with the -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +<b>lpinfo</b>(8) command to get a list of supported device URIs and schemes. <dt><b>-D "</b><i>info</i><b>"</b> <dd style="margin-left: 5.0em">Provides a textual description of the destination. <dt><b>-E</b> <dd style="margin-left: 5.0em">When specified before the <b>-d</b>, <b>-p</b>, or <b>-x</b> options, forces the use of TLS encryption on the connection to the scheduler. Otherwise, enables the destination and accepts jobs; this is the same as running the -<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8)</a> +<b>cupsaccept</b>(8) and -<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8)</a> +<b>cupsenable</b>(8) programs on the destination. <dt><b>-L "</b><i>location</i><b>"</b> <dd style="margin-left: 5.0em">Provides a textual location of the destination. @@ -166,7 +169,10 @@ Also, printer and class names are <i>not</i> case-sensitive. <p>Finally, the CUPS version of <b>lpadmin</b> may ask the user for an access password depending on the printing system configuration. This differs from the System V version which requires the root user to execute this command. <h2 class="title"><a name="NOTES">Notes</a></h2> -The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options. +CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). +<p>The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options. <p>Interface scripts are not supported for security reasons. <p>The double meaning of the <b>-E</b> option is an unfortunate historical oddity. <p>The <b>lpadmin</b> command communicates with the scheduler (<b>cupsd</b>) to make changes to the printing system configuration. @@ -180,10 +186,13 @@ Create an IPP Everywhere print queue: </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a> -<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a> -<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> +<b>cupsaccept</b>(8), +<b>cupsenable</b>(8), +<b>lpinfo</b>(8), <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpc.html b/doc/man-lpc.html index 7a97f3a78..f94d9258e 100644 --- a/doc/man-lpc.html +++ b/doc/man-lpc.html @@ -1,11 +1,14 @@ ---- -title: lpc(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpc(8)</title> +</head> +<body> <h1 class="title">lpc(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -lpc - line printer control program +lpc - line printer control program (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>lpc</b> [ @@ -30,19 +33,23 @@ The <b>lpc</b> program accepts a subset of commands accepted by the Berkeley <b> <dd style="margin-left: 5.0em">Displays the status of one or more printer or class queues. </dl> <h2 class="title"><a name="NOTES">Notes</a></h2> -Since <b>lpc</b> is geared towards the Berkeley printing system, it is impossible to use <b>lpc</b> to configure printer or class queues provided by CUPS. +This program is deprecated and will be removed in a future feature release of CUPS. +<p>Since <b>lpc</b> is geared towards the Berkeley printing system, it is impossible to use <b>lpc</b> to configure printer or class queues provided by CUPS. To configure printer or class queues you must use the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) command or another CUPS-compatible client with that functionality. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a> -<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>cancel</b>(1), +<b>cupsaccept</b>(8), +<b>cupsenable</b>(8), +<b>lp</b>(1), +<b>lpadmin</b>(8), +<b>lpr</b>(1), +<b>lprm</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpinfo.html b/doc/man-lpinfo.html index 2b1a39334..1089ec59b 100644 --- a/doc/man-lpinfo.html +++ b/doc/man-lpinfo.html @@ -1,11 +1,14 @@ ---- -title: lpinfo(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpinfo(8)</title> +</head> +<body> <h1 class="title">lpinfo(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -lpinfo - show available devices or drivers +lpinfo - show available devices or drivers (deprecated) <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>lpinfo</b> [ @@ -102,8 +105,15 @@ List drivers matching "HP LaserJet": lpinfo --make-and-model "HP LaserJet" -m </pre> +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> +<b>lpadmin</b>(8), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpmove.html b/doc/man-lpmove.html index 39da31dbe..74ad0ff2d 100644 --- a/doc/man-lpmove.html +++ b/doc/man-lpmove.html @@ -1,8 +1,11 @@ ---- -title: lpmove(8) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpmove(8)</title> +</head> +<body> <h1 class="title">lpmove(8)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpmove - move a job or all jobs to a new destination @@ -59,11 +62,14 @@ Move all jobs from "oldprinter" to "newprinter": lpmove oldprinter newprinter </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpr</b>(1), +<b>lprm</b>(1), <br> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpoptions.html b/doc/man-lpoptions.html index 69a64e908..38ebeeb67 100644 --- a/doc/man-lpoptions.html +++ b/doc/man-lpoptions.html @@ -1,8 +1,11 @@ ---- -title: lpoptions(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpoptions(1)</title> +</head> +<body> <h1 class="title">lpoptions(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpoptions - display or set printer options and defaults @@ -49,12 +52,12 @@ lpoptions - display or set printer options and defaults <h2 class="title"><a name="DESCRIPTION">Description</a></h2> <b>lpoptions</b> displays or sets printer options and defaults. If no printer is specified using the <i>-p</i> option, the default printer is used as described in -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1).</a> +<b>lp</b>(1). <p>If no <i>-l</i>, <i>-o</i>, or <i>-r</i> options are specified, the current options are reported on the standard output. <p>Options set with the <b>lpoptions</b> command are used by the -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a> +<b>lp</b>(1) and -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a> +<b>lpr</b>(1) commands when submitting jobs. <p>When run by the root user, <b>lpoptions</b> gets and sets default options and instances for all users in the <i>/etc/cups/lpoptions</i> file. Otherwise, the per-user defaults are managed in the <i>~/.cups/lpoptions</i> file. @@ -77,7 +80,7 @@ This option overrides the system default printer for the current user. <dd style="margin-left: 5.0em">Sets the destination and instance, if specified, for any options that follow. If the named instance does not exist then it is created. Destinations can only be created using the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) program. <dt><b>-r </b><i>option</i> <dd style="margin-left: 5.0em">Removes the specified option from the named destination. @@ -85,7 +88,7 @@ program. <dd style="margin-left: 5.0em">Removes the options for the named destination and instance, if specified. If the named instance does not exist then this does nothing. Destinations can only be removed using the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) command. </dl> <h2 class="title"><a name="FILES">Files</a></h2> @@ -95,11 +98,14 @@ command. <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> The <b>lpoptions</b> command is unique to CUPS. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpadmin</b>(8), +<b>lpr</b>(1), +<b>lprm</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpq.html b/doc/man-lpq.html index 90538cdb9..064e88234 100644 --- a/doc/man-lpq.html +++ b/doc/man-lpq.html @@ -1,8 +1,11 @@ ---- -title: lpq(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpq(1)</title> +</head> +<body> <h1 class="title">lpq(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpq - show printer queue status @@ -45,11 +48,14 @@ Jobs queued on the default destination will be shown if no printer or class is s <dd style="margin-left: 5.0em">Requests a more verbose (long) reporting format. </dl> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpr</b>(1), +<b>lprm</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpr.html b/doc/man-lpr.html index 160b3839f..37970b408 100644 --- a/doc/man-lpr.html +++ b/doc/man-lpr.html @@ -1,8 +1,11 @@ ---- -title: lpr(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpr(1)</title> +</head> +<body> <h1 class="title">lpr(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpr - print files @@ -55,7 +58,7 @@ CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b If neither are set, the current default set using the <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> command is used, followed by the default set using the -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a> +<b>lpadmin</b>(8) command. <h2 class="title"><a name="OPTIONS">Options</a></h2> The following options are recognized by <i>lpr</i>: @@ -142,13 +145,16 @@ Print a presentation document 2-up to a printer called "foo": lpr -P foo -o number-up=2 filename </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpadmin</b>(8), <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> -<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>lpq</b>(1), +<b>lprm</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lprm.html b/doc/man-lprm.html index eb33a4bc4..f370b7fef 100644 --- a/doc/man-lprm.html +++ b/doc/man-lprm.html @@ -1,8 +1,11 @@ ---- -title: lprm(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lprm(1)</title> +</head> +<body> <h1 class="title">lprm(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lprm - cancel print jobs @@ -66,11 +69,14 @@ Cancel all jobs: lprm - </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpq</b>(1), +<b>lpr</b>(1), +<b>lpstat</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-lpstat.html b/doc/man-lpstat.html index cfefdd2c7..0fcd20c6d 100644 --- a/doc/man-lpstat.html +++ b/doc/man-lpstat.html @@ -1,8 +1,11 @@ ---- -title: lpstat(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>lpstat(1)</title> +</head> +<body> <h1 class="title">lpstat(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> lpstat - print cups status information @@ -117,11 +120,14 @@ Also, printer and class names are <i>not</i> case-sensitive. <p>The <i>-h</i>, <i>-e</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS. <p>The Solaris <i>-f</i>, <i>-P</i>, and <i>-S</i> options are silently ignored. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> -<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> -<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> -<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> -<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> +<b>cancel</b>(1), +<b>lp</b>(1), +<b>lpq</b>(1), +<b>lpr</b>(1), +<b>lprm</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-mailto.conf.html b/doc/man-mailto.conf.html index 7a0f561a8..47dc7a455 100644 --- a/doc/man-mailto.conf.html +++ b/doc/man-mailto.conf.html @@ -1,8 +1,11 @@ ---- -title: mailto.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>mailto.conf(5)</title> +</head> +<body> <h1 class="title">mailto.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> mailto.conf - configuration file for cups email notifier @@ -33,4 +36,7 @@ If multiple lines are present, only the last one is used. <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-mime.convs.html b/doc/man-mime.convs.html index 2894ad393..6afbc71a3 100644 --- a/doc/man-mime.convs.html +++ b/doc/man-mime.convs.html @@ -1,11 +1,14 @@ ---- -title: mime.convs(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>mime.convs(5)</title> +</head> +<body> <h1 class="title">mime.convs(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -mime.convs - mime type conversion file for cups +mime.convs - mime type conversion file for cups (deprecated) <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The <b>mime.convs</b> file defines the filters that are available for converting files from one format to another. The standard filters support text, PDF, PostScript, and many types of image files. @@ -38,12 +41,19 @@ Define a filter that converts PostScript documents to CUPS Raster format: application/vnd.cups-postscript application/vnd.cups-raster 50 pstoraster </pre> +<h2 class="title"><a name="NOTES">Notes</a></h2> +CUPS filters are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> +<b>cupsfilter</b>(8), +<b>mime.types</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-mime.types.html b/doc/man-mime.types.html index d151adda2..28d166cac 100644 --- a/doc/man-mime.types.html +++ b/doc/man-mime.types.html @@ -1,8 +1,11 @@ ---- -title: mime.types(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>mime.types(5)</title> +</head> +<body> <h1 class="title">mime.types(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> mime.types - mime type description file for cups @@ -84,8 +87,11 @@ Define two MIME media types for raster data, with one being a subset with higher <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> +<b>cupsfilter</b>(8), +<b>mime.convs</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-notifier.html b/doc/man-notifier.html index d4d26ff83..27e051fdb 100644 --- a/doc/man-notifier.html +++ b/doc/man-notifier.html @@ -1,8 +1,11 @@ ---- -title: notifier(7) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>notifier(7)</title> +</head> +<body> <h1 class="title">notifier(7)</h1> <h2 class="title"><a name="NAME">Name</a></h2> notifier - cups notification interface @@ -22,10 +25,13 @@ and functions and exit on error. Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen. Notifiers inherit the environment and can use the logging mechanism documented in -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7).</a> +<b>filter</b>(7). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> -<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a> +<b>filter</b>(7), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdc.html b/doc/man-ppdc.html index d51951b55..d4e178b55 100644 --- a/doc/man-ppdc.html +++ b/doc/man-ppdc.html @@ -1,8 +1,11 @@ ---- -title: ppdc(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdc(1)</title> +</head> +<body> <h1 class="title">ppdc(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ppdc - cups ppd compiler (deprecated) @@ -74,12 +77,19 @@ The default is to generate uncompressed PPD files. <dd style="margin-left: 5.0em">Specifies the line ending to use - carriage return, carriage return and line feed, or line feed alone. The default is to use the line feed character alone. </dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a> -<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a> -<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a> -<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a> -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a> +<b>ppdhtml</b>(1), +<b>ppdi</b>(1), +<b>ppdmerge</b>(1), +<b>ppdpo</b>(1), +<b>ppdcfile</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdcfile.html b/doc/man-ppdcfile.html index afe2a3cda..a81f06a8d 100644 --- a/doc/man-ppdcfile.html +++ b/doc/man-ppdcfile.html @@ -1,14 +1,17 @@ ---- -title: ppdcfile(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdcfile(5)</title> +</head> +<body> <h1 class="title">ppdcfile(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> -ppdcfile - cups ppd compiler source file format +ppdcfile - cups ppd compiler source file format (deprecated) <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1).</a> +<b>ppdc</b>(1). This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS. <p>The source file format is plain ASCII text that can be edited using your favorite text editor. Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms. <p>Printer driver information can be grouped and shared using curly braces ({ ... }); PPD files are written when a close brace or end-of-file is seen and a PCFileName directive has been defined. @@ -78,12 +81,19 @@ This man page provides a quick reference to the supported keywords and should be <dd style="margin-left: 5.0em"><dt><b>VariablePaperSize </b><i>boolean-value</i> <dd style="margin-left: 5.0em"><dt><b>Version </b><i>number</i> <dd style="margin-left: 5.0em"></dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a> -<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a> -<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a> -<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a> -<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a> +<b>ppdc</b>(1), +<b>ppdhtml</b>(1), +<b>ppdi</b>(1), +<b>ppdmerge</b>(1), +<b>ppdpo</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdhtml.html b/doc/man-ppdhtml.html index e15a03179..d19621a00 100644 --- a/doc/man-ppdhtml.html +++ b/doc/man-ppdhtml.html @@ -1,8 +1,11 @@ ---- -title: ppdhtml(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdhtml(1)</title> +</head> +<body> <h1 class="title">ppdhtml(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ppdhtml - cups html summary generator (deprecated) @@ -28,12 +31,19 @@ It is equivalent to using the <i>#define</i> directive in the source file. <dd style="margin-left: 5.0em">Specifies an alternate include directory. Multiple <i>-I</i> options can be supplied to add additional directories. </dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a> -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a> -<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a> -<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a> -<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a> +<b>ppdc</b>(1), +<b>ppdcfile</b>(5), +<b>ppdi</b>(1), +<b>ppdmerge</b>(1), +<b>ppdpo</b>(1), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdi.html b/doc/man-ppdi.html index 796e744b9..192b02b8c 100644 --- a/doc/man-ppdi.html +++ b/doc/man-ppdi.html @@ -1,8 +1,11 @@ ---- -title: ppdi(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdi(1)</title> +</head> +<body> <h1 class="title">ppdi(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ppdi - import ppd files (deprecated) @@ -35,12 +38,19 @@ If the source file does not exist, a new source file is created. Otherwise the existing file is merged with the new PPD file(s) on the command-line. If no source file is specified, the filename <i>ppdi.drv</i> is used. </dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a> -<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a> -<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a> -<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a> -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a> +<b>ppdc</b>(1), +<b>ppdhtml</b>(1), +<b>ppdmerge</b>(1), +<b>ppdpo</b>(1), +<b>ppdcfile</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdmerge.html b/doc/man-ppdmerge.html index a3740701d..458fac1f5 100644 --- a/doc/man-ppdmerge.html +++ b/doc/man-ppdmerge.html @@ -1,8 +1,11 @@ ---- -title: ppdmerge(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdmerge(1)</title> +</head> +<body> <h1 class="title">ppdmerge(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ppdmerge - merge ppd files (deprecated) @@ -30,14 +33,20 @@ If not specified, the merged PPD file is written to the standard output. If the output file already exists, it is silently overwritten. </dl> <h2 class="title"><a name="NOTES">Notes</a></h2> -<b>ppdmerge</b> does not check whether the merged PPD files are for the same device. +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). +<p><b>ppdmerge</b> does not check whether the merged PPD files are for the same device. Merging of different device PPDs will yield unpredictable results. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a> -<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a> -<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a> -<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a> -<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a> +<b>ppdc</b>(1), +<b>ppdhtml</b>(1), +<b>ppdi</b>(1), +<b>ppdpo</b>(1), +<b>ppdcfile</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-ppdpo.html b/doc/man-ppdpo.html index fa7b587dd..61c727ad6 100644 --- a/doc/man-ppdpo.html +++ b/doc/man-ppdpo.html @@ -1,8 +1,11 @@ ---- -title: ppdpo(1) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>ppdpo(1)</title> +</head> +<body> <h1 class="title">ppdpo(1)</h1> <h2 class="title"><a name="NAME">Name</a></h2> ppdpo - ppd message catalog generator (deprecated) @@ -34,12 +37,19 @@ Multiple <i>-I</i> options can be supplied to add additional directories. <dd style="margin-left: 5.0em">Specifies the output file. The supported extensions are <i>.po</i> or <i>.po.gz</i> for GNU gettext format message catalogs and <i>.strings</i> for macOS strings files. </dl> +<h2 class="title"><a name="NOTES">Notes</a></h2> +PPD files are deprecated and will no longer be supported in a future feature release of CUPS. +Printers that do not support IPP can be supported using applications such as +<b>ippeveprinter</b>(1). <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a> -<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a> -<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a> -<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a> +<b>ppdc</b>(1), +<b>ppdhtml</b>(1), +<b>ppdi</b>(1), +<b>ppdmerge</b>(1), <b>ppdcfile(5),</b> CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-printers.conf.html b/doc/man-printers.conf.html index a5ca02fa1..a2f8ba68e 100644 --- a/doc/man-printers.conf.html +++ b/doc/man-printers.conf.html @@ -1,8 +1,11 @@ ---- -title: printers.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>printers.conf(5)</title> +</head> +<body> <h1 class="title">printers.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> printers.conf - printer configuration file for cups @@ -13,12 +16,16 @@ program. This file is not intended to be edited or managed manually. <h2 class="title"><a name="NOTES">Notes</a></h2> The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> +<b>classes.conf</b>(5), +<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>subscriptions.conf</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/man-subscriptions.conf.html b/doc/man-subscriptions.conf.html index 791856279..fb7ec0287 100644 --- a/doc/man-subscriptions.conf.html +++ b/doc/man-subscriptions.conf.html @@ -1,24 +1,33 @@ ---- -title: subscriptions.conf(5) -layout: sub ---- - +<!DOCTYPE HTML> +<html> +<!-- SECTION: Man Pages --> +<head> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + <title>subscriptions.conf(5)</title> +</head> +<body> <h1 class="title">subscriptions.conf(5)</h1> <h2 class="title"><a name="NAME">Name</a></h2> subscriptions.conf - subscription configuration file for cups <h2 class="title"><a name="DESCRIPTION">Description</a></h2> -The <b>subscriptions.conf</b> file defines the local event notification subscriptions that are active. It is normally located in the <i>/etc/cups</i> directory and is maintained by the +The <b>subscriptions.conf</b> file defines the local event notification subscriptions that are active. +It is normally located in the <i>/etc/cups</i> directory and is maintained by the <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a> -program. This file is not intended to be edited or managed manually. +program. +This file is not intended to be edited or managed manually. <h2 class="title"><a name="NOTES">Notes</a></h2> The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> +<b>classes.conf</b>(5), +<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> -<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> -<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> -<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> +<b>mime.convs</b>(5), +<b>mime.types</b>(5), +<b>printers.conf</b>(5), CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright © 2007-2018 by Apple Inc. +Copyright © 2007-2019 by Apple Inc. + +</body> +</html> diff --git a/doc/network.html b/doc/network.html index 0c4bf7f0a..1ba087329 100644 --- a/doc/network.html +++ b/doc/network.html @@ -1,8 +1,11 @@ ---- -title: Using Network Printers -layout: sub ---- - +<!DOCTYPE html> +<html> +<!-- SECTION: Getting Started --> + <head> + <title>Using Network Printers</title> + <link rel="stylesheet" type="text/css" href="../cups-printable.css"> + </head> + <body> <h1 class="title">Using Network Printers</h1> <p>This help document describes how to discover, configure, and use TCP/IP network printers with CUPS.</p> @@ -335,3 +338,5 @@ HOST-RESOURCES-MIB::hrDeviceDescr.1 = STRING: HP LaserJet 4000 Series</pre> <p>The hrDeviceType line should show hrDevicePrinter; if not, then your printer or print server doesn't identify itself as a printer. The hrDeviceDescr line should provide a human-readable string for the make and model of the printer, although in some cases you'll just see something less useful like "Axis OfficeBASIC Parallel Print Server".</p> <p>Once you have collected the snmpwalk output, you should go to the <a href="https://github.com/apple/cups/issues">CUPS Issue Tracker</a> page to submit a feature request to support your printer or print server. Be sure to attach those two log files you created - they will help us to identify the SNMP values we need to look for.</p> + </body> +</html> diff --git a/doc/options.html b/doc/options.html index da5805735..9d612fcc9 100644 --- a/doc/options.html +++ b/doc/options.html @@ -1,7 +1,10 @@ ---- -title: Command-Line Printing and Options -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Command-Line Printing and Options</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Command-Line Printing and Options</H1> @@ -542,3 +545,6 @@ lpr -o mirror filename <P>This is typically used when printing on T-shirt transfer media or sometimes on transparencies.</P> + +</BODY> +</HTML> diff --git a/doc/overview.html b/doc/overview.html index 8a5f873e4..a5240fce8 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -1,7 +1,10 @@ ---- -title: Overview of CUPS -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Overview of CUPS</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Overview of CUPS</H1> @@ -57,3 +60,6 @@ Printer for Default Options</VAR> button to update the options automatically.</P <P>Once you have added the printer, you can print to it from any application. You can also choose <VAR>Print Test Page</VAR> from the maintenance menu to print a simple test page and verify that everything is working properly.</P> + +</BODY> +</HTML> diff --git a/doc/policies.html b/doc/policies.html index 25d67ecfe..8a0fc313d 100644 --- a/doc/policies.html +++ b/doc/policies.html @@ -1,7 +1,10 @@ ---- -title: Managing Operation Policies -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Managing Operation Policies</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Managing Operation Policies</H1> @@ -609,3 +612,6 @@ lpadmin -p LaserJet4000 -o printer-op-policy=lab999 </PRE> <P>To make the same change in the web interface, go to the printer's web page, for example "http://localhost:631/printers/LaserJet4000", and choose <VAR>Set Default Options</VAR> from the <VAR>Administration</VAR> menu button. Click on the <VAR>Policies</VAR> link and choose the desired policy from the pull-down list. Click on <VAR>Set Default Options</VAR> to change the policy for the printer.</P> + +</BODY> +</HTML> diff --git a/doc/postscript-driver.html b/doc/postscript-driver.html index ec9722012..f94fa72fd 100644 --- a/doc/postscript-driver.html +++ b/doc/postscript-driver.html @@ -1,7 +1,464 @@ ---- -title: Developing PostScript Printer Drivers -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Developing PostScript Printer Drivers</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + PostScript printer driver documentation for CUPS. + + Copyright © 2007-2012 by Apple Inc. + Copyright © 1997-2007 by Easy Software Products. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Developing PostScript Printer Drivers</h1> @@ -310,3 +767,5 @@ information file.</P> <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterPreset "name/text" "*option choice ..." </pre> </div> + </body> +</html> diff --git a/doc/ppd-compiler.html b/doc/ppd-compiler.html index be4f5e385..b33ca2d27 100644 --- a/doc/ppd-compiler.html +++ b/doc/ppd-compiler.html @@ -1,8 +1,464 @@ ---- -title: Introduction to the PPD Compiler -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Introduction to the PPD Compiler</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + PPD compiler documentation for CUPS. + + Copyright © 2007-2012 by Apple Inc. + Copyright © 1997-2007 by Easy Software Products. + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Introduction to the PPD Compiler</h1> @@ -933,3 +1389,5 @@ ppdc -l de -d ppd/de mydrivers.drv <p>to generate German PPD files.</p> </div> + </body> +</html> diff --git a/doc/raster-driver.html b/doc/raster-driver.html index 53cbb0ac9..de573c616 100644 --- a/doc/raster-driver.html +++ b/doc/raster-driver.html @@ -1,7 +1,464 @@ ---- -title: Developing Raster Printer Drivers -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Programming --> + <head> + <title>Developing Raster Printer Drivers</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + Raster printer driver documentation for CUPS. + + Copyright © 2007-2018 by Apple Inc. + Copyright © 1997-2007 by Easy Software Products. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <h1 class='title'>Developing Raster Printer Drivers</h1> @@ -226,3 +683,5 @@ layout: sub <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterPreset "name/text" "*option choice ..." </pre> </div> + </body> +</html> diff --git a/doc/ref-ppdcfile.html b/doc/ref-ppdcfile.html index 086c99f5a..6c84abd9a 100644 --- a/doc/ref-ppdcfile.html +++ b/doc/ref-ppdcfile.html @@ -1,7 +1,10 @@ ---- -title: PPD Compiler Driver Information File Reference -layout: sub ---- +<HTML> +<!-- SECTION: References --> +<HEAD> + <TITLE>PPD Compiler Driver Information File Reference</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">PPD Compiler Driver Information File Reference</H1> @@ -2441,3 +2444,6 @@ supported keywords for each type.</p> macOS.</LI> </UL> + +</BODY> +</HTML> diff --git a/doc/relnotes.html b/doc/relnotes.html index b2bfdb5d9..b83eacc30 100644 --- a/doc/relnotes.html +++ b/doc/relnotes.html @@ -3,6 +3,48 @@ title: Release Notes layout: sub --- +<h2 class="title"><a name="0203b8">CUPS 2.3b8</a> <em>(May 2, 2019)</em></h2> + +<ul> + + <li>Media size matching now uses a tolerance of 0.5mm (rdar://33822024)</li> + <li>The lpadmin command would hang with a bad PPD file (rdar://41495016)</li> + <li>Fixed a potential crash bug in cups-driverd (rdar://46625579)</li> + <li>Fixed a performance regression with large PPDs (rdar://47040759)</li> + <li>Fixed a memory reallocation bug in HTTP header value expansion (rdar://problem/50000749)</li> + <li>Timed out job submission now yields an error (Issue #5570)</li> + <li>Restored minimal support for the `Emulators` keyword in PPD files to allow old Samsung printer drivers to continue to work (Issue #5562)</li> + <li>The scheduler did not encode octetString values like "job-password" correctly for the print filters (Issue #5558)</li> + <li>The `cupsCheckDestSupported` function did not check octetString values correctly (Issue #5557)</li> + <li>Added support for `UserAgentTokens` directive in "client.conf" (Issue #5555)</li> + <li>Updated the systemd service file for cupsd (Issue #5551)</li> + <li>The `ippValidateAttribute` function did not catch all instances of invalid UTF-8 strings (Issue #5509)</li> + <li>Fixed an issue with the self-signed certificates generated by GNU TLS (Issue #5506)</li> + <li>Fixed a potential memory leak when reading at the end of a file (Issue #5473)</li> + <li>Fixed potential unaligned accesses in the string pool (Issue #5474)</li> + <li>Fixed a potential memory leak when loading a PPD file (Issue #5475)</li> + <li>Added a USB quirks rule for the Lexmark E120n (Issue #5478)</li> + <li>Updated the USB quirks rule for Zebra label printers (Issue #5395)</li> + <li>Fixed a compile error on Linux (Issue #5483)</li> + <li>The lpadmin command, web interface, and scheduler all queried an IPP Everywhere printer differently, resulting in different PPDs for the same printer (Issue #5484)</li> + <li>The web interface no longer provides access to the log files (Issue #5513)</li> + <li>Non-Kerberized printing to Windows via IPP was broken (Issue #5515)</li> + <li>Eliminated use of private headers and some deprecated macOS APIs (Issue #5516)</li> + <li>The scheduler no longer stops a printer if an error occurs when a job is canceled or aborted (Issue #5517)</li> + <li>Added a USB quirks rule for the DYMO 450 Turbo (Issue #5521)</li> + <li>Added a USB quirks rule for Xerox printers (Issue #5523)</li> + <li>The scheduler's self-signed certificate did not include all of the alternate names for the server when using GNU TLS (Issue #5525)</li> + <li>Fixed compiler warnings with newer versions of GCC (Issue #5532, Issue #5533)</li> + <li>Fixed some PPD caching and IPP Everywhere PPD accounting/password bugs (Issue #5535)</li> + <li>Fixed `PreserveJobHistory` bug with time values (Issue #5538)</li> + <li>The scheduler no longer advertises the HTTP methods it supports (Issue #5540)</li> + <li>Localization updates (Issue #5461, Issues #5471, Issue #5481, Issue #5486, Issue #5489, Issue #5491, Issue #5492, Issue #5493, Issue #5494, Issue #5495, Issue #5497, Issue #5499, Issue #5500, Issue #5501, Issue #5504)</li> + <li>The scheduler did not always idle exit as quickly as it could.</li> + <li>Added a new `ippeveprinter` command based on the old ippserver sample code.</li> + +</ul> + + <h2 class="title"><a name="020211">CUPS 2.2.11</a> <em>(March 22, 2019)</em></h2> <ul> diff --git a/doc/security.html b/doc/security.html index 86ed9d11f..6bd2fdfa6 100644 --- a/doc/security.html +++ b/doc/security.html @@ -1,7 +1,10 @@ ---- -title: Server Security -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Server Security</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Server Security</H1> @@ -115,3 +118,6 @@ variety of denial of service attacks:</P> <H2 CLASS="title"><A NAME="ENCRYPTION">Encryption Issues</A></H2> <P>CUPS supports 128-bit TLS encryption of network connections via the GNU TLS library, macOS Security framework, and Windows Schannel APIs. Secure deployment of TLS depends on proper certificate management and software maintenance.</P> + +</BODY> +</HTML> diff --git a/doc/sharing.html b/doc/sharing.html index 847d59df2..a46f393bf 100644 --- a/doc/sharing.html +++ b/doc/sharing.html @@ -1,7 +1,10 @@ ---- -title: Printer Sharing -layout: sub ---- +<html> +<!-- SECTION: Getting Started --> +<head> + <title>Printer Sharing</title> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Printer Sharing</H1> @@ -102,3 +105,7 @@ lpadmin -p <em>printer</em> -E -v ipp://<em>server</em>/printers/<em>printer</em <p>The <var>printer</var> name is the name of the printer on the server machine. The <var>server</var> name is the hostname or IP address of the server machine. Repeat the <b>lpadmin</b> command for each remote printer you wish to use.</p> + + +</body> +</html> diff --git a/doc/spec-banner.html b/doc/spec-banner.html index 22df15253..855a569ef 100644 --- a/doc/spec-banner.html +++ b/doc/spec-banner.html @@ -1,7 +1,20 @@ ---- -title: CUPS Banner File Format -layout: sub ---- +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- SECTION: Specifications --> +<head> + <title>CUPS Banner File Format</title> + <meta name='keywords' content='job-sheets'> + <link rel='stylesheet' type='text/css' href='../cups-printable.css'> +</head> +<body> +<!-- + Banner file format specification for CUPS. + + Copyright © 2008-2011 by Apple Inc. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <H1 CLASS="title">CUPS Banner File Format</H1> @@ -132,3 +145,7 @@ following values are supported:</p> <li><code>time-at-processing</code>: The current date and time</li> </ul> + + +</body> +</html> diff --git a/doc/spec-command.html b/doc/spec-command.html index 68cf26f18..67d54264d 100644 --- a/doc/spec-command.html +++ b/doc/spec-command.html @@ -1,7 +1,21 @@ ---- -title: CUPS Command File Format -layout: sub ---- +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- SECTION: Specifications --> +<head> + <title>CUPS Command File Format</title> + <meta name='keywords' content='Programming, CUPS Command File Format'> + <link rel='stylesheet' type='text/css' href='../cups-printable.css'> +</head> +<body> +<!-- + CUPS command file format specification for CUPS. + + Copyright © 2007-2018 by Apple Inc. + Copyright © 1997-2006 by Easy Software Products. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <H1 CLASS="title">CUPS Command File Format</H1> @@ -193,3 +207,7 @@ device-dependent.</p> #CUPS-COMMAND SetAlignment 1 14 </pre> + + +</body> +</html> diff --git a/doc/spec-design.html b/doc/spec-design.html index c4552ff4d..73d07b8f4 100644 --- a/doc/spec-design.html +++ b/doc/spec-design.html @@ -1,7 +1,11 @@ ---- -title: CUPS Design Description -layout: sub ---- +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<!-- SECTION: Specifications --> +<HEAD> + <TITLE>CUPS Design Description</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">CUPS Design Description</H1> @@ -174,3 +178,7 @@ CUPS_SERVERBIN/notifier/foo recipient user-data <H3>CUPS PPD Compiler Library (libcupsppdc)</H3> <P>The CUPS PPD compiler library provides access to driver information files and is used by the PPD compiler tools as well as the <A HREF="man-cups-driverd.html">cups-driverd(8)</A> helper program to generate PPD files and message catalogs for localization.</P> + + +</BODY> +</HTML> diff --git a/doc/spec-ipp.html b/doc/spec-ipp.html index eb48971d5..3574cd658 100644 --- a/doc/spec-ipp.html +++ b/doc/spec-ipp.html @@ -1,7 +1,21 @@ ---- -title: CUPS Implementation of IPP -layout: sub ---- +<!DOCTYPE HTML> +<html> +<!-- SECTION: Specifications --> +<head> + <title>CUPS Implementation of IPP</title> + <meta name='keywords' content='Programming, Internet Printing Protocol'> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</head> +<body> +<!-- + IPP specification for CUPS. + + Copyright © 2007-2016 by Apple Inc. + Copyright © 1997-2007 by Easy Software Products. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <H1 CLASS="title">CUPS Implementation of IPP</H1> @@ -1886,3 +1900,6 @@ CUPS-Get-PPDs Response: <h4>member-uris (1setof uri)</h4> <p>The "member-uris" attribute specifies the "printer-uri-supported" values for each member printer and class. Each URI corresponds to the same element of the "member-names" attribute. + +</body> +</html> diff --git a/doc/spec-ppd.html b/doc/spec-ppd.html index 70e6a9b94..3782eb7ca 100644 --- a/doc/spec-ppd.html +++ b/doc/spec-ppd.html @@ -1,7 +1,464 @@ ---- -title: CUPS PPD Extensions -layout: sub ---- +<!DOCTYPE html> +<html> +<!-- SECTION: Specifications --> + <head> + <title>CUPS PPD Extensions</title> + <meta name="keywords" content="Specifications"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="codedoc v3.1"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +BLOCKQUOTE { + border-left: solid 2px #777; + margin: 1em 0; + padding: 10px; +} + +BLOCKQUOTE OL LI { + margin-left: -1em; +} + +PRE.command, PRE.example { + background: #eee; + margin: 0 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.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +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; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +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; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding: 5pt 10pt 0; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + 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; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 10px 10px 0px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; + float: right; + font-size: 80%; + padding: 3px 6px; +} +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> +<!-- + PPD extension documentation for CUPS. + + Copyright © 2007-2011 by Apple Inc. + Copyright © 1997-2007 by Easy Software Products. + + Licensed under Apache License v2.0. See the file "LICENSE" for more + information. +--> <H1 CLASS="title">CUPS PPD Extensions</H1> @@ -39,7 +496,7 @@ layout: sub <li><a href="#cupsUIResolver">cupsUIResolver</a></li> </ul></li> <li><a href="#I18N">Globalized PPD Support</a></li> - <li><a href="#OPTIONS"><span class="info">CUPS 1.3/macOS 10.6</span>Custom Options</a></li> + <li><a href="#OPTIONS">Custom Options</a></li> <li><a href="#RASTERPS">Writing PostScript Option Commands for Raster Drivers</a></li> <li><a href="#MEDIA">Media Keywords</a><ul class="subcontents"> <li><a href="#cupsMediaQualifier2">cupsMediaQualifier2</a></li> @@ -129,7 +586,7 @@ LINE-END = CR / LF / CR LF <p>CUPS supports several methods of auto-configuration via PPD keywords.</p> -<h3><span class='info'>macOS 10.5</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3> +<h3 class="title"><span class='info'>macOS 10.5</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3> <p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p> @@ -145,7 +602,7 @@ LINE-END = CR / LF / CR LF </pre> -<h3><span class='info'>macOS 10.2/CUPS 1.4</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3> +<h3 class="title"><span class='info'>macOS 10.2/CUPS 1.4</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3> <p class='summary'>*?<i>MainKeyword</i>: "<br> PostScript query code that writes a message using the = operator...<br> @@ -175,7 +632,7 @@ LINE-END = CR / LF / CR LF </pre> -<h3><span class='info'>macOS 10.4/CUPS 1.5</span><a name='OID'>OIDMainKeyword</a></h3> +<h3 class="title"><span class='info'>macOS 10.4/CUPS 1.5</span><a name='OID'>OIDMainKeyword</a></h3> <p class='summary'>*?OID<i>MainKeyword</i>: ".n.n.n..."<br> *OID<i>MainKeyword</i> <i>OptionKeyword1</i>: "value"<br> @@ -207,7 +664,7 @@ LINE-END = CR / LF / CR LF </blockquote> -<h3><span class='info'>Deprecated</span><a name='cupsColorProfile'>cupsColorProfile</a></h3> +<h3 class="title"><span class='info'>Deprecated</span><a name='cupsColorProfile'>cupsColorProfile</a></h3> <p class='summary'>*cupsColorProfile Resolution/MediaType: "density gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p> @@ -244,7 +701,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </pre> -<h3><span class='info'>macOS 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3> +<h3 class="title"><span class='info'>macOS 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3> <p class='summary'>*cupsICCProfile ColorModel.MediaType.Resolution/Description: "filename"</p> @@ -265,7 +722,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> *cupsICCProfile ../Default: "/Library/Printers/vendor/Profiles/foo-default.icc" </pre> -<h4>Customizing the Profile Selection Keywords</h4> +<h4 class="title">Customizing the Profile Selection Keywords</h4> <p>The <tt>ColorModel</tt>, <tt>MediaType</tt>, and <tt>Resolution</tt> main keywords can be reassigned to different main keywords, allowing drivers to do color profile selection based on different parameters. The <tt>cupsICCQualifier1</tt>, <tt>cupsICCQualifier2</tt>, and <tt>cupsICCQualifier3</tt> keywords define the mapping from selector to main keyword:</p> @@ -284,7 +741,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </pre> -<h3><span class='info'>macOS 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3> +<h3 class="title"><span class='info'>macOS 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3> <p class='summary'>*<a href='#APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a>: true<br> *<a href='#APCustomColorMatchingName'>APCustomColorMatchingName</a> name/text: ""<br> @@ -299,7 +756,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </blockquote> -<h4><span class='info'>macOS 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4> +<h4 class="title"><span class='info'>macOS 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4> <p class='summary'>*APCustomColorMatchingName name/text: ""</p> @@ -313,7 +770,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> *fr.APCustomColorMatchingName name/La AcmeColor(tm): "" </pre> -<h4><span class='info'>macOS 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4> +<h4 class="title"><span class='info'>macOS 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4> <p class='summary'>*APCustomColorMatchingProfile: name</p> @@ -335,7 +792,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> *APCustomColorMatchingProfile: AdobeRGB </pre> -<h4><span class='info'>macOS 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4> +<h4 class="title"><span class='info'>macOS 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4> <p class='summary'>*APDefaultCustomColorMatchingProfile: name</p> @@ -349,7 +806,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> *APDefaultCustomColorMatchingProfile: sRGB </pre> -<h4><span class='info'>macOS 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4> +<h4 class="title"><span class='info'>macOS 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4> <p class='summary'>*APSupportsCustomColorMatching: boolean</p> @@ -386,7 +843,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </blockquote> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsUIConstraints'>cupsUIConstraints</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsUIConstraints'>cupsUIConstraints</a></h3> <p class='summary'>*cupsUIConstraints resolver: "*Keyword1 *Keyword2 ..."<br> *cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 ..."<br> @@ -417,7 +874,7 @@ f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsUIResolver'>cupsUIResolver</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsUIResolver'>cupsUIResolver</a></h3> <p class='summary'>*cupsUIResolver resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p> @@ -635,7 +1092,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234" <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p> -<h3>Custom Page Size Code</h3> +<h3 class="title">Custom Page Size Code</h3> <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p> @@ -649,7 +1106,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234" </pre> -<h3>Supported PostScript Operators</h3> +<h3 class="title">Supported PostScript Operators</h3> <p>CUPS supports the following PostScript operators in addition to the usual PostScript number, string (literal and hex-encoded), boolean, null, and name values:</p> @@ -709,7 +1166,7 @@ PRE B { </blockquote> -<h3>Supported Page Device Attributes</h3> +<h3 class="title">Supported Page Device Attributes</h3> <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p> @@ -981,7 +1438,7 @@ PRE B { size limits based on up to two options.</p> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3> <p class='summary'>*cupsMediaQualifier2: MainKeyword</p> @@ -1001,7 +1458,7 @@ custom page size limits.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMediaQualifier3'>cupsMediaQualifier3</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMediaQualifier3'>cupsMediaQualifier3</a></h3> <p class='summary'>*cupsMediaQualifier3: MainKeyword</p> @@ -1021,7 +1478,7 @@ custom page size limits.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMinSize'>cupsMinSize</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMinSize'>cupsMinSize</a></h3> <p class='summary'>*cupsMinSize .Qualifier2.Qualifier3: "width length"<br> *cupsMinSize .Qualifier2.: "width length"<br> @@ -1045,7 +1502,7 @@ are used to identify options to use for matching.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMaxSize'>cupsMaxSize</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMaxSize'>cupsMaxSize</a></h3> <p class='summary'>*cupsMaxSize .Qualifier2.Qualifier3: "width length"<br> *cupsMaxSize .Qualifier2.: "width length"<br> @@ -1069,7 +1526,7 @@ are used to identify options to use for matching.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsPageSizeCategory'>cupsPageSizeCategory</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsPageSizeCategory'>cupsPageSizeCategory</a></h3> <p class="summary">*cupsPageSizeCategory name/text: "name name2 ... nameN"</p> @@ -1086,7 +1543,7 @@ are used to identify options to use for matching.</p> <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3> <p class='summary'>*cupsBackSide: keyword</p> @@ -1183,7 +1640,7 @@ will be ignored.</p> keyword.</p> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsCommands'>cupsCommands</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsCommands'>cupsCommands</a></h3> <p class='summary'>*cupsCommands: "name name2 ... nameN"</p> @@ -1199,7 +1656,7 @@ by whitespace.</p> </pre> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3> <p class='summary'>*cupsEvenDuplex: boolean</p> @@ -1215,7 +1672,7 @@ printing is selected. The default value is <code>false</code>.</p> </pre> -<h3><a name='cupsFax'>cupsFax</a></h3> +<h3 class="title"><a name='cupsFax'>cupsFax</a></h3> <p class='summary'>*cupsFax: boolean</p> @@ -1228,7 +1685,7 @@ printing is selected. The default value is <code>false</code>.</p> </pre> -<h3><a name='cupsFilter'>cupsFilter</a></h3> +<h3 class="title"><a name='cupsFilter'>cupsFilter</a></h3> <p class='summary'>*cupsFilter: "source/type cost program"</p> @@ -1251,7 +1708,7 @@ the special filter program "-" may be specified.</p> </pre> -<h3><span class='info'>CUPS 1.5</span><a name='cupsFilter2'>cupsFilter2</a></h3> +<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsFilter2'>cupsFilter2</a></h3> <p class='summary'>*cupsFilter2: "source/type destination/type cost program"</p> @@ -1277,7 +1734,7 @@ the special filter program "-" may be specified.</p> </pre> -<h3><span class='info'>CUPS 2.3</span><a name='cupsFinishingTemplate'>cupsFinishingTemplate</a></h3> +<h3 class="title"><span class='info'>CUPS 2.3</span><a name='cupsFinishingTemplate'>cupsFinishingTemplate</a></h3> <p class='summary'>*cupsFinishingTemplate name/text: ""</p> @@ -1296,7 +1753,7 @@ the special filter program "-" may be specified.</p> </pre> -<h3><span class='info'>Deprecated</span><a name='cupsFlipDuplex'>cupsFlipDuplex</a></h3> +<h3 class="title"><span class='info'>Deprecated</span><a name='cupsFlipDuplex'>cupsFlipDuplex</a></h3> <p class='summary'>*cupsFlipDuplex: boolean</p> @@ -1332,7 +1789,7 @@ Ghostscript can use:</p> </pre></blockquote> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3> <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p> @@ -1349,7 +1806,7 @@ values to PPD options and choices.</p> </pre> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsIPPReason'>cupsIPPReason</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsIPPReason'>cupsIPPReason</a></h3> <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p> @@ -1390,7 +1847,7 @@ http://www.vendor.com/help" </pre> -<h3><span class='info'>CUPS 1.5</span><a name='cupsIPPSupplies'>cupsIPPSupplies</a></h3> +<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsIPPSupplies'>cupsIPPSupplies</a></h3> <p class='summary'>*cupsIPPSupplies: boolean</p> @@ -1404,7 +1861,7 @@ http://www.vendor.com/help" </pre> -<h3><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobAccountId'>cupsJobAccountId</a></h3> +<h3 class="title"><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobAccountId'>cupsJobAccountId</a></h3> <p class='summary'>*cupsJobAccountId: boolean</p> @@ -1418,7 +1875,7 @@ http://www.vendor.com/help" </pre> -<h3><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobAccountingUserId'>cupsJobAccountingUserId</a></h3> +<h3 class="title"><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobAccountingUserId'>cupsJobAccountingUserId</a></h3> <p class='summary'>*cupsJobAccountingUserId: boolean</p> @@ -1432,7 +1889,7 @@ http://www.vendor.com/help" </pre> -<h3><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobPassword'>cupsJobPassword</a></h3> +<h3 class="title"><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsJobPassword'>cupsJobPassword</a></h3> <p class='summary'>*cupsJobPassword: "format"</p> @@ -1459,7 +1916,7 @@ password string. For example, "1111" indicated a 4-digit US ASCII PIN code.</p> </pre> -<h3><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3> +<h3 class="title"><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3> <p class='summary'>*cupsLanguages: "locale list"</p> @@ -1475,7 +1932,7 @@ list of locale names ("en", "en_US", "fr_CA", etc.)</p> </pre> -<h3><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsMandatory'>cupsMandatory</a></h3> +<h3 class="title"><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsMandatory'>cupsMandatory</a></h3> <p class='summary'>*cupsMandatory: "attribute1 attribute2 ... attributeN"</p> @@ -1489,7 +1946,7 @@ list of locale names ("en", "en_US", "fr_CA", etc.)</p> </pre> -<h3><a name='cupsManualCopies'>cupsManualCopies</a></h3> +<h3 class="title"><a name='cupsManualCopies'>cupsManualCopies</a></h3> <p class='summary'>*cupsManualCopies: boolean</p> @@ -1505,7 +1962,7 @@ hardware. The default value is <code>false</code>.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3> <p class='summary'>*cupsMarkerName/Name Text: ""</p> @@ -1520,7 +1977,7 @@ generated by the driver to human readable text.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3> <p class='summary'>*cupsMarkerNotice: "disclaimer text"</p> @@ -1535,7 +1992,7 @@ are approximate".</p> </pre> -<h3><span class='info'>CUPS 1.6/macOS 10.8</span><a name='cupsMaxCopies'>cupsMaxCopies</a></h3> +<h3 class="title"><span class='info'>CUPS 1.6/macOS 10.8</span><a name='cupsMaxCopies'>cupsMaxCopies</a></h3> <p class='summary'>*cupsMaxCopies: integer</p> @@ -1549,7 +2006,7 @@ are approximate".</p> </pre> -<h3><a name='cupsModelNumber'>cupsModelNumber</a></h3> +<h3 class="title"><a name='cupsModelNumber'>cupsModelNumber</a></h3> <p class='summary'>*cupsModelNumber: number</p> @@ -1565,7 +2022,7 @@ the output for a specific model of printer.</p> </pre> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3> <p class='summary'>*cupsPJLCharset: "ISO character set name"</p> @@ -1581,7 +2038,7 @@ assumed.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3> <p class='summary'>*cupsPJLDisplay: "what"</p> @@ -1601,7 +2058,7 @@ to use "@PJL RDYMSG DISPLAY". The default is "job".</p> </pre> -<h3><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3> +<h3 class="title"><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3> <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p> @@ -1634,7 +2091,7 @@ to disable the port monitor for the given URI scheme.</p> </pre> -<h3><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3> +<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3> <p class='summary'>*cupsPreFilter: "source/type cost program"</p> @@ -1653,7 +2110,7 @@ before the filter that accepts the given MIME type.</p> </pre> -<h3><span class='info'>CUPS 1.5</span><a name='cupsPrintQuality'>cupsPrintQuality</a></h3> +<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsPrintQuality'>cupsPrintQuality</a></h3> <p class='summary'>*cupsPrintQuality keyword/text: "code"</p> @@ -1678,7 +2135,7 @@ before the filter that accepts the given MIME type.</p> </pre> -<h3><span class='info'>CUPS 1.5</span><a name='cupsSingleFile'>cupsSingleFile</a></h3> +<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsSingleFile'>cupsSingleFile</a></h3> <p class='summary'>*cupsSingleFile: Boolean</p> @@ -1695,7 +2152,7 @@ before the filter that accepts the given MIME type.</p> </pre> -<h3><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3> +<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3> <p class='summary'>*cupsSNMPSupplies: boolean</p> @@ -1711,7 +2168,7 @@ the standard SNMP Printer MIB OIDs for supply levels. The default value is </pre> -<h3><a name='cupsVersion'>cupsVersion</a></h3> +<h3 class="title"><a name='cupsVersion'>cupsVersion</a></h3> <p class='summary'>*cupsVersion: major.minor</p> @@ -1727,7 +2184,7 @@ PPD file extensions was used. Currently it must be the string </pre> -<h3><span class="info">CUPS 1.6/macOS 10.8</span><a name="JCLToPDFInterpreter">JCLToPDFInterpreter</a></h3> +<h3 class="title"><span class="info">CUPS 1.6/macOS 10.8</span><a name="JCLToPDFInterpreter">JCLToPDFInterpreter</a></h3> <p class="summary">*JCLToPDFInterpreter: "JCL"</p> @@ -1743,7 +2200,7 @@ PPD file extensions was used. Currently it must be the string <h2 class='title'><a name='MACOSX'>macOS Attributes</a></h2> -<h3><span class='info'>Deprecated</span><a name='APDialogExtension'>APDialogExtension</a></h3> +<h3 class="title"><span class='info'>Deprecated</span><a name='APDialogExtension'>APDialogExtension</a></h3> <p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p> @@ -1774,7 +2231,7 @@ AirPrint moving forward.</p> </pre> -<h3><span class='info'>macOS 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3> +<h3 class="title"><span class='info'>macOS 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3> <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p> @@ -1857,7 +2314,7 @@ and the <tt>Tumble</tt> page attribute.</p> keyword.</p> -<h3><a name='APHelpBook'>APHelpBook</a></h3> +<h3 class="title"><a name='APHelpBook'>APHelpBook</a></h3> <p class='summary'>*APHelpBook: "bundle URL"</p> @@ -1873,7 +2330,7 @@ looking up IPP reason codes for this printer driver. The </pre> -<h3><span class='info'>macOS 10.6</span><a name='APICADriver'>APICADriver</a></h3> +<h3 class="title"><span class='info'>macOS 10.6</span><a name='APICADriver'>APICADriver</a></h3> <p class='summary'>*APICADriver: boolean</p> @@ -1888,7 +2345,7 @@ Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p> </pre> -<h3><span class='info'>macOS 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3> +<h3 class="title"><span class='info'>macOS 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3> <p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p> @@ -1903,7 +2360,7 @@ displaying the printer. The file must be in the Apple icon format.</p> </pre> -<h3><span class='info'>macOS 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3> +<h3 class="title"><span class='info'>macOS 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3> <p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p> @@ -1921,7 +2378,7 @@ Technical Note TN2144</a> for more information.</p> </pre> -<h3><span class='info'>macOS 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3> +<h3 class="title"><span class='info'>macOS 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3> <p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p> @@ -1992,7 +2449,7 @@ choice (*MainKeyword OptionKeyword) or a preset identifier and value </pre> -<h3><span class='info'>macOS 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3> +<h3 class="title"><span class='info'>macOS 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3> <p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p> @@ -2008,7 +2465,7 @@ information.</p> </pre> -<h3><span class='info'>macOS 10.6</span><a name='APScannerOnly'>APScannerOnly</a></h3> +<h3 class="title"><span class='info'>macOS 10.6</span><a name='APScannerOnly'>APScannerOnly</a></h3> <p class='summary'>*APScannerOnly: boolean</p> @@ -2023,7 +2480,7 @@ capabilities. The default is <tt>False</tt>.</p> </pre> -<h3><span class='info'>macOS 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3> +<h3 class="title"><span class='info'>macOS 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3> <p class='summary'>*APScanAppBundleID: "bundle ID"</p> @@ -2040,7 +2497,7 @@ the device.</p> <h2 class='title'><a name='HISTORY'>Change History</a></h2> -<h3>Changes in CUPS 2.3</h3> +<h3 class="title">Changes in CUPS 2.3</h3> <ul> @@ -2049,7 +2506,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.7</h3> +<h3 class="title">Changes in CUPS 1.7</h3> <ul> @@ -2061,7 +2518,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.6</h3> +<h3 class="title">Changes in CUPS 1.6</h3> <ul> @@ -2076,7 +2533,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.5</h3> +<h3 class="title">Changes in CUPS 1.5</h3> <ul> @@ -2085,7 +2542,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.4.5</h3> +<h3 class="title">Changes in CUPS 1.4.5</h3> <ul> @@ -2096,7 +2553,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.4</h3> +<h3 class="title">Changes in CUPS 1.4</h3> <ul> @@ -2131,7 +2588,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.3.1</h3> +<h3 class="title">Changes in CUPS 1.3.1</h3> <ul> @@ -2146,7 +2603,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.3</h3> +<h3 class="title">Changes in CUPS 1.3</h3> <ul> @@ -2166,7 +2623,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.2.8</h3> +<h3 class="title">Changes in CUPS 1.2.8</h3> <ul> @@ -2176,7 +2633,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.2</h3> +<h3 class="title">Changes in CUPS 1.2</h3> <ul> @@ -2202,7 +2659,7 @@ the device.</p> </ul> -<h3>Changes in CUPS 1.1</h3> +<h3 class="title">Changes in CUPS 1.1</h3> <ul> @@ -2212,3 +2669,5 @@ the device.</p> </ul> </div> + </body> +</html> diff --git a/doc/spec-raster.html b/doc/spec-raster.html index 2cd71800e..50fca220a 100644 --- a/doc/spec-raster.html +++ b/doc/spec-raster.html @@ -1,7 +1,11 @@ ---- -title: CUPS Raster Format -layout: sub ---- +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<!-- SECTION: Specifications --> +<HEAD> + <TITLE>CUPS Raster Format</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">CUPS Raster Format</H1> @@ -711,3 +715,6 @@ layout: sub <li>Added ICC and CIE color spaces.</li> </ul> + +</BODY> +</HTML> diff --git a/doc/spec-stp.html b/doc/spec-stp.html index b4b4e351a..06c099b55 100644 --- a/doc/spec-stp.html +++ b/doc/spec-stp.html @@ -1,7 +1,11 @@ ---- -title: CUPS Software Test Plan -layout: sub ---- +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<!-- SECTION: Specifications --> +<HEAD> + <TITLE>CUPS Software Test Plan</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">CUPS Software Test Plan</H1> @@ -124,3 +128,6 @@ properly cancel a job or all jobs.</P> <P>This test verifies that the <CODE>lpinfo</CODE> command returns a list of available printer drivers and devices.</P> + +</BODY> +</HTML> diff --git a/doc/translation.html b/doc/translation.html index ab419d30d..7202c4c0e 100644 --- a/doc/translation.html +++ b/doc/translation.html @@ -1,77 +1,53 @@ ---- -title: Translating and Customizing CUPS -layout: sub ---- +<HTML> +<!-- SECTION: Getting Started --> +<HEAD> + <TITLE>Translating and Customizing CUPS</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> <H1 CLASS="title">Translating and Customizing CUPS</H1> -<P>Thanks to its extensive use of templates, images, and message -catalogs, CUPS can be easily translated (or customized!) to suit -your needs. This help file will guide you through the CUPS -localization files so you can get the most out of it.</P> +<P>Thanks to its extensive use of templates, images, and message catalogs, CUPS can be easily translated (or customized!) to suit your needs. This help file will guide you through the CUPS localization files so you can get the most out of it.</P> -<H2 CLASS="title"><A NAME="INTRO">Getting Started</A></H2> +<H2 CLASS="title" ID="INTRO">Getting Started</H2> -<P>Start by downloading the CUPS source code from <A -HREF="http://www.cups.org/software.php" -TARGET="_blank">www.cups.org</A>. After you extract the files -from the source archive, you will want to copy the following -files and directories:</P> +<P>Start by downloading the CUPS source code from <A HREF="https://www.cups.org/" TARGET="_blank">www.cups.org</A>. After you extract the files from the source archive (or clone the Git repository), you will want to copy the following files and directories:</P> <UL> - <LI><VAR>desktop/cups.desktop</VAR> - the GNOME/KDE - desktop file pointing to the CUPS web interface</LI> + <LI><VAR>desktop/cups.desktop</VAR> - the GNOME/KDE desktop file pointing to the CUPS web interface</LI> - <LI><VAR>doc/index.html</VAR> - the web interface home - page</LI> + <LI><VAR>doc/index.html.in</VAR> - the web interface home page</LI> <LI><VAR>locale/cups.pot</VAR> - the message catalog</LI> - <LI><VAR>templates/*.tmpl</VAR> - the web interface - template files</LI> + <LI><VAR>templates/*.tmpl</VAR> and <VAR>templates/header.tmpl.in</VAR> - the web interface template files</LI> </UL> -<P>With the exception of the message catalogs and desktop file, -localization files are placed in subdirectories under the -<VAR>doc</VAR> and <VAR>templates</VAR> using the locale name. -Locale names are either <VAR>ll</VAR> or <VAR>ll_CC</VAR>, where -"ll" is the 2-letter language code and "CC" is the 2-letter -country code. <em>CUPS does not currently use or support the newer -<VAR>ll-region</VAR> syntax for locale names.</em></P> +<P>With the exception of the message catalogs and desktop file, localization files are placed in subdirectories under the <VAR>doc</VAR> and <VAR>templates</VAR> using the locale name. Locale names are either <VAR>ll</VAR> or <VAR>ll_CC</VAR>, where "ll" is the 2-letter language code and "CC" is the 2-letter country code. <em>CUPS does not currently use or support the newer <VAR>ll-region</VAR> syntax for locale names.</em></P> -<P>All non-image files must be encoded using the UTF-8 character -set.</P> +<P>All non-image files must be encoded using the UTF-8 character set.</P> -<H2 CLASS="title"><A NAME="SUBMIT">Submitting a Translation for CUPS</A></H2> +<H2 CLASS="title" ID="SUBMIT">Submitting a Translation for CUPS</H2> -<P>To submit a translation for inclusion in CUPS, translate the -desktop file, all of the template files, the <VAR>index.html.in</VAR> -file, and the message catalog. Place these files in the correct -subdirectories in the CUPS source code archive and run the following -command to create an archive with your files:</P> +<P>To submit a translation for inclusion in CUPS, translate the desktop file, all of the template files, the <VAR>index.html.in</VAR> file, and the message catalog. Place these files in the correct subdirectories in the CUPS source code archive and run the following command to create an archive with your files:</P> <PRE CLASS="command"> -tar cvf <I>ll_CC</I>.tar.gz desktop/cups.desktop doc/<I>ll_CC</I> \ - locale/cups_<I>ll_CC</I>.po templates/<I>ll_CC</I> +tar cvf <I>ll_CC</I>.tar.gz desktop/cups.desktop doc/<I>ll_CC</I> locale/cups_<I>ll_CC</I>.po templates/<I>ll_CC</I> </PRE> -<P>Replace "ll_CC" with the locale name for your translation. -Once you have created the archive, go to the <A -HREF="http://www.cups.org/str.php" TARGET="_blank">CUPS Bugs -& Features</A> page and submit a bug report, attaching the -translation to the report.</P> +<P>Replace "ll_CC" with the locale name for your translation. Once you have created the archive, go to the <A HREF="https://github.com/apple/cups" TARGET="_blank">CUPS project page</A> and submit a bug report, attaching the translation to the report.</P> +<P>Alternately, you can clone the CUPS project on Github, make your changes, and submit a pull request from the same link.</P> -<H2 CLASS="title"><A NAME="DESKTOP">The Desktop File</A></H2> -<P>The <VAR>desktop/cups.desktop</VAR> file provides a link to -the CUPS web interface from desktop environments such as -GNOME and KDE. To translate this file, add two lines to the -bottom with the <tt>Name</tt> and <tt>Comment</tt> keys:</P> +<H2 CLASS="title" ID="DESKTOP">The Desktop File</H2> + +<P>The <VAR>desktop/cups.desktop</VAR> file provides a link to the CUPS web interface from desktop environments such as GNOME and KDE. To translate this file, add two lines to the bottom with the <tt>Name</tt> and <tt>Comment</tt> keys:</P> <PRE CLASS="command"> Name[<I>ll_CC</I>]=<I>Translation of "Manage Printing"</I> @@ -79,42 +55,25 @@ Comment[<I>ll_CC</I>]=<I>Translation of "CUPS Web Interface"</I> </PRE> -<H2 CLASS="title"><A NAME="HOMEPAGE">The Home Page</A></H2> +<H2 CLASS="title" ID="HOMEPAGE">The Home Page</H2> -<P>The <VAR>index.html</VAR> file is a complete HTML file that is -displayed when the user visits "http://localhost:631/". Edit the -existing <VAR>doc/index.html</VAR> and save it in the -<VAR>doc/ll_CC</VAR> subdirectory so that the makefile can -install it. Run "make install" in the <VAR>doc</VAR> subdirectory -to test the new home page.</P> +<P>The <VAR>index.html.in</VAR> file is a complete HTML file that is displayed when the user visits "http://localhost:631/". Edit the existing <VAR>doc/index.html.in</VAR> and save it in the <VAR>doc/ll_CC</VAR> subdirectory so that the configure script can generate it. After configuring, run "make install" in the <VAR>doc</VAR> subdirectory to test the new home page.</P> -<H2 CLASS="title"><A NAME="CATALOGS">Message Catalogs</A></H2> +<H2 CLASS="title" ID="CATALOGS">Message Catalogs</H2> -<P>CUPS message catalogs are GNU gettext ".po" text files that -provide a list of localized message strings for the CUPS -software. Message catalogs are named <VAR>cups_ll.po</VAR> or -<VAR>cups_ll_CC.po</VAR>, where "ll" is the standard 2-letter -abbreviation for the language and "CC" is the standard 2-letter -abbreviation for the country.</P> +<P>CUPS message catalogs are GNU gettext ".po" text files that provide a list of localized message strings for the CUPS software. Message catalogs are named <VAR>cups_ll.po</VAR> or <VAR>cups_ll_CC.po</VAR>, where "ll" is the standard 2-letter abbreviation for the language and "CC" is the standard 2-letter abbreviation for the country.</P> -<P>When translating a new message catalog, copy the -<VAR>cups.pot</VAR> message catalog file in the <VAR>locale</VAR> -subdirectory of the CUPS source code. For example, to start -translating the message catalog to Canadian French, you would -type the following commands:</P> +<P>When translating a new message catalog, copy the <VAR>cups.pot</VAR> message catalog file in the <VAR>locale</VAR> subdirectory of the CUPS source code. For example, to start translating the message catalog to Canadian French, you would type the following commands:</P> <PRE CLASS="command"> cd locale cp cups.pot cups_fr_CA.po </PRE> -<P>Alternatively, you can copy the existing <VAR>cups_fr.po</VAR> -message catalog and then make any necessary changes.</P> +<P>Alternatively, you can copy the existing <VAR>cups_fr.po</VAR> message catalog and then make any necessary changes.</P> -<P>Once you have make your copy of the file, edit it using your -favorite text editor or translation program to translate the text -to the desired language.</P> +<P>Once you have make your copy of the file, edit it using your favorite text editor or translation program to translate the text to the desired language.</P> <P>Then validate your translation using the <VAR>locale/checkpo</VAR> utility:</P> @@ -123,29 +82,14 @@ cd locale ./checkpo cups_ll_CC.po </PRE> -<P>After fixing any errors in your translation, add your locale to the <CODE>LANGUAGES</CODE> -variable in the <VAR>Makedefs</VAR> file and run the "make -install" command in the <VAR>locale</VAR> subdirectory to test -the translation.</P> +<P>After fixing any errors in your translation, add your locale to the <CODE>LANGUAGES</CODE> variable in the <VAR>Makedefs</VAR> file and run the "make install" command in the <VAR>locale</VAR> subdirectory to test the translation. <em>This variable is automatically updated when you run the configure script.</em></P> -<H2 CLASS="title"><A NAME="TEMPLATES">Template Files</A></H2> +<H2 CLASS="title" ID="TEMPLATES">Template Files</H2> -<P>The CUPS scheduler provides a web interface that can be used -to do many common printing and administration tasks. The built-in -web server supports localization of web pages through the use of -subdirectories for each locale, e.g. "fr" for French, "de" for -German, "fr_ca" for French in Canada, and so forth.</P> +<P>The CUPS scheduler provides a web interface that can be used to do many common printing and administration tasks. The built-in web server supports localization of web pages through the use of subdirectories for each locale, e.g. "fr" for French, "de" for German, "fr_ca" for French in Canada, and so forth.</P> -<P>Template files are HTML files with special formatting -characters in them that allow substitution of variables and arrays. -The CUPS CGI programs (<CODE>admin.cgi</CODE>, -<CODE>classes.cgi</CODE>, <CODE>help.cgi</CODE>, -<CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE>) use these -template file to provide dynamic content for the web interface. -Template files are installed in the -<VAR>/usr/share/cups/templates</VAR> directory by default. Table -2 lists the various template files and their purpose.</P> +<P>Template files are HTML files with special formatting characters in them that allow substitution of variables and arrays. The CUPS CGI programs (<CODE>admin.cgi</CODE>, <CODE>classes.cgi</CODE>, <CODE>help.cgi</CODE>, <CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE>) use these template file to provide dynamic content for the web interface. Template files are installed in the <VAR>/usr/share/cups/templates</VAR> directory by default. <A HREF="table1">Table 1</a> lists the various template files and their purpose.</P> <P>Translated versions of the template files should be saved in the <VAR>templates/ll_CC</VAR> subdirectory. For example, @@ -156,8 +100,8 @@ translated all of the templates, add the locale to the <VAR>Makedefs</VAR> file and run "make install" in the <VAR>templates</VAR> subdirectory to test the translation.</P> -<DIV CLASS="table"><TABLE SUMMARY="Web Interface Template Files"> -<CAPTION>Table 2: Web Interface Template Files</CAPTION> +<DIV CLASS="table"><TABLE ID="table1" SUMMARY="Web Interface Template Files"> +<CAPTION>Table 1: Web Interface Template Files</CAPTION> <THEAD> <TR> <TH>Filename</TH> @@ -167,17 +111,11 @@ translated all of the templates, add the locale to the <TBODY> <TR> <TD>add-class.tmpl</TD> - <TD>This is the initial form that is shown to add a new - printer class.</TD> + <TD>This is the initial form that is shown to add a new printer class.</TD> </TR> <TR> <TD>add-printer.tmpl</TD> - <TD>This is the initial form that is shown to add a new - printer.</TD> -</TR> -<TR> - <TD>add-rss-subscription.tmpl</TD> - <TD>This is the form that is shown to add a new RSS subscription.</TD> + <TD>This is the initial form that is shown to add a new printer.</TD> </TR> <TR> <TD>admin.tmpl</TD> @@ -185,28 +123,27 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>choose-device.tmpl</TD> - <TD>This is the form that shows the list of available - devices.</TD> + <TD>This is the form that shows the list of available devices.</TD> </TR> <TR> <TD>choose-make.tmpl</TD> - <TD>This is the form that shows the list of available - manufacturers.</TD> + <TD>This is the form that shows the list of available manufacturers.</TD> </TR> <TR> <TD>choose-model.tmpl</TD> - <TD>This is the form that shows the list of available - printer models/drivers.</TD> + <TD>This is the form that shows the list of available printer models/drivers.</TD> </TR> <TR> <TD>choose-serial.tmpl</TD> - <TD>This is the form that allows the user to choose - a serial port and any options.</TD> + <TD>This is the form that allows the user to choose a serial port and any options.</TD> </TR> <TR> <TD>choose-uri.tmpl</TD> - <TD>This is the form that allows the user to enter - a device URI for network printers.</TD> + <TD>This is the form that allows the user to enter a device URI for network printers.</TD> +</TR> +<TR> + <TD>class.tmpl</TD> + <TD>This template shows information about a single class.</TD> </TR> <TR> <TD>class-added.tmpl</TD> @@ -214,8 +151,7 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>class-confirm.tmpl</TD> - <TD>This is the template used to confirm the - deletion of a class.</TD> + <TD>This is the template used to confirm the deletion of a class.</TD> </TR> <TR> <TD>class-deleted.tmpl</TD> @@ -223,8 +159,7 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>class-jobs-header.tmpl</TD> - <TD>This template shows the "jobs" header for jobs in a - class.</TD> + <TD>This template shows the "jobs" header for jobs in a class.</TD> </TR> <TR> <TD>class-modified.tmpl</TD> @@ -236,8 +171,11 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>classes-header.tmpl</TD> - <TD>This template shows the "showing N of M classes" header in - the class list.</TD> + <TD>This template shows the "showing N of M classes" header in the class list.</TD> +</TR> +<TR> + <TD>command.tmpl</TD> + <TD>This template shows the status of a command job.</TD> </TR> <TR> <TD>edit-config.tmpl</TD> @@ -252,9 +190,8 @@ translated all of the templates, add the locale to the <TD>This is the "unknown operation" error page.</TD> </TR> <TR> - <TD>header.tmpl</TD> - <TD>This template is used as the standard header on all dynamic - content.</TD> + <TD>header.tmpl(.in)</TD> + <TD>This template is used as the standard header on all dynamic content. Edit the <VAR>header.tmpl.in</VAR> file and let the configure script generate the <VAR>header.tmpl</VAR> file.</TD> </TR> <TR> <TD>help-header.tmpl</TD> @@ -262,8 +199,11 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>help-printable.tmpl</TD> - <TD>This is the standard page header for the printable - version of help files.</TD> + <TD>This is the standard page header for the printable version of help files.</TD> +</TR> +<TR> + <TD>help-trailer.tmpl</TD> + <TD>This is the bottom part of the help page.</TD> </TR> <TR> <TD>job-cancel.tmpl</TD> @@ -291,36 +231,27 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>jobs.tmpl</TD> - <TD>This template is used to list the print jobs on a server, - class, or printer.</TD> + <TD>This template is used to list the print jobs on a server, class, or printer.</TD> </TR> <TR> <TD>jobs-header.tmpl</TD> - <TD>This template shows the "showing N or M jobs" header in the - jobs list.</TD> + <TD>This template shows the "showing N or M jobs" header in the jobs list.</TD> </TR> <TR> <TD>list-available-printers.tmpl</TD> <TD>This template shows a list of new printers that have been found.</TD> </TR> <TR> - <TD>maintenance.tmpl</TD> - <TD>This template shows "maintenance commands sent".</TD> -</TR> -<TR> <TD>modify-class.tmpl</TD> - <TD>This template is used as the first form when modifying a - class.</TD> + <TD>This template is used as the first form when modifying a class.</TD> </TR> <TR> <TD>modify-printer.tmpl</TD> - <TD>This template is used as the first form when modifying a - printer.</TD> + <TD>This template is used as the first form when modifying a printer.</TD> </TR> <TR> <TD>norestart.tmpl</TD> - <TD>This template shows "server not restarted because no - changes were made to the configuration".</TD> + <TD>This template shows "server not restarted because no changes were made to the configuration".</TD> </TR> <TR> <TD>option-boolean.tmpl</TD> @@ -351,6 +282,10 @@ translated all of the templates, add the locale to the <TD>This template shows the previous/next pager bar.</TD> </TR> <TR> + <TD>printer.tmpl</TD> + <TD>This template shows information about a single printer.</TD> +</TR> +<TR> <TD>printer-accept.tmpl</TD> <TD>This template shows "printer now accepting jobs".</TD> </TR> @@ -359,13 +294,16 @@ translated all of the templates, add the locale to the <TD>This template shows "printer added".</TD> </TR> <TR> + <TD>printer-cancel-jobs.tmpl</TD> + <TD>This template shows "All jobs on printer have been canceled."</TD> +</TR> +<TR> <TD>printer-configured.tmpl</TD> <TD>This template shows "printer configured".</TD> </TR> <TR> <TD>printer-confirm.tmpl</TD> - <TD>This template asks the user to confirm the deletion - of a printer.</TD> + <TD>This template asks the user to confirm the deletion of a printer.</TD> </TR> <TR> <TD>printer-default.tmpl</TD> @@ -377,18 +315,13 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>printer-jobs-header.tmpl</TD> - <TD>This templates shows the "jobs" header for jobs on a - printer.</TD> + <TD>This templates shows the "jobs" header for jobs on a printer.</TD> </TR> <TR> <TD>printer-modified.tmpl</TD> <TD>This template shows "printer modified".</TD> </TR> <TR> - <TD>printer-purge.tmpl</TD> - <TD>This template shows "printer has been purged of all jobs".</TD> -</TR> -<TR> <TD>printer-reject.tmpl</TD> <TD>This template shows "printer now rejecting jobs".</TD> </TR> @@ -402,47 +335,27 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>printers.tmpl</TD> - <TD>This template is used to list information on one or more - printers.</TD> + <TD>This template is used to list information on one or more printers.</TD> </TR> <TR> <TD>printers-header.tmpl</TD> - <TD>This template shows the "showing printer N of M" header in - the printers list.</TD> + <TD>This template shows the "showing printer N of M" header in the printers list.</TD> </TR> <TR> <TD>restart.tmpl</TD> <TD>This template shows "server restarting".</TD> </TR> <TR> - <TD>samba-export.tmpl</TD> - <TD>This template shows the export printers to Samba form.</TD> -</TR> -<TR> - <TD>samba-exported.tmpl</TD> - <TD>This template shows "printers exported to Samba".</TD> -</TR> -<TR> <TD>search.tmpl</TD> <TD>This template shows the search form.</TD> </TR> <TR> <TD>set-printer-options-header.tmpl</TD> - <TD>This template shows the first part of the set printer options - form.</TD> + <TD>This template shows the first part of the set printer options form.</TD> </TR> <TR> <TD>set-printer-options-trailer.tmpl</TD> - <TD>This template shows the last part of the set printer options - form.</TD> -</TR> -<TR> - <TD>subscription-added.tmpl</TD> - <TD>This template shows "subscription ... added".</TD> -</TR> -<TR> - <TD>subscription-canceled.tmpl</TD> - <TD>This template shows "subscription #NNN canceled".</TD> + <TD>This template shows the last part of the set printer options form.</TD> </TR> <TR> <TD>test-page.tmpl</TD> @@ -450,8 +363,7 @@ translated all of the templates, add the locale to the </TR> <TR> <TD>trailer.tmpl</TD> - <TD>This template is used as the standard trailer on all dynamic - content.</TD> + <TD>This template is used as the standard trailer on all dynamic content.</TD> </TR> <TR> <TD>users.tmpl</TD> @@ -460,42 +372,21 @@ translated all of the templates, add the locale to the </TBODY> </TABLE></DIV> -<H3><A NAME="VARIABLE">Inserting Attributes and Values</A></H3> +<H4 ID="VARIABLE">Inserting Attributes and Values</H4> -<P>Template files consist of HTML with variable substitutions for -named inside curly braces "{name}". Variable names are generally -the IPP attribute names with the hyphen ("-") replaced by the -underscore ("_") character. For example, the -<TT>job-printer-uri</TT> attribute is renamed to -<TT>job_printer_uri</TT>.</P> +<P>Template files consist of HTML with variable substitutions for named inside curly braces "{name}". Variable names are generally the IPP attribute names with the hyphen ("-") replaced by the underscore ("_") character. For example, the <TT>job-printer-uri</TT> attribute is renamed to <TT>job_printer_uri</TT>.</P> -<P>Curley braces ("{" and "}") to indicate substitutions, and the -backslash ("\") character for quoting. To insert any of these -special characters as-is you need to use the HTML -<CODE>&name;</CODE> mechanism or prefix each special -character with the backslash ("\".)</P> +<P>Curley braces ("{" and "}") to indicate substitutions, and the backslash ("\") character for quoting. To insert any of these special characters as-is you need to use the HTML <CODE>&name;</CODE> mechanism or prefix each special character with the backslash ("\".)</P> -<P>You substitute the value of a variable using -<CODE>{NAME}</CODE> in your template file. If the variable is -undefined then the <CODE>{NAME}</CODE> string is output -as-is.</P> +<P>You substitute the value of a variable using <CODE>{NAME}</CODE> in your template file. If the variable is undefined then the <CODE>{NAME}</CODE> string is output as-is.</P> -<P>To substitute an empty string if the variable is undefined, -use <CODE>{?NAME}</CODE> instead.</P> +<P>To substitute an empty string if the variable is undefined, use <CODE>{?NAME}</CODE> instead.</P> -<H3>Array Substitutions</H3> +<H4>Array Substitutions</H4> -<P>The number of array elements can be inserted using -<CODE>{#NAME}</CODE>. If the array is undefined then 0 is output. -The current array element (starting at 1) is inserted with -<CODE>{#}</CODE>.</P> +<P>The number of array elements can be inserted using <CODE>{#NAME}</CODE>. If the array is undefined then 0 is output. The current array element (starting at 1) is inserted with <CODE>{#}</CODE>.</P> -<P>Arrays are handled using <CODE>{[NAME]</CODE> at the beginning -of a section and <CODE>}</CODE> at the end. The information -between the closing bracket ("]") and closing brace ("}") is -repeated for as many elements as are in the named array. For -example, the following template will display a list of each job -in the <CODE>job_id</CODE> array:</P> +<P>Arrays are handled using <CODE>{[NAME]</CODE> at the beginning of a section and <CODE>}</CODE> at the end. The information between the closing bracket ("]") and closing brace ("}") is repeated for as many elements as are in the named array. For example, the following template will display a list of each job in the <CODE>job_id</CODE> array:</P> <PRE CLASS="command"> <TABLE> @@ -515,13 +406,11 @@ in the <CODE>job_id</CODE> array:</P> </TABLE> </PRE> -<P>Arrays can be nested, however all elements within the curly -braces ("{" and "}") are indexed using the innermost array.</P> +<P>Arrays can be nested, however all elements within the curly braces ("{" and "}") are indexed using the innermost array.</P> -<H3>Conditional Tests</H3> +<H4>Conditional Tests</H4> -<P>Templates can also test variables against specific values and -conditionally include text in the template. The format is:</P> +<P>Templates can also test variables against specific values and conditionally include text in the template. The format is:</P> <PRE CLASS="command"> {<I>variable</I>?<I>true</I>:<I>false</I>} @@ -531,15 +420,10 @@ conditionally include text in the template. The format is:</P> {<I>variable</I>><I>value</I>?<I>true</I>:<I>false</I>} </PRE> -<P>where <VAR>true</VAR> is the text that is included if the -condition is true and <VAR>false</VAR> is the text that is -included if the condition is false. A value of <CODE>#</CODE> is -replaced with the current element number (starting at 1.) The -character after the variable name specifies the condition to -test. Table 3 shows the available test conditions.</P> +<P>where <VAR>true</VAR> is the text that is included if the condition is true and <VAR>false</VAR> is the text that is included if the condition is false. A value of <CODE>#</CODE> is replaced with the current element number (starting at 1.) The character after the variable name specifies the condition to test. <A HREF="#table2">Table 2</A> shows the available test conditions.</P> -<DIV CLASS="table"><TABLE SUMMARY="Template Substitution Conditions"> -<CAPTION>Table 3: Template Substitution Conditions</CAPTION> +<DIV CLASS="table"><TABLE ID="table2" SUMMARY="Template Substitution Conditions"> +<CAPTION>Table 2: Template Substitution Conditions</CAPTION> <TR> <TH>Char</TH> <TH>Condition</TH> @@ -566,10 +450,29 @@ test. Table 3 shows the available test conditions.</P> </TR> </TABLE></DIV> -<H3><A NAME="CGI">CGI Programs</A></H3> +<H4 ID="LOCTMPL">What to Localize in a Template File</H4> + +<P>Because HTML contains both markup (that generally is not localized) and text (which <em>is</em> localized), you should carefully avoid changing the markup unless it contains human-readable text. The following HTML examples show how to correctly localize template files:</P> + +<P CLASS="command"> +<!-- English table heading --><br> +<table class="list" summary="Printer List"><br> +<br> +<!-- Correctly localized to French; the class attribute is unchanged but summary is localized --><br> +<table class="list" summary="Liste des imprimantes"><br> +<br> +<br> +<!-- English hyperlink --><br> +<li><a {SECTION=help?class="active" :}href="/help/">Help</a></li><br> +<br> +<!-- Correctly localized to Danish; the href attribute is unchanged while the link text is localized --><br> +<li><a {SECTION=help?class="active" :}href="/help/">Hjælp</a></li><br> +</P> -<P>CUPS uses five CGI programs to manage the dynamic web -interfaces:</P> + +<H3 ID="CGI">CGI Programs</H3> + +<P>CUPS uses five CGI programs to manage the dynamic web interfaces:</P> <UL> @@ -581,21 +484,12 @@ interfaces:</P> </UL> -<P>Each CGI program accepts standard form variables such as -<CODE>OP</CODE> for the operation to perform, -<CODE>PRINTER_NAME</CODE> for the printer or class name to -operate on, <CODE>QUERY</CODE> for any search words, -<CODE>FIRST</CODE> for the first class, job, or printer to -display, and <CODE>ORDER</CODE> to control the order that -classes, jobs, or printers are displayed.</P> - -<P>In addition, the <CODE>classes.cgi</CODE>, -<CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE> programs -support a <CODE>WHICH_JOBS</CODE> variable to control which jobs -are displayed. Table 4 lists the supported values.</P> - -<DIV CLASS="table"><TABLE SUMMARY="WHICH_JOBS Values"> -<CAPTION>Table 4: WHICH_JOBS Values</CAPTION> +<P>Each CGI program accepts standard form variables such as <CODE>OP</CODE> for the operation to perform, <CODE>PRINTER_NAME</CODE> for the printer or class name to operate on, <CODE>QUERY</CODE> for any search words,<CODE>FIRST</CODE> for the first class, job, or printer to display, and <CODE>ORDER</CODE> to control the order that classes, jobs, or printers are displayed.</P> + +<P>In addition, the <CODE>classes.cgi</CODE>, <CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE> programs support a <CODE>WHICH_JOBS</CODE> variable to control which jobs are displayed. <A HREF="#table3">Table 3</A> lists the supported values.</P> + +<DIV CLASS="table"><TABLE ID="table3" SUMMARY="WHICH_JOBS Values"> +<CAPTION>Table 3: WHICH_JOBS Values</CAPTION> <THEAD> <TR> <TH>WHICH_JOBS Value</TH> @@ -616,17 +510,12 @@ are displayed. Table 4 lists the supported values.</P> </TR> </TABLE></DIV> -<H4><A NAME="admin.cgi">admin.cgi</A></H4> +<H4 ID="admin.cgi">admin.cgi</H4> -<P>The <CODE>admin.cgi</CODE> program handles all of the printer -and class administration functions and is run for all direct -accesses to the <VAR>/admin</VAR> resource. For most operations -it uses the <CODE>PRINTER_NAME</CODE> and <CODE>OP</CODE> form -variables to specify the action requested. Table 5 shows the -supported <CODE>OP</CODE> values.</P> +<P>The <CODE>admin.cgi</CODE> program handles all of the printer and class administration functions and is run for all direct accesses to the <VAR>/admin</VAR> resource. For most operations it uses the <CODE>PRINTER_NAME</CODE> and <CODE>OP</CODE> form variables to specify the action requested. <A HREF="#table4">Table 4</A> shows the supported <CODE>OP</CODE> values.</P> -<DIV CLASS="table"><TABLE SUMMARY="admin.cgi OP Values"> -<CAPTION>Table 5: admin.cgi OP Values</CAPTION> +<DIV CLASS="table"><TABLE ID="table4" SUMMARY="admin.cgi OP Values"> +<CAPTION>Table 4: admin.cgi OP Values</CAPTION> <THEAD> <TR> <TH>OP Value</TH> @@ -635,10 +524,6 @@ supported <CODE>OP</CODE> values.</P> </THEAD> <TBODY> <TR> - <TD>accept-jobs</TD> - <TD>Accepts jobs on the named destination.</TD> -</TR> -<TR> <TD>add-class</TD> <TD>Adds a new printer class.</TD> </TR> @@ -661,10 +546,6 @@ supported <CODE>OP</CODE> values.</P> may be set to any value to bypass the confirmation page.</TD> </TR> <TR> - <TD>export-samba</TD> - <TD>Exports printers to Samba.</TD> -</TR> -<TR> <TD>find-new-printers</TD> <TD>Find new printers that have not yet been added.</TD> </TR> @@ -677,19 +558,11 @@ supported <CODE>OP</CODE> values.</P> <TD>Modifies a printer.</TD> </TR> <TR> - <TD>purge-jobs</TD> - <TD>Purges all jobs on the named destination.</TD> -</TR> -<TR> <TD>redirect</TD> <TD>Redirects the web browser to the location referenced by the URL form variable.</TD> </TR> <TR> - <TD>reject-jobs</TD> - <TD>Rejects new jobs on the named destination.</TD> -</TR> -<TR> <TD>set-allowed-users</TD> <TD>Sets the allowed users for a destination.</TD> </TR> @@ -705,38 +578,15 @@ supported <CODE>OP</CODE> values.</P> <TD>set-sharing</TD> <TD>Sets the printer-is-shared attribute for a destination.</TD> </TR> -<TR> - <TD>start-class</TD> - <TD>Starts the named class.</TD> -</TR> -<TR> - <TD>start-printer</TD> - <TD>Starts the named printer.</TD> -</TR> -<TR> - <TD>stop-class</TD> - <TD>Stops the named class.</TD> -</TR> -<TR> - <TD>stop-printer</TD> - <TD>Stops the named printer.</TD> -</TR> </TBODY> </TABLE></DIV> -<H4><A NAME="classes.cgi">classes.cgi</A></H4> +<H4 ID="classes.cgi">classes.cgi</H4> -<P>The <CODE>classes.cgi</CODE> program is responsible for -listing class information, including jobs destined for that -class. It is for all direct accesses to the <VAR>/classes</VAR> -resource and supports the optional form variables <CODE>OP</CODE> -and <CODE>WHICH_JOBS</CODE>. If no form variables are supplied -then the CGI lists all or a specific class and the active jobs on -each class. Table 6 shows the supported <CODE>OP</CODE> -values.</P> +<P>The <CODE>classes.cgi</CODE> program is responsible for listing class information, including jobs destined for that class. It is for all direct accesses to the <VAR>/classes</VAR> resource and supports the optional form variables <CODE>OP</CODE> and <CODE>WHICH_JOBS</CODE>. If no form variables are supplied then the CGI lists all or a specific class and the active jobs on each class. <A HREF="#table5">Table 5</A> shows the supported <CODE>OP</CODE> values.</P> -<DIV CLASS="table"><TABLE SUMMARY="classes.cgi OP Values"> -<CAPTION>Table 6: classes.cgi OP Values</CAPTION> +<DIV CLASS="table"><TABLE ID="table5" SUMMARY="classes.cgi OP Values"> +<CAPTION>Table 5: classes.cgi OP Values</CAPTION> <THEAD> <TR> <TH>OP Value</TH> @@ -745,35 +595,48 @@ values.</P> </THEAD> <TBODY> <TR> + <TD>accept-jobs</TD> + <TD>Start accepting jobs for a class.</TD> +</TR> +<TR> + <TD>cancel-jobs</TD> + <TD>Cancel all jobs for a class.</TD> +</TR> +<TR> <TD>move-jobs</TD> - <TD>Moves the jobs on this class to another destination.</TD> + <TD>Move all jobs to a different destination.</TD> </TR> <TR> <TD>print-test-page</TD> - <TD>Prints the standard PostScript test page.</TD> + <TD>Print a PostScript test page.</TD> +</TR> +<TR> + <TD>reject-jobs</TD> + <TD>Stop accepting jobs for a class.</TD> +</TR> +<TR> + <TD>start-class</TD> + <TD>Start processing jobs for a class.</TD> +</TR> +<TR> + <TD>stop-class</TD> + <TD>Stop processing jobs for a class.</TD> </TR> </TBODY> </TABLE></DIV> -<H4><A NAME="help.cgi">help.cgi</A></H4> +<H4 ID="help.cgi">help.cgi</H4> -<P>The <CODE>help.cgi</CODE> program handles all of the on-line -help functions and is run for all direct accesses to the -<VAR>/help</VAR> resource.</P> +<P>The <CODE>help.cgi</CODE> program handles all of the on-line help functions and is run for all direct accesses to the <VAR>/help</VAR> resource.</P> -<H4><A NAME="jobs.cgi">jobs.cgi</A></H4> +<H4 ID="jobs.cgi">jobs.cgi</H4> -<P>The <CODE>jobs.cgi</CODE> program handles all of the job -functions and is run for all direct accesses to the -<VAR>/jobs</VAR> resource. For most operations it uses the -<CODE>JOB_ID</CODE>, <CODE>OP</CODE>, and <CODE>WHICH_JOBS</CODE> -form variables to specify the action requested. Table 7 shows the -supported <CODE>OP</CODE> values.</P> +<P>The <CODE>jobs.cgi</CODE> program handles all of the job functions and is run for all direct accesses to the <VAR>/jobs</VAR> resource. For most operations it uses the <CODE>JOB_ID</CODE>, <CODE>OP</CODE>, and <CODE>WHICH_JOBS</CODE> form variables to specify the action requested. <A HREF="#table6">Table 6</A> shows the supported <CODE>OP</CODE> values.</P> -<DIV CLASS="table"><TABLE SUMMARY="jobs.cgi OP Values"> -<CAPTION>Table 7: jobs.cgi OP Values</CAPTION> +<DIV CLASS="table"><TABLE ID="table6" SUMMARY="jobs.cgi OP Values"> +<CAPTION>Table 6: jobs.cgi OP Values</CAPTION> <THEAD> <TR> <TH>OP Value</TH> @@ -806,19 +669,12 @@ supported <CODE>OP</CODE> values.</P> </TABLE></DIV> -<H4><A NAME="printers.cgi">printers.cgi</A></H4> +<H4 ID="printers.cgi">printers.cgi</H4> -<P>The <CODE>printers.cgi</CODE> program is responsible for -listing printer information, including jobs destined for that -printer. It is for all direct accesses to the -<VAR>/printers</VAR> resource and supports the optional form -variables <CODE>OP</CODE> and <CODE>WHICH_JOBS</CODE>. If no form -variables are supplied then the CGI lists all printers or a -specific printer and the active jobs on that printer. Table 8 -shows the supported <CODE>OP</CODE> values.</P> +<P>The <CODE>printers.cgi</CODE> program is responsible for listing printer information, including jobs destined for that printer. It is for all direct accesses to the <VAR>/printers</VAR> resource and supports the optional form variables <CODE>OP</CODE> and <CODE>WHICH_JOBS</CODE>. If no form variables are supplied then the CGI lists all printers or a specific printer and the active jobs on that printer. <A HREF="#table7">Table 7</A> shows the supported <CODE>OP</CODE> values.</P> -<DIV CLASS="table"><TABLE SUMMARY="printers.cgi OP Values"> -<CAPTION>Table 8: printers.cgi OP Values</CAPTION> +<DIV CLASS="table"><TABLE ID="table7" SUMMARY="printers.cgi OP Values"> +<CAPTION>Table 7: printers.cgi OP Values</CAPTION> <THEAD> <TR> <TH>OP Value</TH> @@ -827,6 +683,14 @@ shows the supported <CODE>OP</CODE> values.</P> </THEAD> <TBODY> <TR> + <TD>accept-jobs</TD> + <TD>Start accepting jobs for a printer.</TD> +</TR> +<TR> + <TD>cancel-jobs</TD> + <TD>Cancel all jobs for a printer.</TD> +</TR> +<TR> <TD>clean-print-heads</TD> <TD>Clean the print heads.</TD> </TR> @@ -842,5 +706,20 @@ shows the supported <CODE>OP</CODE> values.</P> <TD>print-test-page</TD> <TD>Print a PostScript test page.</TD> </TR> +<TR> + <TD>reject-jobs</TD> + <TD>Stop accepting jobs for a printer.</TD> +</TR> +<TR> + <TD>start-printer</TD> + <TD>Start processing jobs for a printer.</TD> +</TR> +<TR> + <TD>stop-printer</TD> + <TD>Stop processing jobs for a printer.</TD> +</TR> </TBODY> </TABLE></DIV> + +</BODY> +</HTML> diff --git a/documentation.html b/documentation.html index 5407fcdca..8fc0a1f8c 100644 --- a/documentation.html +++ b/documentation.html @@ -52,6 +52,8 @@ layout: default <div class="col-md-2"><a href="doc/man-cupsfilter.html">cupsfilter(8)</a></div> <div class="col-md-2"><a href="doc/man-cupstestppd.html">cupstestppd(1)</a></div> <div class="col-md-2"><a href="doc/man-filter.html">filter(7)</a></div> + <div class="col-md-2"><a href="doc/man-ippeveprinter.html">ippeveprinter(1)</a></div> + <div class="col-md-2"><a href="doc/man-ippevepcl.html">ippevepcl/ps(7)</a></div> <div class="col-md-2"><a href="doc/man-ippfind.html">ippfind(1)</a></div> <div class="col-md-2"><a href="doc/man-ipptool.html">ipptool(1)</a></div> <div class="col-md-2"><a href="doc/man-ipptoolfile.html">ipptoolfile(5)</a></div> |