path: root/foomatic-rip.1.in

.\" This -*- nroff -*- source file is part of foomatic.

.hy 0
.TH FOOMATIC-RIP 1 "2002-11-26" "Foomatic Project"
.SH NAME
foomatic-rip \- Universal print filter/RIP wrapper
.SH SYNOPSIS

.SS \fRGeneral Options:
.BI \fBfoomatic-rip\fR\ \fB[-v]\ [-q]\fP \fI\ <spooler-specific\ options>

.SS \fRSpooler-less printing/CPS (older versions) filter:
.BI \fBfoomatic-rip\fR\ \fB[\fB-P\fR \ \fI<printer>\fR \ 
| \ \fB--ppd\fR \ \fI<ppdfile>\fR \fB]\fR \ [\fB-J\fR\ \fI<jobtitle>\fR ]
[\fB-o\fR \ \fI<option>\fB=\fI<value>\fR \ [...]] \ \fB[\fI<files>\fB]\fR

.SS \fRCUPS filter:
.BI \fBfoomatic-rip\fR\ \fI<jobid>\fR \ \fI<user>\fR \ \fI<jobtitle>\fR \ \fI<numcopies>\fR \ \fI<options>\fR \ \fB[\fI<file>\fB]\fR 

.SS \fRLPRng filter:
.BI \fBfoomatic-rip\fR\ --lprng\  \fB[\fB-J\fI<jobtitle>\fB]\fR   \fB[\fB-Z\fI<option>\fB=\fI<value>\fB[,\fI<option>\fB=\fI<value>\fB[, \ \fB...]]\fR \ \fI<ppdfile>\fR
.br

.BI \fBfoomatic-rip\fR\ \ \fB[\fB-J\fI<jobtitle>\fB]\fR   \fB[\fB-Z\fI<option>\fB=\fI<value>\fB[,\fI<option>\fB=\fI<value>\fB[, \ \fB...]]\fR
.br
(printcap :pdd=<ppdfile>)

.BI \fBfoomatic-rip\fR\ \fB--ppd\fR \ \fI<ppdfile>\fR   \fB[\fB-J\fI<jobtitle>\fB]\fR \ \fB[\fB-Z\fI<option>\fB=\fI<value>\fB[,\fI<option>\fB=\fI<value>\fB[, \ \fB...]]\fR

.SS \fRLPD/GNUlpr filter:
.BI \fBfoomatic-rip\fR\ \fB[\fB-w\fR\ \fI<number>\fB]\fR\ \fB[\fB-l\fR\ \fI<number>\fB]\fR\ \fB[\fB-x\fR\ \fI<number>\fB]\fR\ \fB[\fB-y\fR\ \fI<number>\fB]\fR\ \fB[\fB-i\fR\ \fI<number>\fB]\fR\ \fB[\fB-c\fB]\fR\ \fB[\fB-n\fR\ \fI<string>\fB]\fR\ \fB[\fB-h\fR\ \fI<string>\fB]\fR\ \fB[\fB-j|-J\fR\ \fI<jobtitle>\fB|\fI<options>\fB]\fR\ \fI<ppdfile>\fR

.SS \fRPPR RIP:
.BI \fBfoomatic-rip\fR\ \fB[\fI<option>\fB=\fI<value>\fR \ [...]]

.SS \fRPPR interface:
.BI \fBfoomatic-rip\fR\ \fI<queue>\fR \ \fI<destaddress>\fR \ \fI<options>\fR \ \fI<jobbreak>\fR \ \fI<feedback>\fR \ \fI<codes>\fR \ \fI<jobname>\fR \ \fI<routing>\fR \ \fI<for>\fR \ \fI<filetype>\fR \ \fB[\fI<file>\fB]\fR 

.SS \fRPDQ driver file generation:
.BI foomatic-rip\ \fB[\fB--ppd\fR \ \fI<ppdfile>\fB]\fR \ [\fB-o\fR \ \fI<option>\fB=\fI<value>\fR \ [...]] \ \fB--genpdq|--appendpdq|--genrawpdq|--appendrawpdq\fR

.SS \fRPDQ filter:
.BI foomatic-rip\ \fB--pdq\fR\ \fB--ppd\fR \ \fI<ppdfile>\fR \fB]\fR \ [\fB-o\fR \ \fI<option>\fB=\fI<value>\fR \ [...]] \ \fI<file>\fR

.SS \fRCPS (newer versions) filter:
.BI \fBfoomatic-rip\fR\ \fB--cps\fR\ \fB-P\fR \ \fI<printer>\fR \ [\fB-J\fR\ \fI<jobtitle>\fR ] \ [\fB-o\fR \ \fI<option>\fB=\fI<value>\fR \ [...]] \ \fB[\fI<files>\fB]\fR

.SH DESCRIPTION
foomatic-rip is a universal print filter which works with every known free
software printer spooler. It has the following features:

.Topic 
It translates PostScript and PDF (and also other file formats) from standard
input to the printer's native language (usually put to standard
output).

.Topic
The translation is done with an external renderer, usually Ghostscript
(\fBgs(1)\fR). If no translation is needed (PostScript printer) the
renderer's command line reduces to \fBcat(1)\fR. The way how this
translation is done is described in a \fBPPD file\fR.

.Topic
Printer capabilities, how to handle user options, and how to build the
renderer command line is always described by \fBPPD files\fR, these
PPD files usually come from \fBFoomatic\fR or can be the ones supplied by
the manufacturers of PostScript printers. The PPD files are the same
for all spoolers.

.Topic
foomatic-rip works with every known spooler (\fBCUPS\fR, \fBLPRng\fR,
\fBLPD\fR, \fBGNUlpr\fR, \fBPPR\fR, \fBPDQ\fR, \fBCPS\fR, and
\fBwithout spooler\fR). It auto-detects the spooler from which it was
called by the command line options and environment variables which
were supplied by the spooler.

.Topic
Non-PostScript/PDF files are translated to PostScript before they are
passed to the renderer. This is usually done by \fBa2ps(1)\fR,
\fBenscript(1)\fR, or \fBmpage(1)\fR. foomatic-rip auto-detects which
program is installed, but manual configuration is also possible.

.Topic
foomatic-rip does not only apply option settings supplied by the user
through the command line of the printing command, but also searches
the entire job for embedded option settings (only PostScript
jobs). Here not only settings which affect the whole job are taken into
account, but also settings in the page headers, which are only valid
for the page where they were found, so applications which produce
PostScript code with page-specific printer option settings are fully
supported.

.SH SPOOLER-LESS PRINTING

.SS Options

.TP 10
.B \-v
\fRverbose mode for debugging.
.B WARNING:
This will create a file in /tmp that contains the debugging information.
This opens a security loophole and should not be used in production.

.TP 10
.B \-q
\fRquiet mode - minimal information output

.TP 10
.BI \-P \ <printer>
\fI<printer>\fR is the configured printer which should be used for this job.

.TP 10
.BI \--ppd \ <ppdfile>
The PPD file \fI<ppdfile>\fR should be applied for processing this job.
.TP 10
.BI \-J \ <jobtitle>
The \fI<jobtitle>\fR will be printed in the head line of every page of
a plain text job.
.TP 10
.BI \-o \ \fI<option>\fB=\fI<value>\fR
Option settings for this job, do 

.B foomatic-rip -P \fI<printer>\fR \fB-o docs \fI<file>\fR 

(\fI<file>\fR can be an arbitrary existing file, as \fB.bashrc\fR,
will not be printed) to print a list of available options for the
specified \fI<printer>\fR.
.TP 10
.BI \fI<files>\fR
The file(s) to be printed.

.P
\fBfoomatic-rip\fR will print from standard input unless at least one file to
be printed is specified on the command line.
If your printer PPD file is stored as \fI@sysconfdir@/direct/<printer>.ppd\fR
or \fI~/.foomatic/direct/<printer>.ppd\fR you can use it by simply specifying "-P \fI<printer>\fR".

Put a line

\fB*FoomaticRIPPostPipe: "| \fI<command>\fB"\fR
.hy 0

into the PPD file, right after \fB*PPD-Adobe: "4.3"\fR, where
\fI<command>\fR is a command into which you want to re-direct the
output data. Due to the restrictions of PPD files \fB<\fR, \fB>\fR, and
\fB"\fR are not allowed in the \fI<command>\fR, replace them as
follows:

.CodeSkip
.nf
.B Character	Replacement
.B ---------------------
.B		<	&lt;
.B		>	&gt;
.B		"	&quot;
.B		'	&apos;
.B		&	&amp;
.fi

This way you can print directly to your printer, use

\fB*FoomaticRIPPostPipe: "| cat &gt; /dev/lp0"\fR

or

\fB*FoomaticRIPPostPipe: "| cat &gt; /dev/usb/lp0"\fR

for local parallel or USB printers. To make normal users able to print
this way add them to the group \fBlp\fR and make sure that the
appropriate printer device file \fI/dev/...\fR is group-writable for
the \fBlp\fR group.

for a TCP/Socket/JetDirect printer with the host name \fBprinter\fR
listening on port \fB9100\fR you need this:

\fB*FoomaticRIPPostPipe: "| /usr/bin/nc -w 1 printer 9100"\fR

Note the "-w 1" in the "nc" command line, it makes "nc" exiting
immediately after the data is transferred to the printer.

\fB*FoomaticRIPPostPipe: "| rlpr -Plp@printserver"\fR

directs your jobs to the LPD printer queue \fBlp\fR on the machine
named \fBprintserver\fR.

See also http://www.openprinting.org/direct-doc.html

.SH "PRINTING WITH SPOOLER"

See the documentation on the OpenPrinting Web site:
.ft CW
http://www.openprinting.org/
\fR

.SH "CONFIGURATION FILE"

The file \fB@sysconfdir@/foomatic/filter.conf\fR is read whenever
foomatic-rip is executed. It allows to configure the behavior of
foomatic-rip as follows (lines beginning with \fB#\fR are comments and
therefore get ignored):

.TP 10
.BI textfilter: \ <command>
\fRSelects the filter for input files which are not PostScript or PDF.
\fI<command>\fR is one of \fBa2ps\fR, \fBenscript\fR, or \fBmpage\fR.
foomatic-rip automatically selects the needed command line options.

.TP 10
.B debug: 0|1
\fRTurns on (\fB1\fR) or off (\fB0\fR) the debug mode. This is equivalent to
supplying the \fB--debug\fR command line option. Default setting is \fB0\fR.

.TP 10
.B ps_accounting: 0|1
\fRTurns on (\fB1\fR) or off (\fB0\fR) inserting PostScript code for page
accounting into PostScript jobs. The inserted PostScript code makes
Ghostscript generating accounting output on stderr and CUPS can this way
log each page which got printed. The code will only be inserted if CUPS
is the spooler. Default setting is \fB1\fR.

.TP 10
.BI echo: \ [<path>/]<executable>
\fRSets the path to an \fBecho(1)\fR executable which supports \fB-n\fR.

.TP 10
.BI gspath: \ [<path>/]<executable>
\fRSets the path to the Ghostscript (\fBgs(1)\fR) executable. To be used if
Ghostscript is at a non-standard location or if an alternative Ghostscript
should be used.

.TP 10
.BI execpath: \ <path>[:<path>]...
\fRSets the \fB$PATH\fR variable to be used by foomatic-rip.

.TP 10
.BI cupsfilterpath: \ <path>[:<path>]...
\fRSets the directories (colon-separated) in which foomatic-rip searches for
CUPS filters.

.TP 10
.BI preferred_shell: \ [<path>/]<executable>
\fRSets the preferred shell to use when executing FoomaticRIPCommandLine and
friends. Several PPD files use shell constructs that require a more
modern shell like \fBbash\fR, \fBzsh\fR, or \fBksh\fR.


.SH FILES
.PD 0
.TP 0
@sysconfdir@/cups/ppd/<printer>.ppd
.TP 0
@sysconfdir@/lpd/<printer>.ppd
.TP 0
@sysconfdir@/ppr/<printer>.ppd
.TP 0
@sysconfdir@/pdq/<printer>.ppd
.TP 8
@sysconfdir@/direct/<printer>.ppd

The PPD files of the currently defined printers

.TP 8
@sysconfdir@/foomatic/filter.conf

Configuration file for foomatic-rip

.PD 0

.\".SH SEE ALSO
.\".IR foomatic-XXX (1),

.SH EXIT STATUS
.B foomatic-rip
returns 0 unless something unexpected happens.

.SH AUTHOR
Till Kamppeter <\fItill.kamppeter@gmail.com\fR> with parts of Manfred
Wassmanns's <\fImanolo@NCC-1701.B.Shuttle.de\fR> man pages for the
Foomatic 2.0.x filters.

.SH BUGS
None so far.

Please send bug reports to the Foomatic mailing list:

http://lists.freestandards.org/mailman/listinfo/printing-foomatic