-IPPTOOL.txt - 2012-02-06
+IPPTOOL.txt - 2013-07-15
------------------------
See the file CHANGES-IPPTOOL.txt for a list of changes to this software.
INTRODUCTION
- CUPS includes a user program called ipptool that can be used to send
- arbitrary IPP requests to a CUPS server or IPP printer. This tool started
- life as part of the CUPS automated test suite and has grown to support
- complex conformance tests and a simple way to query printer, job, and
- subscription attributes.
+ CUPS includes two user programs for IPP printers. The first is called
+ ipptool and can be used to send arbitrary IPP requests to a CUPS server or
+ IPP printer. This tool started life as part of the CUPS automated test
+ suite and has grown to support complex conformance tests and a simple way
+ to query printer, job, and subscription attributes.
+ The second program called ippfind that can be used to find IPP printers
+ that have registered themselves using Bonjour (DNS-SD, mDNS, and Zeroconf)
+ and run commands such as ipptool.
-BASIC USAGE
+
+READING THE DOCUMENTATION
+
+ Full documentation on the ipptool command can be found in the
+ "man-ipptool.html" and "man-ipptoolfile.html" files; the latter describes
+ the test file format supported by ipptool.
+
+ Full documentation on the ippfind command can be found in the
+ "man-ippfind.html" file.
+
+
+IPPFIND BASIC USAGE
+
+ The ippfind command can be used to discover IPP printers on your network.
+ For example, the following command prints the printer URI of registered IPP
+ printers:
+
+ ippfind
+
+ To find all color IPP printers, run:
+
+ ippfind --txt-color T
+
+ And to run the IPP Everywhere conformance test file on every registered IPP
+ printer, run the following command:
+
+ ippfind _ipp._tcp,_print --exec ipptool -t '{}' ipp-everywhere.test \;
+
+
+IPPTOOL BASIC USAGE
The ipptool command requires a printer URI and one or more "test" files that
describe the operations, attributes to display, and expected status and
state change notifications
get-completed-jobs.test Shows a list of completed jobs
get-jobs.test Shows a list of pending jobs
+ get-notifications.test Shows events for an ippget
+ subscription.
get-printer-attributes.test Shows printer attributes
+ get-subscriptions.test Shows a list of subscriptions
ipp-1.1.test IPP/1.1 conformance test suite
ipp-2.0.test IPP/2.0 conformance test suite
ipp-2.1.test IPP/2.1 conformance test suite
ipp-2.2.test IPP/2.2 conformance test suite
+ ipp-everywhere.test IPP Everywhere conformance test
+ suite
print-job.test Prints a file
+ print-job-deflate.test Prints a file, compressing with
+ deflate.
+ print-job-gzip.test Prints a file, compressing with gzip
+ validate-job.test Validates attributes for a job
+ submission.
CONFORMANCE TESTS
- We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, IPP/2.1, and
- IPP/2.2. For a given printer URI, the following commands perform tests at
- each level:
+ We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, IPP/2.1,
+ IPP/2.2, and IPP Everywhere. For a given printer URI, the following
+ commands perform tests at each level:
ipptool -tf filename [options] -I printer-uri ipp-1.1.test
ipptool -tf filename [options] -I -V 2.0 printer-uri ipp-2.0.test
onepage-letter.pdf
onepage-letter.ps
testfile.jpg
+ testfile.pcl
testfile.pdf
testfile.ps
testfile.txt
-S Test IPP over HTTPS (default for ipps: URIs)
-T seconds Set a timeout for responses in seconds
-v Be verbose, showing all attributes sent and received
+ -X Produce XML (Apple plist) output
The printer-uri must be a URI supported by the printer using the "ipp" or
"ipps" scheme, for example:
ipps://192.168.0.1/ipp/print
Print-by-reference (URL) printing can be tested by defining the document-uri
- variable to a URL, for example:
+ variable as a URL, for example:
ipptool -tf filename -d document-uri=url -I printer-uri ipp-1.1.test
printer.
-READING THE DOCUMENTATION
+IPP EVERYWHERE TESTING
+
+ The IPP Everywhere tests use sample PWG raster files available from:
- The command usage is described in the ipptest(1) man page, while the file
- format is described in the ipptestfile(5) man page. Both are provided in
- HTML format with the standalone releases of ipptool.
+ ftp://ftp.pwg.org/pub/pwg/ipp/examples
+
+ Extract the corresponding ZIP archives into the current directory before
+ running the ipp-everywhere.test file. The test file will attempt to print
+ each PWG Raster file that is supported by the printer being tested - up to
+ 372 pages including the 90 pages produced by the regular IPP test suite.
GETTING SUPPORT AND OTHER RESOURCES
- If you have problems, READ THE DOCUMENTATION FIRST! We also provide many
+ If you have problems, READ THE DOCUMENTATION FIRST! We also provide
discussion forums which are available at:
- http://www.cups.org/newsgroups.php
-
- See the CUPS web site at "http://www.cups.org/" for other resources.
+ http://www.cups.org/
REPORTING BUGS
- If you believe you have discovered a bug in ipptool, please fill out the
- bug form at:
+ If you believe you have discovered a bug in ippfind or ipptool, please fill
+ out the bug form at:
http://www.cups.org/str.php
- Be sure to identify the version of CUPS and ipptool (if you downloaded the
- standalone version) you are using, the printer (if any) and firmware
- version, and include any files that apply.
+ Be sure to identify the version of CUPS and ippfind/ipptool (if you
+ downloaded the standalone version) you are using, the printer (if any) and
+ firmware version, and include any files that apply.
- If you downloaded the standalone version of ipptool, please also re-run the
- test with debug logging enabled. Run the following commands on Windows to
- enable debug logging:
+ If you downloaded the standalone version of ippfind/ipptool, please also
+ re-run the command with debug logging enabled. Run the following commands
+ on Windows to enable debug logging:
setdebug.bat
CUPS_DEBUG_LOG=ipptool.log; export CUPS_DEBUG_LOG
CUPS_DEBUG_LEVEL=6; export CUPS_DEBUG_LEVEL
- Then when you run the ipptool command a new "ipptool.log" file will be
- created with detailed information - attach this file to the bug you file
- as well.
+ Then when you run the ippfind or ipptool command a new "ipptool.log" file
+ will be created with detailed information - attach this file to the bug you
+ file as well.
LEGAL STUFF
- CUPS is Copyright 2007-2012 by Apple Inc. CUPS and the CUPS logo are
+ CUPS is Copyright 2007-2013 by Apple Inc. CUPS and the CUPS logo are
trademarks of Apple Inc.
The MD5 Digest code is Copyright 1999 Aladdin Enterprises.