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