doc/help/man-ipptool.html

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