<i>URI</i>
<i>filename</i>
[
-<i>...</i> <i>filenameN</i>
+<i>...</i><i>filenameN</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<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 <i>ipptoolfile(5)</i>.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>ipptool</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">--help
-<br>
-Shows program help.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--stop-after-include-error
-<br>
-Tells <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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--version
-<br>
-Shows the version of <i>ipptool</i> being used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-4
-<br>
-Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-6
-<br>
-Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-C
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-I
-<br>
-Specifies that <i>ipptool</i> will continue past errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-L
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-S
-<br>
-Forces (dedicated) SSL encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-T seconds
-<br>
-Specifies a timeout for IPP requests in seconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-V version
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-X
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c
-<br>
-Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d name=value
-<br>
-Defines the named variable.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-f filename
-<br>
-Defines the default request filename for tests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-i seconds
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-Specifies that plain text output is desired.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n repeat-count
-<br>
-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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t
-<br>
-Specifies that CUPS test report output is desired instead of the plain text output.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v
-<br>
-Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
+<dl class="man">
+<dt>--help
+<dd style="margin-left: 5.0em">Shows program help.
+<dt>--stop-after-include-error
+<dd style="margin-left: 5.0em">Tells <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.
+<dt>--version
+<dd style="margin-left: 5.0em">Shows the version of <i>ipptool</i> being used.
+<dt>-4
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
+<dt>-6
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
+<dt>-C
+<dd style="margin-left: 5.0em">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.
+<dt>-E
+<dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
+<dt>-I
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> will continue past errors.
+<dt>-L
+<dd style="margin-left: 5.0em">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.
+<dt>-S
+<dd style="margin-left: 5.0em">Forces (dedicated) SSL encryption when connecting to the server.
+<dt>-T seconds
+<dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds.
+<dt>-V version
+<dd style="margin-left: 5.0em">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.
+<dt>-X
+<dd style="margin-left: 5.0em">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.
+<dt>-c
+<dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
+<dt>-d name=value
+<dd style="margin-left: 5.0em">Defines the named variable.
+<dt>-f filename
+<dd style="margin-left: 5.0em">Defines the default request filename for tests.
+<dt>-i seconds
+<dd style="margin-left: 5.0em">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.
+<dt>-l
+<dd style="margin-left: 5.0em">Specifies that plain text output is desired.
+<dt>-n repeat-count
+<dd style="margin-left: 5.0em">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.
+<dt>-t
+<dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output.
+<dt>-v
+<dd style="margin-left: 5.0em">Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
+</dl>
<h2 class="title"><a name="EXIT_CODE">Exit Code</a></h2>
The <i>ipptool</i> program returns 0 if all tests were sucessful and 1 otherwise.
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
The <i>ipptool</i> program is unique to CUPS.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Get a list of completed jobs for "myprinter":
-<pre>
+<pre class="man">
ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
</pre>
<p>Send email notifications to "user@example.com" when "myprinter" changes:
-<pre>
+<pre class="man">
ipptool -d recipient=mailto:user@example.com \
ipp://localhost/printers/myprinter create-printer-subscription.test
</pre>
<h2 class="title"><a name="STANDARD_FILES">Standard Files</a></h2>
The following standard files are available:
-<pre>
+<pre class="man">
color.jpg
create-printer-subscription.test
projects / thirdparty / cups.git / blobdiff