ipptool(1) Apple Inc. ipptool(1)NAMEipptool - perform internet printing protocol requests
SYNOPSISipptool [ --help ] [ --stop-after-include-error ] [ --version ] [ -4 ]
[ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T seconds ] [ -V version ]
[ -X ] [ -c ] [ -d name=value ] [ -f filename ] [ -i seconds ] [ -n
repeat-count ] [ -q ] [ -t ] [ -v ] URI filename [ ... filenameN ]
DESCRIPTIONipptool sends IPP requests to the specified URI and tests and/or dis‐
plays 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 stan‐
dard output, with a non-zero exit status indicating that one or more
tests have failed. The file format is described in ipptoolfile(5).
The following options are recognized by ipptool:
Shows program help.
Tells ipptool to stop if an error occurs in an included file. Nor‐
mally ipptool will continue with subsequent tests after the
Shows the version of ipptool being used.
-4 Specifies that ipptool must connect to the printer or server using
-6 Specifies that ipptool must connect to the printer or server using
-C Specifies that requests should be sent using the HTTP/1.1 "Trans‐
fer-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.
-E Forces TLS encryption when connecting to the server using the HTTP
-I Specifies that ipptool will continue past errors.
-L Specifies that requests should be sent using the HTTP/1.0 "Con‐
tent-Length:" header, which is required for conformance by all
versions of IPP. The default is to use "Transfer-Encoding: chun‐
ked" for requests with attached files and "Content-Length:" for
requests without attached files.
-S Forces (dedicated) SSL encryption when connecting to the server.
Specifies a timeout for IPP requests in seconds.
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.
-X Specifies that XML (Apple plist) output is desired instead of the
plain text report. This option is incompatible with the -i (inter‐
val) and -n (repeat-count) options.
-c Specifies that CSV (comma-separated values) output is desired
instead of the plain text output.
Defines the named variable.
Defines the default request filename for tests.
Specifies that the (last) file should be repeated at the specified
interval. This option is incompatible with the -X (XML plist out‐
-l Specifies that plain text output is desired.
Specifies that the (last) file should be repeated the specified
number of times. This option is incompatible with the -X (XML
plist output) option.
-t Specifies that CUPS test report output is desired instead of the
plain text output.
-v Specifies that all request and response attributes should be out‐
put in CUPS test mode (-t). This is the default for XML output.
The ipptool program returns 0 if all tests were sucessful and 1 other‐
The ipptool program is unique to CUPS.
Get a list of completed jobs for "myprinter":
ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
Send email notifications to "firstname.lastname@example.org" when "myprinter"
ipptool-d recipient=mailto:email@example.com ipp://localhost/printers/myprinter create-printer-subscription.test
The following standard files are available:
SEE ALSOipptoolfile(5), RFC 2911,
Copyright 2007-2014 by Apple Inc.
20 February 2014 CUPS ipptool(1)