"$Id: ipptoolfile.man 11934 2014-06-17 18:58:29Z msweet $"

ipptoolfile man page for CUPS.

Copyright 2010-2014 by Apple Inc.

These coded instructions, statements, and computer programs are the
property of Apple Inc. and are protected by Federal copyright
law. Distribution and use rights are outlined in the file "LICENSE.txt"
which should have been included with this file. If this file is
file is missing or damaged, see the license at "http://www.cups.org/".

ipptoolfile - ipptool file format The ipptool (1) program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curly braces, for example:

 # This is a comment
 {
 # The name of the test
 NAME "Print PostScript File"

 # The request to send
 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
 FILE testfile.ps

 # The response to expect
 STATUS successful-ok
 EXPECT job-id OF-TYPE integer WITH-VALUE >0
 EXPECT job-uri OF-TYPE uri
 }
 {
 # The name of the test
 NAME "Get Attributes of PostScript Job"

 # The request to send
 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

 # The response to expect
 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 3,4,5,6,7,8,9
 EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user"
 }

The following directives can be used outside of a test:

5 { test } Defines a test.

5 DEFINE variable-name value Defines the named variable to the given value. This is equivalent to specifying -d variable-name=value on the ipptool (8) command-line.

5 DEFINE-DEFAULT variable-name value Defines the named variable to the given value if it does not already have a value.

5 FILE-ID "identifier" Specifies an identifier string for the current file.

5 IGNORE-ERRORS yes

5 IGNORE-ERRORS no Specifies whether, by default, ipptool (8) will ignore errors and continue with subsequent tests.

5 INCLUDE "filename"

5 INCLUDE <filename> Includes another test file. The first form includes a file relative to the current test file, while the second form includes a file from the ipptool (8) include directory.

5 INCLUDE-IF-DEFINED name "filename"

5 INCLUDE-IF-DEFINED name <filename> Includes another test file if the named variable is defined. The first form includes a file relative to the current test file, while the second form includes a file from the ipptool (8) include directory.

5 INCLUDE-IF-NOT-DEFINED name "filename"

5 INCLUDE-IF-NOT-DEFINED name <filename> Includes another test file if the named variable is not defined. The first form includes a file relative to the current test file, while the second form includes a file from the ipptool (8) include directory.

5 SKIP-IF-DEFINED variable-name

5 SKIP-IF-NOT-DEFINED variable-name Specifies that the remainder of the test file should be skipped when the variable is or is not defined.

5 STOP-AFTER-INCLUDE-ERROR no

5 STOP-AFTER-INCLUDE-ERROR yes Specifies whether tests will be stopped after an error in an included file.

5 TRANSFER auto Specifies that tests will, by default, use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.

5 TRANSFER chunked Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: chunked" header. This is the default and is equivalent to specifying -c on the ipptool (8) command-line. Support for chunked requests is required for conformance with all versions of IPP.

5 TRANSFER length Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" header. This is equivalent to specifying -l on the ipptool (8) command-line. Support for content length requests is required for conformance with all versions of IPP.

5 VERSION 1.0

5 VERSION 1.1

5 VERSION 2.0

5 VERSION 2.1

5 VERSION 2.2 Specifies the default IPP version number to use for the tests that follow.

The following directives are understood within a test:

5 ATTR tag attribute-name value(s) Adds an attribute to the test request. Values are separated by the comma (",") character - escape commas using the "\" character. Common attributes and values are listed in the IANA IPP registry - see references below.

5 ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... ,{ ... } ] Adds a collection attribute to the test request. Member attributes follow the same syntax as regular attributes and can themselves be nested collections. Multiple collection values can be supplied as needed, separated by commas.

5 COMPRESSION deflate

5 COMPRESSION gzip

5 COMPRESSION none Uses the specified compression on the document data following the attributes in a Print-Job or Send-Document request.

5 DELAY seconds Specifies a delay before this test will be run.

5 DISPLAY attribute-name Specifies that value of the named attribute should be output as part of the test report.

5 EXPECT attribute-name [ predicate(s) ]

5 EXPECT ?attribute-name predicate(s)

5 EXPECT !attribute-name Specifies that the response must/may/must not include the named attribute. Additional requirements can be added as predicates - see the "EXPECT PREDICATES" section for more information on predicates. Attribute names can specify member attributes by separating the attribute and member names with the forward slash, for example "media-col/media-size/x-dimension".

5 FILE filename Specifies a file to include at the end of the request. This is typically used when sending a test print file.

5 GROUP tag Specifies the group tag for subsequent attributes in the request.

5 IGNORE-ERRORS yes

5 IGNORE-ERRORS no Specifies whether ipptool (8) will ignore errors and continue with subsequent tests.

5 NAME "literal string" Specifies the human-readable name of the test.

5 OPERATION operation-code Specifies the operation to be performed.

