man/ipptool.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   ipptool man page for CUPS.
   5 .\"
   6 .\"   Copyright 2010 by Apple Inc.
   7 .\"
   8 .\"   These coded instructions, statements, and computer programs are the
   9 .\"   property of Apple Inc. and are protected by Federal copyright
  10 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  11 .\"   which should have been included with this file.  If this file is
  12 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
  13 .\"
  14 .TH ipptool 1 "CUPS" "2 August 2010" "Apple Inc."
  15 .SH NAME
  16 ipptool - perform internet printing protocol requests
  17 .SH SYNOPSIS
  18 .B ipptool
  19 [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -V
  20 .I version
  21 ] [ -X ] [ -c ] [ -d
  22 .I name=value
  23 ] [ -f
  24 .I filename
  25 ] [ -i
  26 .I seconds
  27 ] [ -n
  28 .I repeat-count
  29 ] [ -q ] [ -t ] [ -v ]
  30 .I URI
  31 .I filename
  32 [
  33 .I ... filenameN
  34 ]
  35 .SH DESCRIPTION
  36 \fIipptool\fR sends IPP requests to the specified URI and tests and/or displays the results. Each named file 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 file format is described in \fIipptoolfile(5)\fR.
  37 .SH OPTIONS
  38 The following options are recognized by \fIipptool\fR:
  39 .TP 5
  40 -C
  41 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.
  42 .TP 5
  43 -E
  44 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
  45 .TP 5
  46 -I
  47 Specifies that \fIipptool\fR will continue past errors.
  48 .TP 5
  49 -L
  50 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.
  51 .TP 5
  52 -S
  53 Forces (dedicated) SSL encryption when connecting to the server.
  54 .TP 5
  55 -V version
  56 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.
  57 .TP 5
  58 -X
  59 Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fI-i\fR (interval) and \fI-n\fR (repeat-count) options.
  60 .TP 5
  61 -c
  62 Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
  63 .TP 5
  64 -d name=value
  65 Defines the named variable.
  66 .TP 5
  67 -f filename
  68 Defines the default request filename for tests.
  69 .TP 5
  70 -i seconds
  71 Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the \fI-x\fR (XML plist output) option.
  72 .TP 5
  73 -l
  74 Specifies that plain text output is desired.
  75 .TP 5
  76 -n repeat-count
  77 Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the \fI-X\fR (XML plist output) option.
  78 .TP 5
  79 -t
  80 Specifies that CUPS test report output is desired instead of the plain text output.
  81 .TP 5
  82 -v
  83 Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output.
  84 .SH COMPATIBILITY
  85 The \fIipptool\fR program is unique to CUPS.
  86 .SH EXAMPLES
  87 Get a list of completed jobs for "myprinter":
  88 .nf
  89     ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
  90 .fi
  91 .LP
  92 Send email notifications to "user@example.com" when "myprinter" changes:
  93 .nf
  94     ipptool -d recipient=mailto:user@example.com \
  95         ipp://localhost/printers/myprinter create-printer-subscription.test
  96 .fi
  97 .SH STANDARD FILES
  98 The following standard files are available:
  99 .nf
 100     create-printer-subscription.test
 101     get-completed-jobs.test
 102     get-jobs.test
 103     ipp-1.1.test
 104     ipp-2.0.test
 105     ipp-2.1.test
 106     testfile.jpg
 107     testfile.pdf
 108     testfile.ps
 109     testfile.txt
 110 .fi
 111 .SH SEE ALSO
 112 \fIipptoolfile(5)\fR,
 113 .br
 114 http://localhost:631/help
 115 .SH COPYRIGHT
 116 Copyright 2007-2010 by Apple Inc.
 117 .\"
 118 .\" End of "$Id$".
 119 .\"