IPPTOOL.txt

   1 IPPTOOL.txt - 2011-09-20
   2 ------------------------
   3
   4
   5 INTRODUCTION
   6
   7     Starting with CUPS 1.5, CUPS now installs a user program called ipptool that
   8     can be used to send arbitrary IPP requests to a CUPS server or IPP printer.
   9     This tool started life as part of the CUPS automated test suite and has
  10     grown to support complex conformance tests and a simple way to query
  11     printer, job, and subscription attributes.
  12
  13
  14 BASIC USAGE
  15
  16     The ipptool command requires a printer URI and one or more "test" files that
  17     describe the operations, attributes to display, and expected status and
  18     attribute values. Several standard files are included with CUPS, for example
  19     to show a list of pending print jobs on a CUPS printer called "myprinter"
  20     you'd run:
  21
  22         ipptool ipp://localhost/printers/myprinter get-jobs.test
  23
  24     which would produce something like this:
  25
  26         job-id job-state    job-name     job-originating-user-name
  27         ------ ------------ ------------ -------------------------
  28         72     pending      testfile.pdf msweet
  29         73     pending      testfile.ps  msweet
  30         74     pending-held testfile.jpg msweet
  31         75     pending-held testfile.txt msweet
  32
  33     To get output suitable for import into a spreadsheet, use the "-c" (CSV)
  34     option:
  35
  36         ipptool -c ipp://localhost/printers/myprinter get-jobs.test
  37
  38     which will produce something like this:
  39
  40         job-id,job-state,job-name,job-originating-user-name
  41         72,pending,testfile.pdf,msweet
  42         73,pending,testfile.ps,msweet
  43         74,pending-held,testfile.jpg,msweet
  44         75,pending-held,testfile.txt,msweet
  45
  46
  47 CONFORMANCE TESTS
  48
  49     We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, IPP/2.1, and
  50     IPP/2.2.  For a given printer URI, the following commands perform tests at
  51     each level:
  52
  53         ipptool -tf filename [options] -I printer-uri ipp-1.1.test
  54         ipptool -tf filename [options] -I -V 2.0 printer-uri ipp-2.0.test
  55         ipptool -tf filename [options] -I -V 2.1 printer-uri ipp-2.1.test
  56         ipptool -tf filename [options] -I -V 2.2 printer-uri ipp-2.2.test
  57
  58     The filename must use a format supported by the printer; ipptool will guess
  59     the MIME media type using the extension, otherwise application/octet stream
  60     will be used.  The following standard test files are included:
  61
  62         color.jpg
  63         document-a4.pdf
  64         document-a4.ps
  65         document-letter.pdf
  66         document-letter.ps
  67         gray.jpg
  68         onepage-a4.pdf
  69         onepage-a4.ps
  70         onepage-letter.pdf
  71         onepage-letter.ps
  72
  73     Print-by-reference (URL) printing can be tested by defining the document-uri
  74     variable to a URL, for example:
  75
  76         ipptool -tf filename -d document-uri=url -I printer-uri ipp-1.1.test
  77
  78     The standard test files are available on cups.org under the "test"
  79     directory, for example:
  80
  81         http://www.cups.org/test/document-a4.pdf
  82
  83     The "document" test files contain 4 pages each.  Doing the IPP conformance
  84     tests will will produce up to 90 pages on various media, depending on the
  85     printer.
  86
  87
  88 READING THE DOCUMENTATION
  89
  90     The command usage is described in the ipptest(1) man page, while the file
  91     format is described in the ipptestfile(5) man page.
  92
  93
  94 GETTING SUPPORT AND OTHER RESOURCES
  95
  96     If you have problems, READ THE DOCUMENTATION FIRST!  We also provide many
  97     discussion forums which are available at:
  98
  99         http://www.cups.org/newsgroups.php
 100
 101     See the CUPS web site at "http://www.cups.org/" for other resources.
 102
 103
 104 LEGAL STUFF
 105
 106     CUPS is Copyright 2007-2011 by Apple Inc.  CUPS and the CUPS logo are
 107     trademarks of Apple Inc.
 108
 109     The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
 110
 111     This software is based in part on the work of the Independent JPEG Group.
 112
 113     CUPS is provided under the terms of version 2 of the GNU General Public
 114     License and GNU Library General Public License. This program is distributed
 115     in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 116     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 117     See the "doc/help/license.html" or "LICENSE.txt" files for more information.