]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - man/ipptool.man
Fix man page typos.
[thirdparty/cups.git] / man / ipptool.man
index bcd276f084706d041d114a9fe20710996607bf48..3e9afe889d5a18a4ab1e196ad642112518157e02 100644 (file)
@@ -1,17 +1,11 @@
 .\"
-.\" "$Id$"
+.\" ipptool man page.
 .\"
-.\" ipptool man page for CUPS.
+.\" Copyright 2010-2017 by Apple Inc.
 .\"
-.\" Copyright 2010-2014 by Apple Inc.
+.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
 .\"
-.\" These coded instructions, statements, and computer programs are the
-.\" property of Apple Inc. and are protected by Federal copyright
-.\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
-.\" 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" "9 April 2014" "Apple Inc."
+.TH ipptool 1 "CUPS" "1 November 2017" "Apple Inc."
 .SH NAME
 ipptool \- perform internet printing protocol requests
 .SH SYNOPSIS
@@ -19,6 +13,9 @@ ipptool \- perform internet printing protocol requests
 [
 .B \-\-help
 ] [
+.B \-\-ippserver
+.I filename
+] [
 .B \-\-stop\-after\-include\-error
 ] [
 .B \-\-version
@@ -35,6 +32,9 @@ ipptool \- perform internet printing protocol requests
 ] [
 .B \-L
 ] [
+.B \-P
+.I filename.plist
+] [
 .B \-S
 ] [
 .B \-T
@@ -53,6 +53,8 @@ ipptool \- perform internet printing protocol requests
 .B \-f
 .I filename
 ] [
+.B \-h
+] [
 .B \-i
 .I seconds
 ] [
@@ -73,9 +75,12 @@ ipptool \- perform internet printing protocol requests
 .B ipptool
 sends IPP requests to the specified
 .I printer-uri
-and tests and/or displays the results. Each named
+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
+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).
@@ -86,6 +91,11 @@ The following options are recognized by
 .B \-\-help
 Shows program help.
 .TP 5
+\fB\-\-ippserver \fIfilename\fR
+Specifies that the test results should be written to the named
+.B ippserver
+attributes file.
+.TP 5
 .B \-\-stop-after-include-error
 Tells
 .B ipptool
@@ -109,7 +119,8 @@ Specifies that
 must connect to the printer or server using IPv6.
 .TP 5
 .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.
+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
 .B \-E
 Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
@@ -120,7 +131,12 @@ Specifies that
 will continue past errors.
 .TP 5
 .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.
+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
+.BI \-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 (\fB\-t\fR).
+This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options.
 .TP 5
 .B \-S
 Forces (dedicated) TLS encryption when connecting to the server.
@@ -132,7 +148,8 @@ Specifies a timeout for IPP requests in seconds.
 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
 .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.
+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
 .B \-c
 Specifies that CSV (comma\-separated values) output is desired instead of the plain text output.
@@ -143,10 +160,14 @@ Defines the named variable.
 .BI \-f \ filename
 Defines the default request filename for tests.
 .TP 5
+.B \-h
+Validate HTTP response headers.
+.TP 5
 .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.
+should be repeated at the specified interval.
+This option is incompatible with the \fB\-X\fR (XML plist output) option.
 .TP 5
 .B \-l
 Specifies that plain text output is desired.
@@ -154,17 +175,22 @@ Specifies that plain text output is desired.
 .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.
+should be repeated the specified number of times.
+This option is incompatible with the \fI\-X\fR (XML plist output) option.
+.TP 5
+.B \-q
+Be quiet and produce no output.
 .TP 5
 .B \-t
 Specifies that CUPS test report output is desired instead of the plain text output.
 .TP 5
 .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.
+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.
+program returns 0 if all tests were successful and 1 otherwise.
 .SH FILES
 The following standard files are available:
 .nf
@@ -218,12 +244,8 @@ Send email notifications to "user@example.com" when "myprinter" changes:
 .fi
 .SH SEE ALSO
 .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),
+RFC 8011 (http://tools.ietf.org/html/rfc8011),
 .SH COPYRIGHT
-Copyright \[co] 2007-2014 by Apple Inc.
-.\"
-.\" End of "$Id$".
-.\"
+Copyright \[co] 2007-2017 by Apple Inc.