[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 regular test report (<b>-t</b>).
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>-q</b>
<dd style="margin-left: 5.0em">Be quiet and produce no output.
<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 successful 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-2016 by Apple Inc.

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