[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>
[ -I
<i>category</i>
] [ -R
<i>rootdir</i>
] [ -W
<i>category</i>
] [ -q ] [-r] [ -v[v] ] filename.ppd[.gz] [ ... filenameN.ppd[.gz] ]
<br>
<b>cupstestppd</b>
[ -R
<i>rootdir</i>
] [ -W
<i>category</i>
] [ -q ] [-r] [ -v[v] ] -
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>cupstestppd</i> 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 <i>cupstestppd</i> 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>
<i>cupstestppd</i> supports the following options:
<p style="margin-left: 5.0em; text-indent: -5.0em">-I filename
<br>
<br>
Ignores all PCFileName warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-I filters
<br>
<br>
Ignores all filter errors.
<p style="margin-left: 5.0em; text-indent: -5.0em">-I profiles
<br>
<br>
Ignores all profile errors.
<p style="margin-left: 5.0em; text-indent: -5.0em">-R rootdir
<br>
<br>
Specifies an alternate root directory for the filter, pre-filter,
and other support file checks.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W constraints
<br>
<br>
Report all UIConstraint errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W defaults
<br>
<br>
Except for size-related options, report all default option errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W filters
<br>
<br>
Report all filter errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W profiles
<br>
<br>
Report all profile errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W sizes
<br>
<br>
Report all media size errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W translations
<br>
<br>
Report all translation errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W all
<br>
<br>
Report all of the previous errors as warnings.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W none
<br>
<br>
Report all of the previous errors as errors.
<p style="margin-left: 5.0em; text-indent: -5.0em">-q
<br>
<br>
Specifies that no information should be displayed.
<p style="margin-left: 5.0em; text-indent: -5.0em">-r
<br>
<br>
Relaxes the PPD conformance requirements so that common
whitespace, control character, and formatting problems are not
treated as hard errors.
<p style="margin-left: 5.0em; text-indent: -5.0em">-v
<br>
<br>
Specifies that detailed conformance testing results should be
displayed rather than the concise PASS/FAIL/ERROR status.
<p style="margin-left: 5.0em; text-indent: -5.0em">-vv
<br>
<br>
Specifies that all information in the PPD file should be
displayed in addition to the detailed conformance testing
results.
<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>
<i>cupstestppd</i> returns zero on success and non-zero on error. The
error codes are as follows:
<p style="margin-left: 5.0em; text-indent: -5.0em">1
<br>
<br>
Bad command-line arguments or missing PPD filename.
<p style="margin-left: 5.0em; text-indent: -5.0em">2
<br>
<br>
Unable to open or read PPD file.
<p style="margin-left: 5.0em; text-indent: -5.0em">3
<br>
<br>
The PPD file contains format errors that cannot be skipped.
<p style="margin-left: 5.0em; text-indent: -5.0em">4
<br>
<br>
The PPD file does not conform to the Adobe PPD specification.
<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>

    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>

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

</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>lpadmin(8)</i>,
<br>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<br>
Adobe PostScript Printer Description File Format Specification, Version 4.3.
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2013 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 MS	13	<b>cupstestppd</b>
	14	[ -I
	15	<i>category</i>
	16	] [ -R
	17	<i>rootdir</i>
	18	] [ -W
	19	<i>category</i>
	20	] [ -q ] [-r] [ -v[v] ] filename.ppd[.gz] [ ... filenameN.ppd[.gz] ]
	21	<br>
	22	<b>cupstestppd</b>
	23	[ -R
	24	<i>rootdir</i>
	25	] [ -W
	26	<i>category</i>
	27	] [ -q ] [-r] [ -v[v] ] -
94436c5a MS	28	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
	29	<i>cupstestppd</i> tests the conformance of PPD files to the
	30	Adobe PostScript Printer Description file format specification
	31	version 4.3. It can also be used to list the supported options
	32	and available fonts in a PPD file. The results of testing and
	33	any other output are sent to the standard output.
	34	<p>The first form of <i>cupstestppd</i> tests one or more PPD files
	35	on the command-line. The second form tests the PPD file provided
	36	on the standard input.
	37	<h2 class="title"><a name="OPTIONS">Options</a></h2>
	38	<i>cupstestppd</i> supports the following options:
c277f98c MS	39	<p style="margin-left: 5.0em; text-indent: -5.0em">-I filename
	40	<br>
	41	<br>
	42	Ignores all PCFileName warnings.
	43	<p style="margin-left: 5.0em; text-indent: -5.0em">-I filters
	44	<br>
	45	<br>
	46	Ignores all filter errors.
	47	<p style="margin-left: 5.0em; text-indent: -5.0em">-I profiles
	48	<br>
	49	<br>
	50	Ignores all profile errors.
	51	<p style="margin-left: 5.0em; text-indent: -5.0em">-R rootdir
	52	<br>
	53	<br>
	54	Specifies an alternate root directory for the filter, pre-filter,
94436c5a	55	and other support file checks.
c277f98c MS	56	<p style="margin-left: 5.0em; text-indent: -5.0em">-W constraints
	57	<br>
	58	<br>
	59	Report all UIConstraint errors as warnings.
	60	<p style="margin-left: 5.0em; text-indent: -5.0em">-W defaults
	61	<br>
	62	<br>
	63	Except for size-related options, report all default option errors as warnings.
	64	<p style="margin-left: 5.0em; text-indent: -5.0em">-W filters
	65	<br>
	66	<br>
	67	Report all filter errors as warnings.
	68	<p style="margin-left: 5.0em; text-indent: -5.0em">-W profiles
	69	<br>
	70	<br>
	71	Report all profile errors as warnings.
	72	<p style="margin-left: 5.0em; text-indent: -5.0em">-W sizes
	73	<br>
	74	<br>
	75	Report all media size errors as warnings.
	76	<p style="margin-left: 5.0em; text-indent: -5.0em">-W translations
	77	<br>
	78	<br>
	79	Report all translation errors as warnings.
	80	<p style="margin-left: 5.0em; text-indent: -5.0em">-W all
	81	<br>
	82	<br>
	83	Report all of the previous errors as warnings.
	84	<p style="margin-left: 5.0em; text-indent: -5.0em">-W none
	85	<br>
	86	<br>
	87	Report all of the previous errors as errors.
	88	<p style="margin-left: 5.0em; text-indent: -5.0em">-q
	89	<br>
	90	<br>
	91	Specifies that no information should be displayed.
	92	<p style="margin-left: 5.0em; text-indent: -5.0em">-r
	93	<br>
	94	<br>
	95	Relaxes the PPD conformance requirements so that common
94436c5a MS	96	whitespace, control character, and formatting problems are not
94436c5a MS	97	treated as hard errors.
c277f98c MS	98	<p style="margin-left: 5.0em; text-indent: -5.0em">-v
	99	<br>
	100	<br>
	101	Specifies that detailed conformance testing results should be
94436c5a	102	displayed rather than the concise PASS/FAIL/ERROR status.
c277f98c MS	103	<p style="margin-left: 5.0em; text-indent: -5.0em">-vv
	104	<br>
	105	<br>
	106	Specifies that all information in the PPD file should be
94436c5a MS	107	displayed in addition to the detailed conformance testing
94436c5a MS	108	results.
94436c5a MS	109	<p>The <i>-q</i>, <i>-v</i>, and <i>-vv</i> options are mutually exclusive.
	110	<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
	111	<i>cupstestppd</i> returns zero on success and non-zero on error. The
	112	error codes are as follows:
c277f98c MS	113	<p style="margin-left: 5.0em; text-indent: -5.0em">1
	114	<br>
	115	<br>
	116	Bad command-line arguments or missing PPD filename.
	117	<p style="margin-left: 5.0em; text-indent: -5.0em">2
	118	<br>
	119	<br>
	120	Unable to open or read PPD file.
	121	<p style="margin-left: 5.0em; text-indent: -5.0em">3
	122	<br>
	123	<br>
	124	The PPD file contains format errors that cannot be skipped.
	125	<p style="margin-left: 5.0em; text-indent: -5.0em">4
	126	<br>
	127	<br>
	128	The PPD file does not conform to the Adobe PPD specification.
94436c5a MS	129	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
	130	The following command will test all PPD files under the current
	131	directory and print the names of each file that does not
	132	conform:
	133	<pre>
	134
	135	find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print
	136
	137	</pre>
	138	The next command tests all PPD files under the current directory
	139	and print detailed conformance testing results for the files
	140	that do not conform:
	141	<pre>
	142
	143	find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
	144	-exec cupstestppd -v '{}' \;
	145
	146	</pre>
	147	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c	148	<i>lpadmin(8)</i>,
94436c5a	149	<br>
c277f98c	150	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a MS	151	<br>
	152	Adobe PostScript Printer Description File Format Specification, Version 4.3.
	153	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	154	Copyright 2007-2013 by Apple Inc.
	155
	156	</body>
	157	</html>