everywhere/man-ippserver.html

   1 <!DOCTYPE HTML>
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>ippserver(1)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">ippserver(1)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 ippserver - a simple internet printing protocol server
  12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
  13 <b>ippserver</b>
  14 [
  15 <b>-2</b>
  16 ] [
  17 <b>-M</b>
  18 <i>manufacturer</i>
  19 ] [
  20 <b>-P</b>
  21 ] [
  22 <b>-c</b>
  23 <i>command</i>
  24 ] [
  25 <b>-d</b>
  26 <i>spool-directory</i>
  27 ] [
  28 <b>-f</b>
  29 <i>type/subtype[,...]</i>
  30 ] [
  31 <b>-h</b>
  32 ] [
  33 <b>-i</b>
  34 <i>iconfile.png</i>
  35 ] [
  36 <b>-k</b>
  37 ] [
  38 <b>-l</b>
  39 <i>location</i>
  40 ] [
  41 <b>-m</b>
  42 <i>model</i>
  43 ] [
  44 <b>-n</b>
  45 <i>hostname</i>
  46 ] [
  47 <b>-p</b>
  48 <i>port</i>
  49 ] [
  50 <b>-r</b>
  51 <i>subtype</i>
  52 ] [
  53 <b>-s</b>
  54 <i>speed[,color-speed]</i>
  55 ] [
  56 <b>-v[vvv]</b>
  57 ]
  58 <i>service-name</i>
  59 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  60 <b>ippserver</b>
  61 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.
  62 <h2 class="title"><a name="OPTIONS">Options</a></h2>
  63 The following options are recognized by
  64 <b>ippserver:</b>
  65 <dl class="man">
  66 <dt><b>-2</b>
  67 <dd style="margin-left: 5.0em">Report support for two-sided (duplex) printing.
  68 <dt><b>-M </b><i>manufacturer</i>
  69 <dd style="margin-left: 5.0em">Set the manufacturer of the printer.
  70 The default is "Test".
  71 <dt><b>-P</b>
  72 <dd style="margin-left: 5.0em">Report support for PIN printing.
  73 <dt><b>-c </b><i>command</i>
  74 <dd style="margin-left: 5.0em">Run the specified command for each document that is printed.
  75 <dt><b>-d </b><i>spool-directory</i>
  76 <dd style="margin-left: 5.0em">Specifies the directory that will hold the print files.
  77 The default is a directory under the user's current temporary directory.
  78 <dt><b>-f </b><i>type/subtype[,...]</i>
  79 <dd style="margin-left: 5.0em">Specifies a list of MIME media types that the server will accept.
  80 The default is "application/pdf,image/jpeg,image/pwg-raster".
  81 <dt><b>-h</b>
  82 <dd style="margin-left: 5.0em">Shows program help.
  83 <dt><b>-i </b><i>iconfile.png</i>
  84 <dd style="margin-left: 5.0em">Specifies the printer icon file for the server.
  85 The default is "printer.png".
  86 <dt><b>-k</b>
  87 <dd style="margin-left: 5.0em">Keeps the print documents in the spool directory rather than deleting them.
  88 <dt><b>-l </b><i>location</i>
  89 <dd style="margin-left: 5.0em">Specifies the human-readable location string that is reported by the server.
  90 The default is the empty string.
  91 <dt><b>-m </b><i>model</i>
  92 <dd style="margin-left: 5.0em">Specifies the model name of the printer.
  93 The default is "Printer".
  94 <dt><b>-n </b><i>hostname</i>
  95 <dd style="margin-left: 5.0em">Specifies the hostname that is reported by the server.
  96 The default is the name returned by the
  97 <b>hostname</b>(1)
  98 command.
  99 <dt><b>-p </b><i>port</i>
 100 <dd style="margin-left: 5.0em">Specifies the port number to listen on.
 101 The default is a user-specific number from 8000 to 8999.
 102 <dt><b>-r </b><i>subtype</i>
 103 <dd style="margin-left: 5.0em">Specifies the Bonjour subtype(s) to advertise.
 104 Separate multiple subtypes with a comma.
 105 The default is "_print".
 106 <dt><b>-s </b><i>speed[,color-speed]</i>
 107 <dd style="margin-left: 5.0em">Specifies the printer speed in pages per minute.
 108 If two numbers are specified and the second number is greater than zero, the server will report support for color printing.
 109 The default is "10,0".
 110 <dt><b>-v[vvv]</b>
 111 <dd style="margin-left: 5.0em">Be (very) verbose when logging activity to the standard output.
 112 </dl>
 113 <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
 114 The
 115 <b>ippserver</b>
 116 program returns 1 if it is unable to process the command-line arguments or register the IPP service.
 117 Otherwise
 118 <b>ippserver</b>
 119 will run continuously until terminated.
 120 <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
 121 The
 122 <b>ippserver</b>
 123 program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification.
 124 <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
 125 <b>ippserver</b>
 126 adds environment variables starting with "IPP_" for all IPP Job attributes in the print request.
 127 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.
 128 <p>Enumerated values are converted to their keyword equivalents.
 129 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".
 130 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
 131 Run
 132 <b>ippserver</b>
 133 with a service name of My Cool Printer:
 134 <pre class="man">
 135
 136     ippserver "My Cool Printer"
 137 </pre>
 138 <p>Run the
 139 <b>file</b>(1)
 140 command whenever a job is sent to the server:
 141 <pre class="man">
 142
 143     ippserver -c file "My Cool Printer"
 144 </pre>
 145 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 146 PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
 147 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 148 Copyright &copy; 2007-2014 by Apple Inc.
 149
 150 </body>
 151 </html>