Home Explore Blog CI



man-pages

1st chunk of `ipptool.man`
4e0418b9e9f7a7237dc015ebe800841095b0a824e8f26f900000000100000d0a
ipptool(1)                        OpenPrinting                       ipptool(1)

NAME
       ipptool - perform internet printing protocol requests

SYNOPSIS
       ipptool [ --help ] [ --ippserver filename ] [ --stop-after-include-error
       ]  [  --version  ]  [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -P file‐
       name.plist ] [ -S ] [ -T seconds ] [ -V version ] [ -X ] [  -c  ]  [  -d
       name=value  ]  [ -f filename ] [ -h ] [ -i seconds ] [ -j ] [ -n repeat‐
       count ] [ -q ] [ -t ] [ -v ] printer‐uri testfile [ ...  testfile ]

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 stan‐
       dard output, with a non‐zero exit status indicating  that  one  or  more
       tests have failed.  The testfile format is described in ipptoolfile(5).

OPTIONS
       The following options are recognized by ipptool:

       --help
            Shows program help.

       --ippserver filename
            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.  Nor‐
            mally 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 "Trans‐
            fer-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  "Con‐
            tent-Length:" header, which is required for conformance by all ver‐
            sions  of  IPP.  The default is to use "Transfer-Encoding: chunked"
            for requests with attached files and "Content-Length:" for requests
            without attached files.

       -P filename.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  (re‐
            peat-count) options.

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

       -T seconds
            Specifies a timeout for IPP requests in seconds.

       -V version
            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

Title: ipptool - Perform Internet Printing Protocol Requests
Summary
This document describes the `ipptool` command-line utility, which is used to send IPP (Internet Printing Protocol) requests to a specified printer URI and test/display the results. It details the syntax, options, and functionality of the tool, including how to define requests using testfiles, handle errors, and generate reports in various formats. The tool supports different HTTP headers and IPP versions, and can be used to test IPP conformance.