1<!DOCTYPE HTML> 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> 11ipptool - perform internet printing protocol requests 12<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> 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] 70<h2 class="title"><a name="DESCRIPTION">Description</a></h2> 71<b>ipptool</b> 72sends IPP requests to the specified 73<i>printer-uri</i> 74and tests and/or displays the results. 75Each named 76<i>testfile</i> 77defines one or more requests, including the expected response status, attributes, and values. 78Output 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. 79The 80<i>testfile</i> 81format is described in 82<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5).</a> 83<h2 class="title"><a name="OPTIONS">Options</a></h2> 84The following options are recognized by 85<b>ipptool:</b> 86<dl class="man"> 87<dt><b>--help</b> 88<dd style="margin-left: 5.0em">Shows program help. 89<dt><b>--stop-after-include-error</b> 90<dd style="margin-left: 5.0em">Tells 91<b>ipptool</b> 92to stop if an error occurs in an included file. Normally 93<b>ipptool</b> 94will 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> 98being used. 99<dt><b>-4</b> 100<dd style="margin-left: 5.0em">Specifies that 101<b>ipptool</b> 102must 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> 106must connect to the printer or server using IPv6. 107<dt><b>-C</b> 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. 109The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files. 110<dt><b>-E</b> 111<dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. 112<dt><b>-I</b> 113<dd style="margin-left: 5.0em">Specifies that 114<b>ipptool</b> 115will continue past errors. 116<dt><b>-L</b> 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. 118The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files. 119<dt><b>-P</b><i> filename.plist</i> 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>). 121This option is incompatible with the <b>-i</b> (interval) and <b>-n</b> (repeat-count) options. 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> 125<dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds. 126<dt><b>-V</b><i> version</i> 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. 128<dt><b>-X</b> 129<dd style="margin-left: 5.0em">Specifies that XML (Apple plist) output is desired instead of the plain text report. 130This option is incompatible with the <b>-i</b> (interval) and <b>-n</b> (repeat-count) options. 131<dt><b>-c</b> 132<dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output. 133<dt><b>-d</b><i> name=value</i> 134<dd style="margin-left: 5.0em">Defines the named variable. 135<dt><b>-f</b><i> filename</i> 136<dd style="margin-left: 5.0em">Defines the default request filename for tests. 137<dt><b>-i</b><i> seconds</i> 138<dd style="margin-left: 5.0em">Specifies that the (last) 139<i>testfile</i> 140should be repeated at the specified interval. 141This option is incompatible with the <b>-X</b> (XML plist output) option. 142<dt><b>-l</b> 143<dd style="margin-left: 5.0em">Specifies that plain text output is desired. 144<dt><b>-n</b><i> repeat-count</i> 145<dd style="margin-left: 5.0em">Specifies that the (last) 146<i>testfile</i> 147should be repeated the specified number of times. 148This 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. 151<dt><b>-t</b> 152<dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output. 153<dt><b>-v</b> 154<dd style="margin-left: 5.0em">Specifies that all request and response attributes should be output in CUPS test mode (<b>-t</b>). 155This is the default for XML output. 156</dl> 157<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> 158The 159<b>ipptool</b> 160program returns 0 if all tests were sucessful and 1 otherwise. 161<h2 class="title"><a name="FILES">Files</a></h2> 162The 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> 196The 197<b>ipptool</b> 198program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2. 199<h2 class="title"><a name="EXAMPLES">Examples</a></h2> 200Get a list of completed jobs for "myprinter": 201<pre class="man"> 202 203 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test 204</pre> 205<p>Send email notifications to "user@example.com" when "myprinter" changes: 206<pre class="man"> 207 208 ipptool -d recipient=mailto:user@example.com \ 209 ipp://localhost/printers/myprinter create-printer-subscription.test 210</pre> 211<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> 212<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a> 213CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, 214IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp\-registrations)">http://www.iana.org/assignments/ipp\-registrations)</a>, 215PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) 216RFC 2911 (<a href="http://tools.ietf.org/html/rfc2911)">http://tools.ietf.org/html/rfc2911)</a>, 217<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> 218Copyright © 2007-2014 by Apple Inc. 219 220</body> 221</html> 222