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