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

.\"
.\" "$Id: cupstestppd.man 177 2006-06-21 00:20:03Z jlovell $"
.\"
.\"   cupstestppd man page for the Common UNIX Printing System (CUPS).
.\"
.\"   Copyright 1997-2006 by Easy Software Products.
.\"
.\"   These coded instructions, statements, and computer programs are the
.\"   property of Easy Software Products and are protected by Federal
.\"   copyright law.  Distribution and use rights are outlined in the file
.\"   "LICENSE.txt" which should have been included with this file.  If this
.\"   file is missing or damaged please contact Easy Software Products
.\"   at:
.\"
.\"       Attn: CUPS Licensing Information
.\"       Easy Software Products
.\"       44141 Airport View Drive, Suite 204
.\"       Hollywood, Maryland 20636 USA
.\"
.\"       Voice: (301) 373-9600
.\"       EMail: cups-info@cups.org
.\"         WWW: http://www.cups.org
.\"
.TH cupstestppd 1 "Common UNIX Printing System" "12 February 2006" "Easy Software Products"
.SH NAME
cupstestppd \- test conformance of ppd files
.SH SYNOPSIS
.B cupstestppd
[ -q ] [-r] [ -v[v] ] filename.ppd[.gz] [ ... filenameN.ppd[.gz] ]
.br
.B cupstestppd
[ -q ] [-r] [ -v[v] ] -
.SH DESCRIPTION
\fIcupstestppd\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 \fIcupstestppd\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
\fIcupstestppd\fR supports the following options:
.TP 5
-q
.br
Specifies that no information should be displayed.
.TP 5
-r
.br
Relaxes the PPD conformance requirements so that common
whitespace, control character, and formatting problems are not
treated as hard errors.
.TP 5
-v
.br
Specifies that detailed conformance testing results should be
displayed rather than the concise PASS/FAIL/ERROR status.
.TP 5
-vv
.br
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
\fIcupstestppd\fR returns zero on success and non-zero on error. The
error codes are as follows:
.TP 5
1
.br
Bad command-line arguments or missing PPD filename.
.TP 5
2
.br
Unable to open or read PPD file.
.TP 5
3
.br
The PPD file contains format errors that cannot be skipped.
.TP 5
4
.br
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
\fIlpadmin(8)\fR,
.br
http://localhost:631/help
.br
Adobe PostScript Printer Description File Format Specification, Version 4.3.
.SH COPYRIGHT
Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
.\"
.\" End of "$Id: cupstestppd.man 177 2006-06-21 00:20:03Z jlovell $".
.\"
Commit	Line	Data
	1	.\"
	2	.\" "$Id: cupstestppd.man 177 2006-06-21 00:20:03Z jlovell $"
	3	.\"
	4	.\" cupstestppd man page for the Common UNIX Printing System (CUPS).
	5	.\"
	6	.\" Copyright 1997-2006 by Easy Software Products.
	7	.\"
	8	.\" These coded instructions, statements, and computer programs are the
	9	.\" property of Easy Software Products and are protected by Federal
	10	.\" copyright law. Distribution and use rights are outlined in the file
	11	.\" "LICENSE.txt" which should have been included with this file. If this
	12	.\" file is missing or damaged please contact Easy Software Products
	13	.\" at:
	14	.\"
	15	.\" Attn: CUPS Licensing Information
	16	.\" Easy Software Products
	17	.\" 44141 Airport View Drive, Suite 204
	18	.\" Hollywood, Maryland 20636 USA
	19	.\"
	20	.\" Voice: (301) 373-9600
	21	.\" EMail: cups-info@cups.org
	22	.\" WWW: http://www.cups.org
	23	.\"
	24	.TH cupstestppd 1 "Common UNIX Printing System" "12 February 2006" "Easy Software Products"
	25	.SH NAME
	26	cupstestppd \- test conformance of ppd files
	27	.SH SYNOPSIS
	28	.B cupstestppd
	29	[ -q ] [-r] [ -v[v] ] filename.ppd[.gz] [ ... filenameN.ppd[.gz] ]
	30	.br
	31	.B cupstestppd
	32	[ -q ] [-r] [ -v[v] ] -
	33	.SH DESCRIPTION
	34	\fIcupstestppd\fR tests the conformance of PPD files to the
	35	Adobe PostScript Printer Description file format specification
	36	version 4.3. It can also be used to list the supported options
	37	and available fonts in a PPD file. The results of testing and
	38	any other output are sent to the standard output.
	39	.LP
	40	The first form of \fIcupstestppd\fR tests one or more PPD files
	41	on the command-line. The second form tests the PPD file provided
	42	on the standard input.
	43	.SH OPTIONS
	44	\fIcupstestppd\fR supports the following options:
	45	.TP 5
	46	-q
	47	.br
	48	Specifies that no information should be displayed.
	49	.TP 5
	50	-r
	51	.br
	52	Relaxes the PPD conformance requirements so that common
	53	whitespace, control character, and formatting problems are not
	54	treated as hard errors.
	55	.TP 5
	56	-v
	57	.br
	58	Specifies that detailed conformance testing results should be
	59	displayed rather than the concise PASS/FAIL/ERROR status.
	60	.TP 5
	61	-vv
	62	.br
	63	Specifies that all information in the PPD file should be
	64	displayed in addition to the detailed conformance testing
	65	results.
	66	.LP
	67	The \fI-q\fR, \fI-v\fR, and \fI-vv\fR options are mutually exclusive.
	68	.SH EXIT STATUS
	69	\fIcupstestppd\fR returns zero on success and non-zero on error. The
	70	error codes are as follows:
	71	.TP 5
	72	1
	73	.br
	74	Bad command-line arguments or missing PPD filename.
	75	.TP 5
	76	2
	77	.br
	78	Unable to open or read PPD file.
	79	.TP 5
	80	3
	81	.br
	82	The PPD file contains format errors that cannot be skipped.
	83	.TP 5
	84	4
	85	.br
	86	The PPD file does not conform to the Adobe PPD specification.
	87	.SH EXAMPLES
	88	The following command will test all PPD files under the current
	89	directory and print the names of each file that does not
	90	conform:
	91	.nf
	92
	93	find . -name \\*.ppd \\! -exec cupstestppd -q '{}' \\; -print
	94
	95	.fi
	96	The next command tests all PPD files under the current directory
	97	and print detailed conformance testing results for the files
	98	that do not conform:
	99	.nf
	100
	101	find . -name \\*.ppd \\! -exec cupstestppd -q '{}' \\; \\
	102	-exec cupstestppd -v '{}' \\;
	103
	104	.fi
	105	.SH SEE ALSO
	106	\fIlpadmin(8)\fR,
	107	.br
	108	http://localhost:631/help
	109	.br
	110	Adobe PostScript Printer Description File Format Specification, Version 4.3.
	111	.SH COPYRIGHT
	112	Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
	113	.\"
	114	.\" End of "$Id: cupstestppd.man 177 2006-06-21 00:20:03Z jlovell $".
	115	.\"