4 .\" ipptool man page for CUPS.
6 .\" Copyright 2010-2013 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" "13 May 2013" "Apple Inc."
16 ipptool - perform internet printing protocol requests
19 [ --help ] [ --stop-after-include-error ] [ --version ]
20 [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
32 ] [ -q ] [ -t ] [ -v ]
39 \fIipptool\fR sends IPP requests to the specified URI and tests and/or displays the results. Each named file 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 file format is described in \fIipptoolfile(5)\fR.
41 The following options are recognized by \fIipptool\fR:
45 --stop-after-include-error
46 Tells \fIipptool\fR to stop if an error occurs in an included file. Normally \fIipptool\fR will continue with subsequent tests after the INCLUDE directive.
48 Shows the version of \fIipptool\fR being used.
51 Specifies that \fIipptool\fR must connect to the printer or server using IPv4.
54 Specifies that \fIipptool\fR must connect to the printer or server using IPv6.
57 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.
60 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
63 Specifies that \fIipptool\fR will continue past errors.
66 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.
69 Forces (dedicated) SSL encryption when connecting to the server.
72 Specifies a timeout for IPP requests in seconds.
75 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.
78 Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fI-i\fR (interval) and \fI-n\fR (repeat-count) options.
81 Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
84 Defines the named variable.
87 Defines the default request filename for tests.
90 Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the \fI-X\fR (XML plist output) option.
93 Specifies that plain text output is desired.
96 Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the \fI-X\fR (XML plist output) option.
99 Specifies that CUPS test report output is desired instead of the plain text output.
102 Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output.
104 The \fIipptool\fR program returns 0 if all tests were sucessful and 1 otherwise.
106 The \fIipptool\fR program is unique to CUPS.
108 Get a list of completed jobs for "myprinter":
110 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
113 Send email notifications to "user@example.com" when "myprinter" changes:
115 ipptool -d recipient=mailto:user@example.com \
116 ipp://localhost/printers/myprinter create-printer-subscription.test
119 The following standard files are available:
122 create-printer-subscription.test
127 get-completed-jobs.test
129 get-notifications.test
130 get-printer-attributes.test
131 get-subscriptions.test
143 print-job-deflate.test
153 \fIipptoolfile(5)\fR,
155 http://localhost:631/help
157 Copyright 2007-2013 by Apple Inc.