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 [ --help ] [ --stop-after-include-error ] [ --version ]
  15 [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
  16 <i>seconds</i>
  17 ] [ -V
  18 <i>version</i>
  19 ] [ -X ] [ -c ] [ -d
  20 <i>name=value</i>
  21 ] [ -f
  22 <i>filename</i>
  23 ] [ -i
  24 <i>seconds</i>
  25 ] [ -n
  26 <i>repeat-count</i>
  27 ] [ -q ] [ -t ] [ -v ]
  28 <i>URI</i>
  29 <i>filename</i>
  30 [
  31 <i>...</i><i>filenameN</i>
  32 ]
  33 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  34 <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 <i>ipptoolfile(5)</i>.
  35 <h2 class="title"><a name="OPTIONS">Options</a></h2>
  36 The following options are recognized by <i>ipptool</i>:
  37 <dl class="man">
  38 <dt>--help
  39 <dd style="margin-left: 5.0em">Shows program help.
  40 <dt>--stop-after-include-error
  41 <dd style="margin-left: 5.0em">Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
  42 <dt>--version
  43 <dd style="margin-left: 5.0em">Shows the version of <i>ipptool</i> being used.
  44 <dt>-4
  45 <dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
  46 <dt>-6
  47 <dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
  48 <dt>-C
  49 <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.
  50 <dt>-E
  51 <dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
  52 <dt>-I
  53 <dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> will continue past errors.
  54 <dt>-L
  55 <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.
  56 <dt>-S
  57 <dd style="margin-left: 5.0em">Forces (dedicated) SSL encryption when connecting to the server.
  58 <dt>-T seconds
  59 <dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds.
  60 <dt>-V version
  61 <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.
  62 <dt>-X
  63 <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 <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
  64 <dt>-c
  65 <dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
  66 <dt>-d name=value
  67 <dd style="margin-left: 5.0em">Defines the named variable.
  68 <dt>-f filename
  69 <dd style="margin-left: 5.0em">Defines the default request filename for tests.
  70 <dt>-i seconds
  71 <dd style="margin-left: 5.0em">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.
  72 <dt>-l
  73 <dd style="margin-left: 5.0em">Specifies that plain text output is desired.
  74 <dt>-n repeat-count
  75 <dd style="margin-left: 5.0em">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.
  76 <dt>-t
  77 <dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output.
  78 <dt>-v
  79 <dd style="margin-left: 5.0em">Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
  80 </dl>
  81 <h2 class="title"><a name="EXIT_CODE">Exit Code</a></h2>
  82 The <i>ipptool</i> program returns 0 if all tests were sucessful and 1 otherwise.
  83 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
  84 The <i>ipptool</i> program is unique to CUPS.
  85 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
  86 Get a list of completed jobs for "myprinter":
  87 <pre class="man">
  88
  89     ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
  90 </pre>
  91 <p>Send email notifications to "user@example.com" when "myprinter" changes:
  92 <pre class="man">
  93
  94     ipptool -d recipient=mailto:user@example.com \
  95         ipp://localhost/printers/myprinter create-printer-subscription.test
  96 </pre>
  97 <h2 class="title"><a name="STANDARD_FILES">Standard Files</a></h2>
  98 The following standard files are available:
  99 <pre class="man">
 100
 101     color.jpg
 102     create-printer-subscription.test
 103     document-a4.pdf
 104     document-a4.ps
 105     document-letter.pdf
 106     document-letter.ps
 107     get-completed-jobs.test
 108     get-jobs.test
 109     get-notifications.test
 110     get-printer-attributes.test
 111     get-subscriptions.test
 112     gray.jpg
 113     ipp-1.1.test
 114     ipp-2.0.test
 115     ipp-2.1.test
 116     ipp-2.2.test
 117     ipp-everywhere.test
 118     onepage-a4.pdf
 119     onepage-a4.ps
 120     onepage-letter.pdf
 121     onepage-letter.ps
 122     print-job.test
 123     print-job-deflate.test
 124     print-job-gzip.test
 125     testfile.jpg
 126     testfile.pcl
 127     testfile.pdf
 128     testfile.ps
 129     testfile.txt
 130     validate-job.test
 131 </pre>
 132 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 133 <i>ipptoolfile(5)</i>, RFC 2911,
 134 <br>
 135 <a href="http://localhost:631/help">http://localhost:631/help</a>
 136 <br>
 137 <a href="http://www.iana.org/assignments/ipp-registrations">http://www.iana.org/assignments/ipp-registrations</a>
 138 <br>
 139 <a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>
 140 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 141 Copyright 2007-2014 by Apple Inc.
 142
 143 </body>
 144 </html>