[thirdparty/cups.git] / doc / help / man-cupsfilter.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cupsfilter(8)</title>
</head>
<body>
<h1 class="title">cupsfilter(8)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cupsfilter - convert a file to another format using cups filters (deprecated)
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>cupsfilter</b>
[
<b>--list-filters</b>
] [
<b>-D</b>
] [
<b>-U</b>
<i>user</i>
] [
<b>-c</b>
<i>config-file</i>
] [
<b>-d</b>
<i>printer</i>
] [
<b>-e</b>
] [
<b>-i</b>
<i>mime/type</i>
] [
<b>-j</b>
<i>job-id[,N]</i>
] [
<b>-m</b>
<i>mime/type</i>
] [
<b>-n</b>
<i>copies</i>
] [
<b>-o</b>
<i>name=value</i>
] [
<b>-p</b>
<i>filename.ppd</i>
] [
<b>-t</b>
<i>title</i>
] [
<b>-u</b>
]
<i>filename</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>cupsfilter</b>
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,
<b>cupsfilter</b>
generates a PDF file. The converted file is sent to the standard output.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<dl class="man">
<dt><b>--list-filters</b>
<dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout.
<dt><b>-D</b>
<dd style="margin-left: 5.0em">Delete the input file after conversion.
<dt><b>-U </b><i>user</i>
<dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user.
<dt><b>-c </b><i>config-file</i>
<dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file.
<dt><b>-d </b><i>printer</i>
<dd style="margin-left: 5.0em">Uses information from the named printer.
<dt><b>-e</b>
<dd style="margin-left: 5.0em">Use every filter from the PPD file.
<dt><b>-i </b><i>mime/type</i>
<dd style="margin-left: 5.0em">Specifies the source file type. The default file type is guessed using the filename and contents of the file.
<dt><b>-j </b><i>job-id[,N]</i>
<dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted.
<dt><b>-m </b><i>mime/type</i>
<dd style="margin-left: 5.0em">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.
<dt><b>-n </b><i>copies</i>
<dd style="margin-left: 5.0em">Specifies the number of copies to generate.
<dt><b>-o </b><i>name=value</i>
<dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters.
<dt><b>-p </b><i>filename.ppd</i>
<dd style="margin-left: 5.0em">Specifies the PPD file to use.
<dt><b>-t </b><i>title</i>
<dd style="margin-left: 5.0em">Specifies the document title.
<dt><b>-u</b>
<dd style="margin-left: 5.0em">Delete the PPD file after conversion.
</dl>
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
<b>cupsfilter</b>
returns a non-zero exit status on any error.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
All of the standard
<b>cups</b>(1)
environment variables affect the operation of
<b>cupsfilter</b>.
<h2 class="title"><a name="FILES">Files</a></h2>
<pre class="man">
/etc/cups/cups-files.conf
/etc/cups/*.convs
/etc/cups/*.types
/usr/share/cups/mime/*.convs
/usr/share/cups/mime/*.types
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
<b>ippeveprinter</b>(1).
<p>Unlike when printing, filters run using the
<b>cupsfilter</b>
command use the current user and security session. This may result in different output or unexpected behavior.
<h2 class="title"><a name="EXAMPLE">Example</a></h2>
The following command will generate a PDF preview of job 42 for a printer named "myprinter" and save it to a file named "preview.pdf":
<pre class="man">

    cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>cups</b>(1),
<b>cupsd.conf</b>(5),
<b>filter(7),</b>
<b>mime.convs</b>(7),
<b>mime.types</b>(7),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2019 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	2	<html>
	3	<!-- SECTION: Man Pages -->
	4	<head>
	5	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	6	<title>cupsfilter(8)</title>
	7	</head>
	8	<body>
	9	<h1 class="title">cupsfilter(8)</h1>
	10	<h2 class="title"><a name="NAME">Name</a></h2>
87030afb	11	cupsfilter - convert a file to another format using cups filters (deprecated)
94436c5a	12	<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
c277f98c	13	<b>cupsfilter</b>
bf1bc4c6 MS	14	[
	15	<b>--list-filters</b>
	16	] [
	17	<b>-D</b>
	18	] [
	19	<b>-U</b>
c277f98c	20	<i>user</i>
bf1bc4c6 MS	21	] [
bf1bc4c6 MS	22	<b>-c</b>
c277f98c	23	<i>config-file</i>
bf1bc4c6 MS	24	] [
bf1bc4c6 MS	25	<b>-d</b>
c277f98c	26	<i>printer</i>
bf1bc4c6 MS	27	] [
	28	<b>-e</b>
	29	] [
	30	<b>-i</b>
c277f98c	31	<i>mime/type</i>
bf1bc4c6 MS	32	] [
bf1bc4c6 MS	33	<b>-j</b>
c277f98c	34	<i>job-id[,N]</i>
bf1bc4c6 MS	35	] [
bf1bc4c6 MS	36	<b>-m</b>
c277f98c	37	<i>mime/type</i>
bf1bc4c6 MS	38	] [
bf1bc4c6 MS	39	<b>-n</b>
c277f98c	40	<i>copies</i>
bf1bc4c6 MS	41	] [
bf1bc4c6 MS	42	<b>-o</b>
c277f98c	43	<i>name=value</i>
bf1bc4c6 MS	44	] [
bf1bc4c6 MS	45	<b>-p</b>
c277f98c	46	<i>filename.ppd</i>
bf1bc4c6 MS	47	] [
bf1bc4c6 MS	48	<b>-t</b>
c277f98c	49	<i>title</i>
bf1bc4c6 MS	50	] [
	51	<b>-u</b>
	52	]
c277f98c MS	53	<i>filename</i>
c277f98c MS	54	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
84987361 MS	55	<b>cupsfilter</b>
	56	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,
	57	<b>cupsfilter</b>
	58	generates a PDF file. The converted file is sent to the standard output.
94436c5a	59	<h2 class="title"><a name="OPTIONS">Options</a></h2>
2909c66c	60	<dl class="man">
bf1bc4c6	61	<dt><b>--list-filters</b>
2909c66c	62	<dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout.
bf1bc4c6	63	<dt><b>-D</b>
2909c66c	64	<dd style="margin-left: 5.0em">Delete the input file after conversion.
bf1bc4c6	65	<dt><b>-U </b><i>user</i>
2909c66c	66	<dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user.
bf1bc4c6	67	<dt><b>-c </b><i>config-file</i>
2909c66c	68	<dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file.
bf1bc4c6	69	<dt><b>-d </b><i>printer</i>
2909c66c	70	<dd style="margin-left: 5.0em">Uses information from the named printer.
bf1bc4c6	71	<dt><b>-e</b>
2909c66c	72	<dd style="margin-left: 5.0em">Use every filter from the PPD file.
bf1bc4c6	73	<dt><b>-i </b><i>mime/type</i>
2909c66c	74	<dd style="margin-left: 5.0em">Specifies the source file type. The default file type is guessed using the filename and contents of the file.
bf1bc4c6	75	<dt><b>-j </b><i>job-id[,N]</i>
2909c66c	76	<dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted.
bf1bc4c6	77	<dt><b>-m </b><i>mime/type</i>
2909c66c	78	<dd style="margin-left: 5.0em">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.
bf1bc4c6	79	<dt><b>-n </b><i>copies</i>
2909c66c	80	<dd style="margin-left: 5.0em">Specifies the number of copies to generate.
bf1bc4c6	81	<dt><b>-o </b><i>name=value</i>
2909c66c	82	<dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters.
bf1bc4c6	83	<dt><b>-p </b><i>filename.ppd</i>
2909c66c	84	<dd style="margin-left: 5.0em">Specifies the PPD file to use.
bf1bc4c6	85	<dt><b>-t </b><i>title</i>
2909c66c	86	<dd style="margin-left: 5.0em">Specifies the document title.
bf1bc4c6	87	<dt><b>-u</b>
2909c66c MS	88	<dd style="margin-left: 5.0em">Delete the PPD file after conversion.
2909c66c MS	89	</dl>
84987361 MS	90	<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
	91	<b>cupsfilter</b>
	92	returns a non-zero exit status on any error.
	93	<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
	94	All of the standard
87030afb	95	<b>cups</b>(1)
84987361 MS	96	environment variables affect the operation of
	97	<b>cupsfilter</b>.
	98	<h2 class="title"><a name="FILES">Files</a></h2>
bf1bc4c6 MS	99	<pre class="man">
	100	/etc/cups/cups-files.conf
	101	/etc/cups/*.convs
	102	/etc/cups/*.types
	103	/usr/share/cups/mime/*.convs
	104	/usr/share/cups/mime/*.types
84987361	105	<h2 class="title"><a name="NOTES">Notes</a></h2>
87030afb MS	106	CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS.
	107	Printers that do not support IPP can be supported using applications such as
	108	<b>ippeveprinter</b>(1).
	109	<p>Unlike when printing, filters run using the
84987361 MS	110	<b>cupsfilter</b>
	111	command use the current user and security session. This may result in different output or unexpected behavior.
	112	<h2 class="title"><a name="EXAMPLE">Example</a></h2>
	113	The following command will generate a PDF preview of job 42 for a printer named "myprinter" and save it to a file named "preview.pdf":
2909c66c	114	<pre class="man">
bf1bc4c6	115
84987361 MS	116	cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
84987361 MS	117	</pre>
94436c5a	118	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb MS	119	<b>cups</b>(1),
87030afb MS	120	<b>cupsd.conf</b>(5),
bf1bc4c6	121	<b>filter(7),</b>
87030afb MS	122	<b>mime.convs</b>(7),
87030afb MS	123	<b>mime.types</b>(7),
bf1bc4c6	124	CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a	125	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb	126	Copyright © 2007-2019 by Apple Inc.
94436c5a MS	127
	128	</body>
	129	</html>