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