[thirdparty/cups.git] / man / cupstestppd.man

.\"
.\" cupstestppd man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 1997-2006 by Easy Software Products.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
.\"
.TH cupstestppd 1 "CUPS" "11 June 2014" "Apple Inc."
.SH NAME
cupstestppd \- test conformance of ppd files
.SH SYNOPSIS
.B cupstestppd
[
.B \-I
.I category
] [
.B \-R
.I rootdir
] [
.B \-W
.I category
] [
.B \-q
] [
.B \-r
] [
\fB\-v\fR[\fBv\fR]
]
.I filename.ppd[.gz]
[ ...
.I filename.ppd[.gz]
]
.br
.B cupstestppd
[
.B \-R
.I rootdir
] [
.B \-W
.I category
] [
.B \-q
] [
.B \-r
] [
\fB\-v\fR[\fBv\fR]
]
.B \-
.SH DESCRIPTION
\fBcupstestppd\fR 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.
.LP
The first form of \fBcupstestppd\fR tests one or more PPD files on the command-line.
The second form tests the PPD file provided on the standard input.
.SH OPTIONS
\fBcupstestppd\fR supports the following options:
.TP 5
\fB\-I filename\fR
Ignores all PCFileName warnings.
.TP 5
\fB\-I filters\fR
Ignores all filter errors.
.TP 5
\fB\-I profiles\fR
Ignores all profile errors.
.TP 5
\fB\-R \fIrootdir\fR
Specifies an alternate root directory for the filter, pre-filter, and other support file checks.
.TP 5
\fB\-W constraints\fR
Report all UIConstraint errors as warnings.
.TP 5
\fB\-W defaults\fR
Except for size-related options, report all default option errors as warnings.
.TP 5
\fB\-W filters\fR
Report all filter errors as warnings.
.TP 5
\fB\-W profiles\fR
Report all profile errors as warnings.
.TP 5
\fB\-W sizes\fR
Report all media size errors as warnings.
.TP 5
\fB\-W translations\fR
Report all translation errors as warnings.
.TP 5
\fB\-W all\fR
Report all of the previous errors as warnings.
.TP 5
\fB\-W none\fR
Report all of the previous errors as errors.
.TP 5
.B \-q
Specifies that no information should be displayed.
.TP 5
.B \-r
Relaxes the PPD conformance requirements so that common whitespace, control character, and formatting problems are not treated as hard errors.
.TP 5
.B \-v
Specifies that detailed conformance testing results should be displayed rather than the concise PASS/FAIL/ERROR status.
.TP 5
.B \-vv
Specifies that all information in the PPD file should be displayed in addition to the detailed conformance testing results.
.LP
The \fI-q\fR, \fI-v\fR, and \fI-vv\fR options are mutually exclusive.
.SH EXIT STATUS
\fBcupstestppd\fR returns zero on success and non-zero on error.
The error codes are as follows:
.TP 5
1
Bad command-line arguments or missing PPD filename.
.TP 5
2
Unable to open or read PPD file.
.TP 5
3
The PPD file contains format errors that cannot be skipped.
.TP 5
4
The PPD file does not conform to the Adobe PPD specification.
.SH EXAMPLES
The following command will test all PPD files under the current directory and print the names of each file that does not conform:
.nf

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

.fi
The next command tests all PPD files under the current directory and print detailed conformance testing results for the files that do not conform:
.nf

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