[thirdparty/cups.git] / doc / help / man-ipptool.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>ipptool(1)</title>
</head>
<body>
<h1 class="title">ipptool(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
ipptool - perform internet printing protocol requests
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>ipptool</b>
[
<b>--help</b>
] [
<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>-i</b>
<i>seconds</i>
] [
<b>-n</b>
<i>repeat-count</i>
] [
<b>-q</b>
] [
<b>-t</b>
] [
<b>-v</b><b>]</b>
<i>printer-uri</i>
<i>testfile</i>
[ ...
<i>testfile</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></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
<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5).</a>
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by
<b>ipptool:</b>
<dl class="man">
<dt><b>--help</b>
<dd style="margin-left: 5.0em">Shows program help.
<dt><b>--stop-after-include-error</b>
<dd style="margin-left: 5.0em">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><b>--version</b>
<dd style="margin-left: 5.0em">Shows the version of
<b>ipptool</b>
being used.
<dt><b>-4</b>
<dd style="margin-left: 5.0em">Specifies that
<b>ipptool</b>
must connect to the printer or server using IPv4.
<dt><b>-6</b>
<dd style="margin-left: 5.0em">Specifies that
<b>ipptool</b>
must connect to the printer or server using IPv6.
<dt><b>-C</b>
<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><b>-E</b>
<dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
<dt><b>-I</b>
<dd style="margin-left: 5.0em">Specifies that
<b>ipptool</b>
will continue past errors.
<dt><b>-L</b>
<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><b>-P</b><i> filename.plist</i>
<dd style="margin-left: 5.0em">Specifies that the test results should be written to the named XML (Apple plist) file in addition to the plain text report. This option is incompatible with the <b>-i</b> (interval) and <b>-n</b> (repeat-count) options.
<dt><b>-S</b>
<dd style="margin-left: 5.0em">Forces (dedicated) TLS encryption when connecting to the server.
<dt><b>-T</b><i> seconds</i>
<dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds.
<dt><b>-V</b><i> version</i>
<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><b>-X</b>
<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 <b>-i</b> (interval) and <b>-n</b> (repeat-count) options.
<dt><b>-c</b>
<dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
<dt><b>-d</b><i> name=value</i>
<dd style="margin-left: 5.0em">Defines the named variable.
<dt><b>-f</b><i> filename</i>
<dd style="margin-left: 5.0em">Defines the default request filename for tests.
<dt><b>-i</b><i> seconds</i>
<dd style="margin-left: 5.0em">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><b>-l</b>
<dd style="margin-left: 5.0em">Specifies that plain text output is desired.
<dt><b>-n</b><i> repeat-count</i>
<dd style="margin-left: 5.0em">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><b>-t</b>
<dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output.
<dt><b>-v</b>
<dd style="margin-left: 5.0em">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>
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
The
<b>ipptool</b>
program returns 0 if all tests were sucessful and 1 otherwise.
<h2 class="title"><a name="FILES">Files</a></h2>
The following standard files are available:
<pre class="man">
<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>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
The
<b>ipptool</b>
program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Get a list of completed jobs for "myprinter":
<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 class="man">

    ipptool -d recipient=mailto:user@example.com \
        ipp://localhost/printers/myprinter create-printer-subscription.test
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
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 2911 (<a href="http://tools.ietf.org/html/rfc2911)">http://tools.ietf.org/html/rfc2911)</a>,
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2014 by Apple Inc.

</body>
</html>
Commit	Line	Data
1a18c85c	1	<!DOCTYPE HTML>
a2326b5b MS	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>
	11	ipptool - perform internet printing protocol requests
	12	<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
1a18c85c MS	13	<b>ipptool</b>
	14	[
	15	<b>--help</b>
	16	] [
	17	<b>--stop-after-include-error</b>
	18	] [
	19	<b>--version</b>
	20	] [
	21	<b>-4</b>
	22	] [
	23	<b>-6</b>
	24	] [
	25	<b>-C</b>
	26	] [
	27	<b>-E</b>
	28	] [
	29	<b>-I</b>
	30	] [
	31	<b>-L</b>
	32	] [
	33	<b>-P</b>
	34	<i>filename.plist</i>
	35	] [
	36	<b>-S</b>
	37	] [
	38	<b>-T</b>
	39	<i>seconds</i>
	40	] [
	41	<b>-V</b>
	42	<i>version</i>
	43	] [
	44	<b>-X</b>
	45	] [
	46	<b>-c</b>
	47	] [
	48	<b>-d</b>
	49	<i>name=value</i>
	50	] [
	51	<b>-f</b>
	52	<i>filename</i>
	53	] [
	54	<b>-i</b>
	55	<i>seconds</i>
	56	] [
	57	<b>-n</b>
	58	<i>repeat-count</i>
	59	] [
	60	<b>-q</b>
	61	] [
	62	<b>-t</b>
	63	] [
	64	<b>-v</b><b>]</b>
	65	<i>printer-uri</i>
	66	<i>testfile</i>
	67	[ ...
	68	<i>testfile</i>
	69	]
a2326b5b	70	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
1a18c85c MS	71	<b>ipptool</b>
	72	sends IPP requests to the specified
	73	<i>printer-uri</i>
	74	and tests and/or displays the results. Each named
	75	<i>testfile</i>
	76	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
	77	<i>testfile</i>
	78	format is described in
	79	<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5).</a>
a2326b5b	80	<h2 class="title"><a name="OPTIONS">Options</a></h2>
1a18c85c MS	81	The following options are recognized by
	82	<b>ipptool:</b>
	83	<dl class="man">
	84	<dt><b>--help</b>
	85	<dd style="margin-left: 5.0em">Shows program help.
	86	<dt><b>--stop-after-include-error</b>
	87	<dd style="margin-left: 5.0em">Tells
	88	<b>ipptool</b>
	89	to stop if an error occurs in an included file. Normally
	90	<b>ipptool</b>
	91	will continue with subsequent tests after the INCLUDE directive.
	92	<dt><b>--version</b>
	93	<dd style="margin-left: 5.0em">Shows the version of
	94	<b>ipptool</b>
	95	being used.
	96	<dt><b>-4</b>
	97	<dd style="margin-left: 5.0em">Specifies that
	98	<b>ipptool</b>
	99	must connect to the printer or server using IPv4.
	100	<dt><b>-6</b>
	101	<dd style="margin-left: 5.0em">Specifies that
	102	<b>ipptool</b>
	103	must connect to the printer or server using IPv6.
	104	<dt><b>-C</b>
	105	<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.
	106	<dt><b>-E</b>
	107	<dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
	108	<dt><b>-I</b>
	109	<dd style="margin-left: 5.0em">Specifies that
	110	<b>ipptool</b>
	111	will continue past errors.
	112	<dt><b>-L</b>
	113	<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.
	114	<dt><b>-P</b><i> filename.plist</i>
	115	<dd style="margin-left: 5.0em">Specifies that the test results should be written to the named XML (Apple plist) file in addition to the plain text report. This option is incompatible with the <b>-i</b> (interval) and <b>-n</b> (repeat-count) options.
	116	<dt><b>-S</b>
	117	<dd style="margin-left: 5.0em">Forces (dedicated) TLS encryption when connecting to the server.
	118	<dt><b>-T</b><i> seconds</i>
	119	<dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds.
	120	<dt><b>-V</b><i> version</i>
	121	<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.
	122	<dt><b>-X</b>
	123	<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 <b>-i</b> (interval) and <b>-n</b> (repeat-count) options.
	124	<dt><b>-c</b>
	125	<dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
	126	<dt><b>-d</b><i> name=value</i>
	127	<dd style="margin-left: 5.0em">Defines the named variable.
	128	<dt><b>-f</b><i> filename</i>
	129	<dd style="margin-left: 5.0em">Defines the default request filename for tests.
	130	<dt><b>-i</b><i> seconds</i>
	131	<dd style="margin-left: 5.0em">Specifies that the (last)
	132	<i>testfile</i>
	133	should be repeated at the specified interval. This option is incompatible with the <b>-X</b> (XML plist output) option.
	134	<dt><b>-l</b>
	135	<dd style="margin-left: 5.0em">Specifies that plain text output is desired.
	136	<dt><b>-n</b><i> repeat-count</i>
	137	<dd style="margin-left: 5.0em">Specifies that the (last)
	138	<i>testfile</i>
	139	should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
	140	<dt><b>-t</b>
	141	<dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output.
	142	<dt><b>-v</b>
	143	<dd style="margin-left: 5.0em">Specifies that all request and response attributes should be output in CUPS test mode (<b>-t</b>). This is the default for XML output.
a2326b5b	144	</dl>
1a18c85c MS	145	<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
	146	The
	147	<b>ipptool</b>
	148	program returns 0 if all tests were sucessful and 1 otherwise.
	149	<h2 class="title"><a name="FILES">Files</a></h2>
	150	The following standard files are available:
	151	<pre class="man">
	152	<i>color.jpg</i>
	153	<i>create-printer-subscription.test</i>
	154	<i>document-a4.pdf</i>
	155	<i>document-a4.ps</i>
	156	<i>document-letter.pdf</i>
	157	<i>document-letter.ps</i>
	158	<i>get-completed-jobs.test</i>
	159	<i>get-jobs.test</i>
	160	<i>get-notifications.test</i>
	161	<i>get-printer-attributes.test</i>
	162	<i>get-subscriptions.test</i>
	163	<i>gray.jpg</i>
	164	<i>ipp-1.1.test</i>
	165	<i>ipp-2.0.test</i>
	166	<i>ipp-2.1.test</i>
	167	<i>ipp-2.2.test</i>
	168	<i>ipp-everywhere.test</i>
	169	<i>onepage-a4.pdf</i>
	170	<i>onepage-a4.ps</i>
	171	<i>onepage-letter.pdf</i>
	172	<i>onepage-letter.ps</i>
	173	<i>print-job.test</i>
	174	<i>print-job-deflate.test</i>
	175	<i>print-job-gzip.test</i>
	176	<i>testfile.jpg</i>
	177	<i>testfile.pcl</i>
	178	<i>testfile.pdf</i>
	179	<i>testfile.ps</i>
	180	<i>testfile.txt</i>
	181	<i>validate-job.test</i>
	182	</pre>
	183	<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
	184	The
	185	<b>ipptool</b>
	186	program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2.
a2326b5b MS	187	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
a2326b5b MS	188	Get a list of completed jobs for "myprinter":
1a18c85c MS	189	<pre class="man">
1a18c85c MS	190
a2326b5b MS	191	ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
	192	</pre>
	193	<p>Send email notifications to "user@example.com" when "myprinter" changes:
1a18c85c MS	194	<pre class="man">
	195
	196	ipptool -d recipient=mailto:user@example.com \
a2326b5b MS	197	ipp://localhost/printers/myprinter create-printer-subscription.test
a2326b5b MS	198	</pre>
a2326b5b	199	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
1a18c85c MS	200	<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a>
	201	CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
	202	IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp\-registrations)">http://www.iana.org/assignments/ipp\-registrations)</a>,
	203	PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
	204	RFC 2911 (<a href="http://tools.ietf.org/html/rfc2911)">http://tools.ietf.org/html/rfc2911)</a>,
a2326b5b	205	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
1a18c85c	206	Copyright © 2007-2014 by Apple Inc.
a2326b5b MS	207
	208	</body>
	209	</html>