doc/help/man-lpadmin.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>lpadmin(8)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">lpadmin(8)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 lpadmin - configure cups printers and classes
  12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
  13 <b>lpadmin
  14 </b>[ -E ] [-U
  15 <i>username
  16 </i>] [ -h
  17 <i>server[:port]
  18 </i>] -d
  19 <i>destination
  20 </i><br>
  21 <b>lpadmin
  22 </b>[ -E ] [-U
  23 <i>username
  24 </i>] [ -h
  25 <i>server[:port]
  26 </i>] -p
  27 <i>destination
  28 </i>[ -R
  29 <i>name-default
  30 </i>]
  31 <i>option(s)
  32 </i><br>
  33 <b>lpadmin
  34 </b>[ -E ] [-U
  35 <i>username
  36 </i>] [ -h
  37 <i>server[:port]
  38 </i>] -x
  39 <i>destination
  40 </i><h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  41 <i>lpadmin</i> configures printer and class queues provided by
  42 CUPS. It can also be used to set the server default printer or
  43 class.
  44 <p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i>
  45 options, the <i>-E</i> option forces encryption when connecting to
  46 the server.
  47 <p>The first form of the command (<i>-d</i>) sets the default printer
  48 or class to <i>destination</i>.  Subsequent print jobs submitted
  49 via the <a href='man-lp.html?TOPIC=Man+Pages'>lp(1)</a> or <a href='man-lpr.html?TOPIC=Man+Pages'>lpr(1)</a> commands will use this
  50 destination unless the user specifies otherwise with the
  51 <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command.
  52 <p>The second form of the command (<i>-p</i>) configures the named
  53 printer or class.  The additional options are described below.
  54 <p>The third form of the command (<i>-x</i>) deletes the printer or
  55 class <i>destination</i>. Any jobs that are pending for the
  56 destination will be removed and any job that is currently printed
  57 will be aborted.
  58 <h2 class="title"><a name="CONFIGURATION_OPTIONS">Configuration Options</a></h2>
  59 The following options are recognized when configuring a printer
  60 queue:
  61 <dl>
  62 <dt>-c class
  63 </dt>
  64 <dd></dd>
  65 <dd>Adds the named <i>printer</i> to <i>class</i>.  If <i>class</i> does
  66 not exist it is created automatically.
  67 </dd>
  68 <dt>-i interface
  69 </dt>
  70 <dd></dd>
  71 <dd>Sets a System V style interface script for the printer. This
  72 option cannot be specified with the <i>-P</i> option (PPD file)
  73 and is intended for providing support for legacy printer drivers.
  74 </dd>
  75 <dt>-m model
  76 </dt>
  77 <dd></dd>
  78 <dd>Sets a standard System V interface script or PPD file for the printer from the
  79 <i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i>
  80 option with the <a href='man-lpinfo.html?TOPIC=Man+Pages'>lpinfo(8)</a> command to get a list of supported models.
  81 </dd>
  82 <dt>-o cupsIPPSupplies=true
  83 </dt>
  84 <dd></dd>
  85 <dt>-o cupsIPPSupplies=false
  86 </dt>
  87 <dd></dd>
  88 <dd>Specifies whether IPP supply level values should be reported.
  89 </dd>
  90 <dt>-o cupsSNMPSupplies=true
  91 </dt>
  92 <dd></dd>
  93 <dt>-o cupsSNMPSupplies=false
  94 </dt>
  95 <dd></dd>
  96 <dd>Specifies whether SNMP supply level (RFC 3805) values should be reported.
  97 </dd>
  98 <dt>-o job-k-limit=value
  99 </dt>
 100 <dd></dd>
 101 <dd>Sets the kilobyte limit for per-user quotas. The value is an
 102 integer number of kilobytes; one kilobyte is 1024 bytes.
 103 </dd>
 104 <dt>-o job-page-limit=value
 105 </dt>
 106 <dd></dd>
 107 <dd>Sets the page limit for per-user quotas. The value is the integer
 108 number of pages that can be printed; double-sided pages are
 109 counted as two pages.
 110 </dd>
 111 <dt>-o job-quota-period=value
 112 </dt>
 113 <dd></dd>
 114 <dd>Sets the accounting period for per-user quotas. The value is an
 115 integer number of seconds; 86,400 seconds are in one day.
 116 </dd>
 117 <dt>-o job-sheets-default=banner
 118 </dt>
 119 <dd></dd>
 120 <dt>-o job-sheets-default=banner,banner
 121 </dt>
 122 <dd></dd>
 123 <dd>Sets the default banner page(s) to use for print jobs.
 124 </dd>
 125 <dt>-o name=value
 126 </dt>
 127 <dd></dd>
 128 <dd>Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
 129 option with the <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command.
 130 </dd>
 131 <dt>-o name-default=value
 132 </dt>
 133 <dd></dd>
 134 <dd>Sets a default server-side option for the destination. Any print-time
 135 option can be defaulted, e.g. "-o cpi-default=17" to set the default
 136 "cpi" option value to 17.
 137 </dd>
 138 <dt>-o port-monitor=name
 139 </dt>
 140 <dd></dd>
 141 <dd>Sets the binary communications program to use when printing,
 142 "none", "bcp", or "tbcp". The default program is "none". The
 143 specified port monitor must be listed in the printer's PPD file.
 144 </dd>
 145 <dt>-o printer-error-policy=name
 146 </dt>
 147 <dd></dd>
 148 <dd>Sets the error policy to be used when the printer backend is
 149 unable to send the job to the printer. The name must be one of
 150 "abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
 151 error policy is "stop-printer" for printers and "retry-current-job" for
 152 classes.
 153 </dd>
 154 <dt>-o printer-is-shared=true/false
 155 </dt>
 156 <dd></dd>
 157 <dd>Sets the destination to shared/published or unshared/unpublished.
 158 Shared/published destinations are publicly announced by the server
 159 on the LAN based on the browsing configuration in
 160 <b>cupsd.conf</b>, while unshared/unpublished destinations are not
 161 announced. The default value is "true".
 162 </dd>
 163 <dt>-o printer-op-policy=name
 164 </dt>
 165 <dd></dd>
 166 <dd>Sets the IPP operation policy associated with the destination. The
 167 name must be defined in the <b>cupsd.conf</b> in a Policy section.
 168 The default operation policy is "default".
 169 </dd>
 170 <dt>-R name-default
 171 </dt>
 172 <dd></dd>
 173 <dd>Deletes the named option from <i>printer</i>.
 174 </dd>
 175 <dt>-r class
 176 </dt>
 177 <dd></dd>
 178 <dd>Removes the named <i>printer</i> from <i>class</i>.  If the
 179 resulting class becomes empty it is removed.
 180 </dd>
 181 <dt>-u allow:user,user,@group
 182 </dt>
 183 <dd></dd>
 184 <dt>-u deny:user,user,@group
 185 </dt>
 186 <dd></dd>
 187 <dt>-u allow:all
 188 </dt>
 189 <dd></dd>
 190 <dt>-u deny:none
 191 </dt>
 192 <dd></dd>
 193 <dd>Sets user-level access control on a destination. Names starting with
 194 "@" are interpreted as UNIX groups. The latter two forms turn
 195 user-level access control off.
 196 </dd>
 197 <dt>-v "device-uri"
 198 </dt>
 199 <dd></dd>
 200 <dd>Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
 201 option with the <a href='man-lpinfo.html?TOPIC=Man+Pages'>lpinfo(8)</a> command to get a list of supported device URIs
 202 and schemes.
 203 </dd>
 204 <dt>-D "info"
 205 </dt>
 206 <dd></dd>
 207 <dd>Provides a textual description of the destination.
 208 </dd>
 209 <dt>-E
 210 </dt>
 211 <dd></dd>
 212 <dd>Enables the destination and accepts jobs; this is the same as running the
 213 <a href='man-cupsaccept.html?TOPIC=Man+Pages'>cupsaccept(8)</a> and <a href='man-cupsenable.html?TOPIC=Man+Pages'>cupsenable(8)</a> programs on the destination.
 214 </dd>
 215 <dt>-L "location"
 216 </dt>
 217 <dd></dd>
 218 <dd>Provides a textual location of the destination.
 219 </dd>
 220 <dt>-P ppd-file
 221 </dt>
 222 <dd></dd>
 223 <dd>Specifies a PostScript Printer Description file to use with the
 224 printer. If specified, this option overrides the <i>-i</i> option
 225 (interface script).
 226 </dd>
 227 </dl>
 228 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
 229 Unlike the System V printing system, CUPS allows printer names to
 230 contain any printable character except SPACE, TAB, "/", or "#".
 231 Also, printer and class names are <i>not</i> case-sensitive.
 232 Finally, the CUPS version of <i>lpadmin</i> may ask the user for
 233 an access password depending on the printing system
 234 configuration. This differs from the System V version which
 235 requires the root user to execute this command.
 236 <h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
 237 The CUPS version of <i>lpadmin</i> does not support all of the
 238 System V or Solaris printing system configuration options.
 239 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 240 <a href='man-cupsaccept.html?TOPIC=Man+Pages'>cupsaccept(8)</a>, <a href='man-cupsenable.html?TOPIC=Man+Pages'>cupsenable(8)</a>, <a href='man-lpinfo.html?TOPIC=Man+Pages'>lpinfo(8)</a>,
 241 <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a>,
 242 <br>
 243 <a href='http://localhost:631/help'>http://localhost:631/help</a>
 244 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 245 Copyright 2007-2013 by Apple Inc.
 246
 247 </body>
 248 </html>