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