]>
Commit | Line | Data |
---|---|---|
39ff2fe7 MS |
1 | IPPTOOL.txt - 2010-04-07 |
2 | ------------------------ | |
3 | ||
4 | ||
5 | INTRODUCTION | |
6 | ||
7 | Starting with CUPS 1.5, CUPS now installs a user program called | |
8 | ipptool that can be used to send arbitrary IPP requests to a CUPS | |
9 | server or IPP printer. This tool started life as part of the CUPS | |
10 | automated test suite and has grown to support complex conformance | |
11 | tests and a simple way to query printer, job, and subscription | |
12 | attributes. | |
13 | ||
14 | ||
15 | BASIC USAGE | |
16 | ||
17 | The ipptool command requires a printer URI and one or more "test" | |
18 | files that describe the operations, attributes to display, and | |
19 | expected status and attribute values. Several standard files are | |
20 | included with CUPS, for example to show a list of pending print jobs | |
21 | on a CUPS printer called "myprinter" you'd run: | |
22 | ||
23 | ipptool ipp://localhost/printers/myprinter get-jobs.test | |
24 | ||
25 | which would produce something like this: | |
26 | ||
27 | job-id job-state job-name job-originating-user-name | |
28 | ------ ------------ ------------ ------------------------- | |
29 | 72 pending testfile.pdf msweet | |
30 | 73 pending testfile.ps msweet | |
31 | 74 pending-held testfile.jpg msweet | |
32 | 75 pending-held testfile.txt msweet | |
33 | ||
34 | To get output suitable for import into a spreadsheet, use the "-c" | |
35 | (CSV) option: | |
36 | ||
37 | ipptool -c ipp://localhost/printers/myprinter get-jobs.test | |
38 | ||
39 | which would produce something like this: | |
40 | ||
41 | job-id,job-state,job-name,job-originating-user-name | |
42 | 72,pending,testfile.pdf,msweet | |
43 | 73,pending,testfile.ps,msweet | |
44 | 74,pending-held,testfile.jpg,msweet | |
45 | 75,pending-held,testfile.txt,msweet | |
46 | ||
47 | ||
48 | CONFORMANCE TESTS | |
49 | ||
50 | We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, and | |
51 | IPP/2.1. For a given printer URI, the following commands perform | |
52 | tests at each level: | |
53 | ||
54 | ipptool -t printer-uri ipp-1.1.test | |
55 | ipptool -t -V 2.0 printer-uri ipp-2.0.test | |
56 | ipptool -t -V 2.1 printer-uri ipp-2.1.test | |
57 | ||
58 | ||
59 | READING THE DOCUMENTATION | |
60 | ||
61 | The command usage is described in the ipptest(1) man page, while the | |
62 | file format is described in the ipptestfile(5) man page. | |
63 | ||
64 | ||
65 | GETTING SUPPORT AND OTHER RESOURCES | |
66 | ||
67 | If you have problems, READ THE DOCUMENTATION FIRST! We also provide many | |
68 | discussion forums which are available at: | |
69 | ||
70 | http://www.cups.org/newsgroups.php | |
71 | ||
72 | See the CUPS web site at "http://www.cups.org/" for other resources. | |
73 | ||
74 | ||
75 | LEGAL STUFF | |
76 | ||
77 | CUPS is Copyright 2007-2010 by Apple Inc. CUPS and the CUPS logo are | |
78 | trademarks of Apple Inc. | |
79 | ||
80 | The MD5 Digest code is Copyright 1999 Aladdin Enterprises. | |
81 | ||
82 | This software is based in part on the work of the Independent JPEG Group. | |
83 | ||
84 | CUPS is provided under the terms of version 2 of the GNU General Public | |
85 | License and GNU Library General Public License. This program is distributed | |
86 | in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even | |
87 | the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
88 | See the "doc/help/license.html" or "LICENSE.txt" files for more information. |