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> 11ipptoolfile - ipptool file format 12<h2 class="title"><a name="DESCRIPTION">Description</a></h2> 13The 14<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a> 15program 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> 59The 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> 66command-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> 75will 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 <</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> 80include 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><</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> 85include 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><</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> 90include 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> 102command-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> 106command-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> 115The 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 129test 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>FILE filename</b> 135<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. 136<dt><b>GROUP tag</b> 137<dd style="margin-left: 5.0em">Specifies the group tag for subsequent attributes in the request. 138<dt><b>IGNORE-ERRORS yes</b> 139<dd style="margin-left: 5.0em"><dt><b>IGNORE-ERRORS no</b> 140<dd style="margin-left: 5.0em">Specifies whether 141<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 142will ignore errors and continue with subsequent tests. 143<dt><b>NAME "</b><i>literal string</i><b>"</b> 144<dd style="margin-left: 5.0em">Specifies the human-readable name of the test. 145<dt><b>OPERATION </b><i>operation-code</i> 146<dd style="margin-left: 5.0em">Specifies the operation to be performed. 147<dt><b>PAUSE "</b><i>message</i><b>"</b> 148<dd style="margin-left: 5.0em">Displays the provided message and waits for the user to press a key to continue. 149<dt><b>REQUEST-ID </b><i>number</i> 150<dd style="margin-left: 5.0em"><dt><b>REQUEST-ID random</b> 151<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). 152<dt><b>RESOURCE </b><i>path</i> 153<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 154<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 155program. 156<dt><b>SKIP-IF-DEFINED </b><i>variable-name</i> 157<dd style="margin-left: 5.0em"><dt><b>SKIP-IF-NOT-DEFINED </b><i>variable-name</i> 158<dd style="margin-left: 5.0em">Specifies that the current test should be skipped when the variable is or is not defined. 159<dt><b>SKIP-PREVIOUS-ERROR yes</b> 160<dd style="margin-left: 5.0em"><dt><b>SKIP-PREVIOUS-ERROR no</b> 161<dd style="margin-left: 5.0em">Specifies whether 162<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 163will skip the current test if the previous test resulted in an error/failure. 164<dt><b>STATUS </b><i>status-code </i>[ <i>predicate</i> ] 165<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. 166<dt><b>TEST-ID "</b><i>identifier</i>" 167<dd style="margin-left: 5.0em">Specifies an identifier string for the current test. 168<dt><b>TRANSFER auto</b> 169<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. 170<dt><b>TRANSFER chunked</b> 171<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header. 172<dt><b>TRANSFER length</b> 173<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.0 "Content-Length:" header. 174<dt><b>VERSION 1.0</b> 175<dd style="margin-left: 5.0em"><dt><b>VERSION 1.1</b> 176<dd style="margin-left: 5.0em"><dt><b>VERSION 2.0</b> 177<dd style="margin-left: 5.0em"><dt><b>VERSION 2.1</b> 178<dd style="margin-left: 5.0em"><dt><b>VERSION 2.2</b> 179<dd style="margin-left: 5.0em">Specifies the IPP version number to use for this test. 180</dl> 181<h3><a name="EXPECT_PREDICATES">Expect Predicates</a></h3> 182The following predicates are understood following the <b>EXPECT</b> test directive: 183<dl class="man"> 184<dt><b>COUNT </b><i>number</i> 185<dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to have the specified number of values. 186<dt><b>DEFINE-MATCH </b><i>variable-name</i> 187<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. 188<dt><b>DEFINE-NO-MATCH </b><i>variable-name</i> 189<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. 190<dt><b>DEFINE-VALUE </b><i>variable-name</i> 191<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. 192<dt><b>IF-DEFINED </b><i>variable-name</i> 193<dd style="margin-left: 5.0em">Makes the <b>EXPECT</b> conditions apply only if the specified variable is defined. 194<dt><b>IF-NOT-DEFINED </b><i>variable-name</i> 195<dd style="margin-left: 5.0em">Makes the <b>EXPECT</b> conditions apply only if the specified variable is not defined. 196<dt><b>IN-GROUP </b><i>tag</i> 197<dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to be in the specified group tag. 198<dt><b>OF-TYPE </b><i>tag[,tag,...]</i> 199<dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to use one of the specified value tag(s). 200<dt><b>REPEAT-LIMIT </b><i>number</i> 201<dd style="margin-left: 5.0em"><br> 202Specifies 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. 203<dt><b>REPEAT-MATCH</b> 204<dd style="margin-left: 5.0em"><dt><b>REPEAT-NO-MATCH</b> 205<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. 206<dt><b>SAME-COUNT-AS </b><i>attribute-name</i> 207<dd style="margin-left: 5.0em">Requires the <b>EXPECT</b> attribute to have the same number of values as the specified parallel attribute. 208<dt><b>WITH-ALL-HOSTNAMES "</b><i>literal string</i><b>"</b> 209<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-HOSTNAMES "/</b><i>regular expression</i><b>/"</b> 210<dd style="margin-left: 5.0em">Requires that all URI values contain a matching hostname. 211<dt><b>WITH-ALL-RESOURCES "</b><i>literal string</i><b>"</b> 212<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-RESOURCES "/</b><i>regular expression</i><b>/"</b> 213<dd style="margin-left: 5.0em">Requires that all URI values contain a matching resource (including leading /). 214<dt><b>WITH-ALL-SCHEMES "</b><i>literal string</i><b>"</b> 215<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-SCHEMES "/</b><i>regular expression</i><b>/"</b> 216<dd style="margin-left: 5.0em">Requires that all URI values contain a matching scheme. 217<dt><b>WITH-ALL-VALUES "</b><i>literal string</i><b>"</b> 218<dd style="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the literal string. Comparisons are case-sensitive. 219<dt><b>WITH-ALL-VALUES <</b><i>number</i> 220<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES =</b><i>number</i> 221<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES ></b><i>number</i> 222<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES </b><i>number</i>[<i>,...,number</i>] 223<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 "<" and ">" operators only check the upper bound of the range. 224<dt><b>WITH-ALL-VALUES "false"</b> 225<dd style="margin-left: 5.0em"><dt><b>WITH-ALL-VALUES "true"</b> 226<dd style="margin-left: 5.0em">Requires that all values of the <b>EXPECT</b> attribute match the boolean value given. 227<dt><b>WITH-ALL-VALUES "/</b><i>regular expression</i><b>/"</b> 228<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. 229<dt><b>WITH-HOSTNAME "</b><i>literal string</i><b>"</b> 230<dd style="margin-left: 5.0em"><dt><b>WITH-HOSTNAME "/</b><i>regular expression</i><b>/"</b> 231<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching hostname. 232<dt><b>WITH-RESOURCE "</b><i>literal string</i><b>"</b> 233<dd style="margin-left: 5.0em"><dt><b>WITH-RESOURCE "/</b><i>regular expression</i><b>/"</b> 234<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching resource (including leading /). 235<dt><b>WITH-SCHEME "</b><i>literal string</i><b>"</b> 236<dd style="margin-left: 5.0em"><dt><b>WITH-SCHEME "/</b><i>regular expression</i><b>/"</b> 237<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching scheme. 238<dt><b>WITH-VALUE "</b><i>literal string</i><b>"</b> 239<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. 240<dt><b>WITH-VALUE <</b><i>number</i> 241<dd style="margin-left: 5.0em"><dt><b>WITH-VALUE =</b><i>number</i> 242<dd style="margin-left: 5.0em"><dt><b>WITH-VALUE ></b><i>number</i> 243<dd style="margin-left: 5.0em"><dt><b>WITH-VALUE </b><i>number</i>[<i>,...,number</i>] 244<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 "<" and ">" operators only check the upper bound of the range. 245<dt><b>WITH-VALUE "false"</b> 246<dd style="margin-left: 5.0em"><dt><b>WITH-VALUE "true"</b> 247<dd style="margin-left: 5.0em">Requires that at least one value of the <b>EXPECT</b> attribute matches the boolean value given. 248<dt><b>WITH-VALUE "/</b><i>regular expression</i><b>/"</b> 249<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. 250</dl> 251<h3><a name="STATUS_PREDICATES">Status Predicates</a></h3> 252The following predicates are understood following the <b>STATUS</b> test directive: 253<dl class="man"> 254<dt><b>DEFINE-MATCH </b><i>variable-name</i> 255<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. 256<dt><b>DEFINE-NO-MATCH </b><i>variable-name</i> 257<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. 258<dt><b>IF-DEFINED </b><i>variable-name</i> 259<dd style="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is defined. 260<dt><b>IF-NOT-DEFINED </b><i>variable-name</i> 261<dd style="margin-left: 5.0em">Makes the <b>STATUS</b> apply only if the specified variable is not defined. 262<dt><b>REPEAT-LIMIT </b><i>number</i> 263<dd style="margin-left: 5.0em"><br> 264Specifies the maximum number of times to repeat. The default value is 1000. 265<dt><b>REPEAT-MATCH</b> 266<dd style="margin-left: 5.0em"><dt><b>REPEAT-NO-MATCH</b> 267<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. 268</dl> 269<h3><a name="OPERATION_CODES">Operation Codes</a></h3> 270Operation 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 271<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a> 272<pre class="man"> 273 274 Activate-Printer 275 CUPS-Accept-Jobs 276 CUPS-Add-Modify-Class 277 CUPS-Add-Modify-Printer 278 CUPS-Authenticate-Job 279 CUPS-Delete-Class 280 CUPS-Delete-Printer 281 CUPS-Get-Classes 282 CUPS-Get-Default 283 CUPS-Get-Devices 284 CUPS-Get-Document 285 CUPS-Get-PPD 286 CUPS-Get-PPDs 287 CUPS-Get-Printers 288 CUPS-Move-Job 289 CUPS-Reject-Jobs 290 CUPS-Set-Default 291 Cancel-Current-Job 292 Cancel-Job 293 Cancel-Jobs 294 Cancel-My-Jobs 295 Cancel-Subscription 296 Close-Job 297 Create-Job 298 Create-Job-Subscriptions 299 Create-Printer-Subscriptions 300 Deactivate-Printer 301 Disable-Printer 302 Enable-Printer 303 Get-Job-Attributes 304 Get-Jobs 305 Get-Notifications 306 Get-Printer-Attributes 307 Get-Printer-Support-Files 308 Get-Printer-Supported-Values 309 Get-Subscription-Attributes 310 Get-Subscriptions 311 Hold-Job 312 Hold-New-Jobs 313 Identify-Printer 314 Pause-Printer 315 Pause-Printer-After-Current-Job 316 Print-Job 317 Print-URI 318 Promote-Job 319 Purge-Jobs 320 Release-Held-New-Jobs 321 Release-Job 322 Renew-Subscription 323 Reprocess-Job 324 Restart-Job 325 Restart-Printer 326 Resubmit-Job 327 Resume-Job 328 Resume-Printer 329 Schedule-Job-After 330 Send-Document 331 Send-Hardcopy-Document 332 Send-Notifications 333 Send-URI 334 Set-Job-Attributes 335 Set-Printer-Attributes 336 Shutdown-Printer 337 Startup-Printer 338 Suspend-Current-Job 339 Validate-Document 340 Validate-Job 341</pre> 342<h3><a name="STATUS_CODES">Status Codes</a></h3> 343Status 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 344<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8):</a> 345<pre class="man"> 346 347 client-error-account-authorization-failed 348 client-error-account-closed 349 client-error-account-info-needed 350 client-error-account-limit-reached 351 client-error-attributes-not-settable 352 client-error-attributes-or-values-not-supported 353 client-error-bad-request 354 client-error-charset-not-supported 355 client-error-compression-error 356 client-error-compression-not-supported 357 client-error-conflicting-attributes 358 client-error-document-access-error 359 client-error-document-format-error 360 client-error-document-format-not-supported 361 client-error-document-password-error 362 client-error-document-permission-error 363 client-error-document-security-error 364 client-error-document-unprintable-error 365 client-error-forbidden 366 client-error-gone 367 client-error-ignored-all-notifications 368 client-error-ignored-all-subscriptions 369 client-error-not-authenticated 370 client-error-not-authorized 371 client-error-not-found 372 client-error-not-possible 373 client-error-print-support-file-not-found 374 client-error-request-entity-too-large 375 client-error-request-value-too-long 376 client-error-timeout 377 client-error-too-many-subscriptions 378 client-error-uri-scheme-not-supported 379 cups-error-account-authorization-failed 380 cups-error-account-closed 381 cups-error-account-info-needed 382 cups-error-account-limit-reached 383 cups-see-other 384 redirection-other-site 385 server-error-busy 386 server-error-device-error 387 server-error-internal-error 388 server-error-job-canceled 389 server-error-multiple-document-jobs-not-supported 390 server-error-not-accepting-jobs 391 server-error-operation-not-supported 392 server-error-printer-is-deactivated 393 server-error-service-unavailable 394 server-error-temporary-error 395 server-error-version-not-supported 396 successful-ok 397 successful-ok-but-cancel-subscription 398 successful-ok-conflicting-attributes 399 successful-ok-events-complete 400 successful-ok-ignored-notifications 401 successful-ok-ignored-or-substituted-attributes 402 successful-ok-ignored-subscriptions 403 successful-ok-too-many-events 404</pre> 405<h3><a name="TAGS">Tags</a></h3> 406Value and group tags correspond to the names from RFC 2911 and other IPP extension specifications. Here are the group tags: 407<pre class="man"> 408 409 document-attributes-tag 410 event-notification-attributes-tag 411 job-attributes-tag 412 operation-attributes-tag 413 printer-attributes-tag 414 subscription-attributes-tag 415 unsupported-attributes-tag 416</pre> 417<p>Here are the value tags: 418<pre class="man"> 419 420 admin-define 421 boolean 422 charset 423 collection 424 dateTime 425 default 426 delete-attribute 427 enum 428 integer 429 keyword 430 mimeMediaType 431 nameWithLanguage 432 nameWithoutLanguage 433 naturalLanguage 434 no-value 435 not-settable 436 octetString 437 rangeOfInteger 438 resolution 439 textWithLanguage 440 textWithoutLanguage 441 unknown 442 unsupported 443 uri 444 uriScheme 445</pre> 446<h3><a name="VARIABLES">Variables</a></h3> 447The 448<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 449program 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: 450<dl class="man"> 451<dt><b>$$</b> 452<dd style="margin-left: 5.0em">Inserts a single "$" character. 453<dt><b>$ENV[</b><i>name</i><b>]</b> 454<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. 455<dt><b>$filename</b> 456<dd style="margin-left: 5.0em">Inserts the filename provided to 457<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 458with the <i>-f</i> option. 459<dt><b>$filetype</b> 460<dd style="margin-left: 5.0em">Inserts the MIME media type for the filename provided to 461<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8)</a> 462with the <i>-f</i> option. 463<dt><b>$hostname</b> 464<dd style="margin-left: 5.0em">Inserts the hostname from the URI provided to 465<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> 466<dt><b>$job-id</b> 467<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. 468<dt><b>$job-uri</b> 469<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. 470<dt><b>$notify-subscription-id</b> 471<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. 472<dt><b>$port</b> 473<dd style="margin-left: 5.0em">Inserts the port number from the URI provided to 474<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> 475<dt><b>$resource</b> 476<dd style="margin-left: 5.0em">Inserts the resource path from the URI provided to 477<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> 478<dt><b>$scheme</b> 479<dd style="margin-left: 5.0em">Inserts the scheme from the URI provided to 480<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> 481<dt><b>$uri</b> 482<dd style="margin-left: 5.0em">Inserts the URI provided to 483<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8).</a> 484<dt><b>$uriuser</b> 485<dd style="margin-left: 5.0em">Inserts the username from the URI provided to 486<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(8),</a> 487if any. 488<dt><b>$user</b> 489<dd style="margin-left: 5.0em">Inserts the current user's login name. 490</dl> 491<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> 492<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1),</a> 493CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, 494IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp-registrations)">http://www.iana.org/assignments/ipp-registrations)</a>, 495PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</a>, 496RFC 2911 (<a href="http://tools.ietf.org/html/rfc3911">http://tools.ietf.org/html/rfc3911</a>) 497<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> 498Copyright © 2007-2014 by Apple Inc. 499 500</body> 501</html> 502