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