378 lines
8.1 KiB
HTML
378 lines
8.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of ipptool</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>ipptool</H1>
|
|
Section: Apple Inc. (1)<BR>Updated: CUPS<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
ipptool - perform internet printing protocol requests
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>ipptool</B>
|
|
|
|
[
|
|
<B>--help</B>
|
|
|
|
] [
|
|
<B>--ippserver</B>
|
|
|
|
<I>filename</I>
|
|
|
|
] [
|
|
<B>--stop-after-include-error</B>
|
|
|
|
] [
|
|
<B>--version</B>
|
|
|
|
] [
|
|
<B>-4</B>
|
|
|
|
] [
|
|
<B>-6</B>
|
|
|
|
] [
|
|
<B>-C</B>
|
|
|
|
] [
|
|
<B>-E</B>
|
|
|
|
] [
|
|
<B>-I</B>
|
|
|
|
] [
|
|
<B>-L</B>
|
|
|
|
] [
|
|
<B>-P</B>
|
|
|
|
<I>filename.plist</I>
|
|
|
|
] [
|
|
<B>-S</B>
|
|
|
|
] [
|
|
<B>-T</B>
|
|
|
|
<I>seconds</I>
|
|
|
|
] [
|
|
<B>-V</B>
|
|
|
|
<I>version</I>
|
|
|
|
] [
|
|
<B>-X</B>
|
|
|
|
] [
|
|
<B>-c</B>
|
|
|
|
] [
|
|
<B>-d</B>
|
|
|
|
<I>name=value</I>
|
|
|
|
] [
|
|
<B>-f</B>
|
|
|
|
<I>filename</I>
|
|
|
|
] [
|
|
<B>-h</B>
|
|
|
|
] [
|
|
<B>-i</B>
|
|
|
|
<I>seconds</I>
|
|
|
|
] [
|
|
<B>-n</B>
|
|
|
|
<I>repeat-count</I>
|
|
|
|
] [
|
|
<B>-q</B>
|
|
|
|
] [
|
|
<B>-t</B>
|
|
|
|
] [
|
|
<B>-v ]</B>
|
|
|
|
<I>printer-uri</I>
|
|
|
|
<I>testfile</I>
|
|
|
|
[ ...
|
|
<I>testfile</I>
|
|
|
|
]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>ipptool</B>
|
|
|
|
sends IPP requests to the specified
|
|
<I>printer-uri</I>
|
|
|
|
and tests and/or displays the results.
|
|
Each named
|
|
<I>testfile</I>
|
|
|
|
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
|
|
<I>testfile</I>
|
|
|
|
format is described in
|
|
<B><A HREF="/cgi-bin/man/man2html?5+ipptoolfile">ipptoolfile</A></B>(5).
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
The following options are recognized by
|
|
<B>ipptool:</B>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>--help</B>
|
|
|
|
<DD>
|
|
Shows program help.
|
|
<DT id="2"><B>--ippserver </B><I>filename</I><DD>
|
|
Specifies that the test results should be written to the named
|
|
<B>ippserver</B>
|
|
|
|
attributes file.
|
|
<DT id="3"><B>--stop-after-include-error</B>
|
|
|
|
<DD>
|
|
Tells
|
|
<B>ipptool</B>
|
|
|
|
to stop if an error occurs in an included file. Normally
|
|
<B>ipptool</B>
|
|
|
|
will continue with subsequent tests after the INCLUDE directive.
|
|
<DT id="4"><B>--version</B>
|
|
|
|
<DD>
|
|
Shows the version of
|
|
<B>ipptool</B>
|
|
|
|
being used.
|
|
<DT id="5"><B>-4</B>
|
|
|
|
<DD>
|
|
Specifies that
|
|
<B>ipptool</B>
|
|
|
|
must connect to the printer or server using IPv4.
|
|
<DT id="6"><B>-6</B>
|
|
|
|
<DD>
|
|
Specifies that
|
|
<B>ipptool</B>
|
|
|
|
must connect to the printer or server using IPv6.
|
|
<DT id="7"><B>-C</B>
|
|
|
|
<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.
|
|
<DT id="8"><B>-E</B>
|
|
|
|
<DD>
|
|
Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
|
|
<DT id="9"><B>-I</B>
|
|
|
|
<DD>
|
|
Specifies that
|
|
<B>ipptool</B>
|
|
|
|
will continue past errors.
|
|
<DT id="10"><B>-L</B>
|
|
|
|
<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.
|
|
<DT id="11"><B>-P</B><I> filename.plist</I>
|
|
|
|
<DD>
|
|
Specifies that the test results should be written to the named XML (Apple plist) file in addition to the regular test report (<B>-t</B>).
|
|
This option is incompatible with the <B>-i</B> (interval) and <B>-n</B> (repeat-count) options.
|
|
<DT id="12"><B>-S</B>
|
|
|
|
<DD>
|
|
Forces (dedicated) TLS encryption when connecting to the server.
|
|
<DT id="13"><B>-T</B><I> seconds</I>
|
|
|
|
<DD>
|
|
Specifies a timeout for IPP requests in seconds.
|
|
<DT id="14"><B>-V</B><I> version</I>
|
|
|
|
<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.
|
|
<DT id="15"><B>-X</B>
|
|
|
|
<DD>
|
|
Specifies that XML (Apple plist) output is desired instead of the plain text report.
|
|
This option is incompatible with the <B>-i</B> (interval) and <B>-n</B> (repeat-count) options.
|
|
<DT id="16"><B>-c</B>
|
|
|
|
<DD>
|
|
Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
|
|
<DT id="17"><B>-d</B><I> name=value</I>
|
|
|
|
<DD>
|
|
Defines the named variable.
|
|
<DT id="18"><B>-f</B><I> filename</I>
|
|
|
|
<DD>
|
|
Defines the default request filename for tests.
|
|
<DT id="19"><B>-h</B>
|
|
|
|
<DD>
|
|
Validate HTTP response headers.
|
|
<DT id="20"><B>-i</B><I> seconds</I>
|
|
|
|
<DD>
|
|
Specifies that the (last)
|
|
<I>testfile</I>
|
|
|
|
should be repeated at the specified interval.
|
|
This option is incompatible with the <B>-X</B> (XML plist output) option.
|
|
<DT id="21"><B>-l</B>
|
|
|
|
<DD>
|
|
Specifies that plain text output is desired.
|
|
<DT id="22"><B>-n</B><I> repeat-count</I>
|
|
|
|
<DD>
|
|
Specifies that the (last)
|
|
<I>testfile</I>
|
|
|
|
should be repeated the specified number of times.
|
|
This option is incompatible with the <I>-X</I> (XML plist output) option.
|
|
<DT id="23"><B>-q</B>
|
|
|
|
<DD>
|
|
Be quiet and produce no output.
|
|
<DT id="24"><B>-t</B>
|
|
|
|
<DD>
|
|
Specifies that CUPS test report output is desired instead of the plain text output.
|
|
<DT id="25"><B>-v</B>
|
|
|
|
<DD>
|
|
Specifies that all request and response attributes should be output in CUPS test mode (<B>-t</B>).
|
|
This is the default for XML output.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
The
|
|
<B>ipptool</B>
|
|
|
|
program returns 0 if all tests were successful and 1 otherwise.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
The following standard files are available:
|
|
<PRE>
|
|
<I>color.jpg</I>
|
|
<I>create-printer-subscription.test</I>
|
|
<I>document-a4.pdf</I>
|
|
<I>document-a4.ps</I>
|
|
<I>document-letter.pdf</I>
|
|
<I>document-letter.ps</I>
|
|
<I>get-completed-jobs.test</I>
|
|
<I>get-jobs.test</I>
|
|
<I>get-notifications.test</I>
|
|
<I>get-printer-attributes.test</I>
|
|
<I>get-subscriptions.test</I>
|
|
<I>gray.jpg</I>
|
|
<I>ipp-1.1.test</I>
|
|
<I>ipp-2.0.test</I>
|
|
<I>ipp-2.1.test</I>
|
|
<I>ipp-2.2.test</I>
|
|
<I>ipp-everywhere.test</I>
|
|
<I>onepage-a4.pdf</I>
|
|
<I>onepage-a4.ps</I>
|
|
<I>onepage-letter.pdf</I>
|
|
<I>onepage-letter.ps</I>
|
|
<I>print-job.test</I>
|
|
<I>print-job-deflate.test</I>
|
|
<I>print-job-gzip.test</I>
|
|
<I>testfile.jpg</I>
|
|
<I>testfile.pcl</I>
|
|
<I>testfile.pdf</I>
|
|
<I>testfile.ps</I>
|
|
<I>testfile.txt</I>
|
|
<I>validate-job.test</I>
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
The
|
|
<B>ipptool</B>
|
|
|
|
program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
Get a list of completed jobs for "myprinter":
|
|
<PRE>
|
|
|
|
ipptool <A HREF="ipp://localhost/printers/myprinter">ipp://localhost/printers/myprinter</A> get-completed-jobs.test
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
Send email notifications to "<A HREF="mailto:user@example.com">user@example.com</A>" when "myprinter" changes:
|
|
<PRE>
|
|
|
|
ipptool -d recipient=mailto:<A HREF="mailto:user@example.com">user@example.com</A> \
|
|
<A HREF="ipp://localhost/printers/myprinter">ipp://localhost/printers/myprinter</A> create-printer-subscription.test
|
|
</PRE>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+ipptoolfile">ipptoolfile</A></B>(5),
|
|
|
|
IANA IPP Registry (<A HREF="http://www.iana.org/assignments/ipp-registrations),">http://www.iana.org/assignments/ipp-registrations),</A>
|
|
PWG Internet Printing Protocol Workgroup (<A HREF="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</A>
|
|
RFC 8011 (<A HREF="http://tools.ietf.org/html/rfc8011),">http://tools.ietf.org/html/rfc8011),</A>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
Copyright © 2007-2019 by Apple Inc.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="26"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="27"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="28"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="29"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="30"><A HREF="#lbAF">EXIT STATUS</A><DD>
|
|
<DT id="31"><A HREF="#lbAG">FILES</A><DD>
|
|
<DT id="32"><A HREF="#lbAH">CONFORMING TO</A><DD>
|
|
<DT id="33"><A HREF="#lbAI">EXAMPLES</A><DD>
|
|
<DT id="34"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="35"><A HREF="#lbAK">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:17 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|