]>
Commit | Line | Data |
---|---|---|
83e08001 | 1 | IPPTOOL.txt - 2011-09-14 |
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 | ||
83e08001 | 38 | which will produce something like this: |
39ff2fe7 MS |
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 | ||
83e08001 MS |
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] printer-uri ipp-1.1.test | |
54 | ipptool -tf filename [options] -V 2.0 printer-uri ipp-2.0.test | |
55 | ipptool -tf filename [options] -V 2.1 printer-uri ipp-2.1.test | |
56 | ipptool -tf filename [options] -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=your-url printer-uri ipp-1.1.test | |
77 | ||
78 | The standard test files are available on cups.org under the "test" | |
79 | directory, for example: | |
39ff2fe7 | 80 | |
83e08001 | 81 | http://www.cups.org/test/document-a4.pdf |
39ff2fe7 MS |
82 | |
83 | ||
84 | READING THE DOCUMENTATION | |
85 | ||
10d09e33 MS |
86 | The command usage is described in the ipptest(1) man page, while the file |
87 | format is described in the ipptestfile(5) man page. | |
39ff2fe7 MS |
88 | |
89 | ||
90 | GETTING SUPPORT AND OTHER RESOURCES | |
91 | ||
92 | If you have problems, READ THE DOCUMENTATION FIRST! We also provide many | |
93 | discussion forums which are available at: | |
94 | ||
95 | http://www.cups.org/newsgroups.php | |
96 | ||
97 | See the CUPS web site at "http://www.cups.org/" for other resources. | |
98 | ||
99 | ||
100 | LEGAL STUFF | |
101 | ||
321d8d57 | 102 | CUPS is Copyright 2007-2011 by Apple Inc. CUPS and the CUPS logo are |
39ff2fe7 MS |
103 | trademarks of Apple Inc. |
104 | ||
105 | The MD5 Digest code is Copyright 1999 Aladdin Enterprises. | |
106 | ||
107 | This software is based in part on the work of the Independent JPEG Group. | |
108 | ||
109 | CUPS is provided under the terms of version 2 of the GNU General Public | |
110 | License and GNU Library General Public License. This program is distributed | |
111 | in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even | |
112 | the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
113 | See the "doc/help/license.html" or "LICENSE.txt" files for more information. |