4 .\" Copyright 2010-2018 by Apple Inc.
6 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
8 .TH ipptool 1 "CUPS" "1 November 2017" "Apple Inc."
10 ipptool \- perform internet printing protocol requests
19 .B \-\-stop\-after\-include\-error
76 sends IPP requests to the specified
78 and tests and/or displays the results.
81 defines one or more requests, including the expected response status, attributes, and values.
82 Output is either a plain text, formatted text, CSV, or XML report on the standard output, with a non-zero exit status indicating that one or more tests have failed.
85 format is described in
88 The following options are recognized by
94 \fB\-\-ippserver \fIfilename\fR
95 Specifies that the test results should be written to the named
99 .B \-\-stop-after-include-error
102 to stop if an error occurs in an included file. Normally
104 will continue with subsequent tests after the INCLUDE directive.
114 must connect to the printer or server using IPv4.
119 must connect to the printer or server using IPv6.
122 Specifies that requests should be sent using the HTTP/1.1 "Transfer\-Encoding: chunked" header, which is required for conformance by all versions of IPP.
123 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
126 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
131 will continue past errors.
134 Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP.
135 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
137 .BI \-P \ filename.plist
138 Specifies that the test results should be written to the named XML (Apple plist) file in addition to the regular test report (\fB\-t\fR).
139 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
142 Forces (dedicated) TLS encryption when connecting to the server.
145 Specifies a timeout for IPP requests in seconds.
148 Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not specified, version 1.1 is used.
151 Specifies that XML (Apple plist) output is desired instead of the plain text report.
152 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
155 Specifies that CSV (comma\-separated values) output is desired instead of the plain text output.
158 Defines the named variable.
161 Defines the default request filename for tests.
164 Validate HTTP response headers.
167 Specifies that the (last)
169 should be repeated at the specified interval.
170 This option is incompatible with the \fB\-X\fR (XML plist output) option.
173 Specifies that plain text output is desired.
175 .BI \-n \ repeat\-count
176 Specifies that the (last)
178 should be repeated the specified number of times.
179 This option is incompatible with the \fI\-X\fR (XML plist output) option.
182 Be quiet and produce no output.
185 Specifies that CUPS test report output is desired instead of the plain text output.
188 Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR).
189 This is the default for XML output.
193 program returns 0 if all tests were successful and 1 otherwise.
195 The following standard files are available:
198 .I create\-printer\-subscription.test
201 .I document\-letter.pdf
202 .I document\-letter.ps
203 .I get\-completed\-jobs.test
205 .I get\-notifications.test
206 .I get\-printer\-attributes.test
207 .I get\-subscriptions.test
213 .I ipp\-everywhere.test
216 .I onepage\-letter.pdf
217 .I onepage\-letter.ps
219 .I print\-job\-deflate.test
220 .I print\-job\-gzip.test
226 .I validate\-job.test
231 program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
233 Get a list of completed jobs for "myprinter":
236 ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test
239 Send email notifications to "user@example.com" when "myprinter" changes:
242 ipptool \-d recipient=mailto:user@example.com \\
243 ipp://localhost/printers/myprinter create\-printer\-subscription.test
247 IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations),
248 PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
249 RFC 8011 (http://tools.ietf.org/html/rfc8011),
251 Copyright \[co] 2007-2018 by Apple Inc.