doc/help/man-ipptoolfile.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   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
  13 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  14 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:
  15 <pre>
  16
  17     # This is a comment
  18     {
  19       # The name of the test
  20       NAME "Print PostScript Job"
  21
  22       # The request to send
  23       OPERATION Print-Job
  24       GROUP operation-attributes-tag
  25       ATTR charset attributes-charset utf-8
  26       ATTR language attributes-natural-language en
  27       ATTR uri printer-uri $uri
  28       ATTR name requesting-user-name $user
  29       FILE testfile.ps
  30
  31       # The response to expect
  32       STATUS successful-ok
  33       EXPECT attributes-charset OF-TYPE charset
  34       EXPECT attributes-natural-language OF-TYPE naturalLanguage
  35       EXPECT job-id OF-TYPE integer
  36       EXPECT job-uri OF-TYPE uri
  37     }
  38     {
  39       # The name of the test
  40       NAME "Get Attributes of PostScript Job"
  41
  42       # The request to send
  43       OPERATION Get-Job-Attributes
  44       GROUP operation-attributes-tag
  45       ATTR charset attributes-charset utf-8
  46       ATTR language attributes-natural-language en
  47       ATTR uri printer-uri $uri
  48       ATTR integer job-id $job-id
  49       ATTR name requesting-user-name $user
  50
  51       # The response to expect
  52       STATUS successful-ok
  53       EXPECT attributes-charset OF-TYPE charset
  54       EXPECT attributes-natural-language OF-TYPE naturalLanguage
  55       EXPECT job-id OF-TYPE integer
  56       EXPECT job-uri OF-TYPE uri
  57       EXPECT job-state OF-TYPE enum
  58       EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user"
  59     }
  60 </pre>
  61
  62 <h2 class="title"><a name="TOP-LEVEL_DIRECTIVES">Top-level Directives</a></h2>
  63 The following directives can be used outside of a test:
  64 <dl>
  65 <dt>{ test }
  66 </dt>
  67 <dd>Defines a test.
  68 </dd>
  69 <dt>DEFINE variable-name value
  70 </dt>
  71 <dd>Defines the named variable to the given value. This is equivalent to specifying
  72 "-d variable-name=value" on the <i>ipptool</i> command-line.
  73 </dd>
  74 <dt>DEFINE-DEFAULT variable-name value
  75 </dt>
  76 <dd>Defines the named variable to the given value if it does not already have a
  77 value.
  78 </dd>
  79 <dt>FILE-ID "identifier"
  80 </dt>
  81 <dd>Specifies an identifier string for the current file.
  82 </dd>
  83 <dt>IGNORE-ERRORS yes
  84 </dt>
  85 <dd></dd>
  86 <dt>IGNORE-ERRORS no
  87 </dt>
  88 <dd>Specifies whether, by default, <i>ipptool</i> will ignore errors and continue with
  89 subsequent tests.
  90 </dd>
  91 <dt>INCLUDE "filename"
  92 </dt>
  93 <dd></dd>
  94 <dt>INCLUDE &lt;filename>
  95 </dt>
  96 <dd>Includes another test file. The first form includes a file relative to the
  97 current test file, while the second form includes a file from the <i>ipptool</i>
  98 include directory.
  99 </dd>
 100 <dt>INCLUDE-IF-DEFINED name "filename"
 101 </dt>
 102 <dd></dd>
 103 <dt>INCLUDE-IF-DEFINED name &lt;filename>
 104 </dt>
 105 <dd>Includes another test file if the named variable is defined. The first form
 106 includes a file relative to the current test file, while the second form
 107 includes a file from the <i>ipptool</i> include directory.
 108 </dd>
 109 <dt>INCLUDE-IF-NOT-DEFINED name "filename"
 110 </dt>
 111 <dd></dd>
 112 <dt>INCLUDE-IF-NOT-DEFINED name &lt;filename>
 113 </dt>
 114 <dd>Includes another test file if the named variable is not defined. The first form
 115 includes a file relative to the current test file, while the second form
 116 includes a file from the <i>ipptool</i> include directory.
 117 </dd>
 118 <dt>SKIP-IF-DEFINED variable-name
 119 </dt>
 120 <dd></dd>
 121 <dt>SKIP-IF-NOT-DEFINED variable-name
 122 </dt>
 123 <dd>Specifies that the remainder of the test file should be skipped when the
 124 variable is or is not defined.
 125 </dd>
 126 <dt>STOP-AFTER-INCLUDE-ERROR no
 127 </dt>
 128 <dd></dd>
 129 <dt>STOP-AFTER-INCLUDE-ERROR yes
 130 </dt>
 131 <dd>Specifies whether tests will be stopped after an error in an included file.
 132 </dd>
 133 <dt>TRANSFER auto
 134 </dt>
 135 <dd>Specifies that tests will, by default, use "Transfer-Encoding: chunked" for
 136 requests with attached files and "Content-Length:" for requests without attached
 137 files.
 138 </dd>
 139 <dt>TRANSFER chunked
 140 </dt>
 141 <dd>Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding:
 142 chunked" header. This is the default and is equivalent to specifying "-c" on the
 143 <i>ipptool</i> command-line. Support for chunked requests is required for
 144 conformance with all versions of IPP.
 145 </dd>
 146 <dt>TRANSFER length
 147 </dt>
 148 <dd>Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:"
 149 header. This is equivalent to specifying "-l" on the <i>ipptool</i> command-line.
 150 Support for content length requests is required for conformance with all
 151 versions of IPP.
 152 </dd>
 153 <dt>VERSION 1.0
 154 </dt>
 155 <dd></dd>
 156 <dt>VERSION 1.1
 157 </dt>
 158 <dd></dd>
 159 <dt>VERSION 2.0
 160 </dt>
 161 <dd></dd>
 162 <dt>VERSION 2.1
 163 </dt>
 164 <dd></dd>
 165 <dt>VERSION 2.2
 166 </dt>
 167 <dd>Specifies the default IPP version number to use for the tests that follow.
 168
 169 </dd>
 170 </dl>
 171 <h2 class="title"><a name="TEST_DIRECTIVES">Test Directives</a></h2>
 172 The following directives are understood in a test:
 173 <dl>
 174 <dt>ATTR tag attribute-name value(s)
 175 </dt>
 176 <dd>Adds an attribute to the test request. Values are separated by the comma (",")
 177 character - escape commas using the "" character.
 178 </dd>
 179 <dt>ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ]
 180 </dt>
 181 <dd>Adds a collection attribute to the test request. Member attributes follow the
 182 same syntax as regular attributes and can themselves be nested collections.
 183 Multiple collection values can be supplied as needed.
 184 </dd>
 185 <dt>COMPRESSION deflate
 186 </dt>
 187 <dd></dd>
 188 <dt>COMPRESSION gzip
 189 </dt>
 190 <dd></dd>
 191 <dt>COMPRESSION none
 192 </dt>
 193 <dd></dd>
 194 <dd>Uses the specified compression on the document data following the attributes in
 195 a Print-Job or Send-Document request.
 196 </dd>
 197 <dt>DELAY seconds
 198 </dt>
 199 <dd>Specifies a delay before this test will be run.
 200 </dd>
 201 <dt>DISPLAY attribute-name
 202 </dt>
 203 <dd>Specifies that value of the named attribute should be output as part of the
 204 test report.
 205 </dd>
 206 <dt>EXPECT attribute-name [ predicate(s) ]
 207 </dt>
 208 <dd></dd>
 209 <dt>EXPECT ?attribute-name predicate(s)
 210 </dt>
 211 <dd></dd>
 212 <dt>EXPECT !attribute-name
 213 </dt>
 214 <dd>Specifies that the response must/may/must not include the named attribute.
 215 Additional requirements can be added as predicates - see the "EXPECT PREDICATES"
 216 section for more information on predicates.
 217 </dd>
 218 <dt>FILE filename
 219 </dt>
 220 <dd>Specifies a file to include at the end of the request. This is typically used
 221 when sending a test print file.
 222 </dd>
 223 <dt>GROUP tag
 224 </dt>
 225 <dd>Specifies the group tag for subsequent attributes in the request.
 226 </dd>
 227 <dt>IGNORE-ERRORS yes
 228 </dt>
 229 <dd></dd>
 230 <dt>IGNORE-ERRORS no
 231 </dt>
 232 <dd>Specifies whether <i>ipptool</i> will ignore errors and continue with subsequent
 233 tests.
 234 </dd>
 235 <dt>NAME "literal string"
 236 </dt>
 237 <dd>Specifies the human-readable name of the test.
 238 </dd>
 239 <dt>OPERATION operation-code
 240 </dt>
 241 <dd>Specifies the operation to be performed.
 242 </dd>
 243 <dt>REQUEST-ID number
 244 </dt>
 245 <dd></dd>
 246 <dt>REQUEST-ID random
 247 </dt>
 248 <dd>Specifies the request-id value to use in the request, either an integer or the
 249 word "random" to use a randomly generated value (the default).
 250 </dd>
 251 <dt>RESOURCE path
 252 </dt>
 253 <dd>Specifies an alternate resource path that is used for the HTTP POST request.
 254 The default is the resource from the URI provided to the <i>ipptool</i> program.
 255 </dd>
 256 <dt>SKIP-IF-DEFINED variable-name
 257 </dt>
 258 <dd></dd>
 259 <dt>SKIP-IF-NOT-DEFINED variable-name
 260 </dt>
 261 <dd>Specifies that the current test should be skipped when the variable is or is not
 262 defined.
 263 </dd>
 264 <dt>SKIP-PREVIOUS-ERROR yes
 265 </dt>
 266 <dd></dd>
 267 <dt>SKIP-PREVIOUS-ERROR no
 268 </dt>
 269 <dd>Specifies whether <i>ipptool</i> will skip the current test if the previous test
 270 resulted in an error/failure.
 271 </dd>
 272 <dt>STATUS status-code [ predicate ]
 273 </dt>
 274 <dd>Specifies an expected response status-code value. Additional requirements can be
 275 added as predicates - see the "STATUS PREDICATES" section for more information
 276 on predicates.
 277 </dd>
 278 <dt>TEST-ID "identifier"
 279 </dt>
 280 <dd>Specifies an identifier string for the current test.
 281 </dd>
 282 <dt>TRANSFER auto
 283 </dt>
 284 <dd>Specifies that this test will use "Transfer-Encoding: chunked" if it has an
 285 attached file or "Content-Length:" otherwise.
 286 </dd>
 287 <dt>TRANSFER chunked
 288 </dt>
 289 <dd>Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked"
 290 header.
 291 </dd>
 292 <dt>TRANSFER length
 293 </dt>
 294 <dd>Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
 295 </dd>
 296 <dt>VERSION 1.0
 297 </dt>
 298 <dd></dd>
 299 <dt>VERSION 1.1
 300 </dt>
 301 <dd></dd>
 302 <dt>VERSION 2.0
 303 </dt>
 304 <dd></dd>
 305 <dt>VERSION 2.1
 306 </dt>
 307 <dd></dd>
 308 <dt>VERSION 2.2
 309 </dt>
 310 <dd>Specifies the IPP version number to use for this test.
 311
 312 </dd>
 313 </dl>
 314 <h2 class="title"><a name="EXPECT_PREDICATES">Expect Predicates</a></h2>
 315 The following predicates are understood following the EXPECT test directive:
 316 <dl>
 317 <dt>COUNT number
 318 </dt>
 319 <dd>Requires the EXPECT attribute to have the specified number of values.
 320 </dd>
 321 <dt>DEFINE-MATCH variable-name
 322 </dt>
 323 <dd>Defines the variable to "1" when the EXPECT condition matches. A side-effect of
 324 this predicate is that this EXPECT will never fail a test.
 325 </dd>
 326 <dt>DEFINE-NO-MATCH variable-name
 327 </dt>
 328 <dd>Defines the variable to "1" when the EXPECT condition does not match. A side-
 329 effect of this predicate is that this EXPECT will never fail a test.
 330 </dd>
 331 <dt>DEFINE-VALUE variable-name
 332 </dt>
 333 <dd>Defines the variable to the value of the attribute when the EXPECT condition
 334 matches. A side-effect of this predicate is that this EXPECT will never fail a test.
 335 </dd>
 336 <dt>IF-DEFINED variable-name
 337 </dt>
 338 <dd>Makes the EXPECT conditions apply only if the specified variable is defined.
 339 </dd>
 340 <dt>IF-NOT-DEFINED variable-name
 341 </dt>
 342 <dd>Makes the EXPECT conditions apply only if the specified variable is not
 343 defined.
 344 </dd>
 345 <dt>IN-GROUP tag
 346 </dt>
 347 <dd>Requires the EXPECT attribute to be in the specified group tag.
 348 </dd>
 349 <dt>OF-TYPE tag[,tag,...]
 350 </dt>
 351 <dd>Requires the EXPECT attribute to use the specified value tag(s).
 352 </dd>
 353 <dt>REPEAT-LIMIT number
 354 </dt>
 355 <dd></dd>
 356 <dd>Specifies the maximum number of times to repeat. The default value is 1000.
 357 </dd>
 358 <dt>REPEAT-MATCH
 359 </dt>
 360 <dd></dd>
 361 <dt>REPEAT-NO-MATCH
 362 </dt>
 363 <dd>Specifies that the current test should be repeated when the EXPECT condition
 364 matches or does not match.
 365 </dd>
 366 <dt>SAME-COUNT-AS attribute-name
 367 </dt>
 368 <dd>Requires the EXPECT attribute to have the same number of values as the specified
 369 parallel attribute.
 370 </dd>
 371 <dt>WITH-ALL-HOSTNAMES "literal string"
 372 </dt>
 373 <dd></dd>
 374 <dt>WITH-ALL-HOSTNAMES "/regular expression/"
 375 </dt>
 376 <dd>Requires that all URI values contain a matching hostname.
 377 </dd>
 378 <dt>WITH-ALL-RESOURCES "literal string"
 379 </dt>
 380 <dd></dd>
 381 <dt>WITH-ALL-RESOURCES "/regular expression/"
 382 </dt>
 383 <dd>Requires that all URI values contain a matching resource (including leading /).
 384 </dd>
 385 <dt>WITH-ALL-SCHEMES "literal string"
 386 </dt>
 387 <dd></dd>
 388 <dt>WITH-ALL-SCHEMES "/regular expression/"
 389 </dt>
 390 <dd>Requires that all URI values contain a matching scheme.
 391 </dd>
 392 <dt>WITH-ALL-VALUES "literal string"
 393 </dt>
 394 <dd>Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.
 395 </dd>
 396 <dt>WITH-ALL-VALUES &lt;number
 397 </dt>
 398 <dd></dd>
 399 <dt>WITH-ALL-VALUES =number
 400 </dt>
 401 <dd></dd>
 402 <dt>WITH-ALL-VALUES >number
 403 </dt>
 404 <dd></dd>
 405 <dt>WITH-ALL-VALUES number[,number,...]
 406 </dt>
 407 <dd>Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "&lt;" and ">" operators only check the upper bound of the range.
 408 </dd>
 409 <dt>WITH-ALL-VALUES "false"
 410 </dt>
 411 <dd></dd>
 412 <dt>WITH-ALL-VALUES "true"
 413 </dt>
 414 <dd>Requires that all values of the EXPECT attribute match the boolean value given.
 415 </dd>
 416 <dt>WITH-ALL-VALUES "/regular expression/"
 417 </dt>
 418 <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.
 419 </dd>
 420 <dt>WITH-HOSTNAME "literal string"
 421 </dt>
 422 <dd></dd>
 423 <dt>WITH-HOSTNAME "/regular expression/"
 424 </dt>
 425 <dd>Requires that at least one URI value contains a matching hostname.
 426 </dd>
 427 <dt>WITH-RESOURCE "literal string"
 428 </dt>
 429 <dd></dd>
 430 <dt>WITH-RESOURCE "/regular expression/"
 431 </dt>
 432 <dd>Requires that at least one URI value contains a matching resource (including leading /).
 433 </dd>
 434 <dt>WITH-SCHEME "literal string"
 435 </dt>
 436 <dd></dd>
 437 <dt>WITH-SCHEME "/regular expression/"
 438 </dt>
 439 <dd>Requires that at least one URI value contains a matching scheme.
 440 </dd>
 441 <dt>WITH-VALUE "literal string"
 442 </dt>
 443 <dd>Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.
 444 </dd>
 445 <dt>WITH-VALUE &lt;number
 446 </dt>
 447 <dd></dd>
 448 <dt>WITH-VALUE =number
 449 </dt>
 450 <dd></dd>
 451 <dt>WITH-VALUE >number
 452 </dt>
 453 <dd></dd>
 454 <dt>WITH-VALUE number[,number,...]
 455 </dt>
 456 <dd>Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "&lt;" and ">" operators only check the upper bound of the range.
 457 </dd>
 458 <dt>WITH-VALUE "false"
 459 </dt>
 460 <dd></dd>
 461 <dt>WITH-VALUE "true"
 462 </dt>
 463 <dd>Requires that at least one value of the EXPECT attribute matches the boolean value given.
 464 </dd>
 465 <dt>WITH-VALUE "/regular expression/"
 466 </dt>
 467 <dd>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.
 468
 469 </dd>
 470 </dl>
 471 <h2 class="title"><a name="STATUS_PREDICATES">Status Predicates</a></h2>
 472 The following predicates are understood following the STATUS test directive:
 473 <dl>
 474 <dt>DEFINE-MATCH variable-name
 475 </dt>
 476 <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.
 477 </dd>
 478 <dt>DEFINE-NO-MATCH variable-name
 479 </dt>
 480 <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.
 481 </dd>
 482 <dt>IF-DEFINED variable-name
 483 </dt>
 484 <dd>Makes the STATUS apply only if the specified variable is defined.
 485 </dd>
 486 <dt>IF-NOT-DEFINED variable-name
 487 </dt>
 488 <dd>Makes the STATUS apply only if the specified variable is not defined.
 489 </dd>
 490 <dt>REPEAT-LIMIT number
 491 </dt>
 492 <dd></dd>
 493 <dd>Specifies the maximum number of times to repeat. The default value is 1000.
 494 </dd>
 495 <dt>REPEAT-MATCH
 496 </dt>
 497 <dd></dd>
 498 <dt>REPEAT-NO-MATCH
 499 </dt>
 500 <dd>Specifies that the current test should be repeated when the response status-code
 501 matches or does not match the value specified by the STATUS directive.
 502
 503 </dd>
 504 </dl>
 505 <h2 class="title"><a name="OPERATION_CODES">Operation Codes</a></h2>
 506 Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from
 507 RFC 2911 and other IPP extension specifications. Here is a complete list:
 508 <pre>
 509     Activate-Printer
 510     CUPS-Accept-Jobs
 511     CUPS-Add-Modify-Class
 512     CUPS-Add-Modify-Printer
 513     CUPS-Authenticate-Job
 514     CUPS-Delete-Class
 515     CUPS-Delete-Printer
 516     CUPS-Get-Classes
 517     CUPS-Get-Default
 518     CUPS-Get-Devices
 519     CUPS-Get-Document
 520     CUPS-Get-PPD
 521     CUPS-Get-PPDs
 522     CUPS-Get-Printers
 523     CUPS-Move-Job
 524     CUPS-Reject-Jobs
 525     CUPS-Set-Default
 526     Cancel-Current-Job
 527     Cancel-Job
 528     Cancel-Jobs
 529     Cancel-My-Jobs
 530     Cancel-Subscription
 531     Close-Job
 532     Create-Job
 533     Create-Job-Subscription
 534     Create-Printer-Subscription
 535     Deactivate-Printer
 536     Disable-Printer
 537     Enable-Printer
 538     Get-Job-Attributes
 539     Get-Jobs
 540     Get-Notifications
 541     Get-Printer-Attributes
 542     Get-Printer-Support-Files
 543     Get-Printer-Supported-Values
 544     Get-Subscription-Attributes
 545     Get-Subscriptions
 546     Hold-Job
 547     Hold-New-Jobs
 548     Identify-Printer
 549     Pause-Printer
 550     Pause-Printer-After-Current-Job
 551     Print-Job
 552     Print-URI
 553     Promote-Job
 554     Purge-Jobs
 555     Release-Held-New-Jobs
 556     Release-Job
 557     Renew-Subscription
 558     Reprocess-Job
 559     Restart-Job
 560     Restart-Printer
 561     Resubmit-Job
 562     Resume-Job
 563     Resume-Printer
 564     Schedule-Job-After
 565     Send-Document
 566     Send-Hardcopy-Document
 567     Send-Notifications
 568     Send-URI
 569     Set-Job-Attributes
 570     Set-Printer-Attributes
 571     Shutdown-Printer
 572     Startup-Printer
 573     Suspend-Current-Job
 574     Validate-Document
 575     Validate-Job
 576 </pre>
 577
 578 <h2 class="title"><a name="STATUS_CODES">Status Codes</a></h2>
 579 Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC
 580 2911 and other IPP extension specifications. Here is a complete list:
 581 <pre>
 582     client-error-attributes-not-settable
 583     client-error-attributes-or-values-not-supported
 584     client-error-bad-request
 585     client-error-charset-not-supported
 586     client-error-compression-error
 587     client-error-compression-not-supported
 588     client-error-conflicting-attributes
 589     client-error-document-access-error
 590     client-error-document-format-error
 591     client-error-document-format-not-supported
 592     client-error-document-password-error
 593     client-error-document-permission-error
 594     client-error-document-security-error
 595     client-error-document-unprintable-error
 596     client-error-forbidden
 597     client-error-gone
 598     client-error-ignored-all-notifications
 599     client-error-ignored-all-subscriptions
 600     client-error-not-authenticated
 601     client-error-not-authorized
 602     client-error-not-found
 603     client-error-not-possible
 604     client-error-print-support-file-not-found
 605     client-error-request-entity-too-large
 606     client-error-request-value-too-long
 607     client-error-timeout
 608     client-error-too-many-subscriptions
 609     client-error-uri-scheme-not-supported
 610     cups-see-other
 611     redirection-other-site
 612     server-error-busy
 613     server-error-device-error
 614     server-error-internal-error
 615     server-error-job-canceled
 616     server-error-multiple-document-jobs-not-supported
 617     server-error-not-accepting-jobs
 618     server-error-operation-not-supported
 619     server-error-printer-is-deactivated
 620     server-error-service-unavailable
 621     server-error-temporary-error
 622     server-error-version-not-supported
 623     successful-ok
 624     successful-ok-but-cancel-subscription
 625     successful-ok-conflicting-attributes
 626     successful-ok-events-complete
 627     successful-ok-ignored-notifications
 628     successful-ok-ignored-or-substituted-attributes
 629     successful-ok-ignored-subscriptions
 630     successful-ok-too-many-events
 631 </pre>
 632
 633 <h2 class="title"><a name="TAGS">Tags</a></h2>
 634 Value and group tags correspond to the names from RFC 2911 and other IPP
 635 extension specifications. Here are the group tags:
 636 <pre>
 637     event-notification-attributes-tag
 638     job-attributes-tag
 639     operation-attributes-tag
 640     printer-attributes-tag
 641     subscription-attributes-tag
 642     unsupported-attributes-tag
 643 </pre>
 644 <p>Here are the value tags:
 645 <pre>
 646     admin-define
 647     boolean
 648     charset
 649     collection
 650     dateTime
 651     default
 652     delete-attribute
 653     enum
 654     integer
 655     keyword
 656     mimeMediaType
 657     nameWithLanguage
 658     nameWithoutLanguage
 659     naturalLanguage
 660     no-value
 661     not-settable
 662     octetString
 663     rangeOfInteger
 664     resolution
 665     textWithLanguage
 666     textWithoutLanguage
 667     unknown
 668     unsupported
 669     uri
 670     uriScheme
 671 </pre>
 672
 673 <h2 class="title"><a name="VARIABLES">Variables</a></h2>
 674 The <i>ipptool</i> program maintains a list of variables that can be used in any
 675 literal string or attribute value by specifying "$variable-name". Aside from
 676 variables defined using the "-d" option or "DEFINE" directive, the following
 677 pre-defined variables are available:
 678 <dl>
 679 <dt>$$
 680 </dt>
 681 <dd>Inserts a single "$" character.
 682 </dd>
 683 <dt>$ENV[name]
 684 </dt>
 685 <dd>Inserts the value of the named environment variable, or an empty string if the
 686 environment variable is not defined.
 687 </dd>
 688 <dt>$filename
 689 </dt>
 690 <dd>Inserts the filename provided to <i>ipptool</i> with the "-f" option.
 691 </dd>
 692 <dt>$hostname
 693 </dt>
 694 <dd>Inserts the hostname from the URI provided to <i>ipptool</i>.
 695 </dd>
 696 <dt>$job-id
 697 </dt>
 698 <dd>Inserts the last job-id value returned in a test response or 0 if no job-id has
 699 been seen.
 700 </dd>
 701 <dt>$job-uri
 702 </dt>
 703 <dd>Inserts the last job-uri value returned in a test response or an empty string if
 704 no job-uri has been seen.
 705 </dd>
 706 <dt>$scheme
 707 </dt>
 708 <dd>Inserts the scheme from the URI provided to <i>ipptool</i>.
 709 </dd>
 710 <dt>$notify-subscription-id
 711 </dt>
 712 <dd>Inserts the last notify-subscription-id value returned in a test response or 0 if
 713 no notify-subscription-id has been seen.
 714 </dd>
 715 <dt>$port
 716 </dt>
 717 <dd>Inserts the port number from the URI provided to <i>ipptool</i>.
 718 </dd>
 719 <dt>$resource
 720 </dt>
 721 <dd>Inserts the resource path from the URI provided to <i>ipptool</i>.
 722 </dd>
 723 <dt>$uri
 724 </dt>
 725 <dd>Inserts the URI provided to <i>ipptool</i>.
 726 </dd>
 727 <dt>$user
 728 </dt>
 729 <dd>Inserts the current user's login name.
 730 </dd>
 731 <dt>$username
 732 </dt>
 733 <dd>Inserts the username from the URI provided to <i>ipptool</i>, if any.
 734
 735 </dd>
 736 </dl>
 737 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 738 <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a>,
 739 <br>
 740 <a href='http://localhost:631/help'>http://localhost:631/help</a>
 741
 742 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 743 Copyright 2007-2013 by Apple Inc.
 744
 745 </body>
 746 </html>