]> git.ipfire.org Git - thirdparty/cups.git/blob - man/ipptest.man
Merge changes from CUPS 1.5svn-r9000.
[thirdparty/cups.git] / man / ipptest.man
1 .\"
2 .\" "$Id$"
3 .\"
4 .\" ipptest 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 ipptest 1 "CUPS" "15 February 2010" "Apple Inc."
15 .SH NAME
16 ipptest - perform internet printing protocol tests
17 .SH SYNOPSIS
18 .B ipptest
19 [ -E ] [ -V
20 .I version
21 ] [ -X ] [ -c ] [ -d
22 .I name=value
23 ] [ -f
24 .I filename
25 ] [ -i
26 .I seconds
27 ] [ -l ] [ -v ]
28 .I URI
29 .I filename.test
30 [
31 .I ... filenameN.test
32 ]
33 .SH DESCRIPTION
34 \fIipptest\fR sends IPP requests to the specified URI and tests the results.
35 Each test file contains one or more test requests, including the expected
36 response status, attributes, and values. Output is either a plain text or XML
37 report on the standard output, with a non-zero exit status indicating that one
38 or more tests have failed. The test file format is described in
39 \fIipp.test(5)\fR.
40 .SH OPTIONS
41 The following options are recognized by \fIipptest\fR:
42 .TP 5
43 -E
44 Forces encryption when connecting to the server.
45 .TP 5
46 -V version
47 Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not
48 specified, version 1.1 is used.
49 .TP 5
50 -X
51 Specifies that XML (Apple plist) output is desired instead of the plain text
52 report. This option is incompatible with the \fI-i\fR (interval) option.
53 .TP 5
54 -c
55 Specifies that requests should be sent using the HTTP/1.1 "Transfer-Encoding:
56 chunked" header, which is required for conformance by all versions of IPP. The
57 default is to use "Transfer-Encoding: chunked" for requests with attached files
58 and "Content-Length:" for requests without attached files.
59 .TP 5
60 -d name=value
61 Defines the named variable.
62 .TP 5
63 -f filename
64 Defines the default request filename for tests.
65 .TP 5
66 -i seconds
67 Specifies that the (last) test should be repeated at the specified interval.
68 This option is incompatible with the \fI-X\fR (XML output) option.
69 .TP 5
70 -l
71 Specifies that requests should be sent using the HTTP/1.0 "Content-Length:"
72 header, which is required for conformance by all versions of IPP. The
73 default is to use "Transfer-Encoding: chunked" for requests with attached files
74 and "Content-Length:" for requests without attached files.
75 .TP 5
76 -v
77 Specifies that all request and response attributes should be output. This is the
78 default for XML output.
79 .SH COMPATIBILITY
80 The \fIipptest\fR program is unique to CUPS.
81 .SH SEE ALSO
82 \fIipp.test(5)\fR,
83 .br
84 http://localhost:631/help
85 .SH COPYRIGHT
86 Copyright 2007-2010 by Apple Inc.
87 .\"
88 .\" End of "$Id$".
89 .\"