]>
Commit | Line | Data |
---|---|---|
a2326b5b MS |
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> | |
c1420c87 | 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: |
a2326b5b MS |
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> | |
1d47b929 MS |
79 | <dt>FILE-ID "identifier" |
80 | </dt> | |
81 | <dd>Specifies an identifier string for the current file. | |
82 | </dd> | |
a2326b5b MS |
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 <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 <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 <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> | |
9475ec92 MS |
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> | |
a2326b5b MS |
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> | |
c41769ff MS |
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> | |
a2326b5b MS |
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> | |
1d47b929 MS |
278 | <dt>TEST-ID "identifier" |
279 | </dt> | |
280 | <dd>Specifies an identifier string for the current test. | |
281 | </dd> | |
a2326b5b MS |
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> | |
a29fd7dd MS |
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> | |
a2326b5b MS |
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> | |
82cc1f9a MS |
371 | <dt>WITH-ALL-VALUES "literal string" |
372 | </dt> | |
373 | <dd>Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive. | |
374 | </dd> | |
375 | <dt>WITH-ALL-VALUES <number | |
376 | </dt> | |
377 | <dd></dd> | |
378 | <dt>WITH-ALL-VALUES =number | |
379 | </dt> | |
380 | <dd></dd> | |
381 | <dt>WITH-ALL-VALUES >number | |
382 | </dt> | |
383 | <dd></dd> | |
384 | <dt>WITH-ALL-VALUES number[,number,...] | |
385 | </dt> | |
386 | <dd>Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range. | |
387 | </dd> | |
388 | <dt>WITH-ALL-VALUES "false" | |
389 | </dt> | |
390 | <dd></dd> | |
391 | <dt>WITH-ALL-VALUES "true" | |
392 | </dt> | |
393 | <dd>Requires that all values of the EXPECT attribute match the boolean value given. | |
394 | </dd> | |
395 | <dt>WITH-ALL-VALUES "/regular expression/" | |
396 | </dt> | |
397 | <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. | |
398 | </dd> | |
a2326b5b MS |
399 | <dt>WITH-VALUE "literal string" |
400 | </dt> | |
82cc1f9a MS |
401 | <dd>Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive. |
402 | </dd> | |
403 | <dt>WITH-VALUE <number | |
404 | </dt> | |
405 | <dd></dd> | |
406 | <dt>WITH-VALUE =number | |
407 | </dt> | |
408 | <dd></dd> | |
409 | <dt>WITH-VALUE >number | |
410 | </dt> | |
411 | <dd></dd> | |
412 | <dt>WITH-VALUE number[,number,...] | |
413 | </dt> | |
414 | <dd>Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range. | |
415 | </dd> | |
416 | <dt>WITH-VALUE "false" | |
417 | </dt> | |
418 | <dd></dd> | |
419 | <dt>WITH-VALUE "true" | |
420 | </dt> | |
421 | <dd>Requires that at least one value of the EXPECT attribute matches the boolean value given. | |
a2326b5b MS |
422 | </dd> |
423 | <dt>WITH-VALUE "/regular expression/" | |
424 | </dt> | |
82cc1f9a | 425 | <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. |
a2326b5b MS |
426 | |
427 | </dd> | |
428 | </dl> | |
429 | <h2 class="title"><a name="STATUS_PREDICATES">Status Predicates</a></h2> | |
430 | The following predicates are understood following the STATUS test directive: | |
431 | <dl> | |
0fa6c7fa MS |
432 | <dt>DEFINE-MATCH variable-name |
433 | </dt> | |
434 | <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. | |
435 | </dd> | |
436 | <dt>DEFINE-NO-MATCH variable-name | |
437 | </dt> | |
438 | <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. | |
439 | </dd> | |
a2326b5b MS |
440 | <dt>IF-DEFINED variable-name |
441 | </dt> | |
442 | <dd>Makes the STATUS apply only if the specified variable is defined. | |
443 | </dd> | |
444 | <dt>IF-NOT-DEFINED variable-name | |
445 | </dt> | |
446 | <dd>Makes the STATUS apply only if the specified variable is not defined. | |
447 | </dd> | |
a29fd7dd MS |
448 | <dt>REPEAT-LIMIT number |
449 | </dt> | |
450 | <dd></dd> | |
451 | <dd>Specifies the maximum number of times to repeat. The default value is 1000. | |
452 | </dd> | |
a2326b5b MS |
453 | <dt>REPEAT-MATCH |
454 | </dt> | |
455 | <dd></dd> | |
456 | <dt>REPEAT-NO-MATCH | |
457 | </dt> | |
458 | <dd>Specifies that the current test should be repeated when the response status-code | |
459 | matches or does not match the value specified by the STATUS directive. | |
460 | ||
461 | </dd> | |
462 | </dl> | |
463 | <h2 class="title"><a name="OPERATION_CODES">Operation Codes</a></h2> | |
464 | Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from | |
465 | RFC 2911 and other IPP extension specifications. Here is a complete list: | |
466 | <pre> | |
467 | Activate-Printer | |
468 | CUPS-Accept-Jobs | |
469 | CUPS-Add-Modify-Class | |
470 | CUPS-Add-Modify-Printer | |
471 | CUPS-Authenticate-Job | |
472 | CUPS-Delete-Class | |
473 | CUPS-Delete-Printer | |
474 | CUPS-Get-Classes | |
475 | CUPS-Get-Default | |
476 | CUPS-Get-Devices | |
477 | CUPS-Get-Document | |
478 | CUPS-Get-PPD | |
479 | CUPS-Get-PPDs | |
480 | CUPS-Get-Printers | |
481 | CUPS-Move-Job | |
482 | CUPS-Reject-Jobs | |
483 | CUPS-Set-Default | |
484 | Cancel-Current-Job | |
485 | Cancel-Job | |
486 | Cancel-Jobs | |
487 | Cancel-My-Jobs | |
488 | Cancel-Subscription | |
489 | Close-Job | |
490 | Create-Job | |
491 | Create-Job-Subscription | |
492 | Create-Printer-Subscription | |
493 | Deactivate-Printer | |
494 | Disable-Printer | |
495 | Enable-Printer | |
496 | Get-Job-Attributes | |
497 | Get-Jobs | |
498 | Get-Notifications | |
499 | Get-Printer-Attributes | |
500 | Get-Printer-Support-Files | |
501 | Get-Printer-Supported-Values | |
502 | Get-Subscription-Attributes | |
503 | Get-Subscriptions | |
504 | Hold-Job | |
505 | Hold-New-Jobs | |
82cc1f9a | 506 | Identify-Printer |
a2326b5b MS |
507 | Pause-Printer |
508 | Pause-Printer-After-Current-Job | |
509 | Print-Job | |
510 | Print-URI | |
511 | Promote-Job | |
512 | Purge-Jobs | |
513 | Release-Held-New-Jobs | |
514 | Release-Job | |
515 | Renew-Subscription | |
516 | Reprocess-Job | |
517 | Restart-Job | |
518 | Restart-Printer | |
519 | Resubmit-Job | |
520 | Resume-Job | |
521 | Resume-Printer | |
522 | Schedule-Job-After | |
523 | Send-Document | |
9475ec92 | 524 | Send-Hardcopy-Document |
a2326b5b MS |
525 | Send-Notifications |
526 | Send-URI | |
527 | Set-Job-Attributes | |
528 | Set-Printer-Attributes | |
529 | Shutdown-Printer | |
530 | Startup-Printer | |
531 | Suspend-Current-Job | |
82cc1f9a | 532 | Validate-Document |
a2326b5b MS |
533 | Validate-Job |
534 | </pre> | |
535 | ||
536 | <h2 class="title"><a name="STATUS_CODES">Status Codes</a></h2> | |
537 | Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC | |
538 | 2911 and other IPP extension specifications. Here is a complete list: | |
539 | <pre> | |
540 | client-error-attributes-not-settable | |
541 | client-error-attributes-or-values-not-supported | |
542 | client-error-bad-request | |
543 | client-error-charset-not-supported | |
544 | client-error-compression-error | |
545 | client-error-compression-not-supported | |
546 | client-error-conflicting-attributes | |
547 | client-error-document-access-error | |
548 | client-error-document-format-error | |
549 | client-error-document-format-not-supported | |
82cc1f9a MS |
550 | client-error-document-password-error |
551 | client-error-document-permission-error | |
552 | client-error-document-security-error | |
553 | client-error-document-unprintable-error | |
a2326b5b MS |
554 | client-error-forbidden |
555 | client-error-gone | |
556 | client-error-ignored-all-notifications | |
557 | client-error-ignored-all-subscriptions | |
558 | client-error-not-authenticated | |
559 | client-error-not-authorized | |
560 | client-error-not-found | |
561 | client-error-not-possible | |
562 | client-error-print-support-file-not-found | |
563 | client-error-request-entity-too-large | |
564 | client-error-request-value-too-long | |
565 | client-error-timeout | |
566 | client-error-too-many-subscriptions | |
567 | client-error-uri-scheme-not-supported | |
568 | cups-see-other | |
569 | redirection-other-site | |
570 | server-error-busy | |
571 | server-error-device-error | |
572 | server-error-internal-error | |
573 | server-error-job-canceled | |
574 | server-error-multiple-document-jobs-not-supported | |
575 | server-error-not-accepting-jobs | |
576 | server-error-operation-not-supported | |
577 | server-error-printer-is-deactivated | |
578 | server-error-service-unavailable | |
579 | server-error-temporary-error | |
580 | server-error-version-not-supported | |
581 | successful-ok | |
582 | successful-ok-but-cancel-subscription | |
583 | successful-ok-conflicting-attributes | |
584 | successful-ok-events-complete | |
585 | successful-ok-ignored-notifications | |
586 | successful-ok-ignored-or-substituted-attributes | |
587 | successful-ok-ignored-subscriptions | |
588 | successful-ok-too-many-events | |
589 | </pre> | |
590 | ||
591 | <h2 class="title"><a name="TAGS">Tags</a></h2> | |
592 | Value and group tags correspond to the names from RFC 2911 and other IPP | |
593 | extension specifications. Here are the group tags: | |
594 | <pre> | |
595 | event-notification-attributes-tag | |
596 | job-attributes-tag | |
597 | operation-attributes-tag | |
598 | printer-attributes-tag | |
599 | subscription-attributes-tag | |
600 | unsupported-attributes-tag | |
601 | </pre> | |
602 | <p>Here are the value tags: | |
603 | <pre> | |
604 | admin-define | |
605 | boolean | |
606 | charset | |
607 | collection | |
608 | dateTime | |
609 | default | |
610 | delete-attribute | |
611 | enum | |
612 | integer | |
613 | keyword | |
614 | mimeMediaType | |
615 | nameWithLanguage | |
616 | nameWithoutLanguage | |
617 | naturalLanguage | |
618 | no-value | |
619 | not-settable | |
620 | octetString | |
621 | rangeOfInteger | |
622 | resolution | |
623 | textWithLanguage | |
624 | textWithoutLanguage | |
625 | unknown | |
626 | unsupported | |
627 | uri | |
628 | uriScheme | |
629 | </pre> | |
630 | ||
631 | <h2 class="title"><a name="VARIABLES">Variables</a></h2> | |
632 | The <i>ipptool</i> program maintains a list of variables that can be used in any | |
633 | literal string or attribute value by specifying "$variable-name". Aside from | |
634 | variables defined using the "-d" option or "DEFINE" directive, the following | |
635 | pre-defined variables are available: | |
636 | <dl> | |
637 | <dt>$$ | |
638 | </dt> | |
639 | <dd>Inserts a single "$" character. | |
640 | </dd> | |
641 | <dt>$ENV[name] | |
642 | </dt> | |
643 | <dd>Inserts the value of the named environment variable, or an empty string if the | |
644 | environment variable is not defined. | |
645 | </dd> | |
646 | <dt>$filename | |
647 | </dt> | |
648 | <dd>Inserts the filename provided to <i>ipptool</i> with the "-f" option. | |
649 | </dd> | |
650 | <dt>$hostname | |
651 | </dt> | |
652 | <dd>Inserts the hostname from the URI provided to <i>ipptool</i>. | |
653 | </dd> | |
654 | <dt>$job-id | |
655 | </dt> | |
656 | <dd>Inserts the last job-id value returned in a test response or 0 if no job-id has | |
657 | been seen. | |
658 | </dd> | |
659 | <dt>$job-uri | |
660 | </dt> | |
661 | <dd>Inserts the last job-uri value returned in a test response or an empty string if | |
662 | no job-uri has been seen. | |
663 | </dd> | |
664 | <dt>$scheme | |
665 | </dt> | |
666 | <dd>Inserts the scheme from the URI provided to <i>ipptool</i>. | |
667 | </dd> | |
668 | <dt>$notify-subscription-id | |
669 | </dt> | |
c1420c87 | 670 | <dd>Inserts the last notify-subscription-id value returned in a test response or 0 if |
a2326b5b MS |
671 | no notify-subscription-id has been seen. |
672 | </dd> | |
673 | <dt>$port | |
674 | </dt> | |
675 | <dd>Inserts the port number from the URI provided to <i>ipptool</i>. | |
676 | </dd> | |
677 | <dt>$resource | |
678 | </dt> | |
679 | <dd>Inserts the resource path from the URI provided to <i>ipptool</i>. | |
680 | </dd> | |
681 | <dt>$uri | |
682 | </dt> | |
683 | <dd>Inserts the URI provided to <i>ipptool</i>. | |
684 | </dd> | |
685 | <dt>$user | |
686 | </dt> | |
687 | <dd>Inserts the current user's login name. | |
688 | </dd> | |
689 | <dt>$username | |
690 | </dt> | |
691 | <dd>Inserts the username from the URI provided to <i>ipptool</i>, if any. | |
692 | ||
693 | </dd> | |
694 | </dl> | |
695 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> | |
696 | <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a>, | |
697 | <br> | |
698 | <a href='http://localhost:631/help'>http://localhost:631/help</a> | |
699 | ||
700 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> | |
0fa6c7fa | 701 | Copyright 2007-2013 by Apple Inc. |
a2326b5b MS |
702 | |
703 | </body> | |
704 | </html> |