5 PAUSE "message" Displays the provided message and waits for the user to press a key to continue.

5 REQUEST-ID number

5 REQUEST-ID random Specifies the request-id value to use in the request, either an integer or the word "random" to use a randomly generated value (the default).

5 RESOURCE path Specifies an alternate resource path that is used for the HTTP POST request. The default is the resource from the URI provided to the ipptool (8) program.

5 SKIP-IF-DEFINED variable-name

5 SKIP-IF-NOT-DEFINED variable-name Specifies that the current test should be skipped when the variable is or is not defined.

5 SKIP-PREVIOUS-ERROR yes

5 SKIP-PREVIOUS-ERROR no Specifies whether ipptool (8) will skip the current test if the previous test resulted in an error/failure.

5 STATUS status-code [ predicate ] Specifies an expected response status-code value. Additional requirements can be added as predicates - see the "STATUS PREDICATES" section for more information on predicates.

5 TEST-ID "identifier" Specifies an identifier string for the current test.

5 TRANSFER auto Specifies that this test will use "Transfer-Encoding: chunked" if it has an attached file or "Content-Length:" otherwise.

5 TRANSFER chunked Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header.

5 TRANSFER length Specifies that this test will use the HTTP/1.0 "Content-Length:" header.

5 VERSION 1.0

5 VERSION 1.1

5 VERSION 2.0

5 VERSION 2.1

5 VERSION 2.2 Specifies the IPP version number to use for this test.

The following predicates are understood following the EXPECT test directive:

5 COUNT number Requires the EXPECT attribute to have the specified number of values.

5 DEFINE-MATCH variable-name Defines the variable to "1" when the EXPECT condition matches. A side-effect of this predicate is that this EXPECT will never fail a test.

5 DEFINE-NO-MATCH variable-name Defines the variable to "1" when the EXPECT condition does not match. A side-effect of this predicate is that this EXPECT will never fail a test.

5 DEFINE-VALUE variable-name Defines the variable to the value of the attribute when the EXPECT condition matches. A side-effect of this predicate is that this EXPECT will never fail a test.

5 IF-DEFINED variable-name Makes the EXPECT conditions apply only if the specified variable is defined.

5 IF-NOT-DEFINED variable-name Makes the EXPECT conditions apply only if the specified variable is not defined.

5 IN-GROUP tag Requires the EXPECT attribute to be in the specified group tag.

5 OF-TYPE tag[,tag,...] Requires the EXPECT attribute to use one of the specified value tag(s).

5 REPEAT-LIMIT number

Specifies the maximum number of times to repeat if the REPEAT-MATCH or REPEAT-NO-MATCH predicate is specified. The default value is 1000.

5 REPEAT-MATCH

5 REPEAT-NO-MATCH Specifies that the current test should be repeated when the EXPECT condition matches or does not match.

5 SAME-COUNT-AS attribute-name Requires the EXPECT attribute to have the same number of values as the specified parallel attribute.

5 WITH-ALL-HOSTNAMES "literal string"

5 WITH-ALL-HOSTNAMES "/regular expression/" Requires that all URI values contain a matching hostname.

5 WITH-ALL-RESOURCES "literal string"

5 WITH-ALL-RESOURCES "/regular expression/" Requires that all URI values contain a matching resource (including leading /).

5 WITH-ALL-SCHEMES "literal string"

5 WITH-ALL-SCHEMES "/regular expression/" Requires that all URI values contain a matching scheme.

5 WITH-ALL-VALUES "literal string" Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.

5 WITH-ALL-VALUES <number

5 WITH-ALL-VALUES =number

5 WITH-ALL-VALUES >number

5 WITH-ALL-VALUES number[,...,number] Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.

5 WITH-ALL-VALUES "false"

5 WITH-ALL-VALUES "true" Requires that all values of the EXPECT attribute match the boolean value given.

5 WITH-ALL-VALUES "/regular expression/" Requires that all values of the EXPECT attribute match the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.

5 WITH-HOSTNAME "literal string"

5 WITH-HOSTNAME "/regular expression/" Requires that at least one URI value contains a matching hostname.

5 WITH-RESOURCE "literal string"

5 WITH-RESOURCE "/regular expression/" Requires that at least one URI value contains a matching resource (including leading /).

5 WITH-SCHEME "literal string"

5 WITH-SCHEME "/regular expression/" Requires that at least one URI value contains a matching scheme.

5 WITH-VALUE "literal string" Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.

5 WITH-VALUE <number

5 WITH-VALUE =number

5 WITH-VALUE >number

5 WITH-VALUE number[,...,number] Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.

5 WITH-VALUE "false"

5 WITH-VALUE "true" Requires that at least one value of the EXPECT attribute matches the boolean value given.

5 WITH-VALUE "/regular expression/" Requires that at least one value of the EXPECT attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.

The following predicates are understood following the STATUS test directive:

