4 .\" ipptool man page for CUPS.
6 .\" Copyright 2010-2014 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" "15 May 2014" "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. Each named
81 defines one or more requests, including the expected response status, attributes, and values. 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. The
83 format is described in
86 The following options are recognized by
92 .B \-\-stop-after-include-error
95 to stop if an error occurs in an included file. Normally
97 will continue with subsequent tests after the INCLUDE directive.
107 must connect to the printer or server using IPv4.
112 must connect to the printer or server using IPv6.
115 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. The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
118 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
123 will continue past errors.
126 Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP. The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files.
128 .BI \-P \ filename.plist
129 Specifies that the test results should be written to the named XML (Apple plist) file in addition to the plain text report. This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
132 Forces (dedicated) TLS encryption when connecting to the server.
135 Specifies a timeout for IPP requests in seconds.
138 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.
141 Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
144 Specifies that CSV (comma\-separated values) output is desired instead of the plain text output.
147 Defines the named variable.
150 Defines the default request filename for tests.
153 Specifies that the (last)
155 should be repeated at the specified interval. This option is incompatible with the \fB\-X\fR (XML plist output) option.
158 Specifies that plain text output is desired.
160 .BI \-n \ repeat\-count
161 Specifies that the (last)
163 should be repeated the specified number of times. This option is incompatible with the \fI\-X\fR (XML plist output) option.
166 Specifies that CUPS test report output is desired instead of the plain text output.
169 Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR). This is the default for XML output.
173 program returns 0 if all tests were sucessful and 1 otherwise.
175 The following standard files are available:
178 .I create\-printer\-subscription.test
181 .I document\-letter.pdf
182 .I document\-letter.ps
183 .I get\-completed\-jobs.test
185 .I get\-notifications.test
186 .I get\-printer\-attributes.test
187 .I get\-subscriptions.test
193 .I ipp\-everywhere.test
196 .I onepage\-letter.pdf
197 .I onepage\-letter.ps
199 .I print\-job\-deflate.test
200 .I print\-job\-gzip.test
206 .I validate\-job.test
211 program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
213 Get a list of completed jobs for "myprinter":
216 ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test
219 Send email notifications to "user@example.com" when "myprinter" changes:
222 ipptool \-d recipient=mailto:user@example.com \\
223 ipp://localhost/printers/myprinter create\-printer\-subscription.test
227 CUPS Online Help (http://localhost:631/help),
228 IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations),
229 PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
230 RFC 2911 (http://tools.ietf.org/html/rfc2911),
232 Copyright \[co] 2007-2014 by Apple Inc.