1<!DOCTYPE HTML> 2<html> 3<!-- SECTION: Man Pages --> 4<head> 5 <link rel="stylesheet" type="text/css" href="../cups-printable.css"> 6 <title>ippeveprinter(1)</title> 7</head> 8<body> 9<h1 class="title">ippeveprinter(1)</h1> 10<h2 class="title"><a name="NAME">Name</a></h2> 11ippeveprinter - an ipp everywhere printer application for cups 12<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> 13<b>ippeveprinter</b> 14[ 15<b>--help</b> 16] [ 17<b>--no-web-forms</b> 18] [ 19<b>--pam-service</b> 20<i>service</i> 21] [ 22<b>--version</b> 23] [ 24<b>-2</b> 25] [ 26<b>-A</b> 27] [ 28<b>-D</b> 29<i>device-uri</i> 30] [ 31<b>-F</b> 32<i>output-type/subtype</i> 33] [ 34<b>-K</b> 35<i>keypath</i> 36] [ 37<b>-M</b> 38<i>manufacturer</i> 39] [ 40<b>-P</b> 41<i>filename.ppd</i> 42] [ 43<b>-V</b> 44<i>ipp-version</i> 45] [ 46<b>-a</b> 47<i>filename.conf</i> 48] [ 49<b>-c</b> 50<i>command</i> 51] [ 52<b>-d</b> 53<i>spool-directory</i> 54] [ 55<b>-f</b> 56<i>type/subtype[,...]</i> 57] [ 58<b>-i</b> 59<i>iconfile.png</i> 60] [ 61<b>-k</b> 62] [ 63<b>-l</b> 64<i>location</i> 65] [ 66<b>-m</b> 67<i>model</i> 68] [ 69<b>-n</b> 70<i>hostname</i> 71] [ 72<b>-p</b> 73<i>port</i> 74] [ 75<b>-r</b> 76<i>subtype[,subtype]</i> 77] [ 78<b>-s</b> 79<i>speed[,color-speed]</i> 80] [ 81<b>-v[vvv]</b> 82] 83<i>service-name</i> 84<h2 class="title"><a name="DESCRIPTION">Description</a></h2> 85<b>ippeveprinter</b> 86is 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. 87<h2 class="title"><a name="OPTIONS">Options</a></h2> 88The following options are recognized by 89<b>ippeveprinter:</b> 90<dl class="man"> 91<dt><b>--help</b> 92<dd style="margin-left: 5.0em">Show program usage. 93<dt><b>--no-web-forms</b> 94<dd style="margin-left: 5.0em">Disable the web interface forms used to update the media and supply levels. 95<dt><b>--pam-service </b><i>service</i> 96<dd style="margin-left: 5.0em">Set the PAM service name. 97The default service is "cups". 98<dt><b>--version</b> 99<dd style="margin-left: 5.0em">Show the CUPS version. 100<dt><b>-2</b> 101<dd style="margin-left: 5.0em">Report support for two-sided (duplex) printing. 102<dt><b>-A</b> 103<dd style="margin-left: 5.0em">Enable authentication for the created printer. 104<b>ippeveprinter</b> 105uses PAM to authenticate HTTP Basic credentials. 106<dt><b>-D </b><i>device-uri</i> 107<dd style="margin-left: 5.0em">Set the device URI for print output. 108The URI can be a filename, directory, or a network socket URI of the form "socket://ADDRESS[:PORT]" (where the default port number is 9100). 109When specifying a directory, 110<b>ippeveprinter</b> 111will create an output file using the job ID and name. 112<dt><b>-F </b><i>output-type/subtype[,...]</i> 113<dd style="margin-left: 5.0em">Specifies the output MIME media type. 114The default is "application/postscript" when the <b>-P</b> option is specified. 115<dt><b>-M </b><i>manufacturer</i> 116<dd style="margin-left: 5.0em">Set the manufacturer of the printer. 117The default is "Example". 118<dt><b>-P </b><i>filename.ppd</i> 119<dd style="margin-left: 5.0em">Load printer attributes from the specified PPD file. 120This option is typically used in conjunction with the 121<b>ippeveps</b>(7) 122printer command ("-c ippeveps"). 123<dt><b>-V 1.1</b> 124<dd style="margin-left: 5.0em"><dt><b>-V 2.0</b> 125<dd style="margin-left: 5.0em">Specifies the maximum IPP version to report. 1262.0 is the default. 127<dt><b>-c </b><i>command</i> 128<dd style="margin-left: 5.0em">Run the specified command for each document that is printed. 129If "command" is not an absolute path ("/path/to/command"), 130<b>ippeveprinter</b> 131looks for the command in the "command" subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command. 132The 133<b>cups-config</b>(1) 134command can be used to discover the correct binary directory ("cups-config --serverbin"). 135In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the 136<b>cups</b>(1) 137man page for more details. 138<dt><b>-d </b><i>spool-directory</i> 139<dd style="margin-left: 5.0em">Specifies the directory that will hold the print files. 140The default is a directory under the user's current temporary directory. 141<dt><b>-f </b><i>type/subtype[,...]</i> 142<dd style="margin-left: 5.0em">Specifies a list of MIME media types that the server will accept. 143The default depends on the type of printer created. 144<dt><b>-i </b><i>iconfile.png</i> 145<dd style="margin-left: 5.0em">Specifies the printer icon file for the server. 146The file must be a PNG format image. 147The default is an internally-provided PNG image. 148<dt><b>-k</b> 149<dd style="margin-left: 5.0em">Keeps the print documents in the spool directory rather than deleting them. 150<dt><b>-l </b><i>location</i> 151<dd style="margin-left: 5.0em">Specifies the human-readable location string that is reported by the server. 152The default is the empty string. 153<dt><b>-m </b><i>model</i> 154<dd style="margin-left: 5.0em">Specifies the model name of the printer. 155The default is "Printer". 156<dt><b>-n </b><i>hostname</i> 157<dd style="margin-left: 5.0em">Specifies the hostname that is reported by the server. 158The default is the name returned by the 159<b>hostname</b>(1) 160command. 161<dt><b>-p </b><i>port</i> 162<dd style="margin-left: 5.0em">Specifies the port number to listen on. 163The default is a user-specific number from 8000 to 8999. 164<dt><b>-r</b><b>off</b> 165<dd style="margin-left: 5.0em">Turns off DNS-SD service advertisements entirely. 166<dt><b>-r </b><i>subtype[,subtype]</i> 167<dd style="margin-left: 5.0em">Specifies the DNS-SD subtype(s) to advertise. 168Separate multiple subtypes with a comma. 169The default is "_print". 170<dt><b>-s </b><i>speed[,color-speed]</i> 171<dd style="margin-left: 5.0em">Specifies the printer speed in pages per minute. 172If two numbers are specified and the second number is greater than zero, the server will report support for color printing. 173The default is "10,0". 174<dt><b>-v[vvv]</b> 175<dd style="margin-left: 5.0em">Be (very) verbose when logging activity to standard error. 176</dl> 177<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> 178The 179<b>ippeveprinter</b> 180program returns 1 if it is unable to process the command-line arguments or register the IPP service. 181Otherwise 182<b>ippeveprinter</b> 183will run continuously until terminated. 184<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> 185The 186<b>ippeveprinter</b> 187program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification. 188<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> 189<b>ippeveprinter</b> 190adds environment variables starting with "IPP_" for all IPP Job attributes in the print request. 191For 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. 192<p>In addition, all IPP "xxx-default" and "pwg-xxx" Printer Description attributes are added to the environment. 193For example, the "IPP_MEDIA_DEFAULT" environment variable will be set to the default value for the "media" Job Template attribute. 194<p>Enumerated values are converted to their keyword equivalents. 195For 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". 196This string conversion only happens for standard Job Template attributes, currently "finishings", "orientation-requested", and "print-quality". 197<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. 198<h2 class="title"><a name="COMMAND_OUTPUT">Command Output</a></h2> 199Unless they communicate directly with a printer, print commands send printer-ready data to the standard output. 200<p>Print commands can send messages back to 201<b>ippeveprinter</b> 202on the standard error with one of the following prefixes: 203<dl class="man"> 204<dt><b>ATTR: </b><i>attribute=value[ attribute=value]</i> 205<dd style="margin-left: 5.0em">Sets the named attribute(s) to the given values. 206Currently 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. 207<dt><b>DEBUG: </b><i>Debugging message</i> 208<dd style="margin-left: 5.0em">Logs a debugging message if at least two -v's have been specified. 209<dt><b>ERROR: </b><i>Error message</i> 210<dd style="margin-left: 5.0em">Logs an error message and copies the message to the "job-state-message" attribute. 211<dt><b>INFO: </b><i>Informational message</i> 212<dd style="margin-left: 5.0em">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. 213<dt><b>STATE: </b><i>keyword[,keyword,...]</i> 214<dd style="margin-left: 5.0em">Sets the printer's "printer-state-reasons" attribute to the listed keywords. 215<dt><b>STATE: -</b><i>keyword[,keyword,...]</i> 216<dd style="margin-left: 5.0em">Removes the listed keywords from the printer's "printer-state-reasons" attribute. 217<dt><b>STATE: +</b><i>keyword[,keyword,...]</i> 218<dd style="margin-left: 5.0em">Adds the listed keywords to the printer's "printer-state-reasons" attribute. 219</dl> 220<h2 class="title"><a name="EXAMPLES">Examples</a></h2> 221Run 222<b>ippeveprinter</b> 223with a service name of My Cool Printer: 224<pre class="man"> 225 226 ippeveprinter "My Cool Printer" 227</pre> 228<p>Run the 229<b>file</b>(1) 230command whenever a job is sent to the server: 231<pre class="man"> 232 233 ippeveprinter -c /usr/bin/file "My Cool Printer" 234</pre> 235<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> 236<b>ippevepcl</b>(7), 237<b>ippeveps</b>(7), 238PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) 239<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> 240Copyright © 2007-2019 by Apple Inc. 241 242</body> 243</html> 244
