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