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