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

.\"
.\" "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $"
.\"
.\"   cupsfilter man page for CUPS.
.\"
.\"   Copyright 2007-2013 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" "20 June 2012" "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.
.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 cupsd.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
\fIcupsd.conf(5)\fR
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007-2013 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	.\"
ba55dc12	4	.\" cupsfilter man page for CUPS.
bc44d920	5	.\"
0fa6c7fa	6	.\" Copyright 2007-2013 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	.\"
37e7e6e0	14	.TH cupsfilter 8 "CUPS" "20 June 2012" "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
2fb76298	44	through CUPS. By default, \fIcupsfilter\fR generates a PDF file.
bc44d920	45	.SH OPTIONS
bc44d920	46	.TP 5
37e7e6e0 MS	47	-D
	48	.br
	49	Delete the input file after conversion.
	50	.TP 5
	51	-U user
	52	.br
	53	Specifies the username passed to the filters. The default is the name of the current user.
	54	.TP 5
bc44d920	55	-c config-file
	56	.br
	57	Uses the named cupsd.conf configuration file.
	58	.TP 5
ba55dc12 MS	59	-d printer
	60	Uses information from the named printer.
	61	.TP 5
1340db2d MS	62	-e
	63	.br
	64	Use every filter from the PPD file.
	65	.TP 5
37e7e6e0 MS	66	-i mime/type
	67	.br
	68	Specifies the source file type. The default file type is guessed using the
	69	filename and contents of the file.
	70	.TP 5
2e4ff8af MS	71	-j job-id[,N]
	72	.br
	73	Converts document N from the specified job. If N is omitted, document 1 is
	74	converted.
	75	.TP 5
bc44d920	76	-m mime/type
bc44d920	77	.br
2fb76298	78	Specifies the destination file type. The default file type is application/pdf.
b19ccc9e MS	79	Use printer/foo to convert to the printer format defined by the filters in the
b19ccc9e MS	80	PPD file.
bc44d920	81	.TP 5
	82	-n copies
	83	.br
	84	Specifies the number of copies to generate.
	85	.TP 5
	86	-o name=value
	87	.br
	88	Specifies options to pass to the CUPS filters.
	89	.TP 5
	90	-p filename.ppd
	91	.br
	92	Specifies the PPD file to use.
	93	.TP 5
	94	-t title
	95	.br
	96	Specifies the document title.
37e7e6e0 MS	97	.TP 5
	98	-u
	99	.br
	100	Delete the PPD file after conversion.
bc44d920	101	.SH SEE ALSO
	102	\fIcupsd.conf(5)\fR
	103	.br
	104	http://localhost:631/help
	105	.SH COPYRIGHT
0fa6c7fa	106	Copyright 2007-2013 by Apple Inc.
bc44d920	107	.\"
b19ccc9e	108	.\" End of "$Id: cupsfilter.man 7936 2008-09-11 03:12:59Z mike $".
bc44d920	109	.\"