4 .\" Copyright © 2010-2019 by Apple Inc.
6 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more
9 .TH ipptool 1 "CUPS" "26 April 2019" "Apple Inc."
11 ipptool \- perform internet printing protocol requests
20 .B \-\-stop\-after\-include\-error
77 sends IPP requests to the specified
79 and tests and/or displays the results.
82 defines one or more requests, including the expected response status, attributes, and values.
83 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.
86 format is described in
89 The following options are recognized by
95 \fB\-\-ippserver \fIfilename\fR
96 Specifies that the test results should be written to the named
100 .B \-\-stop-after-include-error
103 to stop if an error occurs in an included file. Normally
105 will continue with subsequent tests after the INCLUDE directive.
115 must connect to the printer or server using IPv4.
120 must connect to the printer or server using IPv6.
123 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.
124 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
127 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
132 will continue past errors.
135 Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP.
136 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
138 .BI \-P \ filename.plist
139 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).
140 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
143 Forces (dedicated) TLS encryption when connecting to the server.
146 Specifies a timeout for IPP requests in seconds.
149 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.
152 Specifies that XML (Apple plist) output is desired instead of the plain text report.
153 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
156 Specifies that CSV (comma\-separated values) output is desired instead of the plain text output.
159 Defines the named variable.
162 Defines the default request filename for tests.
165 Validate HTTP response headers.
168 Specifies that the (last)
170 should be repeated at the specified interval.
171 This option is incompatible with the \fB\-X\fR (XML plist output) option.
174 Specifies that plain text output is desired.
176 .BI \-n \ repeat\-count
177 Specifies that the (last)
179 should be repeated the specified number of times.
180 This option is incompatible with the \fI\-X\fR (XML plist output) option.
183 Be quiet and produce no output.
186 Specifies that CUPS test report output is desired instead of the plain text output.
189 Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR).
190 This is the default for XML output.
194 program returns 0 if all tests were successful and 1 otherwise.
196 The following standard files are available:
199 .I create\-printer\-subscription.test
202 .I document\-letter.pdf
203 .I document\-letter.ps
204 .I get\-completed\-jobs.test
206 .I get\-notifications.test
207 .I get\-printer\-attributes.test
208 .I get\-subscriptions.test
214 .I ipp\-everywhere.test
217 .I onepage\-letter.pdf
218 .I onepage\-letter.ps
220 .I print\-job\-deflate.test
221 .I print\-job\-gzip.test
227 .I validate\-job.test
232 program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
234 Get a list of completed jobs for "myprinter":
237 ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test
240 Send email notifications to "user@example.com" when "myprinter" changes:
243 ipptool \-d recipient=mailto:user@example.com \\
244 ipp://localhost/printers/myprinter create\-printer\-subscription.test
248 IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations),
249 PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
250 RFC 8011 (http://tools.ietf.org/html/rfc8011),
252 Copyright \[co] 2007-2019 by Apple Inc.