1ipptool(1)                        Apple Inc.                        ipptool(1)
2
3
4

NAME

6       ipptool - perform internet printing protocol requests
7

SYNOPSIS

9       ipptool  [ --help ] [ --stop-after-include-error ] [ --version ] [ -4 ]
10       [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -P filename.plist ] [ -S  ]  [  -T
11       seconds  ] [ -V version ] [ -X ] [ -c ] [ -d name=value ] [ -f filename
12       ] [ -h ] [ -i seconds ] [ -n repeat-count ] [ -q  ]  [  -t  ]  [  -v  ]
13       printer-uri testfile [ ...  testfile ]
14

DESCRIPTION

16       ipptool  sends  IPP  requests  to  the  specified printer-uri and tests
17       and/or displays the results.  Each named testfile defines one  or  more
18       requests,  including the expected response status, attributes, and val‐
19       ues.  Output is either a plain text, formatted text, CSV, or XML report
20       on the standard output, with a non-zero exit status indicating that one
21       or more tests have failed.  The testfile format is  described  in  ipp‐
22       toolfile(5).
23

OPTIONS

25       The following options are recognized by ipptool:
26
27       --help
28            Shows program help.
29
30       --stop-after-include-error
31            Tells ipptool to stop if an error occurs in an included file. Nor‐
32            mally ipptool  will  continue  with  subsequent  tests  after  the
33            INCLUDE directive.
34
35       --version
36            Shows the version of ipptool being used.
37
38       -4   Specifies that ipptool must connect to the printer or server using
39            IPv4.
40
41       -6   Specifies that ipptool must connect to the printer or server using
42            IPv6.
43
44       -C   Specifies  that requests should be sent using the HTTP/1.1 "Trans‐
45            fer-Encoding: chunked" header, which is required  for  conformance
46            by all versions of IPP.  The default is to use "Transfer-Encoding:
47            chunked" for requests with attached  files  and  "Content-Length:"
48            for requests without attached files.
49
50       -E   Forces TLS encryption when connecting to the server using the HTTP
51            "Upgrade" header.
52
53       -I   Specifies that ipptool will continue past errors.
54
55       -L   Specifies that requests should be sent using  the  HTTP/1.0  "Con‐
56            tent-Length:"  header,  which  is  required for conformance by all
57            versions of IPP.  The default is to use "Transfer-Encoding:  chun‐
58            ked"  for  requests  with attached files and "Content-Length:" for
59            requests without attached files.
60
61       -P filename.plist
62            Specifies that the test results should be written to the named XML
63            (Apple  plist)  file  in addition to the regular test report (-t).
64            This  option  is  incompatible  with  the  -i  (interval)  and  -n
65            (repeat-count) options.
66
67       -S   Forces (dedicated) TLS encryption when connecting to the server.
68
69       -T seconds
70            Specifies a timeout for IPP requests in seconds.
71
72       -V version
73            Specifies  the  default IPP version to use: 1.0, 1.1, 2.0, 2.1, or
74            2.2. If not specified, version 1.1 is used.
75
76       -X   Specifies that XML (Apple plist) output is desired instead of  the
77            plain  text  report.   This  option  is  incompatible  with the -i
78            (interval) and -n (repeat-count) options.
79
80       -c   Specifies that CSV  (comma-separated  values)  output  is  desired
81            instead of the plain text output.
82
83       -d name=value
84            Defines the named variable.
85
86       -f filename
87            Defines the default request filename for tests.
88
89       -h   Validate HTTP response headers.
90
91       -i seconds
92            Specifies that the (last) testfile should be repeated at the spec‐
93            ified interval.  This option is  incompatible  with  the  -X  (XML
94            plist output) option.
95
96       -l   Specifies that plain text output is desired.
97
98       -n repeat-count
99            Specifies  that  the (last) testfile should be repeated the speci‐
100            fied number of times.  This option is  incompatible  with  the  -X
101            (XML plist output) option.
102
103       -q   Be quiet and produce no output.
104
105       -t   Specifies  that  CUPS test report output is desired instead of the
106            plain text output.
107
108       -v   Specifies that all request and response attributes should be  out‐
109            put in CUPS test mode (-t).  This is the default for XML output.
110

EXIT STATUS

112       The ipptool program returns 0 if all tests were successful and 1 other‐
113       wise.
114

FILES

116       The following standard files are available:
117       color.jpg
118       create-printer-subscription.test
119       document-a4.pdf
120       document-a4.ps
121       document-letter.pdf
122       document-letter.ps
123       get-completed-jobs.test
124       get-jobs.test
125       get-notifications.test
126       get-printer-attributes.test
127       get-subscriptions.test
128       gray.jpg
129       ipp-1.1.test
130       ipp-2.0.test
131       ipp-2.1.test
132       ipp-2.2.test
133       ipp-everywhere.test
134       onepage-a4.pdf
135       onepage-a4.ps
136       onepage-letter.pdf
137       onepage-letter.ps
138       print-job.test
139       print-job-deflate.test
140       print-job-gzip.test
141       testfile.jpg
142       testfile.pcl
143       testfile.pdf
144       testfile.ps
145       testfile.txt
146       validate-job.test
147

CONFORMING TO

149       The ipptool program is unique to CUPS  and  conforms  to  the  Internet
150       Printing Protocol up to version 2.2.
151

EXAMPLES

153       Get a list of completed jobs for "myprinter":
154
155           ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
156
157       Send   email   notifications  to  "user@example.com"  when  "myprinter"
158       changes:
159
160           ipptool -d recipient=mailto:user@example.com \
161               ipp://localhost/printers/myprinter create-printer-subscription.test
162

SEE ALSO

164       ipptoolfile(5),   IANA   IPP   Registry    (http://www.iana.org/assign
165       ments/ipp-registrations),  PWG  Internet  Printing  Protocol  Workgroup
166       (http://www.pwg.org/ipp) RFC 8011 (http://tools.ietf.org/html/rfc8011),
167
169       Copyright © 2007-2017 by Apple Inc.
170
171
172
1734 August 2017                        CUPS                           ipptool(1)
Impressum