1ipptool(1) Apple Inc. ipptool(1)
2
6 ipptool - perform internet printing protocol requests
7
9 ipptool [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T seconds ]
10 [ -V version ] [ -X ] [ -c ] [ -d name=value ] [ -f filename ] [ -i
11 seconds ] [ -n repeat-count ] [ -q ] [ -t ] [ -v ] URI filename [ ...
12 filenameN ]
13
15 ipptool sends IPP requests to the specified URI and tests and/or dis‐
16 plays the results. Each named file defines one or more requests,
17 including the expected response status, attributes, and values. Output
18 is either a plain text, formatted text, CSV, or XML report on the stan‐
19 dard output, with a non-zero exit status indicating that one or more
20 tests have failed. The file format is described in ipptoolfile(5).
21
23 The following options are recognized by ipptool:
24 -4 Specifies that ipptool must connect to the printer or server using
26 IPv4.
27 -6 Specifies that ipptool must connect to the printer or server using
29 IPv6.
30 -C Specifies that requests should be sent using the HTTP/1.1 "Trans‐
32 fer-Encoding: chunked" header, which is required for conformance
33 by all versions of IPP. The default is to use "Transfer-Encoding:
34 chunked" for requests with attached files and "Content-Length:"
35 for requests without attached files.
36 -E Forces TLS encryption when connecting to the server using the HTTP
38 "Upgrade" header.
39 -I Specifies that ipptool will continue past errors.
41 -L Specifies that requests should be sent using the HTTP/1.0 "Con‐
43 tent-Length:" header, which is required for conformance by all
44 versions of IPP. The default is to use "Transfer-Encoding: chun‐
45 ked" for requests with attached files and "Content-Length:" for
46 requests without attached files.
47 -S Forces (dedicated) SSL encryption when connecting to the server.
49 -T seconds
51 Specifies a timeout for IPP requests in seconds.
52 -V version
54 Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or
55 2.2. If not specified, version 1.1 is used.
56 -X Specifies that XML (Apple plist) output is desired instead of the
58 plain text report. This option is incompatible with the -i (inter‐
59 val) and -n (repeat-count) options.
60 -c Specifies that CSV (comma-separated values) output is desired
62 instead of the plain text output.
63 -d name=value
65 Defines the named variable.
66 -f filename
68 Defines the default request filename for tests.
69 -i seconds
71 Specifies that the (last) file should be repeated at the specified
72 interval. This option is incompatible with the -X (XML plist out‐
73 put) option.
74 -l Specifies that plain text output is desired.
76 -n repeat-count
78 Specifies that the (last) file should be repeated the specified
79 number of times. This option is incompatible with the -X (XML
80 plist output) option.
81 -t Specifies that CUPS test report output is desired instead of the
83 plain text output.
84 -v Specifies that all request and response attributes should be out‐
86 put in CUPS test mode (-t). This is the default for XML output.
87
89 The ipptool program is unique to CUPS.
90
92 Get a list of completed jobs for "myprinter":
93 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
94 Send email notifications to "user@example.com" when "myprinter"
96 changes:
97 ipptool -d recipient=mailto:user@example.com ipp://localhost/printers/myprinter create-printer-subscription.test
98
100 The following standard files are available:
101 color.jpg
102 create-printer-subscription.test
103 document-a4.pdf
104 document-a4.ps
105 document-letter.pdf
106 document-letter.ps
107 get-completed-jobs.test
108 get-jobs.test
109 get-printer-attributes.test
110 gray.jpg
111 ipp-1.1.test
112 ipp-2.0.test
113 ipp-2.1.test
114 ipp-2.2.test
115 onepage-a4.pdf
116 onepage-a4.ps
117 onepage-letter.pdf
118 onepage-letter.ps
119 print-job.test
120 testfile.jpg
121 testfile.pdf
122 testfile.ps
123 testfile.txt
124
126 ipptoolfile(5),
127 http://localhost:631/help
128
130 Copyright 2007-2013 by Apple Inc.
1319 November 2010 CUPS ipptool(1)