Merge changes from CUPS 1.6svn-r10267.

[thirdparty/cups.git] / IPPTOOL.txt

diff --git a/IPPTOOL.txt b/IPPTOOL.txt
index 3447b19398ba9275f9e7d0dcea12dc550bf2afbd..9cd2201032ec5c8d1657147101116e3ccf70bacc 100644 (file)
--- a/IPPTOOL.txt
+++ b/IPPTOOL.txt
@@ -1,4 +1,4 @@
-IPPTOOL.txt - 2011-12-02
+IPPTOOL.txt - 2012-02-06
 ------------------------
 
 See the file CHANGES-IPPTOOL.txt for a list of changes to this software.
@@ -6,11 +6,11 @@ See the file CHANGES-IPPTOOL.txt for a list of changes to this software.
 
 INTRODUCTION
 
-    Starting with CUPS 1.5, CUPS now installs 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 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.
 
 
 BASIC USAGE
@@ -46,6 +46,22 @@ BASIC USAGE
        75,pending-held,testfile.txt,msweet
 
 
+STANDARD TEST FILES
+
+    The following standard test files are included with ipptool:
+
+        create-printer-subscription.test    Creates a printer subscription for
+                                            state change notifications
+        get-completed-jobs.test             Shows a list of completed jobs
+        get-jobs.test                       Shows a list of pending jobs
+        get-printer-attributes.test         Shows printer attributes
+        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
+        print-job.test                      Prints a file
+
+
 CONFORMANCE TESTS
 
     We provide basic IPP conformance tests for IPP/1.1, IPP/2.0, IPP/2.1, and
@@ -71,6 +87,28 @@ CONFORMANCE TESTS
        onepage-a4.ps
        onepage-letter.pdf
        onepage-letter.ps
+       testfile.jpg
+       testfile.pdf
+       testfile.ps
+       testfile.txt
+
+    Useful options include the following:
+
+        -4           Connect using IPv4
+        -6           Connect using IPv6
+        -C           Send chunked requests (default)
+        -d name=val  Define a variable
+        -E           Test IPP with HTTP Upgrade to TLS
+        -L           Send requests using the Content-Length header (HTTP/1.0)
+        -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
+
+    The printer-uri must be a URI supported by the printer using the "ipp" or
+    "ipps" scheme, for example:
+
+        ipp://192.168.0.1/ipp
+        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:
@@ -80,7 +118,9 @@ CONFORMANCE TESTS
     The standard test files are available on cups.org under the "test"
     directory, for example:
 
-       http://www.cups.org/test/document-a4.pdf
+        ipptool -tf document-a4.pdf \
+            -d document-uri=http://www.cups.org/test/document-a4.pdf \
+            ipp://192.168.0.1/ipp -I -V 2.0 ipp-2.0.test
 
     The "document" test files contain 4 pages each.  Doing the IPP conformance
     tests will will produce up to 90 pages on various media, depending on the
@@ -90,7 +130,8 @@ CONFORMANCE TESTS
 READING THE DOCUMENTATION
 
     The command usage is described in the ipptest(1) man page, while the file
-    format is described in the ipptestfile(5) man page.
+    format is described in the ipptestfile(5) man page.  Both are provided in
+    HTML format with the standalone releases of ipptool.
 
 
 GETTING SUPPORT AND OTHER RESOURCES
@@ -118,8 +159,7 @@ REPORTING BUGS
     test with debug logging enabled.  Run the following commands on Windows to
     enable debug logging:
 
-       set CUPS_DEBUG_LOG=ipptool.log
-       set CUPS_DEBUG_LEVEL=6
+        setdebug.bat
 
     For Linux and Mac OS X use:
 
@@ -133,7 +173,7 @@ REPORTING BUGS
 
 LEGAL STUFF
 
-    CUPS is Copyright 2007-2011 by Apple Inc.  CUPS and the CUPS logo are
+    CUPS is Copyright 2007-2012 by Apple Inc.  CUPS and the CUPS logo are
     trademarks of Apple Inc.
 
     The MD5 Digest code is Copyright 1999 Aladdin Enterprises.