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