]> git.ipfire.org Git - thirdparty/cups.git/blame - man/ipptoolfile.man
The ipptool program now supports EXPECT statements for collection member
[thirdparty/cups.git] / man / ipptoolfile.man
CommitLineData
f8b3a85b
MS
1.\"
2.\" "$Id$"
3.\"
3a43047f 4.\" ipptoolfile man page for CUPS.
f8b3a85b 5.\"
3a43047f 6.\" Copyright 2010-2014 by Apple Inc.
f8b3a85b 7.\"
3a43047f
MS
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/".
f8b3a85b 13.\"
6b13fa61 14.TH ipptoolfile 5 "CUPS" "9 April 2014" "Apple Inc."
f8b3a85b 15.SH NAME
aaf19ab0 16ipptoolfile \- ipptool file format
f8b3a85b 17.SH DESCRIPTION
6b13fa61
MS
18The
19.BR ipptool (1)
20program 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:
f8b3a85b
MS
21.nf
22
23 # This is a comment
24 {
25 # The name of the test
6b13fa61 26 NAME "Print PostScript File"
f8b3a85b
MS
27
28 # The request to send
6b13fa61
MS
29 OPERATION Print\-Job
30 GROUP operation\-attributes\-tag
31 ATTR charset attributes\-charset utf\-8
32 ATTR language attributes\-natural\-language en
33 ATTR uri printer\-uri $uri
34 ATTR name requesting\-user\-name $user
f8b3a85b
MS
35 FILE testfile.ps
36
37 # The response to expect
6b13fa61
MS
38 STATUS successful\-ok
39 EXPECT job\-id OF\-TYPE integer WITH\-VALUE >0
40 EXPECT job\-uri OF\-TYPE uri
f8b3a85b
MS
41 }
42 {
43 # The name of the test
44 NAME "Get Attributes of PostScript Job"
45
46 # The request to send
6b13fa61
MS
47 OPERATION Get\-Job\-Attributes
48 GROUP operation\-attributes\-tag
49 ATTR charset attributes\-charset utf\-8
50 ATTR language attributes\-natural\-language en
51 ATTR uri printer\-uri $uri
52 ATTR integer job\-id $job\-id
53 ATTR name requesting\-user\-name $user
f8b3a85b
MS
54
55 # The response to expect
6b13fa61
MS
56 STATUS successful\-ok
57 EXPECT job\-id OF\-TYPE integer WITH\-VALUE $job\-id
58 EXPECT job\-uri OF\-TYPE uri
59 EXPECT job\-state OF\-TYPE enum WITH\-VALUE 3,4,5,6,7,8,9
60 EXPECT job\-originating\-user\-name OF\-TYPE name WITH\-VALUE "$user"
f8b3a85b
MS
61 }
62.fi
6b13fa61
MS
63.SS TOP-LEVEL DIRECTIVES
64The following directives can be used outside of a \fItest\fR:
f8b3a85b 65.TP 5
6b13fa61 66\fB{ \fItest \fB}\fR
f8b3a85b
MS
67Defines a test.
68.TP 5
6b13fa61
MS
69\fBDEFINE \fIvariable-name value\fR
70Defines the named variable to the given value. This is equivalent to specifying \fI\-d variable-name=value\fR on the
71.BR ipptool (8)
72command-line.
f8b3a85b 73.TP 5
6b13fa61
MS
74\fBDEFINE\-DEFAULT \fIvariable-name value\fR
75Defines the named variable to the given value if it does not already have a value.
321d8d57 76.TP 5
6b13fa61 77\fBFILE\-ID "\fIidentifier\fB"\fR
1d47b929
MS
78Specifies an identifier string for the current file.
79.TP 5
6b13fa61 80\fBIGNORE\-ERRORS yes\fR
030ae6a1 81.TP 5
6b13fa61
MS
82\fBIGNORE\-ERRORS no\fR
83Specifies whether, by default,
84.BR ipptool (8)
85will ignore errors and continue with subsequent tests.
030ae6a1 86.TP 5
6b13fa61 87\fBINCLUDE "\fIfilename\fB"\fR
f8b3a85b 88.TP 5
6b13fa61
MS
89\fBINCLUDE <\fIfilename\fB>\fR
90Includes another test file. The first form includes a file relative to the current test file, while the second form includes a file from the
91.BR ipptool (8)
f8b3a85b
MS
92include directory.
93.TP 5
6b13fa61 94\fBINCLUDE\-IF\-DEFINED \fIname \fB"\fIfilename\fB"\fR
321d8d57 95.TP 5
6b13fa61
MS
96\fBINCLUDE\-IF\-DEFINED \fIname \fB<\fIfilename\fB>\fR
97Includes 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
98.BR ipptool (8)
99include directory.
321d8d57 100.TP 5
6b13fa61 101\fBINCLUDE\-IF\-NOT\-DEFINED \fIname \fB"\fIfilename\fB"\fR
321d8d57 102.TP 5
6b13fa61
MS
103\fBINCLUDE\-IF\-NOT\-DEFINED \fIname \fB<\fIfilename\fB>\fR
104Includes 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
105.BR ipptool (8)
106include directory.
321d8d57 107.TP 5
6b13fa61 108\fBSKIP\-IF\-DEFINED \fIvariable-name\fR
030ae6a1 109.TP 5
6b13fa61
MS
110\fBSKIP\-IF\-NOT\-DEFINED \fIvariable-name\fR
111Specifies that the remainder of the test file should be skipped when the variable is or is not defined.
030ae6a1 112.TP 5
6b13fa61 113\fBSTOP\-AFTER\-INCLUDE\-ERROR no\fR
9475ec92 114.TP 5
6b13fa61 115\fBSTOP\-AFTER\-INCLUDE\-ERROR yes\fR
9475ec92
MS
116Specifies whether tests will be stopped after an error in an included file.
117.TP 5
6b13fa61
MS
118\fBTRANSFER auto\fR
119Specifies that tests will, by default, use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
f8b3a85b 120.TP 5
6b13fa61
MS
121\fBTRANSFER chunked\fR
122Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: chunked" header. This is the default and is equivalent to specifying \fI\-c\fR on the
123.BR ipptool (8)
124command-line. Support for chunked requests is required for conformance with all versions of IPP.
f8b3a85b 125.TP 5
6b13fa61
MS
126\fBTRANSFER length\fR
127Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" header. This is equivalent to specifying \fI\-l\fR on the
128.BR ipptool (8)
129command-line. Support for content length requests is required for conformance with all versions of IPP.
f8b3a85b 130.TP 5
6b13fa61 131\fBVERSION 1.0\fR
f8b3a85b 132.TP 5
6b13fa61 133\fBVERSION 1.1\fR
f8b3a85b 134.TP 5
6b13fa61 135\fBVERSION 2.0\fR
f8b3a85b 136.TP 5
6b13fa61 137\fBVERSION 2.1\fR
f8b3a85b 138.TP 5
6b13fa61 139\fBVERSION 2.2\fR
f8b3a85b 140Specifies the default IPP version number to use for the tests that follow.
6b13fa61
MS
141.SS TEST DIRECTIVES
142The following directives are understood within a \fItest\fR:
f8b3a85b 143.TP 5
6b13fa61
MS
144\fBATTR \fItag attribute-name value(s)\fR
145Adds 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.
f8b3a85b 146.TP 5
6b13fa61
MS
147\fBATTR collection \fIattribute-name \fB{ MEMBER \fItag member-name value(s) ... \fB}\fR [ \fI... \fB,{ \fI... \fB} \fR]
148Adds 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.
f8b3a85b 149.TP 5
6b13fa61 150\fBCOMPRESSION deflate\fR
c41769ff 151.TP 5
6b13fa61 152\fBCOMPRESSION gzip\fR
c41769ff 153.TP 5
6b13fa61
MS
154\fBCOMPRESSION none\fR
155Uses the specified compression on the document data following the attributes in a Print-Job or Send-Document request.
c41769ff 156.TP 5
6b13fa61 157\fBDELAY \fIseconds\fR
f8b3a85b
MS
158Specifies a delay before this test will be run.
159.TP 5
6b13fa61 160\fBDISPLAY \fIattribute-name\fR
f8b3a85b
MS
161Specifies that value of the named attribute should be output as part of the
162test report.
163.TP 5
6b13fa61 164\fBEXPECT \fIattribute-name \fR[ \fIpredicate(s) \fR]
f8b3a85b 165.TP 5
6b13fa61 166\fBEXPECT ?\fIattribute-name predicate(s)\fR
f8b3a85b 167.TP 5
6b13fa61
MS
168\fBEXPECT !\fIattribute-name\fR
169Specifies 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".
f8b3a85b 170.TP 5
6b13fa61
MS
171\fBFILE filename\fR
172Specifies a file to include at the end of the request. This is typically used when sending a test print file.
f8b3a85b 173.TP 5
6b13fa61 174\fBGROUP tag\fR
f8b3a85b
MS
175Specifies the group tag for subsequent attributes in the request.
176.TP 5
6b13fa61 177\fBIGNORE\-ERRORS yes\fR
030ae6a1 178.TP 5
6b13fa61
MS
179\fBIGNORE\-ERRORS no\fR
180Specifies whether
181.BR ipptool (8)
182will ignore errors and continue with subsequent tests.
030ae6a1 183.TP 5
6b13fa61 184\fBNAME "\fIliteral string\fB"\fR
f8b3a85b
MS
185Specifies the human-readable name of the test.
186.TP 5
6b13fa61 187\fBOPERATION \fIoperation-code\fR
f8b3a85b
MS
188Specifies the operation to be performed.
189.TP 5
6b13fa61 190\fBREQUEST\-ID \fInumber\fR\fR
f8b3a85b 191.TP 5
6b13fa61
MS
192\fBREQUEST\-ID random\fR
193Specifies the request-id value to use in the request, either an integer or the word "random" to use a randomly generated value (the default).
f8b3a85b 194.TP 5
6b13fa61
MS
195\fBRESOURCE \fIpath\fR
196Specifies an alternate resource path that is used for the HTTP POST request. The default is the resource from the URI provided to the
197.BR ipptool (8)
198program.
f8b3a85b 199.TP 5
6b13fa61 200\fBSKIP\-IF\-DEFINED \fIvariable-name\fR
030ae6a1 201.TP 5
6b13fa61
MS
202\fBSKIP\-IF\-NOT\-DEFINED \fIvariable-name\fR
203Specifies that the current test should be skipped when the variable is or is not defined.
030ae6a1 204.TP 5
6b13fa61 205\fBSKIP\-PREVIOUS\-ERROR yes\fR
030ae6a1 206.TP 5
6b13fa61
MS
207\fBSKIP\-PREVIOUS\-ERROR no\fR
208Specifies whether
209.BR ipptool (8)
210will skip the current test if the previous test resulted in an error/failure.
030ae6a1 211.TP 5
6b13fa61
MS
212\fBSTATUS \fIstatus-code \fR[ \fIpredicate\fR ]
213Specifies an expected response status-code value. Additional requirements can be added as predicates - see the "STATUS PREDICATES" section for more information on predicates.
f8b3a85b 214.TP 5
6b13fa61 215\fBTEST\-ID "\fIidentifier\fR"
1d47b929
MS
216Specifies an identifier string for the current test.
217.TP 5
6b13fa61
MS
218\fBTRANSFER auto\fR
219Specifies that this test will use "Transfer-Encoding: chunked" if it has an attached file or "Content-Length:" otherwise.
f8b3a85b 220.TP 5
6b13fa61
MS
221\fBTRANSFER chunked\fR
222Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header.
f8b3a85b 223.TP 5
6b13fa61 224\fBTRANSFER length\fR
f8b3a85b
MS
225Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
226.TP 5
6b13fa61 227\fBVERSION 1.0\fR
f8b3a85b 228.TP 5
6b13fa61 229\fBVERSION 1.1\fR
f8b3a85b 230.TP 5
6b13fa61 231\fBVERSION 2.0\fR
f8b3a85b 232.TP 5
6b13fa61 233\fBVERSION 2.1\fR
f8b3a85b 234.TP 5
6b13fa61 235\fBVERSION 2.2\fR
f8b3a85b 236Specifies the IPP version number to use for this test.
6b13fa61
MS
237.SS EXPECT PREDICATES
238The following predicates are understood following the \fBEXPECT\fR test directive:
f8b3a85b 239.TP 5
6b13fa61
MS
240\fBCOUNT \fInumber\fR
241Requires the \fBEXPECT\fR attribute to have the specified number of values.
f8b3a85b 242.TP 5
6b13fa61
MS
243\fBDEFINE\-MATCH \fIvariable-name\fR
244Defines the variable to "1" when the \fBEXPECT\fR condition matches. A side-effect of this predicate is that this \fBEXPECT\fR will never fail a test.
030ae6a1 245.TP 5
6b13fa61
MS
246\fBDEFINE\-NO\-MATCH \fIvariable-name\fR
247Defines the variable to "1" when the \fBEXPECT\fR condition does not match. A side-effect of this predicate is that this \fBEXPECT\fR will never fail a test.
030ae6a1 248.TP 5
6b13fa61
MS
249\fBDEFINE\-VALUE \fIvariable-name\fR
250Defines the variable to the value of the attribute when the \fBEXPECT\fR condition matches. A side-effect of this predicate is that this \fBEXPECT\fR will never fail a test.
030ae6a1 251.TP 5
6b13fa61
MS
252\fBIF\-DEFINED \fIvariable-name\fR
253Makes the \fBEXPECT\fR conditions apply only if the specified variable is defined.
f8b3a85b 254.TP 5
6b13fa61
MS
255\fBIF\-NOT\-DEFINED \fIvariable-name\fR
256Makes the \fBEXPECT\fR conditions apply only if the specified variable is not defined.
f8b3a85b 257.TP 5
6b13fa61
MS
258\fBIN\-GROUP \fItag\fR
259Requires the \fBEXPECT\fR attribute to be in the specified group tag.
f8b3a85b 260.TP 5
6b13fa61
MS
261\fBOF\-TYPE \fItag[,tag,...]\fR
262Requires the \fBEXPECT\fR attribute to use one of the specified value tag(s).
f8b3a85b 263.TP 5
6b13fa61 264\fBREPEAT\-LIMIT \fInumber\fR
a29fd7dd 265.br
6b13fa61 266Specifies the maximum number of times to repeat if the \fBREPEAT-MATCH\fR or \fBREPEAT-NO-MATCH\fR predicate is specified. The default value is 1000.
a29fd7dd 267.TP 5
6b13fa61 268\fBREPEAT\-MATCH\fR
83e08001 269.TP 5
6b13fa61
MS
270\fBREPEAT\-NO\-MATCH\fR
271Specifies that the current test should be repeated when the \fBEXPECT\fR condition matches or does not match.
83e08001 272.TP 5
6b13fa61
MS
273\fBSAME\-COUNT\-AS \fIattribute-name\fR
274Requires the \fBEXPECT\fR attribute to have the same number of values as the specified parallel attribute.
f8b3a85b 275.TP 5
6b13fa61 276\fBWITH\-ALL\-HOSTNAMES "\fIliteral string\fB"\fR
890a10b7 277.TP 5
6b13fa61 278\fBWITH\-ALL\-HOSTNAMES "/\fIregular expression\fB/"\fR
890a10b7
MS
279Requires that all URI values contain a matching hostname.
280.TP 5
6b13fa61 281\fBWITH\-ALL\-RESOURCES "\fIliteral string\fB"\fR
890a10b7 282.TP 5
6b13fa61 283\fBWITH\-ALL\-RESOURCES "/\fIregular expression\fB/"\fR
890a10b7
MS
284Requires that all URI values contain a matching resource (including leading /).
285.TP 5
6b13fa61 286\fBWITH\-ALL\-SCHEMES "\fIliteral string\fB"\fR
890a10b7 287.TP 5
6b13fa61 288\fBWITH\-ALL-SCHEMES "/\fIregular expression\fB/"\fR
890a10b7
MS
289Requires that all URI values contain a matching scheme.
290.TP 5
6b13fa61
MS
291\fBWITH\-ALL\-VALUES "\fIliteral string\fB"\fR
292Requires that all values of the \fBEXPECT\fR attribute match the literal string. Comparisons are case-sensitive.
82cc1f9a 293.TP 5
6b13fa61 294\fBWITH\-ALL\-VALUES <\fInumber\fR
82cc1f9a 295.TP 5
6b13fa61 296\fBWITH\-ALL\-VALUES =\fInumber\fR
82cc1f9a 297.TP 5
6b13fa61 298\fBWITH\-ALL\-VALUES >\fInumber\fR
82cc1f9a 299.TP 5
6b13fa61
MS
300\fBWITH\-ALL\-VALUES \fInumber\fR[\fI,...,number\fR]
301Requires that all values of the \fBEXPECT\fR attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
82cc1f9a 302.TP 5
6b13fa61 303\fBWITH\-ALL\-VALUES "false"\fR
82cc1f9a 304.TP 5
6b13fa61
MS
305\fBWITH\-ALL\-VALUES "true"\fR
306Requires that all values of the \fBEXPECT\fR attribute match the boolean value given.
82cc1f9a 307.TP 5
6b13fa61
MS
308\fBWITH\-ALL\-VALUES "/\fIregular expression\fB/"\fR
309Requires that all values of the \fBEXPECT\fR attribute match the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
82cc1f9a 310.TP 5
6b13fa61 311\fBWITH\-HOSTNAME "\fIliteral string\fB"\fR
890a10b7 312.TP 5
6b13fa61 313\fBWITH\-HOSTNAME "/\fIregular expression\fB/"\fR
890a10b7
MS
314Requires that at least one URI value contains a matching hostname.
315.TP 5
6b13fa61 316\fBWITH\-RESOURCE "\fIliteral string\fB"\fR
890a10b7 317.TP 5
6b13fa61 318\fBWITH\-RESOURCE "/\fIregular expression\fB/"\fR
890a10b7
MS
319Requires that at least one URI value contains a matching resource (including leading /).
320.TP 5
6b13fa61 321\fBWITH\-SCHEME "\fIliteral string\fB"\fR
890a10b7 322.TP 5
6b13fa61 323\fBWITH\-SCHEME "/\fIregular expression\fB/"\fR
890a10b7
MS
324Requires that at least one URI value contains a matching scheme.
325.TP 5
6b13fa61
MS
326\fBWITH\-VALUE "\fIliteral string\fB"\fR
327Requires that at least one value of the \fBEXPECT\fR attribute matches the literal string. Comparisons are case-sensitive.
82cc1f9a 328.TP 5
6b13fa61 329\fBWITH\-VALUE <\fInumber\fR
82cc1f9a 330.TP 5
6b13fa61 331\fBWITH\-VALUE =\fInumber\fR
82cc1f9a 332.TP 5
6b13fa61 333\fBWITH\-VALUE >\fInumber\fR
82cc1f9a 334.TP 5
6b13fa61
MS
335\fBWITH\-VALUE \fInumber\fR[\fI,...,number\fR]
336Requires that at least one value of the \fBEXPECT\fR attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
82cc1f9a 337.TP 5
6b13fa61 338\fBWITH\-VALUE "false"\fR
82cc1f9a 339.TP 5
6b13fa61
MS
340\fBWITH\-VALUE "true"\fR
341Requires that at least one value of the \fBEXPECT\fR attribute matches the boolean value given.
f8b3a85b 342.TP 5
6b13fa61
MS
343\fBWITH\-VALUE "/\fIregular expression\fB/"\fR
344Requires that at least one value of the \fBEXPECT\fR attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
345.SS STATUS PREDICATES
346The following predicates are understood following the \fBSTATUS\fR test directive:
f8b3a85b 347.TP 5
6b13fa61
MS
348\fBDEFINE\-MATCH \fIvariable-name\fR
349Defines the variable to "1" when the \fBSTATUS\fR matches. A side-effect of this predicate is that this \fBSTATUS\fR will never fail a test.
0fa6c7fa 350.TP 5
6b13fa61
MS
351\fBDEFINE\-NO\-MATCH \fIvariable-name\fR
352Defines the variable to "1" when the \fBSTATUS\fR does not match. A side-effect of this predicate is that this \fBSTATUS\fR will never fail a test.
0fa6c7fa 353.TP 5
6b13fa61
MS
354\fBIF\-DEFINED \fIvariable-name\fR
355Makes the \fBSTATUS\fR apply only if the specified variable is defined.
f8b3a85b 356.TP 5
6b13fa61
MS
357\fBIF\-NOT\-DEFINED \fIvariable-name\fR
358Makes the \fBSTATUS\fR apply only if the specified variable is not defined.
83e08001 359.TP 5
6b13fa61 360\fBREPEAT\-LIMIT \fInumber\fR
a29fd7dd
MS
361.br
362Specifies the maximum number of times to repeat. The default value is 1000.
363.TP 5
6b13fa61 364\fBREPEAT\-MATCH\fR
83e08001 365.TP 5
6b13fa61
MS
366\fBREPEAT\-NO\-MATCH\fR
367Specifies that the current test should be repeated when the response status-code matches or does not match the value specified by the STATUS directive.
368.SS OPERATION CODES
369Operation 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
370.BR ipptool (8):
f8b3a85b 371.nf
f8b3a85b 372
6b13fa61
MS
373 Activate\-Printer
374 CUPS\-Accept\-Jobs
375 CUPS\-Add\-Modify\-Class
376 CUPS\-Add\-Modify\-Printer
377 CUPS\-Authenticate\-Job
378 CUPS\-Delete\-Class
379 CUPS\-Delete\-Printer
380 CUPS\-Get\-Classes
381 CUPS\-Get\-Default
382 CUPS\-Get\-Devices
383 CUPS\-Get\-Document
384 CUPS\-Get\-PPD
385 CUPS\-Get\-PPDs
386 CUPS\-Get\-Printers
387 CUPS\-Move\-Job
388 CUPS\-Reject\-Jobs
389 CUPS\-Set\-Default
390 Cancel\-Current\-Job
391 Cancel\-Job
392 Cancel\-Jobs
393 Cancel\-My\-Jobs
394 Cancel\-Subscription
395 Close\-Job
396 Create\-Job
397 Create\-Job\-Subscriptions
398 Create\-Printer\-Subscriptions
399 Deactivate\-Printer
400 Disable\-Printer
401 Enable\-Printer
402 Get\-Job\-Attributes
403 Get\-Jobs
404 Get\-Notifications
405 Get\-Printer\-Attributes
406 Get\-Printer\-Support\-Files
407 Get\-Printer\-Supported\-Values
408 Get\-Subscription\-Attributes
409 Get\-Subscriptions
410 Hold\-Job
411 Hold\-New\-Jobs
412 Identify\-Printer
413 Pause\-Printer
414 Pause\-Printer\-After\-Current\-Job
415 Print\-Job
416 Print\-URI
417 Promote\-Job
418 Purge\-Jobs
419 Release\-Held\-New\-Jobs
420 Release\-Job
421 Renew\-Subscription
422 Reprocess\-Job
423 Restart\-Job
424 Restart\-Printer
425 Resubmit\-Job
426 Resume\-Job
427 Resume\-Printer
428 Schedule\-Job\-After
429 Send\-Document
430 Send\-Hardcopy\-Document
431 Send\-Notifications
432 Send\-URI
433 Set\-Job\-Attributes
434 Set\-Printer\-Attributes
435 Shutdown\-Printer
436 Startup\-Printer
437 Suspend\-Current\-Job
438 Validate\-Document
439 Validate\-Job
f8b3a85b 440.fi
6b13fa61
MS
441.SS STATUS CODES
442Status 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
443.BR ipptool (8):
444.nf
f8b3a85b 445
6b13fa61
MS
446 client\-error\-account\-authorization\-failed
447 client\-error\-account\-closed
448 client\-error\-account\-info\-needed
449 client\-error\-account\-limit\-reached
450 client\-error\-attributes\-not\-settable
451 client\-error\-attributes\-or\-values\-not\-supported
452 client\-error\-bad\-request
453 client\-error\-charset\-not\-supported
454 client\-error\-compression\-error
455 client\-error\-compression\-not\-supported
456 client\-error\-conflicting\-attributes
457 client\-error\-document\-access\-error
458 client\-error\-document\-format\-error
459 client\-error\-document\-format\-not\-supported
460 client\-error\-document\-password\-error
461 client\-error\-document\-permission\-error
462 client\-error\-document\-security\-error
463 client\-error\-document\-unprintable\-error
464 client\-error\-forbidden
465 client\-error\-gone
466 client\-error\-ignored\-all\-notifications
467 client\-error\-ignored\-all\-subscriptions
468 client\-error\-not\-authenticated
469 client\-error\-not\-authorized
470 client\-error\-not\-found
471 client\-error\-not\-possible
472 client\-error\-print\-support\-file\-not\-found
473 client\-error\-request\-entity\-too\-large
474 client\-error\-request\-value\-too\-long
475 client\-error\-timeout
476 client\-error\-too\-many\-subscriptions
477 client\-error\-uri\-scheme\-not\-supported
478 cups\-error\-account\-authorization\-failed
479 cups\-error\-account\-closed
480 cups\-error\-account\-info\-needed
481 cups\-error\-account\-limit\-reached
482 cups\-see\-other
483 redirection\-other\-site
484 server\-error\-busy
485 server\-error\-device\-error
486 server\-error\-internal\-error
487 server\-error\-job\-canceled
488 server\-error\-multiple\-document\-jobs\-not\-supported
489 server\-error\-not\-accepting\-jobs
490 server\-error\-operation\-not\-supported
491 server\-error\-printer\-is\-deactivated
492 server\-error\-service\-unavailable
493 server\-error\-temporary\-error
494 server\-error\-version\-not\-supported
495 successful\-ok
496 successful\-ok\-but\-cancel\-subscription
497 successful\-ok\-conflicting\-attributes
498 successful\-ok\-events\-complete
499 successful\-ok\-ignored\-notifications
500 successful\-ok\-ignored\-or\-substituted\-attributes
501 successful\-ok\-ignored\-subscriptions
502 successful\-ok\-too\-many\-events
503.fi
504.SS TAGS
505Value and group tags correspond to the names from RFC 2911 and other IPP extension specifications. Here are the group tags:
f8b3a85b 506.nf
6b13fa61
MS
507
508 document\-attributes\-tag
509 event\-notification\-attributes\-tag
510 job\-attributes\-tag
511 operation\-attributes\-tag
512 printer\-attributes\-tag
513 subscription\-attributes\-tag
514 unsupported\-attributes\-tag
f8b3a85b
MS
515.fi
516.LP
517Here are the value tags:
518.nf
6b13fa61
MS
519
520 admin\-define
f8b3a85b
MS
521 boolean
522 charset
523 collection
524 dateTime
525 default
6b13fa61 526 delete\-attribute
f8b3a85b
MS
527 enum
528 integer
529 keyword
530 mimeMediaType
531 nameWithLanguage
532 nameWithoutLanguage
533 naturalLanguage
6b13fa61
MS
534 no\-value
535 not\-settable
f8b3a85b
MS
536 octetString
537 rangeOfInteger
538 resolution
539 textWithLanguage
540 textWithoutLanguage
541 unknown
542 unsupported
543 uri
544 uriScheme
545.fi
6b13fa61
MS
546.SS VARIABLES
547The
548.BR ipptool (8)
549program maintains a list of variables that can be used in any literal string or attribute value by specifying "\fI$variable-name\fR". Aside from variables defined using the \fI-d\fR option or \fBDEFINE\fR directive, the following pre-defined variables are available:
f8b3a85b 550.TP 5
6b13fa61 551\fB$$\fR
f8b3a85b
MS
552Inserts a single "$" character.
553.TP 5
6b13fa61
MS
554\fB$ENV[\fIname\fB]\fR
555Inserts the value of the named environment variable, or an empty string if the environment variable is not defined.
f8b3a85b 556.TP 5
6b13fa61
MS
557\fB$filename\fR
558Inserts the filename provided to
559.BR ipptool (8)
560with the \fI-f\fR option.
f8b3a85b 561.TP 5
6b13fa61
MS
562\fB$filetype\fR
563Inserts the MIME media type for the filename provided to
564.BR ipptool (8)
565with the \fI-f\fR option.
f8b3a85b 566.TP 5
6b13fa61
MS
567\fB$hostname\fR
568Inserts the hostname from the URI provided to
569.BR ipptool (8).
f8b3a85b 570.TP 5
6b13fa61
MS
571\fB$job\-id\fR
572Inserts the last "job\-id" attribute value returned in a test response or 0 if no "job\-id" attribute has been seen.
f8b3a85b 573.TP 5
6b13fa61
MS
574\fB$job\-uri\fR
575Inserts the last "job\-uri" attribute value returned in a test response or an empty string if no "job\-uri" attribute has been seen.
f8b3a85b 576.TP 5
6b13fa61
MS
577\fB$notify\-subscription\-id\fR
578Inserts the last "notify\-subscription\-id" attribute value returned in a test response or 0 if no "notify\-subscription\-id" attribute has been seen.
f8b3a85b 579.TP 5
6b13fa61
MS
580\fB$port\fR
581Inserts the port number from the URI provided to
582.BR ipptool (8).
f8b3a85b 583.TP 5
6b13fa61
MS
584\fB$resource\fR
585Inserts the resource path from the URI provided to
586.BR ipptool (8).
f8b3a85b 587.TP 5
6b13fa61
MS
588\fB$scheme\fR
589Inserts the scheme from the URI provided to
590.BR ipptool (8).
f8b3a85b 591.TP 5
6b13fa61
MS
592\fB$uri\fR
593Inserts the URI provided to
594.BR ipptool (8).
f8b3a85b 595.TP 5
6b13fa61
MS
596\fB$uriuser\fR
597Inserts the username from the URI provided to
598.BR ipptool (8),
599if any.
600.TP 5
601\fB$user\fR
602Inserts the current user's login name.
f8b3a85b 603.SH SEE ALSO
6b13fa61
MS
604.BR ipptool (1),
605CUPS Online Help (http://localhost:631/help),
606IANA IPP Registry (http://www.iana.org/assignments/ipp-registrations),
607PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp),
608RFC 2911 (http://tools.ietf.org/html/rfc3911)
f8b3a85b 609.SH COPYRIGHT
6b13fa61 610Copyright \[co] 2007-2014 by Apple Inc.
f8b3a85b
MS
611.\"
612.\" End of "$Id$".
613.\"