]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cupstestppd.man
Add header validation option to ipptool.
[thirdparty/cups.git] / man / cupstestppd.man
1 .\"
2 .\" cupstestppd man page for CUPS.
3 .\"
4 .\" Copyright 2007-2014 by Apple Inc.
5 .\" Copyright 1997-2006 by Easy Software Products.
6 .\"
7 .\" These coded instructions, statements, and computer programs are the
8 .\" property of Apple Inc. and are protected by Federal copyright
9 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 .\" which should have been included with this file. If this file is
11 .\" file is missing or damaged, see the license at "http://www.cups.org/".
12 .\"
13 .TH cupstestppd 1 "CUPS" "11 June 2014" "Apple Inc."
14 .SH NAME
15 cupstestppd \- test conformance of ppd files
16 .SH SYNOPSIS
17 .B cupstestppd
18 [
19 .B \-I
20 .I category
21 ] [
22 .B \-R
23 .I rootdir
24 ] [
25 .B \-W
26 .I category
27 ] [
28 .B \-q
29 ] [
30 .B \-r
31 ] [
32 \fB\-v\fR[\fBv\fR]
33 ]
34 .I filename.ppd[.gz]
35 [ ...
36 .I filename.ppd[.gz]
37 ]
38 .br
39 .B cupstestppd
40 [
41 .B \-R
42 .I rootdir
43 ] [
44 .B \-W
45 .I category
46 ] [
47 .B \-q
48 ] [
49 .B \-r
50 ] [
51 \fB\-v\fR[\fBv\fR]
52 ]
53 .B \-
54 .SH DESCRIPTION
55 \fBcupstestppd\fR tests the conformance of PPD files to the Adobe PostScript Printer Description file format specification version 4.3.
56 It can also be used to list the supported options and available fonts in a PPD file.
57 The results of testing and any other output are sent to the standard output.
58 .LP
59 The first form of \fBcupstestppd\fR tests one or more PPD files on the command-line.
60 The second form tests the PPD file provided on the standard input.
61 .SH OPTIONS
62 \fBcupstestppd\fR supports the following options:
63 .TP 5
64 \fB\-I filename\fR
65 Ignores all PCFileName warnings.
66 .TP 5
67 \fB\-I filters\fR
68 Ignores all filter errors.
69 .TP 5
70 \fB\-I profiles\fR
71 Ignores all profile errors.
72 .TP 5
73 \fB\-R \fIrootdir\fR
74 Specifies an alternate root directory for the filter, pre-filter, and other support file checks.
75 .TP 5
76 \fB\-W constraints\fR
77 Report all UIConstraint errors as warnings.
78 .TP 5
79 \fB\-W defaults\fR
80 Except for size-related options, report all default option errors as warnings.
81 .TP 5
82 \fB\-W filters\fR
83 Report all filter errors as warnings.
84 .TP 5
85 \fB\-W profiles\fR
86 Report all profile errors as warnings.
87 .TP 5
88 \fB\-W sizes\fR
89 Report all media size errors as warnings.
90 .TP 5
91 \fB\-W translations\fR
92 Report all translation errors as warnings.
93 .TP 5
94 \fB\-W all\fR
95 Report all of the previous errors as warnings.
96 .TP 5
97 \fB\-W none\fR
98 Report all of the previous errors as errors.
99 .TP 5
100 .B \-q
101 Specifies that no information should be displayed.
102 .TP 5
103 .B \-r
104 Relaxes the PPD conformance requirements so that common whitespace, control character, and formatting problems are not treated as hard errors.
105 .TP 5
106 .B \-v
107 Specifies that detailed conformance testing results should be displayed rather than the concise PASS/FAIL/ERROR status.
108 .TP 5
109 .B \-vv
110 Specifies that all information in the PPD file should be displayed in addition to the detailed conformance testing results.
111 .LP
112 The \fI-q\fR, \fI-v\fR, and \fI-vv\fR options are mutually exclusive.
113 .SH EXIT STATUS
114 \fBcupstestppd\fR returns zero on success and non-zero on error.
115 The error codes are as follows:
116 .TP 5
117 1
118 Bad command-line arguments or missing PPD filename.
119 .TP 5
120 2
121 Unable to open or read PPD file.
122 .TP 5
123 3
124 The PPD file contains format errors that cannot be skipped.
125 .TP 5
126 4
127 The PPD file does not conform to the Adobe PPD specification.
128 .SH EXAMPLES
129 The following command will test all PPD files under the current directory and print the names of each file that does not conform:
130 .nf
131
132 find . \-name \\*.ppd \\! \-exec cupstestppd \-q '{}' \\; \-print
133
134 .fi
135 The next command tests all PPD files under the current directory and print detailed conformance testing results for the files that do not conform:
136 .nf
137
138 find . \-name \\*.ppd \\! \-exec cupstestppd \-q '{}' \\; \\
139 \-exec cupstestppd \-v '{}' \\;
140 .fi
141 .SH SEE ALSO
142 .BR lpadmin (8),
143 CUPS Online Help (http://localhost:631/help),
144 Adobe PostScript Printer Description File Format Specification, Version 4.3.
145 .SH COPYRIGHT
146 Copyright \[co] 2007-2017 by Apple Inc.