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

.\"
.\" "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $"
.\"
.\"   cupsfilter man page for the Common UNIX Printing System (CUPS).
.\"
.\"   Copyright 2007-2009 by Apple Inc.
.\"
.\"   These coded instructions, statements, and computer programs are the
.\"   property of Apple Inc. 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
.\"   file is missing or damaged, see the license at "http://www.cups.org/".
.\"
.TH cupsfilter 8 "Common UNIX Printing System" "26 February 2009" "Apple Inc."
.SH NAME
cupsfilter \- convert a file to another format using cups filters
.SH SYNOPSIS
.B cupsfilter
[ -c
.I config-file
] [ -e ] -j
.I job-id[,N]
[ -m
.I mime/type
] [ -n
.I copies
] [ -o
.I name=value
] [ -p
.I filename.ppd
] [ -t
.I title
]
.I filename
.SH DESCRIPTION
\fIcupsfilter\fR is a front-end to the CUPS filter subsystem which allows you
to convert a file to a specific format, just as if you had printed the file
through CUPS. By default, \fIcupsfilter\fR generates a PDF file.
.SH OPTIONS
.TP 5
-c config-file
.br
Uses the named cupsd.conf configuration file.
.TP 5
-e
.br
Use every filter from the PPD file.
.TP 5
-j job-id[,N]
.br
Converts document N from the specified job. If N is omitted, document 1 is
converted.
.TP 5
-m mime/type
.br
Specifies the destination file type. The default file type is application/pdf.
Use printer/foo to convert to the printer format defined by the filters in the
PPD file.
.TP 5
-n copies
.br
Specifies the number of copies to generate.
.TP 5
-o name=value
.br
Specifies options to pass to the CUPS filters.
.TP 5
-p filename.ppd
.br
Specifies the PPD file to use.
.TP 5
-t title
.br
Specifies the document title.
.SH KNOWN ISSUES
\fIcupsfilter\fR currently does not use the filters defined in the PPD file.
This will be addressed in a future CUPS release.
.SH SEE ALSO
\fIcupsd.conf(5)\fR
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007-2009 by Apple Inc.
.\"
.\" End of "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $".
.\"
Commit	Line	Data
bc44d920	1	.\"
b19ccc9e	2	.\" "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $"
bc44d920	3	.\"
	4	.\" cupsfilter man page for the Common UNIX Printing System (CUPS).
	5	.\"
c168a833	6	.\" Copyright 2007-2009 by Apple Inc.
bc44d920	7	.\"
	8	.\" These coded instructions, statements, and computer programs are the
	9	.\" property of Apple Inc. and are protected by Federal copyright
	10	.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
	11	.\" which should have been included with this file. If this file is
	12	.\" file is missing or damaged, see the license at "http://www.cups.org/".
	13	.\"
1340db2d	14	.TH cupsfilter 8 "Common UNIX Printing System" "26 February 2009" "Apple Inc."
bc44d920	15	.SH NAME
	16	cupsfilter \- convert a file to another format using cups filters
	17	.SH SYNOPSIS
	18	.B cupsfilter
	19	[ -c
	20	.I config-file
1340db2d	21	] [ -e ] -j
2e4ff8af	22	.I job-id[,N]
2fb76298	23	[ -m
bc44d920	24	.I mime/type
2fb76298	25	] [ -n
bc44d920	26	.I copies
	27	] [ -o
	28	.I name=value
	29	] [ -p
	30	.I filename.ppd
	31	] [ -t
	32	.I title
	33	]
	34	.I filename
	35	.SH DESCRIPTION
	36	\fIcupsfilter\fR is a front-end to the CUPS filter subsystem which allows you
	37	to convert a file to a specific format, just as if you had printed the file
2fb76298	38	through CUPS. By default, \fIcupsfilter\fR generates a PDF file.
bc44d920	39	.SH OPTIONS
	40	.TP 5
	41	-c config-file
	42	.br
	43	Uses the named cupsd.conf configuration file.
	44	.TP 5
1340db2d MS	45	-e
	46	.br
	47	Use every filter from the PPD file.
	48	.TP 5
2e4ff8af MS	49	-j job-id[,N]
	50	.br
	51	Converts document N from the specified job. If N is omitted, document 1 is
	52	converted.
	53	.TP 5
bc44d920	54	-m mime/type
bc44d920	55	.br
2fb76298	56	Specifies the destination file type. The default file type is application/pdf.
b19ccc9e MS	57	Use printer/foo to convert to the printer format defined by the filters in the
b19ccc9e MS	58	PPD file.
bc44d920	59	.TP 5
	60	-n copies
	61	.br
	62	Specifies the number of copies to generate.
	63	.TP 5
	64	-o name=value
	65	.br
	66	Specifies options to pass to the CUPS filters.
	67	.TP 5
	68	-p filename.ppd
	69	.br
	70	Specifies the PPD file to use.
	71	.TP 5
	72	-t title
	73	.br
	74	Specifies the document title.
2fb76298 MS	75	.SH KNOWN ISSUES
	76	\fIcupsfilter\fR currently does not use the filters defined in the PPD file.
	77	This will be addressed in a future CUPS release.
bc44d920	78	.SH SEE ALSO
	79	\fIcupsd.conf(5)\fR
	80	.br
	81	http://localhost:631/help
	82	.SH COPYRIGHT
c168a833	83	Copyright 2007-2009 by Apple Inc.
bc44d920	84	.\"
b19ccc9e	85	.\" End of "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $".
bc44d920	86	.\"