diff options
Diffstat (limited to 'man/ipptool.man')
| -rw-r--r-- | man/ipptool.man | 271 |
1 files changed, 170 insertions, 101 deletions
diff --git a/man/ipptool.man b/man/ipptool.man index 5949d06f9..f88a0c1ad 100644 --- a/man/ipptool.man +++ b/man/ipptool.man @@ -1,5 +1,5 @@ .\" -.\" "$Id: ipptool.man 11642 2014-02-27 15:57:59Z msweet $" +.\" "$Id: ipptool.man 11880 2014-05-16 06:14:11Z msweet $" .\" .\" ipptool man page for CUPS. .\" @@ -11,156 +11,225 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH ipptool 1 "CUPS" "20 February 2014" "Apple Inc." +.TH ipptool 1 "CUPS" "15 May 2014" "Apple Inc." .SH NAME -ipptool - perform internet printing protocol requests +ipptool \- perform internet printing protocol requests .SH SYNOPSIS .B ipptool -[ --help ] [ --stop-after-include-error ] [ --version ] -[ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T +[ +.B \-\-help +] [ +.B \-\-stop\-after\-include\-error +] [ +.B \-\-version +] [ +.B \-4 +] [ +.B \-6 +] [ +.B \-C +] [ +.B \-E +] [ +.B \-I +] [ +.B \-L +] [ +.B \-P +.I filename.plist +] [ +.B \-S +] [ +.B \-T .I seconds -] [ -V +] [ +.B \-V .I version -] [ -X ] [ -c ] [ -d +] [ +.B \-X +] [ +.B \-c +] [ +.B \-d .I name=value -] [ -f +] [ +.B \-f .I filename -] [ -i +] [ +.B \-i .I seconds -] [ -n +] [ +.B \-n .I repeat-count -] [ -q ] [ -t ] [ -v ] -.I URI -.I filename -[ -.I ... filenameN +] [ +.B \-q +] [ +.B \-t +] [ +.B \-v ] +.I printer-uri +.I testfile +[ ... +.I testfile ] .SH DESCRIPTION -\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. +.B ipptool +sends IPP requests to the specified +.I printer-uri +and tests and/or displays the results. Each named +.I 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 +.I testfile +format is described in +.BR ipptoolfile (5). .SH OPTIONS -The following options are recognized by \fIipptool\fR: +The following options are recognized by +.B ipptool: .TP 5 ---help +.B \-\-help Shows program help. .TP 5 ---stop-after-include-error -Tells \fIipptool\fR to stop if an error occurs in an included file. Normally \fIipptool\fR will continue with subsequent tests after the INCLUDE directive. +.B \-\-stop-after-include-error +Tells +.B ipptool +to stop if an error occurs in an included file. Normally +.B ipptool +will continue with subsequent tests after the INCLUDE directive. .TP 5 ---version -Shows the version of \fIipptool\fR being used. +.B \-\-version +Shows the version of +.B ipptool +being used. .TP 5 --4 -Specifies that \fIipptool\fR must connect to the printer or server using IPv4. +.B \-4 +Specifies that +.B ipptool +must connect to the printer or server using IPv4. .TP 5 --6 -Specifies that \fIipptool\fR must connect to the printer or server using IPv6. +.B \-6 +Specifies that +.B ipptool +must connect to the printer or server using IPv6. .TP 5 --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. +.B \-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. .TP 5 --E +.B \-E Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. .TP 5 --I -Specifies that \fIipptool\fR will continue past errors. +.B \-I +Specifies that +.B ipptool +will continue past errors. .TP 5 --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. +.B \-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. .TP 5 --S -Forces (dedicated) SSL encryption when connecting to the server. +.BI \-P \ filename.plist +Specifies that the test results should be written to the named XML (Apple plist) file in addition to the plain text report. This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options. .TP 5 --T seconds +.B \-S +Forces (dedicated) TLS encryption when connecting to the server. +.TP 5 +.BI \-T \ seconds Specifies a timeout for IPP requests in seconds. .TP 5 --V version +.BI \-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. .TP 5 --X -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. +.B \-X +Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options. .TP 5 --c -Specifies that CSV (comma-separated values) output is desired instead of the plain text output. +.B \-c +Specifies that CSV (comma\-separated values) output is desired instead of the plain text output. .TP 5 --d name=value +.BI \-d \ name=value Defines the named variable. .TP 5 --f filename +.BI \-f \ filename Defines the default request filename for tests. .TP 5 --i seconds -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. +.BI \-i \ seconds +Specifies that the (last) +.I testfile +should be repeated at the specified interval. This option is incompatible with the \fB\-X\fR (XML plist output) option. .TP 5 --l +.B \-l Specifies that plain text output is desired. .TP 5 --n repeat-count -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. +.BI \-n \ repeat\-count +Specifies that the (last) +.I testfile +should be repeated the specified number of times. This option is incompatible with the \fI\-X\fR (XML plist output) option. .TP 5 --t +.B \-t Specifies that CUPS test report output is desired instead of the plain text output. .TP 5 --v -Specifies that all request and response attributes should be output in CUPS test mode (\fI-t\fR). This is the default for XML output. -.SH EXIT CODE -The \fIipptool\fR program returns 0 if all tests were sucessful and 1 otherwise. -.SH COMPATIBILITY -The \fIipptool\fR program is unique to CUPS. +.B \-v +Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR). This is the default for XML output. +.SH EXIT STATUS +The +.B ipptool +program returns 0 if all tests were sucessful and 1 otherwise. +.SH FILES +The following standard files are available: +.nf +.I color.jpg +.I create\-printer\-subscription.test +.I document\-a4.pdf +.I document\-a4.ps +.I document\-letter.pdf +.I document\-letter.ps +.I get\-completed\-jobs.test +.I get\-jobs.test +.I get\-notifications.test +.I get\-printer\-attributes.test +.I get\-subscriptions.test +.I gray.jpg +.I ipp\-1.1.test +.I ipp\-2.0.test +.I ipp\-2.1.test +.I ipp\-2.2.test +.I ipp\-everywhere.test +.I onepage\-a4.pdf +.I onepage\-a4.ps +.I onepage\-letter.pdf +.I onepage\-letter.ps +.I print\-job.test +.I print\-job\-deflate.test +.I print\-job\-gzip.test +.I testfile.jpg +.I testfile.pcl +.I testfile.pdf +.I testfile.ps +.I testfile.txt +.I validate\-job.test +.fi +.SH CONFORMING TO +The +.B ipptool +program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2. .SH EXAMPLES Get a list of completed jobs for "myprinter": .nf - ipptool ipp://localhost/printers/myprinter get-completed-jobs.test + + ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test .fi .LP Send email notifications to "user@example.com" when "myprinter" changes: .nf - ipptool -d recipient=mailto:user@example.com \ - ipp://localhost/printers/myprinter create-printer-subscription.test -.fi -.SH STANDARD FILES -The following standard files are available: -.nf - color.jpg - create-printer-subscription.test - document-a4.pdf - document-a4.ps - document-letter.pdf - document-letter.ps - get-completed-jobs.test - get-jobs.test - get-notifications.test - get-printer-attributes.test - get-subscriptions.test - gray.jpg - ipp-1.1.test - ipp-2.0.test - ipp-2.1.test - ipp-2.2.test - ipp-everywhere.test - onepage-a4.pdf - onepage-a4.ps - onepage-letter.pdf - onepage-letter.ps - print-job.test - print-job-deflate.test - print-job-gzip.test - testfile.jpg - testfile.pcl - testfile.pdf - testfile.ps - testfile.txt - validate-job.test + + ipptool \-d recipient=mailto:user@example.com \\ + ipp://localhost/printers/myprinter create\-printer\-subscription.test .fi .SH SEE ALSO -\fIipptoolfile(5)\fR, RFC 2911, -.br -http://localhost:631/help -.br -http://www.iana.org/assignments/ipp-registrations -.br -http://www.pwg.org/ipp +.BR ipptoolfile (5), +CUPS Online Help (http://localhost:631/help), +IANA IPP Registry (http://www.iana.org/assignments/ipp\-registrations), +PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp) +RFC 2911 (http://tools.ietf.org/html/rfc2911), .SH COPYRIGHT -Copyright 2007-2014 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" -.\" End of "$Id: ipptool.man 11642 2014-02-27 15:57:59Z msweet $". +.\" End of "$Id: ipptool.man 11880 2014-05-16 06:14:11Z msweet $". .\" |