logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ipptool - perform internet printing protocol requests

Conforming To

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

Description

ipptool sends IPP requests to the specified printer-uri and tests  and/or  displays  the  results.   Each
       named  testfile  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 testfile format is described  in
       ipptoolfile(5).

Examples

       Get a list of completed jobs for "myprinter":

           ipptool ipp://localhost/printers/myprinter get-completed-jobs.test

       Send email notifications to "user@example.com" when "myprinter" changes:

           ipptool -d recipient=mailto:user@example.com \
               ipp://localhost/printers/myprinter create-printer-subscription.test

Exit Status

       The ipptool program returns 0 if all tests were successful and 1 otherwise.

Files

       The following standard files are available:
       color.jpgcreate-printer-subscription.testdocument-a4.pdfdocument-a4.psdocument-letter.pdfdocument-letter.psget-completed-jobs.testget-jobs.testget-notifications.testget-printer-attributes.testget-subscriptions.testgray.jpgipp-1.1.testipp-2.0.testipp-2.1.testipp-2.2.testipp-everywhere.testonepage-a4.pdfonepage-a4.psonepage-letter.pdfonepage-letter.psprint-job.testprint-job-deflate.testprint-job-gzip.testtestfile.jpgtestfile.pcltestfile.pdftestfile.pstestfile.txtvalidate-job.test

Name

       ipptool - perform internet printing protocol requests

Options

       The following options are recognized by ipptool:--help
            Shows program help.

       --ippserverfilename
            Specifies that the test results should be written to the named ippserver attributes file.

       --stop-after-include-error
            Tells  ipptool  to  stop if an error occurs in an included file. Normally ipptool will continue with
            subsequent tests after the INCLUDE directive.

       --version
            Shows the version of ipptool being used.

       -4   Specifies that ipptool must connect to the printer or server using IPv4.

       -6   Specifies that ipptool must connect to the printer or server using IPv6.

       -C   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.

       -E   Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.

       -I   Specifies that ipptool will continue past errors.

       -L   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.

       -Pfilename.plist
            Specifies that the test results should be written to the named XML (Apple plist) file in addition to
            the regular test  report  (-t).   This  option  is  incompatible  with  the  -i  (interval)  and  -n
            (repeat-count) options.

       -S   Forces (dedicated) TLS encryption when connecting to the server.

       -Tseconds
            Specifies a timeout for IPP requests in seconds.

       -Vversion
            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.

       -X   Specifies that XML (Apple plist) output is desired instead of the plain text report.  This option is
            incompatible with the -i (interval) and -n (repeat-count) options.

       -c   Specifies that CSV (comma-separated values) output is desired instead of the plain text output.

       -dname=value
            Defines the named variable.

       -ffilename
            Defines the default request filename for tests.

       -h   Validate HTTP response headers.

       -iseconds
            Specifies that the (last) testfile should be repeated at the specified  interval.   This  option  is
            incompatible with the -X (XML plist output) option.

       -l   Specifies that plain text output is desired.

       -nrepeat-count
            Specifies that the (last) testfile should be repeated the specified number of times.  This option is
            incompatible with the -X (XML plist output) option.

       -q   Be quiet and produce no output.

       -t   Specifies that CUPS test report output is desired instead of the plain text output.

       -v   Specifies that all request and response attributes should be output in CUPS test mode (-t).  This is
            the default for XML output.

See Also

ipptoolfile(5),  IANA  IPP  Registry  (http://www.iana.org/assignments/ipp-registrations),  PWG  Internet
       Printing Protocol Workgroup (http://www.pwg.org/ipp) RFC 8011 (http://tools.ietf.org/html/rfc8011),

Synopsis

ipptool  [ --help ] [ --ippserverfilename ] [ --stop-after-include-error ] [ --version ] [ -4 ] [ -6 ] [
       -C ] [ -E ] [ -I ] [ -L ] [ -Pfilename.plist ] [ -S ] [ -Tseconds ] [ -Vversion ] [ -X ] [ -c ]  [  -dname=value  ]  [ -ffilename ] [ -h ] [ -iseconds ] [ -nrepeat-count ] [ -q ] [ -t ] [ -v]printer-uritestfile [ ...  testfile ]

See Also