]>
Commit | Line | Data |
---|---|---|
aaf19ab0 | 1 | .\" |
f1dd3a39 | 2 | .\" ipptool man page. |
aaf19ab0 | 3 | .\" |
f1dd3a39 | 4 | .\" Copyright 2010-2017 by Apple Inc. |
aaf19ab0 | 5 | .\" |
e3101897 | 6 | .\" Licensed under Apache License v2.0. See the file "LICENSE" for more information. |
aaf19ab0 | 7 | .\" |
6646208b | 8 | .TH ipptool 1 "CUPS" "1 November 2017" "Apple Inc." |
aaf19ab0 | 9 | .SH NAME |
6b13fa61 | 10 | ipptool \- perform internet printing protocol requests |
aaf19ab0 MS |
11 | .SH SYNOPSIS |
12 | .B ipptool | |
6b13fa61 MS |
13 | [ |
14 | .B \-\-help | |
15 | ] [ | |
6646208b MS |
16 | .BI \-\-ippserver filename |
17 | ] [ | |
6b13fa61 MS |
18 | .B \-\-stop\-after\-include\-error |
19 | ] [ | |
20 | .B \-\-version | |
21 | ] [ | |
22 | .B \-4 | |
23 | ] [ | |
24 | .B \-6 | |
25 | ] [ | |
26 | .B \-C | |
27 | ] [ | |
28 | .B \-E | |
29 | ] [ | |
30 | .B \-I | |
31 | ] [ | |
32 | .B \-L | |
33 | ] [ | |
9fcdd250 MS |
34 | .B \-P |
35 | .I filename.plist | |
36 | ] [ | |
6b13fa61 MS |
37 | .B \-S |
38 | ] [ | |
39 | .B \-T | |
10d09e33 | 40 | .I seconds |
6b13fa61 MS |
41 | ] [ |
42 | .B \-V | |
aaf19ab0 | 43 | .I version |
6b13fa61 MS |
44 | ] [ |
45 | .B \-X | |
46 | ] [ | |
47 | .B \-c | |
48 | ] [ | |
49 | .B \-d | |
aaf19ab0 | 50 | .I name=value |
6b13fa61 MS |
51 | ] [ |
52 | .B \-f | |
aaf19ab0 | 53 | .I filename |
6b13fa61 | 54 | ] [ |
345e10ca MS |
55 | .B \-h |
56 | ] [ | |
6b13fa61 | 57 | .B \-i |
aaf19ab0 | 58 | .I seconds |
6b13fa61 MS |
59 | ] [ |
60 | .B \-n | |
aaf19ab0 | 61 | .I repeat-count |
6b13fa61 MS |
62 | ] [ |
63 | .B \-q | |
64 | ] [ | |
65 | .B \-t | |
66 | ] [ | |
67 | .B \-v ] | |
68 | .I printer-uri | |
69 | .I testfile | |
70 | [ ... | |
71 | .I testfile | |
aaf19ab0 MS |
72 | ] |
73 | .SH DESCRIPTION | |
6b13fa61 MS |
74 | .B ipptool |
75 | sends IPP requests to the specified | |
76 | .I printer-uri | |
1deb86fd MS |
77 | and tests and/or displays the results. |
78 | Each named | |
6b13fa61 | 79 | .I testfile |
1deb86fd MS |
80 | defines one or more requests, including the expected response status, attributes, and values. |
81 | 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. | |
82 | The | |
6b13fa61 MS |
83 | .I testfile |
84 | format is described in | |
85 | .BR ipptoolfile (5). | |
aaf19ab0 | 86 | .SH OPTIONS |
6b13fa61 MS |
87 | The following options are recognized by |
88 | .B ipptool: | |
aaf19ab0 | 89 | .TP 5 |
6b13fa61 | 90 | .B \-\-help |
9475ec92 | 91 | Shows program help. |
3a43047f | 92 | .TP 5 |
6646208b MS |
93 | -BI \-\-ippserver filename |
94 | Specifies that the test results should be written to the named | |
95 | .B ippserver | |
96 | attributes file. | |
97 | .TP 5 | |
6b13fa61 MS |
98 | .B \-\-stop-after-include-error |
99 | Tells | |
100 | .B ipptool | |
101 | to stop if an error occurs in an included file. Normally | |
102 | .B ipptool | |
103 | will continue with subsequent tests after the INCLUDE directive. | |
3a43047f | 104 | .TP 5 |
6b13fa61 MS |
105 | .B \-\-version |
106 | Shows the version of | |
107 | .B ipptool | |
108 | being used. | |
9475ec92 | 109 | .TP 5 |
6b13fa61 MS |
110 | .B \-4 |
111 | Specifies that | |
112 | .B ipptool | |
113 | must connect to the printer or server using IPv4. | |
1106b00e | 114 | .TP 5 |
6b13fa61 MS |
115 | .B \-6 |
116 | Specifies that | |
117 | .B ipptool | |
118 | must connect to the printer or server using IPv6. | |
1106b00e | 119 | .TP 5 |
6b13fa61 | 120 | .B \-C |
1deb86fd MS |
121 | 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. |
122 | The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files. | |
aaf19ab0 | 123 | .TP 5 |
6b13fa61 | 124 | .B \-E |
aaf19ab0 MS |
125 | Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. |
126 | .TP 5 | |
6b13fa61 MS |
127 | .B \-I |
128 | Specifies that | |
129 | .B ipptool | |
130 | will continue past errors. | |
030ae6a1 | 131 | .TP 5 |
6b13fa61 | 132 | .B \-L |
1deb86fd MS |
133 | Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP. |
134 | The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files. | |
aaf19ab0 | 135 | .TP 5 |
9fcdd250 | 136 | .BI \-P \ filename.plist |
1deb86fd MS |
137 | Specifies that the test results should be written to the named XML (Apple plist) file in addition to the regular test report (\fB\-t\fR). |
138 | This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options. | |
9fcdd250 | 139 | .TP 5 |
6b13fa61 MS |
140 | .B \-S |
141 | Forces (dedicated) TLS encryption when connecting to the server. | |
aaf19ab0 | 142 | .TP 5 |
6b13fa61 | 143 | .BI \-T \ seconds |
10d09e33 MS |
144 | Specifies a timeout for IPP requests in seconds. |
145 | .TP 5 | |
6b13fa61 | 146 | .BI \-V \ version |
aaf19ab0 MS |
147 | 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. |
148 | .TP 5 | |
6b13fa61 | 149 | .B \-X |
1deb86fd MS |
150 | Specifies that XML (Apple plist) output is desired instead of the plain text report. |
151 | This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options. | |
aaf19ab0 | 152 | .TP 5 |
6b13fa61 MS |
153 | .B \-c |
154 | Specifies that CSV (comma\-separated values) output is desired instead of the plain text output. | |
aaf19ab0 | 155 | .TP 5 |
6b13fa61 | 156 | .BI \-d \ name=value |
aaf19ab0 MS |
157 | Defines the named variable. |
158 | .TP 5 | |
6b13fa61 | 159 | .BI \-f \ filename |
aaf19ab0 MS |
160 | Defines the default request filename for tests. |
161 | .TP 5 | |
345e10ca MS |
162 | .B \-h |
163 | Validate HTTP response headers. | |
164 | .TP 5 | |
6b13fa61 MS |
165 | .BI \-i \ seconds |
166 | Specifies that the (last) | |
167 | .I testfile | |
1deb86fd MS |
168 | should be repeated at the specified interval. |
169 | This option is incompatible with the \fB\-X\fR (XML plist output) option. | |
aaf19ab0 | 170 | .TP 5 |
6b13fa61 | 171 | .B \-l |
aaf19ab0 MS |
172 | Specifies that plain text output is desired. |
173 | .TP 5 | |
6b13fa61 MS |
174 | .BI \-n \ repeat\-count |
175 | Specifies that the (last) | |
176 | .I testfile | |
1deb86fd MS |
177 | should be repeated the specified number of times. |
178 | This option is incompatible with the \fI\-X\fR (XML plist output) option. | |
179 | .TP 5 | |
180 | .B \-q | |
181 | Be quiet and produce no output. | |
aaf19ab0 | 182 | .TP 5 |
6b13fa61 | 183 | .B \-t |
aaf19ab0 MS |
184 | Specifies that CUPS test report output is desired instead of the plain text output. |
185 | .TP 5 | |
6b13fa61 | 186 | .B \-v |
1deb86fd MS |
187 | Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR). |
188 | This is the default for XML output. | |
6b13fa61 MS |
189 | .SH EXIT STATUS |
190 | The | |
191 | .B ipptool | |
dd3fdd2c | 192 | program returns 0 if all tests were successful and 1 otherwise. |
6b13fa61 MS |
193 | .SH FILES |
194 | The following standard files are available: | |
195 | .nf | |
196 | .I color.jpg | |
197 | .I create\-printer\-subscription.test | |
198 | .I document\-a4.pdf | |
199 | .I document\-a4.ps | |
200 | .I document\-letter.pdf | |
201 | .I document\-letter.ps | |
202 | .I get\-completed\-jobs.test | |
203 | .I get\-jobs.test | |
204 | .I get\-notifications.test | |
205 | .I get\-printer\-attributes.test | |
206 | .I get\-subscriptions.test | |
207 | .I gray.jpg | |
208 | .I ipp\-1.1.test | |
209 | .I ipp\-2.0.test | |
210 | .I ipp\-2.1.test | |
211 | .I ipp\-2.2.test | |
212 | .I ipp\-everywhere.test | |
213 | .I onepage\-a4.pdf | |
214 | .I onepage\-a4.ps | |
215 | .I onepage\-letter.pdf | |
216 | .I onepage\-letter.ps | |
217 | .I print\-job.test | |
218 | .I print\-job\-deflate.test | |
219 | .I print\-job\-gzip.test | |
220 | .I testfile.jpg | |
221 | .I testfile.pcl | |
222 | .I testfile.pdf | |
223 | .I testfile.ps | |
224 | .I testfile.txt | |
225 | .I validate\-job.test | |
226 | .fi | |
227 | .SH CONFORMING TO | |
228 | The | |
229 | .B ipptool | |
230 | program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2. | |
aaf19ab0 MS |
231 | .SH EXAMPLES |
232 | Get a list of completed jobs for "myprinter": | |
233 | .nf | |
4c6277cc | 234 | |
6b13fa61 | 235 | ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test |
aaf19ab0 MS |
236 | .fi |
237 | .LP | |
238 | Send email notifications to "user@example.com" when "myprinter" changes: | |
239 | .nf | |
4c6277cc | 240 | |
6b13fa61 MS |
241 | ipptool \-d recipient=mailto:user@example.com \\ |
242 | ipp://localhost/printers/myprinter create\-printer\-subscription.test | |
aaf19ab0 MS |
243 | .fi |
244 | .SH SEE ALSO | |
6b13fa61 | 245 | .BR ipptoolfile (5), |
6b13fa61 MS |
246 | IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations), |
247 | PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp) | |
f1dd3a39 | 248 | RFC 8011 (http://tools.ietf.org/html/rfc8011), |
aaf19ab0 | 249 | .SH COPYRIGHT |
bd5a2f28 | 250 | Copyright \[co] 2007-2017 by Apple Inc. |