]>
Commit | Line | Data |
---|---|---|
aaf19ab0 MS |
1 | .\" |
2 | .\" "$Id$" | |
3 | .\" | |
4 | .\" ipptool man page for CUPS. | |
5 | .\" | |
0fa6c7fa | 6 | .\" Copyright 2010-2013 by Apple Inc. |
aaf19ab0 MS |
7 | .\" |
8 | .\" These coded instructions, statements, and computer programs are the | |
9 | .\" property of Apple Inc. and are protected by Federal copyright | |
10 | .\" law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
11 | .\" which should have been included with this file. If this file is | |
12 | .\" file is missing or damaged, see the license at "http://www.cups.org/". | |
13 | .\" | |
1106b00e | 14 | .TH ipptool 1 "CUPS" "9 November 2010" "Apple Inc." |
aaf19ab0 MS |
15 | .SH NAME |
16 | ipptool - perform internet printing protocol requests | |
17 | .SH SYNOPSIS | |
18 | .B ipptool | |
1106b00e | 19 | [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T |
10d09e33 MS |
20 | .I seconds |
21 | ] [ -V | |
aaf19ab0 MS |
22 | .I version |
23 | ] [ -X ] [ -c ] [ -d | |
24 | .I name=value | |
25 | ] [ -f | |
26 | .I filename | |
27 | ] [ -i | |
28 | .I seconds | |
29 | ] [ -n | |
30 | .I repeat-count | |
31 | ] [ -q ] [ -t ] [ -v ] | |
32 | .I URI | |
33 | .I filename | |
34 | [ | |
35 | .I ... filenameN | |
36 | ] | |
37 | .SH DESCRIPTION | |
38 | \fIipptool\fR 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 \fIipptoolfile(5)\fR. | |
39 | .SH OPTIONS | |
40 | The following options are recognized by \fIipptool\fR: | |
41 | .TP 5 | |
1106b00e MS |
42 | -4 |
43 | Specifies that \fIipptool\fR must connect to the printer or server using IPv4. | |
44 | .TP 5 | |
45 | -6 | |
46 | Specifies that \fIipptool\fR must connect to the printer or server using IPv6. | |
47 | .TP 5 | |
aaf19ab0 MS |
48 | -C |
49 | 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 | .TP 5 | |
51 | -E | |
52 | Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. | |
53 | .TP 5 | |
030ae6a1 MS |
54 | -I |
55 | Specifies that \fIipptool\fR will continue past errors. | |
56 | .TP 5 | |
aaf19ab0 MS |
57 | -L |
58 | 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. | |
59 | .TP 5 | |
60 | -S | |
61 | Forces (dedicated) SSL encryption when connecting to the server. | |
62 | .TP 5 | |
10d09e33 MS |
63 | -T seconds |
64 | Specifies a timeout for IPP requests in seconds. | |
65 | .TP 5 | |
aaf19ab0 MS |
66 | -V version |
67 | 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. | |
68 | .TP 5 | |
69 | -X | |
70 | Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fI-i\fR (interval) and \fI-n\fR (repeat-count) options. | |
71 | .TP 5 | |
72 | -c | |
73 | Specifies that CSV (comma-separated values) output is desired instead of the plain text output. | |
74 | .TP 5 | |
75 | -d name=value | |
76 | Defines the named variable. | |
77 | .TP 5 | |
78 | -f filename | |
79 | Defines the default request filename for tests. | |
80 | .TP 5 | |
81 | -i seconds | |
10d09e33 | 82 | Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the \fI-X\fR (XML plist output) option. |
aaf19ab0 MS |
83 | .TP 5 |
84 | -l | |
85 | Specifies that plain text output is desired. | |
86 | .TP 5 | |
87 | -n repeat-count | |
88 | Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the \fI-X\fR (XML plist output) option. | |
89 | .TP 5 | |
90 | -t | |
91 | Specifies that CUPS test report output is desired instead of the plain text output. | |
92 | .TP 5 | |
93 | -v | |
94 | Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output. | |
95 | .SH COMPATIBILITY | |
96 | The \fIipptool\fR program is unique to CUPS. | |
97 | .SH EXAMPLES | |
98 | Get a list of completed jobs for "myprinter": | |
99 | .nf | |
100 | ipptool ipp://localhost/printers/myprinter get-completed-jobs.test | |
101 | .fi | |
102 | .LP | |
103 | Send email notifications to "user@example.com" when "myprinter" changes: | |
104 | .nf | |
105 | ipptool -d recipient=mailto:user@example.com \ | |
106 | ipp://localhost/printers/myprinter create-printer-subscription.test | |
107 | .fi | |
108 | .SH STANDARD FILES | |
109 | The following standard files are available: | |
110 | .nf | |
f3c17241 | 111 | color.jpg |
aaf19ab0 | 112 | create-printer-subscription.test |
f3c17241 MS |
113 | document-a4.pdf |
114 | document-a4.ps | |
115 | document-letter.pdf | |
116 | document-letter.ps | |
aaf19ab0 MS |
117 | get-completed-jobs.test |
118 | get-jobs.test | |
f3c17241 MS |
119 | get-printer-attributes.test |
120 | gray.jpg | |
aaf19ab0 MS |
121 | ipp-1.1.test |
122 | ipp-2.0.test | |
123 | ipp-2.1.test | |
f3c17241 MS |
124 | ipp-2.2.test |
125 | onepage-a4.pdf | |
126 | onepage-a4.ps | |
127 | onepage-letter.pdf | |
128 | onepage-letter.ps | |
129 | print-job.test | |
aaf19ab0 MS |
130 | testfile.jpg |
131 | testfile.pdf | |
132 | testfile.ps | |
133 | testfile.txt | |
134 | .fi | |
135 | .SH SEE ALSO | |
136 | \fIipptoolfile(5)\fR, | |
137 | .br | |
138 | http://localhost:631/help | |
139 | .SH COPYRIGHT | |
0fa6c7fa | 140 | Copyright 2007-2013 by Apple Inc. |
aaf19ab0 MS |
141 | .\" |
142 | .\" End of "$Id$". | |
143 | .\" |