377 lines
11 KiB
HTML
377 lines
11 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of ippeveprinter</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>ippeveprinter</H1>
|
|
Section: Apple Inc. (1)<BR>Updated: CUPS<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
ippeveprinter - an ipp everywhere printer application for cups
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>ippeveprinter</B>
|
|
|
|
[
|
|
<B>--help</B>
|
|
|
|
] [
|
|
<B>--no-web-forms</B>
|
|
|
|
] [
|
|
<B>--pam-service</B>
|
|
|
|
<I>service</I>
|
|
|
|
] [
|
|
<B>--version</B>
|
|
|
|
] [
|
|
<B>-2</B>
|
|
|
|
] [
|
|
<B>-A</B>
|
|
|
|
] [
|
|
<B>-D</B>
|
|
|
|
<I>device-uri</I>
|
|
|
|
] [
|
|
<B>-F</B>
|
|
|
|
<I>output-type/subtype</I>
|
|
|
|
] [
|
|
<B>-K</B>
|
|
|
|
<I>keypath</I>
|
|
|
|
] [
|
|
<B>-M</B>
|
|
|
|
<I>manufacturer</I>
|
|
|
|
] [
|
|
<B>-P</B>
|
|
|
|
<I>filename.ppd</I>
|
|
|
|
] [
|
|
<B>-V</B>
|
|
|
|
<I>ipp-version</I>
|
|
|
|
] [
|
|
<B>-a</B>
|
|
|
|
<I>filename.conf</I>
|
|
|
|
] [
|
|
<B>-c</B>
|
|
|
|
<I>command</I>
|
|
|
|
] [
|
|
<B>-d</B>
|
|
|
|
<I>spool-directory</I>
|
|
|
|
] [
|
|
<B>-f</B>
|
|
|
|
<I>type/subtype[,...]</I>
|
|
|
|
] [
|
|
<B>-i</B>
|
|
|
|
<I>iconfile.png</I>
|
|
|
|
] [
|
|
<B>-k</B>
|
|
|
|
] [
|
|
<B>-l</B>
|
|
|
|
<I>location</I>
|
|
|
|
] [
|
|
<B>-m</B>
|
|
|
|
<I>model</I>
|
|
|
|
] [
|
|
<B>-n</B>
|
|
|
|
<I>hostname</I>
|
|
|
|
] [
|
|
<B>-p</B>
|
|
|
|
<I>port</I>
|
|
|
|
] [
|
|
<B>-r</B>
|
|
|
|
<I>subtype[,subtype]</I>
|
|
|
|
] [
|
|
<B>-s</B>
|
|
|
|
<I>speed[,color-speed]</I>
|
|
|
|
] [
|
|
<B>-v[vvv]</B>
|
|
|
|
]
|
|
<I>service-name</I>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>ippeveprinter</B>
|
|
|
|
is a simple Internet Printing Protocol (IPP) server conforming to the IPP Everywhere (PWG 5100.14) specification. It can be used to test client software or act as a very basic print server that runs a command for every job that is printed.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
The following options are recognized by
|
|
<B>ippeveprinter:</B>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>--help</B>
|
|
|
|
<DD>
|
|
Show program usage.
|
|
<DT id="2"><B>--no-web-forms</B>
|
|
|
|
<DD>
|
|
Disable the web interface forms used to update the media and supply levels.
|
|
<DT id="3"><B>--pam-service </B><I>service</I><DD>
|
|
Set the PAM service name.
|
|
The default service is "cups".
|
|
<DT id="4"><B>--version</B>
|
|
|
|
<DD>
|
|
Show the CUPS version.
|
|
<DT id="5"><B>-2</B>
|
|
|
|
<DD>
|
|
Report support for two-sided (duplex) printing.
|
|
<DT id="6"><B>-A</B>
|
|
|
|
<DD>
|
|
Enable authentication for the created printer.
|
|
<B>ippeveprinter</B>
|
|
|
|
uses PAM to authenticate HTTP Basic credentials.
|
|
<DT id="7"><B>-D </B><I>device-uri</I><DD>
|
|
Set the device URI for print output.
|
|
The URI can be a filename, directory, or a network socket URI of the form "<A HREF="socket://ADDRESS[:PORT]">socket://ADDRESS[:PORT]</A>" (where the default port number is 9100).
|
|
When specifying a directory,
|
|
<B>ippeveprinter</B>
|
|
|
|
will create an output file using the job ID and name.
|
|
<DT id="8"><B>-F </B><I>output-type/subtype[,...]</I><DD>
|
|
Specifies the output MIME media type.
|
|
The default is "application/postscript" when the <B>-P</B> option is specified.
|
|
<DT id="9"><B>-M </B><I>manufacturer</I><DD>
|
|
Set the manufacturer of the printer.
|
|
The default is "Example".
|
|
<DT id="10"><B>-P </B><I>filename.ppd</I><DD>
|
|
Load printer attributes from the specified PPD file.
|
|
This option is typically used in conjunction with the
|
|
<B><A HREF="/cgi-bin/man/man2html?7+ippeveps">ippeveps</A></B>(7)
|
|
|
|
printer command ("-c ippeveps").
|
|
<DT id="11"><B>-V 1.1</B><DD>
|
|
<DT id="12"><B>-V 2.0</B><DD>
|
|
Specifies the maximum IPP version to report.
|
|
2.0 is the default.
|
|
<DT id="13"><B>-c </B><I>command</I><DD>
|
|
Run the specified command for each document that is printed.
|
|
If "command" is not an absolute path ("/path/to/command"),
|
|
<B>ippeveprinter</B>
|
|
|
|
looks for the command in the "command" subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command.
|
|
The
|
|
<B><A HREF="/cgi-bin/man/man2html?1+cups-config">cups-config</A></B>(1)
|
|
|
|
command can be used to discover the correct binary directory ("cups-config --serverbin").
|
|
In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the
|
|
<B><A HREF="/cgi-bin/man/man2html?1+cups">cups</A></B>(1)
|
|
|
|
man page for more details.
|
|
<DT id="14"><B>-d </B><I>spool-directory</I><DD>
|
|
Specifies the directory that will hold the print files.
|
|
The default is a directory under the user's current temporary directory.
|
|
<DT id="15"><B>-f </B><I>type/subtype[,...]</I><DD>
|
|
Specifies a list of MIME media types that the server will accept.
|
|
The default depends on the type of printer created.
|
|
<DT id="16"><B>-i </B><I>iconfile.png</I><DD>
|
|
Specifies the printer icon file for the server.
|
|
The file must be a PNG format image.
|
|
The default is an internally-provided PNG image.
|
|
<DT id="17"><B>-k</B>
|
|
|
|
<DD>
|
|
Keeps the print documents in the spool directory rather than deleting them.
|
|
<DT id="18"><B>-l </B><I>location</I><DD>
|
|
Specifies the human-readable location string that is reported by the server.
|
|
The default is the empty string.
|
|
<DT id="19"><B>-m </B><I>model</I><DD>
|
|
Specifies the model name of the printer.
|
|
The default is "Printer".
|
|
<DT id="20"><B>-n </B><I>hostname</I><DD>
|
|
Specifies the hostname that is reported by the server.
|
|
The default is the name returned by the
|
|
<B><A HREF="/cgi-bin/man/man2html?1+hostname">hostname</A></B>(1)
|
|
|
|
command.
|
|
<DT id="21"><B>-p </B><I>port</I><DD>
|
|
Specifies the port number to listen on.
|
|
The default is a user-specific number from 8000 to 8999.
|
|
<DT id="22"><B>-r off</B>
|
|
|
|
<DD>
|
|
Turns off DNS-SD service advertisements entirely.
|
|
<DT id="23"><B>-r </B><I>subtype[,subtype]</I><DD>
|
|
Specifies the DNS-SD subtype(s) to advertise.
|
|
Separate multiple subtypes with a comma.
|
|
The default is "_print".
|
|
<DT id="24"><B>-s </B><I>speed[,color-speed]</I><DD>
|
|
Specifies the printer speed in pages per minute.
|
|
If two numbers are specified and the second number is greater than zero, the server will report support for color printing.
|
|
The default is "10,0".
|
|
<DT id="25"><B>-v[vvv]</B>
|
|
|
|
<DD>
|
|
Be (very) verbose when logging activity to standard error.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
The
|
|
<B>ippeveprinter</B>
|
|
|
|
program returns 1 if it is unable to process the command-line arguments or register the IPP service.
|
|
Otherwise
|
|
<B>ippeveprinter</B>
|
|
|
|
will run continuously until terminated.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
The
|
|
<B>ippeveprinter</B>
|
|
|
|
program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<B>ippeveprinter</B>
|
|
|
|
adds environment variables starting with "IPP_" for all IPP Job attributes in the print request.
|
|
For example, when executing a command for an IPP Job containing the "media" Job Template attribute, the "IPP_MEDIA" environment variable will be set to the value of that attribute.
|
|
<P>
|
|
|
|
In addition, all IPP "xxx-default" and "pwg-xxx" Printer Description attributes are added to the environment.
|
|
For example, the "IPP_MEDIA_DEFAULT" environment variable will be set to the default value for the "media" Job Template attribute.
|
|
<P>
|
|
|
|
Enumerated values are converted to their keyword equivalents.
|
|
For example, a "print-quality" Job Template attribute with a enum value of 3 will become the "IPP_PRINT_QUALITY" environment variable with a value of "draft".
|
|
This string conversion only happens for standard Job Template attributes, currently "finishings", "orientation-requested", and "print-quality".
|
|
<P>
|
|
|
|
Finally, the "CONTENT_TYPE" environment variable contains the MIME media type of the document being printed, the "DEVICE_URI" environment variable contains the device URI as specified with the "-D" option, the "OUTPUT_FORMAT" environment variable contains the output MIME media type, and the "PPD" environment variable contains the PPD filename as specified with the "-P" option.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COMMAND OUTPUT</H2>
|
|
|
|
Unless they communicate directly with a printer, print commands send printer-ready data to the standard output.
|
|
<P>
|
|
|
|
Print commands can send messages back to
|
|
<B>ippeveprinter</B>
|
|
|
|
on the standard error with one of the following prefixes:
|
|
<DL COMPACT>
|
|
<DT id="26"><B>ATTR: </B><I>attribute=value[ attribute=value]</I><DD>
|
|
Sets the named attribute(s) to the given values.
|
|
Currently only the "job-impressions" and "job-impressions-completed" Job Status attributes and the "marker-xxx", "printer-alert", "printer-alert-description", "printer-supply", and "printer-supply-description" Printer Status attributes can be set.
|
|
<DT id="27"><B>DEBUG: </B><I>Debugging message</I><DD>
|
|
Logs a debugging message if at least two -v's have been specified.
|
|
<DT id="28"><B>ERROR: </B><I>Error message</I><DD>
|
|
Logs an error message and copies the message to the "job-state-message" attribute.
|
|
<DT id="29"><B>INFO: </B><I>Informational message</I><DD>
|
|
Logs an informational/progress message if -v has been specified and copies the message to the "job-state-message" attribute unless an error has been reported.
|
|
<DT id="30"><B>STATE: </B><I>keyword[,keyword,...]</I><DD>
|
|
Sets the printer's "printer-state-reasons" attribute to the listed keywords.
|
|
<DT id="31"><B>STATE: -</B><I>keyword[,keyword,...]</I><DD>
|
|
Removes the listed keywords from the printer's "printer-state-reasons" attribute.
|
|
<DT id="32"><B>STATE: +</B><I>keyword[,keyword,...]</I><DD>
|
|
Adds the listed keywords to the printer's "printer-state-reasons" attribute.
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
Run
|
|
<B>ippeveprinter</B>
|
|
|
|
with a service name of My Cool Printer:
|
|
<PRE>
|
|
|
|
ippeveprinter "My Cool Printer"
|
|
</PRE>
|
|
|
|
<P>
|
|
|
|
Run the
|
|
<B><A HREF="/cgi-bin/man/man2html?1+file">file</A></B>(1)
|
|
|
|
command whenever a job is sent to the server:
|
|
<PRE>
|
|
|
|
ippeveprinter -c /usr/bin/file "My Cool Printer"
|
|
</PRE>
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+ippevepcl">ippevepcl</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+ippeveps">ippeveps</A></B>(7),
|
|
|
|
PWG Internet Printing Protocol Workgroup (<A HREF="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</A>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
Copyright © 2007-2019 by Apple Inc.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="33"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="34"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="35"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="36"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="37"><A HREF="#lbAF">EXIT STATUS</A><DD>
|
|
<DT id="38"><A HREF="#lbAG">CONFORMING TO</A><DD>
|
|
<DT id="39"><A HREF="#lbAH">ENVIRONMENT</A><DD>
|
|
<DT id="40"><A HREF="#lbAI">COMMAND OUTPUT</A><DD>
|
|
<DT id="41"><A HREF="#lbAJ">EXAMPLES</A><DD>
|
|
<DT id="42"><A HREF="#lbAK">SEE ALSO</A><DD>
|
|
<DT id="43"><A HREF="#lbAL">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:17 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|