]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-ipptoolfile.html
Import CUPS v1.7.2
[thirdparty/cups.git] / doc / help / man-ipptoolfile.html
index 645fd4a1f6a8113e142604cefb1a88bb3b66acd7..ce64e2550c089848fa9f49c362071d2f20f07498 100644 (file)
@@ -11,7 +11,7 @@
 ipptoolfile - ipptool file format
 
 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-The <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a> 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 curley braces, for example:
+The <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a> 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:
 <pre>
 
     # This is a comment
@@ -76,6 +76,10 @@ The following directives can be used outside of a test:
 <dd>Defines the named variable to the given value if it does not already have a
 value.
 </dd>
+<dt>FILE-ID "identifier"
+</dt>
+<dd>Specifies an identifier string for the current file.
+</dd>
 <dt>IGNORE-ERRORS yes
 </dt>
 <dd></dd>
@@ -119,6 +123,13 @@ includes a file from the <i>ipptool</i> include directory.
 <dd>Specifies that the remainder of the test file should be skipped when the
 variable is or is not defined.
 </dd>
+<dt>STOP-AFTER-INCLUDE-ERROR no
+</dt>
+<dd></dd>
+<dt>STOP-AFTER-INCLUDE-ERROR yes
+</dt>
+<dd>Specifies whether tests will be stopped after an error in an included file.
+</dd>
 <dt>TRANSFER auto
 </dt>
 <dd>Specifies that tests will, by default, use "Transfer-Encoding: chunked" for
@@ -163,7 +174,7 @@ The following directives are understood in a test:
 <dt>ATTR tag attribute-name value(s)
 </dt>
 <dd>Adds an attribute to the test request. Values are separated by the comma (",")
-character - escape commas using the "" character.
+character - escape commas using the "" character. Common attributes and values are listed in the IANA IPP registry - see references below.
 </dd>
 <dt>ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ]
 </dt>
@@ -171,6 +182,18 @@ character - escape commas using the "" character.
 same syntax as regular attributes and can themselves be nested collections.
 Multiple collection values can be supplied as needed.
 </dd>
+<dt>COMPRESSION deflate
+</dt>
+<dd></dd>
+<dt>COMPRESSION gzip
+</dt>
+<dd></dd>
+<dt>COMPRESSION none
+</dt>
+<dd></dd>
+<dd>Uses the specified compression on the document data following the attributes in
+a Print-Job or Send-Document request.
+</dd>
 <dt>DELAY seconds
 </dt>
 <dd>Specifies a delay before this test will be run.
@@ -252,6 +275,10 @@ resulted in an error/failure.
 added as predicates - see the "STATUS PREDICATES" section for more information
 on predicates.
 </dd>
+<dt>TEST-ID "identifier"
+</dt>
+<dd>Specifies an identifier string for the current test.
+</dd>
 <dt>TRANSFER auto
 </dt>
 <dd>Specifies that this test will use "Transfer-Encoding: chunked" if it has an
@@ -341,6 +368,27 @@ matches or does not match.
 <dd>Requires the EXPECT attribute to have the same number of values as the specified
 parallel attribute.
 </dd>
+<dt>WITH-ALL-HOSTNAMES "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-ALL-HOSTNAMES "/regular expression/"
+</dt>
+<dd>Requires that all URI values contain a matching hostname.
+</dd>
+<dt>WITH-ALL-RESOURCES "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-ALL-RESOURCES "/regular expression/"
+</dt>
+<dd>Requires that all URI values contain a matching resource (including leading /).
+</dd>
+<dt>WITH-ALL-SCHEMES "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-ALL-SCHEMES "/regular expression/"
+</dt>
+<dd>Requires that all URI values contain a matching scheme.
+</dd>
 <dt>WITH-ALL-VALUES "literal string"
 </dt>
 <dd>Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.
@@ -369,6 +417,27 @@ parallel attribute.
 </dt>
 <dd>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.
 </dd>
+<dt>WITH-HOSTNAME "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-HOSTNAME "/regular expression/"
+</dt>
+<dd>Requires that at least one URI value contains a matching hostname.
+</dd>
+<dt>WITH-RESOURCE "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-RESOURCE "/regular expression/"
+</dt>
+<dd>Requires that at least one URI value contains a matching resource (including leading /).
+</dd>
+<dt>WITH-SCHEME "literal string"
+</dt>
+<dd></dd>
+<dt>WITH-SCHEME "/regular expression/"
+</dt>
+<dd>Requires that at least one URI value contains a matching scheme.
+</dd>
 <dt>WITH-VALUE "literal string"
 </dt>
 <dd>Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.
@@ -402,6 +471,14 @@ parallel attribute.
 <h2 class="title"><a name="STATUS_PREDICATES">Status Predicates</a></h2>
 The following predicates are understood following the STATUS test directive:
 <dl>
+<dt>DEFINE-MATCH variable-name
+</dt>
+<dd>Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test.
+</dd>
+<dt>DEFINE-NO-MATCH variable-name
+</dt>
+<dd>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.
+</dd>
 <dt>IF-DEFINED variable-name
 </dt>
 <dd>Makes the STATUS apply only if the specified variable is defined.
@@ -453,8 +530,8 @@ RFC 2911 and other IPP extension specifications. Here is a complete list:
     Cancel-Subscription
     Close-Job
     Create-Job
-    Create-Job-Subscription
-    Create-Printer-Subscription
+    Create-Job-Subscriptions
+    Create-Printer-Subscriptions
     Deactivate-Printer
     Disable-Printer
     Enable-Printer
@@ -486,6 +563,7 @@ RFC 2911 and other IPP extension specifications. Here is a complete list:
     Resume-Printer
     Schedule-Job-After
     Send-Document
+    Send-Hardcopy-Document
     Send-Notifications
     Send-URI
     Set-Job-Attributes
@@ -631,7 +709,7 @@ no job-uri has been seen.
 </dd>
 <dt>$notify-subscription-id
 </dt>
-<dd>Inserts the last notify-subscription-id value returnd in a test response or 0 if
+<dd>Inserts the last notify-subscription-id value returned in a test response or 0 if
 no notify-subscription-id has been seen.
 </dd>
 <dt>$port
@@ -657,12 +735,15 @@ no notify-subscription-id has been seen.
 </dd>
 </dl>
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a>,
+<a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a>, RFC 2911,
 <br>
 <a href='http://localhost:631/help'>http://localhost:631/help</a>
-
+<br>
+<a href='http://www.iana.org/assignments/ipp-registrations'>http://www.iana.org/assignments/ipp-registrations</a>
+<br>
+<a href='http://www.pwg.org/ipp'>http://www.pwg.org/ipp</a>
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
-Copyright 2007-2012 by Apple Inc.
+Copyright 2007-2014 by Apple Inc.
 
 </body>
 </html>