| <HTML> |
| <HEAD> |
| <META NAME="COPYRIGHT" CONTENT="Copyright 1997-2003 All Rights Reserved"> |
| <META NAME="DOCNUMBER" CONTENT="CUPS-IPP-1.2"> |
| <META NAME="Author" CONTENT="Easy Software Products"> |
| <TITLE>CUPS Implementation of IPP</TITLE> |
| </HEAD> |
| <BODY> |
| |
| <H1>Scope</H1> |
| |
| <H2>Identification</H2> |
| |
| <P>This document provides an overview of the Internet Printing Protocol |
| ("IPP") version 1.1 as implemented in the Common UNIX Printing System |
| ("CUPS") version 1.2. |
| |
| <EMBED SRC="system-overview.shtml"> |
| |
| <H2>Document Overview</H2> |
| |
| <P>This document is organized into the following sections: |
| |
| <UL> |
| <LI><A HREF="#1">1 - Scope</A> |
| <LI><A HREF="#2">2 - References</A> |
| <LI><A HREF="#3">3 - Overview</A> |
| <LI><A HREF="#4">4 - Operations</A> |
| <LI><A HREF="#5">5 - Attributes</A> |
| <LI><A HREF="#6">A - Glossary</A> |
| </UL> |
| |
| <EMBED SRC="references.shtml"> |
| |
| <H1>Overview</H1> |
| |
| <P>CUPS 1.1 implements IPP/1.1 and the operations and attributes |
| defined in the "IPP: Job and Printer Set Operations", |
| "IPP/1.1: Output-bin Attribute Extension", and "IPP/1.1: finishings |
| 'fold',' trim', and 'bale' attribute values extension" specifications. |
| |
| <P>CUPS also provides 13 new operations and many new attributes to |
| support multiple IPP printers and printer classes on a single host. |
| |
| <H2>IPP URIs</H2> |
| |
| <P>CUPS supports both the "http" and "ipp" methods. The following |
| resource names are used: |
| |
| <DL> |
| |
| <DT>method://hostname:port/ |
| |
| <DD>Can be used for all "get" operations. |
| |
| <DT>method://hostname:port/admin |
| |
| <DD>Used for all administrative operations. |
| |
| <DT>method://hostname:port/classes/name |
| |
| <DD>Specifies a printer class. |
| |
| <DT>method://hostname:port/jobs/id |
| |
| <DD>Specifies a job. |
| |
| <DT>method://hostname:port/printers/name |
| |
| <DD>Specifies a printer. |
| |
| </DL> |
| |
| <P>So a typical printer URI would be "ipp://foo.bar.com/printers/LaserJet". |
| |
| <P>In addition, the CUPS server also supports normal browser access to |
| "method://hostname:port/admin/", "method://hostname:port/classes/", |
| "method://hostname:port/jobs/", and "method://hostname:port/printers/" |
| to view and manage resources on the server dynamically. |
| |
| <H2>CUPS IPP Operations</H2> |
| |
| <P>CUPS provides 13 extension operations in addition to most of the |
| standard IPP and registered extension operations: |
| |
| <CENTER><TABLE BORDER WIDTH="80%"> |
| <TR> |
| <TH VALIGN="TOP">Operation Name</TH> |
| <TH VALIGN="TOP">CUPS</TH> |
| <TH VALIGN="TOP">Code</TH> |
| <TH VALIGN="TOP">Brief Description</TH> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Print-Job</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0002</TD> |
| <TD VALIGN="TOP">Print a file.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Validate-Job</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0004</TD> |
| <TD VALIGN="TOP">Validate job attributes.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Create-Job</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x0005</TD> |
| <TD VALIGN="TOP">Create a print job.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Send-Document</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x0006</TD> |
| <TD VALIGN="TOP">Send a file for a print job.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Cancel-Job</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0008</TD> |
| <TD VALIGN="TOP">Cancel a print job.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Get-Job-Attributes</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0009</TD> |
| <TD VALIGN="TOP">Get job attributes.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Get-Jobs</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x000A</TD> |
| <TD VALIGN="TOP">Get all jobs.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Get-Printer-Attributes</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x000B</TD> |
| <TD VALIGN="TOP">Get printer attributes.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Hold-Job</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x000C</TD> |
| <TD VALIGN="TOP">Hold a job for printing.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Release-Job</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x000D</TD> |
| <TD VALIGN="TOP">Release a job for printing.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Pause-Printer</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0010</TD> |
| <TD VALIGN="TOP">Pause printing on a printer.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Resume-Printer</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0011</TD> |
| <TD VALIGN="TOP">Resume printing on a printer.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Purge-Jobs</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x0012</TD> |
| <TD VALIGN="TOP">Purge all jobs.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">Set-Job-Attributes</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x0014</TD> |
| <TD VALIGN="TOP">Set attributes for a pending or held job.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Get-Default</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4001</TD> |
| <TD VALIGN="TOP">Get the default destination.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Get-Printers</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4002</TD> |
| <TD VALIGN="TOP">Get all of the available printers.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Add-Modify-Printer</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4003</TD> |
| <TD VALIGN="TOP">Add or modify a printer.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Delete-Printer</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4004</TD> |
| <TD VALIGN="TOP">Delete a printer.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Get-Classes</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4005</TD> |
| <TD VALIGN="TOP">Get all of the available printer classes.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Add-Modify-Class</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4006</TD> |
| <TD VALIGN="TOP">Add or modify a printer class.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Delete-Class</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4007</TD> |
| <TD VALIGN="TOP">Delete a printer class.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Accept-Jobs</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4008</TD> |
| <TD VALIGN="TOP">Accept jobs on a printer or printer class.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Reject-Jobs</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x4009</TD> |
| <TD VALIGN="TOP">Reject jobs on a printer or printer class.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Set-Default</TD> |
| <TD VALIGN="TOP">1.0</TD> |
| <TD VALIGN="TOP">0x400A</TD> |
| <TD VALIGN="TOP">Set the default destination.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Get-Devices</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x400B</TD> |
| <TD VALIGN="TOP">Get all of the available devices.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Get-PPDs</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x400C</TD> |
| <TD VALIGN="TOP">Get all of the available PPDs.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">CUPS-Move-Job</TD> |
| <TD VALIGN="TOP">1.2</TD> |
| <TD VALIGN="TOP">0x400D</TD> |
| <TD VALIGN="TOP">Move a job to a different printer.</TD> |
| </TR> |
| </TABLE> |
| </CENTER> |
| |
| <H1>Operations</H1> |
| |
| <P>The following sections describe the operations supported by CUPS. |
| In the interest of brevity, operations which use only the standard |
| IPP attributes are not described. |
| |
| <H2>Print-Job Operation</H2> |
| |
| <P>The Print-Job operation (0x0002) prints a file. |
| |
| <H3>Print-Job Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| Print-Job request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer. |
| |
| </UL> |
| |
| <P>Group 2: Job Template Attributes |
| |
| <UL> |
| |
| <P>"job-billing" (text(MAX)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a billing string that is logged |
| with the page accounting information. |
| |
| <P>"job-sheets" (1setof type3 keyword | name(MAX)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies one or two banner pages that |
| are printed before and after any files in the print job. The |
| name of "none" is reserved to indicate that no banner page |
| should be printed. If the client does not specify this |
| attribute then the value of the "job-sheets-default" printer |
| object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| job-sheets attribute value. |
| |
| <P>"media" (1setof type3 keyword | name(MAX)): |
| |
| <P>The client OPTIONALLY supplies one or more media attributes |
| specifying the size, type, source, and color of the output |
| media. If the client does not specify this attribute then the |
| value of the "media-default" printer object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| media attribute value. |
| |
| <P>Other Job Template Attributes |
| |
| </UL> |
| |
| <P>The Print-Job request is followed by a file to be printed. |
| |
| <H3>Print-Job Response</H3> |
| |
| <P>The following groups of attributes are send as part of the Print-Job |
| Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Job Attributes |
| |
| <UL> |
| |
| <P>Standard Job Attributes |
| |
| </UL> |
| |
| <H2>Create-Job Operation</H2> |
| |
| <P>The Create-Job operation (0x0005) creates a new, empty print job. |
| |
| <H3>Create-Job Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| Create-Job request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer. |
| |
| </UL> |
| |
| <P>Group 2: Job Template Attributes |
| |
| <UL> |
| |
| <P>"job-billing" (text(MAX)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a billing string that is logged |
| with the page accounting information. |
| |
| <P>"job-sheets" (1setof type3 keyword | name(MAX)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies one or two banner pages that |
| are printed before and after any files in the print job. The |
| name of "none" is reserved to indicate that no banner page |
| should be printed. If the client does not specify this |
| attribute then the value of the "job-sheets-default" printer |
| object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| job-sheets attribute value. |
| |
| <P>"media" (1setof type3 keyword | name(MAX)): |
| |
| <P>The client OPTIONALLY supplies one or more media attributes |
| specifying the size, type, source, and color of the output |
| media. If the client does not specify this attribute then the |
| value of the "media-default" printer object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| media attribute value. |
| |
| <P>Standard Job Template Attributes |
| |
| </UL> |
| |
| <H3>Create-Job Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| Create-Job Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Job Attributes |
| |
| <UL> |
| |
| <P>Standard Job Attributes |
| |
| </UL> |
| |
| <H2>Set-Job-Attributes Operation</H2> |
| |
| <P>The Set-Job-Attributes operation (0x0014) changes the attributes of |
| an active (not completed) job. |
| |
| <H3>Set-Job-Attributes Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| Set-Job-Attributes request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri) and "job-id" (integer) |
| <P><I>OR</I> |
| <P>"job-uri": |
| |
| <P>The client MUST supply a URI for the specified printer and |
| a job ID number, or the job URI. |
| |
| </UL> |
| |
| <P>Group 2: Job Template Attributes |
| |
| <UL> |
| |
| <P>"job-sheets" (1setof type3 keyword | name(MAX)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies one or two banner pages that |
| are printed before and after any files in the print job. The |
| name of "none" is reserved to indicate that no banner page |
| should be printed. If the client does not specify this |
| attribute then the value of the "job-sheets-default" printer |
| object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| job-sheets attribute value. |
| |
| <P>"media" (1setof type3 keyword | name(MAX)): |
| |
| <P>The client OPTIONALLY supplies one or more media attributes |
| specifying the size, type, source, and color of the output |
| media. If the client does not specify this attribute then the |
| value of the "media-default" printer object attribute is used. |
| |
| <P><B>Note:</B> Standard IPP only allows specification of a single |
| media attribute value. |
| |
| <P>Other Job Template Attributes |
| |
| </UL> |
| |
| <H3>Set-Job-Attributes Response</H3> |
| |
| <P>The following groups of attributes are send as part of the Set-Job-Attributes |
| Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Get-Default Operation</H2> |
| |
| <P>The CUPS-Get-Default operation (0x4001) returns the default printer |
| URI and attributes. |
| |
| <H3>CUPS-Get-Default Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Get-Default request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"requested-attributes" (1setOf keyword) : |
| |
| <P>The client OPTIONALLY supplies a set of attribute names |
| and/or attribute group names in whose values the requester is |
| interested. If the client omits this attribute, the server |
| responds as if this attribute had been supplied with a value of |
| 'all'. |
| |
| </UL> |
| |
| <H3>CUPS-Get-Default Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Get-Default Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Printer Object Attributes |
| |
| <UL> |
| |
| <P>The set of requested attributes and their current values. |
| |
| </UL> |
| |
| <H2>CUPS-Get-Printers Operation</H2> |
| |
| <P>The CUPS-Get-Printers operation (0x4002) returns the printer |
| attributes for every printer known to the system. This may include |
| printers that are not served directly by the server. |
| |
| <H3>CUPS-Get-Printers Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Get-Printers request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"limit" (integer (1:MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute limiting the |
| number of printers that are returned. |
| |
| <P>"printer-info" (text(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies this attribute to |
| select which printers are returned. |
| |
| <P>"printer-location" (text(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies this attribute to |
| select which printers are returned. |
| |
| <P>"printer-type" (type2 enum): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a printer type enumeration to |
| select which printers are returned. |
| |
| <P>"printer-type-mask" (type2 enum): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a printer type mask |
| enumeration to select which bits are used in the "printer-type" |
| attribute. |
| |
| <P>"requested-attributes" (1setOf keyword) : |
| |
| <P>The client OPTIONALLY supplies a set of attribute names |
| and/or attribute group names in whose values the requester is |
| interested. If the client omits this attribute, the server |
| responds as if this attribute had been supplied with a value of |
| 'all'. |
| |
| </UL> |
| |
| <H3>CUPS-Get-Printers Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Get-Printers Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Printer Object Attributes |
| |
| <UL> |
| |
| <P>The set of requested attributes and their current values for |
| each printer. |
| |
| </UL> |
| |
| <H2>CUPS-Add-Modify-Printer Operation</H2> |
| |
| <P>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or |
| modifies an existing printer on the system. |
| |
| <H3>CUPS-Add-Modify-Printer Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Add-Modify-Printer request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer. |
| |
| </UL> |
| |
| <P>Group 2: Printer Object Attributes |
| |
| <UL> |
| |
| <P>"banner-end-default" (name(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a banner page name that is |
| printed after files in a job. The reserved name "none" is used to |
| specify that no banner page should be printed. |
| |
| <P>"banner-start-default" (name(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a banner page name that is |
| printed before files in a job. The reserved name "none" is used to |
| specify that no banner page should be printed. |
| |
| <P>"device-uri" (uri): |
| |
| <P>The client OPTIONALLY supplies a device URI for the |
| specified printer. |
| |
| <P>"ppd-name" (name(127)): |
| |
| <P>The client OPTIONALLY supplies a PPD name for the specified |
| printer. |
| |
| <P>"printer-is-accepting-jobs" (boolean): |
| |
| <P>The client OPTIONALLY supplies this boolean attribute |
| indicating whether or not the printer object should accept new jobs. |
| |
| <P>"printer-info" (text(127)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating the |
| printer information string. |
| |
| <P>"printer-location" (text(127)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| textual location of the printer. |
| |
| <P>"printer-more-info" (uri): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| URI for additional printer information. |
| |
| <P>"printer-state" (type2 enum): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating the |
| initial/current state of the printer. Only the "idle" and "stopped" |
| enumerations are recognized. |
| |
| <P>"printer-state-message" (text(MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| textual reason for the current printer state. |
| |
| <P>"requesting-user-name-allowed" (1setof name(127) | delete) |
| <P><I>OR</I> |
| <P>"requesting-user-name-denied" (1setof name(127) | delete): |
| |
| <P>The client OPTIONALLY supplies one of these attributes to |
| specify an access control list for incoming print jobs. To allow |
| all users access to a printer, use the delete tag for the |
| attribute value. |
| |
| </UL> |
| |
| <P>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD |
| file or System V interface script to be used for the printer. The |
| "ppd-name" attribute overrides any file that is attached to the end of |
| the request with a local CUPS PPD file. |
| |
| <H3>CUPS-Add-Modify-Printer Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Add-Modify-Printer Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Delete-Printer Operation</H2> |
| |
| <P>The CUPS-Delete-Printer operation (0x4004) removes an existing |
| printer from the system. |
| |
| <H3>CUPS-Delete-Printer Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Delete-Printer request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer. |
| |
| </UL> |
| |
| <H3>CUPS-Delete-Printer Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Delete-Printer Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Get-Classes Operation</H2> |
| |
| <P>The CUPS-Get-Classes operation (0x4005) returns the printer |
| attributes for every printer class known to the system. This may |
| include printer classes that are not served directly by the server. |
| |
| <H3>CUPS-Get-Classes Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Get-Classes request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"limit" (integer (1:MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute limiting the |
| number of printer classes that are returned. |
| |
| <P>"printer-info" (text(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies this attribute to |
| select which printer classes are returned. |
| |
| <P>"printer-location" (text(127)): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies this attribute to |
| select which printer classes are returned. |
| |
| <P>"printer-type" (type2 enum): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a printer type enumeration to |
| select which printer classes are returned. |
| |
| <P>"printer-type-mask" (type2 enum): |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The client OPTIONALLY supplies a printer type mask |
| enumeration to select which bits are used in the "printer-type" |
| attribute. |
| |
| <P>"requested-attributes" (1setOf keyword) : |
| |
| <P>The client OPTIONALLY supplies a set of attribute names |
| and/or attribute group names in whose values the requester is |
| interested. If the client omits this attribute, the server responds as |
| if this attribute had been supplied with a value of 'all'. |
| |
| </UL> |
| |
| <H3>CUPS-Get-Classes Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Get-Classes Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Printer Class Object Attributes |
| |
| <UL> |
| |
| <P>The set of requested attributes and their current values for |
| each printer class. |
| |
| </UL> |
| |
| <H2>CUPS-Add-Modify-Class Operation</H2> |
| |
| <P>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or |
| modifies and existing printer class on the system. |
| |
| <H3>CUPS-Add-Modify-Class Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Add-Modify-Class request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer class. |
| |
| </UL> |
| |
| <P>Group 2: Printer Object Attributes |
| |
| <UL> |
| |
| <P>"member-uris" (1setof uri): |
| |
| <P>The client OPTIONALLY supplies the "member-uris" set |
| specifying the printers and printer classes that are part of the class. |
| |
| <P>"printer-is-accepting-jobs" (boolean): |
| |
| <P>The client OPTIONALLY supplies this boolean attribute |
| indicating whether or not the class object should accept new jobs. |
| |
| <P>"printer-info" (text(127)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating the |
| printer information string. |
| |
| <P>"printer-location" (text(127)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| textual location of the class. |
| |
| <P>"printer-more-info" (uri): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| URI for additional class information. |
| |
| <P>"printer-state" (type2 enum): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating the |
| initial/current state of the class. Only the "idle" and "stopped" |
| enumerations are recognized. |
| |
| <P>"printer-state-message" (text(MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| textual reason for the current class state. |
| |
| <P>"requesting-user-name-allowed" (1setof name(127)) |
| <P><I>OR</I> |
| <P>"requesting-user-name-denied" (1setof name(127)): |
| |
| <P>The client OPTIONALLY supplies one of these attributes to |
| specify an access control list for incoming print jobs. To allow |
| all users access to a class, use the delete tag for the |
| attribute value. |
| |
| </UL> |
| |
| <H3>CUPS-Add-Modify-Class Response</H3> |
| |
| <P>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Delete-Class Operation</H2> |
| |
| <P>The CUPS-Delete-Class operation (0x4007) removes an existing printer |
| class from the system. |
| |
| <H3>CUPS-Delete-Class Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Delete-Class request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer class. |
| |
| </UL> |
| |
| <H3>CUPS-Delete-Class Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Delete-Class Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Accept-Jobs Operation</H2> |
| |
| <P>The CUPS-Accept-Jobs operation (0x4008) sets the |
| "printer-is-accepting-jobs" attribute to true for the specified printer |
| or printer class. |
| |
| <H3>CUPS-Accept-Jobs Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Accept-Jobs request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer or printer class. |
| |
| </UL> |
| |
| <H3>CUPS-Accept-Jobs Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Accept-Jobs Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Reject-Jobs Operation</H2> |
| |
| <P>The CUPS-Reject-Jobs operation (0x4009) sets |
| the"printer-is-accepting-jobs" attribute to false for the specified |
| printer or printer class. |
| |
| <H3>CUPS-Reject-Jobs Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Reject-Jobs request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer or printer class. |
| |
| </UL> |
| |
| <P>Group 2: Printer Object Attributes |
| |
| <UL> |
| |
| <P>"printer-state-message" (text(MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute indicating a |
| textual reason for the current printer state. |
| |
| </UL> |
| |
| <H3>CUPS-Reject-Jobs Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Reject-Jobs Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Set-Default Operation</H2> |
| |
| <P>The CUPS-Set-Default operation (0x400A) sets the default printer |
| destination for all clients when a resource name of "/printers" is |
| specified. |
| |
| <H3>CUPS-Set-Default Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Set-Default request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri): |
| |
| <P>The client MUST supply a URI for the specified printer or |
| printer class. |
| |
| </UL> |
| |
| <H3>CUPS-Set-Default Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Set-Default Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H2>CUPS-Get-Devices Operation</H2> |
| |
| <P>The CUPS-Get-Devices operation (0x400B) returns all of the supported |
| device-uri's for the server (CUPS 1.1 and higher). |
| |
| <H3>CUPS-Get-Devices Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Get-Devices request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"device-class" (type1 keyword): |
| |
| <P>The client OPTIONALLY supplies a device class keyword to select |
| which devices are returned. |
| |
| <P>"limit" (integer (1:MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute limiting the number of |
| devices that are returned. |
| |
| <P>"requested-attributes" (1setOf keyword) : |
| |
| <P>The client OPTIONALLY supplies a set of attribute names and/or |
| attribute group names in whose values the requester is interested. If |
| the client omits this attribute, the server responds as if this |
| attribute had been supplied with a value of 'all'. |
| |
| </UL> |
| |
| <H3>CUPS-Get-Devices Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Get-Devices Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: Device Object Attributes |
| |
| <UL> |
| |
| <P>The set of requested attributes and their current values for |
| each device. |
| |
| </UL> |
| |
| <H2>CUPS-Get-PPDs Operation</H2> |
| |
| <P>The CUPS-Get-PPDs operation (0x400C) returns all of the locally |
| available PPD files on the system (CUPS 1.1 and higher). |
| |
| <H3>CUPS-Get-PPDs Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Get-PPDs request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"limit" (integer (1:MAX)): |
| |
| <P>The client OPTIONALLY supplies this attribute limiting the number of |
| PPDs that are returned. |
| |
| <P>"ppd-make" (text(127)): |
| |
| <P>The client OPTIONALLY supplies a printer manufacturer to select |
| which PPDs are returned. |
| |
| <P>"requested-attributes" (1setOf keyword) : |
| |
| <P>The client OPTIONALLY supplies a set of attribute names and/or |
| attribute group names in whose values the requester is interested. If |
| the client omits this attribute, the server responds as if this |
| attribute had been supplied with a value of 'all'. |
| |
| </UL> |
| |
| <H3>CUPS-Get-PPDs Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Get-PPDs Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <P>Group 2: PPD Attributes |
| |
| <UL> |
| |
| <P>The set of requested attributes and their current values for each |
| PPD file. |
| |
| </UL> |
| |
| <H2>CUPS-Move-Job Operation</H2> |
| |
| <P>The CUPS-Move-Job operation (0x400D) moves an active print job to a |
| different printer (CUPS 1.1 and higher). |
| |
| <H3>CUPS-Move-Job Request</H3> |
| |
| <P>The following groups of attributes are supplied as part of the |
| CUPS-Move-Job request: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.1 of the IPP Model and |
| Semantics document. |
| |
| <P>"printer-uri" (uri) and "job-id" (integer) |
| <P><I>OR</I> |
| <P>"job-uri": |
| |
| <P>The client MUST supply a URI for the specified printer and |
| a job ID number, or the job URI. |
| |
| </UL> |
| |
| <P>Group 2: Job Template Attributes |
| |
| <UL> |
| |
| <P>"job-printer-uri" (uri) |
| |
| <P>The client MUST supply a URI for a printer on the same server. |
| |
| </UL> |
| |
| <H3>CUPS-Move-Job Response</H3> |
| |
| <P>The following groups of attributes are send as part of the |
| CUPS-Move-Job Response: |
| |
| <P>Group 1: Operation Attributes |
| |
| <UL> |
| |
| <P>Status Message: |
| |
| <P>The standard response status message. |
| |
| <P>Natural Language and Character Set: |
| |
| <P>The "attributes-charset" and "attributes-natural-language" |
| attributes as described in section 3.1.4.2 of the IPP Model and |
| Semantics document. |
| |
| </UL> |
| |
| <H1>Attributes</H1> |
| |
| <P>CUPS provides many extension attributes to support multiple devices, |
| PPD files, standard job filters, printers, and printer classes. |
| |
| <H2>Device Attributes</H2> |
| |
| <P>Device attributes are returned by the CUPS-Get-Devices operation and |
| enumerate all of the available hardware devices and network protocols |
| that are supported by the server. |
| |
| <H3>device-class (type2 keyword)</H3> |
| |
| <P>The device-class attribute specifies the class of device and can be |
| one of the following: |
| |
| <UL> |
| |
| <LI>"file" - a disk file. |
| |
| <LI>"direct" - a parallel or fixed-rate serial data port, |
| currently used for Centronics, IEEE-1284, and USB printer |
| ports. |
| |
| <LI>"serial" - a variable-rate serial port. |
| |
| <LI>"network" - a network connection, typically via AppSocket, |
| HTTP, IPP, LPD, or SMB/CIFS protocols. |
| |
| </UL> |
| |
| <H3>device-info (text(127))</H3> |
| |
| <P>The device-info attribute specifies a human-readable string describing |
| the device, e.g. "Parallel Port #1". |
| |
| <H3>device-make-and-model (text(127))</H3> |
| |
| <P>The device-makr-and-model attribute specifies a device |
| identification string provided by the printer connected to the device. |
| If the device or printer does not support identification then this |
| attribute contains the string "unknown". |
| |
| <H3>device-uri (uri)</H3> |
| |
| <P>The device-uri attribute specifies a unique identifier for the |
| device. The actual format of the device-uri string depends on the value |
| of the device-class attribute: |
| |
| <UL> |
| |
| <LI>"file" - The device-uri will be of the form |
| "file:/path/to/filename". |
| |
| <LI>"direct" - The device-uri will be of the form |
| "method:/dev/filename", where method may be "parallel" or "usb" |
| in the current implementation. |
| |
| <LI>"serial" - The device-uri will be of the form |
| "serial:/dev/filename?baud=value+parity=value+flow=value". |
| The baud value is the data rate in bits per second; the |
| supported values depend on the underlying hardware. |
| The parity value can be one of "none", "even", or "odd". |
| The flow value can be one of "none", "soft" (XON/XOFF |
| handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), |
| or "dtrdsr" (DTR/DSR handshaking). |
| |
| <P>The URI returned by CUPS-Get-Devices will contain the |
| maximum baud rate supported by the device and the best |
| type of flow control available ("soft" or "hard"). |
| |
| <LI>"network" - The device-uri will be of the form |
| "method://[username:password@]hostname[:port]/[resource]", |
| where method may be "http", "ipp", "lpd", "smb", or |
| "socket" in the current implementation. |
| |
| <P>The URI returned by CUPS-Get-Devices will only contain |
| the method name followed by two slashes ("method://"). |
| It is up to the client application to add the appropriate |
| host and other information when adding a new printer. |
| |
| <P>The URI returned by Get-Printer-Attributes and |
| CUPS-Get-Printers has any username and password information |
| stripped; the information is still stored and used by the |
| server internally to perform any needed authentication. |
| |
| </UL> |
| |
| <H2>Job Template Attributes</H2> |
| |
| <H3>blackplot (boolean)</H3> |
| |
| <P>The blackplot attribute specifies whether HP-GL/2 plot files should be |
| rendered entirely in black ink (blackplot=true) or using the colors and shades |
| specified in the file (blackplot=false). The default value is false. |
| |
| <H3>brightness (integer(0:200))</H3> |
| |
| <P>The brightness attribute specifies the overall brightness of the printed |
| output in percent. A brightness of 100 is normal, while 200 is twice as |
| bright and 50 is half as bright. The default value is 100. |
| |
| <P>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using |
| the function "f(x) = brightness / 100 * x". |
| |
| <H3>columns (integer(1:4))</H3> |
| |
| <P>The columns attribute specifies the number of columns to generate when |
| printing text files. The default value is 1. |
| |
| <H3>cpi (type2 enum)</H3> |
| |
| <P>The cpi attribute specifies the number of characters per inch when |
| printing text files. Only the values 10, 12, and 17 are currently |
| supported. The default value is 10. |
| |
| <H3>fitplot (boolean)</H3> |
| |
| <P>The fitplot attribute specifies whether to scale HP-GL/2 plot files to |
| fit on the selected media (fitplot=true) or use the physical scale specified |
| in the plot file (fitplot=false). The default value is false. |
| |
| <H3>gamma (integer(1:10000))</H3> |
| |
| <P>The gamma attribute specifies the luminance correction for the output. |
| A value of 1000 specifies no correction, while values of 2000 and 500 will |
| generate lighter and darker output, respectively. The default value is |
| 1000. |
| |
| <P>Gamma is applied to the Red, Green, and Blue values (or luminance for |
| grayscale output) using the function "f(x) = x<SUP>(1000/gamma)</SUP>". |
| |
| <H3>hue (integer(-180:180))</H3> |
| |
| <P>The hue attribute specifies a color hue rotation when printing image |
| files. The default value is 0. |
| |
| <H3>job-billing (text(MAX))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-billing attribute provides a text value to associate with a job |
| for billing purposes. |
| |
| <H3>job-hold-until (keyword | name(MAX))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-hold-until attribute specifies a hold time. In addition to the |
| standard IPP/1.1 keyword names, CUPS supports name values of the form |
| "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in |
| Greenwich Mean Time (GMT) and <I>not</I> in the local time zone. If the |
| specified time is less than the current time, the job is held until the |
| next day. |
| |
| <H3>job-sheets (1setof type3 keyword | name(MAX))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-sheets attribute specifies one or two banner files that are printed |
| before and after a job. The reserved value of "none" disables banner printing. |
| The default value is stored in the job-sheets-default attribute. |
| |
| <P>If only one value is supplied, the banner file is printed before the job. |
| If two values are supplied, the first value is used as the starting banner |
| file and the second as the ending banner file. |
| |
| <H3>job-originating-host-name (name(MAX))</H3> |
| |
| <P><I>(CUPS 1.1.5 and higher)</I> |
| |
| <P>The job-originating-host-name attribute specifies the host |
| from which the job was queued. The value will be the hostname or |
| IP address of the client depending on whether hostname |
| resolution is enabled. The localhost address (127.0.0.1) is |
| <B>always</B> resolved to the name "localhost". |
| |
| <P>This attribute is read-only. |
| |
| <H3>lpi (type2 enum)</H3> |
| |
| <P>The lpi attribute specifies the number of lines per inch when |
| printing text files. Only the values 6 and 8 are currently supported. |
| The default value is 6. |
| |
| <H3>mirror (boolean)</H3> |
| |
| <P>The mirror attribute specifies whether pages are mirrored on |
| their X axis, which is useful for printing transfer images on |
| special media. The default value is false. |
| |
| <H3>natural-scaling (integer(1:1000))</H3> |
| |
| <P><I>(CUPS 1.1.9 and higher)</I> |
| |
| <P>The natural-scaling attribute specifies the scaling of image files with |
| respect to the natural image size. A value of 100 specifies that the image |
| file should exactly the natural size, while 50 is half the natural size |
| and 200 is twice the natural size. The default value is 100. |
| |
| <P>The ppi option can be used to override the natural resolution of the |
| image, which controls the natural size. |
| |
| <H3>number-up-layout (type2 keyword)</H3> |
| |
| <P><I>(CUPS 1.1.15 and higher)</I> |
| |
| <P>The number-up-layout attribute specifies the order each input |
| page is placed on each output page. The following keywords are |
| presently defined: |
| |
| <UL> |
| |
| <LI><CODE>btlr</CODE> - Bottom to top, left to right</LI> |
| |
| <LI><CODE>btrl</CODE> - Bottom to top, right to left</LI> |
| |
| <LI><CODE>lrbt</CODE> - Left to right, bottom to top</LI> |
| |
| <LI><CODE>lrtb</CODE> - Left to right, top to bottom (default)</LI> |
| |
| <LI><CODE>rlbt</CODE> - Right to left, bottom to top</LI> |
| |
| <LI><CODE>rltb</CODE> - Right to left, top to bottom</LI> |
| |
| <LI><CODE>tblr</CODE> - Top to bottom, left to right</LI> |
| |
| <LI><CODE>tbrl</CODE> - Top to bottom, right to left</LI> |
| |
| </UL> |
| |
| <H3>page-border (type2 keyword)</H3> |
| |
| <P><I>(CUPS 1.1.15 and higher)</I> |
| |
| <P>The page-border attribute specifies whether a border is |
| draw around each page. The following keywords are presently |
| defined: |
| |
| <UL> |
| |
| <LI><CODE>double</CODE> - Two hairline borders are drawn</LI> |
| |
| <LI><CODE>double-thick</CODE> - Two 1pt borders are drawn</LI> |
| |
| <LI><CODE>none</CODE> - No border is drawn (default)</LI> |
| |
| <LI><CODE>single</CODE> - A single hairline border is drawn</LI> |
| |
| <LI><CODE>single-thick</CODE> - A single 1pt border is drawn</LI> |
| |
| </UL> |
| |
| <H3>page-bottom (integer(0:MAX))</H3> |
| |
| <P>The page-bottom attribute specifies the bottom margin in points (72 points |
| equals 1 inch). The default value is the device physical margin. |
| |
| <H3>page-label (text(MAX))</H3> |
| |
| <P><I>(CUPS 1.1.7 and higher)</I> |
| |
| <P>The page-label attribute provides a text value to place in |
| the header and footer on each page. If a classification level is |
| set on the server, then this classification is printed before |
| the page label. |
| |
| <H3>page-left (integer(0:MAX))</H3> |
| |
| <P>The page-left attribute specifies the left margin in points (72 points |
| equals 1 inch). The default value is the device physical margin. |
| |
| <H3>page-right (integer(0:MAX))</H3> |
| |
| <P>The page-right attribute specifies the right margin in points (72 points |
| equals 1 inch). The default value is the device physical margin. |
| |
| <H3>page-set (type2 keyword)</H3> |
| |
| <P>The page-set attribute specifies which pages to print in a file. The |
| supported keywords are "all", "even", and "odd". The default value is |
| "all". |
| |
| <H3>page-top (integer(0:MAX))</H3> |
| |
| <P>The page-top attribute specifies the top margin in points (72 points |
| equals 1 inch). The default value is the device physical margin. |
| |
| <H3>penwidth (integer(0:MAX))</H3> |
| |
| <P>The penwidth attribute specifies the default pen width in micrometers |
| when printing HP-GL/2 plot files. The default value is 1000 (1 millimeter). |
| |
| <H3>position (type2 keyword)</H3> |
| |
| <P>The position attribute specifies the location of image files on the |
| media. The following keyword values are recognized: |
| |
| <UL> |
| |
| <LI><CODE>center</CODE> - Center the image on the page (default) |
| |
| <LI><CODE>top</CODE> - Print the image centered at the top of the page |
| |
| <LI><CODE>left</CODE> - Print the image centered on the left of page |
| |
| <LI><CODE>right</CODE> - Print the image centered on the right of the page |
| |
| <LI><CODE>top-left</CODE> - Print the image at the top left corner of |
| the page |
| |
| <LI><CODE>top-right</CODE> - Print the image at the top right corner of |
| the page |
| |
| <LI><CODE>bottom</CODE> - Print the image centered at the bottom of |
| the page |
| |
| <LI><CODE>bottom-left</CODE> - Print the image at the bottom left |
| corner of the page |
| |
| <LI><CODE>bottom-right</CODE> - Print the image at the bottom right |
| corner of the page |
| |
| </UL> |
| |
| <H3>ppi (integer(1:MAX))</H3> |
| |
| <P>The ppi attribute specifies the resolution of an image file in pixels |
| per inch. The default value is the resolution included with the file or |
| 128 if no resolution information is available. |
| |
| <H3>prettyprint (boolean)</H3> |
| |
| <P>The prettyprint attribute specifies whether text files should be printed |
| with a shaded header and keyword highlighting (prettyprint=true) or without |
| additional formatting (prettyprint=false). The default value is false. |
| |
| <H3>saturation (integer(0:200))</H3> |
| |
| <P>The saturation attribute specifies the color saturation when |
| printing image files. A saturation of 100 is normal, while values of 50 |
| and 200 will be half and twice as colorful, respectively. The default |
| value is 100. |
| |
| <H3>scaling (integer(1:1000))</H3> |
| |
| <P>The scaling attribute specifies the scaling of image files with |
| respect to the selected media. A value of 100 specifies that the image |
| file should fit 100% of the page, or as much as possible given the |
| image dimensions. The default value is unspecified. |
| |
| <P>The scaling attribute overrides the ppi attribute if specified. |
| |
| <H3>wrap (boolean)</H3> |
| |
| <P>The wrap attribute specifies whether long lines should be wrapped |
| (wrap=true) or not (wrap=false) when printing text files. The default |
| value is true. |
| |
| <H2>PPD Attributes</H2> |
| |
| <H3>ppd-natural-language (naturalLanguage)</H3> |
| |
| <P>The ppd-natural-language attribute specifies the language encoding |
| of the PPD file (the LanguageVersion attribute in the PPD file). If the |
| language is unknown or undefined then "en" (English) is assumed. |
| |
| <H3>ppd-make (text(127))</H3> |
| |
| <P>The ppd-make attribute specifies the manufacturer of the printer |
| (the Manufacturer attribute in the PPD file). If the manufacturer |
| is not specified in the PPD file then an educated guess is made using |
| the NickName attribute in the PPD file. |
| |
| <H3>ppd-make-and-model (text(127))</H3> |
| |
| <P>The ppd-make-and-model attribute specifies the manufacturer and model |
| name of the PPD file (the NickName attribute in the PPD file). If the |
| make and model is not specified in the PPD file then the ModelName or |
| ShortNickName attributes are used instead. |
| |
| <H3>ppd-name (name(255))</H3> |
| |
| <P>The ppd-name attribute specifies the PPD filename on the server |
| relative to the model directory. The forward slash (/) is used to |
| delineate directories. |
| |
| <H2>Printer Attributes</H2> |
| |
| <H3>job-k-limit (integer)</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-k-limit attribute specifies the maximum number of kilobytes that |
| may be printed by a user, including banner files. The default value of 0 |
| specifies that there is no limit. |
| |
| <H3>job-page-limit (integer)</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-page-limit attribute specifies the maximum number of pages that |
| may be printed by a user, including banner files. The default value of 0 |
| specifies that there is no limit. |
| |
| <H3>job-quota-period (integer)</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-quota-period attribute specifies the time period used for quota |
| calculations, in seconds. The default value of 0 specifies that the limits |
| apply to all jobs that have been printed by a user that are still known to |
| the system. |
| |
| <H3>job-sheets-supported (1setof type3 keyword | name(MAX))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The job-sheets-supported attribute specifies the available banner files. |
| There will always be at least one banner file available called "none". |
| |
| <H3>printer-type (type2 enum)</H3> |
| |
| <P>The printer-type attribute specifies printer type and capability bits for |
| the printer or class. The default value is computed from internal state |
| information and the PPD file for the printer. The following bits are defined: |
| |
| <CENTER><TABLE WIDTH="80%" BORDER> |
| <TR> |
| <TH>Bit</TH> |
| <TH>Description</TH> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000001</TD> |
| <TD VALIGN="TOP">Is a printer class.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000002</TD> |
| <TD VALIGN="TOP">Is a remote destination.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000004</TD> |
| <TD VALIGN="TOP">Can print in black.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000008</TD> |
| <TD VALIGN="TOP">Can print in color.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000010</TD> |
| <TD VALIGN="TOP">Can print on both sides of the page in hardware.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000020</TD> |
| <TD VALIGN="TOP">Can staple output.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000040</TD> |
| <TD VALIGN="TOP">Can do fast copies in hardware.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000080</TD> |
| <TD VALIGN="TOP">Can do fast copy collation in hardware.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000100</TD> |
| <TD VALIGN="TOP">Can punch output.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000200</TD> |
| <TD VALIGN="TOP">Can cover output.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000400</TD> |
| <TD VALIGN="TOP">Can bind output.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00000800</TD> |
| <TD VALIGN="TOP">Can sort output.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00001000</TD> |
| <TD VALIGN="TOP">Can handle media up to US-Legal/A4.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00002000</TD> |
| <TD VALIGN="TOP">Can handle media from US-Legal/A4 to ISO-C/A2.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00004000</TD> |
| <TD VALIGN="TOP">Can handle media larger than ISO-C/A2.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00008000</TD> |
| <TD VALIGN="TOP">Can handle user-defined media sizes.</TD> |
| </TR> |
| <TR> |
| <TD VALIGN="TOP">0x00010000</TD> |
| <TD VALIGN="TOP">Is an implicit (server-generated) class.</TD> |
| </TR> |
| </TABLE></CENTER> |
| |
| <H3>printer-type-mask (type2 enum)</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The printer-type-mask attribute is used to choose printers or classes with |
| the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined |
| identically to the printer-type attribute and default to all 1's. |
| |
| <H3>requesting-user-name-allowed (1setof name(127))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The requesting-user-name-allowed attribute lists all of the users that are |
| allowed to access a printer or class. Either this attribute or the |
| requesting-user-name-denied attribute will be defined, but not both. |
| |
| <H3>requesting-user-name-denied (1setof name(127))</H3> |
| |
| <P><I>(CUPS 1.1 and higher)</I> |
| |
| <P>The requesting-user-name-denied attribute lists all of the users that are |
| not allowed to access a printer or class. Either this attribute or the |
| requesting-user-name-allowed attribute will be defined, but not both. |
| |
| <H2>Printer Class Attributes</H2> |
| |
| <H3>member-names (1setof name(127))</H3> |
| |
| <P>The member-names attribute specifies each of the printer-name attributes of |
| the member printers and classes. Each name corresponds to the same element of |
| the member-uris attribute. |
| |
| <H3>member-uris (1setof uri)</H3> |
| |
| <P>The member-uris attribute specifies each of the printer-uri attributes of |
| the member printers and classes. Each URI corresponds to the same element of |
| the member-names attribute. |
| |
| <EMBED SRC="glossary.shtml"> |
| |
| </BODY> |
| </HTML> |