5 DEFINE-MATCH variable-name Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test.

5 DEFINE-NO-MATCH variable-name Defines the variable to "1" when the STATUS does not match. A side-effect of this predicate is that this STATUS will never fail a test.

5 IF-DEFINED variable-name Makes the STATUS apply only if the specified variable is defined.

5 IF-NOT-DEFINED variable-name Makes the STATUS apply only if the specified variable is not defined.

5 REPEAT-LIMIT number

Specifies the maximum number of times to repeat. The default value is 1000.

5 REPEAT-MATCH

5 REPEAT-NO-MATCH Specifies that the current test should be repeated when the response status-code matches or does not match the value specified by the STATUS directive.

Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 2911 and other IPP extension specifications. Here is a complete list of names supported by ipptool (8):

 Activate-Printer
 CUPS-Accept-Jobs
 CUPS-Add-Modify-Class
 CUPS-Add-Modify-Printer
 CUPS-Authenticate-Job
 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
 Cancel-Current-Job
 Cancel-Job
 Cancel-Jobs
 Cancel-My-Jobs
 Cancel-Subscription
 Close-Job
 Create-Job
 Create-Job-Subscriptions
 Create-Printer-Subscriptions
 Deactivate-Printer
 Disable-Printer
 Enable-Printer
 Get-Job-Attributes
 Get-Jobs
 Get-Notifications
 Get-Printer-Attributes
 Get-Printer-Support-Files
 Get-Printer-Supported-Values
 Get-Subscription-Attributes
 Get-Subscriptions
 Hold-Job
 Hold-New-Jobs
 Identify-Printer
 Pause-Printer
 Pause-Printer-After-Current-Job
 Print-Job
 Print-URI
 Promote-Job
 Purge-Jobs
 Release-Held-New-Jobs
 Release-Job
 Renew-Subscription
 Reprocess-Job
 Restart-Job
 Restart-Printer
 Resubmit-Job
 Resume-Job
 Resume-Printer
 Schedule-Job-After
 Send-Document
 Send-Hardcopy-Document
 Send-Notifications
 Send-URI
 Set-Job-Attributes
 Set-Printer-Attributes
 Shutdown-Printer
 Startup-Printer
 Suspend-Current-Job
 Validate-Document
 Validate-Job

Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 2911 and other IPP extension specifications. Here is a complete list of the names supported by 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-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

Value and group tags correspond to the names from RFC 2911 and other IPP extension specifications. Here are the group tags:

 document-attributes-tag
 event-notification-attributes-tag
 job-attributes-tag
 operation-attributes-tag
 printer-attributes-tag
 subscription-attributes-tag
 unsupported-attributes-tag

Here are the value tags:

 admin-define
 boolean
 charset
 collection
 dateTime
 default
 delete-attribute
 enum
 integer
 keyword
 mimeMediaType
 nameWithLanguage
 nameWithoutLanguage
 naturalLanguage
 no-value
 not-settable
 octetString
 rangeOfInteger
 resolution
 textWithLanguage
 textWithoutLanguage
 unknown
 unsupported
 uri
 uriScheme

The ipptool (8) program maintains a list of variables that can be used in any literal string or attribute value by specifying "$variable-name". Aside from variables defined using the -d option or DEFINE directive, the following pre-defined variables are available:

5 $$ Inserts a single "$" character.

5 $ENV[name] Inserts the value of the named environment variable, or an empty string if the environment variable is not defined.

5 $filename Inserts the filename provided to ipptool (8) with the -f option.

5 $filetype Inserts the MIME media type for the filename provided to ipptool (8) with the -f option.

5 $hostname Inserts the hostname from the URI provided to ipptool (8).

5 $job-id Inserts the last "job-id" attribute value returned in a test response or 0 if no "job-id" attribute has been seen.

5 $job-uri Inserts the last "job-uri" attribute value returned in a test response or an empty string if no "job-uri" attribute has been seen.

5 $notify-subscription-id Inserts the last "notify-subscription-id" attribute value returned in a test response or 0 if no "notify-subscription-id" attribute has been seen.

5 $port Inserts the port number from the URI provided to ipptool (8).

5 $resource Inserts the resource path from the URI provided to ipptool (8).

5 $scheme Inserts the scheme from the URI provided to ipptool (8).

5 $uri Inserts the URI provided to ipptool (8).

5 $uriuser Inserts the username from the URI provided to ipptool (8), if any.

5 $user Inserts the current user's login name.

ipptool (1), CUPS Online Help (http://localhost:631/help), IANA IPP Registry (http://www.iana.org/assignments/ipp-registrations), PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp), RFC 2911 (http://tools.ietf.org/html/rfc3911) Copyright \[co] 2007-2014 by Apple Inc.
End of "$Id: ipptoolfile.man 11934 2014-06-17 18:58:29Z msweet $".