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

.\"
.\" "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $"
.\"
.\" cupsfilter man page for CUPS.
.\"
.\" Copyright 2007-2014 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 "CUPS" "28 March 2014" "Apple Inc."
.SH NAME
cupsfilter \- convert a file to another format using cups filters
.SH SYNOPSIS
.B cupsfilter
[ -D ] [ -U
.I user
] [ -c
.I config-file
] [ -d
.I printer
] [ -e ] [ -i
.I mime/type
] [ -j
.I job-id[,N]
] [ -m
.I mime/type
] [ -n
.I copies
] [ -o
.I name=value
] [ -p
.I filename.ppd
] [ -t
.I title
] [ -u ]
.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. The converted
file is sent to the standard output.
.SH OPTIONS
.TP 5
-D
.br
Delete the input file after conversion.
.TP 5
-U user
.br
Specifies the username passed to the filters. The default is the name of the current user.
.TP 5
-c config-file
.br
Uses the named cups-files.conf configuration file.
.TP 5
-d printer
Uses information from the named printer.
.TP 5
-e
.br
Use every filter from the PPD file.
.TP 5
-i mime/type
.br
Specifies the source file type. The default file type is guessed using the
filename and contents of the 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.
.TP 5
-u
.br
Delete the PPD file after conversion.
.SH SEE ALSO
\fIcups-files.conf(5)\fR
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007-2014 by Apple Inc.
.\"
.\" End of "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $".
.\"
Commit	Line	Data
bc44d920	1	.\"
71f63681	2	.\" "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $"
bc44d920	3	.\"
71f63681	4	.\" cupsfilter man page for CUPS.
bc44d920	5	.\"
71f63681	6	.\" Copyright 2007-2014 by Apple Inc.
bc44d920	7	.\"
71f63681 MS	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/".
bc44d920	13	.\"
71f63681	14	.TH cupsfilter 8 "CUPS" "28 March 2014" "Apple Inc."
bc44d920	15	.SH NAME
	16	cupsfilter \- convert a file to another format using cups filters
	17	.SH SYNOPSIS
	18	.B cupsfilter
37e7e6e0 MS	19	[ -D ] [ -U
	20	.I user
	21	] [ -c
bc44d920	22	.I config-file
f3c17241	23	] [ -d
ba55dc12	24	.I printer
37e7e6e0 MS	25	] [ -e ] [ -i
	26	.I mime/type
	27	] [ -j
2e4ff8af	28	.I job-id[,N]
37e7e6e0	29	] [ -m
bc44d920	30	.I mime/type
2fb76298	31	] [ -n
bc44d920	32	.I copies
	33	] [ -o
	34	.I name=value
	35	] [ -p
	36	.I filename.ppd
	37	] [ -t
	38	.I title
37e7e6e0	39	] [ -u ]
bc44d920	40	.I filename
	41	.SH DESCRIPTION
	42	\fIcupsfilter\fR is a front-end to the CUPS filter subsystem which allows you
	43	to convert a file to a specific format, just as if you had printed the file
71f63681 MS	44	through CUPS. By default, \fIcupsfilter\fR generates a PDF file. The converted
71f63681 MS	45	file is sent to the standard output.
bc44d920	46	.SH OPTIONS
bc44d920	47	.TP 5
37e7e6e0 MS	48	-D
	49	.br
	50	Delete the input file after conversion.
	51	.TP 5
	52	-U user
	53	.br
	54	Specifies the username passed to the filters. The default is the name of the current user.
	55	.TP 5
bc44d920	56	-c config-file
bc44d920	57	.br
71f63681	58	Uses the named cups-files.conf configuration file.
bc44d920	59	.TP 5
ba55dc12 MS	60	-d printer
	61	Uses information from the named printer.
	62	.TP 5
1340db2d MS	63	-e
	64	.br
	65	Use every filter from the PPD file.
	66	.TP 5
37e7e6e0 MS	67	-i mime/type
	68	.br
	69	Specifies the source file type. The default file type is guessed using the
	70	filename and contents of the file.
	71	.TP 5
2e4ff8af MS	72	-j job-id[,N]
	73	.br
	74	Converts document N from the specified job. If N is omitted, document 1 is
	75	converted.
	76	.TP 5
bc44d920	77	-m mime/type
bc44d920	78	.br
2fb76298	79	Specifies the destination file type. The default file type is application/pdf.
b19ccc9e MS	80	Use printer/foo to convert to the printer format defined by the filters in the
b19ccc9e MS	81	PPD file.
bc44d920	82	.TP 5
	83	-n copies
	84	.br
	85	Specifies the number of copies to generate.
	86	.TP 5
	87	-o name=value
	88	.br
	89	Specifies options to pass to the CUPS filters.
	90	.TP 5
	91	-p filename.ppd
	92	.br
	93	Specifies the PPD file to use.
	94	.TP 5
	95	-t title
	96	.br
	97	Specifies the document title.
37e7e6e0 MS	98	.TP 5
	99	-u
	100	.br
	101	Delete the PPD file after conversion.
bc44d920	102	.SH SEE ALSO
71f63681	103	\fIcups-files.conf(5)\fR
bc44d920	104	.br
	105	http://localhost:631/help
	106	.SH COPYRIGHT
71f63681	107	Copyright 2007-2014 by Apple Inc.
bc44d920	108	.\"
71f63681	109	.\" End of "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $".
bc44d920	110	.\"