<ddstyle="margin-left: 5.0em">Includes another test file. The first form includes a file relative to the current test file, while the second form includes a file from the
<ddstyle="margin-left: 5.0em">Includes another test file if the named variable is defined. The first form includes a file relative to the current test file, while the second form includes a file from the
<ddstyle="margin-left: 5.0em">Includes another test file if the named variable is not defined. The first form includes a file relative to the current test file, while the second form includes a file from the
<ddstyle="margin-left: 5.0em">Specifies whether tests will be stopped after an error in an included file.
<dt><b>TRANSFER auto</b>
<ddstyle="margin-left: 5.0em">Specifies that tests will, by default, use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
<dt><b>TRANSFER chunked</b>
<ddstyle="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: chunked" header. This is the default and is equivalent to specifying <i>-c</i> on the
<b>ipptool</b>(8)
command-line. Support for chunked requests is required for conformance with all versions of IPP.
<dt><b>TRANSFER length</b>
<ddstyle="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" header. This is equivalent to specifying <i>-l</i> on the
<b>ipptool</b>(8)
command-line. Support for content length requests is required for conformance with all versions of IPP.
<ddstyle="margin-left: 5.0em">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".
<ddstyle="margin-left: 5.0em">Specifies that the response must/may include the named attribute and that all occurrences of that attribute must match the given predicates.
<dt><b>FILE filename</b>
<ddstyle="margin-left: 5.0em">Specifies a file to include at the end of the request. This is typically used when sending a test print file.
<dt><b>GROUP tag</b>
<ddstyle="margin-left: 5.0em">Specifies the group tag for subsequent attributes in the request.
<ddstyle="margin-left: 5.0em">Specifies printer state monitoring tests to run in parallel with the test operation.
The monitoring tests will run until all of the <b>EXPECT</b> conditions are satisfied or the primary test operation has completed, whichever occurs first.
<ddstyle="margin-left: 5.0em">Specifies the request-id value to use in the request, either an integer or the word "random" to use a randomly generated value (the default).
<dt><b>RESOURCE </b><i>path</i>
<ddstyle="margin-left: 5.0em">Specifies an alternate resource path that is used for the HTTP POST request. The default is the resource from the URI provided to the
<ddstyle="margin-left: 5.0em">Specifies an expected response status-code value. Additional requirements can be added as predicates - see the "STATUS PREDICATES" section for more information on predicates.
<dt><b>TEST-ID "</b><i>identifier</i>"
<ddstyle="margin-left: 5.0em">Specifies an identifier string for the current test.
<dt><b>TRANSFER auto</b>
<ddstyle="margin-left: 5.0em">Specifies that this test will use "Transfer-Encoding: chunked" if it has an attached file or "Content-Length:" otherwise.
<dt><b>TRANSFER chunked</b>
<ddstyle="margin-left: 5.0em">Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header.
<dt><b>TRANSFER length</b>
<ddstyle="margin-left: 5.0em">Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
Most value tags also support the specification of limits in parenthesis, for example "name(42)" would allow nameWith/WithoutLanguage strings up to 42 octets in length, "name(4:MAX)" would allow nameWith/WithoutLanguage strings between 4 and 255 octets in length, and "integer(-273:MAX)" would allow integers between -273 and 2147483647.
Specifies the maximum number of times to repeat if the <b>REPEAT-MATCH</b> or <b>REPEAT-NO-MATCH</b> predicate is specified. The default value is 1000.
<ddstyle="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
<ddstyle="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the regular expression, which must conform to the POSIX regular expression syntax.
Comparisons are case-sensitive.
<dt><b>WITH-DISTINCT-VALUES</b>
<ddstyle="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute are unique.
Comparisons are case-sensitive.
Only charset, collection, enum, integer, keyword, mimeMediaType, naturalLanguage, rangeOfInteger, resolution, uriScheme attributes support this predicate.
<ddstyle="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the literal string. Comparisons are case-sensitive.
<ddstyle="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
<ddstyle="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
<dt><b>WITH-VALUE-FROM </b><i>attribute-name</i>
<ddstyle="margin-left: 5.0em">Requires that the value(s) of the <b>EXPECT</b> attribute matches the value(s) in the specified attribute.
For example, "EXPECT job-sheets WITH-VALUE-FROM job-sheets-supported" requires that the "job-sheets" value is listed as a value of the "job-sheets-supported" attribute.
The following predicates are understood following the <b>STATUS</b> test directive:
<dlclass="man">
<dt><b>DEFINE-MATCH </b><i>variable-name</i>
<ddstyle="margin-left: 5.0em">Defines the variable to "1" when the <b>STATUS</b> matches. A side-effect of this predicate is that this <b>STATUS</b> will never fail a test.
<dt><b>DEFINE-NO-MATCH </b><i>variable-name</i>
<ddstyle="margin-left: 5.0em">Defines the variable to "1" when the <b>STATUS</b> does not match. A side-effect of this predicate is that this <b>STATUS</b> will never fail a test.
<dt><b>IF-DEFINED </b><i>variable-name</i>
<ddstyle="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is defined.
<dt><b>IF-NOT-DEFINED </b><i>variable-name</i>
<ddstyle="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is not defined.
<dt><b>REPEAT-LIMIT </b><i>number</i>
<ddstyle="margin-left: 5.0em"><br>
Specifies the maximum number of times to repeat. The default value is 1000.
<ddstyle="margin-left: 5.0em">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 8011 and other IPP extension specifications. Here is a complete list of names supported by
Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of the names supported by
program maintains a list of variables that can be used in any literal string or attribute value by specifying "<i>$variable-name</i>". Aside from variables defined using the <i>-d</i> option or <b>DEFINE</b> directive, the following pre-defined variables are available:
<dlclass="man">
<dt><b>$$</b>
<ddstyle="margin-left: 5.0em">Inserts a single "$" character.
<dt><b>$ENV[</b><i>name</i><b>]</b>
<ddstyle="margin-left: 5.0em">Inserts the value of the named environment variable, or an empty string if the environment variable is not defined.
<dt><b>$date-current</b>
<ddstyle="margin-left: 5.0em">Inserts the current date and time using the ISO-8601 format ("yyyy-mm-ddThh:mm:ssZ").
<dt><b>$date-start</b>
<ddstyle="margin-left: 5.0em">Inserts the starting date and time using the ISO-8601 format ("yyyy-mm-ddThh:mm:ssZ").
<dt><b>$filename</b>
<ddstyle="margin-left: 5.0em">Inserts the filename provided to
<b>ipptool</b>(8)
with the <i>-f</i> option.
<dt><b>$filetype</b>
<ddstyle="margin-left: 5.0em">Inserts the MIME media type for the filename provided to
<b>ipptool</b>(8)
with the <i>-f</i> option.
<dt><b>$hostname</b>
<ddstyle="margin-left: 5.0em">Inserts the hostname from the URI provided to
<b>ipptool</b>(8).
<dt><b>$job-id</b>
<ddstyle="margin-left: 5.0em">Inserts the last "job-id" attribute value returned in a test response or 0 if no "job-id" attribute has been seen.
<dt><b>$job-uri</b>
<ddstyle="margin-left: 5.0em">Inserts the last "job-uri" attribute value returned in a test response or an empty string if no "job-uri" attribute has been seen.
<dt><b>$notify-subscription-id</b>
<ddstyle="margin-left: 5.0em">Inserts the last "notify-subscription-id" attribute value returned in a test response or 0 if no "notify-subscription-id" attribute has been seen.
<dt><b>$port</b>
<ddstyle="margin-left: 5.0em">Inserts the port number from the URI provided to
<b>ipptool</b>(8).
<dt><b>$resource</b>
<ddstyle="margin-left: 5.0em">Inserts the resource path from the URI provided to
<b>ipptool</b>(8).
<dt><b>$scheme</b>
<ddstyle="margin-left: 5.0em">Inserts the scheme from the URI provided to
<b>ipptool</b>(8).
<dt><b>$uri</b>
<ddstyle="margin-left: 5.0em">Inserts the URI provided to
<b>ipptool</b>(8).
<dt><b>$uriuser</b>
<ddstyle="margin-left: 5.0em">Inserts the username from the URI provided to
<b>ipptool</b>(8),
if any.
<dt><b>$user</b>
<ddstyle="margin-left: 5.0em">Inserts the current user's login name.
