4 .\" ipptool man page for CUPS.
6 .\" Copyright 2010 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" "9 November 2010" "Apple Inc."
16 ipptool - perform internet printing protocol requests
19 [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
31 ] [ -q ] [ -t ] [ -v ]
38 \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.
40 The following options are recognized by \fIipptool\fR:
43 Specifies that \fIipptool\fR must connect to the printer or server using IPv4.
46 Specifies that \fIipptool\fR must connect to the printer or server using IPv6.
49 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.
52 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
55 Specifies that \fIipptool\fR will continue past errors.
58 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.
61 Forces (dedicated) SSL encryption when connecting to the server.
64 Specifies a timeout for IPP requests in seconds.
67 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.
70 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.
73 Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
76 Defines the named variable.
79 Defines the default request filename for tests.
82 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.
85 Specifies that plain text output is desired.
88 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.
91 Specifies that CUPS test report output is desired instead of the plain text output.
94 Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output.
96 The \fIipptool\fR program is unique to CUPS.
98 Get a list of completed jobs for "myprinter":
100 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
103 Send email notifications to "user@example.com" when "myprinter" changes:
105 ipptool -d recipient=mailto:user@example.com \
106 ipp://localhost/printers/myprinter create-printer-subscription.test
109 The following standard files are available:
111 create-printer-subscription.test
112 get-completed-jobs.test
123 \fIipptoolfile(5)\fR,
125 http://localhost:631/help
127 Copyright 2007-2010 by Apple Inc.