1ipptool(1) Apple Inc. ipptool(1)
2
3
4
6 ipptool - perform internet printing protocol requests
7
9 ipptool [ --help ] [ --ippserver filename ] [
10 --stop-after-include-error ] [ --version ] [ -4 ] [ -6 ] [ -C ] [ -E ]
11 [ -I ] [ -L ] [ -P filename.plist ] [ -S ] [ -T seconds ] [ -V version
12 ] [ -X ] [ -c ] [ -d name=value ] [ -f filename ] [ -h ] [ -i seconds ]
13 [ -n repeat-count ] [ -q ] [ -t ] [ -v ] printer-uri testfile [ ...
14 testfile ]
15
17 ipptool sends IPP requests to the specified printer-uri and tests
18 and/or displays the results. Each named testfile defines one or more
19 requests, including the expected response status, attributes, and val‐
20 ues. Output is either a plain text, formatted text, CSV, or XML report
21 on the standard output, with a non-zero exit status indicating that one
22 or more tests have failed. The testfile format is described in ipp‐
23 toolfile(5).
24
26 The following options are recognized by ipptool:
27
28 --help
29 Shows program help.
30
31 --ippserver filename
32 Specifies that the test results should be written to the named
33 ippserver attributes file.
34
35 --stop-after-include-error
36 Tells ipptool to stop if an error occurs in an included file. Nor‐
37 mally ipptool will continue with subsequent tests after the
38 INCLUDE directive.
39
40 --version
41 Shows the version of ipptool being used.
42
43 -4 Specifies that ipptool must connect to the printer or server using
44 IPv4.
45
46 -6 Specifies that ipptool must connect to the printer or server using
47 IPv6.
48
49 -C Specifies that requests should be sent using the HTTP/1.1 "Trans‐
50 fer-Encoding: chunked" header, which is required for conformance
51 by all versions of IPP. The default is to use "Transfer-Encoding:
52 chunked" for requests with attached files and "Content-Length:"
53 for requests without attached files.
54
55 -E Forces TLS encryption when connecting to the server using the HTTP
56 "Upgrade" header.
57
58 -I Specifies that ipptool will continue past errors.
59
60 -L Specifies that requests should be sent using the HTTP/1.0 "Con‐
61 tent-Length:" header, which is required for conformance by all
62 versions of IPP. The default is to use "Transfer-Encoding: chun‐
63 ked" for requests with attached files and "Content-Length:" for
64 requests without attached files.
65
66 -P filename.plist
67 Specifies that the test results should be written to the named XML
68 (Apple plist) file in addition to the regular test report (-t).
69 This option is incompatible with the -i (interval) and -n
70 (repeat-count) options.
71
72 -S Forces (dedicated) TLS encryption when connecting to the server.
73
74 -T seconds
75 Specifies a timeout for IPP requests in seconds.
76
77 -V version
78 Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or
79 2.2. If not specified, version 1.1 is used.
80
81 -X Specifies that XML (Apple plist) output is desired instead of the
82 plain text report. This option is incompatible with the -i
83 (interval) and -n (repeat-count) options.
84
85 -c Specifies that CSV (comma-separated values) output is desired
86 instead of the plain text output.
87
88 -d name=value
89 Defines the named variable.
90
91 -f filename
92 Defines the default request filename for tests.
93
94 -h Validate HTTP response headers.
95
96 -i seconds
97 Specifies that the (last) testfile should be repeated at the spec‐
98 ified interval. This option is incompatible with the -X (XML
99 plist output) option.
100
101 -l Specifies that plain text output is desired.
102
103 -n repeat-count
104 Specifies that the (last) testfile should be repeated the speci‐
105 fied number of times. This option is incompatible with the -X
106 (XML plist output) option.
107
108 -q Be quiet and produce no output.
109
110 -t Specifies that CUPS test report output is desired instead of the
111 plain text output.
112
113 -v Specifies that all request and response attributes should be out‐
114 put in CUPS test mode (-t). This is the default for XML output.
115
117 The ipptool program returns 0 if all tests were successful and 1 other‐
118 wise.
119
121 The following standard files are available:
122 color.jpg
123 create-printer-subscription.test
124 document-a4.pdf
125 document-a4.ps
126 document-letter.pdf
127 document-letter.ps
128 get-completed-jobs.test
129 get-jobs.test
130 get-notifications.test
131 get-printer-attributes.test
132 get-subscriptions.test
133 gray.jpg
134 ipp-1.1.test
135 ipp-2.0.test
136 ipp-2.1.test
137 ipp-2.2.test
138 ipp-everywhere.test
139 onepage-a4.pdf
140 onepage-a4.ps
141 onepage-letter.pdf
142 onepage-letter.ps
143 print-job.test
144 print-job-deflate.test
145 print-job-gzip.test
146 testfile.jpg
147 testfile.pcl
148 testfile.pdf
149 testfile.ps
150 testfile.txt
151 validate-job.test
152
154 The ipptool program is unique to CUPS and conforms to the Internet
155 Printing Protocol up to version 2.2.
156
158 Get a list of completed jobs for "myprinter":
159
160 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
161
162 Send email notifications to "user@example.com" when "myprinter"
163 changes:
164
165 ipptool -d recipient=mailto:user@example.com \
166 ipp://localhost/printers/myprinter create-printer-subscription.test
167
169 ipptoolfile(5), IANA IPP Registry (http://www.iana.org/assign‐
170 ments/ipp-registrations), PWG Internet Printing Protocol Workgroup
171 (http://www.pwg.org/ipp) RFC 8011 (http://tools.ietf.org/html/rfc8011),
172
174 Copyright © 2007-2019 by Apple Inc.
175
176
177
17826 April 2019 CUPS ipptool(1)