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.1. >
CUPS >provides >a >portable >printing >layer >for > UNIX®-based >operating >systems. >It >has >been >developed > by >Easy >Software >Products> to >promote >a >standard >printing >solution >for >all > UNIX >vendors >and >users. >CUPS >provides >the >System > V >and >Berkeley >command-line >interfaces. >
CUPS >uses >the >Internet >Printing >Protocol >("IPP") > as >the >basis >for >managing >print >jobs >and > queues. >The >Line >Printer >Daemon >("LPD") >Server > Message >Block >("SMB"), >and >AppSocket >(a.k.a. > JetDirect) >protocols >are >also >supported >with >reduced > functionality. >CUPS >adds >network >printer >browsing >and > PostScript >Printer >Description >("PPD") >based >printing > options >to >support >real-world >printing >under >UNIX. >
CUPS >also >includes >a >customized >version >of >GNU > Ghostscript >(currently >based >off >GNU >Ghostscript > 5.50) >and >an >image >file >RIP >that >are >used >to > support >non-PostScript >printers. >Sample >drivers >for > HP >and >EPSON >printers >are >included >that >use > these >filters. >
This >document >is >organized >into >the >following > sections: >
The >following >CUPS >documentation >is >referenced >by > this >document: >
The >following >non-CUPS >documents >are >referenced >by > this >document: >
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. >
CUPS >also >provides >13 >new >operations >and >many > new >attributes >to >support >multiple >IPP >printers > and >printer >classes >on >a >single >host. >
CUPS >supports >both >the >"http" >and >"ipp" > methods. >The >following >resource >names >are >used: >
So >a >typical >printer >URI >would >be > "ipp://foo.bar.com/printers/LaserJet". >
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. >
CUPS >provides >13 >extension >operations >in >addition > to >most >of >the >standard >IPP >and >registered > extension >operations: >
Operation >Name> | CUPS> | Code> | Brief >Description> |
---|---|---|---|
Print-Job> | 1.0> | 0x0002> | Print >a >file.> |
Validate-Job> | 1.0> | 0x0004> | Validate >job >attributes.> |
Create-Job> | 1.1> | 0x0005> | Create >a >print >job.> |
Send-Document> | 1.1> | 0x0006> | Send >a >file >for > a >print >job.> |
Cancel-Job> | 1.0> | 0x0008> | Cancel >a >print >job.> |
Get-Job-Attributes> | 1.0> | 0x0009> | Get >job >attributes.> |
Get-Jobs> | 1.0> | 0x000A> | Get >all >jobs.> |
Get-Printer-Attributes> | 1.0> | 0x000B> | Get >printer > attributes.> |
Hold-Job> | 1.1> | 0x000C> | Hold >a >job >for >printing.> |
Release-Job> | 1.1> | 0x000D> | Release >a >job >for >printing.> |
Pause-Printer> | 1.0> | 0x0010> | Pause >printing >on > a >printer.> |
Resume-Printer> | 1.0> | 0x0011> | Resume >printing >on > a >printer.> |
Purge-Jobs> | 1.0> | 0x0012> | Purge >all >jobs.> |
Set-Job-Attributes> | 1.1> | 0x0014> | Set >attributes >for > a >pending >or >held >job.> |
CUPS-Get-Default> | 1.0> | 0x4001> | Get >the >default > destination.> |
CUPS-Get-Printers> | 1.0> | 0x4002> | Get >all >of >the > available >printers.> |
CUPS-Add-Printer> | 1.0> | 0x4003> | Add >or >modify >a > printer.> |
CUPS-Delete-Printer> | 1.0> | 0x4004> | Delete >a >printer.> |
CUPS-Get-Classes> | 1.0> | 0x4005> | Get >all >of >the > available >printer >classes.> |
CUPS-Add-Class> | 1.0> | 0x4006> | Add >or >modify >a > printer >class.> |
CUPS-Delete-Class> | 1.0> | 0x4007> | Delete >a >printer > class.> |
CUPS-Accept-Jobs> | 1.0> | 0x4008> | Accept >jobs >on >a > printer >or >printer >class.> |
CUPS-Reject-Jobs> | 1.0> | 0x4009> | Reject >jobs >on >a > printer >or >printer >class.> |
CUPS-Set-Default> | 1.0> | 0x400A> | Set >the >default > destination.> |
CUPS-Get-Devices> | 1.1> | 0x400B> | Get >all >of >the > available >devices.> |
CUPS-Get-PPDs> | 1.1> | 0x400C> | Get >all >of >the > available >PPDs.> |
CUPS-Move-Job> | 1.1> | 0x400D> | Move >a >job >to >a > different >printer.> |
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. >
The >Print-Job >operation >(0x0002) >prints >a >file. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >Print-Job >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer. >
Group >2: >Job >Template >Attributes >
"job-billing" >(text(MAX)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >billing >string > that >is >logged > with >the >page >accounting > information. >
"job-sheets" >(1setof >type3 >keyword >| >name(MAX)): >
(CUPS >1.1 >and >higher)>
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > job-sheets >attribute >value. >
"media" >(1setof >type3 >keyword >| >name(MAX)): >
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > media >attribute >value. >
Other >Job >Template >Attributes >
The >Print-Job >request >is >followed >by >a >file > to >be >printed. >
The >following >groups >of >attributes >are >send >as > part >of >the >Print-Job >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Job >Attributes >
Standard >Job >Attributes >
The >Create-Job >operation >(0x0005) >creates >a >new, > empty >print >job. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >Create-Job >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer. >
Group >2: >Job >Template >Attributes >
"job-billing" >(text(MAX)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >billing >string > that >is >logged > with >the >page >accounting > information. >
"job-sheets" >(1setof >type3 >keyword >| >name(MAX)): >
(CUPS >1.1 >and >higher)>
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > job-sheets >attribute >value. >
"media" >(1setof >type3 >keyword >| >name(MAX)): >
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > media >attribute >value. >
Standard >Job >Template >Attributes >
The >following >groups >of >attributes >are >send >as > part >of >the >Create-Job >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Job >Attributes >
Standard >Job >Attributes >
The >Set-Job-Attributes >operation >(0x0014) >changes >the > attributes >of >an >active >(not >completed) >job. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >Set-Job-Attributes >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri) >and >"job-id" >(integer) >
OR>
"job-uri": >
The >client >MUST >supply >a >URI >for >the > specified >printer >and > a >job >ID >number, >or >the > job >URI. >
Group >2: >Job >Template >Attributes >
"job-sheets" >(1setof >type3 >keyword >| >name(MAX)): >
(CUPS >1.1 >and >higher)>
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > job-sheets >attribute >value. >
"media" >(1setof >type3 >keyword >| >name(MAX)): >
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. >
Note:> Standard >IPP >only >allows >specification > of >a >single > media >attribute >value. >
Other >Job >Template >Attributes >
The >following >groups >of >attributes >are >send >as > part >of >the >Set-Job-Attributes >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Get-Default >operation >(0x4001) >returns >the > default >printer >URI >and >attributes. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Get-Default >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"requested-attributes" >(1setOf >keyword) >: >
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'. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Get-Default >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Printer >Object >Attributes >
The >set >of >requested >attributes >and >their > current >values. >
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. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Get-Printers >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"limit" >(integer >(1:MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > limiting >the > number >of >printers >that >are > returned. >
"printer-info" >(text(127)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >this >attribute >to > select >which >printers >are >returned. >
"printer-location" >(text(127)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >this >attribute >to > select >which >printers >are >returned. >
"printer-type" >(type2 >enum): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >printer >type > enumeration >to > select >which >printers >are >returned. >
"printer-type-mask" >(type2 >enum): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >printer >type > mask > enumeration >to >select >which >bits >are >used > in >the >"printer-type" > attribute. >
"requested-attributes" >(1setOf >keyword) >: >
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'. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Get-Printers >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Printer >Object >Attributes >
The >set >of >requested >attributes >and >their > current >values >for > each >printer. >
The >CUPS-Add-Printer >operation >(0x4003) >adds >a >new > printer >or >modifies >an >existing >printer >on >the > system. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Add-Printer >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer. >
Group >2: >Printer >Object >Attributes >
"banner-end-default" >(name(127)): >
(CUPS >1.1 >and >higher)>
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. >
"banner-start-default" >(name(127)): >
(CUPS >1.1 >and >higher)>
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. >
"device-uri" >(uri): >
The >client >OPTIONALLY >supplies >a >device >URI >for > the > specified >printer. >
"ppd-name" >(name(127)): >
The >client >OPTIONALLY >supplies >a >PPD >name >for > the >specified > printer. >
"printer-is-accepting-jobs" >(boolean): >
The >client >OPTIONALLY >supplies >this >boolean > attribute > indicating >whether >or >not >the >printer > object >should >accept >new >jobs. >
"printer-info" >(text(127)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >the > printer >information >string. >
"printer-location" >(text(127)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > textual >location >of >the >printer. >
"printer-more-info" >(uri): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > URI >for >additional >printer >information. >
"printer-state" >(type2 >enum): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >the > initial/current >state >of >the >printer. > Only >the >"idle" >and >"stopped" > enumerations >are > recognized. >
"printer-state-message" >(text(MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > textual >reason >for >the >current > printer >state. >
"requesting-user-name-allowed" >(1setof >name(127) >| > delete) >
OR>
"requesting-user-name-denied" >(1setof >name(127) >| > delete): >
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. >
The >CUPS-Add-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. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Add-Printer >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Delete-Printer >operation >(0x4004) >removes >an > existing >printer >from >the >system. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Delete-Printer >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Delete-Printer >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
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. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Get-Classes >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"limit" >(integer >(1:MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > limiting >the > number >of >printer >classes >that >are > returned. >
"printer-info" >(text(127)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >this >attribute >to > select >which >printer >classes >are >returned. >
"printer-location" >(text(127)): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >this >attribute >to > select >which >printer >classes >are >returned. >
"printer-type" >(type2 >enum): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >printer >type > enumeration >to > select >which >printer >classes >are > returned. >
"printer-type-mask" >(type2 >enum): >
(CUPS >1.1 >and >higher)>
The >client >OPTIONALLY >supplies >a >printer >type > mask > enumeration >to >select >which >bits >are >used > in >the >"printer-type" > attribute. >
"requested-attributes" >(1setOf >keyword) >: >
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'. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Get-Classes >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Printer >Class >Object >Attributes >
The >set >of >requested >attributes >and >their > current >values >for > each >printer >class. >
The >CUPS-Add-Class >operation >(0x4006) >adds >a >new > printer >class >or >modifies >and >existing >printer > class >on >the >system. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Add-Class >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer >class. >
Group >2: >Printer >Object >Attributes >
"member-uris" >(1setof >uri): >
The >client >OPTIONALLY >supplies >the >"member-uris" > set > specifying >the >printers >and >printer >classes > that >are >part >of >the >class. >
"printer-is-accepting-jobs" >(boolean): >
The >client >OPTIONALLY >supplies >this >boolean > attribute > indicating >whether >or >not >the >class > object >should >accept >new >jobs. >
"printer-info" >(text(127)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >the > printer >information >string. >
"printer-location" >(text(127)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > textual >location >of >the >class. >
"printer-more-info" >(uri): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > URI >for >additional >class >information. >
"printer-state" >(type2 >enum): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >the > initial/current >state >of >the >class. > Only >the >"idle" >and >"stopped" > enumerations >are > recognized. >
"printer-state-message" >(text(MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > textual >reason >for >the >current >class > state. >
"requesting-user-name-allowed" >(1setof >name(127)) >
OR>
"requesting-user-name-denied" >(1setof >name(127)): >
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. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Add-Class >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Delete-Class >operation >(0x4007) >removes >an > existing >printer >class >from >the >system. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Delete-Class >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer >class. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Delete-Class >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Accept-Jobs >operation >(0x4008) >sets >the > "printer-is-accepting-jobs" >attribute >to >true >for >the > specified >printer >or >printer >class. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Accept-Jobs >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer >or >printer >class. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Accept-Jobs >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Reject-Jobs >operation >(0x4009) >sets > the"printer-is-accepting-jobs" >attribute >to >false >for > the >specified >printer >or >printer >class. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Reject-Jobs >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer >or >printer >class. >
Group >2: >Printer >Object >Attributes >
"printer-state-message" >(text(MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > indicating >a > textual >reason >for >the >current > printer >state. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Reject-Jobs >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Set-Default >operation >(0x400A) >sets >the > default >printer >destination >for >all >clients >when >a > resource >name >of >"/printers" >is >specified. >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Set-Default >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri): >
The >client >MUST >supply >a >URI >for >the > specified >printer >or > printer >class. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Set-Default >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
The >CUPS-Get-Devices >operation >(0x400B) >returns >all > of >the >supported >device-uri's >for >the >server >(CUPS > 1.1 >and >higher). >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Get-Devices >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"device-class" >(type1 >keyword): >
The >client >OPTIONALLY >supplies >a >device >class > keyword >to >select > which >devices >are >returned. >
"limit" >(integer >(1:MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > limiting >the >number >of > devices >that >are >returned. >
"requested-attributes" >(1setOf >keyword) >: >
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'. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Get-Devices >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >Device >Object >Attributes >
The >set >of >requested >attributes >and >their > current >values >for > each >device. >
The >CUPS-Get-PPDs >operation >(0x400C) >returns >all > of >the >locally >available >PPD >files >on >the > system >(CUPS >1.1 >and >higher). >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Get-PPDs >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"limit" >(integer >(1:MAX)): >
The >client >OPTIONALLY >supplies >this >attribute > limiting >the >number >of > PPDs >that >are >returned. >
"ppd-make" >(text(127)): >
The >client >OPTIONALLY >supplies >a >printer > manufacturer >to >select > which >PPDs >are >returned. >
"requested-attributes" >(1setOf >keyword) >: >
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'. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Get-PPDs >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
Group >2: >PPD >Attributes >
The >set >of >requested >attributes >and >their > current >values >for >each > PPD >file. >
The >CUPS-Move-Job >operation >(0x400D) >moves >an > active >print >job >to >a >different >printer >(CUPS > 1.1 >and >higher). >
The >following >groups >of >attributes >are >supplied > as >part >of >the >CUPS-Move-Job >request: >
Group >1: >Operation >Attributes >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.1 >of >the > IPP >Model >and > Semantics >document. >
"printer-uri" >(uri) >and >"job-id" >(integer) >
OR>
"job-uri": >
The >client >MUST >supply >a >URI >for >the > specified >printer >and > a >job >ID >number, >or >the > job >URI. >
Group >2: >Job >Template >Attributes >
"job-printer-uri" >(uri) >
The >client >MUST >supply >a >URI >for >a >printer > on >the >same >server. >
The >following >groups >of >attributes >are >send >as > part >of >the >CUPS-Move-Job >Response: >
Group >1: >Operation >Attributes >
Status >Message: >
The >standard >response >status >message. >
Natural >Language >and >Character >Set: >
The >"attributes-charset" >and >"attributes-natural-language" > attributes >as >described >in >section >3.1.4.2 >of >the > IPP >Model >and > Semantics >document. >
CUPS >provides >many >extension >attributes >to >support > multiple >devices, >PPD >files, >standard >job >filters, > printers, >and >printer >classes. >
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. >
The >device-class >attribute >specifies >the >class >of > device >and >can >be >one >of >the >following: >
The >device-info >attribute >specifies >a >human-readable > string >describing >the >device, >e.g. >"Parallel >Port > #1". >
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". >
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: >
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"). >
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. >
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. >
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. >
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. >
Brightness >is >applied >to >the >Cyan, >Magenta, > Yellow, >and >Black >values >using >the >function >"f(x) > = >brightness >/ >100 >* >x". >
The >columns >attribute >specifies >the >number >of > columns >to >generate >when >printing >text >files. >The > default >value >is >1. >
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. >
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. >
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. >
Gamma >is >applied >to >the >Red, >Green, >and >Blue > values >(or >luminance >for >grayscale >output) >using > the >function >"f(x) >= >x>(1000/gamma)>". >
The >hue >attribute >specifies >a >color >hue > rotation >when >printing >image >files. >The >default > value >is >0. >
(CUPS >1.1 >and >higher)>
The >job-billing >attribute >provides >a >text >value > to >associate >with >a >job >for >billing >purposes. >
(CUPS >1.1 >and >higher)>
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 >not> in >the >local >time >zone. >If >the > specified >time >is >less >than >the >current >time, > the >job >is >held >until >the >next >day. >
(CUPS >1.1 >and >higher)>
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. >
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. >
(CUPS >1.1.5 >and >higher)>
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 > always> resolved >to >the >name >"localhost". >
This >attribute >is >read-only. >
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. >
The >page-bottom >attribute >specifies >the >bottom > margin >in >points >(72 >points >equals >1 >inch). >The > default >value >is >the >device >physical >margin. >
The >page-left >attribute >specifies >the >left >margin > in >points >(72 >points >equals >1 >inch). >The > default >value >is >the >device >physical >margin. >
The >page-right >attribute >specifies >the >right > margin >in >points >(72 >points >equals >1 >inch). >The > default >value >is >the >device >physical >margin. >
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". >
The >page-top >attribute >specifies >the >top >margin > in >points >(72 >points >equals >1 >inch). >The > default >value >is >the >device >physical >margin. >
The >penwidth >attribute >specifies >the >default >pen > width >in >micrometers >when >printing >HP-GL/2 >plot > files. >The >default >value >is >1000 >(1 >millimeter). >
The >position >attribute >specifies >the >location >of > image >files >on >the >media. >The >following >keyword > values >are >recognized: >
center>
- >Center >the >image >on >the >
page >(default) >top>
- >Print >the >image >centered >at >
the >top >of >the >page >left>
- >Print >the >image >centered >on >
the >left >of >page >right>
- >Print >the >image >centered >on >
the >right >of >the >page >top-left>
- >Print >the >image >at >the >
top >left >corner >of > the >page >top-right>
- >Print >the >image >at >the >
top >right >corner >of > the >page >bottom>
- >Print >the >image >centered >at >
the >bottom >of > the >page >bottom-left>
- >Print >the >image >at >the >
bottom >left > corner >of >the >page >bottom-right>
- >Print >the >image >at >
the >bottom >right > corner >of >the >page >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. >
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. >
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. >
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. >
The >scaling >attribute >overrides >the >ppi >attribute > if >specified. >
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. >
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. >
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. >
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. >
The >ppd-name >attribute >specifies >the >PPD >filename > on >the >server >relative >to >the >model >directory. > The >forward >slash >(/) >is >used >to >delineate > directories. >
(CUPS >1.1 >and >higher)>
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. >
(CUPS >1.1 >and >higher)>
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. >
(CUPS >1.1 >and >higher)>
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. >
(CUPS >1.1 >and >higher)>
The >job-sheets-supported >attribute >specifies >the > available >banner >files. >There >will >always >be >at > least >one >banner >file >available >called >"none". >
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: >
Bit> | Description> |
---|---|
0x00000001> | Is >a > printer >class.> |
0x00000002> | Is >a > remote >destination.> |
0x00000004> | Can >print > in >black.> |
0x00000008> | Can >print > in >color.> |
0x00000010> | Can >print > on >both >sides >of >the >page >in >hardware.> |
0x00000020> | Can >staple > output.> |
0x00000040> | Can >do > fast >copies >in >hardware.> |
0x00000080> | Can >do > fast >copy >collation >in >hardware.> |
0x00000100> | Can >punch > output.> |
0x00000200> | Can >cover > output.> |
0x00000400> | Can >bind > output.> |
0x00000800> | Can >sort > output.> |
0x00001000> | Can >handle > media >up >to >US-Legal/A4.> |
0x00002000> | Can >handle > media >from >US-Legal/A4 >to >ISO-C/A2.> |
0x00004000> | Can >handle > media >larger >than >ISO-C/A2.> |
0x00008000> | Can >handle > user-defined >media >sizes.> |
0x00010000> | Is >an > implicit >(server-generated) >class.> |
(CUPS >1.1 >and >higher)>
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. >
(CUPS >1.1 >and >higher)>
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. >
(CUPS >1.1 >and >higher)>
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. >
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. >
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. >