]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-ipptool.html
Initial work on man page modernization (STR #4372)
[thirdparty/cups.git] / doc / help / man-ipptool.html
index 2812b9010e39453c4061430e96ec14ac2940f365..1bafb48321a5970597266e670d063aaa35950022 100644 (file)
@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML>
 <html>
 <!-- SECTION: Man Pages -->
 <head>
 <h2 class="title"><a name="NAME">Name</a></h2>
 ipptool - perform internet printing protocol requests
 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
-<b>ipptool
-</b>[ --help ] [ --stop-after-include-error ] [ --version ]
+<b>ipptool</b>
+[ --help ] [ --stop-after-include-error ] [ --version ]
 [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -S ] [ -T
-<i>seconds
-</i>] [ -V
-<i>version
-</i>] [ -X ] [ -c ] [ -d
-<i>name=value
-</i>] [ -f
-<i>filename
-</i>] [ -i
-<i>seconds
-</i>] [ -n
-<i>repeat-count
-</i>] [ -q ] [ -t ] [ -v ]
-<i>URI
-</i><i>filename
-</i>[
-<i>... filenameN
-</i>]
+<i>seconds</i>
+] [ -V
+<i>version</i>
+] [ -X ] [ -c ] [ -d
+<i>name=value</i>
+] [ -f
+<i>filename</i>
+] [ -i
+<i>seconds</i>
+] [ -n
+<i>repeat-count</i>
+] [ -q ] [ -t ] [ -v ]
+<i>URI</i>
+<i>filename</i>
+[
+<i>...</i> <i>filenameN</i>
+]
 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-<i>ipptool</i> 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 <a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>.
+<i>ipptool</i> 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 <i>ipptoolfile(5)</i>.
 <h2 class="title"><a name="OPTIONS">Options</a></h2>
 The following options are recognized by <i>ipptool</i>:
-<dl>
-<dt>--help
-</dt>
-<dd>Shows program help.
-</dd>
-<dt>--stop-after-include-error
-</dt>
-<dd>Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
-</dd>
-<dt>--version
-</dt>
-<dd>Shows the version of <i>ipptool</i> being used.
-</dd>
-<dt>-4
-</dt>
-<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
-</dd>
-<dt>-6
-</dt>
-<dd>Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
-</dd>
-<dt>-C
-</dt>
-<dd>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.
-</dd>
-<dt>-E
-</dt>
-<dd>Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
-</dd>
-<dt>-I
-</dt>
-<dd>Specifies that <i>ipptool</i> will continue past errors.
-</dd>
-<dt>-L
-</dt>
-<dd>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.
-</dd>
-<dt>-S
-</dt>
-<dd>Forces (dedicated) SSL encryption when connecting to the server.
-</dd>
-<dt>-T seconds
-</dt>
-<dd>Specifies a timeout for IPP requests in seconds.
-</dd>
-<dt>-V version
-</dt>
-<dd>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.
-</dd>
-<dt>-X
-</dt>
-<dd>Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
-</dd>
-<dt>-c
-</dt>
-<dd>Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
-</dd>
-<dt>-d name=value
-</dt>
-<dd>Defines the named variable.
-</dd>
-<dt>-f filename
-</dt>
-<dd>Defines the default request filename for tests.
-</dd>
-<dt>-i seconds
-</dt>
-<dd>Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the <i>-X</i> (XML plist output) option.
-</dd>
-<dt>-l
-</dt>
-<dd>Specifies that plain text output is desired.
-</dd>
-<dt>-n repeat-count
-</dt>
-<dd>Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
-</dd>
-<dt>-t
-</dt>
-<dd>Specifies that CUPS test report output is desired instead of the plain text output.
-</dd>
-<dt>-v
-</dt>
-<dd>Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
-</dd>
-</dl>
+<p style="margin-left: 5.0em; text-indent: -5.0em">--help
+<br>
+Shows program help.
+<p style="margin-left: 5.0em; text-indent: -5.0em">--stop-after-include-error
+<br>
+Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
+<p style="margin-left: 5.0em; text-indent: -5.0em">--version
+<br>
+Shows the version of <i>ipptool</i> being used.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-4
+<br>
+Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-6
+<br>
+Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-C
+<br>
+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.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-E
+<br>
+Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-I
+<br>
+Specifies that <i>ipptool</i> will continue past errors.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-L
+<br>
+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.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-S
+<br>
+Forces (dedicated) SSL encryption when connecting to the server.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-T seconds
+<br>
+Specifies a timeout for IPP requests in seconds.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-V version
+<br>
+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.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-X
+<br>
+Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-c
+<br>
+Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-d name=value
+<br>
+Defines the named variable.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-f filename
+<br>
+Defines the default request filename for tests.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-i seconds
+<br>
+Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the <i>-X</i> (XML plist output) option.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-l
+<br>
+Specifies that plain text output is desired.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-n repeat-count
+<br>
+Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-t
+<br>
+Specifies that CUPS test report output is desired instead of the plain text output.
+<p style="margin-left: 5.0em; text-indent: -5.0em">-v
+<br>
+Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
 <h2 class="title"><a name="EXIT_CODE">Exit Code</a></h2>
 The <i>ipptool</i> program returns 0 if all tests were sucessful and 1 otherwise.
 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
@@ -172,13 +149,13 @@ The following standard files are available:
     validate-job.test
 </pre>
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<a href='man-ipptoolfile.html?TOPIC=Man+Pages'>ipptoolfile(5)</a>, RFC 2911,
+<i>ipptoolfile(5)</i>, RFC 2911,
 <br>
-<a href='http://localhost:631/help'>http://localhost:631/help</a>
+<a href="http://localhost:631/help">http://localhost:631/help</a>
 <br>
-<a href='http://www.iana.org/assignments/ipp-registrations'>http://www.iana.org/assignments/ipp-registrations</a>
+<a href="http://www.iana.org/assignments/ipp-registrations">http://www.iana.org/assignments/ipp-registrations</a>
 <br>
-<a href='http://www.pwg.org/ipp'>http://www.pwg.org/ipp</a>
+<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 Copyright 2007-2014 by Apple Inc.