doc/help/man-ipptoolfile.html

   1 <!DOCTYPE HTML>
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>ipptoolfile(5)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">ipptoolfile(5)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 ipptoolfile - ipptool file format
  12 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  13 The
  14 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a>
  15 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:
  16 <pre class="man">
  17
  18     # This is a comment
  19     {
  20       # The name of the test
  21       NAME "Print PostScript File"
  22
  23       # The request to send
  24       OPERATION Print-Job
  25       GROUP operation-attributes-tag
  26       ATTR charset attributes-charset utf-8
  27       ATTR language attributes-natural-language en
  28       ATTR uri printer-uri $uri
  29       ATTR name requesting-user-name $user
  30       FILE testfile.ps
  31
  32       # The response to expect
  33       STATUS successful-ok
  34       EXPECT job-id OF-TYPE integer WITH-VALUE >0
  35       EXPECT job-uri OF-TYPE uri
  36     }
  37     {
  38       # The name of the test
  39       NAME "Get Attributes of PostScript Job"
  40
  41       # The request to send
  42       OPERATION Get-Job-Attributes
  43       GROUP operation-attributes-tag
  44       ATTR charset attributes-charset utf-8
  45       ATTR language attributes-natural-language en
  46       ATTR uri printer-uri $uri
  47       ATTR integer job-id $job-id
  48       ATTR name requesting-user-name $user
  49
  50       # The response to expect
  51       STATUS successful-ok
  52       EXPECT job-id OF-TYPE integer WITH-VALUE $job-id
  53       EXPECT job-uri OF-TYPE uri
  54       EXPECT job-state OF-TYPE enum WITH-VALUE 3,4,5,6,7,8,9
  55       EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user"
  56     }
  57 </pre>
  58 <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
  59 The following directives can be used outside of a <i>test</i>:
  60 <dl class="man">
  61 <dt><b>{ </b><i>test </i><b>}</b>
  62 <dd style="margin-left: 5.0em">Defines a test.
  63 <dt><b>DEFINE </b><i>variable-name value</i>
  64 <dd style="margin-left: 5.0em">Defines the named variable to the given value. This is equivalent to specifying <i>-d variable-name=value</i> on the
  65 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
  66 command-line.
  67 <dt><b>DEFINE-DEFAULT </b><i>variable-name value</i>
  68 <dd style="margin-left: 5.0em">Defines the named variable to the given value if it does not already have a value.
  69 <dt><b>FILE-ID "</b><i>identifier</i><b>"</b>
  70 <dd style="margin-left: 5.0em">Specifies an identifier string for the current file.
  71 <dt><b>IGNORE-ERRORS yes</b>
  72 <dd style="margin-left: 5.0em"><dt><b>IGNORE-ERRORS no</b>
  73 <dd style="margin-left: 5.0em">Specifies whether, by default,
  74 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
  75 will ignore errors and continue with subsequent tests.
  76 <dt><b>INCLUDE "</b><i>filename</i><b>"</b>
  77 <dd style="margin-left: 5.0em"><dt><b>INCLUDE &lt;</b><i>filename</i><b>></b>
  78 <dd style="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
  79 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
  80 include directory.
  81 <dt><b>INCLUDE-IF-DEFINED </b><i>name </i><b>"</b><i>filename</i><b>"</b>
  82 <dd style="margin-left: 5.0em"><dt><b>INCLUDE-IF-DEFINED </b><i>name </i><b>&lt;</b><i>filename</i><b>></b>
  83 <dd style="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
  84 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
  85 include directory.
  86 <dt><b>INCLUDE-IF-NOT-DEFINED </b><i>name </i><b>"</b><i>filename</i><b>"</b>
  87 <dd style="margin-left: 5.0em"><dt><b>INCLUDE-IF-NOT-DEFINED </b><i>name </i><b>&lt;</b><i>filename</i><b>></b>
  88 <dd style="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
  89 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
  90 include directory.
  91 <dt><b>SKIP-IF-DEFINED </b><i>variable-name</i>
  92 <dd style="margin-left: 5.0em"><dt><b>SKIP-IF-NOT-DEFINED </b><i>variable-name</i>
  93 <dd style="margin-left: 5.0em">Specifies that the remainder of the test file should be skipped when the variable is or is not defined.
  94 <dt><b>STOP-AFTER-INCLUDE-ERROR no</b>
  95 <dd style="margin-left: 5.0em"><dt><b>STOP-AFTER-INCLUDE-ERROR yes</b>
  96 <dd style="margin-left: 5.0em">Specifies whether tests will be stopped after an error in an included file.
  97 <dt><b>TRANSFER auto</b>
  98 <dd style="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.
  99 <dt><b>TRANSFER chunked</b>
 100 <dd style="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
 101 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 102 command-line. Support for chunked requests is required for conformance with all versions of IPP.
 103 <dt><b>TRANSFER length</b>
 104 <dd style="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
 105 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 106 command-line. Support for content length requests is required for conformance with all versions of IPP.
 107 <dt><b>VERSION 1.0</b>
 108 <dd style="margin-left: 5.0em"><dt><b>VERSION 1.1</b>
 109 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.0</b>
 110 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.1</b>
 111 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.2</b>
 112 <dd style="margin-left: 5.0em">Specifies the default IPP version number to use for the tests that follow.
 113 </dl>
 114 <h3><a name="TEST_DIRECTIVES">Test Directives</a></h3>
 115 The following directives are understood within a <i>test</i>:
 116 <dl class="man">
 117 <dt><b>ATTR </b><i>tag attribute-name value(s)</i>
 118 <dd style="margin-left: 5.0em">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.
 119 <dt><b>ATTR collection </b><i>attribute-name </i><b>{ MEMBER </b><i>tag member-name value(s) ... </i><b>}</b> [ <i>... </i><b>,{ </b><i>... </i><b>} </b>]
 120 <dd style="margin-left: 5.0em">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.
 121 <dt><b>COMPRESSION deflate</b>
 122 <dd style="margin-left: 5.0em"><dt><b>COMPRESSION gzip</b>
 123 <dd style="margin-left: 5.0em"><dt><b>COMPRESSION none</b>
 124 <dd style="margin-left: 5.0em">Uses the specified compression on the document data following the attributes in a Print-Job or Send-Document request.
 125 <dt><b>DELAY </b><i>seconds</i>
 126 <dd style="margin-left: 5.0em">Specifies a delay before this test will be run.
 127 <dt><b>DISPLAY </b><i>attribute-name</i>
 128 <dd style="margin-left: 5.0em">Specifies that value of the named attribute should be output as part of the
 129 test report.
 130 <dt><b>EXPECT </b><i>attribute-name </i>[ <i>predicate(s) </i>]
 131 <dd style="margin-left: 5.0em"><dt><b>EXPECT ?</b><i>attribute-name predicate(s)</i>
 132 <dd style="margin-left: 5.0em"><dt><b>EXPECT !</b><i>attribute-name</i>
 133 <dd style="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".
 134 <dt><b>EXPECT-ALL </b><i>attribute-name </i>[ <i>predicate(s) </i>]
 135 <dd style="margin-left: 5.0em"><dt><b>EXPECT-ALL ?</b><i>attribute-name predicate(s)</i>
 136 <dd style="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.
 137 <dt><b>FILE filename</b>
 138 <dd style="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.
 139 <dt><b>GROUP tag</b>
 140 <dd style="margin-left: 5.0em">Specifies the group tag for subsequent attributes in the request.
 141 <dt><b>IGNORE-ERRORS yes</b>
 142 <dd style="margin-left: 5.0em"><dt><b>IGNORE-ERRORS no</b>
 143 <dd style="margin-left: 5.0em">Specifies whether
 144 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 145 will ignore errors and continue with subsequent tests.
 146 <dt><b>NAME "</b><i>literal string</i><b>"</b>
 147 <dd style="margin-left: 5.0em">Specifies the human-readable name of the test.
 148 <dt><b>OPERATION </b><i>operation-code</i>
 149 <dd style="margin-left: 5.0em">Specifies the operation to be performed.
 150 <dt><b>PAUSE "</b><i>message</i><b>"</b>
 151 <dd style="margin-left: 5.0em">Displays the provided message and waits for the user to press a key to continue.
 152 <dt><b>REQUEST-ID </b><i>number</i>
 153 <dd style="margin-left: 5.0em"><dt><b>REQUEST-ID random</b>
 154 <dd style="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).
 155 <dt><b>RESOURCE </b><i>path</i>
 156 <dd style="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
 157 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 158 program.
 159 <dt><b>SKIP-IF-DEFINED </b><i>variable-name</i>
 160 <dd style="margin-left: 5.0em"><dt><b>SKIP-IF-NOT-DEFINED </b><i>variable-name</i>
 161 <dd style="margin-left: 5.0em">Specifies that the current test should be skipped when the variable is or is not defined.
 162 <dt><b>SKIP-PREVIOUS-ERROR yes</b>
 163 <dd style="margin-left: 5.0em"><dt><b>SKIP-PREVIOUS-ERROR no</b>
 164 <dd style="margin-left: 5.0em">Specifies whether
 165 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 166 will skip the current test if the previous test resulted in an error/failure.
 167 <dt><b>STATUS </b><i>status-code </i>[ <i>predicate</i> ]
 168 <dd style="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.
 169 <dt><b>TEST-ID "</b><i>identifier</i>"
 170 <dd style="margin-left: 5.0em">Specifies an identifier string for the current test.
 171 <dt><b>TRANSFER auto</b>
 172 <dd style="margin-left: 5.0em">Specifies that this test will use "Transfer-Encoding: chunked" if it has an attached file or "Content-Length:" otherwise.
 173 <dt><b>TRANSFER chunked</b>
 174 <dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header.
 175 <dt><b>TRANSFER length</b>
 176 <dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
 177 <dt><b>VERSION 1.0</b>
 178 <dd style="margin-left: 5.0em"><dt><b>VERSION 1.1</b>
 179 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.0</b>
 180 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.1</b>
 181 <dd style="margin-left: 5.0em"><dt><b>VERSION 2.2</b>
 182 <dd style="margin-left: 5.0em">Specifies the IPP version number to use for this test.
 183 </dl>
 184 <h3><a name="EXPECT_PREDICATES">Expect Predicates</a></h3>
 185 The following predicates are understood following the <b>EXPECT</b> test directive:
 186 <dl class="man">
 187 <dt><b>COUNT </b><i>number</i>
 188 <dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to have the specified number of values.
 189 <dt><b>DEFINE-MATCH </b><i>variable-name</i>
 190 <dd style="margin-left: 5.0em">Defines the variable to "1" when the <b>EXPECT</b> condition matches. A side-effect of this predicate is that this <b>EXPECT</b> will never fail a test.
 191 <dt><b>DEFINE-NO-MATCH </b><i>variable-name</i>
 192 <dd style="margin-left: 5.0em">Defines the variable to "1" when the <b>EXPECT</b> condition does not match. A side-effect of this predicate is that this <b>EXPECT</b> will never fail a test.
 193 <dt><b>DEFINE-VALUE </b><i>variable-name</i>
 194 <dd style="margin-left: 5.0em">Defines the variable to the value of the attribute when the <b>EXPECT</b> condition matches. A side-effect of this predicate is that this <b>EXPECT</b> will never fail a test.
 195 <dt><b>IF-DEFINED </b><i>variable-name</i>
 196 <dd style="margin-left: 5.0em">Makes the <b>EXPECT</b> conditions apply only if the specified variable is defined.
 197 <dt><b>IF-NOT-DEFINED </b><i>variable-name</i>
 198 <dd style="margin-left: 5.0em">Makes the <b>EXPECT</b> conditions apply only if the specified variable is not defined.
 199 <dt><b>IN-GROUP </b><i>tag</i>
 200 <dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to be in the specified group tag.
 201 <dt><b>OF-TYPE </b><i>tag[,tag,...]</i>
 202 <dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to use one of the specified value tag(s).
 203 <dt><b>REPEAT-LIMIT </b><i>number</i>
 204 <dd style="margin-left: 5.0em"><br>
 205 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.
 206 <dt><b>REPEAT-MATCH</b>
 207 <dd style="margin-left: 5.0em"><dt><b>REPEAT-NO-MATCH</b>
 208 <dd style="margin-left: 5.0em">Specifies that the current test should be repeated when the <b>EXPECT</b> condition matches or does not match.
 209 <dt><b>SAME-COUNT-AS </b><i>attribute-name</i>
 210 <dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to have the same number of values as the specified parallel attribute.
 211 <dt><b>WITH-ALL-HOSTNAMES "</b><i>literal string</i><b>"</b>
 212 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-HOSTNAMES "/</b><i>regular expression</i><b>/"</b>
 213 <dd style="margin-left: 5.0em">Requires that all URI values contain a matching hostname.
 214 <dt><b>WITH-ALL-RESOURCES "</b><i>literal string</i><b>"</b>
 215 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-RESOURCES "/</b><i>regular expression</i><b>/"</b>
 216 <dd style="margin-left: 5.0em">Requires that all URI values contain a matching resource (including leading /).
 217 <dt><b>WITH-ALL-SCHEMES "</b><i>literal string</i><b>"</b>
 218 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-SCHEMES "/</b><i>regular expression</i><b>/"</b>
 219 <dd style="margin-left: 5.0em">Requires that all URI values contain a matching scheme.
 220 <dt><b>WITH-ALL-VALUES "</b><i>literal string</i><b>"</b>
 221 <dd style="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the literal string. Comparisons are case-sensitive.
 222 <dt><b>WITH-ALL-VALUES &lt;</b><i>number</i>
 223 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES =</b><i>number</i>
 224 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES ></b><i>number</i>
 225 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES </b><i>number</i>[<i>,...,number</i>]
 226 <dd style="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 "&lt;" and ">" operators only check the upper bound of the range.
 227 <dt><b>WITH-ALL-VALUES "false"</b>
 228 <dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES "true"</b>
 229 <dd style="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the boolean value given.
 230 <dt><b>WITH-ALL-VALUES "/</b><i>regular expression</i><b>/"</b>
 231 <dd style="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.
 232 <dt><b>WITH-HOSTNAME "</b><i>literal string</i><b>"</b>
 233 <dd style="margin-left: 5.0em"><dt><b>WITH-HOSTNAME "/</b><i>regular expression</i><b>/"</b>
 234 <dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching hostname.
 235 <dt><b>WITH-RESOURCE "</b><i>literal string</i><b>"</b>
 236 <dd style="margin-left: 5.0em"><dt><b>WITH-RESOURCE "/</b><i>regular expression</i><b>/"</b>
 237 <dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching resource (including leading /).
 238 <dt><b>WITH-SCHEME "</b><i>literal string</i><b>"</b>
 239 <dd style="margin-left: 5.0em"><dt><b>WITH-SCHEME "/</b><i>regular expression</i><b>/"</b>
 240 <dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching scheme.
 241 <dt><b>WITH-VALUE "</b><i>literal string</i><b>"</b>
 242 <dd style="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the literal string. Comparisons are case-sensitive.
 243 <dt><b>WITH-VALUE &lt;</b><i>number</i>
 244 <dd style="margin-left: 5.0em"><dt><b>WITH-VALUE =</b><i>number</i>
 245 <dd style="margin-left: 5.0em"><dt><b>WITH-VALUE ></b><i>number</i>
 246 <dd style="margin-left: 5.0em"><dt><b>WITH-VALUE </b><i>number</i>[<i>,...,number</i>]
 247 <dd style="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 "&lt;" and ">" operators only check the upper bound of the range.
 248 <dt><b>WITH-VALUE "false"</b>
 249 <dd style="margin-left: 5.0em"><dt><b>WITH-VALUE "true"</b>
 250 <dd style="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the boolean value given.
 251 <dt><b>WITH-VALUE "/</b><i>regular expression</i><b>/"</b>
 252 <dd style="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.
 253 </dl>
 254 <h3><a name="STATUS_PREDICATES">Status Predicates</a></h3>
 255 The following predicates are understood following the <b>STATUS</b> test directive:
 256 <dl class="man">
 257 <dt><b>DEFINE-MATCH </b><i>variable-name</i>
 258 <dd style="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.
 259 <dt><b>DEFINE-NO-MATCH </b><i>variable-name</i>
 260 <dd style="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.
 261 <dt><b>IF-DEFINED </b><i>variable-name</i>
 262 <dd style="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is defined.
 263 <dt><b>IF-NOT-DEFINED </b><i>variable-name</i>
 264 <dd style="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is not defined.
 265 <dt><b>REPEAT-LIMIT </b><i>number</i>
 266 <dd style="margin-left: 5.0em"><br>
 267 Specifies the maximum number of times to repeat. The default value is 1000.
 268 <dt><b>REPEAT-MATCH</b>
 269 <dd style="margin-left: 5.0em"><dt><b>REPEAT-NO-MATCH</b>
 270 <dd style="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.
 271 </dl>
 272 <h3><a name="OPERATION_CODES">Operation Codes</a></h3>
 273 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
 274 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a>
 275 <pre class="man">
 276
 277     Activate-Printer
 278     CUPS-Accept-Jobs
 279     CUPS-Add-Modify-Class
 280     CUPS-Add-Modify-Printer
 281     CUPS-Authenticate-Job
 282     CUPS-Delete-Class
 283     CUPS-Delete-Printer
 284     CUPS-Get-Classes
 285     CUPS-Get-Default
 286     CUPS-Get-Devices
 287     CUPS-Get-Document
 288     CUPS-Get-PPD
 289     CUPS-Get-PPDs
 290     CUPS-Get-Printers
 291     CUPS-Move-Job
 292     CUPS-Reject-Jobs
 293     CUPS-Set-Default
 294     Cancel-Current-Job
 295     Cancel-Job
 296     Cancel-Jobs
 297     Cancel-My-Jobs
 298     Cancel-Subscription
 299     Close-Job
 300     Create-Job
 301     Create-Job-Subscriptions
 302     Create-Printer-Subscriptions
 303     Deactivate-Printer
 304     Disable-Printer
 305     Enable-Printer
 306     Get-Job-Attributes
 307     Get-Jobs
 308     Get-Notifications
 309     Get-Printer-Attributes
 310     Get-Printer-Support-Files
 311     Get-Printer-Supported-Values
 312     Get-Subscription-Attributes
 313     Get-Subscriptions
 314     Hold-Job
 315     Hold-New-Jobs
 316     Identify-Printer
 317     Pause-Printer
 318     Pause-Printer-After-Current-Job
 319     Print-Job
 320     Print-URI
 321     Promote-Job
 322     Purge-Jobs
 323     Release-Held-New-Jobs
 324     Release-Job
 325     Renew-Subscription
 326     Reprocess-Job
 327     Restart-Job
 328     Restart-Printer
 329     Resubmit-Job
 330     Resume-Job
 331     Resume-Printer
 332     Schedule-Job-After
 333     Send-Document
 334     Send-Hardcopy-Document
 335     Send-Notifications
 336     Send-URI
 337     Set-Job-Attributes
 338     Set-Printer-Attributes
 339     Shutdown-Printer
 340     Startup-Printer
 341     Suspend-Current-Job
 342     Validate-Document
 343     Validate-Job
 344 </pre>
 345 <h3><a name="STATUS_CODES">Status Codes</a></h3>
 346 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
 347 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a>
 348 <pre class="man">
 349
 350     client-error-account-authorization-failed
 351     client-error-account-closed
 352     client-error-account-info-needed
 353     client-error-account-limit-reached
 354     client-error-attributes-not-settable
 355     client-error-attributes-or-values-not-supported
 356     client-error-bad-request
 357     client-error-charset-not-supported
 358     client-error-compression-error
 359     client-error-compression-not-supported
 360     client-error-conflicting-attributes
 361     client-error-document-access-error
 362     client-error-document-format-error
 363     client-error-document-format-not-supported
 364     client-error-document-password-error
 365     client-error-document-permission-error
 366     client-error-document-security-error
 367     client-error-document-unprintable-error
 368     client-error-forbidden
 369     client-error-gone
 370     client-error-ignored-all-notifications
 371     client-error-ignored-all-subscriptions
 372     client-error-not-authenticated
 373     client-error-not-authorized
 374     client-error-not-found
 375     client-error-not-possible
 376     client-error-print-support-file-not-found
 377     client-error-request-entity-too-large
 378     client-error-request-value-too-long
 379     client-error-timeout
 380     client-error-too-many-subscriptions
 381     client-error-uri-scheme-not-supported
 382     cups-error-account-authorization-failed
 383     cups-error-account-closed
 384     cups-error-account-info-needed
 385     cups-error-account-limit-reached
 386     cups-see-other
 387     redirection-other-site
 388     server-error-busy
 389     server-error-device-error
 390     server-error-internal-error
 391     server-error-job-canceled
 392     server-error-multiple-document-jobs-not-supported
 393     server-error-not-accepting-jobs
 394     server-error-operation-not-supported
 395     server-error-printer-is-deactivated
 396     server-error-service-unavailable
 397     server-error-temporary-error
 398     server-error-version-not-supported
 399     successful-ok
 400     successful-ok-but-cancel-subscription
 401     successful-ok-conflicting-attributes
 402     successful-ok-events-complete
 403     successful-ok-ignored-notifications
 404     successful-ok-ignored-or-substituted-attributes
 405     successful-ok-ignored-subscriptions
 406     successful-ok-too-many-events
 407 </pre>
 408 <h3><a name="TAGS">Tags</a></h3>
 409 Value and group tags correspond to the names from RFC 2911 and other IPP extension specifications. Here are the group tags:
 410 <pre class="man">
 411
 412     document-attributes-tag
 413     event-notification-attributes-tag
 414     job-attributes-tag
 415     operation-attributes-tag
 416     printer-attributes-tag
 417     subscription-attributes-tag
 418     unsupported-attributes-tag
 419 </pre>
 420 <p>Here are the value tags:
 421 <pre class="man">
 422
 423     admin-define
 424     boolean
 425     charset
 426     collection
 427     dateTime
 428     default
 429     delete-attribute
 430     enum
 431     integer
 432     keyword
 433     mimeMediaType
 434     nameWithLanguage
 435     nameWithoutLanguage
 436     naturalLanguage
 437     no-value
 438     not-settable
 439     octetString
 440     rangeOfInteger
 441     resolution
 442     textWithLanguage
 443     textWithoutLanguage
 444     unknown
 445     unsupported
 446     uri
 447     uriScheme
 448 </pre>
 449 <h3><a name="VARIABLES">Variables</a></h3>
 450 The
 451 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 452 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:
 453 <dl class="man">
 454 <dt><b>$$</b>
 455 <dd style="margin-left: 5.0em">Inserts a single "$" character.
 456 <dt><b>$ENV[</b><i>name</i><b>]</b>
 457 <dd style="margin-left: 5.0em">Inserts the value of the named environment variable, or an empty string if the environment variable is not defined.
 458 <dt><b>$filename</b>
 459 <dd style="margin-left: 5.0em">Inserts the filename provided to
 460 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 461 with the <i>-f</i> option.
 462 <dt><b>$filetype</b>
 463 <dd style="margin-left: 5.0em">Inserts the MIME media type for the filename provided to
 464 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a>
 465 with the <i>-f</i> option.
 466 <dt><b>$hostname</b>
 467 <dd style="margin-left: 5.0em">Inserts the hostname from the URI provided to
 468 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a>
 469 <dt><b>$job-id</b>
 470 <dd style="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.
 471 <dt><b>$job-uri</b>
 472 <dd style="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.
 473 <dt><b>$notify-subscription-id</b>
 474 <dd style="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.
 475 <dt><b>$port</b>
 476 <dd style="margin-left: 5.0em">Inserts the port number from the URI provided to
 477 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a>
 478 <dt><b>$resource</b>
 479 <dd style="margin-left: 5.0em">Inserts the resource path from the URI provided to
 480 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a>
 481 <dt><b>$scheme</b>
 482 <dd style="margin-left: 5.0em">Inserts the scheme from the URI provided to
 483 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a>
 484 <dt><b>$uri</b>
 485 <dd style="margin-left: 5.0em">Inserts the URI provided to
 486 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a>
 487 <dt><b>$uriuser</b>
 488 <dd style="margin-left: 5.0em">Inserts the username from the URI provided to
 489 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8),</a>
 490 if any.
 491 <dt><b>$user</b>
 492 <dd style="margin-left: 5.0em">Inserts the current user's login name.
 493 </dl>
 494 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 495 <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1),</a>
 496 CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
 497 IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp-registrations)">http://www.iana.org/assignments/ipp-registrations)</a>,
 498 PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</a>,
 499 RFC 2911 (<a href="http://tools.ietf.org/html/rfc3911">http://tools.ietf.org/html/rfc3911</a>)
 500 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 501 Copyright &copy; 2007-2015 by Apple Inc.
 502
 503 </body>
 504 </html>