[thirdparty/cups.git] / doc / help / man-cupstestppd.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cupstestppd(1)</title>
</head>
<body>
<h1 class="title">cupstestppd(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cupstestppd - test conformance of ppd files
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>cupstestppd</b>
[
<b>-I</b>
<i>category</i>
] [
<b>-R</b>
<i>rootdir</i>
] [
<b>-W</b>
<i>category</i>
] [
<b>-q</b>
] [
<b>-r</b>
] [
<b>-v</b>[<b>v</b>]
]
<i>filename.ppd[.gz]</i>
[ ...
<i>filename.ppd[.gz]</i>
]
<br>
<b>cupstestppd</b>
[
<b>-R</b>
<i>rootdir</i>
] [
<b>-W</b>
<i>category</i>
] [
<b>-q</b>
] [
<b>-r</b>
] [
<b>-v</b>[<b>v</b>]
]
<b>-</b>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>cupstestppd</b> tests the conformance of PPD files to the Adobe PostScript Printer Description file format specification version 4.3.
It can also be used to list the supported options and available fonts in a PPD file.
The results of testing and any other output are sent to the standard output.
<p>The first form of <b>cupstestppd</b> tests one or more PPD files on the command-line.
The second form tests the PPD file provided on the standard input.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<b>cupstestppd</b> supports the following options:
<dl class="man">
<dt><b>-I filename</b>
<dd style="margin-left: 5.0em">Ignores all PCFileName warnings.
<dt><b>-I filters</b>
<dd style="margin-left: 5.0em">Ignores all filter errors.
<dt><b>-I profiles</b>
<dd style="margin-left: 5.0em">Ignores all profile errors.
<dt><b>-R </b><i>rootdir</i>
<dd style="margin-left: 5.0em">Specifies an alternate root directory for the filter, pre-filter, and other support file checks.
<dt><b>-W constraints</b>
<dd style="margin-left: 5.0em">Report all UIConstraint errors as warnings.
<dt><b>-W defaults</b>
<dd style="margin-left: 5.0em">Except for size-related options, report all default option errors as warnings.
<dt><b>-W filters</b>
<dd style="margin-left: 5.0em">Report all filter errors as warnings.
<dt><b>-W profiles</b>
<dd style="margin-left: 5.0em">Report all profile errors as warnings.
<dt><b>-W sizes</b>
<dd style="margin-left: 5.0em">Report all media size errors as warnings.
<dt><b>-W translations</b>
<dd style="margin-left: 5.0em">Report all translation errors as warnings.
<dt><b>-W all</b>
<dd style="margin-left: 5.0em">Report all of the previous errors as warnings.
<dt><b>-W none</b>
<dd style="margin-left: 5.0em">Report all of the previous errors as errors.
<dt><b>-q</b>
<dd style="margin-left: 5.0em">Specifies that no information should be displayed.
<dt><b>-r</b>
<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.
<dt><b>-v</b>
<dd style="margin-left: 5.0em">Specifies that detailed conformance testing results should be displayed rather than the concise PASS/FAIL/ERROR status.
<dt><b>-vv</b>
<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.
</dl>
<p>The <i>-q</i>, <i>-v</i>, and <i>-vv</i> options are mutually exclusive.
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
<b>cupstestppd</b> returns zero on success and non-zero on error.
The error codes are as follows:
<dl class="man">
<dt>1
<dd style="margin-left: 5.0em">Bad command-line arguments or missing PPD filename.
<dt>2
<dd style="margin-left: 5.0em">Unable to open or read PPD file.
<dt>3
<dd style="margin-left: 5.0em">The PPD file contains format errors that cannot be skipped.
<dt>4
<dd style="margin-left: 5.0em">The PPD file does not conform to the Adobe PPD specification.
</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
The following command will test all PPD files under the current directory and print the names of each file that does not conform:
<pre class="man">

    find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print

</pre>
The next command tests all PPD files under the current directory and print detailed conformance testing results for the files that do not conform:
<pre class="man">

    find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
        -exec cupstestppd -v '{}' \;
</pre>
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
<b>ippeveprinter</b>(1).
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>lpadmin</b>(8),
CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
Adobe PostScript Printer Description File Format Specification, Version 4.3.
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2019 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	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>
c277f98c	13	<b>cupstestppd</b>
bf1bc4c6 MS	14	[
bf1bc4c6 MS	15	<b>-I</b>
c277f98c	16	<i>category</i>
bf1bc4c6 MS	17	] [
bf1bc4c6 MS	18	<b>-R</b>
c277f98c	19	<i>rootdir</i>
bf1bc4c6 MS	20	] [
bf1bc4c6 MS	21	<b>-W</b>
c277f98c	22	<i>category</i>
bf1bc4c6 MS	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	]
c277f98c MS	34	<br>
c277f98c MS	35	<b>cupstestppd</b>
bf1bc4c6 MS	36	[
bf1bc4c6 MS	37	<b>-R</b>
c277f98c	38	<i>rootdir</i>
bf1bc4c6 MS	39	] [
bf1bc4c6 MS	40	<b>-W</b>
c277f98c	41	<i>category</i>
bf1bc4c6 MS	42	] [
	43	<b>-q</b>
	44	] [
	45	<b>-r</b>
	46	] [
	47	<b>-v</b>[<b>v</b>]
	48	]
	49	<b>-</b>
94436c5a	50	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
bf1bc4c6 MS	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.
94436c5a	56	<h2 class="title"><a name="OPTIONS">Options</a></h2>
bf1bc4c6	57	<b>cupstestppd</b> supports the following options:
2909c66c	58	<dl class="man">
bf1bc4c6 MS	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.
2909c66c	91	</dl>
94436c5a MS	92	<p>The <i>-q</i>, <i>-v</i>, and <i>-vv</i> options are mutually exclusive.
94436c5a MS	93	<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
bf1bc4c6 MS	94	<b>cupstestppd</b> returns zero on success and non-zero on error.
bf1bc4c6 MS	95	The error codes are as follows:
2909c66c MS	96	<dl class="man">
2909c66c MS	97	<dt>1
bf1bc4c6	98	<dd style="margin-left: 5.0em">Bad command-line arguments or missing PPD filename.
2909c66c	99	<dt>2
bf1bc4c6	100	<dd style="margin-left: 5.0em">Unable to open or read PPD file.
2909c66c	101	<dt>3
bf1bc4c6	102	<dd style="margin-left: 5.0em">The PPD file contains format errors that cannot be skipped.
2909c66c	103	<dt>4
bf1bc4c6	104	<dd style="margin-left: 5.0em">The PPD file does not conform to the Adobe PPD specification.
2909c66c	105	</dl>
94436c5a	106	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
bf1bc4c6	107	The following command will test all PPD files under the current directory and print the names of each file that does not conform:
2909c66c	108	<pre class="man">
94436c5a MS	109
	110	find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print
	111
	112	</pre>
bf1bc4c6	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:
2909c66c	114	<pre class="man">
94436c5a MS	115
	116	find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
	117	-exec cupstestppd -v '{}' \;
94436c5a	118	</pre>
87030afb MS	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).
94436c5a	123	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb	124	<b>lpadmin</b>(8),
bf1bc4c6	125	CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
94436c5a MS	126	Adobe PostScript Printer Description File Format Specification, Version 4.3.
94436c5a MS	127	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb	128	Copyright © 2007-2019 by Apple Inc.
94436c5a MS	129
	130	</body>
	131	</html>