doc/help/man-lpadmin.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>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</b>
  14 [ -E ] [-U
  15 <i>username</i>
  16 ] [ -h
  17 <i>server[:port]</i>
  18 ] -d
  19 <i>destination</i>
  20 <br>
  21 <b>lpadmin</b>
  22 [ -E ] [-U
  23 <i>username</i>
  24 ] [ -h
  25 <i>server[:port]</i>
  26 ] -p
  27 <i>destination</i>
  28 [ -R
  29 <i>name-default</i>
  30 ]
  31 <i>option(s)</i>
  32 <br>
  33 <b>lpadmin</b>
  34 [ -E ] [-U
  35 <i>username</i>
  36 ] [ -h
  37 <i>server[:port]</i>
  38 ] -x
  39 <i>destination</i>
  40 <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 <i>lp(1)</i> or <i>lpr(1)</i> commands will use this
  50 destination unless the user specifies otherwise with the
  51 <i>lpoptions(1)</i> 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 class="man">
  62 <dt>-c class
  63 <dd style="margin-left: 5.0em"><br>
  64 Adds the named <i>printer</i> to <i>class</i>.  If <i>class</i> does
  65 not exist it is created automatically.
  66 <dt>-i interface
  67 <dd style="margin-left: 5.0em"><br>
  68 Sets a System V style interface script for the printer. This
  69 option cannot be specified with the <i>-P</i> option (PPD file)
  70 and is intended for providing support for legacy printer drivers.
  71 <dt>-m model
  72 <dd style="margin-left: 5.0em"><br>
  73 Sets a standard System V interface script or PPD file for the printer from the
  74 <i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i>
  75 option with the <i>lpinfo(8)</i> command to get a list of supported models.
  76 <dt>-o cupsIPPSupplies=true
  77 <dd style="margin-left: 5.0em"><dt>-o cupsIPPSupplies=false
  78 <dd style="margin-left: 5.0em"><br>
  79 Specifies whether IPP supply level values should be reported.
  80 <dt>-o cupsSNMPSupplies=true
  81 <dd style="margin-left: 5.0em"><dt>-o cupsSNMPSupplies=false
  82 <dd style="margin-left: 5.0em"><br>
  83 Specifies whether SNMP supply level (RFC 3805) values should be reported.
  84 <dt>-o job-k-limit=value
  85 <dd style="margin-left: 5.0em"><br>
  86 Sets the kilobyte limit for per-user quotas. The value is an
  87 integer number of kilobytes; one kilobyte is 1024 bytes.
  88 <dt>-o job-page-limit=value
  89 <dd style="margin-left: 5.0em"><br>
  90 Sets the page limit for per-user quotas. The value is the integer
  91 number of pages that can be printed; double-sided pages are
  92 counted as two pages.
  93 <dt>-o job-quota-period=value
  94 <dd style="margin-left: 5.0em"><br>
  95 Sets the accounting period for per-user quotas. The value is an
  96 integer number of seconds; 86,400 seconds are in one day.
  97 <dt>-o job-sheets-default=banner
  98 <dd style="margin-left: 5.0em"><dt>-o job-sheets-default=banner,banner
  99 <dd style="margin-left: 5.0em"><br>
 100 Sets the default banner page(s) to use for print jobs.
 101 <dt>-o name=value
 102 <dd style="margin-left: 5.0em"><br>
 103 Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
 104 option with the <i>lpoptions(1)</i> command.
 105 <dt>-o name-default=value
 106 <dd style="margin-left: 5.0em"><br>
 107 Sets a default server-side option for the destination. Any print-time
 108 option can be defaulted, e.g. "-o cpi-default=17" to set the default
 109 "cpi" option value to 17.
 110 <dt>-o port-monitor=name
 111 <dd style="margin-left: 5.0em"><br>
 112 Sets the binary communications program to use when printing,
 113 "none", "bcp", or "tbcp". The default program is "none". The
 114 specified port monitor must be listed in the printer's PPD file.
 115 <dt>-o printer-error-policy=name
 116 <dd style="margin-left: 5.0em"><br>
 117 Sets the error policy to be used when the printer backend is
 118 unable to send the job to the printer. The name must be one of
 119 "abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
 120 error policy is "stop-printer" for printers and "retry-current-job" for
 121 classes.
 122 <dt>-o printer-is-shared=true/false
 123 <dd style="margin-left: 5.0em"><br>
 124 Sets the destination to shared/published or unshared/unpublished.
 125 Shared/published destinations are publicly announced by the server
 126 on the LAN based on the browsing configuration in
 127 <b>cupsd.conf</b>, while unshared/unpublished destinations are not
 128 announced. The default value is "true".
 129 <dt>-o printer-op-policy=name
 130 <dd style="margin-left: 5.0em"><br>
 131 Sets the IPP operation policy associated with the destination. The
 132 name must be defined in the <b>cupsd.conf</b> in a Policy section.
 133 The default operation policy is "default".
 134 <dt>-R name-default
 135 <dd style="margin-left: 5.0em"><br>
 136 Deletes the named option from <i>printer</i>.
 137 <dt>-r class
 138 <dd style="margin-left: 5.0em"><br>
 139 Removes the named <i>printer</i> from <i>class</i>.  If the
 140 resulting class becomes empty it is removed.
 141 <dt>-u allow:user,user,@group
 142 <dd style="margin-left: 5.0em"><dt>-u deny:user,user,@group
 143 <dd style="margin-left: 5.0em"><dt>-u allow:all
 144 <dd style="margin-left: 5.0em"><dt>-u deny:none
 145 <dd style="margin-left: 5.0em"><br>
 146 Sets user-level access control on a destination. Names starting with
 147 "@" are interpreted as UNIX groups. The latter two forms turn
 148 user-level access control off.
 149 <dt>-v "device-uri"
 150 <dd style="margin-left: 5.0em"><br>
 151 Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
 152 option with the <i>lpinfo(8)</i> command to get a list of supported device URIs
 153 and schemes.
 154 <dt>-D "info"
 155 <dd style="margin-left: 5.0em"><br>
 156 Provides a textual description of the destination.
 157 <dt>-E
 158 <dd style="margin-left: 5.0em"><br>
 159 Enables the destination and accepts jobs; this is the same as running the
 160 <i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination.
 161 <dt>-L "location"
 162 <dd style="margin-left: 5.0em"><br>
 163 Provides a textual location of the destination.
 164 <dt>-P ppd-file
 165 <dd style="margin-left: 5.0em"><br>
 166 Specifies a PostScript Printer Description file to use with the
 167 printer. If specified, this option overrides the <i>-i</i> option
 168 (interface script).
 169 </dl>
 170 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
 171 Unlike the System V printing system, CUPS allows printer names to
 172 contain any printable character except SPACE, TAB, "/", or "#".
 173 Also, printer and class names are <i>not</i> case-sensitive.
 174 Finally, the CUPS version of <i>lpadmin</i> may ask the user for
 175 an access password depending on the printing system
 176 configuration. This differs from the System V version which
 177 requires the root user to execute this command.
 178 <h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
 179 The CUPS version of <i>lpadmin</i> does not support all of the
 180 System V or Solaris printing system configuration options.
 181 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 182 <i>cupsaccept(8)</i>, <i>cupsenable(8)</i>, <i>lpinfo(8)</i>,
 183 <i>lpoptions(1)</i>,
 184 <br>
 185 <a href="http://localhost:631/help">http://localhost:631/help</a>
 186 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 187 Copyright 2007-2013 by Apple Inc.
 188
 189 </body>
 190 </html>