]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-ipptool.html
Remove the deprecated ServiceIPC key and add the recommended EnableTransactions
[thirdparty/cups.git] / doc / help / man-ipptool.html
CommitLineData
a2326b5b
MS
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<!-- SECTION: Man Pages -->
4<head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>ipptool(1)</title>
7</head>
8<body>
9<h1 class="title">ipptool(1)</h1>
10<h2 class="title"><a name="NAME">Name</a></h2>
11ipptool - perform internet printing protocol requests
12<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
13<b>ipptool
9475ec92
MS
14</b>[ --help ] [ --stop-after-include-error ] [ --version ]
15[ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
a2326b5b
MS
16<i>seconds
17</i>] [ -V
18<i>version
19</i>] [ -X ] [ -c ] [ -d
20<i>name=value
21</i>] [ -f
22<i>filename
23</i>] [ -i
24<i>seconds
25</i>] [ -n
26<i>repeat-count
27</i>] [ -q ] [ -t ] [ -v ]
28<i>URI
29</i><i>filename
30</i>[
31<i>... filenameN
32</i>]
33<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
34<i>ipptool</i> 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 <a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>.
35<h2 class="title"><a name="OPTIONS">Options</a></h2>
36The following options are recognized by <i>ipptool</i>:
37<dl>
9475ec92
MS
38<dt>--help
39</dt>
40<dd>Shows program help.
41--stop-after-include-error
42Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
43--version
44Shows the version of <i>ipptool</i> being used.
45</dd>
a2326b5b
MS
46<dt>-4
47</dt>
48<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
49</dd>
50<dt>-6
51</dt>
52<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
53</dd>
54<dt>-C
55</dt>
56<dd>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.
57</dd>
58<dt>-E
59</dt>
60<dd>Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
61</dd>
62<dt>-I
63</dt>
64<dd>Specifies that <i>ipptool</i> will continue past errors.
65</dd>
66<dt>-L
67</dt>
68<dd>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</dd>
70<dt>-S
71</dt>
72<dd>Forces (dedicated) SSL encryption when connecting to the server.
73</dd>
74<dt>-T seconds
75</dt>
76<dd>Specifies a timeout for IPP requests in seconds.
77</dd>
78<dt>-V version
79</dt>
80<dd>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.
81</dd>
82<dt>-X
83</dt>
84<dd>Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
85</dd>
86<dt>-c
87</dt>
88<dd>Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
89</dd>
90<dt>-d name=value
91</dt>
92<dd>Defines the named variable.
93</dd>
94<dt>-f filename
95</dt>
96<dd>Defines the default request filename for tests.
97</dd>
98<dt>-i seconds
99</dt>
100<dd>Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the <i>-X</i> (XML plist output) option.
101</dd>
102<dt>-l
103</dt>
104<dd>Specifies that plain text output is desired.
105</dd>
106<dt>-n repeat-count
107</dt>
108<dd>Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
109</dd>
110<dt>-t
111</dt>
112<dd>Specifies that CUPS test report output is desired instead of the plain text output.
113</dd>
114<dt>-v
115</dt>
116<dd>Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
117</dd>
118</dl>
9475ec92
MS
119<h2 class="title"><a name="EXIT_CODE">Exit Code</a></h2>
120The <i>ipptool</i> program returns 0 if all tests were sucessful and 1 otherwise.
a2326b5b
MS
121<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
122The <i>ipptool</i> program is unique to CUPS.
123<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
124Get a list of completed jobs for "myprinter":
125<pre>
126 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
127</pre>
128<p>Send email notifications to "user@example.com" when "myprinter" changes:
129<pre>
130 ipptool -d recipient=mailto:user@example.com
131 ipp://localhost/printers/myprinter create-printer-subscription.test
132</pre>
133<h2 class="title"><a name="STANDARD_FILES">Standard Files</a></h2>
134The following standard files are available:
135<pre>
f3c17241 136 color.jpg
a2326b5b 137 create-printer-subscription.test
f3c17241
MS
138 document-a4.pdf
139 document-a4.ps
140 document-letter.pdf
141 document-letter.ps
a2326b5b
MS
142 get-completed-jobs.test
143 get-jobs.test
9475ec92 144 get-notifications.test
f3c17241 145 get-printer-attributes.test
9475ec92 146 get-subscriptions.test
f3c17241 147 gray.jpg
a2326b5b
MS
148 ipp-1.1.test
149 ipp-2.0.test
150 ipp-2.1.test
f3c17241 151 ipp-2.2.test
9475ec92 152 ipp-everywhere.test
f3c17241
MS
153 onepage-a4.pdf
154 onepage-a4.ps
155 onepage-letter.pdf
156 onepage-letter.ps
157 print-job.test
9475ec92
MS
158 print-job-deflate.test
159 print-job-gzip.test
a2326b5b 160 testfile.jpg
9475ec92 161 testfile.pcl
a2326b5b
MS
162 testfile.pdf
163 testfile.ps
164 testfile.txt
9475ec92 165 validate-job.test
a2326b5b
MS
166</pre>
167<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
168<a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>,
169<br>
170<a href='http://localhost:631/help'>http://localhost:631/help</a>
171<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
0cb67df3 172Copyright 2007-2013 by Apple Inc.
a2326b5b
MS
173
174</body>
175</html>