man/ipptoolfile.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   ipptoolfile man page for CUPS.
   5 .\"
   6 .\"   Copyright 2010-2011 by Apple Inc.
   7 .\"
   8 .\"   These coded instructions, statements, and computer programs are the
   9 .\"   property of Apple Inc. and are protected by Federal copyright
  10 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  11 .\"   which should have been included with this file.  If this file is
  12 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
  13 .\"
  14 .TH ipptoolfile 5 "CUPS" "11 May 2011" "Apple Inc."
  15 .SH NAME
  16 ipptoolfile \- ipptool file format
  17
  18 .SH DESCRIPTION
  19 The \fIipptool(1)\fR 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:
  20 .nf
  21
  22     # This is a comment
  23     {
  24       # The name of the test
  25       NAME "Print PostScript Job"
  26
  27       # The request to send
  28       OPERATION Print-Job
  29       GROUP operation-attributes-tag
  30       ATTR charset attributes-charset utf-8
  31       ATTR language attributes-natural-language en
  32       ATTR uri printer-uri $uri
  33       ATTR name requesting-user-name $user
  34       FILE testfile.ps
  35
  36       # The response to expect
  37       STATUS successful-ok
  38       EXPECT attributes-charset OF-TYPE charset
  39       EXPECT attributes-natural-language OF-TYPE naturalLanguage
  40       EXPECT job-id OF-TYPE integer
  41       EXPECT job-uri OF-TYPE uri
  42     }
  43     {
  44       # The name of the test
  45       NAME "Get Attributes of PostScript Job"
  46
  47       # The request to send
  48       OPERATION Get-Job-Attributes
  49       GROUP operation-attributes-tag
  50       ATTR charset attributes-charset utf-8
  51       ATTR language attributes-natural-language en
  52       ATTR uri printer-uri $uri
  53       ATTR integer job-id $job-id
  54       ATTR name requesting-user-name $user
  55
  56       # The response to expect
  57       STATUS successful-ok
  58       EXPECT attributes-charset OF-TYPE charset
  59       EXPECT attributes-natural-language OF-TYPE naturalLanguage
  60       EXPECT job-id OF-TYPE integer
  61       EXPECT job-uri OF-TYPE uri
  62       EXPECT job-state OF-TYPE enum
  63       EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user"
  64     }
  65 .fi
  66
  67 .SH TOP-LEVEL DIRECTIVES
  68 The following directives can be used outside of a test:
  69 .TP 5
  70 { test }
  71 Defines a test.
  72 .TP 5
  73 DEFINE variable-name value
  74 Defines the named variable to the given value. This is equivalent to specifying
  75 "-d variable-name=value" on the \fIipptool\fR command-line.
  76 .TP 5
  77 DEFINE-DEFAULT variable-name value
  78 Defines the named variable to the given value if it does not already have a
  79 value.
  80 .TP 5
  81 IGNORE-ERRORS yes
  82 .TP 5
  83 IGNORE-ERRORS no
  84 Specifies whether, by default, \fIipptool\fR will ignore errors and continue with
  85 subsequent tests.
  86 .TP 5
  87 INCLUDE "filename"
  88 .TP 5
  89 INCLUDE <filename>
  90 Includes another test file. The first form includes a file relative to the
  91 current test file, while the second form includes a file from the \fIipptool\fR
  92 include directory.
  93 .TP 5
  94 INCLUDE-IF-DEFINED name "filename"
  95 .TP 5
  96 INCLUDE-IF-DEFINED name <filename>
  97 Includes another test file if the named variable is defined. The first form
  98 includes a file relative to the current test file, while the second form
  99 includes a file from the \fIipptool\fR include directory.
 100 .TP 5
 101 INCLUDE-IF-NOT-DEFINED name "filename"
 102 .TP 5
 103 INCLUDE-IF-NOT-DEFINED name <filename>
 104 Includes another test file if the named variable is not defined. The first form
 105 includes a file relative to the current test file, while the second form
 106 includes a file from the \fIipptool\fR include directory.
 107 .TP 5
 108 SKIP-IF-DEFINED variable-name
 109 .TP 5
 110 SKIP-IF-NOT-DEFINED variable-name
 111 Specifies that the remainder of the test file should be skipped when the
 112 variable is or is not defined.
 113 .TP 5
 114 TRANSFER auto
 115 Specifies that tests will, by default, use "Transfer-Encoding: chunked" for
 116 requests with attached files and "Content-Length:" for requests without attached
 117 files.
 118 .TP 5
 119 TRANSFER chunked
 120 Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding:
 121 chunked" header. This is the default and is equivalent to specifying "-c" on the
 122 \fIipptool\fR command-line. Support for chunked requests is required for
 123 conformance with all versions of IPP.
 124 .TP 5
 125 TRANSFER length
 126 Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:"
 127 header. This is equivalent to specifying "-l" on the \fIipptool\fR command-line.
 128 Support for content length requests is required for conformance with all
 129 versions of IPP.
 130 .TP 5
 131 VERSION 1.0
 132 .TP 5
 133 VERSION 1.1
 134 .TP 5
 135 VERSION 2.0
 136 .TP 5
 137 VERSION 2.1
 138 .TP 5
 139 VERSION 2.2
 140 Specifies the default IPP version number to use for the tests that follow.
 141
 142 .SH TEST DIRECTIVES
 143 The following directives are understood in a test:
 144 .TP 5
 145 ATTR tag attribute-name value(s)
 146 Adds an attribute to the test request. Values are separated by the comma (",")
 147 character - escape commas using the "\" character.
 148 .TP 5
 149 ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ]
 150 Adds a collection attribute to the test request. Member attributes follow the
 151 same syntax as regular attributes and can themselves be nested collections.
 152 Multiple collection values can be supplied as needed.
 153 .TP 5
 154 DELAY seconds
 155 Specifies a delay before this test will be run.
 156 .TP 5
 157 DISPLAY attribute-name
 158 Specifies that value of the named attribute should be output as part of the
 159 test report.
 160 .TP 5
 161 EXPECT attribute-name [ predicate(s) ]
 162 .TP 5
 163 EXPECT ?attribute-name predicate(s)
 164 .TP 5
 165 EXPECT !attribute-name
 166 Specifies that the response must/may/must not include the named attribute.
 167 Additional requirements can be added as predicates - see the "EXPECT PREDICATES"
 168 section for more information on predicates.
 169 .TP 5
 170 FILE filename
 171 Specifies a file to include at the end of the request. This is typically used
 172 when sending a test print file.
 173 .TP 5
 174 GROUP tag
 175 Specifies the group tag for subsequent attributes in the request.
 176 .TP 5
 177 IGNORE-ERRORS yes
 178 .TP 5
 179 IGNORE-ERRORS no
 180 Specifies whether \fIipptool\fR will ignore errors and continue with subsequent
 181 tests.
 182 .TP 5
 183 NAME "literal string"
 184 Specifies the human-readable name of the test.
 185 .TP 5
 186 OPERATION operation-code
 187 Specifies the operation to be performed.
 188 .TP 5
 189 REQUEST-ID number
 190 .TP 5
 191 REQUEST-ID random
 192 Specifies the request-id value to use in the request, either an integer or the
 193 word "random" to use a randomly generated value (the default).
 194 .TP 5
 195 RESOURCE path
 196 Specifies an alternate resource path that is used for the HTTP POST request.
 197 The default is the resource from the URI provided to the \fIipptool\fR program.
 198 .TP 5
 199 SKIP-IF-DEFINED variable-name
 200 .TP 5
 201 SKIP-IF-NOT-DEFINED variable-name
 202 Specifies that the current test should be skipped when the variable is or is not
 203 defined.
 204 .TP 5
 205 SKIP-PREVIOUS-ERROR yes
 206 .TP 5
 207 SKIP-PREVIOUS-ERROR no
 208 Specifies whether \fIipptool\fR will skip the current test if the previous test
 209 resulted in an error/failure.
 210 .TP 5
 211 STATUS status-code [ predicate ]
 212 Specifies an expected response status-code value. Additional requirements can be
 213 added as predicates - see the "STATUS PREDICATES" section for more information
 214 on predicates.
 215 .TP 5
 216 TRANSFER auto
 217 Specifies that this test will use "Transfer-Encoding: chunked" if it has an
 218 attached file or "Content-Length:" otherwise.
 219 .TP 5
 220 TRANSFER chunked
 221 Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked"
 222 header.
 223 .TP 5
 224 TRANSFER length
 225 Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
 226 .TP 5
 227 VERSION 1.0
 228 .TP 5
 229 VERSION 1.1
 230 .TP 5
 231 VERSION 2.0
 232 .TP 5
 233 VERSION 2.1
 234 .TP 5
 235 VERSION 2.2
 236 Specifies the IPP version number to use for this test.
 237
 238 .SH EXPECT PREDICATES
 239 The following predicates are understood following the EXPECT test directive:
 240 .TP 5
 241 COUNT number
 242 Requires the EXPECT attribute to have the specified number of values.
 243 .TP 5
 244 DEFINE-MATCH variable-name
 245 Defines the variable to "1" when the EXPECT condition matches. A side-effect of
 246 this predicate is that this EXPECT will never fail a test.
 247 .TP 5
 248 DEFINE-NO-MATCH variable-name
 249 Defines the variable to "1" when the EXPECT condition does not match. A side-
 250 effect of this predicate is that this EXPECT will never fail a test.
 251 .TP 5
 252 DEFINE-VALUE variable-name
 253 Defines the variable to the value of the attribute when the EXPECT condition
 254 matches.
 255 .TP 5
 256 IF-DEFINED variable-name
 257 Makes the EXPECT conditions apply only if the specified variable is defined.
 258 .TP 5
 259 IF-NOT-DEFINED variable-name
 260 Makes the EXPECT conditions apply only if the specified variable is not
 261 defined.
 262 .TP 5
 263 IN-GROUP tag
 264 Requires the EXPECT attribute to be in the specified group tag.
 265 .TP 5
 266 OF-TYPE tag[,tag,...]
 267 Requires the EXPECT attribute to use the specified value tag(s).
 268 .TP 5
 269 SAME-COUNT-AS attribute-name
 270 Requires the EXPECT attribute to have the same number of values as the specified
 271 parallel attribute.
 272 .TP 5
 273 WITH-VALUE "literal string"
 274 Requires at least one value of the EXPECT attribute to match the literal string.
 275 Comparisons are case-sensitive.
 276 .TP 5
 277 WITH-VALUE "/regular expression/"
 278 Requires that all values of the EXPECT attribute match the regular expression,
 279 which must conform to the POSIX regular expression syntax.
 280 Comparisons are case-sensitive.
 281
 282 .SH STATUS PREDICATES
 283 The following predicates are understood following the STATUS test directive:
 284 .TP 5
 285 IF-DEFINED variable-name
 286 Makes the STATUS apply only if the specified variable is defined.
 287 .TP 5
 288 IF-NOT-DEFINED variable-name
 289 Makes the STATUS apply only if the specified variable is not defined.
 290
 291 .SH OPERATION CODES
 292 Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from
 293 RFC 2911 and other IPP extension specifications. Here is a complete list:
 294 .nf
 295     Activate-Printer
 296     CUPS-Accept-Jobs
 297     CUPS-Add-Modify-Class
 298     CUPS-Add-Modify-Printer
 299     CUPS-Authenticate-Job
 300     CUPS-Delete-Class
 301     CUPS-Delete-Printer
 302     CUPS-Get-Classes
 303     CUPS-Get-Default
 304     CUPS-Get-Devices
 305     CUPS-Get-Document
 306     CUPS-Get-PPD
 307     CUPS-Get-PPDs
 308     CUPS-Get-Printers
 309     CUPS-Move-Job
 310     CUPS-Reject-Jobs
 311     CUPS-Set-Default
 312     Cancel-Current-Job
 313     Cancel-Job
 314     Cancel-Jobs
 315     Cancel-My-Jobs
 316     Cancel-Subscription
 317     Close-Job
 318     Create-Job
 319     Create-Job-Subscription
 320     Create-Printer-Subscription
 321     Deactivate-Printer
 322     Disable-Printer
 323     Enable-Printer
 324     Get-Job-Attributes
 325     Get-Jobs
 326     Get-Notifications
 327     Get-Printer-Attributes
 328     Get-Printer-Support-Files
 329     Get-Printer-Supported-Values
 330     Get-Subscription-Attributes
 331     Get-Subscriptions
 332     Hold-Job
 333     Hold-New-Jobs
 334     Pause-Printer
 335     Pause-Printer-After-Current-Job
 336     Print-Job
 337     Print-URI
 338     Promote-Job
 339     Purge-Jobs
 340     Release-Held-New-Jobs
 341     Release-Job
 342     Renew-Subscription
 343     Reprocess-Job
 344     Restart-Job
 345     Restart-Printer
 346     Resubmit-Job
 347     Resume-Job
 348     Resume-Printer
 349     Schedule-Job-After
 350     Send-Document
 351     Send-Notifications
 352     Send-URI
 353     Set-Job-Attributes
 354     Set-Printer-Attributes
 355     Shutdown-Printer
 356     Startup-Printer
 357     Suspend-Current-Job
 358     Validate-Job
 359 .fi
 360
 361 .SH STATUS CODES
 362 Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC
 363 2911 and other IPP extension specifications. Here is a complete list:
 364 .nf
 365     client-error-attributes-not-settable
 366     client-error-attributes-or-values-not-supported
 367     client-error-bad-request
 368     client-error-charset-not-supported
 369     client-error-compression-error
 370     client-error-compression-not-supported
 371     client-error-conflicting-attributes
 372     client-error-document-access-error
 373     client-error-document-format-error
 374     client-error-document-format-not-supported
 375     client-error-forbidden
 376     client-error-gone
 377     client-error-ignored-all-notifications
 378     client-error-ignored-all-subscriptions
 379     client-error-not-authenticated
 380     client-error-not-authorized
 381     client-error-not-found
 382     client-error-not-possible
 383     client-error-print-support-file-not-found
 384     client-error-request-entity-too-large
 385     client-error-request-value-too-long
 386     client-error-timeout
 387     client-error-too-many-subscriptions
 388     client-error-uri-scheme-not-supported
 389     cups-see-other
 390     redirection-other-site
 391     server-error-busy
 392     server-error-device-error
 393     server-error-internal-error
 394     server-error-job-canceled
 395     server-error-multiple-document-jobs-not-supported
 396     server-error-not-accepting-jobs
 397     server-error-operation-not-supported
 398     server-error-printer-is-deactivated
 399     server-error-service-unavailable
 400     server-error-temporary-error
 401     server-error-version-not-supported
 402     successful-ok
 403     successful-ok-but-cancel-subscription
 404     successful-ok-conflicting-attributes
 405     successful-ok-events-complete
 406     successful-ok-ignored-notifications
 407     successful-ok-ignored-or-substituted-attributes
 408     successful-ok-ignored-subscriptions
 409     successful-ok-too-many-events
 410 .fi
 411
 412 .SH TAGS
 413 Value and group tags correspond to the names from RFC 2911 and other IPP
 414 extension specifications. Here are the group tags:
 415 .nf
 416     event-notification-attributes-tag
 417     job-attributes-tag
 418     operation-attributes-tag
 419     printer-attributes-tag
 420     subscription-attributes-tag
 421     unsupported-attributes-tag
 422 .fi
 423 .LP
 424 Here are the value tags:
 425 .nf
 426     admin-define
 427     boolean
 428     charset
 429     collection
 430     dateTime
 431     default
 432     delete-attribute
 433     enum
 434     integer
 435     keyword
 436     mimeMediaType
 437     nameWithLanguage
 438     nameWithoutLanguage
 439     naturalLanguage
 440     no-value
 441     not-settable
 442     octetString
 443     rangeOfInteger
 444     resolution
 445     textWithLanguage
 446     textWithoutLanguage
 447     unknown
 448     unsupported
 449     uri
 450     uriScheme
 451 .fi
 452
 453 .SH VARIABLES
 454 The \fIipptool\fR program maintains a list of variables that can be used in any
 455 literal string or attribute value by specifying "$variable-name". Aside from
 456 variables defined using the "-d" option or "DEFINE" directive, the following
 457 pre-defined variables are available:
 458 .TP 5
 459 $$
 460 Inserts a single "$" character.
 461 .TP 5
 462 $ENV[name]
 463 Inserts the value of the named environment variable, or an empty string if the
 464 environment variable is not defined.
 465 .TP 5
 466 $filename
 467 Inserts the filename provided to \fIipptool\fR with the "-f" option.
 468 .TP 5
 469 $hostname
 470 Inserts the hostname from the URI provided to \fIipptool\fR.
 471 .TP 5
 472 $job-id
 473 Inserts the last job-id value returned in a test response or 0 if no job-id has
 474 been seen.
 475 .TP 5
 476 $job-uri
 477 Inserts the last job-uri value returned in a test response or an empty string if
 478 no job-uri has been seen.
 479 .TP 5
 480 $scheme
 481 Inserts the scheme from the URI provided to \fIipptool\fR.
 482 .TP 5
 483 $notify-subscription-id
 484 Inserts the last notify-subscription-id value returnd in a test response or 0 if
 485 no notify-subscription-id has been seen.
 486 .TP 5
 487 $port
 488 Inserts the port number from the URI provided to \fIipptool\fR.
 489 .TP 5
 490 $resource
 491 Inserts the resource path from the URI provided to \fIipptool\fR.
 492 .TP 5
 493 $uri
 494 Inserts the URI provided to \fIipptool\fR.
 495 .TP 5
 496 $user
 497 Inserts the current user's login name.
 498 .TP 5
 499 $username
 500 Inserts the username from the URI provided to \fIipptool\fR, if any.
 501
 502 .SH SEE ALSO
 503 \fIipptool(1)\fR,
 504 .br
 505 http://localhost:631/help
 506
 507 .SH COPYRIGHT
 508 Copyright 2007-2011 by Apple Inc.
 509 .\"
 510 .\" End of "$Id$".
 511 .\"