]>
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 | .\" |
3a43047f | 14 | .TH ipptool 1 "CUPS" "20 February 2014" "Apple Inc." |
aaf19ab0 MS |
15 | .SH NAME |
16 | ipptool - perform internet printing protocol requests | |
17 | .SH SYNOPSIS | |
18 | .B ipptool | |
9475ec92 | 19 | [ --help ] [ --stop-after-include-error ] [ --version ] |
1106b00e | 20 | [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T |
10d09e33 MS |
21 | .I seconds |
22 | ] [ -V | |
aaf19ab0 MS |
23 | .I version |
24 | ] [ -X ] [ -c ] [ -d | |
25 | .I name=value | |
26 | ] [ -f | |
27 | .I filename | |
28 | ] [ -i | |
29 | .I seconds | |
30 | ] [ -n | |
31 | .I repeat-count | |
32 | ] [ -q ] [ -t ] [ -v ] | |
33 | .I URI | |
34 | .I filename | |
35 | [ | |
36 | .I ... filenameN | |
37 | ] | |
38 | .SH DESCRIPTION | |
39 | \fIipptool\fR sends IPP requests to the specified URI and tests and/or displays the results. Each named file 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 file format is described in \fIipptoolfile(5)\fR. | |
40 | .SH OPTIONS | |
41 | The following options are recognized by \fIipptool\fR: | |
42 | .TP 5 | |
9475ec92 MS |
43 | --help |
44 | Shows program help. | |
3a43047f | 45 | .TP 5 |
9475ec92 MS |
46 | --stop-after-include-error |
47 | Tells \fIipptool\fR to stop if an error occurs in an included file. Normally \fIipptool\fR will continue with subsequent tests after the INCLUDE directive. | |
3a43047f | 48 | .TP 5 |
9475ec92 MS |
49 | --version |
50 | Shows the version of \fIipptool\fR being used. | |
51 | .TP 5 | |
1106b00e MS |
52 | -4 |
53 | Specifies that \fIipptool\fR must connect to the printer or server using IPv4. | |
54 | .TP 5 | |
55 | -6 | |
56 | Specifies that \fIipptool\fR must connect to the printer or server using IPv6. | |
57 | .TP 5 | |
aaf19ab0 MS |
58 | -C |
59 | 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. | |
60 | .TP 5 | |
61 | -E | |
62 | Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. | |
63 | .TP 5 | |
030ae6a1 MS |
64 | -I |
65 | Specifies that \fIipptool\fR will continue past errors. | |
66 | .TP 5 | |
aaf19ab0 MS |
67 | -L |
68 | 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. | |
69 | .TP 5 | |
70 | -S | |
71 | Forces (dedicated) SSL encryption when connecting to the server. | |
72 | .TP 5 | |
10d09e33 MS |
73 | -T seconds |
74 | Specifies a timeout for IPP requests in seconds. | |
75 | .TP 5 | |
aaf19ab0 MS |
76 | -V version |
77 | 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. | |
78 | .TP 5 | |
79 | -X | |
80 | Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fI-i\fR (interval) and \fI-n\fR (repeat-count) options. | |
81 | .TP 5 | |
82 | -c | |
83 | Specifies that CSV (comma-separated values) output is desired instead of the plain text output. | |
84 | .TP 5 | |
85 | -d name=value | |
86 | Defines the named variable. | |
87 | .TP 5 | |
88 | -f filename | |
89 | Defines the default request filename for tests. | |
90 | .TP 5 | |
91 | -i seconds | |
10d09e33 | 92 | Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the \fI-X\fR (XML plist output) option. |
aaf19ab0 MS |
93 | .TP 5 |
94 | -l | |
95 | Specifies that plain text output is desired. | |
96 | .TP 5 | |
97 | -n repeat-count | |
98 | Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the \fI-X\fR (XML plist output) option. | |
99 | .TP 5 | |
100 | -t | |
101 | Specifies that CUPS test report output is desired instead of the plain text output. | |
102 | .TP 5 | |
103 | -v | |
104 | Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output. | |
9475ec92 MS |
105 | .SH EXIT CODE |
106 | The \fIipptool\fR program returns 0 if all tests were sucessful and 1 otherwise. | |
aaf19ab0 MS |
107 | .SH COMPATIBILITY |
108 | The \fIipptool\fR program is unique to CUPS. | |
109 | .SH EXAMPLES | |
110 | Get a list of completed jobs for "myprinter": | |
111 | .nf | |
4c6277cc | 112 | |
aaf19ab0 MS |
113 | ipptool ipp://localhost/printers/myprinter get-completed-jobs.test |
114 | .fi | |
115 | .LP | |
116 | Send email notifications to "user@example.com" when "myprinter" changes: | |
117 | .nf | |
4c6277cc MS |
118 | |
119 | ipptool -d recipient=mailto:user@example.com \\ | |
aaf19ab0 MS |
120 | ipp://localhost/printers/myprinter create-printer-subscription.test |
121 | .fi | |
122 | .SH STANDARD FILES | |
123 | The following standard files are available: | |
124 | .nf | |
4c6277cc | 125 | |
f3c17241 | 126 | color.jpg |
aaf19ab0 | 127 | create-printer-subscription.test |
f3c17241 MS |
128 | document-a4.pdf |
129 | document-a4.ps | |
130 | document-letter.pdf | |
131 | document-letter.ps | |
aaf19ab0 MS |
132 | get-completed-jobs.test |
133 | get-jobs.test | |
9475ec92 | 134 | get-notifications.test |
f3c17241 | 135 | get-printer-attributes.test |
9475ec92 | 136 | get-subscriptions.test |
f3c17241 | 137 | gray.jpg |
aaf19ab0 MS |
138 | ipp-1.1.test |
139 | ipp-2.0.test | |
140 | ipp-2.1.test | |
f3c17241 | 141 | ipp-2.2.test |
9475ec92 | 142 | ipp-everywhere.test |
f3c17241 MS |
143 | onepage-a4.pdf |
144 | onepage-a4.ps | |
145 | onepage-letter.pdf | |
146 | onepage-letter.ps | |
147 | print-job.test | |
9475ec92 MS |
148 | print-job-deflate.test |
149 | print-job-gzip.test | |
aaf19ab0 | 150 | testfile.jpg |
9475ec92 | 151 | testfile.pcl |
aaf19ab0 MS |
152 | testfile.pdf |
153 | testfile.ps | |
154 | testfile.txt | |
9475ec92 | 155 | validate-job.test |
aaf19ab0 MS |
156 | .fi |
157 | .SH SEE ALSO | |
3a43047f | 158 | \fIipptoolfile(5)\fR, RFC 2911, |
aaf19ab0 MS |
159 | .br |
160 | http://localhost:631/help | |
3a43047f MS |
161 | .br |
162 | http://www.iana.org/assignments/ipp-registrations | |
163 | .br | |
164 | http://www.pwg.org/ipp | |
aaf19ab0 | 165 | .SH COPYRIGHT |
3a43047f | 166 | Copyright 2007-2014 by Apple Inc. |
aaf19ab0 MS |
167 | .\" |
168 | .\" End of "$Id$". | |
169 | .\" |