Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cupstestppd.html
1 <!DOCTYPE HTML>
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6         <title>cupstestppd(1)</title>
7 </head>
8 <body>
9 <h1 class="title">cupstestppd(1)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 cupstestppd - test conformance of ppd files
12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
13 <b>cupstestppd</b>
14 [
15 <b>-I</b>
16 <i>category</i>
17 ] [
18 <b>-R</b>
19 <i>rootdir</i>
20 ] [
21 <b>-W</b>
22 <i>category</i>
23 ] [
24 <b>-q</b>
25 ] [
26 <b>-r</b>
27 ] [
28 <b>-v</b>[<b>v</b>]
29 ]
30 <i>filename.ppd[.gz]</i>
31 [ ...
32 <i>filename.ppd[.gz]</i>
33 ]
34 <br>
35 <b>cupstestppd</b>
36 [
37 <b>-R</b>
38 <i>rootdir</i>
39 ] [
40 <b>-W</b>
41 <i>category</i>
42 ] [
43 <b>-q</b>
44 ] [
45 <b>-r</b>
46 ] [
47 <b>-v</b>[<b>v</b>]
48 ]
49 <b>-</b>
50 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
51 <b>cupstestppd</b> tests the conformance of PPD files to the Adobe PostScript Printer Description file format specification version 4.3.
52 It can also be used to list the supported options and available fonts in a PPD file.
53 The results of testing and any other output are sent to the standard output.
54 <p>The first form of <b>cupstestppd</b> tests one or more PPD files on the command-line.
55 The second form tests the PPD file provided on the standard input.
56 <h2 class="title"><a name="OPTIONS">Options</a></h2>
57 <b>cupstestppd</b> supports the following options:
58 <dl class="man">
59 <dt><b>-I filename</b>
60 <dd style="margin-left: 5.0em">Ignores all PCFileName warnings.
61 <dt><b>-I filters</b>
62 <dd style="margin-left: 5.0em">Ignores all filter errors.
63 <dt><b>-I profiles</b>
64 <dd style="margin-left: 5.0em">Ignores all profile errors.
65 <dt><b>-R </b><i>rootdir</i>
66 <dd style="margin-left: 5.0em">Specifies an alternate root directory for the filter, pre-filter, and other support file checks.
67 <dt><b>-W constraints</b>
68 <dd style="margin-left: 5.0em">Report all UIConstraint errors as warnings.
69 <dt><b>-W defaults</b>
70 <dd style="margin-left: 5.0em">Except for size-related options, report all default option errors as warnings.
71 <dt><b>-W filters</b>
72 <dd style="margin-left: 5.0em">Report all filter errors as warnings.
73 <dt><b>-W profiles</b>
74 <dd style="margin-left: 5.0em">Report all profile errors as warnings.
75 <dt><b>-W sizes</b>
76 <dd style="margin-left: 5.0em">Report all media size errors as warnings.
77 <dt><b>-W translations</b>
78 <dd style="margin-left: 5.0em">Report all translation errors as warnings.
79 <dt><b>-W all</b>
80 <dd style="margin-left: 5.0em">Report all of the previous errors as warnings.
81 <dt><b>-W none</b>
82 <dd style="margin-left: 5.0em">Report all of the previous errors as errors.
83 <dt><b>-q</b>
84 <dd style="margin-left: 5.0em">Specifies that no information should be displayed.
85 <dt><b>-r</b>
86 <dd style="margin-left: 5.0em">Relaxes the PPD conformance requirements so that common whitespace, control character, and formatting problems are not treated as hard errors.
87 <dt><b>-v</b>
88 <dd style="margin-left: 5.0em">Specifies that detailed conformance testing results should be displayed rather than the concise PASS/FAIL/ERROR status.
89 <dt><b>-vv</b>
90 <dd style="margin-left: 5.0em">Specifies that all information in the PPD file should be displayed in addition to the detailed conformance testing results.
91 </dl>
92 <p>The <i>-q</i>, <i>-v</i>, and <i>-vv</i> options are mutually exclusive.
93 <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
94 <b>cupstestppd</b> returns zero on success and non-zero on error.
95 The error codes are as follows:
96 <dl class="man">
97 <dt>1
98 <dd style="margin-left: 5.0em">Bad command-line arguments or missing PPD filename.
99 <dt>2
100 <dd style="margin-left: 5.0em">Unable to open or read PPD file.
101 <dt>3
102 <dd style="margin-left: 5.0em">The PPD file contains format errors that cannot be skipped.
103 <dt>4
104 <dd style="margin-left: 5.0em">The PPD file does not conform to the Adobe PPD specification.
105 </dl>
106 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
107 The following command will test all PPD files under the current directory and print the names of each file that does not conform:
108 <pre class="man">
109
110     find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print
111
112 </pre>
113 The next command tests all PPD files under the current directory and print detailed conformance testing results for the files that do not conform:
114 <pre class="man">
115
116     find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
117         -exec cupstestppd -v '{}' \;
118 </pre>
119 <h2 class="title"><a name="NOTES">Notes</a></h2>
120 PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
121 Printers that do not support IPP can be supported using applications such as
122 <b>ippeveprinter</b>(1).
123 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
124 <b>lpadmin</b>(8),
125 CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
126 Adobe PostScript Printer Description File Format Specification, Version 4.3.
127 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
128 Copyright &copy; 2007-2019 by Apple Inc.
129
130 </body>
131 </html>