4 .\" ipptool man page for CUPS.
6 .\" Copyright 2010-2015 by Apple Inc.
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/".
14 .TH ipptool 1 "CUPS" "26 August 2015" "Apple Inc."
16 ipptool \- perform internet printing protocol requests
22 .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 .B \-\-stop-after-include-error
98 to stop if an error occurs in an included file. Normally
100 will continue with subsequent tests after the INCLUDE directive.
110 must connect to the printer or server using IPv4.
115 must connect to the printer or server using IPv6.
118 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.
119 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
122 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
127 will continue past errors.
130 Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP.
131 The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
133 .BI \-P \ filename.plist
134 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).
135 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
138 Forces (dedicated) TLS encryption when connecting to the server.
141 Specifies a timeout for IPP requests in seconds.
144 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.
147 Specifies that XML (Apple plist) output is desired instead of the plain text report.
148 This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
151 Specifies that CSV (comma\-separated values) output is desired instead of the plain text output.
154 Defines the named variable.
157 Defines the default request filename for tests.
160 Specifies that the (last)
162 should be repeated at the specified interval.
163 This option is incompatible with the \fB\-X\fR (XML plist output) option.
166 Specifies that plain text output is desired.
168 .BI \-n \ repeat\-count
169 Specifies that the (last)
171 should be repeated the specified number of times.
172 This option is incompatible with the \fI\-X\fR (XML plist output) option.
175 Be quiet and produce no output.
178 Specifies that CUPS test report output is desired instead of the plain text output.
181 Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR).
182 This is the default for XML output.
186 program returns 0 if all tests were successful and 1 otherwise.
188 The following standard files are available:
191 .I create\-printer\-subscription.test
194 .I document\-letter.pdf
195 .I document\-letter.ps
196 .I get\-completed\-jobs.test
198 .I get\-notifications.test
199 .I get\-printer\-attributes.test
200 .I get\-subscriptions.test
206 .I ipp\-everywhere.test
209 .I onepage\-letter.pdf
210 .I onepage\-letter.ps
212 .I print\-job\-deflate.test
213 .I print\-job\-gzip.test
219 .I validate\-job.test
224 program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
226 Get a list of completed jobs for "myprinter":
229 ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test
232 Send email notifications to "user@example.com" when "myprinter" changes:
235 ipptool \-d recipient=mailto:user@example.com \\
236 ipp://localhost/printers/myprinter create\-printer\-subscription.test
240 CUPS Online Help (http://localhost:631/help),
241 IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations),
242 PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
243 RFC 2911 (http://tools.ietf.org/html/rfc2911),
245 Copyright \[co] 2007-2015 by Apple Inc.