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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<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>[ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
<i>seconds
</i>] [ -V
<i>version
</i>] [ -X ] [ -c ] [ -d
<i>name=value
</i>] [ -f
<i>filename
</i>] [ -i
<i>seconds
</i>] [ -n
<i>repeat-count
</i>] [ -q ] [ -t ] [ -v ]
<i>URI
</i><i>filename
</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 <a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>ipptool</i>:
<dl>
<dt>-4
</dt>
<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
</dd>
<dt>-6
</dt>
<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
</dd>
<dt>-C
</dt>
<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.
</dd>
<dt>-E
</dt>
<dd>Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
</dd>
<dt>-I
</dt>
<dd>Specifies that <i>ipptool</i> will continue past errors.
</dd>
<dt>-L
</dt>
<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.
</dd>
<dt>-S
</dt>
<dd>Forces (dedicated) SSL encryption when connecting to the server.
</dd>
<dt>-T seconds
</dt>
<dd>Specifies a timeout for IPP requests in seconds.
</dd>
<dt>-V version
</dt>
<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.
</dd>
<dt>-X
</dt>
<dd>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.
</dd>
<dt>-c
</dt>
<dd>Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
</dd>
<dt>-d name=value
</dt>
<dd>Defines the named variable.
</dd>
<dt>-f filename
</dt>
<dd>Defines the default request filename for tests.
</dd>
<dt>-i seconds
</dt>
<dd>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.
</dd>
<dt>-l
</dt>
<dd>Specifies that plain text output is desired.
</dd>
<dt>-n repeat-count
</dt>
<dd>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.
</dd>
<dt>-t
</dt>
<dd>Specifies that CUPS test report output is desired instead of the plain text output.
</dd>
<dt>-v
</dt>
<dd>Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
</dd>
</dl>
<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>
    ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
</pre>
<p>Send email notifications to "user@example.com" when "myprinter" changes:
<pre>
    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>
    color.jpg
    create-printer-subscription.test
    document-a4.pdf
    document-a4.ps
    document-letter.pdf
    document-letter.ps
    get-completed-jobs.test
    get-jobs.test
    get-printer-attributes.test
    gray.jpg
    ipp-1.1.test
    ipp-2.0.test
    ipp-2.1.test
    ipp-2.2.test
    onepage-a4.pdf
    onepage-a4.ps
    onepage-letter.pdf
    onepage-letter.ps
    print-job.test
    testfile.jpg
    testfile.pdf
    testfile.ps
    testfile.txt
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>,
<br>
<a href='http://localhost:631/help'>http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2012 by Apple Inc.

</body>
</html>
Commit	Line	Data
a2326b5b MS	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	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>
	13	<b>ipptool
	14	</b>[ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
	15	<i>seconds
	16	</i>] [ -V
	17	<i>version
	18	</i>] [ -X ] [ -c ] [ -d
	19	<i>name=value
	20	</i>] [ -f
	21	<i>filename
	22	</i>] [ -i
	23	<i>seconds
	24	</i>] [ -n
	25	<i>repeat-count
	26	</i>] [ -q ] [ -t ] [ -v ]
	27	<i>URI
	28	</i><i>filename
	29	</i>[
	30	<i>... filenameN
	31	</i>]
	32	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
	33	<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 <a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>.
	34	<h2 class="title"><a name="OPTIONS">Options</a></h2>
	35	The following options are recognized by <i>ipptool</i>:
	36	<dl>
	37	<dt>-4
	38	</dt>
	39	<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
	40	</dd>
	41	<dt>-6
	42	</dt>
	43	<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
	44	</dd>
	45	<dt>-C
	46	</dt>
	47	<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.
	48	</dd>
	49	<dt>-E
	50	</dt>
	51	<dd>Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
	52	</dd>
	53	<dt>-I
	54	</dt>
	55	<dd>Specifies that <i>ipptool</i> will continue past errors.
	56	</dd>
	57	<dt>-L
	58	</dt>
	59	<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.
	60	</dd>
	61	<dt>-S
	62	</dt>
	63	<dd>Forces (dedicated) SSL encryption when connecting to the server.
	64	</dd>
65	<dt>-T seconds
66	</dt>
67	<dd>Specifies a timeout for IPP requests in seconds.
68	</dd>
69	<dt>-V version
70	</dt>
71	<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.
72	</dd>
73	<dt>-X
74	</dt>
75	<dd>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.
76	</dd>
77	<dt>-c
78	</dt>
79	<dd>Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
80	</dd>
81	<dt>-d name=value
82	</dt>
83	<dd>Defines the named variable.
84	</dd>
85	<dt>-f filename
86	</dt>
87	<dd>Defines the default request filename for tests.
88	</dd>
89	<dt>-i seconds
90	</dt>
91	<dd>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.
92	</dd>
93	<dt>-l
94	</dt>
95	<dd>Specifies that plain text output is desired.
96	</dd>
97	<dt>-n repeat-count
98	</dt>
99	<dd>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.
100	</dd>
101	<dt>-t
102	</dt>
103	<dd>Specifies that CUPS test report output is desired instead of the plain text output.
104	</dd>
105	<dt>-v
106	</dt>
107	<dd>Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
108	</dd>
109	</dl>
110	<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
111	The <i>ipptool</i> program is unique to CUPS.
112	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
113	Get a list of completed jobs for "myprinter":
114	<pre>
115	ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
116	</pre>
117	<p>Send email notifications to "user@example.com" when "myprinter" changes:
118	<pre>
119	ipptool -d recipient=mailto:user@example.com
120	ipp://localhost/printers/myprinter create-printer-subscription.test
121	</pre>
122	<h2 class="title"><a name="STANDARD_FILES">Standard Files</a></h2>
123	The following standard files are available:
124	<pre>
f3c17241	125	color.jpg
a2326b5b	126	create-printer-subscription.test
f3c17241 MS	127	document-a4.pdf
	128	document-a4.ps
	129	document-letter.pdf
	130	document-letter.ps
a2326b5b MS	131	get-completed-jobs.test
a2326b5b MS	132	get-jobs.test
f3c17241 MS	133	get-printer-attributes.test
f3c17241 MS	134	gray.jpg
a2326b5b MS	135	ipp-1.1.test
	136	ipp-2.0.test
	137	ipp-2.1.test
f3c17241 MS	138	ipp-2.2.test
	139	onepage-a4.pdf
	140	onepage-a4.ps
	141	onepage-letter.pdf
	142	onepage-letter.ps
	143	print-job.test
a2326b5b MS	144	testfile.jpg
	145	testfile.pdf
	146	testfile.ps
	147	testfile.txt
	148	</pre>
	149	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
	150	<a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>,
	151	<br>
	152	<a href='http://localhost:631/help'>http://localhost:631/help</a>
	153	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
f3c17241	154	Copyright 2007-2012 by Apple Inc.
a2326b5b MS	155
	156	</body>
	157	</html>