projects / thirdparty / cups.git / blame
| Commit | Line | Data |
|---|---|---|
| 10d09e33 | 1 | IPPTOOL.txt - 2010-10-17 |
| 39ff2fe7 MS |
2 | ------------------------ |
| 3 | ||
| 4 | ||
| 5 | INTRODUCTION | |
| 6 | ||
| 10d09e33 MS |
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. | |
| 39ff2fe7 MS |
12 | |
| 13 | ||
| 14 | BASIC USAGE | |
| 15 | ||
| 10d09e33 MS |
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: | |
| 39ff2fe7 MS |
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 | ||
| 10d09e33 MS |
33 | To get output suitable for import into a spreadsheet, use the "-c" (CSV) |
| 34 | option: | |
| 39ff2fe7 MS |
35 | |
| 36 | ipptool -c ipp://localhost/printers/myprinter get-jobs.test | |
| 37 | ||
| 38 | which would 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 | ||
| 10d09e33 MS |
49 | We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, and IPP/2.1. |
| 50 | For a given printer URI, the following commands perform tests at each level: | |
| 39ff2fe7 MS |
51 | |
| 52 | ipptool -t printer-uri ipp-1.1.test | |
| 53 | ipptool -t -V 2.0 printer-uri ipp-2.0.test | |
| 54 | ipptool -t -V 2.1 printer-uri ipp-2.1.test | |
| 55 | ||
| 56 | ||
| 57 | READING THE DOCUMENTATION | |
| 58 | ||
| 10d09e33 MS |
59 | The command usage is described in the ipptest(1) man page, while the file |
| 60 | format is described in the ipptestfile(5) man page. | |
| 39ff2fe7 MS |
61 | |
| 62 | ||
| 63 | GETTING SUPPORT AND OTHER RESOURCES | |
| 64 | ||
| 65 | If you have problems, READ THE DOCUMENTATION FIRST! We also provide many | |
| 66 | discussion forums which are available at: | |
| 67 | ||
| 68 | http://www.cups.org/newsgroups.php | |
| 69 | ||
| 70 | See the CUPS web site at "http://www.cups.org/" for other resources. | |
| 71 | ||
| 72 | ||
| 73 | LEGAL STUFF | |
| 74 | ||
| 75 | CUPS is Copyright 2007-2010 by Apple Inc. CUPS and the CUPS logo are | |
| 76 | trademarks of Apple Inc. | |
| 77 | ||
| 78 | The MD5 Digest code is Copyright 1999 Aladdin Enterprises. | |
| 79 | ||
| 80 | This software is based in part on the work of the Independent JPEG Group. | |
| 81 | ||
| 82 | CUPS is provided under the terms of version 2 of the GNU General Public | |
| 83 | License and GNU Library General Public License. This program is distributed | |
| 84 | in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even | |
| 85 | the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 86 | See the "doc/help/license.html" or "LICENSE.txt" files for more information. |