ipptoolfile(5) OpenPrinting ipptoolfile(5) (NAME) ipptoolfile - ipptool (DESCRIPTION) ipptool(1) IPP . <<#>> . : # { # NAME "Print PDF File" # OPERATION Print-Job GROUP operation-attributes-tag ATTR charset attributes-charset utf-8 ATTR language attributes-natural-language en ATTR uri printer-uri $uri ATTR name requesting-user-name $user ATTR mimeMediaType document-format application/pdf GROUP job-attributes-tag ATTR collection media-col { # US Letter <
> MEMBER collection media-size { MEMBER integer x-dimension 21590 MEMBER integer y-dimension 27940 } MEMBER integer media-top-margin 423 MEMBER integer media-bottom-margin 423 MEMBER integer media-left-margin 423 MEMBER integer media-right-margin 423 MEMBER keyword media-source "main" MEMBER keyword media-type "stationery" } FILE testfile.pdf # STATUS successful-ok EXPECT job-id OF-TYPE integer WITH-VALUE >0 EXPECT job-uri OF-TYPE uri } { # NAME "Wait for Job to Complete" # OPERATION Get-Job-Attributes GROUP operation-attributes-tag ATTR charset attributes-charset utf-8 ATTR language attributes-natural-language en ATTR uri printer-uri $uri ATTR integer job-id $job-id ATTR name requesting-user-name $user # STATUS successful-ok EXPECT job-id OF-TYPE integer WITH-VALUE $job-id EXPECT job-uri OF-TYPE uri EXPECT job-state OF-TYPE enum WITH-VALUE >5 REPEAT-NO-MATCH EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user" # ... DISPLAY job-state DISPLAY job-state-reasons } (TOP-LEVEL DIRECTIVES) test : { test } . DEFINE variable-name value . -d variable-name=value ipptool(8) . DEFINE-DEFAULT variable-name value . FILE-ID "identifier" . IGNORE-ERRORS yes IGNORE-ERRORS no ipptool(8) . INCLUDE "filename" INCLUDE . include ipptool(8) . INCLUDE-IF-DEFINED name "filename" INCLUDE-IF-DEFINED name . include ipptool(8) . INCLUDE-IF-NOT-DEFINED name "filename" INCLUDE-IF-NOT-DEFINED name . include ipptool(8) . SKIP-IF-DEFINED variable-name SKIP-IF-NOT-DEFINED variable-name . STOP-AFTER-INCLUDE-ERROR no STOP-AFTER-INCLUDE-ERROR yes . TRANSFER auto "Transfer-Encoding: chunked" "Content-Length:" . TRANSFER chunked "Transfer-Encoding: chunked" HTTP/1.1 . -c ipptool(8) . (chunked) IPP . TRANSFER length "Content-Length:" HTTP/1.0 . -l ipptool(8) . (content length) IPP . VERSION 1.0 VERSION 1.1 VERSION 2.0 VERSION 2.1 VERSION 2.2 IPP . (TEST DIRECTIVES) test : ATTR out-of-band-tag attribute-name ATTR tag attribute-name value(s) . (admin-define delete-attribute no-value not-settable unknown unsupported) . (",") - "\" . IPP IANA - . ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... ,{ ... } ] (collection) . . . COMPRESSION deflate COMPRESSION gzip COMPRESSION none Print-Job Send-Document . DELAY seconds[,repeat-seconds] . . . DISPLAY attribute-name . EXPECT attribute-name [ predicate(s) ] EXPECT ?attribute-name predicate(s) EXPECT !attribute-name // . - << EXPECT>> . "media-col/media-size/x-dimension". EXPECT-ALL attribute-name [ predicate(s) ] EXPECT-ALL ?attribute-name predicate(s) / . FILE filename . . GROUP tag . IGNORE-ERRORS yes IGNORE-ERRORS no ipptool(8) . MONITOR-PRINTER-STATE [ printer-uri ] { EXPECT attribute-name [ predicate(s) ] } . EXPECT . NAME "literal string" . OPERATION operation-code . PASS-IF-DEFINED variable-name PASS-IF-NOT-DEFINED variable-name (pass) . PAUSE "message" . REQUEST-ID number REQUEST-ID random request-id "random" () . RESOURCE path HTTP POST . URI ipptool(8) . SKIP-IF-DEFINED variable-name SKIP-IF-NOT-DEFINED variable-name . SKIP-PREVIOUS-ERROR yes SKIP-PREVIOUS-ERROR no / ipptool(8) . STATUS status-code [ predicate ] . - << STATUS>> . TEST-ID "identifier" . TRANSFER auto "Transfer-Encoding: chunked" "Content-Length:" . TRANSFER chunked "Transfer-Encoding: chunked" HTTP/1.1 . TRANSFER length "Content-Length:" HTTP/1.0 . VERSION 1.0 VERSION 1.1 VERSION 2.0 VERSION 2.1 VERSION 2.2 IPP . EXPECT (EXPECT PREDICATES) EXPECT : COUNT number EXPECT . DEFINE-MATCH variable-name EXPECT "1" . EXPECT . DEFINE-NO-MATCH variable-name EXPECT "1" . EXPECT . DEFINE-VALUE variable-name EXPECT . EXPECT . DISPLAY-MATCH "message" EXPECT . IF-DEFINED variable-name EXPECT . IF-NOT-DEFINED variable-name EXPECT . IN-GROUP tag EXPECT . OF-TYPE tag[(limits)|tag|...] EXPECT . "name(42)" nameWith/WithoutLanguage "name(4:MAX)" nameWith/WithoutLanguage "integer(-273:MAX)" - . REPEAT-LIMIT number REPEAT-MATCH REPEAT-NO-MATCH . . REPEAT-MATCH REPEAT-NO-MATCH EXPECT . SAME-COUNT-AS attribute-name EXPECT . WITH-ALL-HOSTNAMES "literal string" WITH-ALL-HOSTNAMES "/regular expression/" URI . WITH-ALL-RESOURCES "literal string" WITH-ALL-RESOURCES "/regular expression/" URI ( / ) . WITH-ALL-SCHEMES "literal string" WITH-ALL-SCHEMES "/regular expression/" URI (scheme) . WITH-ALL-VALUES "literal string" EXPECT . . WITH-ALL-VALUES number WITH-ALL-VALUES number[,...,number] EXPECT ( ) . rangeOfInteger <<<>> <<>>> . WITH-ALL-VALUES "false" WITH-ALL-VALUES "true" EXPECT . WITH-ALL-VALUES "/regular expression/" EXPECT POSIX . . WITH-DISTINCT-VALUES EXPECT . . charset collection enum integer keyword mimeMediaType naturalLanguage rangeOfInteger resolution uriScheme . WITH-HOSTNAME "literal string" WITH-HOSTNAME "/regular expression/" URI . WITH-RESOURCE "literal string" WITH-RESOURCE "/regular expression/" URI ( / ) . WITH-SCHEME "literal string" WITH-SCHEME "/regular expression/" URI . WITH-VALUE "literal string" EXPECT . . WITH-VALUE number WITH-VALUE number[,...,number] EXPECT ( ) . rangeOfInteger <<<>> <<>>> . WITH-VALUE "false" WITH-VALUE "true" EXPECT . WITH-VALUE "/regular expression/" EXPECT POSIX . . WITH-VALUE-FROM attribute-name ( ) EXPECT ( ) . "EXPECT job-sheets WITH-VALUE-FROM job-sheets-supported" "job-sheets" "job-sheets-supported" . STATUS (STATUS PREDICATES) STATUS : DEFINE-MATCH variable-name STATUS "1" . STATUS . DEFINE-NO-MATCH variable-name STATUS "1" . STATUS . IF-DEFINED variable-name STATUS . IF-NOT-DEFINED variable-name STATUS . REPEAT-LIMIT number . . REPEAT-MATCH REPEAT-NO-MATCH STATUS . (OPERATION CODES) (0xHHHH) RFC 8011 IPP . ipptool(8) : Acknowledge-Document Acknowledge-Identify-Printer Acknowledge-Job Activate-Printer Add-Document-Images Allocate-Printer-Resources Cancel-Current-Job Cancel-Job Cancel-Jobs Cancel-My-Jobs Cancel-Resource Cancel-Subscription Close-Job Create-Job Create-Job-Subscriptions Create-Printer Create-Printer-Subscriptions Create-Resource Create-Resource-Subscriptions Create-System-Subscriptions CUPS-Accept-Jobs CUPS-Accept-Jobs CUPS-Add-Modify-Class CUPS-Add-Modify-Printer CUPS-Authenticate-Job CUPS-Create-Local-Printer CUPS-Delete-Class CUPS-Delete-Printer CUPS-Get-Classes CUPS-Get-Default CUPS-Get-Devices CUPS-Get-Document CUPS-Get-PPD CUPS-Get-PPDs CUPS-Get-Printers CUPS-Move-Job CUPS-Reject-Jobs CUPS-Set-Default Deactivate-Printer Deallocate-Printer-Resources Delete-Printer Deregister-Output-Device Disable-All-Printers Disable-Printer Enable-All-Printers Enable-Printer Fetch-Document Fetch-Job Get-Job-Attributes Get-Jobs Get-Next-Document-Data Get-Notifications Get-Output-Device-Attributes Get-Printer-Attributes Get-Printer-Support-Files Get-Printer-Supported-Values Get-Printers Get-Subscription-Attributes Get-Subscriptions Get-System-Attributes Get-System-Supported-Values Hold-Job Hold-New-Jobs Identify-Printer Install-Resource Pause-All-Printers Pause-All-Printers-After-Current-Job Pause-Printer Pause-Printer-After-Current-Job Print-Job Print-URI Promote-Job Purge-Jobs Register-Output-Device Release-Held-New-Jobs Release-Job Renew-Subscription Reprocess-Job Restart-Job Restart-Printer Restart-System Resubmit-Job Resume-All-Printers Resume-Job Resume-Printer Schedule-Job-After Send-Document Send-Hardcopy-Document Send-Notifications Send-Resource-Data Send-URI Set-Job-Attributes Set-Printer-Attributes Set-Resource-Attributes Set-System-Attributes Shutdown-All-Printers Shutdown-One-Printer Shutdown-Printer Startup-All-Printers Startup-One-Printer Startup-Printer Suspend-Current-Job Update-Active-Jobs Update-Document-Status Update-Job-Status Update-Output-Device-Attributes Validate-Document Validate-Job (STATUS CODES) (0xHHHH) RFC 8011 IPP . ipptool(8) : client-error-account-authorization-failed client-error-account-closed client-error-account-info-needed client-error-account-limit-reached client-error-attributes-not-settable client-error-attributes-or-values-not-supported client-error-bad-request client-error-charset-not-supported client-error-compression-error client-error-compression-not-supported client-error-conflicting-attributes client-error-document-access-error client-error-document-format-error client-error-document-format-not-supported client-error-document-password-error client-error-document-permission-error client-error-document-security-error client-error-document-unprintable-error client-error-forbidden client-error-gone client-error-ignored-all-notifications client-error-ignored-all-subscriptions client-error-not-authenticated client-error-not-authorized client-error-not-fetchable client-error-not-found client-error-not-possible client-error-print-support-file-not-found client-error-request-entity-too-large client-error-request-value-too-long client-error-timeout client-error-too-many-subscriptions client-error-uri-scheme-not-supported cups-error-account-authorization-failed cups-error-account-closed cups-error-account-info-needed cups-error-account-limit-reached cups-see-other redirection-other-site server-error-busy server-error-device-error server-error-internal-error server-error-job-canceled server-error-multiple-document-jobs-not-supported server-error-not-accepting-jobs server-error-operation-not-supported server-error-printer-is-deactivated server-error-service-unavailable server-error-temporary-error server-error-version-not-supported successful-ok successful-ok-but-cancel-subscription successful-ok-conflicting-attributes successful-ok-events-complete successful-ok-ignored-notifications successful-ok-ignored-or-substituted-attributes successful-ok-ignored-subscriptions successful-ok-too-many-events (TAGS) RFC 8011 IPP . : document-attributes-tag event-notification-attributes-tag job | job-attributes-tag operation | operation-attributes-tag printer | printer-attributes-tag resource-attributes-tag subscription-attributes-tag system-attributes-tag unsupported-attributes-tag : admin-define boolean charset collection | begCollection dateTime default delete-attribute enum integer keyword language | naturalLanguage mimetype | mimeMediaType name | nameWithLanguage | nameWithoutLanguage no-value not-settable octetString rangeOfInteger resolution text | textWithLanguage | textWithoutLanguage unknown unsupported uri uriScheme (VARIABLES) ipptool(8) "$variable-name" . -d DEFINE : $$ <<$>> . $ENV[name] . $date-current ISO-8601 ("yyyy-mm- ddThh:mm:ssZ") . $date-start ISO-8601 ("yyyy-mm- ddThh:mm:ssZ") . $filename ipptool(8) -f . $filetype MIME ipptool(8) -f . $hostname URI ipptool(8) . $job-id "job-id" "job-id" 0 . $job-uri "job-uri" "job-uri" . $notify-subscription-id "notify-subscription-id" "notify-subscription-id" 0 . $port (port) URI ipptool(8) . $resource URI ipptool(8) . $scheme (scheme) URI ipptool(8) . $uri URI ipptool(8) . $uriuser URI ipptool(8) ( ) . $user . (SEE ALSO) ipptool(1), IANA IPP Registry (https://www.iana.org/assignments/ipp- registrations), PWG Internet Printing Protocol Workgroup (https://www.pwg.org/ipp), RFC 8011 (https://datatracker.ietf.org/doc/html/rfc8011) (COPYRIGHT) Copyright (C) 2020-2024 by OpenPrinting. 2021-09-20 CUPS ipptoolfile(5)